API Schedule Details

This API provides details for a specified schedule.

Resource URL

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

Replace {scheduleid} with the actual id number of the schedule. Schedules are numbered sequentially when added to VALT.

Resource Information

Method	GET
Response Type	JSON
Authentication Required	Yes

Parameters

No parameters can be passed to this call.

Response

Code	Reason
200	Request Successful
401	Unauthorized
404	Schedule ID Not Found

JSON Response

data
id		Schedule ID
name		Schedule Name
template		Array of metadata fields populated for this schedule.
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
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/2?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":{
"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"
}
}
}

Failure Response

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