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

Index

References

Classes

Type aliases

Variables

References

default

Renames and exports ReportApi

Type aliases

FormReportData

FormReportData: { column_names: string[]; form_name: string; form_unit_name: string; limit: number; page: number; results: { packet_id: string; table_cells: string[] }[]; total_count: number }

Data returned from a form report

Type declaration

  • column_names: string[]

    the column names of the returned data

  • form_name: string

    the form name

  • form_unit_name: string

    the name of the unit this form is associated with

  • limit: number

    the max number of records returned

  • page: number

    the page that these records belong to

  • results: { packet_id: string; table_cells: string[] }[]

    the results of the form

  • total_count: number

    the total number of records available for the data queried

FormReportIndex

FormReportIndex: { candidate_email: string; candidate_first_name: string; candidate_last_name: string; candidate_name: string; id: number; unit_id: number; unit_name: string }

Type which is returned when querying for which packets have values in the report

Type declaration

  • candidate_email: string

    email of the candidate

  • candidate_first_name: string

    first name of the candidate

  • candidate_last_name: string

    last name of the candidate

  • candidate_name: string

    full name of the candidate

  • id: number

    packet id

  • unit_id: number

    unit id of the packet

  • unit_name: string

    unit name of the packet unit

FormReportParams

FormReportParams: { form_id: number; form_type: string; limit?: number; packet_ids: number[]; page?: number }

Params to query the form report

Type declaration

  • form_id: number

    the id of the form

  • form_type: string

    the type of the form (e.g. committee)

  • Optional limit?: number

    the number of records to be returned - default = 100

  • packet_ids: number[]

    the packet ids for the forms of the data to be returned

  • Optional page?: number

    the page number of the records to be returned - default = 1

PacketReportParams

PacketReportParams: { criteria?: { custom_forms?: { id: number; questions: number[] }[]; packet: string[] }; custom_form_facets_only?: boolean; facets?: ReportFacets; from?: number; search_text?: string; size?: number; sort?: { column: string; direction: string } }

Parameters to be sent to the report generate api call

Type declaration

  • Optional criteria?: { custom_forms?: { id: number; questions: number[] }[]; packet: string[] }

    which columns to include

    • Optional custom_forms?: { id: number; questions: number[] }[]
    • packet: string[]
  • Optional custom_form_facets_only?: boolean

    only include custom form facets

  • Optional facets?: ReportFacets

    the facets which to query the the packets by

  • Optional from?: number

    the row to begin selecting records from

  • Optional search_text?: string

    text to search for in packet

  • Optional size?: number

    the number of records to retrieve

  • Optional sort?: { column: string; direction: string }

    the column and direction of the row sort

    • column: string

      the column to sort by

    • direction: string

      the direction to sort by ('asc'|'desc')

ReportFacets

ReportFacets: { archived?: boolean; closed?: boolean; closed_date_range?: { from: string; to: string }; created_date_range?: { from: string; to: string }; status?: string[]; template_name?: string[]; unit_names?: string[] }

Type declaration

  • Optional archived?: boolean

    criteria if the packet is archived

  • Optional closed?: boolean
  • Optional closed_date_range?: { from: string; to: string }

    the date range in which to query closed date by

    • from: string

      closed date start range

    • to: string

      closed date end range

  • Optional created_date_range?: { from: string; to: string }

    the date range in which to query created date by

    • from: string

      created_date start range

    • to: string

      created_date end range

  • Optional status?: string[]

    array of statuses to query by

  • Optional template_name?: string[]

    array of template names to query by

  • Optional unit_names?: string[]

    array of unit names to query by

ReportPacket

ReportPacket: { closed: boolean; closed_date: string | null; created_date: string; current_workflow_step_name: string | null; email: string | null; firstname: string | null; formatted_status: string; id: number; lastname: string | null; status: null | { color: string; created_at: string; deleted: boolean; elastic_search_updated_at: string; id: number; name: string; sort_order: number; unit_id: number; updated_at: string }; template_name: string | null; unit_name: string }

Data returned from the Packet Search

Type declaration

  • closed: boolean

    flag indicating if this packet is closed

  • closed_date: string | null

    date the packet was closed

  • created_date: string

    date when the packet was created

  • current_workflow_step_name: string | null

    current workflow step name

  • email: string | null

    email of the candidate

  • firstname: string | null

    the formatted status of the packet

  • formatted_status: string

    ID of the Packet/case

  • id: number

    First name of the candidate

  • lastname: string | null

    Last name of the candidate

  • status: null | { color: string; created_at: string; deleted: boolean; elastic_search_updated_at: string; id: number; name: string; sort_order: number; unit_id: number; updated_at: string }

    current status of the packet

  • template_name: string | null

    template name from which the case was created

  • unit_name: string

    the type of the /** name of the unit for this packet

Variables

Const REPORT_BASE_URL

REPORT_BASE_URL: string = ...

Const REPORT_FORM_INDEX_URL

REPORT_FORM_INDEX_URL: string = ...

Const REPORT_FORM_URL

REPORT_FORM_URL: string = ...

Const REPORT_PACKET_SEARCH_URL

REPORT_PACKET_SEARCH_URL: string = ...

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc