CollegeSource_CSIWS
Click here for a complete list of operations.
GetInstitutionListByKeywordScope
Get publishing institutions by keyword, scope.
>> Parameter Guide
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.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_CSIWS.asmx HTTP/1.1
Host: csiws.collegesource.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://csiws.collegesource.com/GetInstitutionListByKeywordScope"
<?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>
<GetInstitutionListByKeywordScope xmlns="https://csiws.collegesource.com">
<AccessKeyID>string</AccessKeyID>
<Keyword>string</Keyword>
<Scope>int</Scope>
</GetInstitutionListByKeywordScope>
</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>
<GetInstitutionListByKeywordScopeResponse xmlns="https://csiws.collegesource.com">
<GetInstitutionListByKeywordScopeResult>
<Institution>
<InstitutionID>string</InstitutionID>
<IPEDSID>string</IPEDSID>
<OPEID>string</OPEID>
<CEEBCode>string</CEEBCode>
<PESCGEOCode>string</PESCGEOCode>
<InstitutionName>string</InstitutionName>
<City>string</City>
<StateAbbr>string</StateAbbr>
<Country>string</Country>
<PrimaryTESTitle>string</PrimaryTESTitle>
<PrimaryTESTitleMostRecentEditionLowYear>string</PrimaryTESTitleMostRecentEditionLowYear>
<PrimaryTESTitleMostRecentEditionHighYear>string</PrimaryTESTitleMostRecentEditionHighYear>
</Institution>
<Institution>
<InstitutionID>string</InstitutionID>
<IPEDSID>string</IPEDSID>
<OPEID>string</OPEID>
<CEEBCode>string</CEEBCode>
<PESCGEOCode>string</PESCGEOCode>
<InstitutionName>string</InstitutionName>
<City>string</City>
<StateAbbr>string</StateAbbr>
<Country>string</Country>
<PrimaryTESTitle>string</PrimaryTESTitle>
<PrimaryTESTitleMostRecentEditionLowYear>string</PrimaryTESTitleMostRecentEditionLowYear>
<PrimaryTESTitleMostRecentEditionHighYear>string</PrimaryTESTitleMostRecentEditionHighYear>
</Institution>
</GetInstitutionListByKeywordScopeResult>
</GetInstitutionListByKeywordScopeResponse>
</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_CSIWS.asmx HTTP/1.1
Host: csiws.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>
<GetInstitutionListByKeywordScope xmlns="https://csiws.collegesource.com">
<AccessKeyID>string</AccessKeyID>
<Keyword>string</Keyword>
<Scope>int</Scope>
</GetInstitutionListByKeywordScope>
</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>
<GetInstitutionListByKeywordScopeResponse xmlns="https://csiws.collegesource.com">
<GetInstitutionListByKeywordScopeResult>
<Institution>
<InstitutionID>string</InstitutionID>
<IPEDSID>string</IPEDSID>
<OPEID>string</OPEID>
<CEEBCode>string</CEEBCode>
<PESCGEOCode>string</PESCGEOCode>
<InstitutionName>string</InstitutionName>
<City>string</City>
<StateAbbr>string</StateAbbr>
<Country>string</Country>
<PrimaryTESTitle>string</PrimaryTESTitle>
<PrimaryTESTitleMostRecentEditionLowYear>string</PrimaryTESTitleMostRecentEditionLowYear>
<PrimaryTESTitleMostRecentEditionHighYear>string</PrimaryTESTitleMostRecentEditionHighYear>
</Institution>
<Institution>
<InstitutionID>string</InstitutionID>
<IPEDSID>string</IPEDSID>
<OPEID>string</OPEID>
<CEEBCode>string</CEEBCode>
<PESCGEOCode>string</PESCGEOCode>
<InstitutionName>string</InstitutionName>
<City>string</City>
<StateAbbr>string</StateAbbr>
<Country>string</Country>
<PrimaryTESTitle>string</PrimaryTESTitle>
<PrimaryTESTitleMostRecentEditionLowYear>string</PrimaryTESTitleMostRecentEditionLowYear>
<PrimaryTESTitleMostRecentEditionHighYear>string</PrimaryTESTitleMostRecentEditionHighYear>
</Institution>
</GetInstitutionListByKeywordScopeResult>
</GetInstitutionListByKeywordScopeResponse>
</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_CSIWS.asmx/GetInstitutionListByKeywordScope HTTP/1.1 Host: csiws.collegesource.com Content-Type: application/x-www-form-urlencoded Content-Length: length AccessKeyID=string&Keyword=string&Scope=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://csiws.collegesource.com">
<Institution>
<InstitutionID>string</InstitutionID>
<IPEDSID>string</IPEDSID>
<OPEID>string</OPEID>
<CEEBCode>string</CEEBCode>
<PESCGEOCode>string</PESCGEOCode>
<InstitutionName>string</InstitutionName>
<City>string</City>
<StateAbbr>string</StateAbbr>
<Country>string</Country>
<PrimaryTESTitle>string</PrimaryTESTitle>
<PrimaryTESTitleMostRecentEditionLowYear>string</PrimaryTESTitleMostRecentEditionLowYear>
<PrimaryTESTitleMostRecentEditionHighYear>string</PrimaryTESTitleMostRecentEditionHighYear>
</Institution>
<Institution>
<InstitutionID>string</InstitutionID>
<IPEDSID>string</IPEDSID>
<OPEID>string</OPEID>
<CEEBCode>string</CEEBCode>
<PESCGEOCode>string</PESCGEOCode>
<InstitutionName>string</InstitutionName>
<City>string</City>
<StateAbbr>string</StateAbbr>
<Country>string</Country>
<PrimaryTESTitle>string</PrimaryTESTitle>
<PrimaryTESTitleMostRecentEditionLowYear>string</PrimaryTESTitleMostRecentEditionLowYear>
<PrimaryTESTitleMostRecentEditionHighYear>string</PrimaryTESTitleMostRecentEditionHighYear>
</Institution>
</ArrayOfInstitution>