Categories
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- list_() : EventCategoryCollection
- Returns a collection of event categories.
- post() : EventCategoryCreateResponseExample
- Returns the ID of the created Events Category
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/events/categories"
Endpoint URL pattern
Methods
list_()
Returns a collection of event categories.
public
list_(array{page: int} $params) : EventCategoryCollection
Requires one of the following roles in the Education Management system:
-
Content Manager
-
Platform Manager
Parameters
- $params : array{page: int}
-
An associative array
- page: Format - int32. The page of results to start from.
Tags
Return values
EventCategoryCollection —Success
post()
Returns the ID of the created Events Category
public
post(EventCategory $requestBody) : EventCategoryCreateResponseExample
Requires one of the following roles in the Education Management system:
-
Content Manager
-
Platform Manager
Parameters
- $requestBody : EventCategory
Tags
Return values
EventCategoryCreateResponseExample —Success