Allows to create new monitoring task with chosen carrier.

Monitoring of shipment on the route between loading and unloading points without the need to specify the type and dimensions of the load transported. Allows to receive location updates during shipment.

Technical aspects

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • Endpoint: /ext/loads-monitoring-api/v1/monitorings
  • Method: POST
  • Authorization: Bearer {access_token}
  • Content-type: application/json

Authorization

Authorization process is described here. Each API request must also consist of unique Api-key obtained during application registration together with client_id and client_secret.

For accessing freights API no additional scopes are set, therefore the scope parameter can be left empty.

Description and example values

Value Req Example Type Description
office_id Yes Object String Identification number of company assigned to monitoring task
spots Yes Object Collection of locations of monitored route
spots.place.address.country Yes BE String ISO value for country of loading or unloading spot
spots.place.address.postal_code Yes D1234 String Postal code
spots.place.address.locality Yes Hamburg String Town
spots.place.address.street Yes Strasse String Street
spots.place.address.number Yes 11 String Number
spots.place.coordinates Yes Object Longitude and latitude for selected point
place.coordinates.longitude Yes 49.1231 Int or float Longitude of the point along monitored route
place.coordinates.latitude Yes 11.123 Int or float Latitude of the point along monitored route
info Yes Example String Additional information or route description
devices Yes [] Array To be left as empty array

Request body example

{
  "office_id": 123,
  "spots": [
    {
      "place": {
        "address": {
          "locality": "Hamburg",
          "postcode": "D1234",
          "country": "DE",
          "street": "Example street",
          "number": "17"
        },
         "coordinates": {
          "latitude": "54.3705784",
          "longitude": "18.652582"
        }
      },
      "operations": [
        {
          "type": "loading",
          "time_frame": {
            "date_from": "2020-03-23T11:27:39.000Z",
            "date_to": "2020-03-24T12:22:39.000Z"
          }
        }
      ]
    },
    {
      "place": {
        "address": {
          "locality": "Gdansk",
          "postcode": "87-800",
          "country": "PL",
          "street": "Example street",
          "number": "11"
        }
      },
      "coordinates": {
        "latitude": "54.3705784",
        "longitude": "18.652582"
      },
      "operations": [
        {
          "type": "unloading",
          "time_frame": {
            "date_from": "2020-03-25T11:27:39.000Z",
            "date_to": "2020-03-25T12:22:39.000Z"
          }
        }
      ]
    }
  ],
  "info": "Example monitoring info",
  "devices": []