Documentation

Courses extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

getBySchoolId()  : CoursesOutputModel
Returns a collection of courses for the specified ```school\_id```.

Properties

$url

protected string $url = "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/schools/{school_id}/courses"

Endpoint URL pattern

Methods

getBySchoolId()

Returns a collection of courses for the specified ```school\_id```.

public getBySchoolId(array{school_id: string} $params) : CoursesOutputModel
Parameters
$params : array{school_id: string}

An associative array

  • school_id: sourcedId for the teacher
Tags
throws
ArgumentException

if required parameters are not defined

Return values
CoursesOutputModel

OK - It was possible to read the collection.


        
On this page

Search results