| Name | Description | Type | Additional information |
|---|---|---|---|
|
ResponseResults
ResponseReport for each response of the question
Type
Collection of SurveyResponseResult
|
|||
| ResponseResults |
ResponseReport for each response of the question |
Collection of SurveyResponseResult | |
|
ResponseAggregate
The aggregates for this question showing Average, NPS and Median for this question taking the respondent filter into account
Type
QuestionAggregate
|
|||
| ResponseAggregate |
The aggregates for this question showing Average, NPS and Median for this question taking the respondent filter into account |
QuestionAggregate | |
|
Id
Id of a survey question.
Type
integer
|
|||
| Id |
Id of a survey question. |
integer | |
|
DataLabel
The datalabel of a survey question which can be used to identify a question within a survey.
Type
string
Additional info
Must be unique in a survey. |
|||
| DataLabel |
The datalabel of a survey question which can be used to identify a question within a survey. |
string |
Must be unique in a survey. |
|
Language
The language which is used to retrieve the
Type
string
|
|||
| Language |
The language which is used to retrieve the |
string | |
| QuestionTypeId |
The id of the question type. |
integer | |
|
Caption
The string caption in the requested language
Type
string
|
|||
| Caption |
The string caption in the requested language |
string | |
|
Required
Indicates if this question is required, respondents must complete this question before they can continue to the next page.
Type
boolean
|
|||
| Required |
Indicates if this question is required, respondents must complete this question before they can continue to the next page. |
boolean | |
| DataTypeId |
The datatype of the expected response. |
integer | |
| ScaleTypeId |
The scale label type. |
byte | |
|
Hidden
Indicates if a question is hidden in a survey.
Type
boolean
|
|||
| Hidden |
Indicates if a question is hidden in a survey. |
boolean | |
|
MinValue
The minimum length of the text, the minimum value of a number.
Type
integer
|
|||
| MinValue |
The minimum length of the text, the minimum value of a number. |
integer | |
|
MaxValue
The maximum length of the text, the maximum value of a number.
Type
integer
|
|||
| MaxValue |
The maximum length of the text, the maximum value of a number. |
integer | |
|
PageNumber
The page number of which the question is shown.
Type
integer
|
|||
| PageNumber |
The page number of which the question is shown. |
integer | |
|
OrderNumber
The order of the question within the page or within the parent question.
Type
integer
|
|||
| OrderNumber |
The order of the question within the page or within the parent question. |
integer | |
|
QuestionNumber
The number of the question as it will be shown in the survey.
Type
integer
|
|||
| QuestionNumber |
The number of the question as it will be shown in the survey. |
integer | |
|
ParentQuestionId
The id of the main question in case this question is a subquestion.
Type
integer
|
|||
| ParentQuestionId |
The id of the main question in case this question is a subquestion. |
integer | |
|
UseSentimentScore
Use sentiment score when tagging open responses
Type
boolean
|
|||
| UseSentimentScore |
Use sentiment score when tagging open responses |
boolean | |
|
SubQuestions
The sub questions of a question.
Type
Collection of SurveyQuestion
Additional info
When passing the asFlatList parameter with the 3/surveys/{surveyid}/questions, the subquestions property will be empty and all questions will appear in the root list. |
|||
| SubQuestions |
The sub questions of a question. |
Collection of SurveyQuestion |
When passing the asFlatList parameter with the 3/surveys/{surveyid}/questions, the subquestions property will be empty and all questions will appear in the root list. |
|
QuestionResponses
Shows the possible responses for this question.
Type
Collection of SurveyQuestionResponse
|
|||
| QuestionResponses |
Shows the possible responses for this question. |
Collection of SurveyQuestionResponse | |
| Links |
HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic. |
Hateoas | |