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": 1,
   "spots": [
     {
       "place": {
         "id": "289c1829-d457-4cf0-be68-1df4e8a1db13",
         "adress": {
           "locality": "Wroclaw",
           "postcode": "50-556",
           "country": "PL",
           "street": "Raclawicka",
           "number": "123",
           "name": "Example name",
           "description": "Example description"
         }
       }
     },
     {
       "place": {
         "id": "63041efe-184f-43f0-980b-88ece2684539",
         "adress": {
           "locality": "Gdansk",
           "postcode": "87-800",
           "country": "PL",
           "street": "Stoczniowa",
           "number": "987",
           "name": " Example name ",
           "description": " Example description "
         },
         "coordinates": {
           "latitude": "54.3705784",
           "longitude": "18.652582"
         }
       }
     }
   ],
   "info": "example monitoring info",
   "devices": [
     "Example"
   ]
 }