Skip to content

WS303 - Start AWB

WS303 - Start of AWB

This integration aims to open the request to start an awb in Comprovai.

Click here to see version history
Update date Service publication date Changes
02/09/2021 02/15/2021 Creation of the webservice

Warning

This is documentation of a beta service that is subject to field and url changes before its final publication.

Prerequisites

To use this service, a driver type user must be pre-registered on the platform. Your code should be awb. AWBs cannot be repeated. If this code is not unique, there will be a risk that the registration will be incorrect if there are 2 identical AWBs registered in the system. The maximum number of awbs allowed to be downloaded at a time is 10.

Authentication

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

Features

  • URL

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

  • Method:

PATCH

Warning

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

  • Example of Request:
{
     "awbs" : [{
      "occurrence_date" : "2020-11-12 00:00:00",
      "awb" : "XXXXXXX"
   },{
       "occurrence_date" : "2020-11-12 00:00:00",
       "awb" : "XXXXXXX"
   }]
}

AWBs

Parameter Type Description
AWBs JSON Array Set of JSON. Must have at least one (1) JSON object with the fields from the AWB table (Required)

AWB

Parameter Type Description
awb Alphanumeric Name given to AWB in Comprovei (required)
awb_user Alphanumeric User has proven responsible for transportation (Optional)
awb_date Date AWB Date (Optional)
occurrence_date Date and time Route start date (required)
latitude Numeric Latitude of the coordinate where the route was completed (optional)
longitude Numeric Longitude of the coordinate where the route was completed (optional)
device_id Alphanumeric Device ID used by the driver during the route (optional)
device_model Alphanumeric Model of the device used by the driver during the route (optional)

  • Success:

  • Code: 202
    Content: 

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

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

  • Error:

  • Code: 401
    Content: 

        "Unauthorized"