Enrollments
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getBySchoolIdAndClassId() : EnrollmentsOutputModel
- Returns a collection of enrollments for the specified ```class\_id``` in the ```school\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/schools/{school_id}/classes/{class_id}/enrollments"
Endpoint URL pattern
Methods
getBySchoolIdAndClassId()
Returns a collection of enrollments for the specified ```class\_id``` in the ```school\_id```.
public
getBySchoolIdAndClassId(array{school_id: string, class_id: string} $params) : EnrollmentsOutputModel
Parameters
- $params : array{school_id: string, class_id: string}
-
An associative array
- school_id: sourcedId for the school
- class_id: sourcedId for the class
Tags
Return values
EnrollmentsOutputModel —OK - It was possible to read the collection.