Allows to get location updates for previously created monitoring task.
Technical aspects
Url parameters and connection settings
- URL: https://api.platform.trans.eu
- Endpoint: /ext/loads-monitoring-api/v1/monitorings
- Method: GET
- Authorization: Bearer {access_token}
- Content-type: application/json
Authorization
Authorization process is described here. Each API request must also consist of unique Api-key obtained during application registration together with client_id and client_secret.
For accessing freights API no additional scopes are set, therefore the scope parameter can be left empty.
Response body example
{
"_embedded": {
"monitorings": [
{
"_embedded": {
"unconfirmed_alerts": []
},
"details": {
"status_details": null
},
"id": "d259ba03-b91e-4289-9f6c-51fc7e3647z2",
"role": "shipper",
"status": "new",
"state": "new",
"confirmation_status": "waiting_for_acceptance",
"finished_at": null,
"spots": [
{
"id": "03e0bb02-ff34-4a91-8441-98a72fa70f40",
"place": {
"id": "a9a0a2e4-ef48-479b-a887-b3485f905386",
"address": {
"locality": "Wrocław",
"postcode": "50-019",
"country": "PL",
"street": null,
"number": null,
"name": null,
"description": null,
"gis_id": null,
"foreign_id": null,
"detailed_location_id": null,
"radius": 5000
},
"coordinates": {
"latitude": 51.1,
"longitude": 17.03333
}
},
"operations": [
{
"id": "8127140c-f876-4567-9a0f-885fbd1851eb",
"type": "loading",
"time_frame": {
"date_from": "2020-05-21T00:00:00.000Z",
"date_to": "2020-05-21T00:00:00.000Z"
},
"is_completed": false,
"completion_type": null,
"delay_from_executor": 0,
"completed_at": null
}
],
"owner_monitoring_id": "d259ba03-b91e-4289-9f6c-51fc7e3647a2"
},
{
"id": "f265bde1-fe9c-4da0-bcd1-99af2d865536",
"place": {
"id": "151d3586-660c-46dd-b34d-e1f99f82a88f",
"address": {
"locality": "Warszawa",
"postcode": "00-693",
"country": "PL",
"street": null,
"number": null,
"name": null,
"description": null,
"gis_id": null,
"foreign_id": null,
"detailed_location_id": null,
"radius": 5000
},
"coordinates": {
"latitude": 52.22977,
"longitude": 21.01178
}
},
"operations": [
{
"id": "68d8cb69-ff55-40ea-83aa-c173c9387732",
"type": "unloading",
"time_frame": {
"date_from": "2020-06-09T12:00:00.000Z",
"date_to": "2020-06-09T12:00:00.000Z"
},
"is_completed": false,
"completion_type": null,
"delay_from_executor": 0,
"completed_at": null
}
],
"owner_monitoring_id": "d259ba03-b91e-4289-9f6c-51fc7e3647a2"
}
],
"date_created": "2020-05-19T11:42:41.000Z",
"reference_number": "2020/05/19/18",
"devices": [],
"companies": {
"owner": {
"id": 123,
"name": "Sample company name",
"contact_person": {
"first_name": "Name",
"last_name": "Surname",
"account_id": 749989
}
},
"shipper": {
"id": 1007374,
"name": "Sample company carrier name",
"contact_person": {
"first_name": "Name",
"last_name": "Surname",
"account_id": 749989
}
},
"carrier": {
"id": 562769,
"name": "Carrier",
"contact_person": {
"first_name": "Name",
"last_name": "Surname",
"account_id": 707312
}
}
},
"time_frame": {
"date_from": "2020-05-20T23:30:00.000Z",
"date_to": "2020-06-10T12:00:00.000Z"
},
"source": {
"name": "freight-orders",
"data": {
"order_id": "60d04250-0eeb-4da6-9ae2-efbf9feee375",
"order_number": "2020/05/19/18",
"order_shipment_external_id": null,
"freight_legacy_id": null,
"freight_reference_number": null
}
},
"tracking_required": true,
"info": null,
"config": {
"start_buffer_in_minutes": 30,
"delay_monitoring_start_buffer_in_minutes": 60,
"delay_monitoring_interval_in_minutes": 20
},
"vehicle_size": "4_any_size",
"_links": {
"self": {
"href": "https://service.loads-monitoring.query/api/rest/v2/monitorings/d259ba03-b91e-4289-9f6c-51fc7e3647a2"
},
"monitorings": []
}
},
{
"_embedded": {
"unconfirmed_alerts": []
},
"details": {
"status_details": null
},
"id": "6cc575f0-3759-4715-b01f-e0a18dd0ffce",
"role": "shipper",
"status": "waiting_for_carrier_acceptance",
"state": "new",
"confirmation_status": "waiting_for_acceptance",
"finished_at": null,
"spots": [
{
"id": "6725b070-b430-46e8-a7da-6fe2a08fa200",
"place": {
"id": "f45d981f-5c2d-41cf-9ff3-a96c54ce343a",
"address": {
"locality": "Moskwa",
"postcode": "54-220",
"country": "RU",
"street": "Nowa",
"number": "2",
"name": null,
"description": null,
"gis_id": null,
"foreign_id": null,
"detailed_location_id": null,
"radius": 5000
},
"coordinates": {
"latitude": 55.755825,
"longitude": 37.617298
}
},
"operations": [
{
"id": "f6e6c2b2-c1c7-4413-9e0f-9bdcd0c0e245",
"type": "loading",
"time_frame": {
"date_from": "2020-06-20T07:30:00.000Z",
"date_to": "2020-06-20T07:30:00.000Z"
},
"is_completed": false,
"completion_type": null,
"delay_from_executor": 0,
"completed_at": null
}
],
"owner_monitoring_id": "6cc575f0-3759-4715-b01f-e0a18dd0ffce"
},
{
"id": "5880a7e6-48fe-45ef-9eeb-281ac6bd352f",
"place": {
"id": "9652a907-2987-43e6-8673-d23bca150360",
"address": {
"locality": "Lizbona",
"postcode": "00-910",
"country": "PT",
"street": "Stara",
"number": "2",
"name": null,
"description": null,
"gis_id": null,
"foreign_id": null,
"detailed_location_id": null,
"radius": 5000
},
"coordinates": {
"latitude": 38.722252,
"longitude": -9.139337
}
},
"operations": [
{
"id": "99393439-9cf6-42ad-a948-1fb37887a4cc",
"type": "unloading",
"time_frame": {
"date_from": "2020-06-22T16:30:00.000Z",
"date_to": "2020-06-22T16:30:00.000Z"
},
"is_completed": false,
"completion_type": null,
"delay_from_executor": 0,
"completed_at": null
}
],
"owner_monitoring_id": "6cc575f0-3759-4715-b01f-e0a18dd0ffce"
}
],
"date_created": "2020-05-27T07:02:19.000Z",
"reference_number": "2020/05/0OVW",
"devices": [],
"companies": {
"owner": {
"id": 1007374,
"name": "Example company name",
"contact_person": {
"first_name": "Barbara",
"last_name": "Demczyszak",
"account_id": 749989
}
},
"shipper": {
"id": 1007374,
"name": "Example shipper",
"contact_person": {
"first_name": "Name",
"last_name": "Surname",
"account_id": 749989
}
},
"carrier": {
"id": 562768,
"name": "Company",
"contact_person": {
"first_name": "Name",
"last_name": "Surname",
"account_id": 707311
}
}
},
"time_frame": {
"date_from": "2020-06-20T07:00:00.000Z",
"date_to": "2020-06-23T16:30:00.000Z"
},
"source": {
"name": "other",
"data": {}
},
"tracking_required": false,
"info": "example monitoring info",
"config": {
"start_buffer_in_minutes": 30,
"delay_monitoring_start_buffer_in_minutes": 60,
"delay_monitoring_interval_in_minutes": 20
},
"vehicle_size": "3_lorry",
"_links": {
"self": {
"href": "https://service.loads-monitoring.query/api/rest/v2/monitorings/6cc575f0-3759-4715-b01f-e0a18dd0ffce"
},
"monitorings": []
}
},
{
}
]
},
"total_items": 119
}