Changes
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : EnrollmentChangesCollection
- Returns a collection of students with enrollment changes on or after the date parameter.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/enrollments/changes"
Endpoint URL pattern
Methods
list_()
Returns a collection of students with enrollment changes on or after the date parameter.
public
list_(array{start_date: string, end_date: string} $params) : EnrollmentChangesCollection
The maximum period of time that can be specified is 30 days from start_date, if end_date is not provided or is greater than 30 days from start_date it will be set to start_date + 30 days.
Requires at least one of the following roles in the Education Management system:
-
Schedule Manager
-
Academic Group Manager
Parameters
- $params : array{start_date: string, end_date: string}
-
An associative array
- start_date: Format - date-time (as date-time in RFC3339). The DateTime of changes to academics enrollments to begin with
- end_date: Format - date-time (as date-time in RFC3339). The DateTime of changes to academics enrollments to end with.
Tags
Return values
EnrollmentChangesCollection —Success