Students
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- post() : PostResponse
- Adds bulk enrollment data (students and/or teachers) for the specified section(s).
- searchBySectionId() : StudentCollection
- Returns a collection of students in the specified ```section\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/sections/{section_id}/students"
Methods
post()
Adds bulk enrollment data (students and/or teachers) for the specified section(s).
public
post(BulkEnrollment $requestBody) : PostResponse
Returns True if successful, otherwise false.
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Schedule Manager
Parameters
- $requestBody : BulkEnrollment
-
Defines which users (students and/or teachers) should be added to which offerings (via
section\_idand durationid)
Tags
Return values
PostResponse —Success
searchBySectionId()
Returns a collection of students in the specified ```section\_id```.
public
searchBySectionId(array{section_id: int} $params) : StudentCollection
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Teacher
Parameters
- $params : array{section_id: int}
-
An associative array
- section_id: Format - int32. The ID of the section, which can be found using Section list.
Tags
Return values
StudentCollection —Success