Domain Group Schools API

openapi: 3.2.0
info:
  title: Domain Group Schools API
  contact:
    name: Domain Developer Support
    email: api@domain.com.au
  termsOfService: https://developer.domain.com.au/docs/latest/support/terms
  version: '1.0'
  description: 'Operations tagged Schools across 2 of this provider''s published API definitions: domain-group-openapi-latest.json, domain-group-openapi-v2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.domain.com.au/
  description: Primary
- url: https://api.domain.com.au/sandbox/
  description: Sandbox
tags:
- name: Schools
paths:
  /v2/schools/{id}:
    get:
      tags:
      - Schools
      summary: Retrieve the details of a school by Id
      description: Domain School Ids can be obtained from the search by location endpoint.
      operationId: Schools_Get_ById
      parameters:
      - name: id
        in: path
        description: School id
        required: true
        schema:
          type: integer
          format: int32
        example: 1234
      responses:
        '200':
          description: Schools data returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schools.V2.School'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - apikey: []
      - oauth2:
        - api_locations_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Primary
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
  /v2/schools/{latitude}/{longitude}:
    get:
      tags:
      - Schools
      summary: Search for a school in a location
      operationId: Schools_Search_ByLocation
      parameters:
      - name: latitude
        in: path
        description: Latitude to search
        required: true
        schema:
          type: number
          format: double
        example: -33.8
      - name: longitude
        in: path
        description: Longitude to search
        required: true
        schema:
          type: number
          format: double
        example: 150.9
      responses:
        '200':
          description: Schools data returned
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Schools.V2.SchoolWithDistance'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      security:
      - apikey: []
      - oauth2:
        - api_locations_read
      x-domain-endpointcost: 1
      x-domain-usercontextrequired: false
      x-domain-environment: Primary
    servers:
    - url: https://api.domain.com.au/
      description: Primary
    - url: https://api.domain.com.au/sandbox/
      description: Sandbox
