Documentation

GradingPeriods extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

getByTermId()  : AcademicSessionsOutputModel
Returns a collection of grading periods for the specified ```term\_id```

Properties

$url

protected string $url = "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/terms/{term_id}/gradingPeriods"

Endpoint URL pattern

Methods

getByTermId()

Returns a collection of grading periods for the specified ```term\_id```

public getByTermId(array{term_id: string} $params) : AcademicSessionsOutputModel
Parameters
$params : array{term_id: string}

An associative array

  • term_id: sourcedId for the term
Tags
throws
ArgumentException

if required parameters are not defined

Return values
AcademicSessionsOutputModel

OK - It was possible to read the collection.


        
On this page

Search results