Description of monitoring tasks usage, scope and allowed methods.

Available methods

What is the scope of monitoring tasks:

  • create new monitoring task
  • get list of monitoring tasks
  • get details of single monitoring task by id
  • get location of single monitoring task

Creating new monitoring task

With the use of Trans.eu API it is possible to create new own monitoring task, displayed in Trans.eu Platform in Monitoring module. After the monitoring task is created, it will be automatically sent to carrier assigned for acceptance.


Diagram

Standard and recommended process for using monitoring tasks


Components of single monitoring task

Each monitoring task consists of:

  • places
  • operations
  • carrier’s id

Description and example values

Structure of posting new monitoring task

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

Structure of confirmation for posting new monitoring task

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

Structure of getting list of monitoring tasks

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

Structure of getting single monitoring task

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