Categories
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- get() : CategoriesOutputModel
- Returns a collection of categories.
- getById() : CategoryOutputModel
- Returns a specific category.
- putById() : CategoryOutputModel
- Returns the category object that was created or updated.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/afe-rostr/ims/oneroster/v1p1/categories/{id}"
Methods
get()
Returns a collection of categories.
public
get() : CategoriesOutputModel
Return values
CategoriesOutputModel —OK - It was possible to read the collection.
getById()
Returns a specific category.
public
getById(array{id: string} $params) : CategoryOutputModel
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the category
Tags
Return values
CategoryOutputModel —OK - It was possible to read the resource.
putById()
Returns the category object that was created or updated.
public
putById(array{id: string} $params, CategoryInputModel $requestBody) : CategoryOutputModel
Parameters
- $params : array{id: string}
-
An associative array
- id: sourcedId for the category
- $requestBody : CategoryInputModel
-
input model for a category
Tags
Return values
CategoryOutputModel —OK - It was possible to read the resource.