WS308 - Send ETA to recipient

WS308 - Our service for sending the recipient's estimated arrival date (ETA)

This integration aims to send the recipient's estimated arrival date (ETA).

Authentication

• Calls will have transport-level authentication (Basic Authentication);
• Request user / password from the account administrator.

Features

• URL

  <https://entregas-api.comprovei.com/v1/documents/eta>

• Method:

  POST

Example

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

Property	Type	Description
Access key	JSON	Document access key to download

JSON Access Key

Parameter	Type	Description
route_number	Alphanumeric	Code given to the route in Comprovei (mandatory)
route_date	Date	Route date in Comprovei (required)
driver	Alphanumeric	Driver assigned to the route in Comprovei (required)
eta_date	Date and time	Estimated date and time of arrival (required)
coordinates	JSON	Coordinate of the driver's current location (required)
device_model	Alphanumeric	(optional) Model of the device used by the driver during the route
device_id	Alphanumeric	(optional) Device ID used by the driver during the route

Coordinates

Parameter	Type	Description
latitude	Numeric	(Required) Latitude of the event location in fractional format using American notation
longitude	Numeric	(Required) Longitude of the event location in fractional format using American notation

• Success:

  • Code: 202
    Content:

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

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

• Error:

  • Code: 400
    Content:

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