Virima API Specification - AssessmentMasterAndQuestionService Services

The requests documented in this section are directed to AssessmentMasterAndQuestionService resources, which represent .

Contents

1 addMaster POST Interface
2 addAssessmentQuestion POST Interface
3 addQuestionChoice POST Interface
4 addThreshold POST Interface
5 getRisk GET Interface
6 getRiskAssessmentResponse GET Interface

addMaster POST Interface

Method: POST

Relative URL: risk-assessment/add-master

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
master	AssessmentMaster

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDMASTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "name":"?",
   "introduction":"?",
   "endNote":"?",
   "createdOn":?,
   "archive":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addAssessmentQuestion POST Interface

Method: POST

Relative URL: risk-assessment/add-question

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
question	AssessmentQuestion

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDASSESSMENTQUESTION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "masterId":?,
   "question":"?",
   "type":"?",
   "weight":?,
   "choices":[
      {
         "questionId":?,
         "value":"?",
         "score":?,
         "archive":?
      }   ],
   "archive":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addQuestionChoice POST Interface

Method: POST

Relative URL: risk-assessment/add-choice

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
choice	QuestionChoice

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDQUESTIONCHOICE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "questionId":?,
   "value":"?",
   "score":?,
   "archive":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

addThreshold POST Interface

Method: POST

Relative URL: risk-assessment/add-threshold

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
threshold	AssessmentThreshold

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDTHRESHOLD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "masterId":?,
   "risk":"?",
   "score":?,
   "archive":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getRisk GET Interface

Method: GET

Relative URL: risk-assessment/get-risk

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getRiskAssessmentResponse GET Interface

Method: GET

Relative URL: risk-assessment/get-all-assessment-response/record-id/entity-name

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

{
   "id":2147483647,
   "response":"?"
}