For Developers

Categories

List Categories

categories.list(options);

Retrieve a list of Categories.

Function Arguments

This query allows for standard paging options.

Create Category

categories.create(class_id, category);

Create a Category in a Class.

Function Arguments

ParameterTypeDescription
class_idstringThe UUID of the class.
categoryCategoryThe category to create.

Fetch Category

categories.fetch(class_id, category_id);

Retrieve a Category in a Class.

Function Arguments

ParameterTypeDescription
class_idstringThe UUID of the class.
category_idstringThe UUID of the category.

Update Category

categories.update(class_id, category_id, category);

Update a Category in a Class.

Function Arguments

ParameterTypeDescription
class_idstringThe UUID of the class.
category_idstringThe UUID of the category.
categoryCategoryA partial category object.

Delete Category

categories.delete(class_id, category_id);

Delete a Category in a Class.

Function Arguments

ParameterTypeDescription
class_idstringThe UUID of the class.
category_idstringThe UUID of the category.