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.

Query parameters

  • URL: https://api.platform.trans.eu
  • Endpoint:/ext/loads-monitoring-api/v1/monitorings
  • Http Method: POST

Headers

  • Accept: application/json
  • Content-type: application/json
  • Authorization: Bearer {access_token}
  • Api-key: {unique_app_api-key}

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.

Description and example values

Json Is required Example Type Description
office_id Yes 11111 String Identification number of company assigned to monitoring task
spots Yes Object Collection of freights’ spots – at least one loading and one unloading is required
spots.place Yes Object Collection of locations of monitored route
spots.place.address Yes Object Address
spots.place.address.country Yes DE String ISO value for country of loading or unloading spot
spots.place.address.postcode 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
spots.place.coordinates.longitude Yes 49.1231 Float Longitude of the point along monitored route
spots.place.coordinates.latitude Yes 11.123 Float Latitude of the point along monitored route
spots.operations Yes Object Array of operations to be completed in given spot
spots.operations.type Yes Loading String Could be either loading or unloading, at least one of each is required
spots.operations.time_frame Yes Object Timeframe of operation
spots.operations.time_frame.date_from Yes 2021-02-16T15:00:00 Timestamp Date from
spots.operations.time_frame.date_to Yes 2021-02-16T16:00:00 Timestamp Date to
info Yes Example String Additional information or route description

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