WS360 - Send trip data

WS360 - Our service for sending travel status

This integration aims to open a request for travel status notes. The notes are “start trip”, “abort trip”, “mark arrival”.

Click here to see version history

Update date	Service publication date	Changes
07/29/2021	07/29/2021	Availability of the webservice

Authentication

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

Features

• URL

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

• Method:

  PATCH

This integration returns a protocol for monitoring - WS301

Parameters

Example

{
    "route_number":"TesteWS360",
    "route_date" : "2020-02-03",
    "driver" : "65040930160",
    "document_keys":[
        "12345678901234567890123456789012345678901231",
        "12345678901234567890123456789012345678901232",
        "12345678901234567890123456789012345678901233"
    ],
    "coordinates" : {
        "latitude" : -23.6883,
        "longitude" : -46.7075
    },
    "action_code":"ontheway",
    "datetime":"2021-08-01 09:34:54"
}

Parameter	Type	Description
route_number	Alphanumeric	Code given to the route in Comprovei (optional)
route_date	Date	Route date in Comprovei (optional)
driver	Alphanumeric	Driver assigned to the route in Comprovei (optional)
document_keys	Alphanumeric []	Key to the document(s) (required)
coordinates	Array	Driver's Latitude and Longitude (Required)
action_code	Alphanumeric	Status code (required) ontheway - On the way arrive - Arrived at the customer abort - Aborted trip
datetime	Alphanumeric	Date and time of occurrence (required)
device_id	Alphanumeric	Driver's cell phone ID (optional)
device_model	Alphanumeric	Driver's cell phone model (optional)

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

Important

All optional fields will be validated if sent, that is, they cannot be blank. If you do not wish to send optional information, do not add the fields.

• Success:

  • Code: 202
    Content:

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

• Error:

  • Code: 400
    Content:

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

    {
        "message" : "Rota não encontrada" 
    }
    

    {
        "message" : "Ação inválida" 
    }
    

    { 
        "message" : "Campos obrigatórios não preenchidos" 
    }