- Authentication
- Company
- Get Camera Health Errors for CompanyGET
- Create a companyPUT
- get partner settingsGET
- get audit logs of a companyGET
- get input sensors notifications of a companyGET
- get ignition notifications of a companyGET
- Get a company by IDGET
- update a company by IDPOST
- Update companyPOST
- search companiesGET
- get companies listGET
- Get a companyGET
- Get companiesGET
- get partner companies listGET
- Get own partner companyGET
- Get profile update devices statesGET
- Get profile update devicesGET
- Export profile updates progressGET
- Create zonePUT
- Update zonePOST
- Delete zoneDELETE
- Get zones for companyGET
- Get zone movementsGET
- Get zone movements by vehicleGET
- Get Camera Health Errors for Company
- Custom Role Permissions
- Device
- Get reported DTCs for devices
- Get pre-selected devices
- Store pre-selected devices
- Migrate devices to another company
- Get all device migrations for a company
- Cancel device migrations for a company
- Get company devices
- Search devices
- Update a device settings
- get a device data usage
- Play in-cab audible alert sound for device
- get devices data usage
- get a company devices by company ID
- restart a device
- get company devices with modems
- get distance
- get installed report of a device
- get an installed report
- merge profile with device config
- get audit logs of a device
- Get list of trip dates for device
- Get list of trips for passed device and date
- Get a device
- Get list of company devices
- get device with driver id
- create devices (legacy/DV4)
- Create devices (auto-prov/DV6)
- get company device using IMEI/SN
- check red bubble in manage vehicles
- Bulk device creation
- Get devices for all companies available for user
- get list of trip related snapshots
- reset status of sd card
- get list of all available dates
- Get available video list for date
- Replace device
- get replace history by device id
- clear device channel status
- get camera health error by device id
- get camera health definitions
- update camera health error by error id
- update camera health errors
- Get device list for multiple companies
- Get current activity status of devices
- 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 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 device 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
- 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
- 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
- Request IFTA report of a company
- Get IFTA report of a company
- Get IFTA report in CSV-file by company
- 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
- Record map type usage
- 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
- Asset
- Schemas
Pair RL device with external device
PUT
/external_service/{service_type}/pair
To unpair RoscoLive device from external (Webfleet / Ituran) device pass an empty
serial_number parameter.Authorization header is optional. To pair RL device with external (Webfleet / Ituran) device, if user and device (device_id parameter) belong to different companies, the user should provide bearer token in the Authorization header.Parameter Details#
serial_number parameter:additional parameter:null.{"ldw_l": "snapshot_only", "ldw_r": "snapshot_only", "hmw": "snapshot_only", "ufcw": "video_snapshot", "fcw": "video_snapshot", "pdz": "snapshot_only", "pcw": "snapshot_only", "tsr": "snapshot_only"}User Role Permissions#
| Role | Permission |
|---|---|
| Partner | |
| Partner View | |
| Custom Partner | |
| Fleet Manager | |
| Group Manager | |
| User | |
| Custom User |
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************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 PUT 'https://fleet.roscolive.com/api/v1.0/external_service//pair' \
--header 'Authorization: Bearer <token>' \
--form 'device_id=""' \
--form 'serial_number=""' \
--form 'license_plate="NYV004"' \
--form 'additional=""'Responses
🟢200Success
application/json
Body
Example
{
"meta": {
"code": 200
},
"response": "success",
"result": "OK"
}🟠401Login Required
🟠404Resource Not Found
🔴500Internal Server Error
Modified at 2025-03-27 11:20:30