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

Index

References

Classes

Type aliases

Variables

References

default

Renames and exports ReportApi

Type aliases

ApplicationCriteria

ApplicationCriteria: "id" | "firstname" | "lastname" | "highest_degree" | "highest_degree_school" | "application_status_name" | "completeness_level" | "last_date_sent" | "labels" | "my_average_rating"

Criteria (or fields that can be returned) from an application search

ApplicationData

ApplicationData: { application_status_name: string; completeness_level: string; firstname: string; formatted_labels: { is_editable: boolean; tag_id: number; tag_name: string; tagging_id: number; user_id: number }[]; formatted_my_average_rating: string; highest_degree: string; highest_degree_school: string; id: number; labels: { is_editable: boolean; tag_id: number; tag_name: string; tagging_id: number; user_id: number }[]; last_date_sent: string; lastname: string; my_average_rating: string; position_id: number; questions: { name: string; responses: string[] }[] }

the data returned from an application search

Type declaration

  • application_status_name: string

    human readable name of the application status

  • completeness_level: string

    completeness level of the application

  • firstname: string

    first name of the applicant

  • formatted_labels: { is_editable: boolean; tag_id: number; tag_name: string; tagging_id: number; user_id: number }[]

    labels attached to the application

  • formatted_my_average_rating: string

    formatted version of average rating for user

  • highest_degree: string

    highest degree of the applicant

  • highest_degree_school: string

    school issuing the highest degree for the applicant

  • id: number

    unique identifier for the application

  • labels: { is_editable: boolean; tag_id: number; tag_name: string; tagging_id: number; user_id: number }[]

    formatted labels for the application

  • last_date_sent: string

    date of the last time application was sent

  • lastname: string

    last name of the applicant

  • my_average_rating: string

    average rating of user for applications

  • position_id: number

    position_id to which the application is connected

  • questions: { name: string; responses: string[] }[]

    questions the applicant answered

ApplicationSearchData

ApplicationSearchData: { applications: ApplicationData[]; total: number }

data to be sent

Type declaration

ApplicationSearchFacets

ApplicationSearchFacets: { application_date_range?: { from: string; to: string }; application_rating?: number; archived?: boolean; complete?: boolean; my_average_rating?: number; position_id: number; withdrawn?: boolean }

facets to list the criteria for the search for applications

Type declaration

  • Optional application_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 application_rating?: number

    the rating of the application

  • Optional archived?: boolean
  • Optional complete?: boolean
  • Optional my_average_rating?: number
  • position_id: number

    id of the position

  • Optional withdrawn?: boolean

ApplicationSearchParams

ApplicationSearchParams: { criteria?: { application: ApplicationCriteria[] }; facets: ApplicationSearchFacets; 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?: { application: ApplicationCriteria[] }

    which columns to include

  • facets: ApplicationSearchFacets

    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')

Variables

Const REPORT_APPLICATION_SEARCH_URL

REPORT_APPLICATION_SEARCH_URL: string = ...

the application search url

Const SEARCH_REPORT_BASE_URL

SEARCH_REPORT_BASE_URL: string = ...

the base url for the search/reports api

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc