Sets
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getByScheduleSetId() : ScheduleSetDetails
- Returns details about the specified ```schedule\_set\_id```.
- list_() : ScheduleSetCollection
- Returns a collection of Schedule Sets for the specified ```level\_num```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/schedules/sets/{schedule_set_id}"
Methods
getByScheduleSetId()
Returns details about the specified ```schedule\_set\_id```.
public
getByScheduleSetId(array{schedule_set_id: int} $params) : ScheduleSetDetails
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Schedule Manager
Parameters
- $params : array{schedule_set_id: int}
-
An associative array
- schedule_set_id: Format - int32. ID of the Schedule Set you seek.
Tags
Return values
ScheduleSetDetails —Success
list_()
Returns a collection of Schedule Sets for the specified ```level\_num```.
public
list_(array{level_num: int, school_year: string, group_type?: int} $params) : ScheduleSetCollection
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Schedule Manager
Parameters
- $params : array{level_num: int, school_year: string, group_type?: int}
-
An associative array
- level_num: Format - int32. Level Number indicates which school you are working with.
- school_year: The school year to get Schedule Sets for.
Corresponds to
school\_year\_labelin the Year list. Defaults to the current school year. - group_type: Format - int32. The Group Type to filter the collection of Schedule Sets. Defaults to the 'Academics' (1).
Tags
Return values
ScheduleSetCollection —Success