Teachers
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getByClassId() : UsersOutputModel
- Returns a collection of teacher user data for the specified ```class\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/classes/{class_id}/teachers"
Endpoint URL pattern
Methods
getByClassId()
Returns a collection of teacher user data for the specified ```class\_id```.
public
getByClassId(array{class_id: string} $params) : UsersOutputModel
Roles returned include:
-
Teacher
-
Pending Teacher
Parameters
- $params : array{class_id: string}
-
An associative array
- class_id: sourcedId for the class
Tags
Return values
UsersOutputModel —Success