Students
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- get() : UsersOutputModel
- Returns a collection of student user data.
- getById() : UserOutputModel
- Returns a single student user for the specified ```id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/students/{id}"
Methods
get()
Returns a collection of student user data.
public
get() : UsersOutputModel
Return values
UsersOutputModel —Success
getById()
Returns a single student user for the specified ```id```.
public
getById(array{id: string} $params) : UserOutputModel
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the student
Tags
Return values
UserOutputModel —Success