(Quick Reference)
Service: Dissociate a customer from a route
Description: This web service is used to dissociate an assigned customer to a route and delete the data from the database
Method: DELETE
URL:
https://BASE_URL/api/VERSION/routeCustomers/{id}:
| Name | Description | Type | Required | Example values |
|---|
| id | id of the desired record to delete | 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
{
"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 routeCustomer with the id 999 doesn't exist."
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
