API List Schedule Conflicts

From IVS Wiki
Jump to: navigation, search

The following two API calls provide information of blocked or conflicted schedules.

Blocked = Schedules are complete blocked by another schedule.

Conflict = Schedules are partially blocked by another schedule.

Both calls return data in the same format.

Resource URL

http://valt.example.com/api/v3/schedule/blocked
http://valt.example.com/api/v3/schedule/conflict

Resource Information

Method GET
Response Type JSON
Authentication Required Yes

Parameters

No parameters can be passed to this call.

Response

If there are no blocked or conflicted schedules an empty array will be returned.
Code Reason
200 Request Successful
401 Unauthorized
JSON Response
data
blocked_schedules Array of JSON objects, one for each schedule.
id Schedule ID
name Schedule Name
template Array of metadata fields populated for this schedule.
room Room the schedule initiates recording in.
id Room ID
name Room Name
created Time schedule was created (epoch time)
start_at Time schedule will initiate recording (epoch time)
stop_at Time schedule will stop recording (epoch time)
duration Duration is seconds of the scheduled recording.
status pending or started
recurrence Recurring schedule information
type Recurring Schedule Type (Valid Values: weekly, monthly, daily, none)
weeks_range Days of the week the schedule will recur (0-6, 0=Sunday)
range_type When will recurring schedule end (Valid Value: no = no end date, after = fixed number of occurrences, by = will end of specified date)
end_after Number of Occurrences
end_by Date to end schedule on.
shared Videos created by this schedule will be shared with these users.
users List of user IDs videos created by this schedule will be shared with.
user_groups List of group IDs videos created by this schedule will be shared with.

Examples

Request

https://ivstest1.ad.ipivs.com/api/v3/schedule/conflict?access_token=e82632d19c523678fea3d1016c6df9e9

Successful Response

Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.

{
"data":{
"conflict_schedules":[]
}
}

Failure Response

{"error":{"code":401,"message":"No API key provided"}}