WS316 Apontar ocorrências na rota de transferência

Clique aqui para ver histórico de versões

Data de atualização	Data de publicação do serviço	Alterações
22/03/2021	25/03/2021	Criação do webservice

Objetivo

Esta integração tem por objetivo enviar ocorrências para awbs.

Aviso

Esta é uma documentação de um serviço beta que está sujeito a alterações de campos e urls antes de sua publicação definitiva.

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/awbs/send>

• Método:

  POST

Parâmetros

Exemplo

{
    "00000111112222233333444455556666777788889999" : {
        "code" : "landing",
        "start_date" : "2021-03-23 16:09:00",
        "end_date" : "2021-03-23 16:37:00",
        "coordinates" : {
            "latitude" : 0,
            "longitude" : 0
        }
    }
}

Propriedade	Tipo	Descrição
Chave de acesso	JSON	Chave de acesso do documento para dar baixa

JSON Chave de Acesso

Parâmetro	Tipo	Descrição
code	Alfanumérico	Código da ocorrência para baixa. Deve estar cadastrada no Comprovei (obrigatório)
start_date	Data e hora	Data e hora do início da ocorrência (obrigatório)
end_date	Data e hora	Data e hora a finalização da ocorrência (obrigatório)
coordinates	JSON	Localização

JSON Coordinates

Parâmetro	Tipo	Descrição
latitude	decimal	Latitude do documento
longitude	decimal	Longitude do documento