1. Trans.eu Api
  2. Monitoring tasks
  3. Monitoring tasks description

Monitoring tasks description

Descrip­tion of mon­i­tor­ing tasks usage, scope and allowed meth­ods.

Available methods

What is the scope of mon­i­tor­ing tasks:

  • cre­ate new mon­i­tor­ing task
  • get list of mon­i­tor­ing tasks
  • get details of sin­gle mon­i­tor­ing task by id
  • get loca­tion of sin­gle mon­i­tor­ing task
  • accept mon­i­tor­ing task

Creating new monitoring task

With the use of Trans.eu API it is pos­si­ble for ship­per and for­warder to cre­ate new mon­i­tor­ing task, dis­played in Trans.eu Plat­form in Mon­i­tor­ing mod­ule. After the mon­i­tor­ing task is cre­at­ed, it will be auto­mat­i­cal­ly sent to car­ri­er assigned for accep­tance.

Diagram

Stan­dard and rec­om­mend­ed process for using mon­i­tor­ing tasks

Components of single monitoring task

Each mon­i­tor­ing task con­sists of:

  • places
  • oper­a­tions
  • car­ri­er’s id

Monitoring task statuses:

  • new
  • waiting_for_carrier_acceptance
  • wait­ing for ship­per accep­tance
  • pending_monitoring_data
  • ready
  • en_route
  • alert
  • abort­ed
  • fin­ished
  • missed
  • rejected_by_carrier
  • rejected_by_shipper

Description and example values

Structure of posting new monitoring task

JsonIs requiredExam­pleTypeDescrip­tion
office_idYes11111StringIden­ti­fi­ca­tion num­ber of com­pa­ny assigned to mon­i­tor­ing task
spotsYesObject—Col­lec­tion of freights’ spots – at least one load­ing and one unload­ing is required
spots.placeYesObject—Col­lec­tion of loca­tions of mon­i­tored route
spots.place.addressYesObject—Address
spots.place.address.countryYesDEStringISO val­ue for coun­try of load­ing or unload­ing spot
spots.place.address.postcodeYesD1234StringPostal code
spots.place.address.localityYesHam­burgStringTown
spots.place.address.streetYesStrasseStringStreet
spots.place.address.numberYes11StringNum­ber
spots.place.coordinatesYesObject—Lon­gi­tude and lat­i­tude for select­ed point
spots.place.coordinates.longitudeYes49.1231FloatLon­gi­tude of the point along mon­i­tored route
spots.place.coordinates.latitudeYes11.123FloatLat­i­tude of the point along mon­i­tored route
spots.operationsYesObject—Array of oper­a­tions to be com­plet­ed in giv­en spot
spots.operations.typeYesLoad­ingStringCould be either load­ing or unload­ing, at least one of each is required
spots.operations.time_frameYesObject—Time­frame of oper­a­tion
spots.operations.time_frame.date_fromYes2021–02-16T15:00:00Time­stampDate from
spots.operations.time_frame.date_toYes2021–02-16T16:00:00Time­stampDate to
infoYesExam­pleStringAddi­tion­al infor­ma­tion or route descrip­tion

Structure of confirmation for posting new monitoring task

