Get a company profile
GET/partners/companies/{company_name}/profiles/{profile_id}Returns a Profile for a company.
Request
Path Params
company_name
string
required
Name of company in RoscoLive
profile_id
string
required
ID of profile
Query Params
include_data
enum<string>
optional
Return list of devices with profile applied
Allowed value:
installed_devices
Cookie Params
AWSALB
string
optional
Example:
{{AWSALB}}
AWSALBCORS
string
optional
Example:
{{AWSALBCORS}}
session
string
optional
Session cookie returned from login response. Include in cookies for all API calls within user session.
Example:
{{session}}
session_token
string
optional
Session token returned in login response. Include in cookies for all API calls within user session.
Example:
{{session_token}}
Request samples
Responses
200(200)
value error(400)
404 (profile doesn't exists)(404)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
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
Example200
{
"meta": {
"code": 200
},
"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\":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",
"id": 9059,
"installed_devices": [
{
"device_id": "3885439985",
"vehicle_name": "Test-FWSD-4548"
}
],
"last_changed_ts": "Mon, 22 Aug 2022 12:13:19 GMT",
"name": "default516857",
"preferred": false
}
},
"result": "OK"
}Last modified: 3 months ago