Configure External API Form Fields

The user is prompted to configure an external API field once added to a form. There are multiple tabs (i.e., Details, Data, API, Display) within the Configuration screen that help define the field's actions and purpose.

Note: The configurations set for these fields may differ based on how they are expected to be used (e.g., eligibility).

  1. In the Configuration screen, select the Details tab.

  2. Update the label, if desired. By default, the label is the same as the name of the field.

  3. Select the web service.

    Note: For more information, see the Configure API Web Services resource.

  4. Choose the corresponding Response Field from the web service as the Param name.

  5. Specify the display type (e.g., Text field, Text area, Raw).

    Tip: Fields being used for eligibility should not be set as Raw.

  6. Provide a brief description.

  7. Determine the tab index.

  8. Specify if an external API response should be required in order to submit.

    Note: Enabling this option means that the form cannot be submitted unless this field has a response in it from the API.

  9. Determine if the field will be visible to Applicants or Grant Managers.

    Note: If these options are left unchecked, then they will be hidden from these users.

  1. In the Configuration select, select the Data tab.

  2. Select the option from the Form field source field that will control when this field calls the API to get data based on another field in the form.

  3. In the Data updates field, specify the applicable method for updating:

    • Component field data will be locked in at form submission. Field data is available for reporting and conditional logic.

      Note: This option is used when the data is static and should be saved to the database and made available for reporting. It will not update to new values after submission.

    • Component field data will be updated when the form is viewed. Field data is not available for reporting or conditional logic.

      Note: This option is used when the data is dynamic and should update based on the API call every time the form is accessed or viewed. The data is not saved to the database. Likewise, data for fields with this setting will not be available for download, reporting, or conditional logic.

  1. In the Configuration screen, select the API tab.

  2. Update the property name as desired.

    Tip: This value defaults to the form field type. It can be updated to a unique form key instead.

By default, fields are set to always be displayed. These settings can be customized based on the scenario.

  1. In the Configuration screen, select the Display tab.

  2. Specify if the value should be cleared when hidden.

  3. Determine when to display the field (e.g., Always show component).

  4. Add conditional logic, if desired.