Locations

Gets a paginated list of locations

get

/api/v1/Locations

Authorizations

AuthorizationstringRequired

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

Query parameters

IncludeArchivedbooleanOptional

Searchstring · max: 200Optional

IsHomebooleanOptional

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

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

OrganisationIdsinteger · int32[]Optional

Responses

200

OK

application/json

400

Bad Request

application/json

Structured body for 4xx / 5xx responses on the new Public API surface: a machine-readable SchoolsBuddy.PublicAPI.Models.ErrorResponse.Code plus a human-readable SchoolsBuddy.PublicAPI.Models.ErrorResponse.Error. See cross-cutting-design.md §5.3. This is additive — existing endpoints continue returning their legacy plain-string / ModelState shapes until migrated by their per-controller ticket.

codestring · nullableOptional

Gets or sets the machine-readable error code (e.g. VALIDATION_FAILED, RESOURCE_NOT_FOUND, INTERNAL_ERROR) per cross-cutting-design.md §5.1.

errorstring · nullableOptional

Gets or sets the human-readable error message.

404

Not Found

application/json

500

Internal Server Error

application/json

get/api/v1/Locations

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

{
  "code": "text",
  "error": "text"
}

Creates a new location

post

/api/v1/Locations

Authorizations

AuthorizationstringRequired

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

Query parameters

organisationIdinteger · int32Optional

The organisation to create the location in (cross-cutting-design §3.8.1 — the Public API's single-resource write convention). Optional for a single-organisation client. The legacy organisationId request-body field is still honoured for existing callers; when both are supplied they must agree.

Body

organisationIdinteger · int32 · nullableOptional

locationNamestring · min: 1 · max: 100Required

locationDescriptionstring · nullableOptional

isHomebooleanOptional

locationTypeIdinteger · int32Optional

citystring · max: 100 · nullableOptional

statestring · max: 100 · nullableOptional

postCodestring · max: 20 · nullableOptional

telephonestring · max: 50 · nullableOptional

streetAddressstring · max: 200 · nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

Structured body for 4xx / 5xx responses on the new Public API surface: a machine-readable SchoolsBuddy.PublicAPI.Models.ErrorResponse.Code plus a human-readable SchoolsBuddy.PublicAPI.Models.ErrorResponse.Error. See cross-cutting-design.md §5.3. This is additive — existing endpoints continue returning their legacy plain-string / ModelState shapes until migrated by their per-controller ticket.

codestring · nullableOptional

Gets or sets the machine-readable error code (e.g. VALIDATION_FAILED, RESOURCE_NOT_FOUND, INTERNAL_ERROR) per cross-cutting-design.md §5.1.

errorstring · nullableOptional

Gets or sets the human-readable error message.

404

Not Found

application/json

500

Internal Server Error

application/json

post/api/v1/Locations

POST /api/v1/Locations HTTP/1.1
Host: publicapi-eu.schoolsbuddy.net
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 193

{
  "organisationId": 1,
  "locationName": "text",
  "locationDescription": "text",
  "isHome": true,
  "locationTypeId": 1,
  "city": "text",
  "state": "text",
  "postCode": "text",
  "telephone": "text",
  "streetAddress": "text"
}

{
  "code": "text",
  "error": "text"
}