API Update Schedule

This API call will update an existing schedule.

Resource URL

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

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

Resource Information

Method	POST
Headers	Content-Type:application/json
Response Type	JSON
Authentication Required	Yes

Parameters

The JSON body must be properly formatted. All fields and values should be enclosed in double quotes and separated by a colon.

Field Name			Description	Required	Example
name			Schedule Name	no	Monday Weekly
room			Room ID	no	4
start_at			Start time (epoch time) Must be in the future	no	1570011010
duration			Schedule duration in seconds	no	300
template			Metadata fields to populate	no	{17:"Student"}
	{fieldid}		Metadata field value	no	Student
recurrence			Reoccurring schedule configuration	no
	type		Recurring Schedule Type (Valid Values: weekly, monthly, daily, none)	no	weekly
	weeks_range		Days of the week the schedule will recur (0-6, 0=Sunday)	no	1
	range_type		When will recurring schedule end (Valid Value: no = no end date, after = fixed number of occurrences, by = will end of specified date)	no	no
	end_after		Number of Occurrences	no	10
	end_by		Date to end schedule on.	no	04-30-2020
share			Videos created by this schedule will be shared with these users.	no	{"users":"13,17,43","users_groups":"1,7,12"}
	users		List of user IDs videos created by this schedule will be shared with.	no	13,17,43
	user_groups		List of group IDs videos created by this schedule will be shared with.	no	1,7,12

Response

Code	Reason
200	Schedule Updated Successfully
400	Invalid Request (See Response for Specific Error)
401	Unauthorized
404	Schedule ID Not Found
500	JSON Body Formatted Incorrectly

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

The sample JSON body below is formatted with line breaks and indentation to make it easier to read. This is not required.

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

{
  "name":"API Schedule 2",
  "room":39,
  "start_at":"1596636900",
  "duration":"300"
}

Successful Response

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

{
"data":{
"id": 4,
"name": "API Schedule 2",
"template": null,
"author":{
"id": 1,
"name": "admin"
},
"room":{
"id": 39,
"name": "Fixed Dome"
},
"created": 1596636900,
"start_at": 1596636900,
"stop_at": 1596637200,
"duration": 300,
"status": "pending",
"recurrence":{
"type": "none"
}
}
}

Failure Response

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

{
"error":{
"code": 404
}
}