Sections
extends BaseEndpoint
in package
Routing class for the subnamespace `Sections`
Tags
Table of Contents
Properties
- $_assignments : Assignments|null
- $_customfields : Customfields|null
- $_cycles : Cycles|null
- $_students : Students|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- list_() : AcademicsSectionCollection
- Returns a collection of academic sections for the specified school level.
Properties
$_assignments
protected
Assignments|null
$_assignments
= null
$_assignments
$_customfields
protected
Customfields|null
$_customfields
= null
$_customfields Routing class for the subnamespace Customfields
$_cycles
protected
Cycles|null
$_cycles
= null
$_cycles
$_students
protected
Students|null
$_students
= null
$_students
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["assignments" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Academics\\Sections\\Assignments", "students" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Academics\\Sections\\Students", "cycles" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Academics\\Sections\\Cycles", "customfields" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Academics\\Sections\\Customfields"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/sections"
Endpoint URL pattern
Methods
list_()
Returns a collection of academic sections for the specified school level.
public
list_(array{level_num: int, school_year: string} $params) : AcademicsSectionCollection
Requires the following role in the Education Management system:
- Academic Group Manager
Parameters
- $params : array{level_num: int, school_year: string}
-
An associative array
- level_num: Format - int32. Level number.
- school_year: The school year to get sections for. Corresponds to
school\_year\_labelin the Year list. Defaults to the current school year.
Tags
Return values
AcademicsSectionCollection —Success