EstablishmentProvider Web Service

EstablishmentProvider

Click here for a complete list of operations.

SearchWithNameFilter

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /EstablishmentProvider.asmx HTTP/1.1
Host: edcoapi.education.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://education.co.uk/SearchWithNameFilter"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SearchWithNameFilter xmlns="http://education.co.uk">
      <key>string</key>
      <name>string</name>
      <town>string</town>
      <postcode>string</postcode>
      <typeFilter>string</typeFilter>
      <countryIDFilter>
        <int>int</int>
        <int>int</int>
      </countryIDFilter>
    </SearchWithNameFilter>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SearchWithNameFilterResponse xmlns="http://education.co.uk">
      <SearchWithNameFilterResult>
        <Establishment>
          <Name>string</Name>
          <EOS_Address>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <Town>string</Town>
            <County xsi:nil="true" />
            <Country xsi:nil="true" />
            <Postcode>string</Postcode>
            <GridEast>int</GridEast>
            <GridNorth>int</GridNorth>
            <LEACode>string</LEACode>
          </EOS_Address>
          <TypeID>string</TypeID>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <ID>int</ID>
          <WebsiteUrl>string</WebsiteUrl>
          <PupilsOnRoll>short</PupilsOnRoll>
          <EmailAddress>string</EmailAddress>
        </Establishment>
        <Establishment>
          <Name>string</Name>
          <EOS_Address>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <Town>string</Town>
            <County xsi:nil="true" />
            <Country xsi:nil="true" />
            <Postcode>string</Postcode>
            <GridEast>int</GridEast>
            <GridNorth>int</GridNorth>
            <LEACode>string</LEACode>
          </EOS_Address>
          <TypeID>string</TypeID>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <ID>int</ID>
          <WebsiteUrl>string</WebsiteUrl>
          <PupilsOnRoll>short</PupilsOnRoll>
          <EmailAddress>string</EmailAddress>
        </Establishment>
      </SearchWithNameFilterResult>
      <statusCode>short</statusCode>
    </SearchWithNameFilterResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /EstablishmentProvider.asmx HTTP/1.1
Host: edcoapi.education.co.uk
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SearchWithNameFilter xmlns="http://education.co.uk">
      <key>string</key>
      <name>string</name>
      <town>string</town>
      <postcode>string</postcode>
      <typeFilter>string</typeFilter>
      <countryIDFilter>
        <int>int</int>
        <int>int</int>
      </countryIDFilter>
    </SearchWithNameFilter>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SearchWithNameFilterResponse xmlns="http://education.co.uk">
      <SearchWithNameFilterResult>
        <Establishment>
          <Name>string</Name>
          <EOS_Address>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <Town>string</Town>
            <County xsi:nil="true" />
            <Country xsi:nil="true" />
            <Postcode>string</Postcode>
            <GridEast>int</GridEast>
            <GridNorth>int</GridNorth>
            <LEACode>string</LEACode>
          </EOS_Address>
          <TypeID>string</TypeID>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <ID>int</ID>
          <WebsiteUrl>string</WebsiteUrl>
          <PupilsOnRoll>short</PupilsOnRoll>
          <EmailAddress>string</EmailAddress>
        </Establishment>
        <Establishment>
          <Name>string</Name>
          <EOS_Address>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <Town>string</Town>
            <County xsi:nil="true" />
            <Country xsi:nil="true" />
            <Postcode>string</Postcode>
            <GridEast>int</GridEast>
            <GridNorth>int</GridNorth>
            <LEACode>string</LEACode>
          </EOS_Address>
          <TypeID>string</TypeID>
          <Telephone>string</Telephone>
          <Fax>string</Fax>
          <ID>int</ID>
          <WebsiteUrl>string</WebsiteUrl>
          <PupilsOnRoll>short</PupilsOnRoll>
          <EmailAddress>string</EmailAddress>
        </Establishment>
      </SearchWithNameFilterResult>
      <statusCode>short</statusCode>
    </SearchWithNameFilterResponse>
  </soap12:Body>
</soap12:Envelope>