EVENT TYPES

EventTypes 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 EventTypes in the system.

You can also fetch Events based on a given EventType.


Event Type Object

{
  "Id": "553a8093-dc61-4e16-ac89-03e9c811efad",
  "Name": "Example Event Type",
  "ReferenceId": "reference-Id",
  "Colour": "#003c69"
}

Supported Actions

POST /eventtype/

Add an Event Type.

Request Body:

{
  "Name": "Example Event Type",
  "ReferenceId": "reference-Id",
  "Colour": "#003c69"
}

Response: 200 OK


PUT /eventtype/{id}

Update an Event Type by Id.

Request Body:

{
  "Name": "Example Event Type (Renamed)",
  "ReferenceId": "reference-Id",
  "Colour": "#003c69"
}

Response: 200 OK


PUT /eventtype/event/{id}

Update an Event by Id to have a specified Event Type Id.

Request Body:

{
  "EventTypeId": "78b14639-926f-40fd-9ba5-7c7c9316a93f"
}

Response: 200 OK


GET /eventtype/

Get all Event Types.

Response: 200 OK and JSON array containing multiple EventType objects.


GET /eventtype/{id}

Get an Event Type by Id.

Response: 200 OK and JSON containing the EventType object.


GET /eventtype/reference/{referenceId}

Get an Event Type by Reference Id.

Response: 200 OK and JSON containing the EventType object.


GET /eventtype/{id}/events/

Get Events which have the given Event Type Id set.

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 /eventtype/{id}

Delete an Event Type by Id.

Response: 200 OK