Skip to content

WS203 - Delete Route

This integration aims to allow the deletion of a route in the system, as long as it is not started, with the option of also deleting its documents.

Authentication

  • Calls will have transport-level authentication (Basic Authentication);
  • Request user / password from the account administrator.

Features

  • URL

    https://api.comprovei.com.br/api/1.1/routes/delete/

  • Method:

    POST

  • URL parameter:

    No parameters

  • Data Parameter:

    • Type: application/json
      Example: {"route_name": "CAMPINAS", "route_date": "2015-11-09", "route_driver": "0017", "route_numberplate": "AAA1234", "delete_docs": true}

  • Success:

    • Code: 200
      Content: {"user_message": "Route deleted successfully!", "internal_message": "", "response_data": "", "code": 0, "more_info": "http://dev.comprovei.com.br"}

  • Error:

    • Code: 400
      Content: {"user_message": "Route in progress. Deletion cancelled!", "internal_message": "Driver has already started this route.", "response_data": "", "code": 400, "more_info": "http://dev.comprovei.com.br" }

    • Code: 401
      Content: {"user_message": "Route closed. Deletion cancelled!", "internal_message": "Route is already in the base.", "response_data": "", "code": 401, "more_info": "http://dev.comprovei.com.br" }

    • Code: 402
      Content: {"user_message": "", "internal_message": "No developer authentication data", "response_data": "", "code": 402, "more_info": "http://dev.comprovei.com.br"}

    • Code: 403
      Content: {"user_message": "", "internal_message": "Invalid username and/or password", "response_data": Account type, "code": 403, "more_info": "http://dev.comprovei.com.br"}

Date Parameter

Name Type Standard Description
route_name string Name used when registering the route.
route_date string Date used in route registration, in the format: yyyy-mm-dd
route_driver string Driver code used when registering the route.
route_numberplate string Plate used in route registration.
delete_docs boolean false Deletes the documents involved in the route from the system.