(Quick Reference)
Service: Show an assigned employee to a route
Description: This web service return an existing assigned employee to a route object of the specified id in JSON format
URL:
https://BASE_URL/api/VERSION/routeEmployees/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record | Long | Yes | 777 |
Success Output
Success case: response.status = 200
{
"id": 1,
"rootingDate": "2016-12-10",
"repeatPeriod": "Monthly",
"employee": {
"id": 3,
"reference": "R-E-001",
"href": "/api/v1.0/employees/3"
},
"route": {
"id": 2,
"reference": "R-RT-001",
"href": "/api/v1.0/routes/2"
},
"dateCreated": "2016-10-19T10:42:09Z",
"lastUpdated": "2016-10-24T09:32:13Z"
} 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 routeEmployee with the id 999 doesn't exist."
}
