Assignments
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- searchBySectionId() : AssignmentCollection
- Returns a collection of assignments for the specified ```section\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/sections/{section_id}/assignments"
Endpoint URL pattern
Methods
searchBySectionId()
Returns a collection of assignments for the specified ```section\_id```.
public
searchBySectionId(array{section_id: int, types: string, status: string, persona_id: int, filter: string, search: string} $params) : AssignmentCollection
Requires at least one of the following roles in the Education Management system:
-
Academic Group Manager
-
Student
-
Teacher
-
Pending Teacher
Parameters
- $params : array{section_id: int, types: string, status: string, persona_id: int, filter: string, search: string}
-
An associative array
- section_id: Format - int32. The ID of the section.
- types: Returns results that match a comma separated list of assignment type IDs.
- status: The status of the assignment. The status corresponds with static system options. Allowed values: "0" for In Progress, "1" for Completed, "2" for Overdue, and "-1" for To Do.
- persona_id: Format - int32. The ID of the persona to get assignments. 3 = Faculty, 2 = Student. Defaults to 3.
- filter: Return assignments based on the entered string:
expired,future, orall. All is the default sort value. - search: Returns results with Descriptions or Titles that match search string.
Tags
Return values
AssignmentCollection —Success