RoscoLive API v1.0
  1. Device
RoscoLive API v1.0
  • Authentication
    • Login
    • Logout
    • mark eula as viewed
    • password change
    • password reset
  • Company
    • Get Camera Health Errors for Company
    • 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
    • get full list of available custom user permission
  • Device
    • get company devices
      GET
    • search devices
      GET
    • update a device
      POST
    • get a device data usage
      GET
    • Play in-cab audible alert sound for device
      POST
    • get devices data usage
      GET
    • get a company devices by company ID
      GET
    • restart a device
      GET
    • get company devices with modems
      GET
    • get distance
      GET
    • get installed report of a device
      GET
    • get an installed report
      GET
    • merge profile with device config
      POST
    • get audit logs of a device
      GET
    • get list of trip dates for device
      GET
    • get list of trips for passed device and date
      GET
    • Get a device
      GET
    • get list of company devices
      GET
    • get device with driver id
      GET
    • create devices (legacy/DV4)
      PUT
    • create devices (auto-prov/DV6)
      PUT
    • get company device using IMEI/SN
      GET
    • check red bubble in manage vehicles
      GET
    • bulk device creation
      PUT
    • get devices for all companies available for user
      GET
    • get list of trip related snapshots
      GET
    • reset status of sd card
      POST
    • get list of all available dates
      GET
    • get available video list for date
      GET
    • replace device
      POST
    • get replace history by device id
      GET
    • clear device channel status
      POST
    • get camera health error by device id
      GET
    • get camera health definitions
      GET
    • update camera health error by error id
      POST
    • update camera health errors
      POST
    • Get device list for multiple companies
      GET
    • Get current activity status of devices
      GET
  • Device Firmware
    • get available firmware versions
    • get list of latest firmware versions
    • push firmware to device
    • cancel pending firmware update to devices
    • get firmware updates history for company
  • 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 New Driver to Company
    • 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
    • Request Custom Snapshots for Time Range
    • Request Custom Event
    • Get an Event of a Device by Start Time
    • Get an Event by ID and Storage Type
    • Get Company Events
    • Get Event by Company and ID
    • send an event
    • get status of an event
    • Request videos of an event
    • Get Uploaded Event Videos
    • 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 Event Snapshots
    • get snapshots of an event or alert by company ID
    • get a last event
    • Get Latest Event for Each Device in Company
    • 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
    • Update 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 Device Events for Period
    • 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
    • Get an external service account
    • Pair RL device with external device
    • Get RL device data via external device unique serial number
    • external service login
    • get a device
  • Fleet Configuration
    • Get profiles of a company
    • Create new profile in a company
    • Get a company profile
    • get profile history
    • Update a company profile
  • 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
    • start live streaming
    • stop live streaming
    • start multi-channel live streaming
    • stop multi-channel live streaming
  • Metadata
    • get metadata of a device
    • get metadata of devices
    • Get alerts and events of devices for company
    • get alerts for charts and graphs
    • get metadata of device(s) for last 24 hours
    • get alerts of a device
    • get alerts of a driver
  • Modem Administration
    • get list of available modems
    • upgrade modem firmware
    • upgrade modem firmware for group of devices
  • 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
    • get full list of devices per partner
    • get full list of companies per partner
    • get user custom presets
    • create custom presets
    • update custom preset
    • delete custom preset by name
  • Releases
    • get last release
    • view a release
  • Remote Device Management
    • get config values from device
    • verify of device token
    • get current firmware of devices
    • SD-card formatting
    • get config file for device
  • Statistics
    • get statistics feature usage
  • User
    • Get Company Users
    • Get User Info from Email Address
    • Update a User's Info
    • remove a user
    • Get my Own User Info
    • Create a User
    • Get 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
    • Add Webhook Subscription to Multiple Event Types
    • Get Notification Subscriptions for Event Type
    • Set Notifications for Event Type
    • Remove Notification Subscription for Event Type
    • Get All Webhook Subscriptions for a Company
    • Delete Webhook Subscription
  1. Device

update a device

POST
/partners/devices/{device_id}
Updates a device. All the attributes are optional, only the posted attributes will be changed.

Request

Path Params

Body Params multipart/form-data

Request Code 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 POST 'https://fleet.roscolive.com/api/v1.0/partners/devices/' \
--form 'vehicle_icon="Arrow 1"' \
--form 'vehicle_name="Truck 1"' \
--form 'user_email="john.doe@example.com,jane.doe@example.com"' \
--form 'driver_name="jim.doe@example.com"' \
--form 'matching_token="my-unique-matching-token-01"' \
--form 'silence_err_notifs="SD20"'

Responses

🟢200OK
application/json
Body

Example
{
    "meta": {
        "code": 200
    },
    "response": {
        "device": {
            "cardreader": true,
            "canbus": "0",
            "device_type": "dv6",
            "is_flagged": true,
            "activated_timestamp": "2024-01-01 12:31:42",
            "active": false,
            "ads_online": false,
            "antenna_img": 1,
            "channel_available": null,
            "company_id": 12345,
            "company_name": "Reilly, Cartwright and Walker",
            "created_at": "2024-01-01 12:31:42",
            "config_checksum": 31529194,
            "data_limit": 1,
            "disable_live_stream": true,
            "dms_enabled": false,
            "deleted_at": "2024-01-01 12:31:42",
            "device_id": "12345",
            "driver_id": "67376042394",
            "driver_name": "Garry Rowe",
            "driver_last_update": "2024-01-01 12:31:42",
            "driver_recognition": null,
            "flood_blocked": -96201719,
            "general_status": null,
            "groups": [
                "fugiat minim enim voluptate tempor",
                "in",
                "est"
            ],
            "installed_by_user_id": null,
            "is_installation": false,
            "is_installation_report": true,
            "last_disconnected_ts": "2024-01-01 12:31:42",
            "last_sleep_connected_ts": "2024-01-01 12:31:42",
            "last_sleep_disconnected_ts": "2024-01-01 12:31:42",
            "live_online": false,
            "matching_token": "ad culpa minim voluptate nostrud",
            "modem_img": 1,
            "modem": {
                "current_firmware": null,
                "firmware_status": "firmware out of date",
                "firmware_updated_ts": null,
                "imei": 61899221,
                "manufacturer": null,
                "model": null,
                "pending_firmware": null,
                "simcard_iccid": "Passenger Van=Passen",
                "version": null
            },
            "online_gps": false,
            "parking_duration": 480,
            "partner_device": null,
            "partner_name": "Mueller, Runte and Koelpin",
            "pending_config": {
                "adas_camera_height": "150",
                "adas_camera_offset": "0",
                "adas_vehicle_hood_len": "150",
                "adas_vehicle_width": "170",
                "canbus": "0",
                "cardreader": false,
                "parking_duration": "et cupidatat proident",
                "timezone": "2024-01-01 12:31:42"
            },
            "power_img": 90392659,
            "recording_status": "OK",
            "silence_err_notifs": null,
            "status": "used",
            "serial_number": null,
            "sleep_mode_enabled": false,
            "tag_plate": null,
            "timezone": "America/Sitka",
            "uploaded_company_profile": null,
            "users": [
                25229953,
                -24168739
            ],
            "vehicle_icon": null,
            "vehicle_name": "ullamco anim nostrud eiusmod",
            "vin_number": "eiusmod eu",
            "windshield_img": 1
        }
    },
    "result": "OK"
}
🟠400update none existing device device
🟠400update a device with an existing name
🟠401Login Required
Modified at 2025-01-14 21:29:00
Previous
search devices
Next
get a device data usage
Built with