WS308 - Enviar previsão de chegada no destinatário (ETA)

WS308 - Nosso serviço para envio da previsão de chegada no destinatário (ETA)

Esta integração tem por objetivo enviar previsão de chegada no destinatário (ETA).

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/documents/eta>

• Método:

  POST

Exemplo

{
    "41190943434343434343550020003567351594519865" : {
        "route_number" : "TesteWS313",
        "route_date" : "2020-02-03",
        "driver" : "65040930160",
        "eta_date" : "2020-02-03 15:00:00",
        "coordinates" : {
            "latitude" : -23.6883,
            "longitude" : -46.7075
        },
        "device_model" : "SMA150",
        "device_id" : "123456"
    }
}

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
route_number	Alfanumérico	Código dado à rota no Comprovei (obrigatório)
route_date	Data	Data da rota no Comprovei (obrigatório)
driver	Alfanumérico	Motorista atribuído à rota no Comprovei (obrigatório)
eta_date	Data e hora	Data e hora previstas de chegada (obrigatório)
coordinates	JSON	Coordenada da localização atual do motorista (obrigatório)
device_model	Alfanumérico	(opcional) Modelo do aparelho usado pelo motorista durante a rota
device_id	Alfanumérico	(opcional) Id do aparelho usado pelo motorista durante a rota

Coordinates

Parâmetro	Tipo	Descrição
latitude	Numérico	(Obrigatório) Latitude do local do evento no formato fracionário usando notação americana
longitude	Numérico	(Obrigatório) Longitude do local do evento no formato fracionário usando notação americana

• Sucesso:

  • Código: 202
    Conteúdo:

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

    {
        "message" : "Algumas rotas enviadas apresentaram erros. Consulte o protocolo para detalhes",
        "protocol" : "<protocol>" 
    
    }
    

• Erro:

  • Código: 400
    Conteúdo:

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

    {
        "message" : "Corpo da requisição não é um JSON válido" 
    }
    

    { 
        "message" : "Em <chave_documento>, a chave do documento não deve estar vazia" 
    }
    

    {
        "message" : "Em <chave_documento>, o corpo do documento deve ser um objeto JSON" 
    }
    

    {
        "message" : "Em <chave_documento>, campo 'route_number' deve ser alfanumérico" 
    }
    

    {
        "message" : "Em <chave_documento>, campo 'route_date' deve ser alfanumérico" 
    }
    

    {
        "message" : "Em <chave_documento>, '<date>' não é uma data válida para 'route_date'" 
    }
    

    {
        "message" : "Em <chave_documento>, campo 'driver' deve ser alfanumérico" 
    }
    

    {
        "message" : "Em <chave_documento>, se o campo 'route_date' for enviado, os campos 'route_number' e 'driver' são obrigatórios" 
    }
    

    {
        "message" : "Em <chave_documento>, campo 'code' é obrigatório" 
    }
    

    {
        "message" : "Em <chave_documento>, campo 'eta_date' é obrigatório" 
    }
    

    {
        "message" : "Em <chave_documento>, campo 'eta_date' deve ser alfanumérico" 
    }
    

    {
        "message" : "Em <chave_documento>, '<date>' não é uma data válida para 'eta_date'" 
    }
    

    {
        "message" : "Em <chave_documento>, campo 'coordinates' é obrigatório" 
    }
    

    {
        "message" : "Em <chave_documento>, campo 'coordinates' deve ser um objeto JSON" 
    }
    

    {
        "message" : "Em <chave_documento> > 'coordinates': Campos 'latitude' e 'longitude' são obrigatórios" 
    }
    

    {
        "message" : "Em <chave_documento> > 'coordinates': 'latitude' deve ser do tipo númerico" 
    }
    

    {
        "message" : "Em <chave_documento> > 'coordinates': 'longitude' deve ser do tipo númerico" 
    }
    

    {
        "message" : "Em <chave_documento>, campo 'device_model' deve ser alfanumérico" 
    }
    

    {
        "message" : "Em <chave_documento>, campo 'device_id' deve ser alfanumérico" 
    }
    

    {
        "errors": [
            {
                "occurrence_code": "<codigo_ocorrencia>",
                "dkey": "<chave_documento>",
                "errors": [
                    { "code" : 404, "message" : "Documento não encontrado" },
                    { "code" : 400, "message" : "Mais de uma rota encontrada" },
                    { "code" : 400, "message" : "Rota já está finalizada ou não foi encontrada" },
                    { "code" : 400, "message" : "Documento não está associado à uma rota" },
                    { "code" : 400, "message" : "Documento já está finalizado" },
                ]
            }
        ],
        "message": "Foram encontrados erros em todos os documentos enviados"
    }