Courses
extends BaseEndpoint
in package
Routing class for the subnamespace `Courses`
Tags
Table of Contents
Properties
- $_customfields : Customfields|null
- $endpoints : array<string, BaseEndpoint>>
- $url : string
Methods
- list_() : CourseCollection
- Returns a collection of academic courses, filtered by department and/or school level.
Properties
$_customfields
protected
Customfields|null
$_customfields
= null
$_customfields Routing class for the subnamespace Customfields
$endpoints
protected
array<string, BaseEndpoint>>
$endpoints
= ["customfields" => "\\Blackbaud\\SKY\\School\\Endpoints\\V1\\Academics\\Courses\\Customfields"]
$endpoints Routing subpaths
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/courses"
Endpoint URL pattern
Methods
list_()
Returns a collection of academic courses, filtered by department and/or school level.
public
list_(array{department_id: int, level_id: int} $params) : CourseCollection
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Platform Manager
Parameters
- $params : array{department_id: int, level_id: int}
-
An associative array
- department_id: Format - int32. Identifier for a specific department.
- level_id: Format - int32. Identifier for a specific school level.
Tags
Return values
CourseCollection —Success