(Quick Reference)
Service: Show an assigned customer to a route
Description: This web service return an existing assigned customer to a route object of the specified id in JSON format
Method: GET
URL:
https://BASE_URL/api/VERSION/routeCustomers/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/routeCustomers/reference/{routeId}/{customerId}:
| Name | Description | Type | Required | Examples values |
|---|
| routeId | reference of the route | String | Yes | R-002 |
| customerId | reference of the customer | String | Yes | C-001 |
Success Output
Success case: response.status = 200
{
"id": 2,
"rank": 2,
"route": {
"id": 2,
"reference": "R-RT-001",
"href": "/api/v1.0/routes/2"
},
"customer": {
"id": 2,
"reference": "R-CUS2",
"href": "/api/v1.0/customers/2"
},
"organization": "entity1",
"dateCreated": "2016-10-18T14:42:24Z",
"lastUpdated": "2016-10-18T14:42:24Z"
} 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 routeCustomer with the id 999 doesn't exist."
}
