v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-23105087.3 KB
locations

Returns the locations for the specified provider.

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

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"
  }
}