Documentation

Enrollments extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

list_()  : UserEnrollmentCollection
Returns a collection of users and their enrollments for a single school year.

Properties

$url

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

Endpoint URL pattern

Methods

list_()

Returns a collection of users and their enrollments for a single school year.

public list_(array<string|int, mixed> $params) : UserEnrollmentCollection

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

  • Admissions manager

  • Platform manager

  • SKY API Data Sync

Parameters
$params : array<string|int, mixed>
Tags
throws
ArgumentException

if required parameters are not defined

Return values
UserEnrollmentCollection

Success


        
On this page

Search results