(Quick Reference)
78 Assign employee to route - Reference Documentation
Version: 2.1
78 Assign employee to route
78.1 List
Service: List of assigned employees to routes
Description: This web service returns a json list of couples (route,employee).
URL:
https://BASE_URL/api/VERSION/routeEmployees
: 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 | |
| employeeReference | Wildcard search by the resource's employee reference | String | no | |
| routeReference | Wildcard search by the resource's route 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": 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"
},
{
"id": 3,
"rootingDate": "2016-11-10T14:30:00Z",
"repeatPeriod": "Never",
"employee": {
"id": 3,
"reference": "R-E-001",
"href": "/api/v1.0/employees/3"
},
"route": {
"id": 4,
"reference": "R-R-001",
"href": "/api/v1.0/routes/4"
},
"dateCreated": "2016-10-24T09:55:41Z",
"lastUpdated": "2016-10-24T09:55:41Z"
}
]
} 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..."
}78.2 Show
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."
}78.3 Create
Service: Assign a route to an employee
Description: This web service is used to assign an employee which is not assigned before to a route
URL:
https://BASE_URL/api/VERSION/routeEmployees
: POST
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| employeeId | the id of employee to be assigned | Long | Yes | 111 |
| routeId | the id of the assigned route | Long | Yes | 777 |
| rootingDate | the date of the operation | Date | Yes | "2016-12-10" |
| repeatPeriod | repetition type of the operation | String | Yes | Never, Weekly, Monthly |
repeatPeriod can only be one of this value : "Never", "Weekly", "Monthly"
In order to assign an employee to a route, all the customers assigned to this route must be already assigned
to the specified employee
In the same rooting date we can't assign an employee to a route if the are already assigned to each other.
Success Output
Success case: response.status = 201
{
"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 routeId you provided is not valid for this request."
}{
"error": "missing_param",
"error_description": "employeeId parameter is missing"
}{
"error": "invalid_date_format",
"error_description": "Invalid date filter (not ISO-8601 formatted): rootingDate"
}{
"error": "save_not_authorized",
"error_description": "the specified route is already assigned to the specified employee"
}{
"error": "save_not_authorized",
"error_description": "Not all the assigned customers to the route are assigned to the employee"
}{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The employee with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}78.4 Update
Service: Update an assigned route to an employee
Description: This web service is used to update an assigned employee to a route
URL:
https://BASE_URL/api/VERSION/routeEmployees/{id}: PUT
Request content type: application/json
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record to update | Long | Yes | 123 |
| employeeId | the id of employee to be assigned | Long | Yes | 111 |
| routeId | the id of the assigned route | Long | Yes | 777 |
| rootingDate | the date of the operation | Date | Yes | "2016-12-10" |
In order to assign an employee to a route, all the customers assigned to this route must be already assigned
to the specified employee
In the same rooting date we can't assign an employee to a route if the are already assigned to each other.
Success Output
Success case: response.status = 200
{
"id": 1,
"rootingDate": "2016-12-10T14:30:00Z",
"repeatPeriod": "Never",
"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-24T010:30:13Z"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter routeId you provided is not valid for this request."
}{
"error": "missing_param",
"error_description": "employeeId parameter is missing"
}{
"error": "invalid_date_format",
"error_description": "Invalid date filter (not ISO-8601 formatted): rootingDate"
}{
"error": "update_not_authorized",
"error_description": "the specified route is already assigned to the specified employee"
}{
"error": "update_not_authorized",
"error_description": "Not all the assigned customers to the route are assigned to the employee"
}{
"error": "save_failed",
"error_description": "Failed to save instance"
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The employee with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}78.5 Delete
Service: Dissociate an employee from a route
Description: This web service is used to dissociate an assigned employee to a route and delete the data from the database
URL:
https://BASE_URL/api/VERSION/routeEmployees/{id}: DELETE
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record to delete | Long | Yes | 777 |
| deleteOccurences | boolean to say if delete will also delete the occurrences instances | Boolean | No | true |
When deleteOccurences is set to true, starting from the rooting date of the desired route/employee instance all the route/employee occurrences will be deleted.
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 routeEmployee with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
