Downloading information about monitoring events in transport tasks

URL parameters and connection settings

Headers:

  • Con­tent type: app/json
  • Accept: application/json
  • Autho­riza­tion: bear­er {access_token}
  • API Key: {unique_app_api_key}

Authorization

The autho­riza­tion process is described Here. Each API request must also con­sist of unique Api-key obtained dur­ing appli­ca­tion reg­is­tra­tion togeth­er with client_id and client_secret.

Endpoint operation description

End­point is used to retrieve detailed infor­ma­tion regard­ing mon­i­tor­ing of a spe­cif­ic trans­port. It returns data on sta­tus, telem­at­ics sig­nal, time frame, par­ties involved (freight for­warder, car­ri­er), vehi­cles, oper­a­tions, require­ments and qual­i­ty and sta­tus of the mon­i­tor­ing process itself.

Getting monitoring events in transport tasks

After query­ing the end­point below, we will receive a list of mon­i­tor­ing sta­tus­es in response

/ext/transports-api/v1/transports/{transport_task_id}/monitoring

The trans­port list con­tains all the details also avail­able when query­ing using the ID

Sample query for monitoring events

GET https://api.platform.trans.eu/ext/transports-api/v1/transports/3b293499-dc30-4213-928b-2b0491369a8d/monitoring 

Sample response to monitoring events

The table below lists the key ele­ments avail­able in the response to the above query.

There isn’tJSON PathVal­ueDescrip­tion
ID mon­i­tor­ingid1e728516-b9f7-4eb2-8fd6-0779d­ba718d3Unique iden­ti­fi­er of the trans­port task
Trans­port num­bertransport_numberTT2025/04/03/6–1/1Trans­port Iden­ti­fi­ca­tion Num­ber
Freight num­berreferences.freight.numberFR/2025/04/03/2NPRFreight ref­er­ence num­ber
Order num­berreferences.order.number2025/04/03/6Order num­ber relat­ed to ship­ping
Date cre­at­eddate_created2025–04-03T06:53:15.000ZDate and time the task was cre­at­ed
Trans­port Sta­tusstatecom­plet­edGen­er­al sta­tus of the trans­port task
Sta­tus mon­i­tor­ingstatus.monitoringfin­ishSta­tus mon­i­tor­ing trans­port
Begin­ning of mon­i­tor­ingstatus.details.monitoring_start_date2025–04-03T06:58:52.000ZMon­i­tor­ing start date
Last sta­tus changestatus.details.status_change_date2025–04-03T07:19:14.000ZLast Sta­tus Update Time
Cur­rent vehi­cle posi­tionstatus.details.device_position.country + time­stampIT, 2025–04-03T07:18:54.000ZCoun­try and time of last sig­nal
Is it mon­i­torable?mon­i­torableTrueWas mon­i­tor­ing tech­ni­cal­ly pos­si­ble?
Mon­i­tor­ing sourcesmonitoring_sources[0]gpsType of telem­at­ics data source
Mon­i­tor­ing requiredrequirements.monitoring.value1_requiredWas mon­i­tor­ing required?
Track­ingrequirements.trackingTrueIs track­ing acti­vat­ed?
Car­ri­er IDcompanies.carrier.id1176749Car­ri­er Com­pa­ny ID
Car­ri­er namecompanies.carrier.nameTFC DEMO Vis­i­bil­i­ty Mon­i­tor­ingCar­ri­er com­pa­ny name
Dri­ver (Name and sur­name)devices.executor.details.nameIlona Per­api­alenkoAssigned dri­ver details
Dri­ver’s phonedevices.executor.details.phone.prefix + num­ber+0020 508655774Dri­ver’s con­tact num­ber
Vehi­cle reg­is­tra­tion num­berdevices.truck.details.plate_numberTRANSDEMLicense plate of assigned vehi­cle
Vehi­cle posi­tiondevices.truck.position.coordinates.latitude + lon­gi­tude + address.locality + address.country45.14549, 7.04032 (Mon­ter, IT)Last known vehi­cle posi­tion

