Description: This web service is used in order to dissociate a customer from an employee, when success it will returns
Method: DELETE
URL:
https://BASE_URL/api/VERSION/customerEmployees/{id}
Parameters:
Name | Description | Type | Required | Examples values |
---|---|---|---|---|
id | Id of the desired record to delete | Long | Yes | 777 |
URL with external_id:
https://BASE_URL/api/VERSION/customerEmployees/reference/{customerId}/{userId}
Parameters:
Name | Description | Type | Required | Examples values |
---|---|---|---|---|
customerId | reference of the customer | String | Yes | CC-002 |
userId | reference of the user | String | Yes | U-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" }
{ "error": "delete_not_authorized", "error_description": "Customer and employee are assigned to route" }
Failure case:response.status = 404
{ "error": "not_found", "error_description": "The customer employee with the id 999 doesn't exist." }
Failure case:response.status = 500
{ "error": "server_error", "error_description": "Oops! Something went wrong..." }