Virima API Specification - SurveyMastersAndQuestions Services

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

Contents

1 addSurveyMaster POST Interface
2 addSurveyQuestion POST Interface
3 updateSurveyMaster POST Interface
4 getAllExistingQuestions POST Interface
5 getAllSurveyQuesions GET Interface
6 addSurveyInstance POST Interface
7 getAllSurveyResponse GET Interface
8 getAllSurveyMasters GET Interface
9 getSurveyUsedIn GET Interface

addSurveyMaster POST Interface

Add Survey Master

Method: POST

Relative URL: survey/add-survey-master

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
survey	SurveyMaster

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDSURVEYMASTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "name":"?",
   "introduction":"?",
   "endNotes":"?",
   "createdOn":?,
   "archive":?,
   "incidentThresholdForNthRecord":?,
   "requestThresholdForNthRecord":?,
   "changeThresholdForNthRecord":?,
   "problemThresholdForNthRecord":?,
   "incidentThresholdForNthDay":?,
   "requestThresholdForNthDay":?,
   "changeThresholdForNthDay":?,
   "problemThresholdForNthDay":?,
   "question":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

addSurveyQuestion POST Interface

Add Survey Question

Method: POST

Relative URL: survey/add-survey-question

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
question	SurveyQuestion

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDSURVEYQUESTION 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "question":"?",
   "type":"?",
   "dafaultValue":"?",
   "createdOn":?,
   "archive":?,
   "master":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

updateSurveyMaster POST Interface

Update Survey Master

Method: POST

Relative URL: survey/update-survey-master

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
surveyMaster	SurveyMaster

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

UPDATESURVEYMASTER 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "uniqueId":"?",
   "name":"?",
   "introduction":"?",
   "endNotes":"?",
   "createdOn":?,
   "archive":?,
   "incidentThresholdForNthRecord":?,
   "requestThresholdForNthRecord":?,
   "changeThresholdForNthRecord":?,
   "problemThresholdForNthRecord":?,
   "incidentThresholdForNthDay":?,
   "requestThresholdForNthDay":?,
   "changeThresholdForNthDay":?,
   "problemThresholdForNthDay":?,
   "question":[
      {
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ]
}

Example Response:

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

getAllExistingQuestions POST Interface

get all existing questions from survey question table

Method: POST

Relative URL: survey/get-all-existing-questions

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
existingQuestions	ExistingQuestion

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

GETALLEXISTINGQUESTIONS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "searchKey":"?",
}

Example Response:

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

getAllSurveyQuesions GET Interface

Method: GET

Relative URL: survey/get-all-survey-questions/id

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":"?"
}

addSurveyInstance POST Interface

Add Survey Response

Method: POST

Relative URL: survey/add-survey-instance

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
answers	SurveyInstance

Response Structure:

Field Name	Type	Description
response	Response	Response

Example Request:

ADDSURVEYINSTANCE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "recordId":"?",
   "surveyMasterId":"?",
   "entity":"?",
   "title":"?",
   "userEmail":"?",
   "response":"?"
}

Example Response:

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

getAllSurveyResponse GET Interface

Method: GET

Relative URL: survey/get-all-survey-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":"?"
}

getAllSurveyMasters GET Interface

Method: GET

Relative URL: survey/get-all-survey-masters

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

Example Response:

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

getSurveyUsedIn GET Interface

Get a list wherever this particular survey is being used

Method: GET

Relative URL: survey/get-survey-used-in/record-id

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":"?"
}