> For the complete documentation index, see [llms.txt](https://guide.fariaedu.com/integrations-portal/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.fariaedu.com/integrations-portal/schoolsbuddy/public-rest-apis/models.md).

# Models

## The ActivityResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ActivityResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"sortPrefix":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"isForAllGroups":{"type":"boolean"},"isSport":{"type":"boolean"},"isTrip":{"type":"boolean"},"isOther":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The ActivityResponseDtoListPagedActivityFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ActivityResponseDtoListPagedActivityFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"ActivityResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"sortPrefix":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"isForAllGroups":{"type":"boolean"},"isSport":{"type":"boolean"},"isTrip":{"type":"boolean"},"isOther":{"type":"boolean"}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The AttendeeRegisterStateEnum object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"AttendeeRegisterStateEnum":{"enum":["Unset","Present","Absent","Late","Excused"],"type":"string"}}}}
```

## The AttendeeStatusEnum object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"AttendeeStatusEnum":{"enum":["ToBeConfirmed","Yes","No","IfRequired","Confirmed"],"type":"string"}}}}
```

## The BulkArchiveClassRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkArchiveClassRequestDto":{"required":["ids"],"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets or sets the ids of the classes to transition. Id validity is\r\nchecked per item (EC-7) — 0 / negative ids fail that item only."},"isArchived":{"type":"boolean","description":"Gets or sets a value indicating whether the classes are archived\r\n(true, default) or unarchived (false)."}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/Class/BulkArchive (SB-15447).\r\nToggleable: isArchived true archives, false unarchives (BulkArchive and\r\na PUT / BulkUpdate item carrying isArchived: false are the verbs allowed\r\nto operate on already-archived rows — EC-1 as amended 2026-07-31).\r\nBoth halves of the Team + SchoolClass pair transition in lockstep."}}}}
```

## The BulkArchiveGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkArchiveGroupRequestDto":{"required":["ids"],"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets or sets the ids of the groups to transition. Id validity is\r\nchecked per item (EC-7) — 0 / negative ids fail that item only."},"isArchived":{"type":"boolean","description":"Gets or sets a value indicating whether the groups are archived\r\n(true, default) or unarchived (false)."}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/Group/BulkArchive (SB-15446).\r\nToggleable: isArchived true archives, false unarchives (BulkArchive and\r\na PUT / BulkUpdate item carrying isArchived: false are the verbs allowed\r\nto operate on already-archived rows — EC-1 as amended 2026-07-31)."}}}}
```

## The BulkArchiveHouseRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkArchiveHouseRequestDto":{"required":["ids"],"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets or sets the ids of the houses to transition. Id validity is\r\nchecked per item (EC-7) — 0 / negative ids fail that item only."},"isArchived":{"type":"boolean","description":"Gets or sets a value indicating whether the houses are archived\r\n(true, default) or unarchived (false)."}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/House/BulkArchive (SB-15448).\r\nToggleable: isArchived true archives, false unarchives (BulkArchive and\r\na PUT / BulkUpdate item carrying isArchived: false are the verbs allowed\r\nto operate on already-archived rows — EC-1 as amended 2026-07-31).\r\nBoth halves of the Team + SchoolHouse pair transition in lockstep."}}}}
```

## The BulkArchiveIbpGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkArchiveIbpGroupRequestDto":{"required":["ids"],"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets or sets the ids (Team.Id) of the child groups to transition.\r\nId validity is checked per item (EC-7) — 0 / negative ids fail\r\nthat item only."},"isArchived":{"type":"boolean","description":"Gets or sets a value indicating whether the groups are archived\r\n(true, default) or unarchived (false)."}},"additionalProperties":false,"description":"Request body for POST /api/v1/CcaSignUp/IBP/{id}/groups/BulkArchive\r\n(SB-15665 §10 C3). Toggleable: isArchived true archives each group\r\n(Team.StatusId = Archive) — blocked per item with\r\nCCASIGNUP_ARCHIVE_BLOCKED_ACTIVE while the group has future events\r\n(§10 D2); false unarchives (StatusId = Active, never blocked). The\r\ncontainer cascade runs per item: archiving the last live group\r\narchives the container (CcaSignUp.Status = 4); unarchiving any group\r\nre-activates it. The parent signup id in the URL gates the whole\r\nrequest (CCASIGNUP_NOT_FOUND, validated before any per-item work) —\r\nan ARCHIVED parent is allowed here, since unarchiving a group is the\r\ncontainer's recovery path (§10 D5)."}}}}
```

## The BulkArchivePrefGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkArchivePrefGroupRequestDto":{"required":["ids"],"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets or sets the ids (Team.Id) of the child groups to transition.\r\nId validity is checked per item (EC-7) — 0 / negative ids fail\r\nthat item only."},"isArchived":{"type":"boolean","description":"Gets or sets a value indicating whether the groups are archived\r\n(true, default) or unarchived (false)."}},"additionalProperties":false,"description":"Request body for POST /api/v1/CcaSignUp/Pref/{id}/groups/BulkArchive\r\n(SB-15666, mirroring SB-15665 §10 C3). Toggleable: isArchived true\r\narchives each group (Team.StatusId = Archive) — blocked per item with\r\nCCASIGNUP_ARCHIVE_BLOCKED_ACTIVE while the group has future events\r\n(§10 D2); false unarchives (StatusId = Active, never blocked). The\r\ncontainer cascade runs per item: archiving the last live group\r\narchives the container (CcaSignUp.Status = 4); unarchiving any group\r\nre-activates it. The parent signup id in the URL gates the whole\r\nrequest (CCASIGNUP_NOT_FOUND, validated before any per-item work) —\r\nan ARCHIVED parent is allowed here, since unarchiving a group is the\r\ncontainer's recovery path (§10 D5)."}}}}
```

## The BulkArchiveSubjectClassRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkArchiveSubjectClassRequestDto":{"required":["ids"],"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets or sets the ids (SubjectClass.Id) of the Subject Classes to\r\ntransition. Id validity is checked per item (EC-7) — 0 / negative\r\nids fail that item only."},"isArchived":{"type":"boolean","description":"Gets or sets a value indicating whether the Subject Classes are\r\narchived (true, default) or unarchived (false)."}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/SubjectClass/BulkArchive\r\n(SB-15451). Toggleable: isArchived true archives (the parent Subject is\r\nunaffected, archive-strategy §2.5); false unarchives, and when the\r\nparent Subject is archived also restores it in the same transaction\r\n(upward cascade). BulkArchive and a PUT / BulkUpdate item carrying\r\nisArchived: false are the verbs allowed to operate on already-archived\r\nrows (EC-1 as amended 2026-07-31)."}}}}
```

## The BulkArchiveSubjectRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkArchiveSubjectRequestDto":{"required":["ids"],"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets or sets the ids (Subject.Id) of the Subjects to transition. Id\r\nvalidity is checked per item (EC-7) — 0 / negative ids fail that\r\nitem only."},"isArchived":{"type":"boolean","description":"Gets or sets a value indicating whether the Subjects are archived\r\n(true, default) or unarchived (false)."}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/Subject/BulkArchive (SB-15450).\r\nToggleable: isArchived true archives (and cascade-archives each Subject's\r\nactive SubjectClasses, archive-strategy §2.6), false unarchives the\r\nSubject only (no class cascade). BulkArchive and a PUT / BulkUpdate\r\nitem carrying isArchived: false are the verbs allowed to operate on\r\nalready-archived rows (EC-1 as amended 2026-07-31)."}}}}
```

## The BulkArchiveYearRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkArchiveYearRequestDto":{"required":["ids"],"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets or sets the ids (Club.Id) of the Years to transition. Id\r\nvalidity is checked per item (EC-7) — 0 / negative ids fail that\r\nitem only."},"isArchived":{"type":"boolean","description":"Gets or sets a value indicating whether the Years are archived\r\n(true, default) or unarchived (false)."}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/Year/BulkArchive (SB-15449).\r\nToggleable: isArchived true archives, false unarchives (BulkArchive and\r\na PUT / BulkUpdate item carrying isArchived: false are the verbs allowed\r\nto operate on already-archived rows — EC-1 as amended 2026-07-31).\r\nBoth halves of the Club + SchoolYearGroup pair transition in lockstep.\r\nThe Whole school row rejects the transition per-item\r\n(YEAR_WHOLE_SCHOOL_NOT_EDITABLE)."}}}}
```

## The BulkCreateClassItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateClassItemDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":240,"minLength":1,"type":"string"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkCreateClassRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateClassRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkCreateClassItemDto"},"description":"Gets or sets the classes to create. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations surface per item in failedItems[]\r\ninstead of failing the whole request (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/Class/BulkCreate (SB-15447).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1) — items are not individually org-addressable."},"BulkCreateClassItemDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":240,"minLength":1,"type":"string"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkCreateGroupItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateGroupItemDto":{"required":["activityId","description","leadStaffId","name"],"type":"object","properties":{"name":{"maxLength":240,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"activityId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"taxCode":{"maxLength":10,"type":"string","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkCreateGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateGroupRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkCreateGroupItemDto"},"description":"Gets or sets the groups to create. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations surface per item in failedItems[]\r\ninstead of failing the whole request (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/Group/BulkCreate (SB-15446).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1) — items are not individually org-addressable."},"BulkCreateGroupItemDto":{"required":["activityId","description","leadStaffId","name"],"type":"object","properties":{"name":{"maxLength":240,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"activityId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"taxCode":{"maxLength":10,"type":"string","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkCreateHouseItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateHouseItemDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":240,"minLength":1,"type":"string"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkCreateHouseRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateHouseRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkCreateHouseItemDto"},"description":"Gets or sets the houses to create. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations surface per item in failedItems[]\r\ninstead of failing the whole request (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/House/BulkCreate (SB-15448).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1) — items are not individually org-addressable."},"BulkCreateHouseItemDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":240,"minLength":1,"type":"string"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkCreateIbpGroupItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateIbpGroupItemDto":{"required":["activityId","availableTo","description","groupName","leadStaffId"],"type":"object","properties":{"groupName":{"maxLength":255,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"activityId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"}},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkCreateIbpGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateIbpGroupRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkCreateIbpGroupItemDto"},"description":"Gets or sets the child groups to create. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations surface per item in failedItems[]\r\n(cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for POST /api/v1/CcaSignUp/IBP/{id}/groups/BulkCreate\r\n(SB-15665). The parent signup id in the URL gates the whole request\r\n(CCASIGNUP_NOT_FOUND, validated before any per-item work — closes\r\nSB-15244 / SB-15245)."},"BulkCreateIbpGroupItemDto":{"required":["activityId","availableTo","description","groupName","leadStaffId"],"type":"object","properties":{"groupName":{"maxLength":255,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"activityId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"}},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkCreatePrefGroupItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreatePrefGroupItemDto":{"required":["activityId","availableTo","day1","day1EndTime","day1StartTime","description","groupName","leadStaffId"],"type":"object","properties":{"groupName":{"maxLength":255,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"activityId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"day1":{"$ref":"#/components/schemas/DayOfWeekType"},"day1StartTime":{"type":"string","format":"partial-time"},"day1EndTime":{"type":"string","format":"partial-time"},"day2":{"$ref":"#/components/schemas/DayOfWeekType"},"day2StartTime":{"type":"string","format":"partial-time","nullable":true},"day2EndTime":{"type":"string","format":"partial-time","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"cost":{"type":"number","format":"double","nullable":true},"joinRequestsOn":{"type":"boolean","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"}},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"DayOfWeekType":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkCreatePrefGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreatePrefGroupRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkCreatePrefGroupItemDto"},"description":"Gets or sets the child groups to create. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations surface per item in failedItems[]\r\n(cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for POST /api/v1/CcaSignUp/Pref/{id}/groups/BulkCreate\r\n(SB-15666). The parent signup id in the URL gates the whole request\r\n(CCASIGNUP_NOT_FOUND, validated before any per-item work — closes\r\nSB-15244 / SB-15245)."},"BulkCreatePrefGroupItemDto":{"required":["activityId","availableTo","day1","day1EndTime","day1StartTime","description","groupName","leadStaffId"],"type":"object","properties":{"groupName":{"maxLength":255,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"activityId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"day1":{"$ref":"#/components/schemas/DayOfWeekType"},"day1StartTime":{"type":"string","format":"partial-time"},"day1EndTime":{"type":"string","format":"partial-time"},"day2":{"$ref":"#/components/schemas/DayOfWeekType"},"day2StartTime":{"type":"string","format":"partial-time","nullable":true},"day2EndTime":{"type":"string","format":"partial-time","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"cost":{"type":"number","format":"double","nullable":true},"joinRequestsOn":{"type":"boolean","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"}},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"DayOfWeekType":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkCreateSubjectClassItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateSubjectClassItemDto":{"required":["leadStaffId","schoolYearGroupId","subjectId","title"],"type":"object","properties":{"title":{"maxLength":250,"minLength":1,"type":"string"},"subjectId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"schoolYearGroupId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkCreateSubjectClassRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateSubjectClassRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkCreateSubjectClassItemDto"},"description":"Gets or sets the Subject Classes to create. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations surface per item in failedItems[]\r\ninstead of failing the whole request (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/SubjectClass/BulkCreate (SB-15451).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1) — items are not individually org-addressable."},"BulkCreateSubjectClassItemDto":{"required":["leadStaffId","schoolYearGroupId","subjectId","title"],"type":"object","properties":{"title":{"maxLength":250,"minLength":1,"type":"string"},"subjectId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"schoolYearGroupId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkCreateSubjectItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateSubjectItemDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":200,"minLength":1,"type":"string"},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkCreateSubjectRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateSubjectRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkCreateSubjectItemDto"},"description":"Gets or sets the Subjects to create. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations surface per item in failedItems[]\r\ninstead of failing the whole request (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/Subject/BulkCreate (SB-15450).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1) — items are not individually org-addressable."},"BulkCreateSubjectItemDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":200,"minLength":1,"type":"string"},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkCreateYearItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateYearItemDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":150,"minLength":1,"type":"string"},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkCreateYearRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkCreateYearRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkCreateYearItemDto"},"description":"Gets or sets the Years to create. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations surface per item in failedItems[]\r\ninstead of failing the whole request (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for POST /api/v1/Groups/Year/BulkCreate (SB-15449).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1) — items are not individually org-addressable."},"BulkCreateYearItemDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":150,"minLength":1,"type":"string"},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkFailedItem object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkFailedItem":{"type":"object","properties":{"index":{"type":"integer","description":"Gets or sets the zero-based index of the failed item within the\r\nrequest array, so callers keeping request order can map it back.","format":"int32"},"clientReferenceId":{"type":"string","description":"Gets or sets the optional opaque client-supplied reference echoed\r\nback from the request item. Null when the caller did not supply one.","nullable":true},"name":{"type":"string","description":"Gets or sets the name of the entity the failed item referred to,\r\nfor at-a-glance identification in the response.","nullable":true},"code":{"type":"string","description":"Gets or sets the machine-readable error code (e.g.\r\n`VALIDATION_FAILED`, `GROUP_IMPORTED_READ_ONLY`) per\r\ncross-cutting-design.md §5.1.","nullable":true},"error":{"type":"string","description":"Gets or sets the human-readable error message.","nullable":true}},"additionalProperties":false,"description":"A single per-item failure entry in a SchoolsBuddy.PublicAPI.Models.BulkOperationResult`1\r\nenvelope. Mirrors the structured error body (cross-cutting-design.md §5.3):\r\na machine-readable SchoolsBuddy.PublicAPI.Models.BulkFailedItem.Code plus a human-readable SchoolsBuddy.PublicAPI.Models.BulkFailedItem.Error."}}}}
```

## The BulkUpdateClassItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateClassItemDto":{"type":"object","properties":{"name":{"maxLength":240,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkUpdateClassRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateClassRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateClassItemDto"},"description":"Gets or sets the class updates. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations (including missing / 0 / negative id,\r\nEC-7) surface per item in failedItems[] instead of failing the\r\nwhole request (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for PUT /api/v1/Groups/Class/BulkUpdate (SB-15447).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1)."},"BulkUpdateClassItemDto":{"type":"object","properties":{"name":{"maxLength":240,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkUpdateGroupItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateGroupItemDto":{"type":"object","properties":{"name":{"maxLength":240,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"taxCode":{"maxLength":10,"type":"string","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkUpdateGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateGroupRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateGroupItemDto"},"description":"Gets or sets the group updates. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations (including missing / 0 / negative id,\r\nEC-7) surface per item in failedItems[] instead of failing the\r\nwhole request (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for PUT /api/v1/Groups/Group/BulkUpdate (SB-15446).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1)."},"BulkUpdateGroupItemDto":{"type":"object","properties":{"name":{"maxLength":240,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"taxCode":{"maxLength":10,"type":"string","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkUpdateHouseItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateHouseItemDto":{"type":"object","properties":{"name":{"maxLength":240,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkUpdateHouseRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateHouseRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateHouseItemDto"},"description":"Gets or sets the house updates. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations (including missing / 0 / negative id,\r\nEC-7) surface per item in failedItems[] instead of failing the\r\nwhole request (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for PUT /api/v1/Groups/House/BulkUpdate (SB-15448).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1)."},"BulkUpdateHouseItemDto":{"type":"object","properties":{"name":{"maxLength":240,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkUpdateIbpGroupItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateIbpGroupItemDto":{"type":"object","properties":{"groupName":{"maxLength":255,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkUpdateIbpGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateIbpGroupRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateIbpGroupItemDto"},"description":"Gets or sets the child groups to update. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations surface per item in failedItems[]\r\n(cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for PUT /api/v1/CcaSignUp/IBP/{id}/groups/BulkUpdate\r\n(SB-15665). The parent signup id in the URL gates the whole request\r\n(CCASIGNUP_NOT_FOUND, validated before any per-item work); each item\r\ncarries its target group Id (EC-7)."},"BulkUpdateIbpGroupItemDto":{"type":"object","properties":{"groupName":{"maxLength":255,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkUpdatePrefGroupItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdatePrefGroupItemDto":{"type":"object","properties":{"groupName":{"maxLength":255,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"day1":{"$ref":"#/components/schemas/DayOfWeekType"},"day1StartTime":{"type":"string","format":"partial-time","nullable":true},"day1EndTime":{"type":"string","format":"partial-time","nullable":true},"day2":{"$ref":"#/components/schemas/DayOfWeekType"},"day2StartTime":{"type":"string","format":"partial-time","nullable":true},"day2EndTime":{"type":"string","format":"partial-time","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"cost":{"type":"number","format":"double","nullable":true},"joinRequestsOn":{"type":"boolean","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"DayOfWeekType":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkUpdatePrefGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdatePrefGroupRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdatePrefGroupItemDto"},"description":"Gets or sets the child groups to update. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations surface per item in failedItems[]\r\n(cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for PUT /api/v1/CcaSignUp/Pref/{id}/groups/BulkUpdate\r\n(SB-15666). The parent signup id in the URL gates the whole request\r\n(CCASIGNUP_NOT_FOUND, validated before any per-item work); each item\r\ncarries its target group Id (EC-7)."},"BulkUpdatePrefGroupItemDto":{"type":"object","properties":{"groupName":{"maxLength":255,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"day1":{"$ref":"#/components/schemas/DayOfWeekType"},"day1StartTime":{"type":"string","format":"partial-time","nullable":true},"day1EndTime":{"type":"string","format":"partial-time","nullable":true},"day2":{"$ref":"#/components/schemas/DayOfWeekType"},"day2StartTime":{"type":"string","format":"partial-time","nullable":true},"day2EndTime":{"type":"string","format":"partial-time","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"cost":{"type":"number","format":"double","nullable":true},"joinRequestsOn":{"type":"boolean","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false},"DayOfWeekType":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The BulkUpdateSubjectClassItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateSubjectClassItemDto":{"type":"object","properties":{"title":{"maxLength":250,"type":"string","nullable":true},"subjectId":{"type":"integer","format":"int32","nullable":true},"schoolYearGroupId":{"type":"integer","format":"int32","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkUpdateSubjectClassRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateSubjectClassRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateSubjectClassItemDto"},"description":"Gets or sets the Subject Class updates. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations (including missing / 0 / negative id, EC-7)\r\nsurface per item in failedItems[] instead of failing the whole\r\nrequest (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for PUT /api/v1/Groups/SubjectClass/BulkUpdate (SB-15451).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1)."},"BulkUpdateSubjectClassItemDto":{"type":"object","properties":{"title":{"maxLength":250,"type":"string","nullable":true},"subjectId":{"type":"integer","format":"int32","nullable":true},"schoolYearGroupId":{"type":"integer","format":"int32","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkUpdateSubjectItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateSubjectItemDto":{"type":"object","properties":{"name":{"maxLength":200,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkUpdateSubjectRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateSubjectRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateSubjectItemDto"},"description":"Gets or sets the Subject updates. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations (including missing / 0 / negative id, EC-7)\r\nsurface per item in failedItems[] instead of failing the whole\r\nrequest (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for PUT /api/v1/Groups/Subject/BulkUpdate (SB-15450).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1)."},"BulkUpdateSubjectItemDto":{"type":"object","properties":{"name":{"maxLength":200,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkUpdateYearItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateYearItemDto":{"type":"object","properties":{"name":{"maxLength":150,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The BulkUpdateYearRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"BulkUpdateYearRequestDto":{"type":"object","properties":{"organisationId":{"type":"integer","description":"Gets or sets the organisation the batch operates on. Optional\r\nwhen the calling client has access to a single organisation;\r\nrequired for multi-org clients.","format":"int32","nullable":true},"items":{"type":"array","items":{"$ref":"#/components/schemas/BulkUpdateYearItemDto"},"description":"Gets or sets the Year updates. Each item is processed\r\nindependently; one failure does not roll back the others.\r\nItem-level validation deliberately bypasses automatic model\r\nvalidation — violations (including missing / 0 / negative id,\r\nEC-7, and the Whole school guard) surface per item in failedItems[]\r\ninstead of failing the whole request (cross-cutting §6.1).","nullable":true}},"additionalProperties":false,"description":"Request body for PUT /api/v1/Groups/Year/BulkUpdate (SB-15449).\r\nThe envelope-level organisationId scopes every item in the batch\r\n(cross-cutting §3.8.1)."},"BulkUpdateYearItemDto":{"type":"object","properties":{"name":{"maxLength":150,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true},"id":{"type":"integer","format":"int32","nullable":true},"clientReferenceId":{"maxLength":100,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CcaCostTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CcaCostTypeEnum":{"enum":["FreeOfCharge","PerTermOrSeason","PerSession","OneOff"],"type":"string"}}}}
```

## The CcaGroupAvailabilityDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CcaGroupAvailabilityDto":{"required":["groupId","requirementGroupId","requirementGroupType"],"type":"object","properties":{"groupId":{"type":"integer","format":"int32"},"requirementGroupId":{"$ref":"#/components/schemas/RequirementType"},"requirementGroupType":{"$ref":"#/components/schemas/RequirementGroupType"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"RequirementType":{"enum":["AvailableTo","PreRequisite","NotAvailableTo"],"type":"string"},"RequirementGroupType":{"enum":["Group","Club","SubjectClass"],"type":"string"}}}}
```

## The CcaGroupReferenceDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"}}}}
```

## The CcaGroupReferenceType object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"}}}}
```

## The CcaSignupResponsibility object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CcaSignupResponsibility":{"enum":["None","PupilsOrParents","ParentsOnly","PupilsOnly"],"type":"string"}}}}
```

## The ClassResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ClassResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The ClassResponseDtoListPagedClassFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ClassResponseDtoListPagedClassFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClassResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"ClassResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The ClassStudentsOperationResultDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ClassStudentsOperationResultDto":{"type":"object","properties":{"studentsProcessed":{"type":"integer","format":"int32"},"totalRequested":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```

## The ClassStudentsRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ClassStudentsRequestDto":{"required":["studentIds"],"type":"object","properties":{"studentIds":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"}}},"additionalProperties":false}}}}
```

## The ContactBulkArchiveRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ContactBulkArchiveRequestDto":{"required":["ids"],"type":"object","properties":{"organisationId":{"type":"integer","format":"int32","nullable":true},"archive":{"type":"boolean"},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"}}},"additionalProperties":false}}}}
```

## The ContactCreateRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ContactCreateRequestDto":{"required":["emailAddress","firstName","lastName"],"type":"object","properties":{"contactId":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"mobilePhoneNumber":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"streetAddress":{"type":"string","nullable":true},"streetAddress2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"lastName":{"minLength":1,"type":"string"},"firstName":{"minLength":1,"type":"string"},"emailAddress":{"minLength":1,"type":"string","format":"email"}},"additionalProperties":false}}}}
```

## The ContactDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ContactDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"contactId":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"mobilePhoneNumber":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"streetAddress":{"type":"string","nullable":true},"streetAddress2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"relatedPeople":{"type":"array","items":{"$ref":"#/components/schemas/ContactRelatedPersonDto"},"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"isArchived":{"type":"boolean"},"updatable":{"type":"boolean"}},"additionalProperties":false},"ContactRelatedPersonDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"vban":{"type":"string","nullable":true},"isParent":{"type":"boolean"},"isBillingContact":{"type":"boolean"},"isReportContact":{"type":"boolean"},"isCommunicationContact":{"type":"boolean"},"isEmergencyContact":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The ContactDtoListPagedContactSearchResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ContactDtoListPagedContactSearchResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"ContactDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"contactId":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"emailAddress":{"type":"string","nullable":true},"mobilePhoneNumber":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"streetAddress":{"type":"string","nullable":true},"streetAddress2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"relatedPeople":{"type":"array","items":{"$ref":"#/components/schemas/ContactRelatedPersonDto"},"nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"isArchived":{"type":"boolean"},"updatable":{"type":"boolean"}},"additionalProperties":false},"ContactRelatedPersonDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"vban":{"type":"string","nullable":true},"isParent":{"type":"boolean"},"isBillingContact":{"type":"boolean"},"isReportContact":{"type":"boolean"},"isCommunicationContact":{"type":"boolean"},"isEmergencyContact":{"type":"boolean"}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The ContactRelatedPersonDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ContactRelatedPersonDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"vban":{"type":"string","nullable":true},"isParent":{"type":"boolean"},"isBillingContact":{"type":"boolean"},"isReportContact":{"type":"boolean"},"isCommunicationContact":{"type":"boolean"},"isEmergencyContact":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The ContactTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ContactTypeEnum":{"enum":["IsParent","IsEmergencyContact","IsBillingContact","IsReportContact","IsCommunicationContact"],"type":"string"}}}}
```

## The ContactUpdateRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ContactUpdateRequestDto":{"type":"object","properties":{"contactId":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"emailAddress":{"type":"string","format":"email","nullable":true},"mobilePhoneNumber":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"streetAddress":{"type":"string","nullable":true},"streetAddress2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"isArchived":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The CreateClassRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreateClassRequestDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":240,"minLength":1,"type":"string"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true}},"additionalProperties":false}}}}
```

## The CreateGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreateGroupRequestDto":{"required":["activityId","description","leadStaffId","name"],"type":"object","properties":{"name":{"maxLength":240,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"activityId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"taxCode":{"maxLength":10,"type":"string","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true}},"additionalProperties":false},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The CreateHouseRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreateHouseRequestDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":240,"minLength":1,"type":"string"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true}},"additionalProperties":false}}}}
```

## The CreateIbpGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreateIbpGroupRequestDto":{"required":["activityId","availableTo","description","groupName","leadStaffId"],"type":"object","properties":{"groupName":{"maxLength":255,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"activityId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"}},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true}},"additionalProperties":false},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The CreateIbpRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreateIbpRequestDto":{"required":["activitiesEndDate","activitiesStartDate","description","name","signupCloses","signupOpens"],"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"activitiesStartDate":{"type":"string","format":"date"},"activitiesEndDate":{"type":"string","format":"date"},"activitiesDefaultStartTime":{"type":"string","format":"partial-time","nullable":true},"activitiesDefaultEndTime":{"type":"string","format":"partial-time","nullable":true},"responsibilityForConfirmation":{"$ref":"#/components/schemas/CcaSignupResponsibility"},"signupOpens":{"type":"string","format":"date-time"},"signupCloses":{"type":"string","format":"date-time"},"termsAndConditions":{"type":"string","nullable":true},"additionalInfoUrl":{"type":"string","nullable":true}},"additionalProperties":false},"CcaSignupResponsibility":{"enum":["None","PupilsOrParents","ParentsOnly","PupilsOnly"],"type":"string"}}}}
```

## The CreateLocationRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreateLocationRequestDto":{"required":["locationName"],"type":"object","properties":{"organisationId":{"type":"integer","format":"int32","nullable":true},"locationName":{"maxLength":100,"minLength":1,"type":"string"},"locationDescription":{"type":"string","nullable":true},"isHome":{"type":"boolean"},"locationTypeId":{"type":"integer","format":"int32"},"city":{"maxLength":100,"type":"string","nullable":true},"state":{"maxLength":100,"type":"string","nullable":true},"postCode":{"maxLength":20,"type":"string","nullable":true},"telephone":{"maxLength":50,"type":"string","nullable":true},"streetAddress":{"maxLength":200,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The CreatePrefGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreatePrefGroupRequestDto":{"required":["activityId","availableTo","day1","day1EndTime","day1StartTime","description","groupName","leadStaffId"],"type":"object","properties":{"groupName":{"maxLength":255,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"activityId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"day1":{"$ref":"#/components/schemas/DayOfWeekType"},"day1StartTime":{"type":"string","format":"partial-time"},"day1EndTime":{"type":"string","format":"partial-time"},"day2":{"$ref":"#/components/schemas/DayOfWeekType"},"day2StartTime":{"type":"string","format":"partial-time","nullable":true},"day2EndTime":{"type":"string","format":"partial-time","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"cost":{"type":"number","format":"double","nullable":true},"joinRequestsOn":{"type":"boolean","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"}},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true}},"additionalProperties":false},"DayOfWeekType":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The CreatePrefRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreatePrefRequestDto":{"required":["activitiesEndDate","activitiesStartDate","description","eventCategoryId","name","signupCloses","signupOpens"],"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string"},"description":{"minLength":1,"type":"string"},"preferenceSelectionScope":{"$ref":"#/components/schemas/PreferenceSelectionScopeEnum"},"eventCategoryId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"activitiesStartDate":{"type":"string","format":"date"},"activitiesEndDate":{"type":"string","format":"date"},"activitiesDefaultStartTime":{"type":"string","format":"partial-time","nullable":true},"activitiesDefaultEndTime":{"type":"string","format":"partial-time","nullable":true},"responsibilityForConfirmation":{"$ref":"#/components/schemas/CcaSignupResponsibility"},"signupOpens":{"type":"string","format":"date-time"},"signupCloses":{"type":"string","format":"date-time"},"termsAndConditions":{"type":"string","nullable":true},"additionalInfoUrl":{"type":"string","nullable":true}},"additionalProperties":false},"PreferenceSelectionScopeEnum":{"enum":["Daily","Weekly"],"type":"string"},"CcaSignupResponsibility":{"enum":["None","PupilsOrParents","ParentsOnly","PupilsOnly"],"type":"string"}}}}
```

## The CreateSubjectClassRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreateSubjectClassRequestDto":{"required":["leadStaffId","schoolYearGroupId","subjectId","title"],"type":"object","properties":{"title":{"maxLength":250,"minLength":1,"type":"string"},"subjectId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"schoolYearGroupId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"},"leadStaffId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```

## The CreateSubjectRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreateSubjectRequestDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":200,"minLength":1,"type":"string"}},"additionalProperties":false}}}}
```

## The CreateYearRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"CreateYearRequestDto":{"required":["name"],"type":"object","properties":{"name":{"maxLength":150,"minLength":1,"type":"string"}},"additionalProperties":false}}}}
```

## The DayOfWeekType object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"DayOfWeekType":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"code":{"type":"string","description":"Gets or sets the machine-readable error code (e.g.\r\n`VALIDATION_FAILED`, `RESOURCE_NOT_FOUND`,\r\n`INTERNAL_ERROR`) per cross-cutting-design.md §5.1.","nullable":true},"error":{"type":"string","description":"Gets or sets the human-readable error message.","nullable":true}},"additionalProperties":false,"description":"Structured body for 4xx / 5xx responses on the new Public API surface:\r\na machine-readable SchoolsBuddy.PublicAPI.Models.ErrorResponse.Code plus a human-readable\r\nSchoolsBuddy.PublicAPI.Models.ErrorResponse.Error. See cross-cutting-design.md §5.3. This is additive —\r\nexisting endpoints continue returning their legacy plain-string /\r\nModelState shapes until migrated by their per-controller ticket."}}}}
```

## The EventAttendanceDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"EventAttendanceDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"calendarEventId":{"type":"integer","format":"int32"},"registerStatus":{"$ref":"#/components/schemas/AttendeeRegisterStateEnum"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"registerUpdatedAt":{"type":"string","format":"date-time","nullable":true},"registerUpdatedBy":{"type":"integer","format":"int32","nullable":true},"registerUpdatedByName":{"type":"string","nullable":true},"attendanceNote":{"type":"string","nullable":true}},"additionalProperties":false},"AttendeeRegisterStateEnum":{"enum":["Unset","Present","Absent","Late","Excused"],"type":"string"}}}}
```

## The EventAttendanceUpdateDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"EventAttendanceUpdateDto":{"required":["id","registerStatus"],"type":"object","properties":{"id":{"type":"integer","format":"int32"},"registerStatus":{"$ref":"#/components/schemas/AttendeeRegisterStateEnum"},"attendanceNote":{"type":"string","nullable":true}},"additionalProperties":false},"AttendeeRegisterStateEnum":{"enum":["Unset","Present","Absent","Late","Excused"],"type":"string"}}}}
```

## The EventCategoryResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"EventCategoryResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"summaryDescription":{"type":"string","nullable":true},"colour":{"type":"string","nullable":true},"displayOrder":{"type":"integer","format":"int32"},"isCca":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The EventCategoryResponseDtoListPagedEventCategoryFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"EventCategoryResponseDtoListPagedEventCategoryFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/EventCategoryResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"EventCategoryResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"summaryDescription":{"type":"string","nullable":true},"colour":{"type":"string","nullable":true},"displayOrder":{"type":"integer","format":"int32"},"isCca":{"type":"boolean"}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The EventParticipantDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"EventParticipantDto":{"required":["attendeeStatus","misId","registerStatus"],"type":"object","properties":{"misId":{"minLength":1,"type":"string"},"attendanceNote":{"type":"string","nullable":true},"attendeeStatus":{"$ref":"#/components/schemas/ExternalAttendeeStatus"},"registerStatus":{"$ref":"#/components/schemas/ExternalRegisterStatus"}},"additionalProperties":false},"ExternalAttendeeStatus":{"enum":["NotExpected","Expected"],"type":"string"},"ExternalRegisterStatus":{"enum":["Unset","Present","Absent"],"type":"string"}}}}
```

## The EventRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"EventRequestDto":{"required":["endDateTime","id","name","organisationId","source","startDateTime"],"type":"object","properties":{"organisationId":{"type":"integer","format":"int32"},"id":{"minLength":1,"type":"string"},"source":{"$ref":"#/components/schemas/ExternalSource"},"name":{"minLength":1,"type":"string"},"startDateTime":{"type":"string","format":"date-time"},"endDateTime":{"type":"string","format":"date-time"},"participants":{"type":"array","items":{"$ref":"#/components/schemas/EventParticipantDto"},"nullable":true}},"additionalProperties":false},"ExternalSource":{"enum":["Vectare"],"type":"string"},"EventParticipantDto":{"required":["attendeeStatus","misId","registerStatus"],"type":"object","properties":{"misId":{"minLength":1,"type":"string"},"attendanceNote":{"type":"string","nullable":true},"attendeeStatus":{"$ref":"#/components/schemas/ExternalAttendeeStatus"},"registerStatus":{"$ref":"#/components/schemas/ExternalRegisterStatus"}},"additionalProperties":false},"ExternalAttendeeStatus":{"enum":["NotExpected","Expected"],"type":"string"},"ExternalRegisterStatus":{"enum":["Unset","Present","Absent"],"type":"string"}}}}
```

## The EventStudentAttendanceUpdateDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"EventStudentAttendanceUpdateDto":{"required":["attendanceStatus","endDateTime","startDateTime"],"type":"object","properties":{"id":{"type":"integer","format":"int32","nullable":true},"studentId":{"type":"string","nullable":true},"startDateTime":{"type":"string","format":"date-time"},"endDateTime":{"type":"string","format":"date-time"},"attendanceStatus":{"$ref":"#/components/schemas/AttendeeStatusEnum"},"attendanceNote":{"type":"string","nullable":true}},"additionalProperties":false},"AttendeeStatusEnum":{"enum":["ToBeConfirmed","Yes","No","IfRequired","Confirmed"],"type":"string"}}}}
```

## The ExternalAttendeeStatus object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ExternalAttendeeStatus":{"enum":["NotExpected","Expected"],"type":"string"}}}}
```

## The ExternalRegisterStatus object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ExternalRegisterStatus":{"enum":["Unset","Present","Absent"],"type":"string"}}}}
```

## The ExternalSource object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ExternalSource":{"enum":["Vectare"],"type":"string"}}}}
```

## The GenderTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"GenderTypeEnum":{"enum":["Female","Male","Unspecified"],"type":"string"}}}}
```

## The GroupEventResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"GroupEventResponseDto":{"type":"object","properties":{"eventId":{"type":"integer","format":"int32"},"eventName":{"type":"string","nullable":true},"eventStartTime":{"type":"string","format":"date-time"},"eventEndTime":{"type":"string","format":"date-time"},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"locationId":{"type":"integer","format":"int32","nullable":true},"numberOfPlaces":{"type":"integer","format":"int32","nullable":true},"eventTypeId":{"type":"integer","format":"int32","nullable":true},"eventType":{"type":"string","nullable":true},"isCancelled":{"type":"boolean"},"isDeleted":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"timeZone":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The GroupExtendedDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"GroupExtendedDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"groupId":{"type":"integer","format":"int32","nullable":true},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"groupCode":{"type":"string","nullable":true},"billingCode":{"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32"},"leadStaffName":{"type":"string","nullable":true},"signupId":{"type":"integer","format":"int32","nullable":true},"signupName":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"isArchived":{"type":"boolean"},"taxCode":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true},"dayOfWeek":{"$ref":"#/components/schemas/DayOfWeekType"},"ccaStartTime":{"type":"string","format":"partial-time","nullable":true},"ccaEndTime":{"type":"string","format":"partial-time","nullable":true},"size":{"type":"integer","format":"int32","nullable":true},"minSize":{"type":"integer","format":"int32","nullable":true},"ccaPrice":{"type":"string","nullable":true},"allowJoinRequests":{"type":"boolean","nullable":true},"linkedParentTeamId":{"type":"integer","format":"int32","nullable":true},"availability":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupAvailabilityDto"},"nullable":true},"teamTypeId":{"type":"integer","format":"int32","nullable":true},"description":{"type":"string","nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"defaultLocation":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean"},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"genderName":{"type":"string","nullable":true},"defaultLocationName":{"type":"string","nullable":true},"activityName":{"type":"string","nullable":true}},"additionalProperties":false},"DayOfWeekType":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"CcaGroupAvailabilityDto":{"required":["groupId","requirementGroupId","requirementGroupType"],"type":"object","properties":{"groupId":{"type":"integer","format":"int32"},"requirementGroupId":{"$ref":"#/components/schemas/RequirementType"},"requirementGroupType":{"$ref":"#/components/schemas/RequirementGroupType"},"name":{"type":"string","nullable":true}},"additionalProperties":false},"RequirementType":{"enum":["AvailableTo","PreRequisite","NotAvailableTo"],"type":"string"},"RequirementGroupType":{"enum":["Group","Club","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The GroupResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"GroupResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"activityId":{"type":"integer","format":"int32"},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"groupCode":{"type":"string","nullable":true},"billingCode":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true},"taxCode":{"type":"string","nullable":true},"showInSportsPortal":{"type":"boolean"},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"locationId":{"type":"integer","format":"int32","nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The GroupResponseDtoListPagedGroupFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"GroupResponseDtoListPagedGroupFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"GroupResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"activityId":{"type":"integer","format":"int32"},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"groupCode":{"type":"string","nullable":true},"billingCode":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true},"taxCode":{"type":"string","nullable":true},"showInSportsPortal":{"type":"boolean"},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"locationId":{"type":"integer","format":"int32","nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The GroupStudentsOperationResultDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"GroupStudentsOperationResultDto":{"type":"object","properties":{"studentsProcessed":{"type":"integer","format":"int32"},"totalRequested":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```

## The GroupStudentsRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"GroupStudentsRequestDto":{"required":["studentIds"],"type":"object","properties":{"studentIds":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"}}},"additionalProperties":false}}}}
```

## The HouseResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"HouseResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The HouseResponseDtoListPagedHouseFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"HouseResponseDtoListPagedHouseFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/HouseResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"HouseResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The HouseStudentsOperationResultDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"HouseStudentsOperationResultDto":{"type":"object","properties":{"studentsProcessed":{"type":"integer","format":"int32"},"totalRequested":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```

## The HouseStudentsRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"HouseStudentsRequestDto":{"required":["studentIds"],"type":"object","properties":{"studentIds":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"}}},"additionalProperties":false}}}}
```

## The IbpGroupResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"IbpGroupResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"groupName":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groupCode":{"type":"string","nullable":true},"billingCode":{"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean"},"locationId":{"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean"},"maximumPlaces":{"type":"integer","format":"int32"},"minimumPlaces":{"type":"integer","format":"int32"},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time","nullable":true},"updatedAtUtc":{"type":"string","format":"date-time"}},"additionalProperties":false},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The IbpGroupResponseDtoListPagedIbpGroupFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"IbpGroupResponseDtoListPagedIbpGroupFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/IbpGroupResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"IbpGroupResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"groupName":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groupCode":{"type":"string","nullable":true},"billingCode":{"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean"},"locationId":{"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean"},"maximumPlaces":{"type":"integer","format":"int32"},"minimumPlaces":{"type":"integer","format":"int32"},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time","nullable":true},"updatedAtUtc":{"type":"string","format":"date-time"}},"additionalProperties":false},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The IbpResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"IbpResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"containerTypeId":{"type":"integer","format":"int32"},"preferenceTypeId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"activitiesStartDate":{"type":"string","format":"date"},"activitiesEndDate":{"type":"string","format":"date"},"activitiesDefaultStartTime":{"type":"string","format":"partial-time","nullable":true},"activitiesDefaultEndTime":{"type":"string","format":"partial-time","nullable":true},"responsibilityForConfirmation":{"$ref":"#/components/schemas/CcaSignupResponsibility"},"signupOpens":{"type":"string","format":"date-time","nullable":true},"signupCloses":{"type":"string","format":"date-time","nullable":true},"useOrganisationBlockDates":{"type":"boolean","nullable":true},"termsAndConditions":{"type":"string","nullable":true},"additionalInfoUrl":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"timeZone":{"type":"string","nullable":true},"createdAtUtc":{"type":"string","format":"date-time","nullable":true},"updatedAtUtc":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"CcaSignupResponsibility":{"enum":["None","PupilsOrParents","ParentsOnly","PupilsOnly"],"type":"string"}}}}
```

## The IbpResponseDtoListPagedIbpFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"IbpResponseDtoListPagedIbpFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/IbpResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"IbpResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"containerTypeId":{"type":"integer","format":"int32"},"preferenceTypeId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"activitiesStartDate":{"type":"string","format":"date"},"activitiesEndDate":{"type":"string","format":"date"},"activitiesDefaultStartTime":{"type":"string","format":"partial-time","nullable":true},"activitiesDefaultEndTime":{"type":"string","format":"partial-time","nullable":true},"responsibilityForConfirmation":{"$ref":"#/components/schemas/CcaSignupResponsibility"},"signupOpens":{"type":"string","format":"date-time","nullable":true},"signupCloses":{"type":"string","format":"date-time","nullable":true},"useOrganisationBlockDates":{"type":"boolean","nullable":true},"termsAndConditions":{"type":"string","nullable":true},"additionalInfoUrl":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"timeZone":{"type":"string","nullable":true},"createdAtUtc":{"type":"string","format":"date-time","nullable":true},"updatedAtUtc":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"CcaSignupResponsibility":{"enum":["None","PupilsOrParents","ParentsOnly","PupilsOnly"],"type":"string"},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The Int32BulkOperationResult object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"Int32BulkOperationResult":{"type":"object","properties":{"successfulIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Gets or sets the ids of the items that were processed successfully.\r\nOn BulkCreate these are the newly-created ids.","nullable":true},"failedItems":{"type":"array","items":{"$ref":"#/components/schemas/BulkFailedItem"},"description":"Gets or sets the per-item failures, each carrying its request index,\r\noptional client reference, name, machine-readable code, and message.","nullable":true},"totalRequested":{"type":"integer","description":"Gets or sets the total number of items in the request. Set by the\r\ncaller (it is not derivable from the success/failure lists alone —\r\nitems rejected before per-item processing may appear in neither).","format":"int32"},"totalSuccessful":{"type":"integer","description":"Gets the number of items processed successfully (computed).","format":"int32","readOnly":true},"totalFailed":{"type":"integer","description":"Gets the number of items that failed (computed).","format":"int32","readOnly":true}},"additionalProperties":false,"description":"Standard envelope returned by every Public API bulk endpoint\r\n(BulkCreate / BulkUpdate / BulkArchive). Each item in the request is\r\nprocessed independently — one item failing does not roll back the\r\nothers — and the envelope reports per-item outcome. See\r\ncross-cutting-design.md §4."},"BulkFailedItem":{"type":"object","properties":{"index":{"type":"integer","description":"Gets or sets the zero-based index of the failed item within the\r\nrequest array, so callers keeping request order can map it back.","format":"int32"},"clientReferenceId":{"type":"string","description":"Gets or sets the optional opaque client-supplied reference echoed\r\nback from the request item. Null when the caller did not supply one.","nullable":true},"name":{"type":"string","description":"Gets or sets the name of the entity the failed item referred to,\r\nfor at-a-glance identification in the response.","nullable":true},"code":{"type":"string","description":"Gets or sets the machine-readable error code (e.g.\r\n`VALIDATION_FAILED`, `GROUP_IMPORTED_READ_ONLY`) per\r\ncross-cutting-design.md §5.1.","nullable":true},"error":{"type":"string","description":"Gets or sets the human-readable error message.","nullable":true}},"additionalProperties":false,"description":"A single per-item failure entry in a SchoolsBuddy.PublicAPI.Models.BulkOperationResult`1\r\nenvelope. Mirrors the structured error body (cross-cutting-design.md §5.3):\r\na machine-readable SchoolsBuddy.PublicAPI.Models.BulkFailedItem.Code plus a human-readable SchoolsBuddy.PublicAPI.Models.BulkFailedItem.Error."}}}}
```

## The IsamsConfigPatchRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"IsamsConfigPatchRequestDto":{"type":"object","properties":{"importEnabled":{"type":"boolean","nullable":true},"url":{"type":"string","nullable":true},"parentContactTypes":{"type":"array","items":{"type":"string"},"nullable":true},"importFlags":{"$ref":"#/components/schemas/IsamsImportFlagsPatchDto"}},"additionalProperties":false},"IsamsImportFlagsPatchDto":{"type":"object","properties":{"allMergesCorrespondenceOnly":{"type":"boolean","nullable":true},"billingOrAllMergesOnly":{"type":"boolean","nullable":true},"ignoreForms":{"type":"boolean","nullable":true},"ignoreHouses":{"type":"boolean","nullable":true},"ignoreSubjects":{"type":"boolean","nullable":true},"ignoreYears":{"type":"boolean","nullable":true},"parentalResponsibilityOnly":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The IsamsConfigResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"IsamsConfigResponseDto":{"type":"object","properties":{"orgId":{"type":"string","nullable":true},"importEnabled":{"type":"boolean"},"url":{"type":"string","nullable":true},"parentContactTypes":{"type":"array","items":{"type":"string"},"nullable":true},"importFlags":{"$ref":"#/components/schemas/IsamsImportFlagsDto"}},"additionalProperties":false},"IsamsImportFlagsDto":{"type":"object","properties":{"allMergesCorrespondenceOnly":{"type":"boolean"},"billingOrAllMergesOnly":{"type":"boolean"},"ignoreForms":{"type":"boolean"},"ignoreHouses":{"type":"boolean"},"ignoreSubjects":{"type":"boolean"},"ignoreYears":{"type":"boolean"},"parentalResponsibilityOnly":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The IsamsImportFlagsDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"IsamsImportFlagsDto":{"type":"object","properties":{"allMergesCorrespondenceOnly":{"type":"boolean"},"billingOrAllMergesOnly":{"type":"boolean"},"ignoreForms":{"type":"boolean"},"ignoreHouses":{"type":"boolean"},"ignoreSubjects":{"type":"boolean"},"ignoreYears":{"type":"boolean"},"parentalResponsibilityOnly":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The IsamsImportFlagsPatchDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"IsamsImportFlagsPatchDto":{"type":"object","properties":{"allMergesCorrespondenceOnly":{"type":"boolean","nullable":true},"billingOrAllMergesOnly":{"type":"boolean","nullable":true},"ignoreForms":{"type":"boolean","nullable":true},"ignoreHouses":{"type":"boolean","nullable":true},"ignoreSubjects":{"type":"boolean","nullable":true},"ignoreYears":{"type":"boolean","nullable":true},"parentalResponsibilityOnly":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The LocationDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"LocationDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"locationName":{"type":"string","nullable":true},"locationDescription":{"type":"string","nullable":true},"isHome":{"type":"boolean"},"locationType":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"streetAddress":{"type":"string","nullable":true},"postCode":{"type":"string","nullable":true},"telephone":{"type":"string","nullable":true},"isDeleted":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The LocationDtoListPagedLocationFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"LocationDtoListPagedLocationFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/LocationDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"LocationDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"locationName":{"type":"string","nullable":true},"locationDescription":{"type":"string","nullable":true},"isHome":{"type":"boolean"},"locationType":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"streetAddress":{"type":"string","nullable":true},"postCode":{"type":"string","nullable":true},"telephone":{"type":"string","nullable":true},"isDeleted":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PrefGroupResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"PrefGroupResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"groupName":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groupCode":{"type":"string","nullable":true},"billingCode":{"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean"},"locationId":{"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean"},"day1":{"$ref":"#/components/schemas/DayOfWeekType"},"day1StartTime":{"type":"string","format":"partial-time","nullable":true},"day1EndTime":{"type":"string","format":"partial-time","nullable":true},"day2":{"$ref":"#/components/schemas/DayOfWeekType"},"day2StartTime":{"type":"string","format":"partial-time","nullable":true},"day2EndTime":{"type":"string","format":"partial-time","nullable":true},"maximumPlaces":{"type":"integer","format":"int32"},"minimumPlaces":{"type":"integer","format":"int32"},"cost":{"type":"number","format":"double"},"costType":{"$ref":"#/components/schemas/CcaCostTypeEnum"},"joinRequestsOn":{"type":"boolean","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"timeZone":{"type":"string","nullable":true},"createdAtUtc":{"type":"string","format":"date-time","nullable":true},"updatedAtUtc":{"type":"string","format":"date-time"}},"additionalProperties":false},"DayOfWeekType":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"CcaCostTypeEnum":{"enum":["FreeOfCharge","PerTermOrSeason","PerSession","OneOff"],"type":"string"},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The PrefGroupResponseDtoListPagedPrefGroupFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"PrefGroupResponseDtoListPagedPrefGroupFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PrefGroupResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"PrefGroupResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"groupName":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groupCode":{"type":"string","nullable":true},"billingCode":{"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean"},"locationId":{"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean"},"day1":{"$ref":"#/components/schemas/DayOfWeekType"},"day1StartTime":{"type":"string","format":"partial-time","nullable":true},"day1EndTime":{"type":"string","format":"partial-time","nullable":true},"day2":{"$ref":"#/components/schemas/DayOfWeekType"},"day2StartTime":{"type":"string","format":"partial-time","nullable":true},"day2EndTime":{"type":"string","format":"partial-time","nullable":true},"maximumPlaces":{"type":"integer","format":"int32"},"minimumPlaces":{"type":"integer","format":"int32"},"cost":{"type":"number","format":"double"},"costType":{"$ref":"#/components/schemas/CcaCostTypeEnum"},"joinRequestsOn":{"type":"boolean","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"type":"string","nullable":true},"shortName":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"timeZone":{"type":"string","nullable":true},"createdAtUtc":{"type":"string","format":"date-time","nullable":true},"updatedAtUtc":{"type":"string","format":"date-time"}},"additionalProperties":false},"DayOfWeekType":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"CcaCostTypeEnum":{"enum":["FreeOfCharge","PerTermOrSeason","PerSession","OneOff"],"type":"string"},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PrefResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"PrefResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"containerTypeId":{"type":"integer","format":"int32"},"preferenceTypeId":{"type":"integer","format":"int32"},"preferenceSelectionScope":{"$ref":"#/components/schemas/PreferenceSelectionScopeEnum"},"eventCategoryId":{"type":"integer","format":"int32","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"activitiesStartDate":{"type":"string","format":"date"},"activitiesEndDate":{"type":"string","format":"date"},"activitiesDefaultStartTime":{"type":"string","format":"partial-time","nullable":true},"activitiesDefaultEndTime":{"type":"string","format":"partial-time","nullable":true},"responsibilityForConfirmation":{"$ref":"#/components/schemas/CcaSignupResponsibility"},"signupOpens":{"type":"string","format":"date-time","nullable":true},"signupCloses":{"type":"string","format":"date-time","nullable":true},"useOrganisationBlockDates":{"type":"boolean","nullable":true},"termsAndConditions":{"type":"string","nullable":true},"additionalInfoUrl":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"timeZone":{"type":"string","nullable":true},"createdAtUtc":{"type":"string","format":"date-time","nullable":true},"updatedAtUtc":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"PreferenceSelectionScopeEnum":{"enum":["Daily","Weekly"],"type":"string"},"CcaSignupResponsibility":{"enum":["None","PupilsOrParents","ParentsOnly","PupilsOnly"],"type":"string"}}}}
```

## The PrefResponseDtoListPagedPrefFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"PrefResponseDtoListPagedPrefFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PrefResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"PrefResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"containerTypeId":{"type":"integer","format":"int32"},"preferenceTypeId":{"type":"integer","format":"int32"},"preferenceSelectionScope":{"$ref":"#/components/schemas/PreferenceSelectionScopeEnum"},"eventCategoryId":{"type":"integer","format":"int32","nullable":true},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"activitiesStartDate":{"type":"string","format":"date"},"activitiesEndDate":{"type":"string","format":"date"},"activitiesDefaultStartTime":{"type":"string","format":"partial-time","nullable":true},"activitiesDefaultEndTime":{"type":"string","format":"partial-time","nullable":true},"responsibilityForConfirmation":{"$ref":"#/components/schemas/CcaSignupResponsibility"},"signupOpens":{"type":"string","format":"date-time","nullable":true},"signupCloses":{"type":"string","format":"date-time","nullable":true},"useOrganisationBlockDates":{"type":"boolean","nullable":true},"termsAndConditions":{"type":"string","nullable":true},"additionalInfoUrl":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"timeZone":{"type":"string","nullable":true},"createdAtUtc":{"type":"string","format":"date-time","nullable":true},"updatedAtUtc":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false},"PreferenceSelectionScopeEnum":{"enum":["Daily","Weekly"],"type":"string"},"CcaSignupResponsibility":{"enum":["None","PupilsOrParents","ParentsOnly","PupilsOnly"],"type":"string"},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The PreferenceSelectionScopeEnum object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"PreferenceSelectionScopeEnum":{"enum":["Daily","Weekly"],"type":"string"}}}}
```

## The ProblemDetails object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## The PublicApiOrganisationRole object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"PublicApiOrganisationRole":{"enum":["Staff","ExternalCoach","BusMonitor"],"type":"string"}}}}
```

## The PublicBusStopResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"PublicBusStopResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"stopName":{"type":"string","nullable":true},"streetAddress":{"type":"string","nullable":true},"streetAddress2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"county":{"type":"string","nullable":true},"postcode":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"isDeleted":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The PublicEventResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"PublicEventResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"isSeries":{"type":"boolean"},"parentEventId":{"type":"integer","format":"int32","nullable":true},"allowJoiningPartWayThrough":{"type":"boolean"},"eventName":{"type":"string","nullable":true},"opponent":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"vitalInformation":{"type":"string","nullable":true},"groupId":{"type":"integer","format":"int32"},"clubId":{"type":"integer","format":"int32","nullable":true},"ccaSignUpId":{"type":"integer","format":"int32","nullable":true},"eventTypeId":{"type":"integer","format":"int32","nullable":true},"eventType":{"type":"string","nullable":true},"eventStartTime":{"type":"string","format":"date-time"},"eventEndTime":{"type":"string","format":"date-time"},"leadStaffMember":{"type":"string","nullable":true},"cost":{"type":"number","format":"double"},"percentageToPayDeposit":{"type":"number","format":"double","nullable":true},"alwaysChargeFullPrice":{"type":"boolean"},"includesTax":{"type":"boolean"},"paymentDueDate":{"type":"string","format":"date","nullable":true},"location":{"type":"string","nullable":true},"meetingLocation":{"type":"string","nullable":true},"meetingTime":{"type":"string","format":"date-time","nullable":true},"pickupLocation":{"type":"string","nullable":true},"pickupTime":{"type":"string","format":"date-time","nullable":true},"numberOfPlaces":{"type":"integer","format":"int32","nullable":true},"consentRequired":{"type":"boolean"},"consentDueDate":{"type":"string","format":"date-time","nullable":true},"consentMessage":{"type":"string","nullable":true},"termsAndConditions":{"type":"string","nullable":true},"orgId":{"type":"integer","format":"int32"},"isBlocked":{"type":"boolean"},"isCancelled":{"type":"boolean"},"isArchived":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"timeZone":{"type":"string","nullable":true},"attendees":{"type":"array","items":{"$ref":"#/components/schemas/EventAttendanceDto"},"nullable":true}},"additionalProperties":false},"EventAttendanceDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"calendarEventId":{"type":"integer","format":"int32"},"registerStatus":{"$ref":"#/components/schemas/AttendeeRegisterStateEnum"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"registerUpdatedAt":{"type":"string","format":"date-time","nullable":true},"registerUpdatedBy":{"type":"integer","format":"int32","nullable":true},"registerUpdatedByName":{"type":"string","nullable":true},"attendanceNote":{"type":"string","nullable":true}},"additionalProperties":false},"AttendeeRegisterStateEnum":{"enum":["Unset","Present","Absent","Late","Excused"],"type":"string"}}}}
```

## The PublicEventResponseDtoListPagedPublicEventsSearchResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"PublicEventResponseDtoListPagedPublicEventsSearchResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/PublicEventResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"PublicEventResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"isSeries":{"type":"boolean"},"parentEventId":{"type":"integer","format":"int32","nullable":true},"allowJoiningPartWayThrough":{"type":"boolean"},"eventName":{"type":"string","nullable":true},"opponent":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"vitalInformation":{"type":"string","nullable":true},"groupId":{"type":"integer","format":"int32"},"clubId":{"type":"integer","format":"int32","nullable":true},"ccaSignUpId":{"type":"integer","format":"int32","nullable":true},"eventTypeId":{"type":"integer","format":"int32","nullable":true},"eventType":{"type":"string","nullable":true},"eventStartTime":{"type":"string","format":"date-time"},"eventEndTime":{"type":"string","format":"date-time"},"leadStaffMember":{"type":"string","nullable":true},"cost":{"type":"number","format":"double"},"percentageToPayDeposit":{"type":"number","format":"double","nullable":true},"alwaysChargeFullPrice":{"type":"boolean"},"includesTax":{"type":"boolean"},"paymentDueDate":{"type":"string","format":"date","nullable":true},"location":{"type":"string","nullable":true},"meetingLocation":{"type":"string","nullable":true},"meetingTime":{"type":"string","format":"date-time","nullable":true},"pickupLocation":{"type":"string","nullable":true},"pickupTime":{"type":"string","format":"date-time","nullable":true},"numberOfPlaces":{"type":"integer","format":"int32","nullable":true},"consentRequired":{"type":"boolean"},"consentDueDate":{"type":"string","format":"date-time","nullable":true},"consentMessage":{"type":"string","nullable":true},"termsAndConditions":{"type":"string","nullable":true},"orgId":{"type":"integer","format":"int32"},"isBlocked":{"type":"boolean"},"isCancelled":{"type":"boolean"},"isArchived":{"type":"boolean"},"updatedAt":{"type":"string","format":"date-time","nullable":true},"timeZone":{"type":"string","nullable":true},"attendees":{"type":"array","items":{"$ref":"#/components/schemas/EventAttendanceDto"},"nullable":true}},"additionalProperties":false},"EventAttendanceDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"calendarEventId":{"type":"integer","format":"int32"},"registerStatus":{"$ref":"#/components/schemas/AttendeeRegisterStateEnum"},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"registerUpdatedAt":{"type":"string","format":"date-time","nullable":true},"registerUpdatedBy":{"type":"integer","format":"int32","nullable":true},"registerUpdatedByName":{"type":"string","nullable":true},"attendanceNote":{"type":"string","nullable":true}},"additionalProperties":false},"AttendeeRegisterStateEnum":{"enum":["Unset","Present","Absent","Late","Excused"],"type":"string"},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The RequirementGroupType object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"RequirementGroupType":{"enum":["Group","Club","SubjectClass"],"type":"string"}}}}
```

## The RequirementType object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"RequirementType":{"enum":["AvailableTo","PreRequisite","NotAvailableTo"],"type":"string"}}}}
```

## The StaffBulkArchiveRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StaffBulkArchiveRequestDto":{"required":["ids"],"type":"object","properties":{"archive":{"type":"boolean"},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"}}},"additionalProperties":false}}}}
```

## The StaffCoreDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StaffCoreDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32","nullable":true},"organisationId":{"type":"integer","format":"int32","nullable":true},"staffId":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"role":{"$ref":"#/components/schemas/PublicApiOrganisationRole"},"onlineMeetingId":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"mobilePhone":{"type":"string","nullable":true},"phoneNumber":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"updatable":{"type":"boolean"}},"additionalProperties":false},"PublicApiOrganisationRole":{"enum":["Staff","ExternalCoach","BusMonitor"],"type":"string"}}}}
```

## The StaffCreateRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StaffCreateRequestDto":{"type":"object","properties":{"staffId":{"maxLength":50,"type":"string","nullable":true},"title":{"maxLength":10,"type":"string","nullable":true},"lastName":{"maxLength":50,"type":"string","nullable":true},"firstName":{"maxLength":50,"type":"string","nullable":true},"email":{"maxLength":250,"type":"string","nullable":true},"onlineMeetingId":{"maxLength":250,"type":"string","nullable":true},"isArchived":{"maximum":1,"minimum":0,"type":"boolean"},"mobilePhone":{"maxLength":250,"type":"string","nullable":true},"phoneNumber":{"maxLength":250,"type":"string","nullable":true},"updateable":{"type":"boolean"},"role":{"$ref":"#/components/schemas/PublicApiOrganisationRole"}},"additionalProperties":false},"PublicApiOrganisationRole":{"enum":["Staff","ExternalCoach","BusMonitor"],"type":"string"}}}}
```

## The StaffDataDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StaffDataDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32","nullable":true},"staffId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"role":{"$ref":"#/components/schemas/PublicApiOrganisationRole"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isArchived":{"type":"boolean"},"updatable":{"type":"boolean"}},"additionalProperties":false},"PublicApiOrganisationRole":{"enum":["Staff","ExternalCoach","BusMonitor"],"type":"string"}}}}
```

## The StaffDataDtoListPagedStaffFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StaffDataDtoListPagedStaffFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/StaffDataDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"StaffDataDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32","nullable":true},"staffId":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"role":{"$ref":"#/components/schemas/PublicApiOrganisationRole"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isArchived":{"type":"boolean"},"updatable":{"type":"boolean"}},"additionalProperties":false},"PublicApiOrganisationRole":{"enum":["Staff","ExternalCoach","BusMonitor"],"type":"string"},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The StaffOnlineMeetingIdItemDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StaffOnlineMeetingIdItemDto":{"required":["id","onlineMeetingId"],"type":"object","properties":{"id":{"type":"integer","format":"int32"},"onlineMeetingId":{"maxLength":250,"minLength":1,"type":"string"}},"additionalProperties":false}}}}
```

## The StaffUpdateRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StaffUpdateRequestDto":{"type":"object","properties":{"staffId":{"maxLength":50,"type":"string","nullable":true},"title":{"maxLength":10,"type":"string","nullable":true},"lastName":{"maxLength":50,"type":"string","nullable":true},"firstName":{"maxLength":50,"type":"string","nullable":true},"email":{"maxLength":250,"type":"string","nullable":true},"onlineMeetingId":{"maxLength":250,"type":"string","nullable":true},"isArchived":{"maximum":1,"minimum":0,"type":"boolean"},"mobilePhone":{"maxLength":250,"type":"string","nullable":true},"phoneNumber":{"maxLength":250,"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The StringStringKeyValuePair object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The StudentBulkArchiveRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StudentBulkArchiveRequestDto":{"required":["ids"],"type":"object","properties":{"archive":{"type":"boolean"},"ids":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"}}},"additionalProperties":false}}}}
```

## The StudentCoreDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StudentCoreDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32","nullable":true},"studentId":{"type":"string","nullable":true},"studentDisplayId":{"type":"string","nullable":true},"qrCode":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"otherName":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date","nullable":true},"house":{"type":"string","nullable":true},"grade":{"type":"string","nullable":true},"homeroomClass":{"type":"string","nullable":true},"homeroomAdvisorId":{"type":"integer","format":"int32","nullable":true},"homeroomAdvisor":{"type":"string","nullable":true},"sen":{"type":"boolean","nullable":true},"relatedPeople":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"updatable":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The StudentCreateRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StudentCreateRequestDto":{"required":["firstName","gender","grade","lastName"],"type":"object","properties":{"studentId":{"maxLength":50,"type":"string","nullable":true},"studentDisplayId":{"maxLength":200,"type":"string","nullable":true},"qrCode":{"maxLength":50,"type":"string","nullable":true},"lastName":{"maxLength":50,"minLength":1,"type":"string"},"firstName":{"maxLength":50,"minLength":1,"type":"string"},"middleName":{"maxLength":100,"type":"string","nullable":true},"gender":{"$ref":"#/components/schemas/GenderTypeEnum"},"otherName":{"maxLength":100,"type":"string","nullable":true},"email":{"maxLength":256,"type":"string","format":"email","nullable":true},"dateOfBirth":{"type":"string","format":"date","nullable":true},"house":{"maxLength":100,"type":"string","nullable":true},"grade":{"maxLength":100,"minLength":1,"type":"string"},"homeroomClass":{"maxLength":100,"type":"string","nullable":true},"sen":{"type":"boolean","nullable":true}},"additionalProperties":false},"GenderTypeEnum":{"enum":["Female","Male","Unspecified"],"type":"string"}}}}
```

## The StudentHealthResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StudentHealthResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true}},"additionalProperties":false}}}}
```

## The StudentHealthUpdateRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StudentHealthUpdateRequestDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"description":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The StudentPublicDataDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StudentPublicDataDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"studentId":{"type":"string","nullable":true},"studentDisplayId":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"otherName":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date","nullable":true},"email":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"house":{"type":"string","nullable":true},"grade":{"type":"string","nullable":true},"homeroomClass":{"type":"string","nullable":true},"homeroomAdvisorId":{"type":"integer","format":"int32","nullable":true},"homeroomAdvisor":{"type":"string","nullable":true},"relatedPeople":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"isArchived":{"type":"boolean"},"updatable":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The StudentPublicDataDtoListPagedStudentFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StudentPublicDataDtoListPagedStudentFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/StudentPublicDataDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"StudentPublicDataDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"studentId":{"type":"string","nullable":true},"studentDisplayId":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"middleName":{"type":"string","nullable":true},"otherName":{"type":"string","nullable":true},"dateOfBirth":{"type":"string","format":"date","nullable":true},"email":{"type":"string","nullable":true},"gender":{"type":"string","nullable":true},"house":{"type":"string","nullable":true},"grade":{"type":"string","nullable":true},"homeroomClass":{"type":"string","nullable":true},"homeroomAdvisorId":{"type":"integer","format":"int32","nullable":true},"homeroomAdvisor":{"type":"string","nullable":true},"relatedPeople":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"createdAt":{"type":"string","format":"date-time","nullable":true},"updatedAt":{"type":"string","format":"date-time","nullable":true},"isArchived":{"type":"boolean"},"updatable":{"type":"boolean"}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The StudentUpdateRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"StudentUpdateRequestDto":{"required":["firstName","gender","grade","lastName"],"type":"object","properties":{"studentId":{"maxLength":50,"type":"string","nullable":true},"studentDisplayId":{"maxLength":200,"type":"string","nullable":true},"qrCode":{"maxLength":50,"type":"string","nullable":true},"lastName":{"maxLength":50,"minLength":1,"type":"string"},"firstName":{"maxLength":50,"minLength":1,"type":"string"},"middleName":{"maxLength":100,"type":"string","nullable":true},"gender":{"$ref":"#/components/schemas/GenderTypeEnum"},"otherName":{"maxLength":100,"type":"string","nullable":true},"email":{"maxLength":256,"type":"string","format":"email","nullable":true},"dateOfBirth":{"type":"string","format":"date","nullable":true},"house":{"maxLength":100,"type":"string","nullable":true},"grade":{"maxLength":100,"minLength":1,"type":"string"},"homeroomClass":{"maxLength":100,"type":"string","nullable":true},"sen":{"type":"boolean","nullable":true},"isArchived":{"type":"boolean"}},"additionalProperties":false},"GenderTypeEnum":{"enum":["Female","Male","Unspecified"],"type":"string"}}}}
```

## The SubjectClassResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"SubjectClassResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"title":{"type":"string","nullable":true},"subjectId":{"type":"integer","format":"int32"},"schoolYearGroupId":{"type":"integer","format":"int32","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The SubjectClassResponseDtoListPagedSubjectClassFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"SubjectClassResponseDtoListPagedSubjectClassFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/SubjectClassResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"SubjectClassResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"title":{"type":"string","nullable":true},"subjectId":{"type":"integer","format":"int32"},"schoolYearGroupId":{"type":"integer","format":"int32","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The SubjectClassStudentsOperationResultDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"SubjectClassStudentsOperationResultDto":{"type":"object","properties":{"studentsProcessed":{"type":"integer","format":"int32"},"totalRequested":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```

## The SubjectClassStudentsRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"SubjectClassStudentsRequestDto":{"required":["studentIds"],"type":"object","properties":{"studentIds":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"}}},"additionalProperties":false}}}}
```

## The SubjectResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"SubjectResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The SubjectResponseDtoListPagedSubjectFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"SubjectResponseDtoListPagedSubjectFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/SubjectResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"SubjectResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The TeamGenderType object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The TeamTypeFilter object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"TeamTypeFilter":{"enum":["Group","Homeroom","SubjectClass","Grade","House"],"type":"string"}}}}
```

## The UpdateClassRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"UpdateClassRequestDto":{"type":"object","properties":{"name":{"maxLength":240,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The UpdateGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"UpdateGroupRequestDto":{"type":"object","properties":{"name":{"maxLength":240,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"taxCode":{"maxLength":10,"type":"string","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"isArchived":{"type":"boolean","nullable":true}},"additionalProperties":false},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The UpdateHouseRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"UpdateHouseRequestDto":{"type":"object","properties":{"name":{"maxLength":240,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"staffIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true},"isArchived":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The UpdateIbpGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"UpdateIbpGroupRequestDto":{"type":"object","properties":{"groupName":{"maxLength":255,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true}},"additionalProperties":false},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The UpdateIbpRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"UpdateIbpRequestDto":{"type":"object","properties":{"name":{"maxLength":255,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"activitiesStartDate":{"type":"string","format":"date","nullable":true},"activitiesEndDate":{"type":"string","format":"date","nullable":true},"activitiesDefaultStartTime":{"type":"string","format":"partial-time","nullable":true},"activitiesDefaultEndTime":{"type":"string","format":"partial-time","nullable":true},"responsibilityForConfirmation":{"$ref":"#/components/schemas/CcaSignupResponsibility"},"signupOpens":{"type":"string","format":"date-time","nullable":true},"signupCloses":{"type":"string","format":"date-time","nullable":true},"termsAndConditions":{"type":"string","nullable":true},"additionalInfoUrl":{"type":"string","nullable":true}},"additionalProperties":false},"CcaSignupResponsibility":{"enum":["None","PupilsOrParents","ParentsOnly","PupilsOnly"],"type":"string"}}}}
```

## The UpdatePrefGroupRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"UpdatePrefGroupRequestDto":{"type":"object","properties":{"groupName":{"maxLength":255,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"groupCode":{"maxLength":50,"type":"string","nullable":true},"billingCode":{"maxLength":50,"type":"string","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"activityId":{"type":"integer","format":"int32","nullable":true},"showInSportsPortal":{"type":"boolean","nullable":true},"locationId":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"informationOnly":{"type":"boolean","nullable":true},"day1":{"$ref":"#/components/schemas/DayOfWeekType"},"day1StartTime":{"type":"string","format":"partial-time","nullable":true},"day1EndTime":{"type":"string","format":"partial-time","nullable":true},"day2":{"$ref":"#/components/schemas/DayOfWeekType"},"day2StartTime":{"type":"string","format":"partial-time","nullable":true},"day2EndTime":{"type":"string","format":"partial-time","nullable":true},"maximumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"minimumPlaces":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32","nullable":true},"cost":{"type":"number","format":"double","nullable":true},"joinRequestsOn":{"type":"boolean","nullable":true},"availableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"preRequisite":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"notAvailableTo":{"type":"array","items":{"$ref":"#/components/schemas/CcaGroupReferenceDto"},"nullable":true},"genderAvailableTo":{"$ref":"#/components/schemas/TeamGenderType"},"taxCode":{"maxLength":10,"type":"string","nullable":true},"shortName":{"maxLength":30,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true}},"additionalProperties":false},"DayOfWeekType":{"enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"type":"string"},"CcaGroupReferenceDto":{"required":["type"],"type":"object","properties":{"id":{"maximum":2147483647,"minimum":0,"type":"integer","format":"int32"},"type":{"$ref":"#/components/schemas/CcaGroupReferenceType"}},"additionalProperties":false},"CcaGroupReferenceType":{"enum":["Group","Class","House","Year","SubjectClass"],"type":"string"},"TeamGenderType":{"enum":["Female","Male","Mixed"],"type":"string"}}}}
```

## The UpdatePrefRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"UpdatePrefRequestDto":{"type":"object","properties":{"name":{"maxLength":255,"type":"string","nullable":true},"description":{"type":"string","nullable":true},"preferenceSelectionScope":{"$ref":"#/components/schemas/PreferenceSelectionScopeEnum"},"eventCategoryId":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32","nullable":true},"activitiesStartDate":{"type":"string","format":"date","nullable":true},"activitiesEndDate":{"type":"string","format":"date","nullable":true},"activitiesDefaultStartTime":{"type":"string","format":"partial-time","nullable":true},"activitiesDefaultEndTime":{"type":"string","format":"partial-time","nullable":true},"responsibilityForConfirmation":{"$ref":"#/components/schemas/CcaSignupResponsibility"},"signupOpens":{"type":"string","format":"date-time","nullable":true},"signupCloses":{"type":"string","format":"date-time","nullable":true},"termsAndConditions":{"type":"string","nullable":true},"additionalInfoUrl":{"type":"string","nullable":true}},"additionalProperties":false},"PreferenceSelectionScopeEnum":{"enum":["Daily","Weekly"],"type":"string"},"CcaSignupResponsibility":{"enum":["None","PupilsOrParents","ParentsOnly","PupilsOnly"],"type":"string"}}}}
```

## The UpdateSubjectClassRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"UpdateSubjectClassRequestDto":{"type":"object","properties":{"title":{"maxLength":250,"type":"string","nullable":true},"subjectId":{"type":"integer","format":"int32","nullable":true},"schoolYearGroupId":{"type":"integer","format":"int32","nullable":true},"leadStaffId":{"type":"integer","format":"int32","nullable":true},"isArchived":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The UpdateSubjectRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"UpdateSubjectRequestDto":{"type":"object","properties":{"name":{"maxLength":200,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The UpdateYearRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"UpdateYearRequestDto":{"type":"object","properties":{"name":{"maxLength":150,"type":"string","nullable":true},"isArchived":{"type":"boolean","nullable":true}},"additionalProperties":false}}}}
```

## The YearResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"YearResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"schoolYearGroupId":{"type":"integer","format":"int32"},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The YearResponseDtoListPagedYearFilterResponseDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"YearResponseDtoListPagedYearFilterResponseDto":{"type":"object","properties":{"isSuccess":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"},"nullable":true},"messageTranslationParameters":{"nullable":true},"data":{"type":"array","items":{"$ref":"#/components/schemas/YearResponseDto"},"nullable":true},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"firstPage":{"type":"string","format":"uri","nullable":true},"lastPage":{"type":"string","format":"uri","nullable":true},"totalPages":{"type":"integer","format":"int32"},"totalRecords":{"type":"integer","format":"int32"},"nextPage":{"type":"string","format":"uri","nullable":true},"previousPage":{"type":"string","format":"uri","nullable":true},"baseUri":{"type":"string","format":"uri","nullable":true},"searchParameters":{"type":"array","items":{"$ref":"#/components/schemas/StringStringKeyValuePair"},"nullable":true}},"additionalProperties":false},"YearResponseDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organisationId":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"schoolYearGroupId":{"type":"integer","format":"int32"},"isArchived":{"type":"boolean"},"createdAtUtc":{"type":"string","format":"date-time"},"updatedAtUtc":{"type":"string","format":"date-time"},"thirdPartyId":{"type":"string","nullable":true},"isImported":{"type":"boolean"}},"additionalProperties":false},"StringStringKeyValuePair":{"type":"object","properties":{"key":{"type":"string","nullable":true},"value":{"type":"string","nullable":true}},"additionalProperties":false}}}}
```

## The YearStudentsOperationResultDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"YearStudentsOperationResultDto":{"type":"object","properties":{"studentsProcessed":{"type":"integer","format":"int32"},"totalRequested":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}
```

## The YearStudentsRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"components":{"schemas":{"YearStudentsRequestDto":{"required":["studentIds"],"type":"object","properties":{"studentIds":{"minItems":1,"type":"array","items":{"type":"integer","format":"int32"}}},"additionalProperties":false}}}}
```