Students
extends BaseEndpoint
in package
Routing class for the subnamespace `Students`
Tags
Table of Contents
Properties
- $_results : Results|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- getByClassId() : UsersOutputModel
- Returns a collection of student user data for the specified ```class\_id```.
Properties
$_results
protected
Results|null
$_results
= null
$_results
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["results" => "\\Blackbaud\\SKY\\OneRoster\\Endpoints\\Classes\\Students\\Results"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/classes/{class_id}/students"
Endpoint URL pattern
Methods
getByClassId()
Returns a collection of student user data for the specified ```class\_id```.
public
getByClassId(array{class_id: string} $params) : UsersOutputModel
Parameters
- $params : array{class_id: string}
-
An associative array
- class_id: sourcedId for the class
Tags
Return values
UsersOutputModel —Success