> 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/ibp.md).

# Ibp

## GET /api/v1/CcaSignUp/IBP

> Gets a paginated list of Instant Book & Pay signups for the
> \
> calling organisation(s), sorted by id. Archived signups are added
> \
> when includeArchived is true; search filters on the signup name.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"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},"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."}}},"paths":{"/api/v1/CcaSignUp/IBP":{"get":{"tags":["Ibp"],"summary":"Gets a paginated list of Instant Book & Pay signups for the\r\ncalling organisation(s), sorted by id. Archived signups are added\r\nwhen includeArchived is true; search filters on the signup name.","parameters":[{"name":"IncludeArchived","in":"query","schema":{"type":"boolean"}},{"name":"Search","in":"query","schema":{"type":"string"}},{"name":"PageNumber","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"PageSize","in":"query","schema":{"maximum":2000,"minimum":1,"type":"integer","format":"int32"}},{"name":"OrganisationIds","in":"query","schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbpResponseDtoListPagedIbpFilterResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /api/v1/CcaSignUp/IBP

> Creates an Instant Book & Pay signup. The container type is
> \
> derived from the URL (the server always creates Instant Book &
> \
> Pay rows) and the preference type is server-set; the signup always
> \
> starts unarchived. The name must be unique among the
> \
> organisation's active signups.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"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"},"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},"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."}}},"paths":{"/api/v1/CcaSignUp/IBP":{"post":{"tags":["Ibp"],"summary":"Creates an Instant Book & Pay signup. The container type is\r\nderived from the URL (the server always creates Instant Book &\r\nPay rows) and the preference type is server-set; the signup always\r\nstarts unarchived. The name must be unique among the\r\norganisation's active signups.","parameters":[{"name":"organisationId","in":"query","description":"The organisation to create the signup in — required when the client has access to multiple organisations","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The create request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIbpRequestDto"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbpResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## GET /api/v1/CcaSignUp/IBP/{id}

> Gets a single Instant Book & Pay signup by id. Archived signups
> \
> — and signups of any other container type (Preference, PTC) —
> \
> return 404 CCASIGNUP\_NOT\_FOUND.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"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"},"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."}}},"paths":{"/api/v1/CcaSignUp/IBP/{id}":{"get":{"tags":["Ibp"],"summary":"Gets a single Instant Book & Pay signup by id. Archived signups\r\n— and signups of any other container type (Preference, PTC) —\r\nreturn 404 CCASIGNUP_NOT_FOUND.","parameters":[{"name":"id","in":"path","description":"The signup id (CcaSignUp.CcaSignUpId)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"organisationId","in":"query","description":"The organisation to look the signup up in — required when the client has access to multiple organisations","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbpResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## PUT /api/v1/CcaSignUp/IBP/{id}

> Partially updates an Instant Book & Pay signup — omitted fields
> \
> preserve their existing values (§3.7e). The URL {id} is the
> \
> canonical identifier; the body carries no id. The signup's archive
> \
> state cannot be changed here: it follows its groups — archiving
> \
> the last live group archives the signup, unarchiving any group
> \
> re-activates it. Any write against an archived signup returns
> \
> 409 RESOURCE\_ARCHIVED.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"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"},"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},"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."}}},"paths":{"/api/v1/CcaSignUp/IBP/{id}":{"put":{"tags":["Ibp"],"summary":"Partially updates an Instant Book & Pay signup — omitted fields\r\npreserve their existing values (§3.7e). The URL {id} is the\r\ncanonical identifier; the body carries no id. The signup's archive\r\nstate cannot be changed here: it follows its groups — archiving\r\nthe last live group archives the signup, unarchiving any group\r\nre-activates it. Any write against an archived signup returns\r\n409 RESOURCE_ARCHIVED.","parameters":[{"name":"id","in":"path","description":"The signup id (CcaSignUp.CcaSignUpId)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"organisationId","in":"query","description":"The organisation the signup belongs to — required when the client has access to multiple organisations","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The update request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIbpRequestDto"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbpResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## GET /api/v1/CcaSignUp/IBP/{id}/groups

> Gets a paginated list of an Instant Book & Pay signup's child
> \
> groups, sorted by id. Archived groups are added when
> \
> includeArchived is true. The sub-resource list has no search
> \
> parameter (locked 2026-06-23). The parent may be archived — its
> \
> groups stay listable so callers can find the ids to unarchive.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"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},"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."}}},"paths":{"/api/v1/CcaSignUp/IBP/{id}/groups":{"get":{"tags":["Ibp"],"summary":"Gets a paginated list of an Instant Book & Pay signup's child\r\ngroups, sorted by id. Archived groups are added when\r\nincludeArchived is true. The sub-resource list has no search\r\nparameter (locked 2026-06-23). The parent may be archived — its\r\ngroups stay listable so callers can find the ids to unarchive.","parameters":[{"name":"id","in":"path","description":"The parent signup id (CcaSignUp.CcaSignUpId)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"IncludeArchived","in":"query","schema":{"type":"boolean"}},{"name":"PageNumber","in":"query","schema":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}},{"name":"PageSize","in":"query","schema":{"maximum":2000,"minimum":1,"type":"integer","format":"int32"}},{"name":"OrganisationIds","in":"query","schema":{"type":"array","items":{"type":"integer","format":"int32"}}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbpGroupResponseDtoListPagedIbpGroupFilterResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /api/v1/CcaSignUp/IBP/{id}/groups

> Creates a child group under an Instant Book & Pay signup. The
> \
> parent signup must exist as an IBP signup (404 CCASIGNUP\_NOT\_FOUND)
> \
> and must not be archived (409 RESOURCE\_ARCHIVED — unarchive one of
> \
> its groups first, which re-activates the signup). The group always
> \
> starts unarchived. Preference-only fields (day1/day2 triples,
> \
> cost, joinRequestsOn) are not part of the IBP group shape and are
> \
> silently ignored if sent.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"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"},"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},"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."}}},"paths":{"/api/v1/CcaSignUp/IBP/{id}/groups":{"post":{"tags":["Ibp"],"summary":"Creates a child group under an Instant Book & Pay signup. The\r\nparent signup must exist as an IBP signup (404 CCASIGNUP_NOT_FOUND)\r\nand must not be archived (409 RESOURCE_ARCHIVED — unarchive one of\r\nits groups first, which re-activates the signup). The group always\r\nstarts unarchived. Preference-only fields (day1/day2 triples,\r\ncost, joinRequestsOn) are not part of the IBP group shape and are\r\nsilently ignored if sent.","parameters":[{"name":"id","in":"path","description":"The parent signup id (CcaSignUp.CcaSignUpId)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"organisationId","in":"query","description":"The organisation the signup belongs to — required when the client has access to multiple organisations","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The create request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIbpGroupRequestDto"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbpGroupResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## PUT /api/v1/CcaSignUp/IBP/{id}/groups/{groupId}

> Partially updates a child group under an Instant Book & Pay
> \
> signup — omitted fields preserve their existing values (§3.7e);
> \
> for the availableTo / preRequisite / notAvailableTo lists an
> \
> omitted field preserves the stored set while an empty array clears
> \
> it. Setting isArchived = true archives the group — rejected with
> \
> 409 CCASIGNUP\_ARCHIVE\_BLOCKED\_ACTIVE while the group has future
> \
> events; archiving the LAST live group also archives the signup.
> \
> Sending isArchived = false unarchives an archived group (EC-1 as
> \
> amended 2026-07-31, never blocked) and re-activates an archived
> \
> signup — subject to the signup's NAME\_NOT\_UNIQUE
> \
> unarchive-into-collision guard; any other write against an
> \
> archived group returns 409 RESOURCE\_ARCHIVED.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"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"},"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},"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."}}},"paths":{"/api/v1/CcaSignUp/IBP/{id}/groups/{groupId}":{"put":{"tags":["Ibp"],"summary":"Partially updates a child group under an Instant Book & Pay\r\nsignup — omitted fields preserve their existing values (§3.7e);\r\nfor the availableTo / preRequisite / notAvailableTo lists an\r\nomitted field preserves the stored set while an empty array clears\r\nit. Setting isArchived = true archives the group — rejected with\r\n409 CCASIGNUP_ARCHIVE_BLOCKED_ACTIVE while the group has future\r\nevents; archiving the LAST live group also archives the signup.\r\nSending isArchived = false unarchives an archived group (EC-1 as\r\namended 2026-07-31, never blocked) and re-activates an archived\r\nsignup — subject to the signup's NAME_NOT_UNIQUE\r\nunarchive-into-collision guard; any other write against an\r\narchived group returns 409 RESOURCE_ARCHIVED.","parameters":[{"name":"id","in":"path","description":"The parent signup id (CcaSignUp.CcaSignUpId)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"groupId","in":"path","description":"The child group id (Team.Id)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"organisationId","in":"query","description":"The organisation the signup belongs to — required when the client has access to multiple organisations","schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The update request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIbpGroupRequestDto"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbpGroupResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /api/v1/CcaSignUp/IBP/{id}/groups/BulkCreate

> Creates child groups under an Instant Book & Pay signup in
> \
> bulk. The parent signup gates the whole request (validated before
> \
> any per-item work); items are then processed independently.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"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"},"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."},"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."}}},"paths":{"/api/v1/CcaSignUp/IBP/{id}/groups/BulkCreate":{"post":{"tags":["Ibp"],"summary":"Creates child groups under an Instant Book & Pay signup in\r\nbulk. The parent signup gates the whole request (validated before\r\nany per-item work); items are then processed independently.","parameters":[{"name":"id","in":"path","description":"The parent signup id (CcaSignUp.CcaSignUpId)","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The bulk create envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateIbpGroupRequestDto"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Int32BulkOperationResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## PUT /api/v1/CcaSignUp/IBP/{id}/groups/BulkUpdate

> Partially updates child groups under an Instant Book & Pay
> \
> signup in bulk. The parent signup gates the whole request
> \
> (validated before any per-item work); each item carries the target
> \
> group id and items are processed independently. Archive semantics
> \
> per item match the single-resource PUT: isArchived = true is
> \
> gated on no future events and can archive the signup via the
> \
> last-live-group cascade; isArchived = false unarchives (EC-1 as
> \
> amended 2026-07-31) and re-activates an archived signup.

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"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"},"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."},"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."}}},"paths":{"/api/v1/CcaSignUp/IBP/{id}/groups/BulkUpdate":{"put":{"tags":["Ibp"],"summary":"Partially updates child groups under an Instant Book & Pay\r\nsignup in bulk. The parent signup gates the whole request\r\n(validated before any per-item work); each item carries the target\r\ngroup id and items are processed independently. Archive semantics\r\nper item match the single-resource PUT: isArchived = true is\r\ngated on no future events and can archive the signup via the\r\nlast-live-group cascade; isArchived = false unarchives (EC-1 as\r\namended 2026-07-31) and re-activates an archived signup.","parameters":[{"name":"id","in":"path","description":"The parent signup id (CcaSignUp.CcaSignUpId)","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The bulk update envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateIbpGroupRequestDto"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Int32BulkOperationResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /api/v1/CcaSignUp/IBP/{id}/groups/BulkArchive

> Archives or unarchives child groups under an Instant Book &
> \
> Pay signup in bulk (toggleable via the isArchived body flag).
> \
> Archiving is rejected per item (CCASIGNUP\_ARCHIVE\_BLOCKED\_ACTIVE)
> \
> while a group has future events; archiving the LAST live group
> \
> also archives the signup. Unarchiving is never blocked and
> \
> re-activates an archived signup — subject to the signup's
> \
> NAME\_NOT\_UNIQUE unarchive-into-collision guard. Alongside PUT /
> \
> BulkUpdate items carrying isArchived = false, the write verbs
> \
> allowed against already-archived groups (EC-1 as amended
> \
> 2026-07-31).

```json
{"openapi":"3.0.1","info":{"title":"SchoolsBuddy Public API","version":"1.0"},"servers":[{"url":"https://publicapi-eu.schoolsbuddy.net","description":"EMEA Public Api server"},{"url":"https://publicapi-asia.schoolsbuddy.net","description":"Asia Public Api server"},{"url":"https://publicapi-us.schoolsbuddy.net","description":"US Public Api server"},{"url":"https://publicapi.schoolsbuddy.cn","description":"China Public Api server"},{"url":"https://identity-eu.schoolsbuddy.net","description":"EMEA Identity server"},{"url":"https://identity-asia.schoolsbuddy.net","description":"Asia Identity server"},{"url":"https://identity-us.schoolsbuddy.net","description":"US Identity server"},{"url":"https://accounts.schoolsbuddy.cn","description":"China Identity server"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","description":"Type \"Bearer\" followed by a space and a token.","name":"Authorization","in":"header"}},"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)."},"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."},"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."}}},"paths":{"/api/v1/CcaSignUp/IBP/{id}/groups/BulkArchive":{"post":{"tags":["Ibp"],"summary":"Archives or unarchives child groups under an Instant Book &\r\nPay signup in bulk (toggleable via the isArchived body flag).\r\nArchiving is rejected per item (CCASIGNUP_ARCHIVE_BLOCKED_ACTIVE)\r\nwhile a group has future events; archiving the LAST live group\r\nalso archives the signup. Unarchiving is never blocked and\r\nre-activates an archived signup — subject to the signup's\r\nNAME_NOT_UNIQUE unarchive-into-collision guard. Alongside PUT /\r\nBulkUpdate items carrying isArchived = false, the write verbs\r\nallowed against already-archived groups (EC-1 as amended\r\n2026-07-31).","parameters":[{"name":"id","in":"path","description":"The parent signup id (CcaSignUp.CcaSignUpId)","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"The bulk archive envelope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkArchiveIbpGroupRequestDto"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Int32BulkOperationResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```