(Quick Reference)
Service: Show a route
Description: This web service return an existing route object of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/routes/{id}:
https://BASE_URL/api/VERSION/routes/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record | Long/String | Yes | 777 |
Success Output
Success case: response.status = 200
{
"id": 2,
"reference": "R-RT-001",
"name": "fast and furious",
"geographicLocation": {
"id": 3,
"name": "Nice",
"href": "/api/v1.0/regions/3"
},
"organization": "entity1",
"dateCreated": "2016-10-17T14:05:54Z",
"lastUpdated": "2016-10-18T09:52:10Z"
} 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 route with the id 999 doesn't exist."
}
