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

Class representing Report calls

Hierarchy

  • ReportApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

formReport

  • Retrieve form responses for a packet

    example
    let responses = await api.Tenure.Reports.formReport({
  form_id: 9999,
  form_type: "committee_form",
  packet_ids: [9999,9998,9997],
  limit: 100,
  page: 1
});

    Parameters

    Returns Promise<FormReportData>

formReportIndex

  • formReportIndex(__namedParameters: { endDate?: string; formId: number; formType: string; startDate?: string; unitIds: number[] }): Promise<FormReportIndex[]>

  • Get the list of packets that have a submitted form of the type specified

    Parameters

    • __namedParameters: { endDate?: string; formId: number; formType: string; startDate?: string; unitIds: number[] }
      • Optional endDate?: string

        end date to query before

      • formId: number

        id of the form type (caasbox_id)

      • formType: string

        form type (e.g. committee_form)

      • Optional startDate?: string

        start date to query after

      • unitIds: number[]

        unitIds to query from

    Returns Promise<FormReportIndex[]>

packetReport

  • Searches packets by provided criteria

    example
    let search = await api.Tenure.Reports.packetSearch({
 from: 0,
 size: 100,
 search_text: "Test Candidate",
 facets: {
   unit_names: ["Biology"]
 }
});

    Parameters

    Returns Promise<{ data: ReportPacket[]; total: number }>

Static getDefaultPacketReportParams

Static getFormReportValueFromColumnNames

  • getFormReportValueFromColumnNames(__namedParameters: { allColumnNames: string[]; matchColumnNames: string[]; tableCells: string[] }): string

  • Search through the tables cells and return the string in the column matched by any of the supplied headers

    Parameters

    • __namedParameters: { allColumnNames: string[]; matchColumnNames: string[]; tableCells: string[] }
      • allColumnNames: string[]
      • matchColumnNames: string[]
      • tableCells: string[]

    Returns string

Legend

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

Generated using TypeDoc