(Quick Reference)
Service: List of question columns
Description: This web service returns a json list of question columns.
URL:
https://BASE_URL/api/VERSION/questionColumns
: 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 | |
| questionName | Wildcard search by the resource's question name | String | no | |
| questionColumnName | Wildcard search by the resource's column name | String | no | |
| type | Filter by question column's type | Integer | no | 1, 2, 3, 4, 5, 6, 8 |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status = 200
{
"paging": {
"total": 2,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 1,
"name": "How do you find our product quality ?",
"type": "1",
"questionOptions": [
{
"id": 59,
"text": "Good",
"href": "/api/v1.0/questionOptions/59"
},
{
"id": 60,
"text": "Acceptable",
"href": "/api/v1.0/questionOptions/60"
},
{
"id": 61,
"text": "Bad",
"href": "/api/v1.0/questionOptions/61"
}
],
"question": {
"id": 35,
"href": "/api/v1.0/questions/35"
},
"dateCreated": "2016-11-25T09:11:47Z",
"lastUpdated": "2016-11-25T09:11:47Z"
},
{
"id": 3,
"name": "How do you feel about joining our community ?",
"type": "1",
"questionOptions": [
{
"id": 65,
"text": "Yes great idea",
"href": "/api/v1.0/questionOptions/65"
},
{
"id": 66,
"text": "I will think about it",
"href": "/api/v1.0/questionOptions/66"
},
{
"id": 67,
"text": "not interested",
"href": "/api/v1.0/questionOptions/67"
}
],
"question": {
"id": 37,
"href": "/api/v1.0/questions/37"
},
"dateCreated": "2016-11-25T09:29:03Z",
"lastUpdated": "2016-11-25T09:29:03Z"
}
]
} 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..."
}
