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

Index

References

Classes

Type aliases

Variables

References

default

Renames and exports PlatformFormApi

Type aliases

AddWorkflowStepFormParams

AddWorkflowStepFormParams: { committeeId: number; committeeManagerOnlySubmission: boolean; formAccessLevel: number; formId: number; packetId: number; sectionId: number; workflowStepId: number }

Params needed to add a form to a packet workflow step

Type declaration

  • committeeId: number

    id of the committee

  • committeeManagerOnlySubmission: boolean

    if only the committee manager will submit this form

  • formAccessLevel: number

    access level indicating who can view the form

  • formId: number

    id of the form to require

  • packetId: number

    id of the individual packet

  • sectionId: number

    section_id of the packet to include this form in

  • workflowStepId: number

    the workflow step id where this form is required

PlatformForm

PlatformForm: { caasbox_form_id: number; committee_id: number; committee_manager_only_submission: true; created_at: string; downloading_allowed: true; form_access_level: number; id: number; packet_section_id: number; pdf_s3_file_location: string; pdf_status: string; pdf_updated_at: string; sort_order: number; updated_at: string; workflow_step_id: number }

Type declaration

  • caasbox_form_id: number

    id of the form type

  • committee_id: number

    id of the committee form is assinged to

  • committee_manager_only_submission: true

    if only the committee manager needs to submit the form

  • created_at: string

    date the form instance was created

  • downloading_allowed: true

    if downloading is allowed

  • form_access_level: number

    level of access granted to view form

  • id: number

    id of the form instance

  • packet_section_id: number

    id of the section where form data should be placed for reader

  • pdf_s3_file_location: string

    location of the pdf file in s3

  • pdf_status: string

    status of the pdf generation

  • pdf_updated_at: string

    date the pdf was last updated

  • sort_order: number

    sort order of the form instance

  • updated_at: string

    last date that the form was updated

  • workflow_step_id: number

    id of the workflow step to which this form instance belongs

PlatformFormResponder

PlatformFormResponder: { committee_member_email: string; committee_member_id: number; committee_member_name: string; form_total_questions: number; form_total_questions_answered: number; form_total_required_questions: number; form_total_required_questions_answered: number; omitted: boolean; pid: number; status: string; submitted: boolean }

Type representing the responders assigned to submit a committee workflow step form

Type declaration

  • committee_member_email: string

    email of the committee member assigned

  • committee_member_id: number

    id of the committee membership

  • committee_member_name: string

    name of the committee member assigned

  • form_total_questions: number

    total number of questions on form

  • form_total_questions_answered: number

    number of questions answers by committee member

  • form_total_required_questions: number

    total number of form questions required

  • form_total_required_questions_answered: number

    total number of required questions answered

  • omitted: boolean

    if the response requirement has been ommitted

  • pid: number

    pid of the user

  • status: string

    submission status

  • submitted: boolean

    if the form has been submitted

PlatformFormSubmission

PlatformFormSubmission: { form_version_id: number; response_data: any; submitted: boolean }

The responses to submit to a platform form

Type declaration

  • form_version_id: number

    the form version number

  • response_data: any

    the responses to the form

  • submitted: boolean

    if the form should be submitted and marked as complete

PlatformFormSubmissionResponse

PlatformFormSubmissionResponse: { createdAt: string; createdBy: number; form: { id: number; title: string }; formVersion: FormVersion; id: number; originId: number; originType: string; responseData: {}; statistics: { required_questions: number; required_questions_answered: number; total_answered_questions: number; total_questions: number }; submitted: boolean; updatedAt: string; updatedBy: number }

Response recieved when updating a form

Type declaration

  • createdAt: string

    date when the form was created

  • createdBy: number

    id of the user who created the form

  • form: { id: number; title: string }

    the title and id of the form that was submitted

    • id: number
    • title: string
  • formVersion: FormVersion

    the version of the form submitted

  • id: number

    id of the form response

  • originId: number

    id of the form instance assigned to the packet

  • originType: string

    not sure

  • responseData: {}

    the response data

    • [questionKey: string]: string | number
  • statistics: { required_questions: number; required_questions_answered: number; total_answered_questions: number; total_questions: number }

    response statistics

    • required_questions: number

      the number of required questions on the form

    • required_questions_answered: number

      the number of required questions answered

    • total_answered_questions: number

      the total number of answered questions

    • total_questions: number

      the number of questions on the form

  • submitted: boolean

    if the form has been submitted

  • updatedAt: string

    date when the form was updated

  • updatedBy: number

    id of the user who last updated the form response

Variables

Const PLATFORM_FORM_BASE_URL

PLATFORM_FORM_BASE_URL: string = ...

Const PLATFORM_FORM_EXCLUDE_URL

PLATFORM_FORM_EXCLUDE_URL: string = ...

Const PLATFORM_FORM_RESPONSE_BASE_URL

PLATFORM_FORM_RESPONSE_BASE_URL: string = ...

Const PLATFORM_FORM_RESPONSE_URL

PLATFORM_FORM_RESPONSE_URL: string = ...

Const PLATFORM_FORM_URL

PLATFORM_FORM_URL: string = ...

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc