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

Index

References

Classes

Type aliases

Variables

References

default

Renames and exports PositionApi

Type aliases

PositionBase

PositionBase: { advertising_explanation?: string; allow_additional_documents?: boolean; application_receipt_message_body?: string; application_receipt_message_from?: string; application_receipt_message_reply_to?: string; application_receipt_message_subject?: string; appointment_type?: string; archived?: boolean; blind_review?: boolean; close_date?: string; close_flag?: boolean; description?: string; discipline?: string; funding_source?: string; hiring_plan?: string; instructions?: string; job_requisition_number?: string; location?: string; name: string; notes?: string; open_date?: string; position_start_date?: string; position_status_id?: number; position_term_id?: number; position_type_id: number; private_flag?: boolean; published?: boolean; qualifications?: string; rank?: string; reason?: string; salary_range?: string; title?: string; unit_id: number }

An Interfolio position base definition on which PositionInsert and PositionDetail is based

Type declaration

  • Optional advertising_explanation?: string

    advertising explanation for the postiion

  • Optional allow_additional_documents?: boolean

    if additional documents are allowed

  • Optional application_receipt_message_body?: string

    body of the application receipt message

  • Optional application_receipt_message_from?: string

    from address for the application receipt message

  • Optional application_receipt_message_reply_to?: string

    reply to for the application receipt message

  • Optional application_receipt_message_subject?: string

    subject of the application receipt message

  • Optional appointment_type?: string

    the appointment type for the position

  • Optional archived?: boolean

    if the position has been archived

  • Optional blind_review?: boolean

    if the applicants should have blind review

  • Optional close_date?: string

    closing date for the position

  • Optional close_flag?: boolean

    if the position has been manually closed regardless of close date

  • Optional description?: string

    description of the position

  • Optional discipline?: string

    discipline for the position

  • Optional funding_source?: string

    funding source for the position

  • Optional hiring_plan?: string

    hiring plan for the position

  • Optional instructions?: string

    application instructions for the position

  • Optional job_requisition_number?: string

    job requisition number

  • Optional location?: string

    location of the position

  • name: string

    Name of the position

  • Optional notes?: string

    notes for the position

  • Optional open_date?: string

    opening date for the position

  • Optional position_start_date?: string

    start date for the position

  • Optional position_status_id?: number

    id of the position status

  • Optional position_term_id?: number

    position term id for the position

  • position_type_id: number

    Type id of the position (e.g. faculty staff etc)

  • Optional private_flag?: boolean

    if the position is private

  • Optional published?: boolean

    if the position is published

  • Optional qualifications?: string

    qualifcations required for the position

  • Optional rank?: string

    rank for the position

  • Optional reason?: string

    reason for the position

  • Optional salary_range?: string

    salary range for the position

  • Optional title?: string

    title for the position

  • unit_id: number

    Unit id of the position

PositionDetail

PositionDetail: PositionBase & { acting_committee_managers: { email: string; first_name: string; id: number; last_name: string; pid: number; role_id: number; user_id: number }[]; acting_evaluators: any[]; active_applications_count: number; active_applications_updated_at: string; ancestor_units: { id: number; name: string }[]; applicant_selected: boolean; applicant_selection_notes: string; application_receipt_message_template_id: string; 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 }[]; application_tagging_allowed: boolean; application_tags: { editable: boolean; id: number; name: string; pid: number; position_id: number; user_id: number }[]; approval_status: string; approved: boolean; approved_by: number; archived_on: string; associated_data_updated_at: string; can_approve_position: boolean; can_be_rejected: boolean; can_be_resolved: boolean; can_move: boolean; can_move_backward: boolean; can_move_forward: boolean; choice_type: string; close_date_display: boolean; committee_id: number; committee_manager_role_id: number; committee_members: { email: string; first_name: string; id: number; last_name: string; pid: number; role_id: number; user_id: number }[]; committee_migrated_to_core: boolean; created_at: string; current_workflow_step: PositionWorkflowStep; deletable: boolean; disposition_codes: { code: string; id: number }[]; editable: boolean; eeo_flaggable: boolean; eeo_statement: string; effective_eeo_statement: string; elastic_search_updated_at: string; evaluation_scales: any[]; evaluator_role_id: number; file_attachments: { display_name: string; file_name: string; id: number; status: string }; id: number; institution_id: number; last_rejected_by_pid: string; last_rejected_date: string; last_rejected_message: string; last_rejected_step: string; legacy_position_id: string; next_workflow_step: PositionWorkflowStep; open: boolean; open_date_display: boolean; pid: string; position_forms: { custom_form_id: number; description: string; eeo_form: boolean; form_name: string; id: number; position_id: number; questions: PositionFormQuestion[]; sort_order: number }[]; position_status: string; position_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 }[]; position_template_id: string; position_term_name: string; position_type_category_id: number; position_type_name: string; previous_workflow_step: PositionWorkflowStep; ready_for_approval: boolean; ready_for_approval_info: any; rejection_info: any; required_documents: { document_type_id: number; document_type_name: string; id: number; notes: string; order: number; quantity: number; single_user_letters: false }[]; requirement_template_id: number; search_strings: string; selected_applicants: { email: string; first_name: string; id: number; last_name: string }[]; selection_last_rejected_by_pid: string; selection_last_rejected_date: string; selection_last_rejected_step: string; selection_rejection_info: any; sortable_date: string; step_number_in_category: string; stored_tenant_id: number; total_application_count: number; type: string; unit_name: string; unit_name_temp: string; unresolved_rejection: string; updated_at: string; use_derived_eeo_statement: boolean; user_id: 153556; workday_position: boolean; workflow_steps: PositionWorkflowStep[]; workflow_template_id: string }

