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

Get a company profile

GET
https://fleet.roscolive.com/api/v1.0/partners/companies/{company_name}/profiles/{profile_id}
Returns a Profile for a company.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://fleet.roscolive.com/api/v1.0/partners/companies//profiles/?include_data='
Response Response Example
200 - 200
{
    "meta": {
        "code": 200
    },
    "response": {
        "profile": {
            "advanced_quality_channels": true,
            "comments": null,
            "configuration": "{\"Channels\":[{\"index\":0,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":true,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":15,\"Audio\":0},{\"index\":1,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":true,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":15,\"Audio\":1},{\"index\":2,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":false,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":15,\"Audio\":1},{\"index\":3,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":false,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":15,\"Audio\":1}],\"Debug\":{\"LcdDisplayMode\":0,\"UseLegacyLive\":false},\"Overlay\":{\"ShowSpeed\":true},\"General\":{\"TimeZone\":\"US/Eastern\",\"IgnitionShutdownDelay\":60},\"Event\":{\"Accelerometer\":{\"Enable\":{\"Y\":true,\"X\":true,\"Z\":false},\"TriggerOutput\":-1,\"FatalThreshold\":{\"Y\":1.2,\"X\":1.2,\"Z\":2},\"Enabled\":true,\"ParkingThreshold\":{\"Y\":0.2,\"X\":0.2,\"Z\":1.2},\"SendToCloud\":false,\"FatalSendToCloud\":true,\"Threshold\":{\"Y\":10,\"X\":10,\"Z\":10},\"FatalTriggerOutput\":-1},\"PanicButton\":{\"Enabled\":true},\"Adas\":{\"Pedestrian\":{\"SendToCloud\":false,\"Enabled\":false},\"SpeedThreshold\":0,\"LaneDeparture\":{\"SendToCloud\":false,\"Enabled\":false},\"Headway\":{\"SendToCloud\":false,\"Enabled\":false},\"ForwardCollision\":{\"SendToCloud\":false,\"Enabled\":false}},\"HighSpeed\":{\"Threshold\":112.65,\"SendToCloud\":false,\"Enabled\":false,\"TriggerOutput\":-1},\"Voltage\":{\"HighThreshold\":32,\"ShutdownDelay\":20,\"LowThreshold\":11.4,\"Enabled\":true,\"RecoveryThreshold\":11.6},\"BuzzerEnabled\":false,\"Sensor\":[{\"index\":0,\"SendToCloud\":false,\"Name\":\"Sensor #1\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S1\"},{\"index\":1,\"SendToCloud\":false,\"Name\":\"Sensor #2\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S2\"},{\"index\":2,\"SendToCloud\":false,\"Name\":\"Sensor #3\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S3\"},{\"index\":3,\"SendToCloud\":false,\"Name\":\"Sensor #4\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S4\"},{\"index\":4,\"SendToCloud\":false,\"Name\":\"External Driver Event\",\"TriggerOutput\":-1,\"Enabled\":true,\"ShortName\":\"EE\"},{\"index\":8,\"SendToCloud\":true,\"TriggerOutput\":-1}],\"HighTemperature\":{\"Threshold\":99,\"ShutdownDelay\":150,\"Enabled\":true},\"Dms\":{\"Distraction\":{\"Enabled\":false,\"SendToCloud\":false},\"PhoneUse\":{\"Enabled\":false,\"SendToCloud\":false},\"Dozing\":{\"Enabled\":false,\"SendToCloud\":false},\"HeadDown\":{\"Enabled\":false,\"SendToCloud\":false},\"Enabled\":false,\"Yawning\":{\"Enabled\":false,\"SendToCloud\":false}}},\"Servers\":{\"Ads\":{\"ShutdownDelay\":480}},\"System\":{\"SpeedUnit\":1,\"BacklightLow\":100,\"BacklightHigh\":700,\"DisplaySpeed\":false},\"Recording\":{\"LockEventFiles\":false},\"Peripherals\":{\"Mobileye\":{\"Enabled\":false},\"Dms\":{\"Enabled\":false}}}",
            "configurationdv6": "{\"Channels\":[{\"index\":0,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":true,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":24,\"Audio\":0},{\"index\":1,\"ParkingQuality\":1,\"Substream\":true,\"Enabled\":true,\"ParkingFPS\":1,\"Record\":1,\"MainQuality\":2,\"MainFPS\":24,\"Audio\":1},{\"index\":2,\"ParkingQuality\":1,\"Substream\":false,\"Enabled\":false,\"ParkingFPS\":1,\"Record\":0,\"MainQuality\":2,\"MainFPS\":24,\"Audio\":0}],\"Debug\":{\"LcdDisplayMode\":0,\"UseLegacyLive\":false},\"Overlay\":{\"ShowSpeed\":true},\"General\":{\"TimeZone\":\"US/Eastern\",\"IgnitionShutdownDelay\":60},\"Event\":{\"Adas\":{\"Enabled\":false,\"CameraHeight\":150,\"CameraOffset\":0,\"VehicleHoodLength\":152,\"VehicleWidth\":170,\"LaneDeparture\":{\"SendToCloud\":false,\"Enabled\":false},\"ForwardCollision\":{\"Sensitivity\":0,\"SendToCloud\":false,\"Enabled\":false},\"Headway\":{\"Sensitivity\":0,\"SendToCloud\":false,\"Enabled\":false,\"SpeedUnit\":\"mph\",\"SpeedThreshold\":32,\"Ttc\":{\"TriggerThreshold\":0.6}},\"FollowingDistance\":{\"Sensitivity\":0,\"SendToCloud\":false,\"Enabled\":false,\"SpeedUnit\":\"mph\",\"SpeedThreshold\":32,\"Ttc\":{\"TriggerThreshold\":0.6}}},\"Accelerometer\":{\"Enable\":{\"Y\":true,\"X\":true,\"Z\":false},\"TriggerOutput\":-1,\"FatalThreshold\":{\"Y\":1.2,\"X\":1.2,\"Z\":2},\"Enabled\":true,\"ParkingThreshold\":{\"Y\":0.2,\"X\":0.2,\"Z\":1.2},\"SendToCloud\":false,\"FatalSendToCloud\":true,\"Threshold\":{\"Y\":10,\"X\":10,\"Z\":10},\"FatalTriggerOutput\":-1},\"HarshAccel\":{\"Threshold\":9.5,\"SendToCloud\":true,\"Enabled\":true},\"HarshBraking\":{\"Threshold\":11,\"SendToCloud\":true,\"Enabled\":true},\"HighSpeed\":{\"Threshold\":112.65,\"SendToCloud\":false,\"Enabled\":false,\"TriggerOutput\":-1},\"Voltage\":{\"HighThreshold\":32,\"ShutdownDelay\":20,\"LowThreshold\":11.5,\"Enabled\":true,\"RecoveryThreshold\":12},\"Sensor\":[{\"index\":0,\"SendToCloud\":false,\"Name\":\"Sensor #1\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S1\"},{\"index\":1,\"SendToCloud\":false,\"Name\":\"Sensor #2\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S2\"},{\"index\":2,\"SendToCloud\":false,\"Name\":\"Sensor #3\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S3\"},{\"index\":3,\"SendToCloud\":false,\"Name\":\"Sensor #4\",\"TriggerOutput\":-1,\"ActiveHigh\":true,\"Enabled\":false,\"ShortName\":\"S4\"},{\"index\":4,\"SendToCloud\":true,\"Name\":\"External Driver Event\",\"TriggerOutput\":-1,\"Enabled\":true,\"ShortName\":\"EE\"},{\"index\":8,\"SendToCloud\":true,\"TriggerOutput\":-1}],\"HighTemperature\":{\"Threshold\":99,\"ShutdownDelay\":150,\"Enabled\":true},\"Dms\":{\"CameraObstruction\":{\"Enabled\":false},\"Seatbelt\":{\"Enabled\":false,\"Sensitivity\":0},\"Distraction\":{\"Enabled\":true,\"SendToCloud\":true,\"Sensitivity\":0},\"PhoneUse\":{\"Enabled\":true,\"SendToCloud\":true,\"Sensitivity\":0},\"Enabled\":true,\"Yawning\":{\"SendToCloud\":true,\"Enabled\":true,\"Sensitivity\":0},\"Dozing\":{\"SendToCloud\":true,\"Enabled\":true,\"Sensitivity\":0},\"Sensitivity\":1,\"HeadDown\":{\"SendToCloud\":true,\"Enabled\":true,\"Sensitivity\":0},\"Smoking\":{\"Enabled\":false,\"Sensitivity\":0}},\"BuzzerEnabled\":false},\"Servers\":{\"Ads\":{\"ShutdownDelay\":480},\"SleepMode\":{\"Enabled\":false}},\"System\":{\"SpeedUnit\":1,\"Chimes\":{\"CameraObstruction\":{\"Enabled\":0},\"Dms\":false,\"Volume\":100,\"Adas\":false,\"Accelerometer\":false,\"HarshBraking\":false,\"HarshAccel\":false,\"HighSpeed\":false,\"Distraction\":true,\"Yawning\":true,\"Drowsiness\":true,\"PhoneUse\":true,\"ForwardCollision\":true,\"Headway\":true,\"FollowingDistance\":true,\"LaneDeparture\":true,\"Smoking\":false,\"Seatbelt\":false}},\"Recording\":{\"LockEventFiles\":false},\"Peripherals\":{\"CanBus\":{\"Type\":0}}}",
            "created_at": "Wed, 10 Aug 2022 12:39:29 GMT",
            "event_types": {
                "dv4_distraction": "video_snapshot",
                "dv4_driver": "video_snapshot",
                "dv4_drowsiness": "video_snapshot",
                "dv4_ext_driver": "snapshot_only",
                "dv4_fatal_gsensor": "video_snapshot",
                "dv4_high_speed": "alert_only",
                "dv4_phone_use": "video_snapshot",
                "dv6_camera_block": "alert_only",
                "dv6_distraction": "video_snapshot",
                "dv6_driver": "video_snapshot",
                "dv6_drowsiness": "video_snapshot",
                "dv6_fatal_gsensor": "video_snapshot",
                "dv6_following_distance": "snapshot_only",
                "dv6_forward_collision": "snapshot_only",
                "dv6_harsh_accel": "video_snapshot",
                "dv6_harsh_braking": "video_snapshot",
                "dv6_headway_monitoring": "snapshot_only",
                "dv6_high_speed": "alert_only",
                "dv6_lane_departure": "snapshot_only",
                "dv6_phone_use": "video_snapshot",
                "dv6_seatbelt": "video_snapshot",
                "dv6_smoking": "video_snapshot",
                "dv6_yawning": "video_snapshot"
            },
            "id": 9059,
            "installed_devices": [
                {
                    "device_id": "3885439985",
                    "device_type": "dv6",
                    "vehicle_name": "Test-FWSD-4548"
                }
            ],
            "last_changed_ts": "Mon, 22 Aug 2022 12:13:19 GMT",
            "name": "default516857",
            "preferred": false
        }
    },
    "result": "OK"
}

Request

Path Params
profile_id
integer 
required
ID of company profile
Query Params
include_data
enum<string> 
optional
Data to include in response
Allowed values:
installed_devicesevent_types

Responses

🟢200200
application/json
Body
meta
object 
required
Request metadata object
code
integer 
required
response
object 
required
Contains response data
profile
object 
required
Profile object
result
enum<string> 
required
"OK" if request successful, otherwise "Failed"
Allowed values:
OKFailed
🟠400value error
🟠404404 (profile doesn't exists)
🟠401Login Required
Modified at 2025-04-02 14:52:40
Previous
Update a company profile
Next
Get profiles of a company
Built with