Visit Survey (Patch)


Description

This endpoint updates the survey answers for a particular question.


HTTP Method

patch


URL

/api/v2/surveys/{ID}

Path Parameters

Name Type Description
ID required <integer>

ID of the Question /api/v2/visits/{visitID}/survey

{ "Sections": [ { "QuestionGroups": [ { "Questions": [ { "ID": 21154 } ] } ] } ] }


Body

Name Type Description
ID required <integer> ID of the Question
ResponseInt optional <string>

The field stores responses to the integer-based questions.
ResponseString optional <string>

The field stores responses to the string-based questions.
SelectedResponses optional array <integer>

The field stores responses to the multi-choice questions.

 
{
  "ID": "<integer>",
  "ResponseInt": "<string>",
  "ResponseString": "<string>",
  "SelectedResponses": [
    "<integer>",
    "<integer>"
  ]
}

Response

{
  "ReturnCode": 0,
  "ReturnMessage": "string"
}

Example

{
    "ReturnCode": -1,
    "ReturnMessage": "Success"
}

Success Response

Code: 200 OK