SchoolServices


Click here for a complete list of operations.

GetSchoolBySchoolId

Gets school by school ID

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
schoolID:

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 /SchoolLegacyService/SchoolServices.asmx HTTP/1.1
Host: vle-vleservices-pre.azurewebsites.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.dec.nsw.gov.au/webservices/GetSchoolBySchoolId"

<?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>
    <GetSchoolBySchoolId xmlns="http://www.dec.nsw.gov.au/webservices/">
      <schoolID>int</schoolID>
    </GetSchoolBySchoolId>
  </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>
    <GetSchoolBySchoolIdResponse xmlns="http://www.dec.nsw.gov.au/webservices/">
      <GetSchoolBySchoolIdResult>
        <SchoolCode>int</SchoolCode>
        <SchoolShortName>string</SchoolShortName>
        <SchoolFullName>string</SchoolFullName>
        <SchoolEmail>string</SchoolEmail>
        <EducationalServicesNumber>int</EducationalServicesNumber>
        <NetworkID>int</NetworkID>
        <PhoneNumber>string</PhoneNumber>
        <Street>string</Street>
        <Suburb>string</Suburb>
        <PostCode>string</PostCode>
        <State>string</State>
        <Country>string</Country>
        <GovNonGov>string</GovNonGov>
        <SchoolType>string</SchoolType>
        <Gender>string</Gender>
        <Denomination>string</Denomination>
        <Sector>string</Sector>
        <SchoolFullTitle>string</SchoolFullTitle>
        <Region>string</Region>
        <Status>string</Status>
        <EducationalServicesName>string</EducationalServicesName>
        <SchoolNetworkName>string</SchoolNetworkName>
        <Longitude>double</Longitude>
        <Latitude>double</Latitude>
        <IsPriorityFunded>boolean</IsPriorityFunded>
        <DataEntryCode>int</DataEntryCode>
      </GetSchoolBySchoolIdResult>
    </GetSchoolBySchoolIdResponse>
  </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 /SchoolLegacyService/SchoolServices.asmx HTTP/1.1
Host: vle-vleservices-pre.azurewebsites.net
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>
    <GetSchoolBySchoolId xmlns="http://www.dec.nsw.gov.au/webservices/">
      <schoolID>int</schoolID>
    </GetSchoolBySchoolId>
  </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>
    <GetSchoolBySchoolIdResponse xmlns="http://www.dec.nsw.gov.au/webservices/">
      <GetSchoolBySchoolIdResult>
        <SchoolCode>int</SchoolCode>
        <SchoolShortName>string</SchoolShortName>
        <SchoolFullName>string</SchoolFullName>
        <SchoolEmail>string</SchoolEmail>
        <EducationalServicesNumber>int</EducationalServicesNumber>
        <NetworkID>int</NetworkID>
        <PhoneNumber>string</PhoneNumber>
        <Street>string</Street>
        <Suburb>string</Suburb>
        <PostCode>string</PostCode>
        <State>string</State>
        <Country>string</Country>
        <GovNonGov>string</GovNonGov>
        <SchoolType>string</SchoolType>
        <Gender>string</Gender>
        <Denomination>string</Denomination>
        <Sector>string</Sector>
        <SchoolFullTitle>string</SchoolFullTitle>
        <Region>string</Region>
        <Status>string</Status>
        <EducationalServicesName>string</EducationalServicesName>
        <SchoolNetworkName>string</SchoolNetworkName>
        <Longitude>double</Longitude>
        <Latitude>double</Latitude>
        <IsPriorityFunded>boolean</IsPriorityFunded>
        <DataEntryCode>int</DataEntryCode>
      </GetSchoolBySchoolIdResult>
    </GetSchoolBySchoolIdResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /SchoolLegacyService/SchoolServices.asmx/GetSchoolBySchoolId?schoolID=string HTTP/1.1
Host: vle-vleservices-pre.azurewebsites.net

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

<?xml version="1.0" encoding="utf-8"?>
<School xmlns="http://www.dec.nsw.gov.au/webservices/">
  <SchoolCode>int</SchoolCode>
  <SchoolShortName>string</SchoolShortName>
  <SchoolFullName>string</SchoolFullName>
  <SchoolEmail>string</SchoolEmail>
  <EducationalServicesNumber>int</EducationalServicesNumber>
  <NetworkID>int</NetworkID>
  <PhoneNumber>string</PhoneNumber>
  <Street>string</Street>
  <Suburb>string</Suburb>
  <PostCode>string</PostCode>
  <State>string</State>
  <Country>string</Country>
  <GovNonGov>string</GovNonGov>
  <SchoolType>string</SchoolType>
  <Gender>string</Gender>
  <Denomination>string</Denomination>
  <Sector>string</Sector>
  <SchoolFullTitle>string</SchoolFullTitle>
  <Region>string</Region>
  <Status>string</Status>
  <EducationalServicesName>string</EducationalServicesName>
  <SchoolNetworkName>string</SchoolNetworkName>
  <Longitude>double</Longitude>
  <Latitude>double</Latitude>
  <IsPriorityFunded>boolean</IsPriorityFunded>
  <DataEntryCode>int</DataEntryCode>
</School>

HTTP POST

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

POST /SchoolLegacyService/SchoolServices.asmx/GetSchoolBySchoolId HTTP/1.1
Host: vle-vleservices-pre.azurewebsites.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<School xmlns="http://www.dec.nsw.gov.au/webservices/">
  <SchoolCode>int</SchoolCode>
  <SchoolShortName>string</SchoolShortName>
  <SchoolFullName>string</SchoolFullName>
  <SchoolEmail>string</SchoolEmail>
  <EducationalServicesNumber>int</EducationalServicesNumber>
  <NetworkID>int</NetworkID>
  <PhoneNumber>string</PhoneNumber>
  <Street>string</Street>
  <Suburb>string</Suburb>
  <PostCode>string</PostCode>
  <State>string</State>
  <Country>string</Country>
  <GovNonGov>string</GovNonGov>
  <SchoolType>string</SchoolType>
  <Gender>string</Gender>
  <Denomination>string</Denomination>
  <Sector>string</Sector>
  <SchoolFullTitle>string</SchoolFullTitle>
  <Region>string</Region>
  <Status>string</Status>
  <EducationalServicesName>string</EducationalServicesName>
  <SchoolNetworkName>string</SchoolNetworkName>
  <Longitude>double</Longitude>
  <Latitude>double</Latitude>
  <IsPriorityFunded>boolean</IsPriorityFunded>
  <DataEntryCode>int</DataEntryCode>
</School>