Contents
Overview
This article serves as a assistance to using the APIs available to form designers of Dynamic Forms.
If APIs are being used to prepopulate fields on the form as it is being pulled up by the end user, the following set up can be configured by selecting the desired field on the form, clicking on Advanced in the upper right, then:
- If a short answer field:
- Select Prefill under Field Type
- Select API under Prefill Source
- Select the API you want to use under Dataset
- Select the field from that API you want the field to prepopulate with under Prefill with
- If a dropdown/choice list field:
- Click on the API button by Items
- Select Letourneau as the School
- Select the API you want to use under Dataset
Active Academic Programs
Returns a list of programs (from acad_programs) without an end date and where the student select flag is set to 'Yes'.
Inputs (optional) : AcadProg (in order to return additional information regarding the program into other fields)
Value Field (recommended): ProgramCode
Description Field (recommended): DescProgCode
Fields In the Return (with examples):
- ProgramCode: "COSC.GDEV.BS.ONC"
- ProgramDescription: "Computer Science, B. S., Game Development Concentration"
- Major: "COSC"
- Specialization: "GDEV"
- CIPNo: "11.0899"
- Department: "COSC"
- Division: "ARSC"
- Level: "UG"
- Degree: "BS"
- MajorCodeDescription: "COSC - Computer Science, B. S., Game Development Concentration"
- ProgramCodeDescription: "COSC.GDEV.BS.ONC - Computer Science, B. S., Game Development Concentration"
- DescProgCode: "Computer Science, B. S., Game Development Concentration (COSC.GDEV.BS.ONC)"
Active Advisors
Returns information about the advisor(s) for a given LETU student. Looks at the advisement, counselor and fa_counselor tables.
Input setting (recommended):
- StudentID - 'Get from user profile'
- AdvisorType- 'I will enter this value'
Inputs:
- StudentID - StudentID (which will be the Colleague ID number when they log in)
- AdvisorType - possible options:
- PRI - Primary Advisor
- SEC - Secondary Advisor
- ATH - Athletic
- FAID - Financial Aid Advisor
- STAC - Student Accounts Advisor
- INTL - International Advisor
- HON - Honors College
Fields In the Return (with examples):
- studentid: "0052606"
- advisorid: "1234567"
- advisortype: "FAID"
- advisordesc: "Financial Aid Counselor"
- advisorfullname: "Stanley, Jennifer"
- advisorfirstname: "Jennifer"
- advisorlastname: "Stanley"
- advisorletuemail: "JenniferStanley@letu.edu"
- dfrouting: "Jennifer|Stanley|JenniferStanley@letu.edu"
Active Cabinet Members
Returns all active cabinet members as defined by the Human Resources Office, along with their Cabinet information. Typically used in routing to cabinet members. Determined based on the Alt ID field populated in the departments table. Does not have any input parameters.
Value Field (recommended): DFRouting (if using the dropdown to route to the cabinet member)
Description Field (recommended): CabinetMemFullName_Cab
Fields In the Return (with examples):
- CabinetMemID: "2345678"
- CabinetMemFullName: "Thaxton, Deron"
- CabinetMemFirstName: "Deron"
- CabinetMemLastName: "Thaxton"
- CabinetMemEmail: "deronthaxton@letu.edu"
- CabinetCode: "FNAD"
- CabinetDesc: "Finance & Admin"
- CabinetMemFullName_Cab: "Thaxton, Deron (Finance & Admin)"
- DFRouting: "Deron|Thaxton|deronthaxton@letu.edu"
Active Chairs
Returns all active Chairs along with their department information as defined and maintained by the Registrar's Office. Determined based on the Dean field populated in the departments table. Does not have any input parameters.
Value Field (recommended): DFRouting (if using the dropdown to route to the Chair)
Description Field (recommended): FullName_Dept
Fields In the Return (with examples):
- ChairID: "3456789"
- ChairFullName: "Lewis, Eveline"
- ChairFirstName: "Eveline"
- ChairLastName: "Lewis"
- ChairLETUEmail: "evelinelewis@letu.edu"
- DeptCode: "BUSI"
- DeptDesc: "Business"
- FullName_Dept: "Lewis, Eveline (Business)"
- DFRouting: "Eveline|Lewis|evelinelewis@letu.edu"
Active Deans
Returns all active Deans along with their department information as defined and maintained by the Registrar's Office. Determined based on the Dean field populated in the divisions table. Does not have any input parameters.
Value Field (recommended): DFRouting (if using the dropdown to route to the Chair)
Description Field (recommended): FullName_Div
Fields In the Return (with examples):
- DeanID: "4567890"
- DeanFullName: "Green, Matthew"
- DeanFirstName: "Matthew"
- DeanLastName: "Green"
- DeanLETUEmail: "MatthewGreen@letu.edu"
- DivCode: "ENGR"
- DivDesc: "Engineering and Engineering Tech"
- FullName_Div: "Green, Matthew (Engineering and Engineering Tech)"
- DFRouting: "Matthew|Green|MatthewGreen@letu.edu"
Active HR Departments
Returns all active departments as defined by the Human Resources Office. Does not have any input parameters.
Value Field (recommended): departmentcode
Description Field (recommended): dptdisplay
Fields In the Return (with examples):
- departmentcode: "BSM"
- departmentdesc: "IT-Business Systems Mgmnt"
- dptdisplay: "BSM | IT-Business Systems Mgmnt"
Active Minors
Returns a list of all the active minors in Colleague. Does not have any input parameters.
Value Field (recommended): Minor
Description Field (recommended): Code_Description (ex. "ACCT - Accounting")
Fields In the Return (with examples):
- Minor: "DTEC"
- Description: "Design Technology"
- CIP_No: "15.1301"
- Code_Description: "DTEC - Design Technology"
Active Phone Numbers
Returns active phones numbers for a given ID number
Input setting (recommended):
- ID - 'Get from user profile'
- Phone_Type- 'I will enter this value'
Inputs:
- ID - StudentID (which will be the Colleague ID number when they log in)
- Phone_Type - possible options:
- C Cell (mobile) phone
- B Business/Employment
- H Home/Permanent
- A Additional
- I Institutional/Campus
- P PO Phone
- F Fax Number
- ECCS Emerg alert cell phone
Fields In the Return (with examples):
- ID: "2566814"
- PhoneType: "C"
- PhoneNumber: "903-555-3865"
- PhoneExtension: ""
- TextAuth: ""
Course Section Info
Curr Term
Current Address
Demographic Info
Faculty Info
Student Courses by Term
Student Info
Student Info by Term