Survey Description Output

Output representation of the response to the Start Survey request.

JSON Example

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

Properties

Property Name	Type	Description	Available Version
`errors`	String[]	Error messages for a failed request.	v1
`flowInterviewState`	String	State of the flow interview.	v1
`invitationId`	String	ID of the survey invitation that’s related to the request.	v1
`invitationUuid`	String	Random ID of the survey invitation that’s generated for enhanced security.	v1
`languageCode`	String	Code of the language to get the survey page or question details.	v1
`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.	v1
`responseId`	String	ID of the survey response.	v1
`status`	String	Status of the API request. Possible values are: `Failure`—Survey unAuth Response API isn’t successfully run. `Success`—Survey unAuth Response API is successfully run.	v1
`surveyDetail`	Survey Detail Output	All details of the page in the survey.	v1
`warnings`	String[]	Warnings for a request.	v1