IVSWikiBlue: Created page with "The following two API calls provide information of blocked or conflicted schedules. Blocked = Schedules are complete blocked by another schedule. Conflict = Schedules are pa..."

2020-04-14T20:05:48Z

Created page with "The following two API calls provide information of blocked or conflicted schedules. Blocked = Schedules are complete blocked by another schedule. Conflict = Schedules are pa..."

New page

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===
<pre>http://valt.example.com/api/v3/schedule/blocked</pre>

<pre>http://valt.example.com/api/v3/schedule/conflict</pre>

===Resource Information===
{|class="wikitable"
|'''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.

{|class="wikitable"
!Code
!Reason
|-
|200
|Request Successful
|-
|401
|Unauthorized
|}

{|class="wikitable"
|+JSON Response
!colspan="4"|data
|-
|colspan="3"|'''blocked_schedules'''
|Array of JSON objects, one for each schedule.
|-
|
|colspan="2"|'''id'''
|Schedule ID
|-
|
|colspan="2"|'''name'''
|Schedule Name
|-
|
|colspan="2"|'''template'''
|Array of metadata fields populated for this schedule.
|-
|
|colspan="2"|'''room'''
|Room the schedule initiates recording in.
|-
|
|
|'''id'''
|Room ID
|-
|
|
|'''name'''
|Room Name
|-
|
|colspan="2"|'''created'''
|Time schedule was created (epoch time)
|-
|
|colspan="2"|'''start_at'''
|Time schedule will initiate recording (epoch time)
|-
|
|colspan="2"|'''stop_at'''
|Time schedule will stop recording (epoch time)
|-
|
|colspan="2"|'''duration'''
|Duration is seconds of the scheduled recording.
|-
|
|colspan="2"|'''status'''
|pending or started
|-
|
|colspan="2"|'''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.
|-
|
|colspan="2"|'''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===
<pre>https://ivstest1.ad.ipivs.com/api/v3/schedule/conflict?access_token=e82632d19c523678fea3d1016c6df9e9</pre>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"data":{
"conflict_schedules":[]
}
}
</nowiki>

===Failure Response===
<pre>{"error":{"code":401,"message":"No API key provided"}}</pre>

API List Schedule Conflicts - Revision history

IVSWikiBlue: Created page with "The following two API calls provide information of blocked or conflicted schedules. Blocked = Schedules are complete blocked by another schedule. Conflict = Schedules are pa..."