Terms
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : TermCollection
- Returns a collection of core school terms.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/terms"
Endpoint URL pattern
Methods
list_()
Returns a collection of core school terms.
public
list_(array{school_year: string, offering_type: int} $params) : TermCollection
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Schedule Manager
-
Platform Manager
-
Any Manager Role
Parameters
- $params : array{school_year: string, offering_type: int}
-
An associative array
- school_year: The school year to get terms for. Defaults to the current school year.
- offering_type: Format - int32. The offering type to filter terms by.
Tags
Return values
TermCollection —Success