Available APIs and Functionality

Note: This article documents a system which is coded to use abbreviations for legacy terms "Traditional and Nontraditional" as part of its support for other integrations which may still be using these object names in code. As such the documentation below documents the original purpose of these objects. As integrations are updated or migrated across LETU these object names will be either updated or eliminated as appropriate

 

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

User Profile

Similar to APIs, LETU passes over certain information for each user when they log in through Single Sign On (SSO).  This information is:

  • FirstName - "Joseph"
  • LastName - "Jones"
  • FullName - "Joseph Jones"
  • Email - "JosephJones@letu.edu"
  • StudentID (this is the user's CX ID regardless if they are a student or not) - "1234567"

If an element of the User Profile is 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 short answer field on the form, clicking on Advanced in the upper right, then:

  • Select Prefill under Field Type
  • Select User Profile under Prefill Source
  • Select the field from the user profile you want the field to prepopulate with under Prefill with

Academic Terms by Date

Returns the past, current, and next session and year for a given date.
Input setting: 'I will enter this value'
Inputs (optional): Academic Date - by leaving blank, it will use today's date, or the date that the form is being filled out
Fields In the Return (with examples):

  • Previous Session - "SP"
  • Previous Session's Year - "2023"
  • Current Session - "SU"
  • Current Session's Year - "2023"
  • Next Session - "FA"
  • Next Session's Year - "2023"

Academic Terms by Date (Copy)

Returns a list of the current and next session/year for a given date.
Input setting: 'I will enter this value'
Inputs (optional): Academic Date - by leaving blank, it will use today's date, or the date that the form is being filled out
Fields In the Return (with examples):

  • sess_year - "FA2023", "SP2024

Active AA Rec

Returns information from the aa_rec for a given LETU faculty/staff/student using the aa code provided that do not have an end date.
Input setting (recommended):

  • Id - 'Get from user profile'
  • AACode - 'I will enter this value'

Inputs:

  • Id - StudentID (which will be the CX ID number when they log in)
  • AACode - possible options:
    • CPOA - Address with CPO
    • EML1 - Primary email address (LETU email address if LETU constituent)
    • PERM - Permanent Address
    • XPCL - Cell phone at primary address

Fields In the Return (with examples):

  • Id - "1234567"
  • AA - "PERM"
  • Line1 - "The Manor"
  • Line2 - "1700 21st Avenue W"
  • Line3 -  "Apt 423"
  • AllLines - "The Manor1700 21st Avenue WApt 423"
  • AllLinesSep - "The Manor 1700 21st Avenue W Apt 423"
  • City - "Center City"
  • State - "WA"
  • Zip - "65432"
  • Phone  - "713-555-0375"
  • PhoneExt - ""

Active Advisors

Returns information about the advisor(s) for a given LETU student.
Input setting (recommended):

  • StudentId - 'Get from user profile'
  • AdvisorType- 'I will enter this value'

Inputs:

  • StudentId - StudentID (which will be the CX ID number when they log in)
  • AdvisorType - possible options:
    • PRIM - Primary Advisor
    • EO - Enrollment Officer
    • FAID - Financial Aid Advisor
    • STAC - Student Accounts Advisor
    • INTL - International Advisor   

Fields In the Return (with examples):

  • AdvisorId - "9876541"
  • AdvisorDesc - "Enrollment Officer"
  • AdvisorFullname - "Smith, Joseph"
  • AdvisorFirstName - "Joseph"
  • AdvisorLastName -  "Smith"
  • AdvisorEmail - "JosephSmith@letu.edu"
  • CondRouting - "Joseph|Smith|JosephSmith@letu.edu" {can be used for the Conditional Routing functionality in Dynamic Forms}
  • StudentId - "1234567"
  • AdvisorType - "EO"

Active Chairs

Returns all active Chairs and Subject Matter Experts (SMEs) along with their department information as defined and maintained by the Registrar's Office.
Value Field (recommended): CondRouting (if using the dropdown to route to the Chair)
Description Field (recommended): FullName_Dept
Fields In the Return (with examples):

  • ChairId - "8724682"
  • ChairFullname - "Jones, Joanna"
  • ChairFirstname - "Joanna"
  • ChairLastname - "Jones"
  • ChairEmail - "JoannaJones@letu.edu"
  • DeptCode - "CSCI"
  • DeptDesc - "Comp Sci Chair/SME-Resid"
  • Fullname_Dept - "Jones, Joanna (Comp Sci Chair/SME-Resid)"
  • Condrouting - "Joanna|Jones|JoannaJones@letu.edu|CSCI"

Active Deans

Returns all active Deans along with their department information as defined and maintained by the Registrar's Office.
Value Field (recommended): CondRouting (if using the dropdown to route to the Chair)
Description Field (recommended): FullName_Dept
Fields In the Return (with examples):

  • DeanId - "8724682"
  • Fullname - "Jones, Joanna"
  • Firstname - "Joanna"
  • Lastname - "Jones"
  • Email - "JoannaJones@letu.edu"
  • DeptCode - "PSYC"
  • DeptDesc - "Psychology and Counsel"
  • Fullname_Dept - "Jones, Joanna (Psychology and Counsel)"
  • Condrouting - "Joanna|Jones|JoannaJones@letu.edu|PSYC"

Active Financial Funds

Returns all active Funds as a part of the General Ledger as defined by the Accounting Office.
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

Returns all active Functions as a part of the General Ledger as defined by the Accounting Office.
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 Financial Objects

Returns all active Objects as a part of the General Ledger as defined by the Accounting Office.
Input setting: 'I will enter this value'
Inputs (optional): Objects (entering an object number in this field could restrict the drop-down to a single object option if desired)
                              Leaving the Input field blank will return all active objects as defined by the Accounting Office.
                              NOTE: do not but spaces in this field as it will return the valid option of a blank object
Value Field (recommended): Object
Description Field (recommended): Object Description (ex. "7633 - Travel/Meal-Recru/Guest")
Fields In the Return (with examples):

  • Object - "7633"
  • Description - "Travel/Meal-Recru/Guest"
  • Object Description - "7633 - Travel/Meal-Recru/Guest"
  • Primary responsible ID - "0"
  • Primary responsible name - "" {forced blank as of this writing}
  • Secondary responsible ID - "0"
  • Secondary responsible name - "" {forced blank as of this writing}
  • Third responsible ID - "0"
  • Third responsible name - "" {forced blank as of this writing}

Active Financial Projects

Returns all active Projects as a part of the General Ledger as defined by the Accounting Office.
Input setting: 'I will enter this value'
Inputs (optional): Projects (entering an object number in this field could restrict the drop-down to a single project option if desired)
                              Leaving the Input field blank will return all active projects as defined by the Accounting Office.
                              NOTE: do not but spaces in this field as it will return the valid option of a blank project
Value Field (recommended): Project
Description Field (recommended): Project Description (ex. "800 - FASB T/R")
Fields In the Return (with examples):

  • Project - "800"
  • Description - "FASB T/R"
  • Project Description - "800 - FASB T/R"
  • Primary responsible ID - "1994200"
  • Primary responsible name - "" {forced blank as of this writing}
  • Secondary responsible ID - "1994600"
  • 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

Returns all active departments as defined by the Human Resources Office.
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 Divisions

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

  • Division Code - "IT"
  • Division Description - "Information Technology"
  • Cabinet Code - "FINA"

Active (HR) Cabinets

Returns all active cabinets as defined by the Human Resources Office.
Input setting: 'I will enter this value'
Inputs (optional): CabinetCode (entering a cabinet code in this field could restrict the drop-down to a particular cabinet if desired)
                              Leaving the Input field blank will return all active divisions as defined by the Human Resources Office
                              NOTE: do not but spaces in this field
Value Field (recommended): Cabinet Code
Description Field (recommended): Cabinet Desc
Fields In the Return (with examples):

  • Cabinet Code - "COMM"
  • Cabinet Description - "Communications & Marketing"
  • Display1 - "(COMM)  Communications & Marketing"
  • Display2 - "COMM - Communications & Marketing"
  • Display3 - "Communications & Marketing  (COMM)"
  • Display4 - "Communications & Marketing - COMM"

Active (HR) 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.
Value Field (recommended): CondRouting (if using the dropdown to route to the cabinet member)
Description Field (recommended): FullName_Dept
Fields In the Return (with examples):

  • Id - "4567891"
  • Fullname - "Smith, Josephine"
  • Firstname - "Josephine"
  • Lastname - "Smith"
  • Email - "JosephineSmith@letu.edu"
  • CabinetCode - "FINA"
  • CabinetDesc - "Finance & Administration"
  • Fullname_Dept - "Smith, Josephine (Finance & Administration)"
  • Condrouting - "Josephine|Smith|JosephineSmith@letu.edu|FINA"

Active HR Departments / Division / Cabinets

Returns all active departments as defined by the Human Resources Office, along with their Division and Cabinet information.
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"

Active Majors

Returns a list of all the active majors in CX.  Does not have any input parameters.
Value Field (recommended): MajorCode
Description Field (recommended): Code_Description (ex. "AAAS  -  BS Aviation Maint Sci")
Fields In the Return (with examples):

  • MajorCode - "AAAS"
  • Description - "BS Aviation Maint Sci"
  • CIP_No - "15.0801"
  • ​​​Department - "AVTC",​​​​
  • Program - "UNDG"
  • Category - "Aircraft Systems"
  • SubCategory - ""
  • ProgramType - "T"
  • JXProgramType - "TMAIN"
  • Code_Description - "AAAS  -  BS Aviation Maint Sci"

Active Majors

Returns a list of all the active minors in CX.  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 - "ACCT"
  • Description - "Accounting"
  • CIP_No - "52.0301"
  • ​Code_Description - "ACCT  -  Accounting"

Course Info

Returns information about a particular course section in a given session/year.  Typically used as a postback API.
Input setting (recommended):

  • Course Number - 'Get the value when the user fills out the form'
  • Section Code - 'Get the value when the user fills out the form'
  • Course Session - 'I will enter this value'
  • Course Year - 'I will enter this value'

Inputs:

  • Course Number - {select the field that holds the course number on the form}
  • Section Code - {select the field that holds the section number on the form}
  • Course Session - {enter the semester to use; options: options - FA, SP, SU}
  • Course Year - {enter the year to use in YYYY format}

Fields In the Return (with examples):

  • CourseNumber - "PSYC4903"
  • SectionCode - "A"
  • CourseDescription - "APA and Original Research"
  • CourseSectionTitle - "PSYC4903-A - APA and Original Research"
  • CourseProgram - "UNDG"
  • CourseSession - "FA"
  • CourseYear - "2022"
  • CreditHours - "3.0"
  • FacultyID - "2094484"
  • NumberRegistered - "9"
  • MaxRegistrations - "20"
  • BeginDate - "2022-10-31"
  • EndDate - "2022-12-11"
  • CourseInWeeks - "5"

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 - 

Enterprise Person Info Lite

Translates a few of the fields from Enterprise Person to allow for new data without changing the backend information.
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):

  • Last Name - "Smith"
  • First Name - "Jane"
  • Middle Name - "Elisabeth"
  • Is International - "0"  {Same logic as EnterprisePerson but uses 0 instead of 'N' and 1 instead of 'Y'}
  • has Citizenship - "Y" {if Citizenship Code in EnterprisePerson is not blank then 'Y' else 'N'}
  • ID - "3159871"

Exam History

Returns past testing dates for a given exam code and location.
Input setting (recommended): 'I will enter this value'
Inputs: ExamCode (required; options: PREPEXAM, IELTS{deprecated})
             LocationName (optional; options: Austin, Bedford, Dallas, McKinney, El Paso, Houston, Longview)
Fields In the Return (with examples):

  • Exam Date Id - "485"
  • Exam Code - "PREPEXAM"
  • Exam Desc - "Teacher preparation exam"
  • Location Name - "Houston"
  • Exam Start - "2021-05-20 17:00:00.0"
  • Exam Start Dateonly - "2021-05-20"
  • Exam End - "2021-05-20 22:00:00.0"
  • Exam End Dateonly - "2021-05-20"
  • Reg Cutoff - "2021-05-18 09:00:00.0"
  • Reg Cutoff Dateonly - "2021-05-18"
  • Registered - "0"
  • Exam Fee - "0.00"
  • Exam Fee And Start Date - "0.00 | 05-20-2021"
  • DF Primary Key - "485"

Exam Locations

Returns testing locations for a given exam code.
Input setting (recommended): 'I will enter this value'
Inputs: ExamCode (required; options: PREPEXAM, IELTS{deprecated})
Fields In the Return (with examples):

  • Location Id - "6"
  • Location Name - "Houston"
  • Exam Code - "PREPEXAM"

