Pular para conteúdo

WS203 - Excluir Rota

Está integração tem por objetivo permitir a exclusão de uma rota no sistema, desde que ela não esteja iniciada, com a opção de também excluir seus documentos.

Autenticação

  • As chamadas terão autenticação a nível de transporte (Basic Authentication);
  • Solicite o user / password ao administrador da conta.

Características

  • URL

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

  • Método:

    POST

  • Parâmetro URL:

    Sem parâmetros

  • Parâmetro Data:

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

    • Código: 200
      Conteúdo: {"user_message": "Rota excluida com sucesso!", "internal_message": "", "response_data": "", "code": 0, "more_info": "http://dev.comprovei.com.br"}
  • Erro:

    • Código: 400
      Conteúdo: {"user_message": "Rota em andamento. Exclusão cancelada!", "internal_message": "Motorista já iniciou esta rota.", "response_data": "", "code": 400, "more_info": "http://dev.comprovei.com.br" }

    • Código: 401
      Conteúdo: {"user_message": "Rota encerrada. Exclusão cancelada!", "internal_message": "Rota já está na base.", "response_data": "", "code": 401, "more_info": "http://dev.comprovei.com.br" }

    • Código: 402
      Conteúdo: {"user_message": "", "internal_message": "Sem dados de autenticação do desenvolvedor", "response_data": "", "code": 402, "more_info": "http://dev.comprovei.com.br"}

    • Código: 403
      Conteúdo: {"user_message": "", "internal_message": "Usuário e/ou senha inválidos", "response_data": Tipo da conta, "code": 403, "more_info": "http://dev.comprovei.com.br"}

Parâmetro Data

Nome Tipo Padrão Descrição
route_name string Nome utilizado no cadastro da rota.
route_date string Data utilizada no cadastro da rota, no formato: yyyy-mm-dd
route_driver string Código do motorista utilizado no cadastro da rota.
route_numberplate string Placa utilizada no cadastro da rota.
delete_docs boolean false Exclui do sistema os documentos envolvidos na rota.