RoscoLive API v1.0(v2.35.0)
  1. Device
RoscoLive API v1.0(v2.35.0)
  • Event
    • Request custom video from device
      PUT
  • Company
    • create a company
      PUT
    • get a company by ID
      GET
    • update a company by ID
      POST
    • update company
      POST
    • get a company
      GET
    • get companies
      GET
    • get own partner company
      GET
  • Device
    • Geotab
      • Pair cameras to GO devices by CSV file
    • Play in-cab audible alert sound for device
      POST
    • Get a device
      GET
  • External Service
    • Get an external service account
      GET
    • Pair RL device with external device
      PUT
    • Get RL device data via external device unique serial number
      GET
  • Fleet Configuration
    • Create new profile in a company
      POST
    • Update a company profile
      POST
    • Get a company profile
      GET
    • Get profiles of a company
      GET
    • get profile history
      GET
  1. Device

Get a device

GET
https://fleet.roscolive.com/api/v1.0/partners/devices/{device_id}
device
Gets a device object and can return supplimental data according to additional params passed.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://fleet.roscolive.com/api/v1.0/partners/devices/?include_data=&geotab=&modem=&partner_device' \
--header 'Cookie: session={{session}};session_token={{session_token}}'
Response Response Example
200 - Success
{
    "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"
}

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}}
session_token
string 
optional
Session token returned in login response. Include in cookies for all API calls within user session.
Example:
{{session_token}}

Responses

🟢200valid get a device
application/json
Body
meta
object 
required
code
integer 
required
response
object 
required
device
object (Device) 
required
result
string 
required
🟠400get a device with incorrect device_id
🟠401Login Required
Modified at 2025-04-02 14:52:40
Previous
Play in-cab audible alert sound for device
Next
Get an external service account
Built with