(Quick Reference)
Service: list of surveys
Description: This web service returns a json list of surveys.
URL:
https://BASE_URL/api/VERSION/surveys
: 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 | |
| name | Wildcard search by the resource's name | String | no | |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success case: response.status=200
{
"paging": {
"total": 3,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 1,
"name": "Survey1",
"description": "Description Survey1",
"isPublic": false,
"status": false,
"organization": "entity1",
"dateCreated": "2016-08-23T09:39:11Z",
"lastUpdated": "2016-08-23T09:42:12Z",
"answerOnce": true,
"showAllAtOnce": false,
"users": []
"questions": [
{
"id": 1,
"href": "/api/v1.0/questions/1"
}
]
},
{
"id": 2,
"name": "Survey2",
"description": "Description Survey2",
"isPublic": true,
"status": true,
"organization": "entity1",
"dateCreated": "2016-08-29T09:39:11Z",
"lastUpdated": "2016-08-29T09:39:11Z",
"answerOnce": false,
"showAllAtOnce": false,
"users": []
},
{
"id": 67,
"name": "Survey3",
"description": "the best decision to choose",
"isPublic": false,
"status": true,
"organization": "entity1",
"dateCreated": "2016-08-31T10:45:34Z",
"lastUpdated": "2016-08-31T10:45:34Z",
"answerOnce": true,
"showAllAtOnce": false,
"users": [
{
"id": 2,
"reference": "R001",
"firstName": "SADOK",
"lastName": "CHEBIL",
"href": "/api/v1.0/users/2"
},
{
"id": 3,
"reference": "R002",
"firstName": "LUFY",
"lastName": "MONKEYD",
"href": "/api/v1.0/users/3"
}
]
"questions": []
} 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-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
