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/{id}
  • 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

{
    "companies": {
        "carrier": {
            "contact_person": {
                "account_id": 123,
                "first_name": "Name",
                "last_name": "Surname"
            },
            "id": 1234,
            "name": "Company Name"
        },
        "owner": {
            "contact_person": {
                "account_id": 749989,
                "first_name": "Name",
                "last_name": "Surname"
            },
            "id": 123,
            "name": "Firma Testowa Spedycja IIT"
        },
        "shipper": {
            "contact_person": {
                "account_id": 123,
                "first_name": "Barbara",
                "last_name": "Demczyszak"
            },
            "id": 1007374,
            "name": "Forwarder sample name"
        }
    },
    "config": {
        "delay_monitoring_interval_in_minutes": 20,
        "delay_monitoring_start_buffer_in_minutes": 60,
        "start_buffer_in_minutes": 30
    },
    "confirmation_status": "waiting_for_acceptance",
    "date_created": "2020-05-19T11:42:41.000Z",
    "details": {
        "status_details": null
    },
    "devices": [],
    "finished_at": null,
    "id": "d259ba03-b91e-4289-9f6c-51fc7e3647a2",
    "info": null,
    "reference_number": "2020/05/19/18",
    "role": "shipper",
    "source": {
        "data": {
            "freight_legacy_id": null,
            "freight_reference_number": null,
            "order_id": "60d04250-0eeb-4da6-9ae2-efbf9feee375",
            "order_number": "2020/05/19/18",
            "order_shipment_external_id": null
        },
        "name": "freight-orders"
    },
    "spots": [
        {
            "id": "03e0bb02-ff34-4a91-8441-98a72fa70f40",
            "operations": [
                {
                    "completed_at": null,
                    "completion_type": null,
                    "delay_from_executor": 0,
                    "id": "8127140c-f876-4567-9a0f-885fbd1851eb",
                    "is_completed": false,
                    "time_frame": {
                        "date_from": "2020-05-21T00:00:00.000Z",
                        "date_to": "2020-05-21T00:00:00.000Z"
                    },
                    "type": "loading"
                }
            ],
            "owner_monitoring_id": "d259ba03-b91e-4289-9f6c-51fc7e3647a2",
            "place": {
                "address": {
                    "country": "PL",
                    "description": null,
                    "detailed_location_id": null,
                    "foreign_id": null,
                    "gis_id": null,
                    "locality": "Wrocław",
                    "name": null,
                    "number": null,
                    "postcode": "50-019",
                    "radius": 5000,
                    "street": null
                },
                "coordinates": {
                    "latitude": 51.1,
                    "longitude": 17.03333
                },
                "id": "a9a0a2e4-ef48-479b-a887-b3485f905386"
            }
        },
        {
            "id": "f265bde1-fe9c-4da0-bcd1-99af2d865536",
            "operations": [
                {
                    "completed_at": null,
                    "completion_type": null,
                    "delay_from_executor": 0,
                    "id": "68d8cb69-ff55-40ea-83aa-c173c9387732",
                    "is_completed": false,
                    "time_frame": {
                        "date_from": "2020-06-09T12:00:00.000Z",
                        "date_to": "2020-06-09T12:00:00.000Z"
                    },
                    "type": "unloading"
                }
            ],
            "owner_monitoring_id": "d259ba03-b91e-4289-9f6c-51fc7e3647a2",
            "place": {
                "address": {
                    "country": "PL",
                    "description": null,
                    "detailed_location_id": null,
                    "foreign_id": null,
                    "gis_id": null,
                    "locality": "Warszawa",
                    "name": null,
                    "number": null,
                    "postcode": "00-693",
                    "radius": 5000,
                    "street": null
                },
                "coordinates": {
                    "latitude": 52.22977,
                    "longitude": 21.01178
                },
                "id": "151d3586-660c-46dd-b34d-e1f99f82a88f"
            }
        }
    ],
    "state": "new",
    "status": "new",
    "time_frame": {
        "date_from": "2020-05-20T23:30:00.000Z",
        "date_to": "2020-06-10T12:00:00.000Z"
    },
    "tracking_required": true,
    "vehicle_size": "any_size"
}