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 |
CreateUserID: |
A user ID obtained by using the following web method: GetUsers.
Set to TES user who will be the evaluation task creator of record. eg. {EAB24EC2-1554-AB23-F1E2-A0123456789B} |
Required |
AssignedUserID: |
A user ID obtained by using the following web method: GetUsers.
Set to TES user who will be initially assigned to service the evaluation task. eg. {AAB24CD2-1CD4-1CD3-E1D2-A0123456789B} |
Required |
Comment: |
Evaluation task comment or note (max size = 1024). |
Optional |
SendInstitutionID: |
A send institution ID obtained by using one of the following web methods:
GetInstitutionByCEEBCode or GetInstitutionByOPEIDCode or GetInstitutionByInstitutionNameCityStateAbbr.
The send institution must correlate with the send courses. eg. {CB123CD-4551-C1B4-E723-A0123456789B} |
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 = {111111-4AD1-EB12-E71D-A0123456789B} SendCourseID3 = {222222-4AD1-EB12-E71D-A0123456789B} SendCourseID4 = {333333-4AD1-EB12-E71D-A0123456789B} |
Optional |
Parameter | Value | Note |
EvaluationID |
An evaluation ID. Used as an input parameter for the following web method: GetEvaluationStatusByEvaluationID. eg. {444a1a34-ac23-4da4-a34c-7a21ac3fc5a1} |
String |