Assignments
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- searchByStudentId() : StudentAssignmentCollection
- Returns assignments for a student that are assigned or due within the date range specified.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/{student_id}/assignments"
Endpoint URL pattern
Methods
searchByStudentId()
Returns assignments for a student that are assigned or due within the date range specified.
public
searchByStudentId(array{student_id: int, start_date: string, end_date: string, section_ids: string} $params) : StudentAssignmentCollection
If no end\_date
is supplied it defaults to 31 days past the
start\_date
Requires at least one of the following roles in the
Education Management system:
-
Student
-
Parent
Parameters
- $params : array{student_id: int, start_date: string, end_date: string, section_ids: string}
-
An associative array
- student_id: Format - int32.
- start_date: Format - date-time (as date-time in RFC3339).
- end_date: Format - date-time (as date-time in RFC3339).
- section_ids:
Tags
Return values
StudentAssignmentCollection —Success