Attendance
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : AttendanceGetCollection
- Returns a collection of student attendance records for the specified day.
- post() : mixed
- Creates a new attendance record for the specified student.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/attendance"
Endpoint URL pattern
Methods
list_()
Returns a collection of student attendance records for the specified day.
public
list_(array{level_id: int, day: string, offering_type: int, excuse_type: int} $params) : AttendanceGetCollection
Please use this Attendance Setup Guide to verify your attendance settings.
Requires the following role in the Education Management system:
- Attendance Manager
Parameters
- $params : array{level_id: int, day: string, offering_type: int, excuse_type: int}
-
An associative array
- level_id: Format - int32. The ID of the school level to retrieve attendance records.
- day: Format - date-time (as date-time in RFC3339). The date to return attendance for.
- offering_type: Format - int32. The offering type to retrieve records for.
- excuse_type: Format - int32. Filters results to a specific excuse type.
Tags
Return values
AttendanceGetCollection —Success
post()
Creates a new attendance record for the specified student.
public
post(AttendanceCreate $requestBody) : mixed
Please use this Attendance Setup Guide to verify your attendance settings.
Requires the following role in the Education Management system:
- Attendance Manager
Parameters
- $requestBody : AttendanceCreate
-
Information about the attendance report
Tags
Return values
mixed —Success