Exam Testing Dates

Returns testing dates with a future registration cut off datetime for a given exam code and location.
Input setting (recommended): 'I will enter this value'
Inputs: ExamCode (required; options: PREPEXAM, IELTS{deprecated})
             LocationName (optional; options: Austin, Bedford, Dallas, McKinney, El Paso, Houston, Longview)
Fields In the Return (with examples):

  • Exam Date Id - "485"
  • Exam Code - "PREPEXAM"
  • Exam Desc - "Teacher preparation exam"
  • Location Name - "Houston"
  • Exam Start - "2023-05-20 08:00:00.0"
  • Exam Start Dateonly - "2023-05-20"
  • Exam Start Display - "05-20-2023 (Saturday)  8:00 AM"
  • Exam End - "2023-05-20 13:00:00.0"
  • Exam End Dateonly - "2023-05-20"
  • Exam End Display - "05-20-2023 (Saturday)  1:00 PM"
  • Reg Cutoff - "2023-05-17 23:59:59.0"
  • Reg Cutoff Dateonly - "2023-05-17"
  • Reg Cutoff Display  - "05-17-2023 (Wednesday)  11:59 PM"
  • Registered - "0"
  • Exam Fee - "0.00"
  • Exam Fee And Start Date - "0.00 | 05-20-2023"
  • DF Primary Key - "636"

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 Information Extended

