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

Class representing calls to the form API (uses graphql endpoints)

Hierarchy

  • FormApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • Constructor for the object

    Parameters

    • config: ApiRequest | ApiConfig

      Configuration for API calls - of type either ApiConfig or ApiRequest

      note pass in ApiRequest to keep all errors in one object instance

    Returns FormApi

Properties

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

createForm

  • createForm(__namedParameters: { description: string; title: string; unitId: number }): Promise<number>

  • Create a new custom form for committees

    expample
    let formId = await api.Tenure.Forms.createForm({title: 'Test form', description: 'Test form Description', unitId: 9999});

    Parameters

    • __namedParameters: { description: string; title: string; unitId: number }
      • description: string

        description of the form

      • title: string

        title of the form

      • unitId: number

        id of the unit this form is related to

    Returns Promise<number>

deleteForm

  • deleteForm(__namedParameters: { id: number }): Promise<boolean>

  • Delete the Form (not yet available via API call

    example
    let deleted = api.Forms.deleteForm({id: 9999});

    Parameters

    • __namedParameters: { id: number }
      • id: number

    Returns Promise<boolean>

findCommitteeForm

  • findCommitteeForm(__namedParameters: { title: string; unitId: number }): Promise<FormListing>

  • Find a Commmittee form in a particular unit

    Parameters

    • __namedParameters: { title: string; unitId: number }
      • title: string
      • unitId: number

    Returns Promise<FormListing>

getForm

  • getForm(__namedParameters: { id: number }): Promise<Form>

getFormResponses

  • getFormResponses(__namedParameters: { formId: number; originId: number; originType: string }): Promise<FormResponse[]>

  • Get the responses that have been submitted for a form

    Parameters

    • __namedParameters: { formId: number; originId: number; originType: string }
      • formId: number

        id of the overall form

      • originId: number

        id of the form instance assigned to a workflow step

      • originType: string

        type of Origin "PacketCommitteeForm"

    Returns Promise<FormResponse[]>

getFormSummaryList

Legend

  • Class
  • Constructor
  • Property
  • Method
  • Variable
  • Function
  • Type alias

Generated using TypeDoc