Students
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- searchByParentId() : ChildOfParentCollection
- Returns a collection of children of the specified ```parent\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/users/{parent_id}/students"
Endpoint URL pattern
Methods
searchByParentId()
Returns a collection of children of the specified ```parent\_id```.
public
searchByParentId(array{parent_id: int} $params) : ChildOfParentCollection
Requires the logged in user\_id matches the specified
parent\_id. Requires the following role in the Education
Management system:
- Parent
Parameters
- $params : array{parent_id: int}
-
An associative array
- parent_id: Format - int32.
Tags
Return values
ChildOfParentCollection —Success