Returns information for a given faculty member. Differs from the above in that it doesn't require the faculty member to be in CMAP, but does include the information if it exists.
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 - ""
  • CMAP Trad Rank Title - ""
  • CMAP Nontrad Rank Title - ""
  • Faculty Record Title - "Assistant Professor & Chair, Computer Science"
  • Faculty Record Rank - "AT"
  • Faculty Record Rank Description - "Assistant Professor"
  • Faculty Record Comment 1 - ""
  • Faculty Record Comment 2 - ""
  • Faculty Record Comment (a combination of 1 and 2) - ""

Open Courses

Returns information for open courses (sec_rec.stat = 'O' or 'R') for the current semester.  Does not include DUAL courses.
Value Field (recommended): CourseSectionTitle
Description Field (recommended): CourseSectionTitle (ex. "ACCT2103-A - Principles Financial Accounting")
Fields In the Return (with examples):

  • Course Number - "ACCT2103"
  • Section Number - "A"
  • Course Title - "Principles Financial Accounting"
  • ​Course Section Title - "ACCT2103-A - Principles Financial Accounting"
  • Faculty ID - "3125556"
  • Faculty Full Name - "Smith, Joseph L"
  • Faculty Email - "JoeySmith@letu.edu"
  • Routing - "Joseph|Smith|JoeySmith@letu.edu"
  • Begin Date - "05/08/2023"
  • DF Primary Key (CourseNumberCatalogYearSessionSectionNumber) - "ACCT2103UG222023SUA"

Session Courses

Returns information for sections for the current and next semester.

If being used as a dropdown - 
Criteria:

  • CanvasCourseID - 'I will enter this value' - {leave blank}
  • DFPrimaryKey - 'I will enter this value' - {leave blank}
  • SessYr - either 'Get the value when the user fills out the form' or 'I will enter this value' - form field or hard-coded value

Value Field (recommended): DFPrimaryKey
Description Field (recommended): CourseSectionTitle (ex. "ACCT2103-01 - Principles Financial Accounting (FA2023)")

If being used as a postback API to populate information on the section - 

Criteria:

  • CanvasCourseID - 'I will enter this value' - {leave blank}
  • DFPrimaryKey - 'Get the value when the user fills out the form' - form field
  • SessYr - 'I will enter this value' - {leave blank}


