Documentation

Sections extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

list_()  : ActivitiesSectionCollection
Returns a collection of activity sections for the specified school level.

Properties

$url

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

Endpoint URL pattern

Methods

list_()

Returns a collection of activity sections for the specified school level.

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

Requires the following role in the Education Management system:

  • Activity 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 activity sections for. Defaults to the current school year.

Tags
throws
ArgumentException

if required parameters are not defined

Return values
ActivitiesSectionCollection

Success


        
On this page

Search results