Sessions
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : SchoolSessionCollection
- Returns a collection of sessions for a higher education institution.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/sessions"
Endpoint URL pattern
Methods
list_()
Returns a collection of sessions for a higher education institution.
public
list_(array{level_num: int, school_year: string} $params) : SchoolSessionCollection
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Platform Manager
Parameters
- $params : array{level_num: int, school_year: string}
-
An associative array
- level_num: Format - int32. Filter for a specific
level\_num(level number) - school_year: Filter for a specific
school\_year(required format YYYY - YYYY (11 chars))
- level_num: Format - int32. Filter for a specific
Tags
Return values
SchoolSessionCollection —Success