Interfolio API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

Classes

Type aliases

Variables

References

default

Renames and exports FormApi

Type aliases

Form

Form: { canAdminister: boolean; currentVersion: FormVersion; description: string; id: number; responseCount: number; title: string; unitId: number }

Type defining a Form

Type declaration

  • canAdminister: boolean

    flag indicating if the current user can administer the form

  • currentVersion: FormVersion

    the current version of the form

  • description: string

    the description of the form including html styling elements (e.g.

    description text

    )

  • id: number

    id uniquely identifying the form

  • responseCount: number

    the number of response to this form

  • title: string

    the title of the form

  • unitId: number

    the unit_id of the unit this form belongs to

FormField

FormField: { field_type: string; id: string; label: string; meta: { maxlength?: number; options?: { label: string; value: string | number }[]; schema?: { field_type: string }[]; type: string }; name: string; required: boolean }

Type defining the form field

Type declaration

  • field_type: string

    the type of field (e.g. text, collection, select)

  • id: string

    id of the field (e.g. q1_text_99999)

  • label: string

    label for the question

  • meta: { maxlength?: number; options?: { label: string; value: string | number }[]; schema?: { field_type: string }[]; type: string }

    additioanl data about the field

    • Optional maxlength?: number
    • Optional options?: { label: string; value: string | number }[]
    • Optional schema?: { field_type: string }[]
    • type: string
  • name: string

    name of the field (similar to id)

  • required: boolean

    flag indicating the field is required

FormListing

FormListing: { associationsCount: number; canAdminister: boolean; description: string; id: number; slug: string; tenantId: number; title: string; unitId: number; unitName: string }

Listing returned from the getForms call

Type declaration

  • associationsCount: number

    The number of associations this form has

  • canAdminister: boolean

    if the current user can administer this form

  • description: string

    description of form including html tags

  • id: number

    id uniquely identifying this form

  • slug: string

    slug for the form

  • tenantId: number

    tenant id for the form

  • title: string

    title of the form

  • unitId: number

    unitId of the form

  • unitName: string

    unit name of the form

FormListingSummary

FormListingSummary: { form_type: string; id: number; name: string }

Type declaration

  • form_type: string

    Type of the form [case_data_form/committee_form/cand0date)form]

  • id: number

    ID of the form

  • name: string

    Name of the form

FormResponse

FormResponse: { createdAt: string; createdBy: number; id: number; originId: number; originType: "PacketCommitteeForm"; responseData: {}; submitted: boolean; updatedAt: string; updatedBy: number }

Type representing responses to platform forms

Type declaration

  • createdAt: string

    Date the response was created

  • createdBy: number

    user id of the user who submitted the response

  • id: number

    id of the form response

  • originId: number

    origin id referencing the assignment of this form to the user

  • originType: "PacketCommitteeForm"

    Type of form e.g. PacketCommitteeForm

  • responseData: {}

    The actual question answers

    • [questionKey: string]: string | number | {}[]
  • submitted: boolean

    if the form has been submitted

  • updatedAt: string

    the date the form response was updated

  • updatedBy: number

    user id of the user who updated the response

FormVersion

FormVersion: { id: number; versionData: { description: string; fieldsets: { fields: FormField[]; id: string }[]; id: string; name: string } }

Type defining the form version

Type declaration

  • id: number

    id uniquely identifying the form version

  • versionData: { description: string; fieldsets: { fields: FormField[]; id: string }[]; id: string; name: string }
    • description: string

      the description of the form including html styling elements (e.g.

      description text

      )

    • fieldsets: { fields: FormField[]; id: string }[]

      array of fieldsets for this form. main form fields contained in fieldset[0]

    • id: string

      id uniquely identifying this version in the form of Name_of_form_12345666

    • name: string

      the name of the form

Variables

Const FORM_URL

FORM_URL: string = ...

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc