CollegeSource_WSAPI_Basic Parameter Guide

Click here to go back to the test form.


GetEquivalencyExportList

Input

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}
Null will return all records.
Optional
PastNumDay: Filters the result set by past number (1-30) of day(s).

eg. 1 = equivalency(ies) created in the past 1 day.
7 = equivalency(ies) created in the past 7 days.
30 = equivalency(ies) created in the past 30 days. (Note: 30 is max value.)
Required
DateType: Filters the result set by date type.

0 = create AND last edit date.
1 = create date only.
2 = last edit date only.
Required
EquivalencyType: Filters the result set by equivalency type.

0 = public and hidden equivalency(ies).
1 = public equivalency(ies) only.
2 = hidden equivalency(ies) only.
Required

Output

Note: Equivalencies may consist of up to 10 send course codes, 10 send course titles, 10 send course units AND/OR 10 receive course codes, 10 receive course titles, 10 receive course units.

The table below is only showing sample output data for a one course-to-one course equivalency.

Parameter Value Note
SendInstitution A send institution name.

eg. SAN DIEGO MESA COLLEGE
String
SendInstitutionCity A send institution city.

eg. SAN DIEGO
String
SendInstitutionState A send institution state.

eg. CALIFORNIA
String
SendInstitutionCountry A send institution country.

eg. UNITED STATES
String
SendInstitutionOPEID A send institution identifier OPEID.

eg. 00127500
String
SendInstitutionIPEDSID A send institution identifier IPEDSID.

eg. 122375
String
SendInstitutionCEEBCode A send institution identifier CEEB Code.

eg. 004735
String
SendEditionLowYear A send institution catalog edition low year.

eg. 2019
Integer
SendEditionHighYear A send institution catalog edition high year.

eg. 2020
Integer
SendCourse1CourseCode
.
.
SendCourse10CourseCode
A send course code.

eg. SendCourse1CourseCode = ACCT 116A
String
SendCourse1CourseTitle
.
.
SendCourse10CourseTitle
A send course title.

eg. SendCourse1CourseTitle = FINANCIAL ACCOUNTING
String
SendCourse1Units
.
.
SendCourse10Units
A send course units.

eg. SendCourse1Units = 3
String
ReceiveInstitution A receive institution name.

eg. COLLEGESOURCE UNDERGRADUATE TITLE (DEV)
String
ReceiveEditionLowYear A receive institution catalog edition low year.

eg. 2019
Integer
ReceiveEditionHighYear A receive institution catalog edition high year.

eg. 2020
Integer
ReceiveCourse1CourseCode
.
.
ReceiveCourse10CourseCode
A receive course code.

eg. ReceiveCourse1CourseCode = ACCTG 201
String
ReceiveCourse1CourseTitle
.
.
ReceiveCourse10CourseTitle
A receive course title.

eg. ReceiveCourse1CourseTitle = FINANCIAL ACCOUNTING FUNDAMENTALS
String
ReceiveCourse1Units
.
.
ReceiveCourse10Units
A receive course units.

eg. ReceiveCourse1Units = 3
String
ActiveDateBegin The begin active date for a course equivalency.

eg. 7/22/2019
String
ActiveDateEnd The end active date for a course equivalency.

eg. 7/22/2020
String
ContactName Name of user who created course equivalency.

eg. Peter Johnson
String
EQCreateDateTime Course equivalency create date time.

eg. 6/22/2019 12:00:00 AM
String
EQLEditDateTime Course equivalency last edit date time.

eg. 7/22/2019 12:00:00 AM
String
HideFlag Indicates whether a course equivalency will be hidden from the TES Public View.

eg. True or False
Boolean
CommentsPublic Optional note that will show in the TES Public View.
String
CommentsPrivate Optional note that will only show in TES account in Equivalency Manager.
String