WS304 - Atualização de Cabeçalho de Rotas

WS304 - Nosso serviço para atualização de cabeçalho de Rotas

Essa integração tem por objetivo atualizar os dados do cabeçalho de Rotas não finalizadas

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/v2/ws304>

• Método:

  PATCH

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

Parâmetros

Exemplo

   {
      "routes" : [{      
       "route_number" : "Exemplo1",    
       "route_date" : "2019-11-11",    
       "numberplate" : "IJS1267",
       "fields" : {
            "vehicle_type_id" : 000,
            "numberplate" : "IJV6161",
            "route_number" : "Exemplo2",
            "driver" : "Comprovei",
            "driver_name" : "Motorista Comprovei de Exemplo",
            "carrier_code" : "484848484848",
            "carrier_name" : "Transportadora Teste"
            } 
        }]
    }

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

Routes

Parâmetro	Tipo	Descrição
route_number	Alfanumérico	Nome dado à rota no Comprovei (obrigatório)
route_date	Data	Data da rota no Comprovei (obrigatório)
numberplate	Alfanumérico	Número da placa no Comprovei (obrigatório)
fields	JSON	Dados que serão atualizados no cabeçalho de rota (obrigatório)

Fields

Parâmetro	Tipo	Descrição
route_number	Alfanumérico	(Opcional) Nome que irá substituir o que está no Comprovei
numberplate	Alfanumérico	(Opcional) Número de placa que irá substituir o que está no Comprovei
vehicle_type_id	Numérico	(Opcional) Identificador do Veículo que irá substuir no Comprovei
driver	Alfanumérico	(Opcional) Motorista que irá substituir o que está no Comprovei
driver_name	Alfanumérico	(Obrigatório se existir o parâmetro driver) Nome completo do Motorista
carrier_name	Alfanumérico	(Opcional) Nome da Trasportadora que irá fazer a substituição no Comprovei
carrier_code	Alfanumérico	(Obrigatório se existir o parâmetro carrier_name) Código da Trasportadora que irá fazer a substituição no Comprovei

Importante

Todos os campos opcionais serão validados e no caso de fields deve haver ao menos um valor a ser ultilizado preenchido.

• Sucesso:

  • Código: 202
    Conteúdo:

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

• Erro:

  • Código: 400
    Conteúdo:

    {
        "message": "O campo {0} deve conter pelo menos 1 item"
    }
    

    {
        "message" : "Houve um erro ao gerar o protocolo. Por favor, tente novamente mais tarde" 
    }
    

    {
        "message" : "Estado de rota invalido, essa rota já foi finalizada" 
    }
    

    {
        "message" : "Todas as requisições apresentaram erro" 
    }
    

    { 
        "message" : "Nenhum item de processamento foi encontrado no protocolo '{0}' com ação '{1}' para a requisição '{2}" 
    }
    

    { 
        "message" : "Nenhuma rota '{0}' com data '{1}' e placa '{2}' está disponível para edição de cabeçalho de rota" 
    }
    

    { 
        "message" : "Foram encontradas 0 rotas com código '{1}' na data '{2}' e número de placa '{3}" 
    }
    

    { 
        "message" : "O usuário de motorista não está com cadastro automático ativo" 
    }
    

    { 
        "message" : "Erro ao atualizar" 
    }
    

    { 
        "message" : "Um erro desconhecido aconteceu" 
    }
    

• Código: 403
  Conteúdo:

  {
      "message": "Você não possui permissão para chamar o serviço"
  }