Available APIs and Functionality

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
    • 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 Financial Funds

Input setting: 'I will enter this value'
Inputs (optional): Fund (entering a fund number in this field could restrict the drop-down to a single fund option if desired)
                              Leaving the Input field blank will return all active funds as defined by the Accounting Office
                              NOTE: do not but spaces in this field as it will return the valid option of a blank function
Value Field (recommended): Fund
Description Field (recommended): FundDescription (ex. "10 - COF - Traditional")
Fields In the Return (with examples):

  • Fund number - "10"
  • Fund description - "COF - Traditional"
  • Fund number and description - "10 - COF - Traditional"
  • Primary responsible ID of the fund - "1994600"
  • Primary responsible name -: "" {forced blank as of this writing}
  • Secondary responsible ID of the fund - "1994600"
  • Secondary responsible name -: "" {forced blank as of this writing}
  • Third responsible ID - "0"
  • Third responsible name -: "" {forced blank as of this writing}

Active Financial Functions

Input setting: 'I will enter this value'
Inputs (optional): Functions (entering a function number in this field could restrict the drop-down to a single function option if desired)
                              Leaving the Input field blank will return all active functions as defined by the Accounting Office.
                              NOTE: do not but spaces in this field as it will return the valid option of a blank function
Value Field (recommended): Function
Description Field (recommended): FuncDescription (ex. "1043012 - ENG General Fund")
Fields In the Return (with examples):

  • Function number - "1043012"
  • Function description - "ENG General Fund"
  • Function number and description - "1043012 - ENG General Fund"
  • Primary responsible ID of the fund - "1991030"
  • Primary responsible name -: "" {forced blank as of this writing}
  • Secondary responsible ID of the fund - "1991031"
  • Secondary responsible name -: "" {forced blank as of this writing}
  • Third responsible ID - "0"
  • Third responsible name -: "" {forced blank as of this writing}

Active HR Departments

Input setting: 'I will enter this value'
Inputs (optional): DivisionCode (entering a division code in this field could restrict the drop-down to the departments of a particular division if desired)
                              Leaving the Input field blank will return all active departments as defined by the Human Resources Office
                              NOTE: do not but spaces in this field
Value Field (recommended): DeptCode
Description Field (recommended): DeptDesc
Fields In the Return (with examples):

  • Department code - "BSM"
  • Department Description - "Business Systems Management"
  • Division Code - "IT"

Active HR Departments / Division / Cabinets

Input setting: 'I will enter this value'
Inputs (optional): DepartmentCode (entering a department code in this field could restrict the drop-down to the departments of a particular division if desired)
                              DivisionCode (entering a division code in this field could restrict the drop-down to the departments of a particular division if desired)
                              CabinetCode (entering a cabinet code in this field could restrict the drop-down to the departments of a particular cabinet if desired)
                              DF_Primary_Key (OBSOLETE - do not enter anything in this field)
                              Leaving the Input fields blank will return all active departments as defined by the Human Resources Office
                              NOTE: do not but spaces in these fields
Value Field (recommended): DepartmentCode
Description Field (recommended): Div_Dpt_Display (ex. "IT  |  Business Systems Management")
Fields In the Return (with examples):

  • Department Code - "BSM"
  • Department Desc - "Business Systems Management"
  • Division Code - "IT"
  • ​​​Division Desc - "Information Technology",​​​​
  • Cabinet Code - "FINA"
  • Cabinet Desc - "Finance & Administration",​​​​​
  • Dept Display - "BSM  |  Business Systems Management"
  • Div Display - "IT  |  Information Technology"
  • Cab Display - "FINA  |  Finance & Administration"
  • Div Dpt Display - "IT  |  Business Systems Management"
  • DF Primary Key - "IT-BSM"

Enterprise Person

