RoscoLive API v1.0
  1. Fleet Configuration
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 Device Events for Period
      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 User Info from Email Address
      GET
    • Get my Own User Info
      GET
    • Get application notifications
      GET
    • SD card reformat reminder
      POST
    • Update notification by email
      POST
    • Get event / sms notification settings
      GET
  1. Fleet Configuration

Create new profile in a company

POST
https://fleet.roscolive.com/api/v1.0/partners/companies/{company_name}/profiles
Add a new profile to a company. The configuration and configurationdv6 parameter is stringified JSON.
The configuration and configurationdv6 objects are camera configuration settings for the respective camera type. Only the configuration for the camera types the user wishes to update need to be changed, otherwise the configuration object can remain the same if no changes are needed.
Profile is not automatically applied to devices after creation, must use POST /device/{device_id}/config endpoint to apply config to each device.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://fleet.roscolive.com/api/v1.0/partners/companies//profiles' \
--form 'configurationdv6=""' \
--form 'name=""' \
--form 'configuration=""' \
--form 'dv4_driver=""' \
--form 'dv4_high_speed=""' \
--form 'dv4_fatal_gsensor=""' \
--form 'dv4_ext_driver=""' \
--form 'dv4_distraction=""' \
--form 'dv4_drowsiness=""' \
--form 'dv4_phone_use=""' \
--form 'dv6_driver=""' \
--form 'dv6_high_speed=""' \
--form 'dv6_fatal_gsensor=""' \
--form 'dv6_distraction=""' \
--form 'dv6_drowsiness=""' \
--form 'dv6_phone_use=""' \
--form 'dv6_yawning=""' \
--form 'dv6_harsh_braking=""' \
--form 'dv6_harsh_accel=""' \
--form 'dv6_lane_departure=""' \
--form 'dv6_forward_collision=""' \
--form 'dv6_headway_monitoring=""' \
--form 'dv6_following_distance=""' \
--form 'dv6_seatbelt=""' \
--form 'dv6_smoking=""'
Response Response Example
201 - Profile Created
{
    "meta": {
        "code": 201
    },
    "response": {
        "profile": {
            "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\": 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\": {\"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\": 800, \"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": "Mon, 25 Nov 2024 01:38:50 GMT",
            "id": 14633,
            "last_changed_ts": "Mon, 25 Nov 2024 01:38:50 GMT",
            "name": "New Profile Name",
            "preferred": false
        }
    },
    "result": "OK"
}

Request

Path Params

Body Params multipart/form-data

Responses

🟢201Profile Created
application/json
Body

🟠401Login Required
Modified at 2024-11-26 17:37:19
Previous
Get Device Events for Period
Next
Get a company profile
Built with