Master
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : MasterScheduleDayCollection
- Returns a collection of Master Schedule days within the date range provided.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/schedules/master"
Endpoint URL pattern
Methods
list_()
Returns a collection of Master Schedule days within the date range provided.
public
list_(array{level_num: int, start_date: string, end_date: string, offering_type: int} $params) : MasterScheduleDayCollection
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Schedule Manager
Parameters
- $params : array{level_num: int, start_date: string, end_date: string, offering_type: int}
-
An associative array
- level_num: Format - int32. Level Number indicates which school you are working with.
- start_date: Format - date-time (as date-time in RFC3339). Start of the date range (inclusive). The earliest possible start_date is 1/1/1900, any date entered before that date will be overwritten with 1/1/1900.
- end_date: Format - date-time (as date-time in RFC3339). End of the date range (inclusive). If the end_date is earlier than the start_date the end_date wil be overwritten with the start_date plus 7 days.
- offering_type: Format - int32. Filters the results by a specific group type. Defaults to "All" offering types.
Tags
Return values
MasterScheduleDayCollection —Success