InstitutionInformationAndCodesServices Web Service

InstitutionInformationAndCodesServices

Click here for a complete list of operations.

GetInstitutionByAPASCode

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/GetInstitutionByAPASCode"

<?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>
    <GetInstitutionByAPASCode xmlns="http://applyalberta.ca/">
      <code>string</code>
    </GetInstitutionByAPASCode>
  </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>
    <GetInstitutionByAPASCodeResponse xmlns="http://applyalberta.ca/">
      <GetInstitutionByAPASCodeResult>
        <ACT>string</ACT>
        <APAS>string</APAS>
        <ATP>string</ATP>
        <CCD>string</CCD>
        <CEEBACT>string</CEEBACT>
        <CSIS>string</CSIS>
        <DUNS>string</DUNS>
        <ESIS>string</ESIS>
        <FICE>string</FICE>
        <IPEDS>string</IPEDS>
        <NCHELPID>string</NCHELPID>
        <OPEID>string</OPEID>
        <PSIS>string</PSIS>
        <USIS>string</USIS>
        <OrganizationName>string</OrganizationName>
        <OrganizationIDCode>string</OrganizationIDCode>
        <CountryName>string</CountryName>
        <ProvinceName>string</ProvinceName>
        <MunicipalityName>string</MunicipalityName>
        <PostalCode>string</PostalCode>
        <InstitutionTypes>
          <string>string</string>
          <string>string</string>
        </InstitutionTypes>
        <RoleTypeCodes>
          <string>string</string>
          <string>string</string>
        </RoleTypeCodes>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <AddressLine3>string</AddressLine3>
        <ElectronicAddress>string</ElectronicAddress>
        <FaxNumber>string</FaxNumber>
        <PhoneNumber>string</PhoneNumber>
        <WebSiteURL>string</WebSiteURL>
        <IsApplicationServiceProvider>boolean</IsApplicationServiceProvider>
        <IsTranscriptPublisher>boolean</IsTranscriptPublisher>
        <IsTranscriptSubscriber>boolean</IsTranscriptSubscriber>
        <ParentAPASCode>string</ParentAPASCode>
        <InstitutionStatus>string</InstitutionStatus>
        <LocalOrganizationIDs>
          <LocalOrganizationID>
            <LocalOrganizationIDCode>string</LocalOrganizationIDCode>
            <LocalOrganizationIDQualifier>string</LocalOrganizationIDQualifier>
          </LocalOrganizationID>
          <LocalOrganizationID>
            <LocalOrganizationIDCode>string</LocalOrganizationIDCode>
            <LocalOrganizationIDQualifier>string</LocalOrganizationIDQualifier>
          </LocalOrganizationID>
        </LocalOrganizationIDs>
      </GetInstitutionByAPASCodeResult>
    </GetInstitutionByAPASCodeResponse>
  </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>
    <GetInstitutionByAPASCode xmlns="http://applyalberta.ca/">
      <code>string</code>
    </GetInstitutionByAPASCode>
  </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>
    <GetInstitutionByAPASCodeResponse xmlns="http://applyalberta.ca/">
      <GetInstitutionByAPASCodeResult>
        <ACT>string</ACT>
        <APAS>string</APAS>
        <ATP>string</ATP>
        <CCD>string</CCD>
        <CEEBACT>string</CEEBACT>
        <CSIS>string</CSIS>
        <DUNS>string</DUNS>
        <ESIS>string</ESIS>
        <FICE>string</FICE>
        <IPEDS>string</IPEDS>
        <NCHELPID>string</NCHELPID>
        <OPEID>string</OPEID>
        <PSIS>string</PSIS>
        <USIS>string</USIS>
        <OrganizationName>string</OrganizationName>
        <OrganizationIDCode>string</OrganizationIDCode>
        <CountryName>string</CountryName>
        <ProvinceName>string</ProvinceName>
        <MunicipalityName>string</MunicipalityName>
        <PostalCode>string</PostalCode>
        <InstitutionTypes>
          <string>string</string>
          <string>string</string>
        </InstitutionTypes>
        <RoleTypeCodes>
          <string>string</string>
          <string>string</string>
        </RoleTypeCodes>
        <AddressLine1>string</AddressLine1>
        <AddressLine2>string</AddressLine2>
        <AddressLine3>string</AddressLine3>
        <ElectronicAddress>string</ElectronicAddress>
        <FaxNumber>string</FaxNumber>
        <PhoneNumber>string</PhoneNumber>
        <WebSiteURL>string</WebSiteURL>
        <IsApplicationServiceProvider>boolean</IsApplicationServiceProvider>
        <IsTranscriptPublisher>boolean</IsTranscriptPublisher>
        <IsTranscriptSubscriber>boolean</IsTranscriptSubscriber>
        <ParentAPASCode>string</ParentAPASCode>
        <InstitutionStatus>string</InstitutionStatus>
        <LocalOrganizationIDs>
          <LocalOrganizationID>
            <LocalOrganizationIDCode>string</LocalOrganizationIDCode>
            <LocalOrganizationIDQualifier>string</LocalOrganizationIDQualifier>
          </LocalOrganizationID>
          <LocalOrganizationID>
            <LocalOrganizationIDCode>string</LocalOrganizationIDCode>
            <LocalOrganizationIDQualifier>string</LocalOrganizationIDQualifier>
          </LocalOrganizationID>
        </LocalOrganizationIDs>
      </GetInstitutionByAPASCodeResult>
    </GetInstitutionByAPASCodeResponse>
  </soap12:Body>
</soap12:Envelope>