components:
  schemas:
    Schools.V2.School:
      type: object
      properties:
        schoolSector:
          enum:
          - Catholic
          - Government
          - Independent
          type:
          - string
          - 'null'
          description: Gets or Sets SchoolSector
        schoolType:
          enum:
          - Combined
          - Primary
          - Secondary
          - Special
          type:
          - string
          - 'null'
          description: Gets or Sets SchoolType
        gender:
          enum:
          - Boys
          - Girls
          - CoEd
          type:
          - string
          - 'null'
          description: Gets or Sets Gender
        name:
          type:
          - string
          - 'null'
          description: Gets or Sets Name
        suburb:
          type:
          - string
          - 'null'
          description: Gets or Sets Suburb
        state:
          type:
          - string
          - 'null'
          description: Gets or Sets State
        postcode:
          type:
          - string
          - 'null'
          description: Gets or Sets Postcode
        centroid:
          type:
          - string
          - 'null'
          description: Gets or Sets Centroid
        profile:
          $ref: '#/components/schemas/Schools.V2.SchoolProfile'
        catchments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Schools.V2.SchoolCatchment'
          description: Gets or Sets Catchments
        domainId:
          type:
          - integer
          - 'null'
          description: Gets or Sets DomainId
          format: int32
      additionalProperties: false
      description: School
      x-data-access-level-info:
        Basic:
        - DomainId
        - Name
        - Profile
        - SchoolSector
        - State
        - SchoolType
        - Suburb
        - Postcode
        - Centroid
        - Gender
        Detailed:
        - DomainId
        - Name
        - Profile
        - SchoolSector
        - State
        - SchoolType
        - Suburb
        - Postcode
        - Centroid
        - Gender
        Full:
        - DomainId
        - Name
        - Profile
        - SchoolSector
        - State
        - SchoolType
        - Suburb
        - Postcode
        - Centroid
        - Gender
        - Catchments
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
      x-data-access-level-info:
        Basic:
        - '*'
        Detailed:
        - '*'
        Full:
        - '*'
    Schools.V2.SchoolCatchment:
      type: object
      properties:
        type:
          enum:
          - Primary
          - Secondary
          type:
          - string
          - 'null'
          description: Gets or Sets Type
      additionalProperties: false
      description: SchoolCatchment
      x-data-access-level-info:
        Basic: []
        Detailed: []
        Full:
        - Type
    Schools.V2.SchoolWithDistance:
      type: object
      properties:
        distance:
          type:
          - number
          - 'null'
          description: Gets or Sets Distance
          format: double
        school:
          $ref: '#/components/schemas/Schools.V2.School'
      additionalProperties: false
      description: SchoolWithDistance
      x-data-access-level-info:
        Basic:
        - '*'
        Detailed:
        - '*'
        Full:
        - '*'
    Schools.V2.SchoolProfile:
      type: object
      properties:
        url:
          type:
          - string
          - 'null'
          description: Website for the school
        yearRange:
          type:
          - string
          - 'null'
          description: The range of year levels offered by the school.
        icsea:
          type:
          - integer
          - 'null'
          description: The Index of Community Socio-Educational Advantage score for the school. This score is derived from a number of variables including parental school and non-school education and occupation, the school’s geographical location and proportion of Indigenous students.
          format: int32
        bottomSeaQuarter:
          type:
          - integer
          - 'null'
          description: The percentage of students positioned in the lowest socio-educational advantage quarter.
          format: int32
        lowerMiddleSeaQuarter:
          type:
          - integer
          - 'null'
          description: The percentage of students positioned in the lower middle socio-educational advantage quarter.
          format: int32
        upperMiddleSeaQuarter:
          type:
          - integer
          - 'null'
          description: The percentage of students positioned in the higher middle socio-educational advantage quarter.
          format: int32
        topSeaQuarter:
          type:
          - integer
          - 'null'
          description: The percentage of students positioned in the highest socio-educational advantage quarter.
          format: int32
        totalEnrolments:
          type:
          - integer
          - 'null'
          description: The total number of students, including both full-time and part-time students, who are enrolled at the school in the calendar year specified.
          format: int32
        girlsEnrolments:
          type:
          - integer
          - 'null'
          description: The total number of female students, including both full-time and part-time students, who are enrolled at the school in the calendar year specified.
          format: int32
        boysEnrolments:
          type:
          - integer
          - 'null'
          description: The total number of male students, including full-time and part-time students, who are enrolled at the school in the calendar year specified.
          format: int32
      additionalProperties: false
      description: SchoolProfile
      x-data-access-level-info:
        Basic:
        - Url
        - YearRange
        - GirlsEnrolments
        - BoysEnrolments
        - TotalEnrolments
        - TopSeaQuarter
        - UpperMiddleSeaQuarter
        - LowerMiddleSeaQuarter
        - BottomSeaQuarter
        - Icsea
        Detailed:
        - Url
        - YearRange
        - GirlsEnrolments
        - BoysEnrolments
        - TotalEnrolments
        - TopSeaQuarter
        - UpperMiddleSeaQuarter
        - LowerMiddleSeaQuarter
        - BottomSeaQuarter
        - Icsea
        Full:
        - Url
        - YearRange
        - GirlsEnrolments
        - BoysEnrolments
        - TotalEnrolments
        - TopSeaQuarter
        - UpperMiddleSeaQuarter
        - LowerMiddleSeaQuarter
        - BottomSeaQuarter
        - Icsea
  securitySchemes:
    apikey:
      type: apiKey
      description: API Key in Header
      name: x-api-key
      in: header
    oauth2:
      type: oauth2
      description: OAuth 2
      flows:
        clientCredentials:
          tokenUrl: https://auth.domain.com.au/v1/connect/token
          scopes:
            api_addresslocators_read: api_addresslocators_read
            api_agencies_read: api_agencies_read
            api_agencies_write: api_agencies_write
            api_authorities_write: api_authorities_write
            api_avm_read: api_avm_read
            api_campaignperformance_read: api_campaignperformance_read
            api_dataset_read: api_dataset_read
            api_demographics_read: api_demographics_read
            api_enquiries_read: api_enquiries_read
            api_enquiries_write: api_enquiries_write
            api_listingperformance_read: api_listingperformance_read
            api_listings_read: api_listings_read
            api_listings_write: api_listings_write
            api_locations_read: api_locations_read
            api_projectperformance_read: api_projectperformance_read
            api_properties_read: api_properties_read
            api_propertyportfolio_read: api_propertyportfolio_read
            api_propertyportfolio_write: api_propertyportfolio_write
            api_propertyreports_read: api_propertyreports_read
            api_salesresults_read: api_salesresults_read
            api_statistics_write: api_statistics_write
            api_suburbhistorical_read: api_suburbhistorical_read
            api_suburbperformance_read: api_suburbperformance_read
            api_suburbsummary_read: api_suburbsummary_read
            api_webhooks_write: api_webhooks_write
        authorizationCode:
          authorizationUrl: https://auth.domain.com.au/v1/connect/authorize
          tokenUrl: https://auth.domain.com.au/v1/connect/token
          refreshUrl: https://auth.domain.com.au/v1/connect/token
          scopes:
            api_addresslocators_read: api_addresslocators_read
            api_agencies_read: api_agencies_read
            api_agencies_write: api_agencies_write
            api_authorities_write: api_authorities_write
            api_avm_read: api_avm_read
            api_campaignperformance_read: api_campaignperformance_read
            api_dataset_read: api_dataset_read
            api_demographics_read: api_demographics_read
            api_enquiries_read: api_enquiries_read
            api_enquiries_write: api_enquiries_write
            api_listingperformance_read: api_listingperformance_read
            api_listings_read: api_listings_read
            api_listings_write: api_listings_write
            api_locations_read: api_locations_read
            api_projectperformance_read: api_projectperformance_read
            api_properties_read: api_properties_read
            api_propertyportfolio_read: api_propertyportfolio_read
            api_propertyportfolio_write: api_propertyportfolio_write
            api_propertyreports_read: api_propertyreports_read
            api_salesresults_read: api_salesresults_read
            api_statistics_write: api_statistics_write
            api_suburbhistorical_read: api_suburbhistorical_read
            api_suburbperformance_read: api_suburbperformance_read
            api_suburbsummary_read: api_suburbsummary_read
            api_webhooks_write: api_webhooks_write
x-refined-from:
- domain-group-openapi-latest.json
- domain-group-openapi-v2.json