Request videos of an event
PUT/partners/companies/{company_name}/events/{event_id}/videosRequest 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.
Roles with endpoint access
| Role | Permission |
|---|---|
| Partner | |
| Partner View | |
| Custom Partner | |
| Fleet Manager | |
| Group Manager | |
| User | |
| Custom User |
Request
Path Params
company_name
string
required
Company name in RoscoLive
Example:
Acme Trucking LLC
event_id
integer
required
ID of event to request video for
>= 0
Example:
12345
Request samples
Responses
Accepted(202)
event doesn't exist(404)
Success(200)
Video already available for event(400)
HTTP Code: 202
Content Type : JSONapplication/json
Response returned when device has Sleep mode enabled and is currently in the Sleep state. NOTE: Although the key returned in response that contains the success message is error, the request is successful.
Data Schema
meta
object
required
Request metadata object
code
integer
required
response
object
required
Contains response data
error
string
required
result
enum<string>
required
"OK" if request successful, otherwise "Failed"
Allowed values:
OKFailed
Example
{
"meta": {
"code": 202
},
"response": {
"error": "device is offline, request is pending"
},
"result": "OK"
}Last modified: 25 days ago