Documentation

Categories extends BaseEndpoint
in package

Table of Contents

Properties

$url  : string

Methods

getByClassId()  : CategoriesOutputModel
Returns a collection of categories for a specified ```class\_id```.

Properties

$url

protected string $url = "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/classes/{class_id}/categories"

Endpoint URL pattern

Methods

getByClassId()

Returns a collection of categories for a specified ```class\_id```.

public getByClassId(array{class_id: string} $params) : CategoriesOutputModel
Parameters
$params : array{class_id: string}

An associative array

  • class_id: sourcedId for the category
Tags
throws
ArgumentException

if required parameters are not defined

Return values
CategoriesOutputModel

OK - It was possible to read the resource.


        
On this page

Search results