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

Index

References

Classes

Type aliases

Variables

References

default

Renames and exports ApplicationApi

Type aliases

Application

Application: { address: string; address2: string; alternate_phone: string; city: string; country: string; email: string; firstname: string; highest_degree_date: string; highest_degree_school: string; id: number; lastname: string; position_id: number; state: string; telephone: string; zip: string }

Type declaration

  • address: string

    address line 1 of the applicant

  • address2: string

    address line 2 of the applicant

  • alternate_phone: string

    alternate phone of the applicant

  • city: string

    city of the applicant

  • country: string

    country of the applicant

  • email: string

    email of the applicant

  • firstname: string

    first name of the applicant

  • highest_degree_date: string

    highest degree date of the applicant

  • highest_degree_school: string

    highest degree school of the applicant

  • id: number

    unique identifier for this application

  • lastname: string

    last name of the applicant

  • position_id: number

    position id to which this application is connected

  • state: string

    state address of the applicant

  • telephone: string

    telephone of the applicant

  • zip: string

    zip/postal code of the applicant

ApplicationDetail

ApplicationDetail: { address: string; address2: string; all_ratings_and_comments_viewable: boolean; alternate_phone: string; application_comments_allowed: boolean; application_documents: ApplicationDocumentListing[]; application_status: string; application_status_id: number; application_tagging_allowed: boolean; application_taggings: { application_tag_editable: boolean; application_tag_id: number; application_tag_name: string; editable: boolean; id: number }[]; archived: boolean; available_application_statuses: { allow_review: boolean; allow_update: boolean; current: boolean; default: boolean; display_to_applicant: boolean; id: number; message_template_id: number; name: string; sort_order: number; unit_id: number; used: boolean }[]; available_application_tags: { editable: boolean; id: number; name: string; pid: number; position_id: number; user_id: number }[]; average_rating: number; background_check_conducted: boolean; bookmarks: any[]; city: string; committee_evaluations: any[]; completeness_level: string; country: string; desired_start_date: string; desired_start_date_display: boolean; disposition_codes: { code: string; id: number }[]; document_requirements_met: boolean; editable: boolean; eeo_flaggable: boolean; email: string; evaluation_scales: { application_rating_id: number; average_rating: number; current: boolean; id: number; my_rating: number; name: string }[]; first_date_sent: string; firstname: string; form_responses: { form_id: number; form_name: string; form_questions: { answers: { answer_id: number; answer_order: number; axis: string; created_by: number; custom_form_id: number; data_answer_text: string; display_answer_text: string; last_update_by: number }[]; question_id: number; question_text: string }[] }[]; general_notes: string; highest_degree: string; highest_degree_date: string; highest_degree_school: string; hiring_notes: string; id: number; institution_user_id: number; job_requisition_number: string; last_date_sent: string; last_date_sent_display: string; last_update_nested: string; lastname: string; materials_complete: boolean; my_rating: number; offer_date: string; offer_date_display: boolean; offer_made: boolean; other_negotiated_items: null; overall_rating: number; pid: 4486015; position_id: 101152; position_name: string; state: string; telephone: string; withdrawn: boolean; zip: string }

Represents an application detail for a position

Type declaration

  • address: string

    applicant address line 1

  • address2: string

    applicant address line 2

  • all_ratings_and_comments_viewable: boolean

    if all ratings and comments are visible for this applicant

  • alternate_phone: string

    alternate phone for the applicant

  • application_comments_allowed: boolean

    if application comments are allowed

  • application_documents: ApplicationDocumentListing[]

    documents submitted for the application

  • application_status: string

    status of the application

  • application_status_id: number

    of the application

  • application_tagging_allowed: boolean

    if tagging is allowed

  • application_taggings: { application_tag_editable: boolean; application_tag_id: number; application_tag_name: string; editable: boolean; id: number }[]

    tags applied to this application

  • archived: boolean

    if the application is archived

  • available_application_statuses: { allow_review: boolean; allow_update: boolean; current: boolean; default: boolean; display_to_applicant: boolean; id: number; message_template_id: number; name: string; sort_order: number; unit_id: number; used: boolean }[]

    available application statuses

  • available_application_tags: { editable: boolean; id: number; name: string; pid: number; position_id: number; user_id: number }[]

    tags available to apply to this application

  • average_rating: number

    average rating of the application

  • background_check_conducted: boolean

    if the background check has been conducted

  • bookmarks: any[]

    any bookmarks applied to this application

  • city: string

    applicant address city

  • committee_evaluations: any[]

    committee evaluations

  • completeness_level: string

    completeness level of the application

  • country: string

    country of the application

  • desired_start_date: string

    desired start date of the application

  • desired_start_date_display: boolean

    desired start date display of the application

  • disposition_codes: { code: string; id: number }[]

    disposition codes for the application

  • document_requirements_met: boolean

    document requirements met of the application

  • editable: boolean

    editable of the application

  • eeo_flaggable: boolean

    eeo flaggable of the application

  • email: string

    email of the application

  • evaluation_scales: { application_rating_id: number; average_rating: number; current: boolean; id: number; my_rating: number; name: string }[]

    scales for rating

  • first_date_sent: string

    first date sent of the application

  • firstname: string

    firstname of the applicant

  • form_responses: { form_id: number; form_name: string; form_questions: { answers: { answer_id: number; answer_order: number; axis: string; created_by: number; custom_form_id: number; data_answer_text: string; display_answer_text: string; last_update_by: number }[]; question_id: number; question_text: string }[] }[]

    form responses for this application

  • general_notes: string

    general notes for the application

  • highest_degree: string

    highest degree of the application

  • highest_degree_date: string

    highest degree date of the applicant

  • highest_degree_school: string

    highest degree school of the applicant

  • hiring_notes: string

    hiring notes of the applicant

  • id: number

    unique identifier for this application

  • institution_user_id: number

    institution user id of the application

  • job_requisition_number: string

    job requisition number of the application

  • last_date_sent: string

    last date sent of the application

  • last_date_sent_display: string

    if the last date sent should be displayed for this application

  • last_update_nested: string

    last update nested of the application

  • lastname: string

    lastname of the applicant

  • materials_complete: boolean

    if materials complete for the application

  • my_rating: number

    my rating of the application

  • offer_date: string

    offer date of the application

  • offer_date_display: boolean

    offer date display of the application

  • offer_made: boolean

    if an offer was made

  • other_negotiated_items: null

    other negotiated items for the offer

  • overall_rating: number

    overall rating of the application

  • pid: 4486015

    pid of hte applicant

  • position_id: 101152

    position id for the application

  • position_name: string

    position name of the position

  • state: string

    state address of the applicant

  • telephone: string

    telephone of the applicant

  • withdrawn: boolean

    if the application was withdrawn

  • zip: string

    zip code of the applicant

Variables

Const APPLICATION_BASE_URL_V1

APPLICATION_BASE_URL_V1: string = ...

Const APPLICATION_DETAIL_URL

APPLICATION_DETAIL_URL: string = ...

Const APPLICATION_URL

APPLICATION_URL: string = ...

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc