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

Index

References

Classes

Type aliases

Variables

References

default

Renames and exports PacketApi

Type aliases

CreatePacketFromTemplateParams

CreatePacketFromTemplateParams: { candidateEmail?: string; candidateFirstName?: string; candidateInvolvement: boolean; candidateLastName?: string; candidatePID?: number; dueDate?: string; eppn?: string; name?: string; packetId: number; unitId: number }

Defines the parameters needed to create a packet from a packet template

Type declaration

  • Optional candidateEmail?: string

    Candidate Email address

  • Optional candidateFirstName?: string

    Candidate's first name

  • candidateInvolvement: boolean

    If the candidate will be involved in the case

  • Optional candidateLastName?: string

    Candidate's Last name

  • Optional candidatePID?: number

    if not using name and email - applicants PID

  • Optional dueDate?: string

    Due date of the packet

  • Optional eppn?: string

    unknown

  • Optional name?: string

    unknown

  • packetId: number

    Id of the packet template to create from

  • unitId: number

    Unit Id to create the case in

MoveParams

MoveParams: { id: number; notificationBody?: string; notificationSubject?: string; sendNotification: boolean }

Defines the parameters needed to move a packet forward/backward

Type declaration

  • id: number

    id of the packet

  • Optional notificationBody?: string

    body of the notification message

  • Optional notificationSubject?: string

    subject for the notification message

  • sendNotification: boolean

    if a notification should be sent

Packet

Packet: { allow_comments: boolean; allow_update: boolean; altered_for_candidate_transparency: boolean; applicant_has_submitted: boolean; applicant_notified: boolean; applicant_pid: number; archived: boolean; archived_on: string; associated_data_updated_at: string; blind_review: boolean; candidate_email: string; candidate_first_name: string; candidate_involvement: boolean; candidate_involvement_confirmed: boolean; candidate_last_name: string; complete: boolean; created_at: string; default_email_from: string; deleted: boolean; deleted_on: string; description: string; due_date: string; elastic_search_updated_at: string; id: number; instructions: string; internal_sections_on_bottom: boolean; internal_sort_order_altered: boolean; name: string; packet_template_name: string; packet_type_id: number; percent_complete: boolean; published: boolean; search_strings: null; status_id: string; unit_id: number; updated_at: string; withdrawn: boolean }

Packet Data that is returned after packet creation

Type declaration

  • allow_comments: boolean

    flag indicating if comments are allowed

  • allow_update: boolean

    flag indicating if updates are allowed

  • altered_for_candidate_transparency: boolean

    flag indicating if the packet has been altered for candidate transparency

  • applicant_has_submitted: boolean

    flag indicating if the applicant has submitted

  • applicant_notified: boolean

    flag indicating if the applicant has been notified

  • applicant_pid: number

    applicant pid of the packet

  • archived: boolean

    flag indicating if the template has been archived

  • archived_on: string

    date on which the packet was archived

  • associated_data_updated_at: string

    data on which associated data was updated

  • blind_review: boolean

    flag indicating if review should be blind

  • candidate_email: string

    email of the candidate

  • candidate_first_name: string

    first name of the candidate

  • candidate_involvement: boolean

    flag indicating if the candidate will be submitting case materials

  • candidate_involvement_confirmed: boolean

    flag indicating that candidate involvement has been confirmed

  • candidate_last_name: string

    Last name of the candidate

  • complete: boolean

    Flag indicating if the packet is complete

  • created_at: string

    Time when the packet was created

  • default_email_from: string

    email from which notifications are sent

  • deleted: boolean

    flag indicating if this packet has been deleted

  • deleted_on: string

    Time when the packet was deleted

  • description: string

    Description of the case template

  • due_date: string

    Due date for the packet

  • elastic_search_updated_at: string

    Date when the elastic search for this packet was last updated

  • id: number

    ID of the packet/template

  • instructions: string

    Candidate Instructions for the packet

  • internal_sections_on_bottom: boolean

    flag indicating if hte internal sections should appear after candidate sections

  • internal_sort_order_altered: boolean

    flag indicating if the internal sort order has been altered

  • name: string

    Name of the packet template

  • packet_template_name: string

    Name of the template on which this packet was created

  • packet_type_id: number

    id of the type of packet

  • percent_complete: boolean

    flag indicating if the packet is complete

  • published: boolean

    flag indicating if the template is published

  • search_strings: null

    list of strings for which this packet can be searched

  • status_id: string

    ID of the status for the packet

  • unit_id: number

    Unit id of the packet

  • updated_at: string

    Time the packet was last updated

  • withdrawn: boolean

    Flag indicating if the packet has been withdrawn

