WS203 - Excluir Rota (REST)

Autenticação

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

Características

Título Excluir uma rota existente no sistema.
URL http://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 Code: 200 
Content: 
{
"user_message": "Rota excluida com sucesso!",
"internal_message": "",
"response_data": "",
"code": 200,
"more_info": "http://dev.comprovei.com.br
}
Erro Code: 400 
Content: 
{
"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


Code: 401 
Content: 
{
"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


Code: 402 
Content: 
{
"user_message": "",
"internal_message": "Sem dados de autenticação do desenvolvedor",
"response_data": Tipo da conta,
"code": 402,
"more_info": "http://dev.comprovei.com.br
}


Code: 403 
Content: 
{
"user_message": "",
"internal_message": "Usuário e/ou senha inválidos",
"response_data": "",
"code": 403,
"more_info": "http://dev.comprovei.com.br
}

Paramêtro 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. 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.