WS305 - Atualização de Sequência de Rota

WS305 - Nosso serviço para alteração da sequência dos documentos na Rota

Essa integração tem por objetivo alterar a sequência dos documentos na rota.

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/ws305>

• Método:

  PATCH

  Esta integração retorna um protocolo

Parâmetros

Exemplo

{
    "routes" : [{      
       "route_number" : "route-1648845123931",    
       "route_date" : "2023-05-06",    
       "numberplate" : "IJS1267",
       "new_stops_sequence" : ["31220347960950011166550020001602861056398510","2022032109422220220321731675590200"]
    }]
}

Parâmetro	Tipo	Descrição
routes	Array de JSON	Conjunto de JSON. Deve possuir somente 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)
new_stops_sequence	Array de string	Chaves dos documentos da rota já na ordem que deverão ficar (obrigatório)

• Sucesso:

  • Código: 202
    Conteúdo:

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

• Erro:

  • Código: 400
    Conteúdo:

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

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

    {
        "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 reordenar." 
    }
    

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

    { 
        "message" : "A rota possui mais chaves do que as informadas na nova sequência. Chaves faltantes: '{0}'" 
    }
    

    { 
        "message" : "As chaves '{0}' não pertencem a esta rota." 
    }
    

    { 
        "message" : "A nova sequência enviada é igual à atual da rota." 
    }
    

    { 
        "message" : "Erro ao atualizar" 
    }
    

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

• Código: 401
  Conteúdo:

      "Unauthorized"
  

• Código: 403
  Conteúdo:

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