CollegeSource_WSAPI_Basic Parameter Guide

Click here to go back to the test form.

SetEquivalency

Input

Parameter Value Note
AccessKeyID: An ID used to authenticate web service access.

eg. {1ABCDEF7-1234-46EF-B7E6-A0123456789B} 		Required
CreateUserID: A user ID obtained by using the following web method: GetUsers. Set to TES user who will be the equivalency creator of record.

eg. {EAB24EC2-1554-AB23-F1E2-A0123456789B} 		Required
EffectiveDateBegin: MM/DD/YYYY date value. Sets the effective date begin for a course equivalency.

eg. 1/11/2015 		Optional
EffectiveDateEnd: MM/DD/YYYY date value. Sets the effective date end for a course equivalency.

eg. 1/11/2016 		Optional
PublicNote: A note that will show in the TES Public View (max size = 1024).

eg. ENG 101 and CM 220 both have a research element. 		Optional
PrivateNote: A note that will only show in TES account in Equivalency Manager (max size = 1024).

eg. ENG 101 and CM 220 both focus on the writing process. 		Optional
HideFlag: Sets whether a course equivalency will be hidden from the TES Public View.

0 = show course equivalency in TES Public View.
1 = hide course equivalency in TES Public View. 		Required
SendCourseID1: A send course ID obtained by using the following web method: GetCourseByInstitutionIDCourseCodeMonthYear. SendCourseID1 must be provided. SendCourseID2-10 are optional. Multiple send course IDs must be from same catalog edition.

eg. SendCourseID1 = {111111-4AD1-EB12-E71D-A0123456789B}
 Required
SendCourseID2:
.
.
SendCourseID10:		 A send course ID obtained by using the following web method: GetCourseByInstitutionIDCourseCodeMonthYear. Multiple send course IDs must be from same catalog edition.

eg. SendCourseID2 = {222222-4AD1-EB12-E71D-A0123456789B}
     SendCourseID3 = {333333-4AD1-EB12-E71D-A0123456789B}
     SendCourseID4 = {444444-4AD1-EB12-E71D-A0123456789B} 		Optional
ReceiveCourseID1: A receive course ID obtained by using the following web method: GetCourseByInstitutionIDCourseCodeMonthYear. ReceiveCourseID1 must be provided. ReceiveCourseID2-10 are optional. Multiple receive course IDs must be from same catalog edition.

eg. ReceiveCourseID1 = {111111-ABCD-EB12-E71D-A0123456789B} 		Required
ReceiveCourseID2:
.
.
ReceiceCourseID10:		 A receive course ID obtained by using the following web method: GetCourseByInstitutionIDCourseCodeMonthYear. Multiple receive course IDs must be from same catalog edition.

eg. ReceiveCourseID2 = {222222-4AD1-EB12-E71D-A0123456789B}
     ReceiveCourseID3 = {333333-4AD1-EB12-E71D-A0123456789B}
     ReceiveCourseID4 = {444444-4AD1-EB12-E71D-A0123456789B} 		Optional

Output

Parameter Value Note
EquivalencyID An equivalency ID. Used as an input parameter for the following web method: GetEquivalencyDetailByEquivalencyID.

eg. {444a1a34-ac23-4da4-a34c-7a21ac3fc5a1} 		String