CATEGORIES

Categories are a type of metadata available in the system, and are se on a per-Event basis.

The actions here allow you to Add, Update, Fetch, and Delete the Categories in the system.

You can also fetch Events based on a given Category.


Category Object

{
  "Id": "98d02f28-55e4-4c5d-abe8-0b3a82f93d60",
  "Name": "Example Category",
  "SystemCategory": false
}

Supported Actions

POST /category/

Add a Category.

Request Body:

Name: {string} - Name to add as a Category.

Response: 200 OK


PUT /category/{id}

Update a Category with the given Id.

Request Body:

Name: {string} - Name to set the Category name to.

Response: 200 OK


GET /category/

Get all Categories.

Response: 200 OK and a JSON array containing multiple Category objects.


GET /category/{id}

Get a Category by Id.

Response: 200 OK and JSON containing a Category object.


GET /category/{id}/events/

Gets the Events with the given Category Id.

Query Parameters:

PageSize:   {int} - Number of results to consider in a page.

PageNumber: {int} - Number of the page you are requesting.

Order: {QueryOrder} - Optional. ASC or DESC.

Response: 200 OK and JSON containing an Event collection.


DEL /category/{id}

Delete a Category by Id.

Response: 200 OK