Call: https://www.outreach.xyz/api/mydevices

Verb: POST

Body: EMPTY

{}


Response:


BODY

{
  "success": true,
  "message": null,
  "devices": [{
    "imei": "354014441803025",
    "camera_id": null,
    "delivery_rule": null,
    "description": "DX71 ORZ",
    "device_capability": "GEO_LOOKUP",
    "device_owner": "HAWKINS_LOGISTICS",
    "device_profile": "AUTOMOTIVE",
    "device_type": "FMB1XX",
    "enabled": true,
    "firmware": "03.25.15_32",
    "hardware": "FMB125",
    "id": "4c3d7c70-50a4-11ed-8c9e-af0b341d458a",
    "serial": "1144444326",
    "tablet_imei": null,
    "telephone_number": "204011111729531",
    "user_description": null,
    "user_group": null,
    "watchdog": true
  }, {
    "imei": "389898086063426",
    "camera_id": "0220332",
    "delivery_rule": null,
    "description": "MA20 TFV",
    "device_capability": "GEO_LOOKUP",
    "device_owner": "HAWKINS_LOGISTICS",
    "device_profile": "AUTOMOTIVE",
    "device_type": "FMB1XX",
    "enabled": true,
    "firmware": "03.27.07_00",
    "hardware": "FMB125",
    "id": "8569cc90-50a6-11ed-a0e1-579b0bcf7010",
    "serial": "1100751891",
    "tablet_imei": null,
    "telephone_number": "204988657614922",
    "user_description": null,
    "user_group": null,
    "watchdog": true
  }, {
    "imei": "358987569637872",
    "camera_id": "0180661",
    "delivery_rule": null,
    "description": "HL22 DAF",
    "device_capability": "GEO_LOOKUP",
    "device_owner": "HAWKINS_LOGISTICS",
    "device_profile": "AUTOMOTIVE",
    "device_type": "FMB1XX",
    "enabled": true,
    "firmware": "03.25.05_00",
    "hardware": "FMB125",
    "id": "87f14550-50a7-11ed-9115-57f14316f2d5",
    "serial": "1234561060",
    "tablet_imei": null,
    "telephone_number": "204048765414945",
    "user_description": null,
    "user_group": null,
    "watchdog": true
  }]
}


Notable Fields:

  1. Success: Determines success or failure of the call

  2. Message: Contains a description of the error if Success returns false

  3. Devices: A JSON array containing details of the device and vehicle


Devices Array Notable Fields:

  • imei: This is the unique identifier for this device

  • description: this is the registration number for the attached vehicle - This may contain spaces depending on region

  • device_owner: This is the system name of the organisation that the device belongs to

  • enabled: Determines whether device is enabled and will send data


NOTE:

imei and description are generally all that is needed to identify the device and associated vehicle.
The imei number is used for calls to  Retrieve Data Points