WS302 - Início de Rota

Nosso serviço de Início de Rota

Esta integração tem por objetivo abrir a solicitação de início de uma rota no Comprovei.

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://entregas-api.comprovei.com/v1/routes/start>

• Método:

PATCH

Esta integração retorna um protocolo para acompanhamento - WS301

Warning

Todos os campos opcionais serão validados caso sejam enviados, ou seja não podem estar em branco, caso não deseje enviar as informações, não acrescente os campos.

Exemplo de Request

{
  "routes" : [{   
    "occurrence_date" : "String",    
    "route_number" : "String",    
    "route_date" : "String",    
    "driver" : "String",    
    "latitude": 0,    
    "longitude" : 0,    
    "device_model" : "String",    
    "device_id" : "String"    
  }]   
 }   

Nosso JSON

• Parâmetro Routes:

Parâmetro	Tipo	Obritório	Descrição
routes	array de JSON	Sim	Conjunto de JSON. Deve possuir pelo menos um (1) objeto do tipo JSON com os campos da tabela Routes.

Routes

Parâmetro	Tipo	Obrigatório	Descrição
occurrence_date	string	Sim	Data de início da rota ('YYYY-MM-DD HH:mm:ss').
route_number	string	Sim	Número dado à rota no Comprovei.
route_date	string	Sim	Data da rota no Comprovei ('YYYY-MM-DD').
driver	string	Sim	Código do Motorista*.
latitude	number	Não	Latitude da coordenada onde foi finalizada a rota.
longitude	number	Não	Longitude da coordenada onde foi finalizada a rota.
device_model	string	Não	Modelo do aparelho usado pelo motorista durante a rota.
device_id	string	Não	Id do aparelho usado pelo motorista durante a rota.

*

Mesmo código enviado na criação da rota.

Exemplo de Response

• Sucesso:

• Código: 202
  Conteúdo:

    {
      "message" : "OK",
      "protocol" : "<protocol>"
    }
  

• Erro:

• Código: 400
  Conteúdo:

  {
    "message" : "Todas as requisições apresentaram erros" 
        "errors" : {
           "route_number" : <route_number>,
           "route_date" : <route_date>,
           "driver" : <driver>,
           "statusCode" : 4xx,
           "message" : <message>
    }
  }
  

• Código: 400
  Conteúdo:

    {
      "message" : "Corpo da requisição está vazio"
    }
  

• Código: 400
  Conteúdo:

    {
      "message" : "Campo route_number é obrigatório"
    }
  

• Código: 400
  Conteúdo:

    {
      "message" : "Campo driver é obrigatório"
    }
  

• Código: 400
  Conteúdo:

    {
      "message" : "Campo end_date é obrigatório"
    }
  

• Código: 400
  Conteúdo:

    {
      "message" : "<Data> não é uma data válida"`</br>
    }
  

• Código: 400
  Conteúdo:

  {
      "message" : "Latitude deve ser do tipo númerico"
  }
  

• Código: 400
  Conteúdo:

  {
      "message" : "Longitude deve ser do tipo númerico"
  }
  

• Código: 401
  Conteúdo:

      "Unauthorized"