- Authentication
- Company
- get camera health error
- create a company
- get partner settings
- get audit logs of a company
- get input sensors notifications of a company
- get ignition notifications of a company
- get a company by ID
- update a company by ID
- update company
- search companies
- get companies list
- get a company
- get companies
- get partner companies list
- get own partner company
- Custom Role Permissions
- Device
- get company devicesGET
- search devicesGET
- update a devicePOST
- get a device data usageGET
- Play in-cab audible alert sound for devicePOST
- get devices data usageGET
- get a company devices by company IDGET
- restart a deviceGET
- get company devices with modemsGET
- get distanceGET
- get installed report of a deviceGET
- get an installed reportGET
- merge profile with device configPOST
- get audit logs of a deviceGET
- get list of trip dates for deviceGET
- get list of trips for passed device and dateGET
- Get a deviceGET
- get list of company devicesGET
- get device with driver idGET
- create devices (legacy/DV4)PUT
- create devices (auto-prov/DV6)PUT
- get company device using IMEI/SNGET
- check red bubble in manage vehiclesGET
- bulk device creationPUT
- get devices for all companies available for userGET
- get list of trip related snapshotsGET
- reset status of sd cardPOST
- get list of all available datesGET
- get available video list for dateGET
- replace devicePOST
- get replace history by device idGET
- clear device channel statusPOST
- get camera health error by device idGET
- get camera health definitionsGET
- update camera health error by error idPOST
- update camera health errorsPOST
- Get device list for multiple companiesGET
- Get current activity status of devicesGET
- Device Firmware
- Driver Scoring / Coaching
- get company drivers list
- get a list of trips
- associate a driver with a trip
- get driver by event_id
- update a driver
- get driver by trip_photo_id
- get driver scores
- add driver photo
- add a driver
- remove a driver
- upload a driver from csv file
- get unknown driver trips
- associate trip with the driver.
- Get company event score weights
- Update company event score weights
- Get drivers coaching events
- Event
- Get company events
- get an event
- send an event
- get status of an event
- Request videos of an event
- get uploaded videos of an event
- get events summary of devices
- get events summary of a device
- get a company events by company ID
- get status of an event by company ID
- get snapshots of an event or alert
- get snapshots of an event or alert by company ID
- get a last event
- get a last event of devices
- get events log of a device
- get dates of events
- get events for charts and graphs
- get events for charts and graphs by company ID
- get an event by company ID
- get events summary of a device by company ID
- request videos of an event by company ID
- get dates of an events by company ID
- get a last event of company device
- clear last event
- get dates of events of a device
- push custom event
- delete an event
- request videos of an alert
- share an event
- get an event by a permalink
- get geotab events
- get a last updated event of devices
- download a blocked event
- Get flagged company events
- flag an event
- unflag an event
- generate snapshots
- local geocoding service
- update an event
- get snapshot/location of event
- Get events for a device
- Request custom video from device
- get snapshot on demand
- get an event by a permalink hash
- Set Event Label for Event
- Restore event video from archive
- Add users for notification of event restore from archive
- Add event label
- Add user feedback to event
- Get event user feedback
- Get event filters list for date range in company
- External Service
- Fleet Configuration
- Group
- get company groups
- add a group
- remove a group
- get devices of a group
- add a device to a group
- remove a device from a group
- get users of a group
- add a user to a group
- remove a user from a group
- get company groups by company ID
- add a device to a group by company ID
- get devices of a group by company ID
- remove a device from a group by company ID
- remove a group by company ID
- add a group by company ID
- add an user to a group by company ID
- get users of a group by company ID
- remove an user from a group by company ID
- edit group
- get groups with ID
- get group of a company by group ID
- Live streaming
- Metadata
- Modem Administration
- Report
- get data usage report
- Get custom report data
- get data usage report by device id
- get list of companies with data usage for date range
- get data usage for active devices for specified companies
- get companies with data usage for date range
- get data usage report for devices in company
- get data tracking report
- get all events report
- Get all events report for company
- get vehicle activity report
- get firmware report
- Get event count summary report for company devices
- get driver event breakdown report
- get driver event performance report
- Update custom report
- get custom reports by user email
- get custom report by report id
- put subscribe to a report
- get report subscriptions
- get list of standard reports
- get speeding summary report
- get speeding breakdown report
- get idling summary report
- get idling breakdown report
- Create custom report for user
- Partner Portal
- Releases
- Remote Device Management
- Statistics
- User
- get company users
- Get a user
- update a user
- remove a user
- Get own info
- create a user
- get company users by company ID
- get user settings
- set user settings
- Get application notifications
- remove the notification
- mark notifications as viewed
- verify password
- SD card reformat reminder
- Update notification by email
- assign user to company
- get permissions by a user_id
- Get event / sms notification settings
- Webhooks
Get a device
GET
/partners/devices/{device_id}
device
Request
Path Params
device_id
integerÂ
required
Query Params
include_data
enum<string>Â
optional
Allowed values:
replaceremovepartner_devicechannel_statusdata_usage
geotab
booleanÂ
optional
modem
booleanÂ
optional
partner_device
booleanÂ
optional
Cookie Params
session
stringÂ
optional
Example:
{{session}}
session_token
stringÂ
optional
Example:
{{session_token}}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
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}}'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
Modified at 2024-12-03 16:26:48