Survey Response Output

Output representation of the response to the Submit Survey request. The response includes the status of the survey response API and the Thank You page details in the survey.

JSON Example

1{
2  "languageCode": "en",
3  "invitationId": "0Kixx0000004MWaCAM",
4  "flowInterviewState": "state1",
5  "status": "Success",
6  "surveyPage": {
7    "label": "Page 1",
8    "name": "p_d84afb73_3a30_4a3f_aae7_b0478b3bb4ed",
9    "surveyQuestions": [
10      {
11        "name": "q_856a997e_be2c_4ea3_b70d_7f6fb9cfbf4f",
12        "label": "Good so Far !",
13        "questionType": "ShortText",
14        "responseDataType": "STRING",
15        "isResponseRequired": false
16      }
17    ]
18  },
19  "navigationActions": [
20    "Next",
21    "Back"
22  ],
23  "responseId": "0Myxx0000004CYqCAM",
24  "errors": []
25}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`errors`	String[]	Error messages for a failed request.	Small, 56.0	56.0
`flowInterviewState`	String	State of the flow interview.	Small, 57.0	57.0
`invitationId`	String	ID of the survey invitation that’s related to the request.	Small, 57.0	57.0
`languageCode`	String	Code of the language that the survey is created in.	Small, 56.0	56.0
`navigationActions`	String	Available navigation actions on the survey page. Possible values are: `Back`—Go to the previous survey page. `Next`—Go to the next survey page.	Small, 57.0	57.0
`responseId`	String	ID of the survey response.	Small, 57.0	57.0
`status`	String	Status of the API request. Possible values are: `Failure`—Survey Response API isn’t successfully run. `Success`—Survey Response API is successfully run.	Small, 56.0	56.0
`surveyPage`	Survey Question Page Output OR Survey Thank You Page Output	Details of the question or the Thank You page.	Small, 56.0	56.0