(Quick Reference)
Service: Show a survey
Description: Returns the requested survey in json format when successful.
URL:
https://BASE_URL/api/VERSION/surveys/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The unique numerical ID of the desired survey | Long | yes | 123 |
Success Output
Success case: response.status=200
{
"id": 69,
"name": "Survey of salary",
"description": "describe you point of vue",
"isPublic": false,
"status": true,
"organization": "entity1",
"dateCreated": "2016-08-31T10:47:29Z",
"lastUpdated": "2016-08-31T10:47:29Z",
"answerOnce": true,
"showAllAtOnce": false,
"users": [
{
"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_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 survey with the id 35 doesn't exist."
}
