Teachers
extends BaseEndpoint
in package
Routing class for the subnamespace `Teachers`
Table of Contents
Properties
Methods
- get() : UsersOutputModel
- Returns a collection of teacher user data.
- getById() : UserOutputModel
- Returns a single teacher user for the specified ```id```.
Properties
$classes
public
Classes
$classes
$_classes
protected
Classes|null
$_classes
= null
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["classes" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Teachers\\Classes"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/teachers/{id}"
Methods
get()
Returns a collection of teacher user data.
public
get() : UsersOutputModel
Roles returned include:
-
Teacher
-
Pending Teacher
Return values
UsersOutputModel —Success
getById()
Returns a single teacher user for the specified ```id```.
public
getById(array{id: string} $params) : UserOutputModel
Roles returned include:
-
Teacher
-
Pending Teacher
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the teacher
Tags
Return values
UserOutputModel —Success