(Quick Reference) Service: Delete a route

Description: This web service is used to delete an existing route object from the database



URL with external_id:


Method: DELETE


NameDescriptionTypeRequiredExample values
idid of the desired record to deleteLong/StringYes777

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_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..."