DOdomain
Schools

Retrieve the details of a school by Id

Domain School Ids can be obtained from the search by location endpoint.

get/v2/schools/{id}

Request

  • Base URL
    https://api.domain.com.au
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://auth.domain.com.au/v1/connect/authorize
      Client credentials
      Token URLhttps://auth.domain.com.au/v1/connect/token
      Scopesapi_locations_read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

School id

Response

Schools data returned

schoolSector'Catholic' | 'Government' | 'Independent' nullable

Gets or Sets SchoolSector

schoolType'Combined' | 'Primary' | 'Secondary' | 'Special' nullable

Gets or Sets SchoolType

gender'Boys' | 'Girls' | 'CoEd' nullable

Gets or Sets Gender

namestring nullable

Gets or Sets Name

suburbstring nullable

Gets or Sets Suburb

statestring nullable

Gets or Sets State

postcodestring nullable

Gets or Sets Postcode

centroidstring nullable

Gets or Sets Centroid

domainIdinteger nullable

Gets or Sets DomainId

Changes