Available APIs and Functionality

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 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}

Faculty Courses

Returns courses for a given faculty member for the current semester.
Input setting (recommended): 'Get from user profile'
Inputs (required): Faculty ID number
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 - "Wooden, Bradley Steven"
  • Faculty Email - "BradWooden@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) - "Bradley|Wooden|BradWooden@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): Faculty ID number
Fields In the Return (with examples):

  • Faculty ID - "922127"
  • Faculty Full Name - "Wooden, Bradley Steven"
  • 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) - ""

Details

Article ID: 136908
Created
Wed 3/2/22 12:02 PM
Modified
Tue 7/26/22 12:07 PM