Documentation

Sections extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

searchByTeacherId()  : AcademicsSectionCollection
Returns a collection of sections for the specified ```teacher\_id```.

Properties

$url

protected string $url = "https://api.sky.blackbaud.com/school/v1/academics/teachers/{teacher_id}/sections"

Endpoint URL pattern

Methods

searchByTeacherId()

Returns a collection of sections for the specified ```teacher\_id```.

public searchByTeacherId(array{teacher_id: int, school_year: string} $params) : AcademicsSectionCollection

Requires at least one of the following roles in the Education Management system:

  • Academic Group Manager

  • Teacher

Parameters
$params : array{teacher_id: int, school_year: string}

An associative array

  • teacher_id: Format - int32. The ID of the teacher to get sections for.
  • school_year: The school year. Corresponds to school\_year\_label in the Year list.
Tags
throws
ArgumentException

if required parameters are not defined

Return values
AcademicsSectionCollection

Success


        
On this page

Search results