JsonIs requiredExam­pleTypeDescrip­tion
date_created
No
2021–02-17T13:19:30.173Z
Time­stampMon­i­tor­ing task cre­ation date
id
No
e4d753f4-b629-4c73-97e0-5dd15648b918
StringMon­i­tor­ing task ID
info
NoExam­pleStringAddi­tion­al infor­ma­tion or route descrip­tion
reference_number
No
2021/02/Q957
StringMon­i­tor­ing task ref­er­ence num­ber
role
No
Ship­per
StringWhen you add mon­i­tor­ing task, you role is ship­per
spotsNoObject—Col­lec­tion of loca­tions of mon­i­tored route
spots.operationsNoObject—Array of oper­a­tions to be com­plet­ed in giv­en spot
spots.operations.completed_atNoNullTime­stampThis field has val­ue null after adding mon­i­tor­ing task
spots.operations.is_completedNoFalseBooleanThis field has val­ue false after adding mon­i­tor­ing task
spots.operations.time_frameNoObject—Time­frame of oper­a­tion
spots.operations.time_frame.date_fromNo2021–02-16T15:00:00.000ZTime­stampDate from
spots.operations.time_frame.date_toNo2021–02-16T16:00:00.000ZTime­stampDate to
spots.operations.typeNoLoad­ingStringCould be either load­ing or unload­ing, at least one of each is required
spots.placeNoObject—Col­lec­tion of loca­tions of mon­i­tored route
spots.place.addressNoObject—Address
spots.place.address.countryNoDEStringISO val­ue for coun­try of load­ing or unload­ing spot
spots.place.address.postcodeNoD1234StringPostal code
spots.place.address.localityNoHam­burgStringTown
spots.place.address.streetNoStrasseStringStreet
spots.place.address.numberNo11StringNum­ber
spots.place.coordinatesNoObject—Lon­gi­tude and lat­i­tude for select­ed point
place.coordinates.longitudeNo49.1231FloatLon­gi­tude of the point along mon­i­tored route
place.coordinates.latitudeNo11.123FloatLat­i­tude of the point along mon­i­tored route
sta­tusNo
waiting_for_carrier_acceptance
StringMon­i­tor­ing task sta­tus
time_frameNoObject—Time­frame of mon­i­tor­ing task
time_frame.date_fromNo2021–02-16T13:30:00.000ZTime­stampDate from
time_frame.date_toNo
2021–02-18T23:00:00.000Z
Time­stampDate to

Structure of getting single monitoring task and list of tasks

JsonIs requiredExam­pleTypeDescrip­tion
date_created
No
2021–02-17T13:19:30.173Z
Time­stampMon­i­tor­ing task cre­ation date
devices
NoObject—A list of devices with their descrip­tion (such as kind, man­u­fac­tur­er, reg­is­tra­tion plate num­ber) and also dri­ver details
finished_at
No2021–02-18T23:00:00.000ZTime­stampMon­i­tor­ing fin­ish time
id
No
e4d753f4-b629-4c73-97e0-5dd15648b918
StringMon­i­tor­ing task ID
info
NoExam­pleStringAddi­tion­al infor­ma­tion or route descrip­tion
reference_number
No
2021/02/Q957
StringMon­i­tor­ing task ref­er­ence num­ber
role
No
Car­ri­er
StringYour com­pa­ny role in mon­i­tor­ing task (for added mon­i­tor­ings it will be ship­per, for received it will be car­ri­er)
spotsNoObject—Col­lec­tion of loca­tions of mon­i­tored route
spots.operationsNoObject—Array of oper­a­tions to be com­plet­ed in giv­en spot
spots.operations.completed_atNo2021–02-18T23:38:00.000ZTime­stampCom­ple­tion time
spots.operations.is_completedNoTrueBooleanIt may be true or false
spots.operations.time_frameNoObject—Time­frame of oper­a­tion
spots.operations.time_frame.date_fromNo2021–02-16T15:00:00.000ZTime­stampDate from
spots.operations.time_frame.date_toNo2021–02-16T16:00:00.000ZTime­stampDate to
spots.operations.typeNoLoad­ingStringCould be either load­ing or unload­ing, at least one of each is required
spots.placeNoObject—Col­lec­tion of loca­tions of mon­i­tored route
spots.place.addressNoObject—Address
spots.place.address.countryNoDEStringISO val­ue for coun­try of load­ing or unload­ing spot
spots.place.address.postcodeNoD1234StringPostal code
spots.place.address.localityNoHam­burgStringTown
spots.place.address.streetNoStrasseStringStreet
spots.place.address.numberNo11StringNum­ber
spots.place.coordinatesNoObject—Lon­gi­tude and lat­i­tude for select­ed point
place.coordinates.longitudeNo49.1231FloatLon­gi­tude of the point along mon­i­tored route
place.coordinates.latitudeNo11.123FloatLat­i­tude of the point along mon­i­tored route
sta­tusNo
Fin­ished
StringMon­i­tor­ing task sta­tus
time_frameNoObject—Time­frame of mon­i­tor­ing task
time_frame.date_fromNo2021–02-16T13:30:00.000ZTime­stampDate from
time_frame.date_toNo
2021–02-18T23:00:00.000Z
Time­stampDate to