Enrollments
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- get() : EnrollmentsOutputModel
- Returns a collection of enrollments.
- getById() : EnrollmentOutputModel
- Returns a specific enrollment.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/enrollments/{id}"
Methods
get()
Returns a collection of enrollments.
public
get() : EnrollmentsOutputModel
Return values
EnrollmentsOutputModel —OK - It was possible to read the collection.
getById()
Returns a specific enrollment.
public
getById(array{id: string} $params) : EnrollmentOutputModel
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the enrollment
Tags
Return values
EnrollmentOutputModel —OK - It was possible to read the resource.