IVSWikiBlue: Created page with "This API provides details for a specified schedule. ===Resource URL===

http://valt.example.com/api/v3/schedule/{scheduleid}

''Replace {scheduleid} with the actual..."

2020-04-14T20:06:13Z

Created page with "This API provides details for a specified schedule. ===Resource URL=== <pre>http://valt.example.com/api/v3/schedule/{scheduleid}</pre> ''Replace {scheduleid} with the actual..."

New page

This API provides details for a specified schedule.

===Resource URL===
<pre>http://valt.example.com/api/v3/schedule/{scheduleid}</pre>
''Replace {scheduleid} with the actual id number of the schedule. Schedules are numbered sequentially when added to VALT.''

===Resource Information===
{|class="wikitable"
|'''Method'''
|GET
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===

No parameters can be passed to this call.

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Request Successful
|-
|401
|Unauthorized
|-
|404
|Schedule ID Not Found
|}

{|class="wikitable"
|+JSON Response
!colspan="4"|data
|-
|-
|colspan="2"|'''id'''
|Schedule ID
|-
|colspan="2"|'''name'''
|Schedule Name
|-
|colspan="2"|'''template'''
|Array of metadata fields populated for this schedule.
|-
|colspan="2"|'''author'''
|User that will own videos created by this schedule. May be different from the user that created the schedule.
|-
|
|'''id'''
|User ID
|-
|
|'''name'''
|User Name
|-
|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/2?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":{
"id": 2,
"name": "Test Schedule",
"template": null,
"author":{
"id": 1,
"name": "admin"
},
"room":{
"id": 59,
"name": "Jared Test"
},
"created": 1586552400,
"start_at": 1586552400,
"stop_at": 1586552700,
"duration": 300,
"status": "pending",
"recurrence":{
"weeks_range":[
5
],
"range_type": "no_end_date",
"type": "weekly"
}
}
}
</nowiki>

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

API Schedule Details - Revision history

IVSWikiBlue: Created page with "This API provides details for a specified schedule. ===Resource URL===
http://valt.example.com/api/v3/schedule/{scheduleid}
''Replace {scheduleid} with the actual..."