Event Categories

Gets a paginated list of the event categories configured for the calling organisation(s), sorted by name.

get

/api/v1/EventCategories

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Query parameters

PageNumberinteger · int32 · min: 1 · max: 2147483647Optional

PageSizeinteger · int32 · min: 1 · max: 2000Optional

OrganisationIdsinteger · int32[]Optional

Responses

200

OK

application/json

isSuccessbooleanOptional

errorsstring[] · nullableOptional

messageTranslationParametersany · nullableOptional

pageNumberinteger · int32Optional

pageSizeinteger · int32Optional

firstPagestring · uri · nullableOptional

lastPagestring · uri · nullableOptional

totalPagesinteger · int32Optional

totalRecordsinteger · int32Optional

nextPagestring · uri · nullableOptional

previousPagestring · uri · nullableOptional

baseUristring · uri · nullableOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/api/v1/EventCategories

GET /api/v1/EventCategories HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "errors": [
    "text"
  ],
  "messageTranslationParameters": null,
  "data": [
    {
      "id": 1,
      "organisationId": 1,
      "name": "text",
      "summaryDescription": "text",
      "colour": "text",
      "displayOrder": 1,
      "isCca": true
    }
  ],
  "pageNumber": 1,
  "pageSize": 1,
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "totalPages": 1,
  "totalRecords": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "baseUri": "https://example.com",
  "searchParameters": [
    {
      "key": "text",
      "value": "text"
    }
  ]
}

Gets a single event category by id. A deleted category, a fixture category, or one belonging to another organisation returns 404 EVENT_CATEGORY_NOT_FOUND.

get

/api/v1/EventCategories/{id}

Authorizations

AuthorizationstringRequired

Type "Bearer" followed by a space and a token.

Path parameters

idinteger · int32Required

The event category id

Query parameters

organisationIdinteger · int32Optional

The organisation to look the category up in — required when the client has access to multiple organisations

Responses

200

OK

application/json

idinteger · int32Optional

organisationIdinteger · int32Optional

namestring · nullableOptional

summaryDescriptionstring · nullableOptional

colourstring · nullableOptional

displayOrderinteger · int32Optional

isCcabooleanOptional

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get/api/v1/EventCategories/{id}

GET /api/v1/EventCategories/{id} HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "organisationId": 1,
  "name": "text",
  "summaryDescription": "text",
  "colour": "text",
  "displayOrder": 1,
  "isCca": true
}