InstitutionInformationAndCodesServices

Click here for a complete list of operations.

GetInstitutionList

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 /APAS.WebServices/InstitutionInformationAndCodesServices.asmx HTTP/1.1
Host: applyalberta.ca
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://applyalberta.ca/GetInstitutionList"

<?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>
    <GetInstitutionList xmlns="http://applyalberta.ca/">
      <filter>
        <InstitutionType>string</InstitutionType>
        <UpdateDate>dateTime</UpdateDate>
        <RecordOffset>int</RecordOffset>
        <Country>string</Country>
        <Region>string</Region>
        <City>string</City>
        <Name>string</Name>
        <MaxResults>int</MaxResults>
        <APASCode>string</APASCode>
        <IsTranscriptSubscriber>string</IsTranscriptSubscriber>
        <IsTranscriptPublisher>string</IsTranscriptPublisher>
        <IsApplicationProvider>string</IsApplicationProvider>
      </filter>
    </GetInstitutionList>
  </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>
    <GetInstitutionListResponse xmlns="http://applyalberta.ca/">
      <GetInstitutionListResult>
        <NumberOfRecordsFound>int</NumberOfRecordsFound>
        <Offset>int</Offset>
        <Result>
          <InstitutionListItem>
            <OrganizationName>string</OrganizationName>
            <APASCode>string</APASCode>
          </InstitutionListItem>
          <InstitutionListItem>
            <OrganizationName>string</OrganizationName>
            <APASCode>string</APASCode>
          </InstitutionListItem>
        </Result>
      </GetInstitutionListResult>
    </GetInstitutionListResponse>
  </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 /APAS.WebServices/InstitutionInformationAndCodesServices.asmx HTTP/1.1
Host: applyalberta.ca
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>
    <GetInstitutionList xmlns="http://applyalberta.ca/">
      <filter>
        <InstitutionType>string</InstitutionType>
        <UpdateDate>dateTime</UpdateDate>
        <RecordOffset>int</RecordOffset>
        <Country>string</Country>
        <Region>string</Region>
        <City>string</City>
        <Name>string</Name>
        <MaxResults>int</MaxResults>
        <APASCode>string</APASCode>
        <IsTranscriptSubscriber>string</IsTranscriptSubscriber>
        <IsTranscriptPublisher>string</IsTranscriptPublisher>
        <IsApplicationProvider>string</IsApplicationProvider>
      </filter>
    </GetInstitutionList>
  </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>
    <GetInstitutionListResponse xmlns="http://applyalberta.ca/">
      <GetInstitutionListResult>
        <NumberOfRecordsFound>int</NumberOfRecordsFound>
        <Offset>int</Offset>
        <Result>
          <InstitutionListItem>
            <OrganizationName>string</OrganizationName>
            <APASCode>string</APASCode>
          </InstitutionListItem>
          <InstitutionListItem>
            <OrganizationName>string</OrganizationName>
            <APASCode>string</APASCode>
          </InstitutionListItem>
        </Result>
      </GetInstitutionListResult>
    </GetInstitutionListResponse>
  </soap12:Body>
</soap12:Envelope>