(Quick Reference)
76 Routes - Reference Documentation
Version: 2.1
76 Routes
76.1 List
Service: List of routes
Description: This web service returns a json list of routes.
URL:
https://BASE_URL/api/VERSION/routes
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | |
| offset | Tells where to start returning records from the entire set of results. | Integer | no | |
| order | Orders ascending or descending. | Integer | no | asc,desc |
| sort | Orders the results by the specified field. | String | no | |
The max parameter is set to 100 by default.
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| name | Wildcard search by the resource's name | String | no | |
| reference | Wildcard search by the resource's reference | String | no | |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status = 200
{
"paging": {
"total": 2,
"max": 100,
"offset": 0,
"previous": null,
"next": null
},
"data": [
{
"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"
},
{
"id": 4,
"reference": "R-RT-002",
"name": "route XYZ",
"geographicLocation": {
"id": 2,
"name": "Toulouse",
"href": "/api/v1.0/regions/2"
},
"organization": "entity1",
"dateCreated": "2016-10-17T16:43:20Z",
"lastUpdated": "2016-10-17T16:43:20Z"
}
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}76.2 Show
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."
}76.3 Create
Service: Create a new route
Description: This web service is used to add a new route object to the database
URL:
https://BASE_URL/api/VERSION/routes
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| name | the name of the new route | String | Yes | |
| reference | the reference of the new appointment | String | Yes | |
| geographicLocationId | the id of region which the route will be associated | Long | No | |
geographicLocationId must be an ID of a leaf region located within the geographical positions’ hierarchical tree
reference must be unique
Success Output
Success case: response.status = 201
{
"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 geographicLocationId you provided is not valid for this request."
}{
"error": "missing_param",
"error_description": "name parameter is missing"
}{
"error": "not_unique",
"error_description": "reference already used"
}{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The geographic location with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}76.4 Update
Service: Update a route
Description: This web service is used to update an existing route object of specified id to the database
URL:
https://BASE_URL/api/VERSION/routes/{id}:
https://BASE_URL/api/VERSION/routes/reference/{id}: PUT
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record to update | Long/String | Yes | 123 |
| name | the name of the new route | String | Yes | |
| reference | the reference of the new appointment | String | Yes | |
| geographicLocationId | the id of region which the route will be associated | Long | No | |
geographicLocationId must be an ID of a leaf region located within the geographical positions’ hierarchical tree
reference must be unique
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 geographicLocationId you provided is not valid for this request."
}{
"error": "missing_param",
"error_description": "name parameter is missing"
}{
"error": "not_unique",
"error_description": "reference already used"
}{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The geographic location with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}76.5 Upsert
Service: Upsert a route
Description: This web service is used to insert a route object to the database if it does not already exist, or update it.
URL with external_id:
https://BASE_URL/api/VERSION/routes/reference/{id}: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| name | the name of the new route | String | Yes | |
| geographicLocationId | the id of region which the route will be associated | Long | No | |
geographicLocationId must be an ID of a leaf region located within the geographical positions’ hierarchical tree
reference must be unique
Success Output
Success case: response.status = 201
{
"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 geographicLocationId you provided is not valid for this request."
}{
"error": "missing_param",
"error_description": "name parameter is missing"
}{
"error": "not_unique",
"error_description": "reference already used"
}{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The geographic location with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}76.6 Delete
Service: Delete a route
Description: This web service is used to delete an existing route object from the database
URL:
https://BASE_URL/api/VERSION/routes/{id}:
https://BASE_URL/api/VERSION/routes/reference/{id}: DELETE
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record to delete | Long/String | Yes | 777 |
When deleting a route instance, all assignments of customers, employees and employee visits relate to this route will be deleted as well.
Success Output
Success case: response.status = 200
{
"success": "true",
"success_description": "Instance deleted successfully"
} 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."
}{
"error": "delete_failed",
"error_description": "Failed to delete instance."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The route with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
