Cycles
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getBySectionId() : SectionCycles
- Returns a collection of cycles for the specified ```section\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/academics/sections/{section_id}/cycles"
Endpoint URL pattern
Methods
getBySectionId()
Returns a collection of cycles for the specified ```section\_id```.
public
getBySectionId(array{section_id: int, duration_id: int, group_type?: int} $params) : SectionCycles
Requires the following role in the Education Management system:
- Academic Group Manager
Parameters
- $params : array{section_id: int, duration_id: int, group_type?: int}
-
An associative array
- section_id: Format - int32. The ID of the section.
- duration_id: Format - int32. The ID of the term for which you want to return cycles. Defaults to the current term for the section provided.
- group_type: Format - int32. The Group Type for the section specified. Defaults to the 'Academics' (1).
Tags
Return values
SectionCycles —Success