Documentation

Sections extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

searchByStudentId()  : AcademicsSectionStudentCollection
Returns a collection of sections for the specified ```student\_id```.

Properties

$url

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

Endpoint URL pattern

Methods

searchByStudentId()

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

public searchByStudentId(array{student_id: int} $params) : AcademicsSectionStudentCollection

The user requesting the information must be the student, parent of the student or faculty member associated with the student.

The cumulative\_gade is shown if the user has the correct access to view it.

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

  • Student

  • Parent

  • Faculty

Parameters
$params : array{student_id: int}

An associative array

  • student_id: Format - int32. The ID of the student to view sections and grades for.
Tags
throws
ArgumentException

if required parameters are not defined

Return values
AcademicsSectionStudentCollection

Success


        
On this page

Search results