# RoscoLive API v1.0 ## Docs - [Device Firmware](https://roscolive-api-v1.apidog.io/1740019f0.md): Endpoints to manage and update device firmware. - [Webhooks](https://roscolive-api-v1.apidog.io/1112502f0.md): ## API Docs - Authentication [Login](https://roscolive-api-v1.apidog.io/6474265e0.md): Login a user to begin a user session. Once logged in, a `session` and `session_token` cookie will be returned. Pass these cookies in the request header for any subsequent API requests for actions using this current user session. User session tokens expire after 24 hours in which a Login request will have to be resubmitted to retrieve a new session. - Authentication [Logout](https://roscolive-api-v1.apidog.io/6474266e0.md): Logout the current user session. - Authentication [mark eula as viewed](https://roscolive-api-v1.apidog.io/6474269e0.md): Mark EULA as 'viewed' for the logged in user. - Authentication [password change](https://roscolive-api-v1.apidog.io/6474268e0.md): Change the password for the current user. User password must adhere to the following rules: - Authentication [password reset](https://roscolive-api-v1.apidog.io/6474267e0.md): Password reset. If the account exists, user will receive an email with instruction. User can use the link included in the email to reset password. - Company [get camera health error](https://roscolive-api-v1.apidog.io/6474286e0.md): Get camera health error - Company [create a company](https://roscolive-api-v1.apidog.io/6474282e0.md): Create a new company. - Company [get partner settings](https://roscolive-api-v1.apidog.io/6474280e0.md): Get partner settings - Company [get audit logs of a company](https://roscolive-api-v1.apidog.io/6474279e0.md): Partner gets audit logs of a company. 'start_date' and 'end_date' have the following format 'YYYYmmDD'. 'log_type' can have the following values: 'user' or 'device'. - Company [get input sensors notifications of a company](https://roscolive-api-v1.apidog.io/6474278e0.md): - Company [get ignition notifications of a company](https://roscolive-api-v1.apidog.io/6474277e0.md): An user gets notifications of a company when ignition works in a vehicle - Company [get a company by ID](https://roscolive-api-v1.apidog.io/6474276e0.md): Return data for company of the passed in `company_id` - Company [update a company by ID](https://roscolive-api-v1.apidog.io/6474275e0.md): Update a company's information. All fields are optional and only passed in fields will be updated. **NOTE**: Only Partner companies with correct permission can update companies. - Company [update company](https://roscolive-api-v1.apidog.io/6474274e0.md): Update a company's information. All fields are optional and only passed in fields will be updated. **NOTE**: Only Partner companies with correct permission can update companies. - Company [search companies](https://roscolive-api-v1.apidog.io/6474273e0.md): Return results of a query to RoscoLive for company based on keyword search using company name. Will return a list of all companies that match keyword search. - Company [get companies list](https://roscolive-api-v1.apidog.io/6474272e0.md): Returns a list of all company names available to the user. - Company [get a company](https://roscolive-api-v1.apidog.io/6474271e0.md): Returns a single company object. - Company [get companies](https://roscolive-api-v1.apidog.io/6474270e0.md): Returns a list of company objects for all companies associated with the partner. - Company [get partner companies list](https://roscolive-api-v1.apidog.io/8880905e0.md): Returns a list of company objects related to the current user's partner with select data. - Company [get own partner company](https://roscolive-api-v1.apidog.io/8880428e0.md): Returns the Partner company data the current user belongs to. - Custom Role Permissions [get full list of available custom user permission](https://roscolive-api-v1.apidog.io/6474468e0.md): API to get full list of available custom user permissions from the permissions_categories table - Device [get company devices](https://roscolive-api-v1.apidog.io/6474305e0.md): Partners view all devices in a company. page_number and page_size are optional to paginate the user list. List of devices in the response can be filtered by optional parameter "fields" with values are "device_id", "vehicle_name", "firmware", "groups", "users". Several values should be separated by ','. - Device [search devices](https://roscolive-api-v1.apidog.io/6474306e0.md): Partner searches devices with device id or vehicle name - Device [update a device](https://roscolive-api-v1.apidog.io/6474307e0.md): Updates a device. All the attributes are optional, only the posted attributes will be changed. - Device [get a device data usage](https://roscolive-api-v1.apidog.io/6474308e0.md): Gets a device's data usage history, - Device [Play audible alert sound](https://roscolive-api-v1.apidog.io/12419742e0.md): A utility endpoint that will push a command to the camera to play an audible in-cab alert sound immediately upon receipt of the request. - Device [get devices data usage](https://roscolive-api-v1.apidog.io/6474309e0.md): Gets a devices' data usage history, - Device [get a company devices by company ID](https://roscolive-api-v1.apidog.io/6474310e0.md): Partner gets devices in the company by company ID - Device [restart a device](https://roscolive-api-v1.apidog.io/6474311e0.md): Partner can restart the device forcibly if it is needed - Device [get company devices with modems](https://roscolive-api-v1.apidog.io/6474312e0.md): Partner gets a list of devices with modems - Device [get distance](https://roscolive-api-v1.apidog.io/6474313e0.md): An user gets distance in kilometers a vehicle has travelled. 'start_date' and 'end_date' parameters have the following format 'YYYYmmDD' - Device [get installed report of a device](https://roscolive-api-v1.apidog.io/6474314e0.md): Partner gets a list of installed reports of a device - Device [get an installed report](https://roscolive-api-v1.apidog.io/6474315e0.md): Partner gets an installed report - Device [merge profile with device config](https://roscolive-api-v1.apidog.io/6474316e0.md): Merging of a profile with a configuration file of a device. Several device IDs should be separated by ',' - Device [get audit logs of a device](https://roscolive-api-v1.apidog.io/6474317e0.md): Partner gets audit logs of a device. 'start_date' and 'end_date' parameters should have the following format: 'YYYYmmDD'. Several device IDs should be separated by ','. 'event' parameter can have one or a few the following values separated by ',': 'change_device', 'delete_device', 'create_device_group', 'change_device_group', 'delete_device_group', 'sd_format_device', 'request_device_file', 'push_device_file', 'send_device_config', 'receive_device_file', 'create_device' - Device [get list of trip dates for device](https://roscolive-api-v1.apidog.io/6474318e0.md): Partner gets list of trip dates for device. The format of start_ts and end_ts is YYYYMMDDHHMMSS, eg:20200706000000. Timezone format is UTC+(-12;+12) - Device [ get list of trips for passed device and date](https://roscolive-api-v1.apidog.io/6474319e0.md): Partner gets a list of trips for passed device and date. The format of start_ts and end_ts is YYYYMMDDHHMMSS, eg:20200706000000 - Device [ Get a device](https://roscolive-api-v1.apidog.io/6474320e0.md): Gets a device object and can return supplimental data according to additional params passed. - Device [get list of company devices](https://roscolive-api-v1.apidog.io/6474321e0.md): Get list of company devices using company ID. - Device [get device with driver id](https://roscolive-api-v1.apidog.io/6474322e0.md): Get device with driver_id - Device [create devices (legacy/DV4)](https://roscolive-api-v1.apidog.io/6474323e0.md): Partner creates a device in a company's account. 50 devices and more can be created at the same time. - Device [create devices (auto-prov/DV6)](https://roscolive-api-v1.apidog.io/6474324e0.md): Create a device in a company's account. 50 devices and more can be created at the same time. - Device [get company device using IMEI/SN](https://roscolive-api-v1.apidog.io/6474325e0.md): Retrieving company device using IMEI/SN - Device [check red bubble in manage vehicles](https://roscolive-api-v1.apidog.io/6474326e0.md): Check red bubble in manage vehicle - Device [bulk device creation](https://roscolive-api-v1.apidog.io/6474327e0.md): Allow bulk device creation - Device [get devices for all companies available for user](https://roscolive-api-v1.apidog.io/6474328e0.md): Returns devices for all companies available for user - Device [get list of trip related snapshots](https://roscolive-api-v1.apidog.io/6474329e0.md): Get list of trip related snapshots - Device [reset status of sd card](https://roscolive-api-v1.apidog.io/6474330e0.md): Reset status of sd card. Geotab_user_id is a token of geotab_user - Device [get list of all available dates](https://roscolive-api-v1.apidog.io/6474331e0.md): Retrieve the video list availability object for a device - Device [get available video list for date](https://roscolive-api-v1.apidog.io/6474332e0.md): **Get available video list for date** - Device [replace device](https://roscolive-api-v1.apidog.io/6474333e0.md): Used when performing a replacement on a vehicle. A "camera" replacement is the removal of a camera from a vehicle to be replaced with a new camera in the same vehicle. A "vehicle" replacement is the removal of a camera from a vehicle to be placed into a new vehicle. Only required to send data relevant to the replace type. - Device [get replace history by device id](https://roscolive-api-v1.apidog.io/6474334e0.md): Get the replacement history of a device using device ID. - Device [clear device channel status](https://roscolive-api-v1.apidog.io/6474335e0.md): Clear the device channel status - Device [get camera health error by device id](https://roscolive-api-v1.apidog.io/6474336e0.md): Get camera health error by device id - Device [get camera health definitions](https://roscolive-api-v1.apidog.io/6474337e0.md): Get camera health definitions - Device [update camera health error by error id](https://roscolive-api-v1.apidog.io/6474338e0.md): Update camera health error by error id - Device [update camera health errors](https://roscolive-api-v1.apidog.io/6474339e0.md): Update camera health error - Device [Get device list for multiple companies](https://roscolive-api-v1.apidog.io/11790586e0.md): Get a list of devices for multiple companies. - Device [Get current activity status of devices](https://roscolive-api-v1.apidog.io/11862662e0.md): Returns a list of current activity statuses for devices according to the passed in `device_ids`. - Device Firmware [get available firmware versions](https://roscolive-api-v1.apidog.io/8891766e0.md): Get available firmware versions. **NOTE**: Only Partners with valid permissions can access this endpoint. - Device Firmware [get list of latest firmware versions](https://roscolive-api-v1.apidog.io/8891890e0.md): Returns a list of latest firmware versions for device types. **NOTE**: Only Partners with valid permissions can successfully call this endpoint. - Device Firmware [push firmware to device](https://roscolive-api-v1.apidog.io/8891798e0.md): Push firmware update to devices. *NOTE*: Only Partners with valid permissions can successfully push firmware updates. - Device Firmware [cancel pending firmware update to devices](https://roscolive-api-v1.apidog.io/8891882e0.md): Cancel pending firmware updates to devices. Firmware updates cannot be reversed if push has been completed. **NOTE**: Only Partners with valid permissions may access this endpoint. - Device Firmware [get firmware updates history for company](https://roscolive-api-v1.apidog.io/8892021e0.md): Returns list of firmware updates to devices in company for all time. **NOTE**: Only Partners with valid permissions can access this endpoint. - Driver Scoring / Coaching [get company drivers list](https://roscolive-api-v1.apidog.io/6474450e0.md): Get a list of drivers for a company - Driver Scoring / Coaching [get a list of trips](https://roscolive-api-v1.apidog.io/6474451e0.md): Partner gets a list of each driver's trips. 'start_date' and 'end_date' parameters have the following format: 'YYYYmmdd'. 'mode' parameter is optional, it can be 'identified_drivers' or 'unidentified_drivers' by default - Driver Scoring / Coaching [associate a driver with a trip](https://roscolive-api-v1.apidog.io/6474452e0.md): Partner associates a driver with a trip by driver ID. If it's a new driver, then 'driver_name' field should be used for adding a new driver - Driver Scoring / Coaching [get driver by event_id](https://roscolive-api-v1.apidog.io/6474453e0.md): Partner gets a driver object by an event_id - Driver Scoring / Coaching [update a driver](https://roscolive-api-v1.apidog.io/6474454e0.md): Partner updates a driver - Driver Scoring / Coaching [get driver by trip_photo_id](https://roscolive-api-v1.apidog.io/6474455e0.md): Partner gets a driver by a trip photo ID - Driver Scoring / Coaching [get driver scores](https://roscolive-api-v1.apidog.io/6474456e0.md): Get Driver Scores. start_ts and end_ts format: YYYYMMDDHHMMSS - Driver Scoring / Coaching [add driver photo](https://roscolive-api-v1.apidog.io/6474457e0.md): Partner adds a photo of a driver - Driver Scoring / Coaching [add a driver](https://roscolive-api-v1.apidog.io/6474458e0.md): Add a new driver to a company. - Driver Scoring / Coaching [remove a driver](https://roscolive-api-v1.apidog.io/6474459e0.md): Partner removes a driver by driver_id - Driver Scoring / Coaching [upload a driver from csv file](https://roscolive-api-v1.apidog.io/6474460e0.md): Partner uploads a new driver(s) from *.csv file. The file should have the following titles of a head row: 'first_name', 'last_name', 'group', 'card_id' - Driver Scoring / Coaching [get unknown driver trips](https://roscolive-api-v1.apidog.io/6474461e0.md): Partner gets a list of unknown_driver trips. 'start_ts' and 'end_ts' parameters have the following format: 'YYYYmmDDHHMMSS'. - Driver Scoring / Coaching [associate trip with the driver.](https://roscolive-api-v1.apidog.io/6474462e0.md): Partner associates trip with the driver via trip id - Driver Scoring / Coaching [Get company event score weights](https://roscolive-api-v1.apidog.io/11969418e0.md): Get event score weights for driver scoring in a company. Driver score weights are on a scale of 1 to 5 with 1 being the least impactful. - Driver Scoring / Coaching [Update company event score weights](https://roscolive-api-v1.apidog.io/11969423e0.md): Update event score weights for driver scoring in a company. Driver score weights are on a scale of 1 to 5 with 1 being the least impactful. - Driver Scoring / Coaching [Get drivers coaching events](https://roscolive-api-v1.apidog.io/13688540e0.md): Returns a list of events assigned for coaching of all drivers for the passed in company ID. - Event [Get company events](https://roscolive-api-v1.apidog.io/6474361e0.md): Get all events of this company during a specific time period. - Event [get an event](https://roscolive-api-v1.apidog.io/6474362e0.md): Gets an event with the specific event id. WCS parameter is false by default - Event [send an event](https://roscolive-api-v1.apidog.io/6474363e0.md): Partner requests event and gets snapshot by device ID. The format of timestamp is YYYYmmDDHHMMSS, UTC, eg: 20170808150120. - Event [get status of an event](https://roscolive-api-v1.apidog.io/6474364e0.md): Get uploading status of a event - Event [Request videos of an event](https://roscolive-api-v1.apidog.io/6474365e0.md): Request video of a previously created custom event. Value of `event_id` parameter can be obtained from response of "Request Custom Video" or from any API that returns a list of events for the company. - Event [get uploaded videos of an event](https://roscolive-api-v1.apidog.io/6474366e0.md): Gets url of an uploaded video. Value of "request_id" parameter can be given from response of "/events/custom_clips", "/events/custom_event" or "/events/custom_alert_clips" requests. - Event [get events summary of devices](https://roscolive-api-v1.apidog.io/6474367e0.md): Views summary of events of devices, including count of events, earliest event, last event, total size of the video, last_uploaded, last_viewed. - Event [get events summary of a device](https://roscolive-api-v1.apidog.io/6474368e0.md): Views summary of events of a device, including count of events, earliest event, last event and total size of the video. - Event [get a company events by company ID](https://roscolive-api-v1.apidog.io/6474369e0.md): Gets all events of this company by company ID during a specific peroid. The format of start_ts and end_ts is YYYYmmDDHHMMSS, UTC, eg: 20170808150120 Default end_ts is current time. page_size and page_number are optional to paginate the events. - Event [get status of an event by company ID](https://roscolive-api-v1.apidog.io/6474370e0.md): Get uploading status of a company event by company ID - Event [get snapshots of an event or alert](https://roscolive-api-v1.apidog.io/6474371e0.md): Partner gets snapshots of an event by event ID. Value of "request_id" parameter can be given from response of "/events/custom_clips", "/events/custom_event" or "/events/custom_alert_clips" requests. If event has not snapshot or does not exist, 404 error will be returned - Event [get snapshots of an event or alert by company ID](https://roscolive-api-v1.apidog.io/6474372e0.md): Partner gets snapshots of a company event by event ID and company ID. Value of "request_id" parameter can be given from response of "/events/custom_clips", "/events/custom_event" or "/events/custom_alert_clips" requests. If event has not snapshot or does not exist, 404 error will be returned - Event [get a last event](https://roscolive-api-v1.apidog.io/6474373e0.md): Partner gets a last event of a device - Event [get a last event of devices](https://roscolive-api-v1.apidog.io/6474374e0.md): Returns a list of latest events from devices in the company passed into the request. - Event [get events log of a device](https://roscolive-api-v1.apidog.io/6474375e0.md): Retrieve activities regarding a device from server side. START_DATE and END_DATE are necessary, format is YYYYMMDD. To retrieve one day log, pass START_DATE and END_DATE for the same date - Event [get dates of events](https://roscolive-api-v1.apidog.io/6474376e0.md): Partner gets list with dates of events to display its in the calendar. START_TS parameter is necessary, format is YYYYmmddHHMMSS, eg: 20180220130200. END_TS parameter is optional, current time by default. The format of the TIMEZONE parameter have to be as UTC-10:00 or UTC+04:00. - Event [get events for charts and graphs](https://roscolive-api-v1.apidog.io/6474377e0.md): Partner gets events for charts and graphs. START_TS and END_TS parameters are necessary, format is YYYYmmddHHMMSS, eg: 20180220130200. Alerts can be filtered by "SD card failure", "Importer shutdown", "Camera failure". - Event [get events for charts and graphs by company ID](https://roscolive-api-v1.apidog.io/6474378e0.md): Partner gets company events by company ID for charts and graphs. START_TS and END_TS parameters are necessary, format is YYYYmmddHHMMSS, eg: 20180220130200. Alerts can be filtered by "SD card failure", "Importer shutdown", "Camera failure". - Event [get an event by company ID](https://roscolive-api-v1.apidog.io/6474379e0.md): Partner gets an event by company ID - Event [get events summary of a device by company ID](https://roscolive-api-v1.apidog.io/6474380e0.md): Partner gets summary of events of a device, including count of events, earliest event, last event and total size of the video by company ID - Event [request videos of an event by company ID](https://roscolive-api-v1.apidog.io/6474381e0.md): - Event [get dates of an events by company ID](https://roscolive-api-v1.apidog.io/6474382e0.md): Partner gets list with dates of events to display its in the calendar by company ID. START_TS and END_TS parameters are necessary, format is YYYYmmddHHMMSS, eg: 20180220130200 - Event [get a last event of company device](https://roscolive-api-v1.apidog.io/6474383e0.md): Partner gets a last event of the company by device ID - Event [clear last event](https://roscolive-api-v1.apidog.io/6474384e0.md): Partner clears last event from the company - Event [get dates of events of a device](https://roscolive-api-v1.apidog.io/6474385e0.md): Partner gets list with dates of events to display its in the calendar by device ID. START_TS parameter is necessary, format is YYYYmmddHHMMSS, eg: 20180220130200. END_TS parameter is optional, current time by default. - Event [push custom event](https://roscolive-api-v1.apidog.io/6474386e0.md): Partner adds description to an event created early. If event does not exist 404 error will be returned - Event [delete an event](https://roscolive-api-v1.apidog.io/6474387e0.md): Partner removes an event. Event can be removed if it has 'pending' status, else 404 error will be returned - Event [request videos of an alert](https://roscolive-api-v1.apidog.io/6474388e0.md): Partner requests video and snapshot of an alert from target device ID, starting from timestamp. Timestamp format is YYYYmmddHHMMSS, eg: 20180808130200. If the device is online, the request will be stored, snapshots and video clips will be uploaded to the cloud storage automatically. A request id will be returned in the response. If the device is offline, the request will be pending until the device is online. - Event [share an event](https://roscolive-api-v1.apidog.io/6474389e0.md): Partner can share an event. The 'expiration' parameter is optional, 1 day by default. Several emails should be separated by ',' - Event [get an event by a permalink](https://roscolive-api-v1.apidog.io/6474390e0.md): An user gets an information about video files and metadata of a shared event by a permalink_event_id. - Event [get geotab events](https://roscolive-api-v1.apidog.io/6474391e0.md): Partner gets a list of geotab events with their types - Event [get a last updated event of devices](https://roscolive-api-v1.apidog.io/6474392e0.md): Partner gets a last changed event of all company's devices. An empty response would be returned, if nothing changed - Event [download a blocked event](https://roscolive-api-v1.apidog.io/6474393e0.md): Partner marks a flood event like an usual one, and it can be downloaded - Event [Get flagged company events](https://roscolive-api-v1.apidog.io/6474394e0.md): Returns list of flagged events for the passed in `company_id` for the current user. - Event [flag an event](https://roscolive-api-v1.apidog.io/6474395e0.md): Partner makes an event flagged - Event [unflag an event](https://roscolive-api-v1.apidog.io/6474396e0.md): Partner makes an event unflagged - Event [generate snapshots](https://roscolive-api-v1.apidog.io/6474397e0.md): Partner generates snapshots.Timestamp format is YYYYmmddHHMMSS, eg: 20201228163001. A request id will be returned in the response. - Event [local geocoding service](https://roscolive-api-v1.apidog.io/6474398e0.md): Local geocode service. LAT - latitude, LNG - longitude. Examples: lat=35.21467208862305, lmg = -80.84073638916016 - Event [update an event](https://roscolive-api-v1.apidog.io/6474399e0.md): Adds or updates the driver and impact score for the existing event. - Event [get snapshot/location of event](https://roscolive-api-v1.apidog.io/6474400e0.md): Get snapshot and location of events for selected date - Event [Get events for a device](https://roscolive-api-v1.apidog.io/6474401e0.md): View all the events of a device in a specific period. - Event [Request custom video from device](https://roscolive-api-v1.apidog.io/6474402e0.md): Send a request to a camera for video and/or snapshots for a selected date-time window. After the request is sent, it will be processed and the request will be sent to the camera to retrieve the requested media. - Event [get snapshot on demand](https://roscolive-api-v1.apidog.io/6474403e0.md): StartFragment - Event [get an event by a permalink hash](https://roscolive-api-v1.apidog.io/6474404e0.md): An user gets an information about video files and metadata of a shared event by a hash - Event [Set Event Label for Event](https://roscolive-api-v1.apidog.io/11783586e0.md): - Event [Restore event video from archive](https://roscolive-api-v1.apidog.io/13645031e0.md): Endpoint to retrieve event video files if they have been archived. Event video files are automatically archived 180 days after upload, making retrieval more time consuming than normal. Expect retrieval to take 3 - 5 hours until event video is available again. - Event [Add users for notification of event restore from archive](https://roscolive-api-v1.apidog.io/13645113e0.md): Add RoscoLive user emails to be notified once an event restored from archive is made available. Once added, the users will receive an email notification when the event video is made available for viewing. - Event [Add event label](https://roscolive-api-v1.apidog.io/13645141e0.md): Adds a label to the `event_label` value for an event. If viewing the event within RoscoLive, this value will be displayed instead of the `event_display_type` value. This is useful for event sub-categorization or flagging the end user finds valuable. - Event [Add user feedback to event](https://roscolive-api-v1.apidog.io/13645299e0.md): Add user feedback to event. The passed in feedback will then be stored on the event and retrievable for further review and data exploration. - Event [Get event user feedback](https://roscolive-api-v1.apidog.io/13660278e0.md): Retrieve user feedback for an event. - Event [Get event filters list for date range in company](https://roscolive-api-v1.apidog.io/13687830e0.md): Returns a list of applicable filter categories for events in the given duration. - External Service [Get an external service account](https://roscolive-api-v1.apidog.io/14788912e0.md): Returns data of external service account (Webfleet, Ituran). - External Service [Pair RL device with external device](https://roscolive-api-v1.apidog.io/14825761e0.md): Endpoint to pair RoscoLive device with external (Webfleet / Ituran) device. - External Service [Get RL device data via external device unique serial number](https://roscolive-api-v1.apidog.io/14955462e0.md): Endpoint to get RoscoLive device data via external (Webfleet / Ituran) device unique serial number. - External Service [external service login](https://roscolive-api-v1.apidog.io/6474472e0.md): Provide the external users access to RL - External Service [get a device](https://roscolive-api-v1.apidog.io/6474473e0.md): Gets a device - Fleet Configuration [Get profiles of a company](https://roscolive-api-v1.apidog.io/15248427e0.md): Endpoint to get profiles of a company. - Fleet Configuration [Create new profile in a company](https://roscolive-api-v1.apidog.io/6474465e0.md): Add a new profile to a company. The `configuration` and `configurationdv6` parameter is stringified JSON. - Fleet Configuration [Get a company profile](https://roscolive-api-v1.apidog.io/6474466e0.md): Returns a Profile for a company. - Fleet Configuration [get profile history](https://roscolive-api-v1.apidog.io/6474467e0.md): A list of history objects will be returned when requesting a profile’s history. - Fleet Configuration [Update a company profile](https://roscolive-api-v1.apidog.io/15249567e0.md): Endpoint to update a company profile. - Group [get company groups](https://roscolive-api-v1.apidog.io/6474340e0.md): View company groups - Group [ add a group](https://roscolive-api-v1.apidog.io/6474341e0.md): Add a group to a company - Group [remove a group](https://roscolive-api-v1.apidog.io/6474342e0.md): Remove a group from a company - Group [get devices of a group](https://roscolive-api-v1.apidog.io/6474343e0.md): view all the devices in a group - Group [add a device to a group](https://roscolive-api-v1.apidog.io/6474344e0.md): Add a device to a group - Group [remove a device from a group](https://roscolive-api-v1.apidog.io/6474345e0.md): Remove a device from a group - Group [get users of a group](https://roscolive-api-v1.apidog.io/6474346e0.md): Views all users in a group - Group [add a user to a group](https://roscolive-api-v1.apidog.io/6474347e0.md): Add a group manager/user into a group - Group [remove a user from a group](https://roscolive-api-v1.apidog.io/6474348e0.md): Removes a group manger/end user from a group - Group [get company groups by company ID](https://roscolive-api-v1.apidog.io/6474349e0.md): Partner gets groups by company ID - Group [add a device to a group by company ID](https://roscolive-api-v1.apidog.io/6474350e0.md): Partner add a device to a group by company ID - Group [get devices of a group by company ID](https://roscolive-api-v1.apidog.io/6474351e0.md): Partner gets devices of a group by company ID - Group [remove a device from a group by company ID](https://roscolive-api-v1.apidog.io/6474352e0.md): Partner removes a device from a group by company ID - Group [remove a group by company ID](https://roscolive-api-v1.apidog.io/6474353e0.md): Partner removes a group by company ID - Group [add a group by company ID](https://roscolive-api-v1.apidog.io/6474354e0.md): Add a group by company ID - Group [add an user to a group by company ID](https://roscolive-api-v1.apidog.io/6474355e0.md): Add an user to a group by company ID - Group [get users of a group by company ID](https://roscolive-api-v1.apidog.io/6474356e0.md): Partner gets all users of a group by company ID - Group [remove an user from a group by company ID](https://roscolive-api-v1.apidog.io/6474357e0.md): Partner removes an user from a group by company ID - Group [edit group](https://roscolive-api-v1.apidog.io/6474358e0.md): Partner edits group name by group ID. - Group [get groups with ID](https://roscolive-api-v1.apidog.io/6474359e0.md): Partner gets list of group's names and IDs - Group [get group of a company by group ID](https://roscolive-api-v1.apidog.io/6474360e0.md): Partner gets group of a company by group ID - Live streaming [start live streaming](https://roscolive-api-v1.apidog.io/6474412e0.md): Starts a live streaming for a device. To save the cellular data plan of the device, the live streaming link must be open in 5s, and the m3au list needs to be refreshed every 5s, or it will be regarded as not playing and the connection will close and expire. - Live streaming [stop live streaming](https://roscolive-api-v1.apidog.io/6474413e0.md): Stops a live streaming for a channel of device where a live streaming was started earlier. - Live streaming [start multi-channel live streaming](https://roscolive-api-v1.apidog.io/6474414e0.md): Start live streaming of all available channels with single API call. Channels should be separated by ',', for example '1,2,3,4' - Live streaming [stop multi-channel live streaming](https://roscolive-api-v1.apidog.io/6474415e0.md): Stop live streaming of all available channels with single API call. Channels should be separated by ',', for example '1,2,3,4' - Metadata [get metadata of a device](https://roscolive-api-v1.apidog.io/6474405e0.md): Gets metadata of a device in a specific period. - Metadata [get metadata of devices](https://roscolive-api-v1.apidog.io/6474406e0.md): Returns current metadata values for passed in Device IDs within the duration requested. Time duration is regulated to a maximum of 24 hours. If `end_ts` not passed into request, duration will default to `start_ts + 24h`. - Metadata [Get alerts and events of devices for company](https://roscolive-api-v1.apidog.io/6474407e0.md): Returns an response that contains events and alerts sent by the devices for a company in the time window specified. - Metadata [get alerts for charts and graphs](https://roscolive-api-v1.apidog.io/6474408e0.md): Partner gets report with alerts. START_TS and END_TS parameters are necessary, format is YYYYmmddHHMMSS, eg: 20180220130200. Alerts can be filtered by "SD card failure", "Importer shutdown", "Camera failure", "HddError". Several values of alerts should be separated by ','. Type can be "Top" or "Bottom". - Metadata [get metadata of device(s) for last 24 hours](https://roscolive-api-v1.apidog.io/6474409e0.md): Partner gets metadata of a device for last 24 hours. Several devices IDs should be separated by ',' - Metadata [get alerts of a device](https://roscolive-api-v1.apidog.io/6474410e0.md): Partner gets alerts of the company device(s). START_TS and END_TS parameters are necessary, format is YYYYmmddHHMMSS, eg: 20180220130200. Alerts can be filtered by type and separated by ',' - Metadata [get alerts of a driver](https://roscolive-api-v1.apidog.io/6474411e0.md): Partner gets alerts of a driver. 'start_ts' and 'end_ts' parameters have the following format: 'YYYYmmDDHHMMSS'. Type of 'event_types' can be executed by one or several following parameters: 'gsensor', 'speed', 'critical_gsensor','driver', 'sensor', 'pending', 'custom', 'ADAS-PCW', 'ADAS-FCW', 'ADAS-LCW', 'ADAS-HW'. 'alert_types' parameter can have one or several values separated by ',': 'SD Card Failure', 'Improper Shutdown', 'Camera Failure' - Modem Administration [get list of available modems](https://roscolive-api-v1.apidog.io/6474447e0.md): Partner gets a list of available modems - Modem Administration [upgrade modem firmware](https://roscolive-api-v1.apidog.io/6474448e0.md): Partner can upgrade modem firmware. Several device_id should be separated by ',' - Modem Administration [upgrade modem firmware for group of devices](https://roscolive-api-v1.apidog.io/6474449e0.md): Partner can upgrade modem firmware for a group of devices. Several device_id should be separated by ',' - Report [get data usage report](https://roscolive-api-v1.apidog.io/6474423e0.md): Partner gets data usage report. The format of start_date and end_date is YYYYmmDD, UTC, eg: 20170808. - Report [Get custom report data](https://roscolive-api-v1.apidog.io/6474432e0.md): Gets a custom report either owned or shared with the user. The report object will contain all of the report fields that were selected for the report when it was created or last updated. - Report [get data usage report by device id](https://roscolive-api-v1.apidog.io/6474440e0.md): Get data usage report by device id with start_date and end_date params - Report [get list of companies with data usage for date range](https://roscolive-api-v1.apidog.io/8828878e0.md): Returns a list of all available companies to the user with data usage information for that billing cycle. - Report [get data usage for active devices for specified companies](https://roscolive-api-v1.apidog.io/8829980e0.md): Requests all devices for the specified companies for data usage within the date range. - Report [get companies with data usage for date range](https://roscolive-api-v1.apidog.io/8904881e0.md): Returns a list of available companies with information about data usage within the specified time window. - Report [get data usage report for devices in company](https://roscolive-api-v1.apidog.io/8905051e0.md): - Report [get data tracking report](https://roscolive-api-v1.apidog.io/6474441e0.md): Returns response that contains data tracking information for the devices in the company for the passed in `company_id` for the time window specified. If the value `all` is provided to the param `company_id`, then **all** available devices will be returned. - Report [get all events report](https://roscolive-api-v1.apidog.io/6474421e0.md): Partner gets total report of events. Type of events can be executed by one or several following parameters: "gsensor", "speed", "critical_gsensor", "driver", "sensor", "pending", "custom", "ADAS-PCW", "ADAS-FCW", "ADAS-LCW", "ADAS-HW". START_TS and END_TS parameters are necessary, format is YYYYmmdd, eg: 20180220. Several device IDs should be separated by ','. "Alerts" parameter can has one or several values separated by ',': "SD Card Failure", "Improper Shutdown", "Camera Failure". - Report [Get all events report for company](https://roscolive-api-v1.apidog.io/6474422e0.md): Returns a report object containing the sum of occurences and data usage each event type contributed for the devices passed into the request for the specified date window. - Report [get vehicle activity report](https://roscolive-api-v1.apidog.io/6474424e0.md): Partner gets vehicle activity report. The format of start_date and end_date is YYYYmmDD, UTC, eg: 20170808. - Report [get firmware report](https://roscolive-api-v1.apidog.io/6474425e0.md): Partner gets firmware report. - Report [Get event count summary report for company devices](https://roscolive-api-v1.apidog.io/6474426e0.md): Get event count summary for all devices within the user's permission scope for passed in `company_id`. - Report [get driver event breakdown report](https://roscolive-api-v1.apidog.io/6474427e0.md): Partner gets "Driver Event Breakdown" report. "start_date" and "end_date" parameters have the following format: "YYYYddmm" - Report [get driver event performance report](https://roscolive-api-v1.apidog.io/6474428e0.md): Partner gets driver event performance. "start_date" and "end_date" parameters have the following format: "YYYYddmm" - Report [Update custom report](https://roscolive-api-v1.apidog.io/6474429e0.md): Update a custom report. - Report [get custom reports by user email](https://roscolive-api-v1.apidog.io/6474430e0.md): Partner gets custom reports by user email - Report [get custom report by report id](https://roscolive-api-v1.apidog.io/6474431e0.md): Partner gets custom report by report id - Report [put subscribe to a report](https://roscolive-api-v1.apidog.io/6474433e0.md): Put subscribe to a report. FREQUENCY possible values:'weekly', 'monthly', 'daily', 'biweekly'. DAY_RUN possible values:'Mon','Tue','Wed','Thu','Fri','Sat','Sun', null (null for anything other than weekly, biweekly). REPORT_TYPE possible values: 'standard', 'custom'. CUSTOM_REPORT_TYPE possible values: 'vehicle', 'driver', null. - Report [get report subscriptions](https://roscolive-api-v1.apidog.io/6474434e0.md): Get report subscriptions. Returns all subscriptions if report_id and report_type are not defined. - Report [get list of standard reports](https://roscolive-api-v1.apidog.io/6474435e0.md): Get list of standard reports - Report [get speeding summary report](https://roscolive-api-v1.apidog.io/6474436e0.md): Get speeding summary report. start_date and end_date have the following format: YYYYMMDD, example: 20210919. - Report [get speeding breakdown report](https://roscolive-api-v1.apidog.io/6474437e0.md): Get speeding breakdown report. start_date and end_date have the following format: YYYYMMDD, example: 20210919. - Report [get idling summary report](https://roscolive-api-v1.apidog.io/6474438e0.md): Idling summary reports. start_date and end_date have the following format: YYYYMMDD, example: 20210919. optional params: - Report [get idling breakdown report](https://roscolive-api-v1.apidog.io/6474439e0.md): Idling breakdown reports. start_date and end_date have the following format: YYYYMMDD, example: 20210919.optional params: - Report [Create custom report for user](https://roscolive-api-v1.apidog.io/6474442e0.md): Add custom report for a user. - Partner Portal [get full list of devices per partner](https://roscolive-api-v1.apidog.io/6474474e0.md): Get full list of vehicles per partner - Partner Portal [get full list of companies per partner](https://roscolive-api-v1.apidog.io/6474475e0.md): Get full list of companies per partner - Partner Portal [get user custom presets](https://roscolive-api-v1.apidog.io/6474476e0.md): Get user custom presets - Partner Portal [create custom presets](https://roscolive-api-v1.apidog.io/6474477e0.md): Creating custom presets - Partner Portal [update custom preset](https://roscolive-api-v1.apidog.io/6474478e0.md): Updating custom presets - Partner Portal [delete custom preset by name](https://roscolive-api-v1.apidog.io/6474479e0.md): Deleting custom presets - Releases [get last release](https://roscolive-api-v1.apidog.io/6474463e0.md): Partner gets last release - Releases [view a release](https://roscolive-api-v1.apidog.io/6474464e0.md): Partner views a release - Remote Device Management [get config values from device](https://roscolive-api-v1.apidog.io/6474416e0.md): Gets some config values regarding video channels from device - Remote Device Management [verify of device token](https://roscolive-api-v1.apidog.io/6474417e0.md): Partner verify if device ID equal with entered token. If they is identical then "true" message should be returned in response. - Remote Device Management [get current firmware of devices](https://roscolive-api-v1.apidog.io/6474418e0.md): Partner gets current firmware for devices - Remote Device Management [SD-card formatting](https://roscolive-api-v1.apidog.io/6474419e0.md): Removes all events from device SD-card. - Remote Device Management [get config file for device](https://roscolive-api-v1.apidog.io/6474420e0.md): Returns latest copy of configuration file from the device since last connection to RoscoLive. - Statistics [get statistics feature usage](https://roscolive-api-v1.apidog.io/6474443e0.md): Partner gets information about number of custom clips, event clips, live video duration, vehicle group and vehicle name of devices assigned to company. START_DATE and END_DATE parameters are necessary, format is YYYYMMDD, eg: 20180220. - User [get company users](https://roscolive-api-v1.apidog.io/6474287e0.md): View all the users in a company - User [Get a user](https://roscolive-api-v1.apidog.io/6474288e0.md): Get an existing RoscoLive user by email. The current user can request any user for which they have view permissions, including their own user. - User [update a user](https://roscolive-api-v1.apidog.io/6474289e0.md): Update a user's information. All the attributes are optional, only the posted attributes will be changed - User [remove a user](https://roscolive-api-v1.apidog.io/6474290e0.md): Remove a user in a company. - User [Get own info](https://roscolive-api-v1.apidog.io/6474291e0.md): View own user currently logged into session. - User [create a user](https://roscolive-api-v1.apidog.io/6474292e0.md): Create a new user for a company. After user is created, an email will be sent to the user's inbox they will then use to verify their email address. Once verified, they will be taken to RoscoLive to create a password for their account to complete the new account setup. - User [get company users by company ID](https://roscolive-api-v1.apidog.io/6474293e0.md): Partner gets company users by company ID - User [get user settings](https://roscolive-api-v1.apidog.io/6474294e0.md): Partner gets user settings by email - User [set user settings](https://roscolive-api-v1.apidog.io/6474295e0.md): Set any/all user settings. All parameters are optional - User [Get application notifications](https://roscolive-api-v1.apidog.io/6474296e0.md): Returns application notifications for the current user. These are notifications that detail updates for certain actions the user has taken, such as confirmation of successful profile updates, uploading of custom event videos from request, ect,... - User [remove the notification](https://roscolive-api-v1.apidog.io/6474297e0.md): Partner can remove the notification - User [mark notifications as viewed](https://roscolive-api-v1.apidog.io/6474298e0.md): Partner marks all own notifications as 'viewed' - User [verify password](https://roscolive-api-v1.apidog.io/6474299e0.md): Verifying of entered and current user password equaling - User [SD card reformat reminder](https://roscolive-api-v1.apidog.io/6474300e0.md): A notification reminds an user to reformat his SD card - User [Update notification by email](https://roscolive-api-v1.apidog.io/6474301e0.md): Update notifications by email. Params must be stringified json - User [assign user to company](https://roscolive-api-v1.apidog.io/6474302e0.md): Partner can assign the Provisionings, Installers and Video Viewers to a company. Several emails should be separated by ',' - User [get permissions by a user_id](https://roscolive-api-v1.apidog.io/6474303e0.md): System Administrator can get the list of permissions by a custom_user id - User [Get event / sms notification settings](https://roscolive-api-v1.apidog.io/6474304e0.md): Get email / sms notification settings for a user the requester has permission to view, including their own. - Webhooks [get push notifications](https://roscolive-api-v1.apidog.io/6474444e0.md): Partners get notifications about events, ignition state, input sensors and drivers - Webhooks [set push notifications](https://roscolive-api-v1.apidog.io/6474445e0.md): Partner set notification about events, ignition state, input sensors and drivers - Webhooks [remove push notifications](https://roscolive-api-v1.apidog.io/6474446e0.md): Partners remove notifications of a specific type