RoscoLive API v1.0
  1. Device
RoscoLive API v1.0
  • Device
    • Get device list for multiple companies
      GET
    • Get current activity status of devices
      GET
  • Driver Scoring / Coaching
    • Get company event score weights
      GET
    • Update company event score weights
      POST
  • Event
    • Get company events
      GET
    • Request videos of an event
      PUT
    • Get events for a device
      GET
  • Fleet Configuration
    • Create new profile in a company
      POST
    • Get a company profile
      GET
  • Metadata
    • Get alerts and events of devices for company
      GET
  • Report
    • Get custom report data
      GET
    • Get all events report for company
      GET
    • Get event count summary report for company devices
      GET
    • Update custom report
      POST
    • Create custom report for user
      PUT
  • User
    • Get a user
      GET
    • Get own info
      GET
    • Get application notifications
      GET
    • SD card reformat reminder
      POST
    • Update notification by email
      POST
    • Get event / sms notification settings
      GET
  1. Device

Get device list for multiple companies

GET
https://fleet.roscolive.com/api/v1.0/devices/list/search
Get a list of devices for multiple companies.
Roles with endpoint access
RolePermission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User

Request

Query Params
company_ids
string 
required
A comma-separated list of company IDs to return devices for. Requires at least 1 company ID.
Example:
"123456,654321"
search_fields
enum<string> 
optional
A comma-separated list of fields on which to search the search_str param value against. The number of values in this param MUST match number of values in search_str
Allowed values:
device_idvehicle_namegroup_namevin_numberserial_numbertag_plate
Example:
"vehicle_name,group_name"
search_str
string 
optional
A comma-separated list of search values in which to search on in the request. Each value will be searched against the values set in search_fields param.
Example:
"foo,bar"
order_fields
enum<string> 
optional
A comma-separated list of fields to order the returned data by. Number of values passed in this param MUST match number of values in order_dir
Allowed values:
device_idvehicle_namegroup_namevin_numberserial_numbertag_plate
Example:
"vehicle_name,group_name"
order_dir
string 
optional
A comma-separated list of either the value "asc" or "desc" for each field value in search_fields param to control the direction of order for the returned data.
Example:
"asc,desc"
include_data
enum<string> 
optional
A comma-separated list of columns to include in the request.
Allowed values:
data_usagechannel_statusignitiondrivermodemfirmware_versionfirmware_statusgeotabinactive_devicesmodem_rssilive_streamcamera_healthno_sd_card
Example:
"data_usage,channel_status,ignition"
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}}

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/devices/list/search?company_ids=&search_fields=&search_str=&order_fields=&order_dir&include_data' \
--header 'Cookie: session={{session}};session_token={{session_token}}'

Responses

🟢200Success
application/json
Body
meta
object 
required
Request metadata object
code
integer 
required
HTTP status code returned by response
>= 100<= 599
response
object 
required
Contains response data
result
enum<string> 
required
"OK" if successful, else "Fail" if error
Allowed values:
OKFail
Example
{
  "meta": {
    "code": 100
  },
  "response": {},
  "result": "OK"
}
🟠401Login Required
🟠404Resource Not Found
🔴500Internal Server Error
Modified at 2024-12-06 04:41:13
Next
Get current activity status of devices
Built with