Survey Description Output

Output representation of the response to the Start Survey request.

JSON Example

{
  "languageCode": "en",
  "invitationId": "0Kixx0000004MWaCAM",
  "flowInterviewState": "state1",
  "status": "Success",
  "isPartiallyCmplSurveyLoaded": false,
  "surveyDetail": {
    "label": "Survey01",
    "name": "Survey01",
    "surveyPage": {
      "label": "Page 1",
      "name": "p_d84afb73_3a30_4a3f_aae7_b0478b3bb4ed",
      "surveyQuestions": [
        {
          "name": "q_856a997e_be2c_4ea3_b70d_7f6fb9cfbf4f",
          "label": "Good so Far !",
          "questionType": "ShortText",
          "responseDataType": "STRING",
          "isResponseRequired": false
        }
      ]
    }
  },
  "navigationActions": [
    "Next"
  ],
  "responseId": "0Myxx0000004CYqCAM",
  "errors": [],
  "warnings": []
}

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
`isPartiallyCmplSurveyLoaded`	Boolean	Indicates whether a partially completed survey is loaded (`true`) or a new survey is started (`false`).	Small, 63.0	63.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: <ul><li>`Back`—Go to the previous survey page.</li><li>`Next`—Go to the next survey page.</li></ul>	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: <ul><li>`Failure`—Survey Response API isn’t successfully run.</li><li>`Success`—Survey Response API is successfully run.</li></ul>	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