PositionFormQuestion

PositionFormQuestion: { active: boolean; answers: { answer_order: number; axis: string; created_by: number; data_answer_text: string; display_answer_text: string; id: number; last_update_by: number }[]; created_by: number; has_other: boolean; id: number; last_update_by: number; question_help_text: string; question_sort_order: number; question_text: string; question_type: { fixed_id: number; id: number; name: string }; required: boolean }

Type declaration

  • active: boolean
  • answers: { answer_order: number; axis: string; created_by: number; data_answer_text: string; display_answer_text: string; id: number; last_update_by: number }[]
  • created_by: number
  • has_other: boolean
  • id: number
  • last_update_by: number
  • question_help_text: string
  • question_sort_order: number
  • question_text: string
  • question_type: { fixed_id: number; id: number; name: string }
    • fixed_id: number
    • id: number
    • name: string
  • required: boolean

PositionInsert

PositionInsert: PositionBase & { from?: string; reply_to?: string }

PositionWorkflowStep

PositionWorkflowStep: { assignments: PositionWorkflowStepAssignment[]; category_id: number; category_name: string; created_at: string; current: boolean; due_date: string; due_date_display: boolean; id: number; name: string; note: string; step_number: number }

Workflow steps in the position

Type declaration

  • assignments: PositionWorkflowStepAssignment[]

    users assigned to the workflow step

  • category_id: number

    workflow step category id

  • category_name: string

    category name of the workflow step

  • created_at: string

    date the that workflow step was created

  • current: boolean

    if this is the current workflow step

  • due_date: string

    due date of the workflow step

  • due_date_display: boolean

    if the due date should be displayed

  • id: number

    id of the workflow step

  • name: string

    name of the workflow step

  • note: string

    note associated with this workflow step

  • step_number: number

    order number of the workflow step

PositionWorkflowStepAssignment

PositionWorkflowStepAssignment: { assignment_id: number; assignment_type: string; assignment_type_display: string; committee_members: { first_name: string; id: number; last_name: string; manager: boolean; pid: number }[]; complete: boolean; email: string; first_name: string; id: number; individual_committee: boolean; last_name: string; manager: boolean; name: string; note: string; pid: number; restricted: boolean }

Type representing assignments to a position workflow step (returned by position detail api)

Type declaration

  • assignment_id: number
  • assignment_type: string
  • assignment_type_display: string
  • committee_members: { first_name: string; id: number; last_name: string; manager: boolean; pid: number }[]
  • complete: boolean
  • email: string
  • first_name: string
  • id: number
  • individual_committee: boolean
  • last_name: string
  • manager: boolean
  • name: string
  • note: string
  • pid: number
  • restricted: boolean

Variables

Const POSITION_BASE_URL

POSITION_BASE_URL: string = ...
const

Base url for position api calls

Const POSITION_FILTER_URL

POSITION_FILTER_URL: string = ...

Const POSITION_URL

POSITION_URL: string = ...

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc