(Quick Reference)
68 Question Lines - Reference Documentation
Version: 2.1
68 Question Lines
68.1 List
Service: List of question lines
Description: This web service returns a json list of question lines.
URL:
https://BASE_URL/api/VERSION/questionLines
: 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 | |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status = 200
{
"paging": {
"total": 3,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"id": 1,
"text": "Documentation Quality",
"item": null,
"itemCategory": null,
"itemGroup": null,
"question": {
"id": 35,
"href": "/api/v1.0/questions/35"
},
"dateCreated": "2016-11-25T09:11:47Z",
"lastUpdated": "2016-11-25T09:11:47Z"
},
{
"id": 8,
"text": null,
"item": {
"id": 53,
"href": "/api/v1.0/items/53"
},
"itemCategory": null,
"itemGroup": null,
"question": {
"id": 39,
"href": "/api/v1.0/questions/39"
},
"dateCreated": "2016-11-25T09:35:45Z",
"lastUpdated": "2016-11-25T09:35:45Z"
},
{
"id": 9,
"text": null,
"item": {
"id": 54,
"href": "/api/v1.0/items/54"
},
"itemCategory": null,
"itemGroup": null,
"question": {
"id": 39,
"href": "/api/v1.0/questions/39"
},
"dateCreated": "2016-11-25T09:35:45Z",
"lastUpdated": "2016-11-25T09:35:45Z"
}
]
} 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..."
}68.2 Show
Service: Show a question line
Description: This web service return an existing question line of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/questionLines/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The numerical ID of the desired record | Long | Yes | 777 |
Success Output
Success case: response.status = 200
{
"id": 6,
"text": "WORK",
"item": null,
"itemCategory": null,
"itemGroup": null,
"question": {
"id": 38,
"href": "/api/v1.0/questions/38"
},
"dateCreated": "2016-11-25T09:33:19Z",
"lastUpdated": "2016-11-25T09:33:19Z"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The question line with the id 99 doesn't exist."
}
