Get a device - RoscoLive API v1.0

Gets a device object and can return supplimental data according to additional params passed.

Request

Path Params

device_id

integer

required

RoscoLive device ID

Query Params

include_data

enum<string>

optional

Comma-separated list of additional device data to include in response.

Allowed values:

replaceremovepartner_devicechannel_statusdata_usage

geotab

boolean

optional

Flag to include Geotab device data

modem

boolean

optional

Flag to include device modem data

partner_device

boolean

optional

Flag to include partner_device object in response

Cookie Params

session

string

optional

Session cookie returned from login response. Include in cookies for all API calls within user session.

Example:

session_token

string

optional

Session token returned in login response. Include in cookies for all API calls within user session.

Example:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200valid get a device

application/json

Body

meta

object

required

code

integer

required

response

object

required

device

object (Device)

required

result

string

required

Example

{
  "meta": {
    "code": 200
  },
  "response": {
    "device": {
      "cardreader": true,
      "canbus": "0",
      "device_type": "dv6",
      "is_flagged": true,
      "activated_timestamp": "2024-01-01 17:31:42",
      "active": false,
      "ads_online": false,
      "antenna_img": 1,
      "channel_available": "fugiat eu dolore aliquip sint",
      "company_id": 12345,
      "company_name": "Carroll - Runolfsdottir",
      "created_at": "2024-01-01 17:31:42",
      "config_checksum": 43447898,
      "data_limit": 1,
      "flood_blocked": 8449852,
      "device_id": "12345",
      "driver_id": "6930",
      "driver_name": "Stanley Bahringer",
      "driver_recognition": null,
      "groups": [
        "officia Excepteur",
        "dolor Ut minim dolore dolore",
        "cupidatat ad"
      ],
      "installed_by_user_id": null,
      "is_installation": false,
      "last_disconnected_ts": "2024-01-01 17:31:42",
      "live_online": true,
      "matching_token": "sed",
      "modem_img": 0,
      "online_gps": true,
      "parking_duration": 420,
      "partner_name": "Pacocha - Mraz",
      "pending_config": {
        "adas_camera_height": "150",
        "adas_camera_offset": "0",
        "adas_vehicle_hood_len": "150",
        "adas_vehicle_width": "170",
        "canbus": "0",
        "cardreader": true,
        "parking_duration": "Ut ullamco adipisicing ipsum eu",
        "timezone": "2024-01-01 17:31:42"
      },
      "power_img": 68138184,
      "status": "used",
      "serial_number": null,
      "users": "consequat ut",
      "vehicle_icon": "van",
      "vehicle_name": null,
      "vin_number": "in Excepteur eiusmod dolor",
      "windshield_img": 1,
      "uploaded_company_profile": null,
      "timezone": "America/Halifax",
      "tag_plate": null,
      "installed_id": "commodo deserunt cupidatat qui",
      "dms_enabled": true,
      "is_installation_report": false,
      "deleted_at": "2024-01-01T17:31:42.0Z",
      "recording_status": "OK",
      "disable_live_stream": false,
      "driver_last_update": "2024-01-01 17:31:42",
      "general_status": "proident fugiat",
      "last_sleep_connected_ts": "2024-01-01 17:31:42",
      "last_sleep_disconnected_ts": "2024-01-01 17:31:42",
      "partner_device": {
        "device_data": {}
      },
      "silence_err_notifs": "in laborum fugiat",
      "sleep_mode_enabled": true
    }
  },
  "result": "OK"
}

🟠400get a device with incorrect device_id

🟠401Login Required