Below is the com­plete response from the sys­tem

{
    "_metadata": {
        "mode": "edit",
        "restrictions": {
            "companies": {
                "carrier": null
            },
            "devices": {
                "executor": {
                    "details": {
                        "document": null,
                        "identity_document_number": null,
                        "name": null,
                        "phone": null
                    },
                    "position": {
                        "address": null
                    }
                },
                "semitrailer": {
                    "position": {
                        "address": null
                    }
                },
                "truck": {
                    "position": {
                        "address": null
                    }
                }
            },
            "and": null,
            "loads": {
                "amount": null,
                "count": null,
                "description": null,
                "height": null,
                "length": null,
                "name": null,
                "type": null,
                "volume": null,
                "weight": null,
                "width": null
            },
            "monitoring": null,
            "monitoring_sources": null,
            "operations": {
                "claims": null,
                "completion_status": null,
                "and": null,
                "execution": null,
                "time_to_next_operation": null
            },
            "reports": null,
            "status": {
                "context": null,
                "details": {
                    "context": null,
                    "device_position": null,
                    "distance_to_destination": null,
                    "monitoring_start_date": null,
                    "pause_start_date": null,
                    "status_change_date": null,
                    "total_route_distance": null
                },
                "monitoring": null,
                "transport": null
            },
            "synthetic_signal": null
        }
    },
    "alerts": [],
    "archived_at": null,
    "available_actions": [
        {
            "available": true,
            "name": "unloading_complete",
            "reasons": [],
            "subactions": []
        },
        {
            "available": true,
            "name": "loading_complete",
            "reasons": [],
            "subactions": []
        },
        {
            "available": true,
            "name": "create_shared_transport",
            "reasons": [],
            "subactions": []
        }
    ],
    "claims": [
        {
            "context": "loading",
            "text": null
        },
        {
            "context": "unloading",
            "text": null
        }
    ],
    "companies": {
        "carrier": {
            "contact_person": {
                "account_id": 961872,
                "first_name": "Anna",
                "language": "PL",
                "last_name": "Lord",
                "trans_id": "1176749-1"
            },
            "id": 1176749,
            "name": "TFC DEMO Visibility Monitoring",
            "product": "tfc"
        },
        "owner": {
            "contact_person": {
                "account_id": 961871,
                "first_name": "Anna",
                "language": "IN",
                "last_name": "Lord",
                "trans_id": "1176748-1"
            },
            "id": 1176748,
            "name": "CargoON + VM demo",
            "product": "cargo"
        },
        "shipper": {
            "contact_person": {
                "account_id": 961871,
                "first_name": "Anna",
                "language": "IN",
                "last_name": "Lord",
                "trans_id": "1176748-1"
            },
            "id": 1176748,
            "name": "CargoON + VM demo",
            "product": "cargo"
        }
    },
    "date_created": "2025-04-03T06:53:15.000Z",
    "devices": {
        "executor": {
            "details": {
                "account_id": 976136,
                "company_id": 1176749,
                "document": {
                    "issuing_authority": null,
                    "number": "65454333321",
                    "type": "other"
                },
                "identity_document_number": "65454333321",
                "is_shared": true,
                "name": "Ilona Perapialenko",
                "phone": {
                    "number": "508655774",
                    "prefix": "0020"
                }
            },
            "is_leading": false,
            "is_shared": true,
            "position": null
        },
        "semitrailer": null,
        "truck": {
            "details": {
                "capacity": null,
                "combustion_norm": null,
                "dispatcher_id": null,
                "fleet_id": null,
                "id": "d29a173b-201c-11f0-b7af-02ac08cb9785",
                "kind": null,
                "loading_meters": null,
                "plate_number": "TRANSDEMO",
                "revision": null,
                "source": {
                    "context": "automatic",
                    "data": null
                },
                "type": null,
                "vehicle_id": null
            },
            "is_leading": true,
            "is_shared": true,
            "position": {
                "address": {
                    "country": "IT",
                    "description": null,
                    "locality": "Mompantero",
                    "name": null,
                    "number": "7",
                    "postcode": "10059",
                    "street": "Marzano Street"
                },
                "coordinates": {
                    "latitude": 45.14549,
                    "longitude": 7.04032
                },
                "country": "IT",
                "date": 2025-04-03T07:18:54.000Z,
                "updated_at": 2025-04-03T07:18:54.000Z
            }
        }
    },
    "and": null,
    "id": "1e728516-b9f7-4eb2-8fd6-0779dba718d3",
    "info": null,
    "monitorable": true,
    "monitoring_sources": [
        "gps"
    ],
    "operations": [
        {
            "claims": [
                {
                    "context": "loading",
                    "text": null
                }
            ],
            "completed_at": 2025-04-03T07:06:54.000Z,
            "completion_status": {
                "data": {
                    "delay_time": 133
                },
                "type": "overdue"
            },
            "completion_type": "CONFIRMED_BY_TELEMATICS",
            "contact": null,
            "estimated_execution_time": 10800,
            "and": null,
            "execution": {
                "arrival": {
                    "date": 2025-04-03T07:02:13.000Z,
                    "load_weight": null,
                    "source": {
                        "context": "telematics_monitoring",
                        "data": null
                    },
                    "vehicle_weight": null
                },
                "complete": {
                    "date": 2025-04-03T07:06:54.000Z,
                    "entry_vehicle_weight": null,
                    "exit_vehicle_weight": null,
                    "load_weight": null,
                    "source": {
                        "context": "telematics_monitoring",
                        "data": null
                    },
                    "vehicle_weight": null
                }
            },
            "id": "b1baf9c0-4a0a-43f5-8cf6-fe08f4511739",
            "index": 1,
            "loads": [],
            "place": {
                "address": {
                    "country": "FR",
                    "description": null,
                    "locality": "Saint-Martin-d'Hères",
                    "name": null,
                    "number": null,
                    "postcode": "38400",
                    "street": null
                },
                "coordinates": {
                    "latitude": 45.1812029,
                    "longitude": 5.7755091
                },
                "suggested_location_id": null,
                "timezone": "Europe/Paris"
            },
            "requirements": {
                "estimated_execution_time": null,
                "time_frame": {
                    "date_from": 2025-04-03T07:00:00.000Z,
                    "date_to": 2025-04-03T07:00:00.000Z
                }
            },
            "time_frame": {
                "date_from": 2025-04-03T07:00:00.000Z,
                "date_to": 2025-04-03T07:00:00.000Z,
                "is_precise": true
            },
            "time_frame_tz": {
                "date_from": 2025-04-03T09:00:00.000+02:00,
                "date_to": 2025-04-03T09:00:00.000+02:00,
                "is_precise": true
            },
            "time_to_next_operation": 540,
            "type": "loading",
            "warehouse": {
                "announcement": null,
                "configurations": [],
                "data": null,
                "id": "5da975cd-c4da-49a2-b4d7-0e30dec7aea6",
                "reason": "LACK_OF_WAREHOUSE",
                "status": "no_matched",
                "time_window": null
            }
        },
        {
            "claims": [
                {
                    "context": "unloading",
                    "text": null
                }
            ],
            "completed_at": 2025-04-03T07:15:54.000Z,
            "completion_status": {
                "data": {
                    "delay_time": null
                },
                "type": "on_time"
            },
            "completion_type": "CONFIRMED_BY_TELEMATICS",
            "contact": null,
            "estimated_execution_time": 10800,
            "and": null,
            "execution": {
                "arrival": {
                    "date": 2025-04-03T07:15:13.000Z,
                    "load_weight": null,
                    "source": {
                        "context": "telematics_monitoring",
                        "data": null
                    },
                    "vehicle_weight": null
                },
                "complete": {
                    "date": 2025-04-03T07:15:54.000Z,
                    "entry_vehicle_weight": null,
                    "exit_vehicle_weight": null,
                    "load_weight": null,
                    "source": {
                        "context": "telematics_monitoring",
                        "data": null
                    },
                    "vehicle_weight": null
                }
            },
            "id": "b89a1464-4b1b-4c11-aeca-a7c1d72e3e27",
            "index": 2,
            "loads": [],
            "place": {
                "address": {
                    "country": "IT",
                    "description": null,
                    "locality": "Oulx",
                    "name": null,
                    "number": null,
                    "postcode": "10056",
                    "street": null
                },
                "coordinates": {
                    "latitude": 45.0330519,
                    "longitude": 6.83251
                },
                "suggested_location_id": null,
                "timezone": "Europe/San_Marino"
            },
            "requirements": {
                "estimated_execution_time": null,
                "time_frame": {
                    "date_from": "2025-04-04T06:00:00.000Z",
                    "date_to": "2025-04-04T06:00:00.000Z"
                }
            },
            "time_frame": {
                "date_from": "2025-04-04T06:00:00.000Z",
                "date_to": "2025-04-04T06:00:00.000Z",
                "is_precise": true
            },
            "time_frame_tz": {
                "date_from": "2025-04-04T08:00:00.000+02:00",
                "date_to": "2025-04-04T08:00:00.000+02:00",
                "is_precise": true
            },
            "time_to_next_operation": null,
            "type": "unloading",
            "warehouse": {
                "announcement": null,
                "configurations": [],
                "data": null,
                "id": "e6ab44df-c3a2-409c-b6e0-fa1d48e16c9f",
                "reason": "LACK_OF_WAREHOUSE",
                "status": "no_matched",
                "time_window": null
            }
        }
    ],
    "reference_number": "Peter Gzel",
    "references": {
        "ecmr": null,
        "freight": {
            "count": 1,
            "id": "3124920",
            "number": "FR/2025/04/03/2NPR",
            "publication_id": 2617212
        },
        "order": {
            "count": 1,
            "id": "dca283a2-f493-434d-9d05-a20fc5c32f94",
            "number": "2025/04/03/6"
        }
    },
    "reports": [],
    "requirements": {
        "monitoring": {
            "value": "1_required"
        },
        "time_frame": null,
        "tracking": true,
        "transit_time": null,
        "vehicle_size": ""
    },
    "source": {
        "data": {
            "freight_legacy_id": 3124920,
            "freight_publication_id": 2617212,
            "freight_reference_number": "FR/2025/04/03/2NPR",
            "order_id": "dca283a2-f493-434d-9d05-a20fc5c32f94",
            "order_number": "2025/04/03/6",
            "order_shipment_external_id": null
        },
        "name": "freight-orders"
    },
    "state": "completed",
    "status": {
        "context": "vehicle_in_motion",
        "details": {
            "context": "vehicle_in_motion",
            "device_position": {
                "country": "IT",
                "timestamp": 2025-04-03T07:18:54.000Z
            },
            "distance_to_destination": null,
            "monitoring_start_date": "2025-04-03T06:58:52.000Z",
            "pause_start_date": null,
            "status_change_date": 2025-04-03T07:19:14.000Z,
            "total_route_distance": 156861
        },
        "monitoring": "finish",
        "transport": {
            "date": 2025-04-03T07:19:14.000Z,
            "source": {
                "context": "telematics_monitoring",
                "data": null
            },
            "value": "9_finished"
        }
    },
    "suggested_route_id": "4c0b9a00-0056-4c57-b931-d54dc1d926fd",
    "time_frame": {
        "date_from": 2025-04-03T07:00:00.000Z,
        "date_to": "2025-04-04T06:00:00.000Z"
    },
    "transport_number": "TT2025/04/03/6-1/1"
}