Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Colleague API Version

TypeDescriptionRead/WriteDependencies
Course Exchange




X.CCCTC.BOGW.UPDATE1.1TransactionUpdate BOGW data in Colleague and store the log of the transaction in a new table XCTC.BOGW.Write
X.CCCTC.CCC.ID.UPDATE1.3TransactionSet the CCC ID of a student. Will only assign the student a CCC ID if they do not have one and no other student has the given CCC ID.Write
X.CCCTC.CHECK.PREREQ1.0Transaction

Check a prerequisite and return whether the pre-requisite has been completed or not. If the pre-requisite is not complete, it will also return a message indicating why.

ReadS.EVALUATE.REQUISTE.COURSES
X.CCCTC.COHORT.ASSIGNMENT1.1TransactionAdd or remove student from a cohort. Used to flag Course Exchange students for a term.Write
X.CCCTC.ENROLL.STUDENT1.0Transaction

Attempt to enroll a student in a section. If the enrollment is not successful, messages will be returned indicating why.

WriteI_DYN.ARRAY.REG.PARAMS.EQUATES
S.READ.REG.USERS
S.READ.REG.CONTROLS
S.REG.STU.COURSE.SECTIONS
S_GET_HELPMSG 
X.CCCTC.EVAL.RULE1.0TransactionEvaluate rule(s) and return true/false indicating whether the rule(s) passed. If the rule(s) did not pass, messages will be returned indicating why.Read

I_EVALUATE.RULES (calls S.EVALUATE.RULES)

X.CCCTC.FA.ADDITIONAL.CRED1.1TransactionManage Additional FA CredWrite

S.FA.GET.ADDITIONAL.CREDITS
S.FA.UPDATE.ADDITIONAL.CREDITS

X.CCCTC.STUDENT.BALANCE1.0TransactionGet the account balance for the student. Depending on whether a term is passed in, this will get their overall account balance or the balance for a term.ReadS.GET.AR.ACCT.BALANCE
X.CCCTC.VERSION.CE1.2TransactionReturns the version of Course Exchange code deployedRead
XCTC.BOGW1.1TableAudit table that stores BOG Fee Waiver data that has been sent to X.CCCTC.BOGW.UPDATE. Contains all the BOG Fee Waiver data from the transaction, including some fields that do not have an explicit place in Colleague. Additionally, data that cannot be imported into Colleague because of an error or because the student already has a BOGW record for the year will be included in the table with a status code indicating that it could not be written.Write






CCC Assess




X.CCCTC.IMPORT.PLACEMENT1.2TransactionImport placement information from CCC Assess into Colleague.Write

XS.CCCTC.EVALUATE.PLACEMENT

XS.CCCTC.EVALUATE.PLACEMENT1.2SubroutineEvaluate placement information from CCC Assess and create non-course records and non-course equivalencies for the student.WriteS.UPDT.PST.TEST.REC,
S.EVAL.NON.CRS.EQUIV, S.CUSTOMIZE.STNC
XS.CCCTC.PLACEMENT.SUBR.TMPL1.2SubroutineSubroutine template to use for developing custom pre and post processing hooks for the CCC Assess import.Write
XCTCS001 (XCTCAP)1.2UI FormCCC Assess Import Parameters UI FormWrite
XCTC.PLACEMENT.IMPORT.METHODS1.2Val CodeVal Code - Method used when importing CCC Assess placement data

XCTC.PLACEMENT.IMPORT.TIMING1.2Val CodeVal Code - Timing of the user subroutine for CCC Assess

XCTC.PLACEMENT.STATUSES1.2Val CodeVal Code - Statuses associated with the import of data from CCC Assess into Colleague

XCTC.PLC.TRANSACTION1.2TableTable that contains the placement data from CCC Assess as well as the import status and error messages

XCTC.PLC.SUBJECT.AREA1.2TableTable that contains the placement data from CCC Assess as well as the import status and error messages

XCTC.PLC.PLACEMENT1.2TableTable that contains the placement data from CCC Assess as well as the import status and error messages

XCTC.PLC.COMPNT.CCCASSESS1.2TableTable that contains the placement data from CCC Assess as well as the import status and error messages

XCTC.PLC.COMPNT.MMAP1.2TableTable that contains the placement data from CCC Assess as well as the import status and error messages

XCTC.PLACMENT.SETUP1.2TableTable that contains the setup information maintained on XCTCAP

...