Classes
extends BaseEndpoint
in package
Routing class for the subnamespace `Classes`
Tags
Table of Contents
Properties
- $_enrollments : Enrollments|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- getBySchoolId() : ClassOutputModel
- Returns a collection of classes for the specified ```school\_id```.
Properties
$_enrollments
protected
Enrollments|null
$_enrollments
= null
$_enrollments
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["enrollments" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Schools\\Classes\\Enrollments"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/schools/{school_id}/classes"
Endpoint URL pattern
Methods
getBySchoolId()
Returns a collection of classes for the specified ```school\_id```.
public
getBySchoolId(array{school_id: string} $params) : ClassOutputModel
Parameters
- $params : array{school_id: string}
-
An associative array
- school_id: sourcedId for the school
Tags
Return values
ClassOutputModel —OK - It was possible to read the resource.