PacketDetail

PacketDetail: { allow_additional_documents: boolean; allow_candidate_sections: boolean; allow_comments: boolean; allow_update: boolean; applicant_can_be_notified: boolean; applicant_has_been_notified: boolean; applicant_has_submitted: boolean; applicant_id: number; applicant_pid: number; application_documents: any[]; archivable: boolean; archived: boolean; can_be_moved_forward: boolean; can_comment_on: boolean; can_edit_comment_settings: boolean; can_edit_packet: boolean; can_edit_packet_settings: boolean; candidate_email: string; candidate_first_name: string; candidate_involvement: boolean; candidate_involvement_confirmed: boolean; candidate_last_name: string; comments_allowed_by_institution: boolean; committee_initiated_evaluations: any[]; confidential_attachments: any[]; created_at: string; current_committee?: { id: number; individual_committee: false; members: [any]; name: string; note: string; requirements_fulfilled: boolean; restricted: boolean; standing: boolean; type: string; unit_id: number }; current_users_assigned_committees: { id: number; name: string }[]; current_workflow_step: WorkflowStep; custom_forms: any[]; documents_by_applicant_submitted_section: any[]; documents_by_evaluator_section: any[]; documents_by_section: any[]; due_date: string | null; due_date_display: string | null; form_responses: any[]; id: number; institution_id: number; instructions: string | null; internal_data_forms: any[]; internal_form_responses: any[]; internal_sections_on_bottom: boolean; name?: string; next_workflow_step: WorkflowStep; packet_attachments: any[]; packet_downloading_allowed: boolean; packet_sections: EvaluatorSection[]; packet_template_id: number; packet_type_id: number | null; packet_type_name: string | null; previous_workflow_step: any; required_documents: { enforcement_level: number; enforcement_level_value: string; for_additional_documents: boolean; id: number; in_use: boolean; lower_limit: number; name: string; note: string | null; upper_limit: number }[]; requirements_by_section: any[]; status: string | null; unit_id: number; unit_name: string; visible_comments: any[]; waiting_on_committee: any[]; workflow_steps: WorkflowStep[] }

Packet data that is returned from a GET request

