(Quick Reference)
Service: Show a question column
Description: This web service return an existing question column of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/questionColumns/{id}
Method: 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": 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_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 column with the id 99 doesn't exist."
}