Query parameters

• search string

  Search by class name, exact match only and case insensitive

• academicYearId string(uuid) | string

  Filter classes by academic year ID or provide current for the current academic year

• limit integer(int32)

  Specify the pagination limit, defaults to 100

• offset integer(int32)

  Specify the pagination offset, defaults to 0.

  Cannot be used with cursor

• cursor string(byte) | null

  Provide the next or previous page cursor

Responses

• 200 application/json

  A list of classes.

  Hide response attributes Show response attributes object

  • data array[object] Required
    Hide data attributes Show data attributes object

    • classId string(uuid) Required

      Class UUID.

    • name string Required

      The name of the class

    • description string

      Optional class description

    • academicYearId string(uuid) Required

      Academic Year UUID.

  • pagination object Required

    Metadata for the current pagination position

    Hide pagination attributes Show pagination attributes object

    • total integer(int32) Required

      The total number of items available.

    • limit integer(int32) Required

      The maximum number of results to return per page.

      Minimum value is 1, maximum value is 100. Default value is 100.

    • offset integer(int32) Required

      Indicates the starting position or index (offset)

      Default value is 0.

    • previousCursor string(byte) | null Required

      The cursor for pagination. Encoded byte string used to navigate between pages.

    • nextCursor string(byte) | null Required

      The cursor for pagination. Encoded byte string used to navigate between pages.

• 400

  Invalid request.

• 401

  Invalid authentication credentials

• 403

  Not authorised to access this resource