Documentation

Sections extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

list_()  : AdvisoriesSectionCollection
Returns a collection of advisory sections for the specified school level

Properties

$url

protected string $url = "https://api.sky.blackbaud.com/school/v1/advisories/sections"

Endpoint URL pattern

Methods

list_()

Returns a collection of advisory sections for the specified school level

public list_(array{level_num: int, school_year: string} $params) : AdvisoriesSectionCollection

Requires the following role in the Education Management system:

  • Sky API Advisory 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 advisory sections for. Defaults to the current school year.

Tags
throws
ArgumentException

if required parameters are not defined

Return values
AdvisoriesSectionCollection

Success


        
On this page

Search results