DEdepartment-for-education
locations

Returns the locations for the specified provider.

Changed on
get/recruitment_cycles/{year}/providers/{provider_code}/locations

Request

  • Base URL
    https://api.publish-teacher-training-courses.service.gov.uk/api/public/v1
  • Auth
    none declared

Path parameters

yearstring required

The starting year of the recruitment cycle. Also accepts "current" for the current recruitment cycle. Defaults to current recruitment cycle if invalid year (eg "1066") is provided

provider_codestring required

The unique code of the provider.

Query parameters

include'recruitment_cycle' | 'provider'

The associated data for this resource.

Response

The collection of locations for the specified provider.

Example response

{
  "data": [
    {
      "id": "11214485",
      "type": "locations",
      "attributes": {
        "code": "-",
        "name": "Main Site",
        "street_address_1": "Barnsley Road",
        "street_address_2": "Wath-upon-Dearne",
        "street_address_3": "Newington",
        "city": "Rotherham",
        "county": "South Yorkshire",
        "postcode": "S63 6PY",
        "region_code": "yorkshire_and_the_humber",
        "latitude": 53.5082828,
        "longitude": -1.3603394,
        "uuid": "a74106f6-dd85-45c4-8d56-048e6222734h"
      },
      "relationships": {
        "recruitment_cycle": {
          "data": {
            "type": "recruitment_cycles",
            "id": "3"
          }
        },
        "provider": {
          "data": {
            "type": "providers",
            "id": "16288"
          }
        },
        "course": {
          "data": {
            "type": "courses",
            "id": "12924236"
          }
        },
        "location_status": {
          "data": {
            "type": "location_statuses",
            "id": "22322679"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "3",
      "type": "recruitment_cycles",
      "attributes": {
        "year": 2021,
        "application_start_date": "2020-10-13",
        "application_end_date": "2021-10-03"
      }
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Changes

  • 4e9e8f725299Revision changes
    • info

      response property included/items/anyOf[CourseResource]/attributes/has_vacancies deprecated

    • info

      response property included/items/anyOf[CourseResource]/attributes/open_for_applications deprecated

    • info

      response property included/items/anyOf[CourseResource]/attributes/running deprecated

  • c34835686364Revision changes
    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status