CollegeSource_WSAPI_Basic Parameter Guide
CollegeSource_WSAPI_Basic Parameter Guide
| Parameter | Value | Note |
| AccessKeyID: |
An ID used to authenticate web service access. eg. {1ABCDEF7-1234-46EF-B7E6-A0123456789B} |
Required |
| SendInstitutionID: |
A specific send institution ID obtained by using the following web method: GetEquivalencyInstitutionListByAccount. eg. {A1B1C1D1-1AB4-88CB-B116-0A1B2C3C4599} |
Required |
| ActiveStatus: |
Filters the result set by comparing the Effective Date Range to the current date. 1 = Limit to only Active EQs 2 = Limit to only Inactive EQs 3 will return both Active and Inactive EQs. |
Required |
| CourseCode: |
Filters the result set to a specific course code. Used in tandem with CourseCodeType. eg. ENGL 101 Null will return all records. |
Optional |
| CourseCodeType: |
Filters the result set to a specific course type. Used in tandem with CourseCode. 1 = Transfer Courses 2 = Home Courses 3 will return all records. |
Required |
| SortType: |
Sets the sort order of result set. 1 = Transfer Course Code 2 = Home Course Code 3 = Begin Date 4 = End Date 1 will sort by Transfer Course Code. |
Required |
| HideStatus: |
Filters the result set by hideflag. 1 = Limit to only unhidden EQs. 0 will return all records. |
Required |
| Page: |
Specific page to return from the result set. Used in tandem with PageSize. eg. Page = 3 and PageSize = 50 returns the third set of 50 records. 0 will return all records. |
Required |
| PageSize: |
Number of records to return per page. Used in tandem with Page. eg. PageSize = 50, returns 50 records per page. 0 will return all records. |
Required |
Note: Equivalencies may consist of up to 10 send courses and/or 10 receive courses.
The table below is only showing sample output data for a one course-to-one course equivalency.
| Parameter | Value | Note |
| CourseEquivalencyID |
A course equivalency ID. Used as an input parameter for the following web method: GetEquivalencyDetailByCourseEquivalencyID. eg. {ca6a1c21-ac12-5da2-1ca4-8a21cd0cc5a2} |
String |
| EffectiveDateBegin |
The begin effective date for a course equivalency. eg. 6/22/2015 12:00:00 AM |
String |
| EffectiveDateEnd |
The end effective date for a course equivalency. eg. 6/22/2016 12:00:00 AM |
String |
| PublicNote |
Optional note that will show in the TES Public View. |
String |
| PrivateNote |
Optional note that will only show in TES account in Equivalency Manager. |
String |
| HideFlag |
Indicates whether a course equivalency will be hidden from the TES Public View. eg. True or False |
Boolean |
| PageCount |
A total page count used to create paging functionality. eg. 5 |
Integer |
| SendTitle |
A send institution title. eg. SAN DIEGO MESA COLLEGE |
String |
| SendLo |
A send institution catalog edition low year. eg. 2010 |
Integer |
| SendHi |
A send institution catalog edition high year. eg. 2011 |
Integer |
| SendCourseCode1 . . SendCourseCode10 |
A send course code. eg. SendCourseCode1 = ACCT 116A |
String |
| SendCourseTitle1 . . SendCourseTitle10 |
A send course title. eg. SendCourseTitle1 = FINANCIAL ACCOUNTING |
String |
| ReceiveTitle |
A receive institution title. eg. COLLEGESOURCE UNDERGRADUATE TITLE (DEV) |
String |
| ReceiveLo |
A receive institution catalog edition low year. eg. 2012 |
Integer |
| ReceiveHi |
A receive institution catalog edition high year. eg. 2013 |
Integer |
| ReceiveCourseCode1 . . ReceiveCourseCode10 |
A receive course code. eg. ReceiveCourseCode1 = ACCTG 201 |
String |
| ReceiveCourseTitle1 . . ReceiveCourseTitle10 |
A receive course title. eg. ReceiveCourseTitle1 = FINANCIAL ACCOUNTING FUNDAMENTALS |
String |