Allows to create new monitoring task with chosen carrier.

Technical aspects

Url parameters and connection settings

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

Authorization

Authorization process is described here.

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

Description and example values

Value Req Example Description
place Yes Object
place.address Yes Object
place.address.country Yes DE
place.address.postal_code Yes D1234
place.address.locality No Hamburg
place.address.street No Strasse
place.address.number No 11
place.coordinates No Object
place.coordinates.longitude No 49.1231
place.coordinates.latitude No 11.123
carrier Yes Object
carrier.vat Yes FR123716
carrier.name Yes Example name
carrier.contact_person Yes Object
carrier.contact_person.first_name Yes John
carrier.contact_person.last_name Yes Doe
reference_number No EXT0987-123

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": []
}