Returns a great deal of information for a given LETU faculty/staff/student.
Input setting (recommended): 'Get from user profile'
Inputs (optional): StudentID (which will be the Employee ID number if they log in)
Fields In the Return (with examples):

  • ID - "3159871"
  • Last Name - "Smith"
  • First Name - "Jane"
  • Middle Name - "Elisabeth"
  • eBridge Name (FullNameLFM) - "Smith, Jane Elisabeth" {This field is in the appropriate format used by various departments when uploading forms to eBridge}
  • Is Current Employee - "N" {This is determined by if the ID has a pers_rec/ employee record or not}
  • Is Current Admit - "Y"  {This is determined by if the student's admitted session/year is the current semester}
  • Current Admit Term - "2022FA"  {This is the semester that the student was admitted}
  • Current Admit Level - "FAR"  {This is the status that the student was admitted as}
  • Is Current Student - "Y"  {This is determined by an active, primary program enrollment record}
  • Current Student Level - "FR" {This is the student's class, i.e. FReshman, SOphomore, JR for junior and SR for Senior}
  • Current Student Term - "2022FA" {This is populated if the student is attending the current term}
  • Is Current Faculty - "N" {This is determined by if the ID has an instructor record for the current term}
  • Current Faculty Term - "2022FA" {This is populated if the ID has an instructor record for the current term}
  • Is Registered Current Term - "Y" {This is determined by if they have qualify student academic record for the current term}
  • Registration Level - "C" {This is the student's registration status on their student academic record for the current term}
  • Registration Term - "2022FA"
  • Registered Hours - "14.0" {This is the registered hours for the current term}
  • Preferred Name - "Lissie" {This is the name in the Alternate Name record, if it exists}
  • Prefix - "Ms"
  • Suffix - "Jr"
  • Birth Date - "10/28/2003"
  • Ethnicity Code -   "07"
  • Ethnicity Description -  "Other"
  • Marital Code - "S"
  • Marital Description - "Single"
  • Religion Code - "PR"
  • Religion Description - "Presbyterian"
  • Gender Code - "F"
  • Gender Description - "Female"
  • Confidentiality Ind - "PRNT" {This is the code that represents what the student has indicated for their FERPA disclosures}
  • Deceased Ind - "N"
  • Citizen Ind - "Y" {This is determined by if the ID has no citizenship or they have USA citizenship}
  • Deceased Date - "" {If the ID had the date that they died recorded in CX, it would be returned here}
  • Citizenship Code - "USA"
  • Citizenship Description - "UNITED STATES OF AMERICA"
  • Permanent Street Line 1 - "6623 E. Main St" {The Permanent Address components come from the address for the ID in the ID record, or the address in the AA record where the AA code is "PERM"}
  • Permanent Street Line 2 - 
  • Permanent Street Line 3 - 
  • Permanent City - "Bixby"
  • Permanent State Code - "TX"
  • Permanent Zip - "75704"
  • Permanent County Code - "GREG" {This is the residential county code in the ID's profile record}
  • Permanent Nation Code - "USA"
  • Permanent TelePhone - "9185048730" {This is the phone number in the ID record}
  • Cell phone - "9185048730" {This is the phone number for the AA record where the AA code is "XPCL"}
  • Local Street Line 1 - "6623 E. Main St" {The Local Address components come from the address in the AA record where the AA code is "LOC"}
  • Local Street Line 2 -
  • Local Street Line3 - 
  • Local City - "Bixby"
  • Local State Code - "TX"
  • Local Zip - "75704"
  • Local Nation Code - "USA"
  • Local Telephone - "9185048730" {This is the phone number for the AA record where the AA code is "XLCL"}
  • is NCAA athlete - "N" {This is determined by if the student has an ATHLETIC involvement record for the current semester}
  • using VA benefits - "N" {This is determined by if the student has the veteran benefits flag set in the program enrollment record} 
  • Is International - "N" {This is determined by if the ID has a visa code other than PR (permanent resident) or UNKN (unknown)}
  • Visa Code - 

Faculty Courses

Returns courses for a given faculty member for the current semester.
Input setting (recommended): 'Get from user profile'
Inputs (required): StudentID (which will be the Faculty ID number when they log in)
Value Field (recommended): depends on the needs of the dropdown
Description Field (recommended): CourseSectionTitle(ex. "AERF1132-01 - Primary Flight I(Private Pilot F")
Fields In the Return (with examples):

  • Course Number - "AERF1132"
  • Section Number - "01"
  • Course Title - "Primary Flight I(Private Pilot F"
  • Course Number - Section Number - Title - "AERF1132-01 - Primary Flight I(Private Pilot F"
  • Faculty ID - "922127"
  • Faculty Full Name - "Smith, Joe Professor"
  • Faculty Email - "JoeSmith@letu.edu"
  • Section Begin Date - "05/09/2022"
  • Section Session - "SU"
  • Section Year - "2022"
  • Dynamic Forms Routing field (used to route to the faculty member of the course if needed) - "Joe|Smith|JoeSmith@letu.edu"
  • Dynamic Forms Primary Key (CourseNumberCatalogYearSessionSectionNumber)- "AERF1132UG212022SU01"

Faculty Information

Returns information for a given faculty member.
Input setting (recommended): 'Get from user profile'
Inputs (required): StudentID (which will be the Faculty ID number when they log in)
Fields In the Return (with examples):

  • Faculty ID - "922127"
  • Faculty Full Name - "Smith, Joe Professor"
  • CMAP Rank ID - "7"
  • CMAP Trad Rank Title - "Associate Professor"
  • CMAP Nontrad Rank Title - "Adjunct Associate Professor"
  • Faculty Record Title - ""
  • Faculty Record Rank - "PF"
  • Faculty Record Rank Description - "Professor"
  • Faculty Record Comment 1 - ""
  • Faculty Record Comment 2 - ""
  • Faculty Record Comment (a combination of 1 and 2) - ""

Students (a.k.a. Academic Info)

Returns information for a given student.  The information is taken from the student's primary, active program enrollment record.
Input setting (recommended): 'Get from user profile'
Inputs (optional): StudentID
Fields In the Return (with examples):

  • Student ID - "3163617"
  • Program - "UNDG" 
  • Subprogram - "TU"
  • Degree Code - "BS"
  • Degree Description - "Bachelor of Science"
  • Major 1 Code - "CIS"
  • Major 1 Description - "BS Information Systems"
  • Major 2 Code - ""
  • Major 2 Description - ""
  • Minor 1 Code - "DASC"
  • Minor 1 Description - "Data Science Minor"
  • Minor 2 Code - ""
  • Minor 2 Description - ""
  • Planned grad - "SP2024"
  • Primary Advisor - "2081610"
  • Primary Advisor Description - "Hunt Sharleen Gail"
  • Faculty Advisor - ""
  • Faculty Advisor Description - ""
  • Financial Aid Representative - ""
  • Financial Aid Representative Description - ""
  • Student Accounts Representative - "3142573"
  • Student Accounts Representative Description - "Munguia Argueta Shery J"
  • Current Registered Hours - "3.0" {This is the registered hours for the current term}
  • Class - "JR" {This is the student's class, i.e. FReshman, SOphomore, JR for junior and SR for Senior}
  • Dorm room - "" {This is the residential information if it exists in the student services record}
  • Campus - "" {This is the campus information if it exists in the student services record}
  • Has Withdrawals - "N" {This is set based on if the student has any course work records that have been withdrawn for the current term}
  • Veteran Chapter - "" {This identifies the veteran's chapter with which the student is associated with}
  • Veteran Certification Location - "" {This is the veteran's benefits certification location, L for Longview, H for Houston}

Details

Article ID: 136908
Created
Wed 3/2/22 12:02 PM
Modified
Wed 1/11/23 11:49 AM