(Quick Reference)
Service: List of questions
Description: This web service returns a JSON list of questions.
URL:
https://BASE_URL/api/VERSION/questions
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | |
| offset | Tells where to start returning records from the entire set of results. | Integer | no | |
| order | Orders ascending or descending. | Integer | no | asc,desc |
| sort | Orders the results by the specified field. | String | no | |
The max parameter is set to 100 by default.
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| surveyName | Wildcard search by the survey's name | String | no | surveyName=*Quality of product* |
| type | Search by the resource's type | Integer | no | 1, 2, 3 |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status = 200
{
"paging": {
"total": 1,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 7,
"survey": {
"id": 4,
"name": "Quality and satisfaction with documentation",
"href": "/api/v1.0/surveys/4"
},
"text": "How satisfied are you with the appropriateness of the documentation to your needs?",
"type": "2",
"isMandatory": true,
"isPhotoMandatory": false,
"enabled": true,
"questionOptions": [
{
"id": 10,
"text": "Satisfied",
"href": "/api/v1.0/questionOptions/10"
},
{
"id": 11,
"text": "Dissatisfied",
"href": "/api/v1.0/questionOptions/11"
},
{
"id": 12,
"text": "Neutral",
"href": "/api/v1.0/questionOptions/12"
}
],
"answers": [],
"questionLines": null,
"questionColumns": null,
"dynamicLines": false,
"addFilterByCategory": false,
"organization": "entity1",
"dateCreated": "2016-08-29T10:01:57Z",
"lastUpdated": "2016-08-29T10:20:10Z"
}
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016/08/29]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
