RoscoLive API v1.0(v2.35.0)
  1. External Service
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. External Service

Pair RL device with external device

PUT
https://fleet.roscolive.com/api/v1.0/external_service/{service_type}/pair
external service
Endpoint to pair RoscoLive device with external (Webfleet / Ituran) device.
To unpair RoscoLive device from external (Webfleet / Ituran) device pass an empty serial_number parameter.
Bearer token in the 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:
Webfleet: Min length is 8 characters.
Ituran: Min length is 1 character.
additional parameter:
Webfleet: By default is equal to null.
Ituran: By default is equal to {"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#

The following table shows which user roles are allowed to send requests using this API endpoint.
RolePermission
Partner
Partner View
Custom Partner
Fleet Manager
Group Manager
User
Custom User
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://fleet.roscolive.com/api/v1.0/external_service//pair' \
--form 'device_id=""' \
--form 'serial_number=""' \
--form 'license_plate="NYV004"' \
--form 'additional=""'
Response Response Example
200 - Success
{
  "meta": {
    "code": 200
  },
  "response": "success",
  "result": "OK"
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
service_type
enum<string> 
required
Allowed values:
webfleetituran
Body Params multipart/form-data
device_id
integer 
required
Unique ID of device
serial_number
string 
required
Serial number of external device
<= 50 characters
license_plate
string  | null 
optional
>= 1 characters<= 32 characters
Default:
null
Example:
NYV004
additional
string 
optional
>= 1 characters<= 1024 characters

Responses

🟢200Success
application/json
Body
meta
object 
required
Request metadata object
code
integer 
required
HTTP status code returned by response
response
string 
required
Contains response data
result
string 
required
"OK" if successful, else "Failed" if error
🟠401Login Required
🟠404Resource Not Found
🔴500Internal Server Error
Previous
Get an external service account
Next
Get RL device data via external device unique serial number
Built with