CollegeSource_WSAPI


Click here for a complete list of operations.

GetInstitutionByOPEIDCode

Get an institution by institution OPEID code.
>> Parameter Guide

Test

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

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 /CollegeSource_WSAPI.asmx HTTP/1.1
Host: wsapi.collegesource.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://wsapi.collegesource.com/GetInstitutionByOPEIDCode"

<?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>
    <GetInstitutionByOPEIDCode xmlns="https://wsapi.collegesource.com">
      <AccessKeyID>string</AccessKeyID>
      <InstitutionOPEID>string</InstitutionOPEID>
    </GetInstitutionByOPEIDCode>
  </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>
    <GetInstitutionByOPEIDCodeResponse xmlns="https://wsapi.collegesource.com">
      <GetInstitutionByOPEIDCodeResult>
        <Institution>
          <InstitutionID>string</InstitutionID>
          <InstitutionName>string</InstitutionName>
          <InstitutionCity>string</InstitutionCity>
          <InstitutionStateAbbr>string</InstitutionStateAbbr>
          <InstitutionCountry>string</InstitutionCountry>
        </Institution>
        <Institution>
          <InstitutionID>string</InstitutionID>
          <InstitutionName>string</InstitutionName>
          <InstitutionCity>string</InstitutionCity>
          <InstitutionStateAbbr>string</InstitutionStateAbbr>
          <InstitutionCountry>string</InstitutionCountry>
        </Institution>
      </GetInstitutionByOPEIDCodeResult>
    </GetInstitutionByOPEIDCodeResponse>
  </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 /CollegeSource_WSAPI.asmx HTTP/1.1
Host: wsapi.collegesource.com
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>
    <GetInstitutionByOPEIDCode xmlns="https://wsapi.collegesource.com">
      <AccessKeyID>string</AccessKeyID>
      <InstitutionOPEID>string</InstitutionOPEID>
    </GetInstitutionByOPEIDCode>
  </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>
    <GetInstitutionByOPEIDCodeResponse xmlns="https://wsapi.collegesource.com">
      <GetInstitutionByOPEIDCodeResult>
        <Institution>
          <InstitutionID>string</InstitutionID>
          <InstitutionName>string</InstitutionName>
          <InstitutionCity>string</InstitutionCity>
          <InstitutionStateAbbr>string</InstitutionStateAbbr>
          <InstitutionCountry>string</InstitutionCountry>
        </Institution>
        <Institution>
          <InstitutionID>string</InstitutionID>
          <InstitutionName>string</InstitutionName>
          <InstitutionCity>string</InstitutionCity>
          <InstitutionStateAbbr>string</InstitutionStateAbbr>
          <InstitutionCountry>string</InstitutionCountry>
        </Institution>
      </GetInstitutionByOPEIDCodeResult>
    </GetInstitutionByOPEIDCodeResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP POST

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

POST /CollegeSource_WSAPI.asmx/GetInstitutionByOPEIDCode HTTP/1.1
Host: wsapi.collegesource.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfInstitution xmlns="https://wsapi.collegesource.com">
  <Institution>
    <InstitutionID>string</InstitutionID>
    <InstitutionName>string</InstitutionName>
    <InstitutionCity>string</InstitutionCity>
    <InstitutionStateAbbr>string</InstitutionStateAbbr>
    <InstitutionCountry>string</InstitutionCountry>
  </Institution>
  <Institution>
    <InstitutionID>string</InstitutionID>
    <InstitutionName>string</InstitutionName>
    <InstitutionCity>string</InstitutionCity>
    <InstitutionStateAbbr>string</InstitutionStateAbbr>
    <InstitutionCountry>string</InstitutionCountry>
  </Institution>
</ArrayOfInstitution>