Survey Description Output

Output representation of the response to the Start Survey request.

JSON example

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

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, 56.0	56.0
`invitationId`	String	ID of the survey invitation that's related to the request.	Small, 56.0	56.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
`surveyDetail`	Survey Detail Output	All details of the page in the survey.	Small, 56.0	56.0
`warnings`	String[]	Warnings for a request.	Small, 56.0	56.0

Connect REST API Developer Guide

Survey Description Output