Documentation

Calendar extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

list_()  : CalendarItemCollection
Returns a list of events for the calling user. Requires one of the following roles in the Education Management system:

Properties

$url

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

Endpoint URL pattern

Methods

list_()

Returns a list of events for the calling user. Requires one of the following roles in the Education Management system:

public list_(array{start_date: string, end_date: string} $params) : CalendarItemCollection
  • Student

  • Parent

  • Teacher

Parameters
$params : array{start_date: string, end_date: string}

An associative array

  • start_date: Format - date-time (as date-time in RFC3339).
  • end_date: Format - date-time (as date-time in RFC3339).
Tags
throws
ArgumentException

if required parameters are not defined

Return values
CalendarItemCollection

Success


        
On this page

Search results