Get monitoring task by reference number

Allows to get mon­i­tor­ing task details for pre­vi­ous­ly cre­at­ed mon­i­tor­ing task using freight ref­er­ence num­ber.

Url parameters and connection settings

  • URL: https://api.platform.trans.eu
  • End­point: /ext/loads-monitoring-api/v1/monitorings?filter={“referenceId”:“REFERENCE/ID/NUMBER”}
  • Method: GET

Headers

  • Con­tent-type: application/json
  • Accept: application/json
  • Autho­riza­tion: Bear­er {access_token}
  • Api-key: {unique_ap­p_api-key}

Authorization

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.

Response body example

{
  "date_created": "2021-02-18T07:34:35.000Z",
  "devices": [
    {
      "date_from": "2021-02-18T09:48:12.000Z",
      "date_to": null,
      "details": {
        "device_id": 690620,
        "name": "Skoda Fabia - CB 421GA"
      },
      "id": "16451f00-b2be-423f-90e1-bd4b366e1619",
      "is_active": true,
      "is_tracked": true,
      "linked_monitoring_id": null,
      "type": "other",
      "way": null
    },
    {
      "date_from": "2021-02-18T09:47:44.000Z",
      "date_to": null,
      "details": {
        "device_id": 681550,
        "kind": "semi-trailer",
        "manufacturer": null,
        "model": null,
        "name": "Name",
        "registration_plate_number": "Name12345",
        "vehicle_id": 231863
      },
      "id": "418150ba-0a57-4cac-946b-be1025f896af",
      "is_active": true,
      "is_tracked": true,
      "linked_monitoring_id": null,
      "type": "fleet",
      "way": null
    },
    {
      "date_from": "2021-02-18T09:47:44.000Z",
      "date_to": null,
      "details": {
        "device_id": 680224,
        "kind": "lorry",
        "manufacturer": null,
        "model": null,
        "name": "Name2",
        "registration_plate_number": "Name54321",
        "vehicle_id": 236490
      },
      "id": "79b0f70f-d32d-42f0-a103-efb46549dcb5",
      "is_active": true,
      "is_tracked": true,
      "linked_monitoring_id": null,
      "type": "fleet",
      "way": null
    },
    {
      "date_from": "2021-02-18T09:47:44.000Z",
      "date_to": null,
      "details": {
        "account_id": 771476,
        "device_id": null,
        "document_number": null,
        "document_type": null,
        "first_name": "Jan",
        "last_name": "Driver",
        "name": "Jan Driver",
        "phone_number": null
      },
      "id": "c0f05658-1df9-44e7-8e65-d5dba9c09c7a",
      "is_active": true,
      "is_tracked": true,
      "linked_monitoring_id": null,
      "type": "executor",
      "way": null
    }
  ],
  "finished_at": "2021-02-18T09:51:29.000Z",
  "id": "472f1d21-aa3a-4ddd-9f20-49754a011a2a",
  "info": "example monitoring info",
  "reference_number": "2021/02/4364",
  "role": "shipper",
  "spots": [
    {
      "id": "494f733e-dcf2-4a9d-a108-89048a92af2b",
      "operations": [
        {
          "completed_at": "2021-02-18T09:49:58.000Z",
          "is_completed": true,
          "time_frame": {
            "date_from": "2021-02-16T14:00:00.000Z",
            "date_to": "2021-02-16T23:00:00.000Z"
          },
          "type": "loading"
        }
      ],
      "owner_monitoring_id": "472f1d21-aa3a-4ddd-9f20-49754a011a2a",
      "place": {
        "address": {
          "country": "PL",
          "locality": "Warszawa",
          "name": null,
          "number": "35",
          "postcode": "00-010",
          "street": "Sienkiewicza"
        },
        "coordinates": {
          "latitude": 48.4977774,
          "longitude": 35.0896543
        }
      }
    },
    {
      "id": "17a6f80a-1406-49e4-b2ab-42f4268c04fe",
      "operations": [
        {
          "completed_at": "2021-02-18T09:51:29.000Z",
          "is_completed": true,
          "time_frame": {
            "date_from": "2021-02-17T23:00:00.000Z",
            "date_to": "2021-02-17T23:00:00.000Z"
          },
          "type": "unloading"
        }
      ],
      "owner_monitoring_id": "472f1d21-aa3a-4ddd-9f20-49754a011a2a",
      "place": {
        "address": {
          "country": "PL",
          "locality": "Wrocław",
          "name": null,
          "number": "1",
          "postcode": "50-261",
          "street": "J. Narodowej"
        },
        "coordinates": {
          "latitude": 48.4548583,
          "longitude": 35.0549241
        }
      }
    }
  ],
  "status": "alert",
  "time_frame": {
    "date_from": "2021-02-16T13:30:00.000Z",
    "date_to": "2021-02-18T23:00:00.000Z"
  }
}