Type declaration

  • allow_additional_documents: boolean

    Flag indicating if additional documents are allowed

  • allow_candidate_sections: boolean

    Flag indicating if additional candidate sections are allowed

  • allow_comments: boolean

    Flag indicating if comments are allowed

  • allow_update: boolean

    flag indicating if updates are allowed

  • applicant_can_be_notified: boolean

    Flag indicating if the applicant can be notified

  • applicant_has_been_notified: boolean

    Flag indicating if applicant has been notified

  • applicant_has_submitted: boolean

    flag indicating if the applicant has submitted

  • applicant_id: number

    ID of the applicant

  • applicant_pid: number

    applicant pid of the packet

  • application_documents: any[]

    Documents supplied by the applicant

  • archivable: boolean

    Flag indicating if this case is archivable

  • archived: boolean

    flag indicating if the template has been archived

  • can_be_moved_forward: boolean

    Flag indicating if the case can be moved forward

  • can_comment_on: boolean

    Flag indicating if the the case can be commented on by the current user

  • can_edit_comment_settings: boolean

    Flag indicating if the the comment settings can be edited by the current user

  • can_edit_packet: boolean

    Flag indicating if the packet can be edited by the current user

  • can_edit_packet_settings: boolean

    Flag indicating if the packet settings can be edited by the current user

  • candidate_email: string

    email of the candidate

  • candidate_first_name: string

    first name of the candidate

  • candidate_involvement: boolean

    flag indicating if the candidate will be submitting case materials

  • candidate_involvement_confirmed: boolean

    flag indicating that candidate involvement has been confirmed

  • candidate_last_name: string

    Last name of the candidate

  • comments_allowed_by_institution: boolean

    Flag indicating if comments are allowed by the institution

  • committee_initiated_evaluations: any[]

    list of committee initiated evaluations

  • confidential_attachments: any[]

    list of confidential attachments

  • created_at: string

    Time when the packet was created

  • Optional current_committee?: { id: number; individual_committee: false; members: [any]; name: string; note: string; requirements_fulfilled: boolean; restricted: boolean; standing: boolean; type: string; unit_id: number }
    • id: number
    • individual_committee: false
    • members: [any]
    • name: string
    • note: string
    • requirements_fulfilled: boolean
    • restricted: boolean
    • standing: boolean
    • type: string
    • unit_id: number
  • current_users_assigned_committees: { id: number; name: string }[]

    committeess assigned to the current user

  • current_workflow_step: WorkflowStep

    current workflow step

  • custom_forms: any[]

    custom forms attached to this case

  • documents_by_applicant_submitted_section: any[]

    list of documents by application section

  • documents_by_evaluator_section: any[]

    list of documents by evaluator section

  • documents_by_section: any[]

    list of documents by section

  • due_date: string | null

    Due date for the packet

  • due_date_display: string | null

    Due date to display

  • form_responses: any[]

    responses to forms

  • id: number

    ID of the packet/template

  • institution_id: number

    instutiion id

  • instructions: string | null

    Candidate Instructions for the packet

  • internal_data_forms: any[]

    internal data forms

  • internal_form_responses: any[]

    internal form responses

  • internal_sections_on_bottom: boolean

    flag indicating if hte internal sections should appear after candidate sections

  • Optional name?: string

    name from template

  • next_workflow_step: WorkflowStep

    the next workflow step

  • packet_attachments: any[]

    packet attachments

  • packet_downloading_allowed: boolean

    flag indicating if packet downloading is allowed

  • packet_sections: EvaluatorSection[]

    list of packet sections

  • packet_template_id: number

    id of the packet template

  • packet_type_id: number | null

    id of the type of packet

  • packet_type_name: string | null

    name of the packet type

  • previous_workflow_step: any

    previous workflow step

  • required_documents: { enforcement_level: number; enforcement_level_value: string; for_additional_documents: boolean; id: number; in_use: boolean; lower_limit: number; name: string; note: string | null; upper_limit: number }[]

    list of required documents for candidate

  • requirements_by_section: any[]

    list of requirements by section

  • status: string | null

    status of the case

  • unit_id: number

    Unit id of the packet

  • unit_name: string

    name of the unit for this case

  • visible_comments: any[]

    list of visible comments

  • waiting_on_committee: any[]

    list of committees that this case is waiting on

  • workflow_steps: WorkflowStep[]

    list of workflow steps

Variables

Const PACKET_ARCHIVE_URL

PACKET_ARCHIVE_URL: string = ...

Const PACKET_BASE_URL

PACKET_BASE_URL: string = ...

Const PACKET_CREATE_FROM_TEMPLATE_URL

PACKET_CREATE_FROM_TEMPLATE_URL: string = ...

Const PACKET_MOVE_BACKWARD_URL

PACKET_MOVE_BACKWARD_URL: string = ...

Const PACKET_MOVE_FORWARD_URL

PACKET_MOVE_FORWARD_URL: string = ...

Const PACKET_URL

PACKET_URL: string = ...

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc