Schools¶

The schools API allows you to retrieve a list of schools, including basic information about each school. You need to authenticate using an API Key in order to call this service; see the Authentication section for further details

URL: /v1/product/schools
HTTP Method: GET
Client Library Message Name: Product.GetSchoolsRequest

Sample request¶

Error

Failed to run contract transformer command: bin\Api.ContractTransformer.exe

{ }

Sample response¶

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Cache-Control: no-cache
Content-Length: 987

{
  "Results": [
    {
      "ProductOfferingsUrl": "https://api.ecenglish.com/v1/product/offerings?withSchools=MLT",
      "Code": "MLT",
      "Name": "Malta",
      "MinimumAge": 16,
      "Country": {
        "Type": "Country",
        "Code": "MT",
        "Name": "Malta",
        "Properties": {}
      }
    },
    {
      "ProductOfferingsUrl": "https://api.ecenglish.com/v1/product/offerings?withSchools=LON",
      "Code": "LON",
      "Name": "London",
      "MinimumAge": 16,
      "Country": {
        "Type": "Country",
        "Code": "GB",
        "Name": "United Kingdom",
        "Properties": {}
      }
    },
    {
      "ProductOfferingsUrl": "https://api.ecenglish.com/v1/product/offerings?withSchools=YRK",
      "Code": "YRK",
      "Name": "New York",
      "MinimumAge": 16,
      "Country": {
        "Type": "Country",
        "Code": "US",
        "Name": "United States",
        "Properties": {}
      }
    }
  ]
}

HTTP/1.1 200 OK
Content-Type: application/xml; charset=utf-8
Cache-Control: no-cache
Content-Length: 1823

<GetSchoolsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EcEnglish.Api.ServiceContract.Product">
  <Results>
    <SchoolWithOfferingsLink>
      <Closures
        i:nil="true" />
      <Code>MLT</Code>
      <Country>
        <Code>MT</Code>
        <Name>Malta</Name>
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        <Type>Country</Type>
      </Country>
      <Currency
        i:nil="true" />
      <MinimumAge>16</MinimumAge>
      <Name>Malta</Name>
      <Properties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"
        i:nil="true" />
      <ProductOfferingsUrl>https://api.ecenglish.com/v1/product/offerings?withSchools=MLT</ProductOfferingsUrl>
    </SchoolWithOfferingsLink>
    <SchoolWithOfferingsLink>
      <Closures
        i:nil="true" />
      <Code>LON</Code>
      <Country>
        <Code>GB</Code>
        <Name>United Kingdom</Name>
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        <Type>Country</Type>
      </Country>
      <Currency
        i:nil="true" />
      <MinimumAge>16</MinimumAge>
      <Name>London</Name>
      <Properties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"
        i:nil="true" />
      <ProductOfferingsUrl>https://api.ecenglish.com/v1/product/offerings?withSchools=LON</ProductOfferingsUrl>
    </SchoolWithOfferingsLink>
    <SchoolWithOfferingsLink>
      <Closures
        i:nil="true" />
      <Code>YRK</Code>
      <Country>
        <Code>US</Code>
        <Name>United States</Name>
        <Properties xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
        <Type>Country</Type>
      </Country>
      <Currency
        i:nil="true" />
      <MinimumAge>16</MinimumAge>
      <Name>New York</Name>
      <Properties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"
        i:nil="true" />
      <ProductOfferingsUrl>https://api.ecenglish.com/v1/product/offerings?withSchools=YRK</ProductOfferingsUrl>
    </SchoolWithOfferingsLink>
  </Results>
</GetSchoolsResponse>