Rosters
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- get() : array<string|int, SectionRosterModel>
- Returns the academic rosters for a selected year. Uses current school year by default.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/rosters"
Endpoint URL pattern
Methods
get()
Returns the academic rosters for a selected year. Uses current school year by default.
public
get(array<string|int, mixed> $params) : array<string|int, SectionRosterModel>
Requires the following role in the Education Management system:
-
Schedule Manager
-
Academic Group Manager
***This endpoint is in BETA. It may be removed or replaced with a 90 day deprecation period.***
Parameters
- $params : array<string|int, mixed>
Tags
Return values
array<string|int, SectionRosterModel> —A List of Academic rosters