Fields In the Return (with examples):

  • CourseNumber - "ACCT2103"
  • SectionNumber - "01"
  • CourseTitle - "Principles Financial Accounting"
  • CourseSectionTitle - "ACCT2103-01 - Principles Financial Accounting (FA2023)"
  • FacultyID - "2075864"
  • FacultyFullname - "Rowe, Beverly Jean"
  • FacultyEmail - "BeverlyRowe@letu.edu"
  • SectionBeginDate - "08/21/2023"
  • SectionSession - "FA"
  • SectionYear - "2023"
  • DFRouting - "Beverly|Rowe|BeverlyRowe@letu.edu"
  • CanvasCourseID - "2023_FA_ACCT2103_0_01_R"
  • DFPrimaryKey - "ACCT2103UG232023FA01"

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 - ""
  • Department Code - "COSC" {This is the department that the student's major1 is in}
  • Department Description - "Computer Science"
  • Division Code - "ARSC" {This is the division that the student's major1 is in}
  • Division Description - "Arts and Sciences"
  • College Code - "CEAS" {This is the college that the student's major1 is in}
  • College Description - "College of Education, Arts, and Sciences"
  • 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}
  • Entry Type Code - "T"
  • Entry Type Description - "Transfer Student"

Students in Course

Built to work in conjunction with Faculty Courses API.  To be used as a Postback API built in the Events section of the form.  Can be used to be used to populate multiple records on the form, not just one.
Action: 'Pull form values real-time by API calls while filling out form'
Criteria: DFPrimaryKey - 'Get the value when the user fills out the form'
               Select the field that contains the DFPrimaryKey from the Faculty Courses API
Fields in the Return (with examples):

  • CourseNumber - "MEGR2122"
  • SectionNumber - "01"
  • SectionSession - "FA"
  • SectionYear - "2022"
  • StudentID - "4256816"
  • StudentFullname - "Perez, Claudia J"
  • StudentEmail - "ClaudiaPerez@letu.edu"
  • StudentProg - "UNDG"
  • StudentSubProg - "TU"
  • StudentMaj1 - "BSME"
  • StudentMaj1Desc - "Mechanical Engr"
  • StudentMaj2 - ""
  • StudentMaj2Desc - ""
  • DFPrimaryKey - "MEGR2122UG222022FA01"

Student Worker Positions

Returns student worker positions and the information regarding them as defined by the Human Resources/Payroll Office.  Can be used for drop-down or postback API.
Input setting: 'I will enter this value'
Inputs (optional): DepartmentCode (entering a department code in this field could restrict the drop-down to positions of a particular departments if desired)
                              DivisionCode (entering a division code in this field could restrict the drop-down to positions of a particular division if desired)
                              CabinetCode (entering a cabinet code in this field could restrict the drop-down to positions 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): Position (or Dept_Code_Position ​​​​​​)
Description Field (recommended): Dept_Code_Position (ex. "ACCS | Accounting Clerk")
Fields In the Return (with examples):

  • Position - "Accounting Clerk"
  • FWS eligible - "Y"
  • Classification - "D"
  • HRDept - "ACCS"
  • HRDept Description - "Accounting Services"
  • HRDiv - "FINS"
  • HRDiv Description  - "Financial Services"
  • HRCab - "FINA"
  • HRCab Description  - "Finance & Administration"
  • Dept Code Position - "ACCS | Accounting Clerk"
  • Dept Name Position - "Accounting Services | Accounting Clerk"
  • DF Primary Key - "4"

Valid Accounts

Returns information related to active Budget Officer or agency accounts for Accounting.
Input setting: 'I will enter this value'
Inputs (optional): ID (entering an object number in this field could restrict the drop-down to a single account option if desired)
                              Title (options: BOID, AGCY)
                              Leaving the Input field blank will return all active accounts as defined by the Accounting Office.
Value Field (recommended): Id
Description Field (recommended): Id_Fullname (ex. "1999106 - ACM-ASSOC COMPUTING MACH")
Fields In the Return (with examples):

  • ID - "1999106"
  • Fullname - "ACM-ASSOC COMPUTING MACH"
  • ID_Fullname - "1999106 - ACM-ASSOC COMPUTING MACH"
  • Title - "AGCY"
  • DF Primary Key - "1999106" 

Valid Agency Accounts

Returns information related to active agency accounts for Accounting.
Input setting: 'I will enter this value'
Inputs (optional): ID (entering an object number in this field could restrict the drop-down to a single account option if desired)
                              Leaving the Input field blank will return all active accounts as defined by the Accounting Office.
Value Field (recommended): Id
Description Field (recommended): Id_Fullname (ex. "1999106 - ACM-ASSOC COMPUTING MACH")
Fields In the Return (with examples):

  • ID - "1999106"
  • Fullname - "ACM-ASSOC COMPUTING MACH"
  • ID_Fullname - "1999106 - ACM-ASSOC COMPUTING MACH"
Print Article