Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

default

Renames and exports ApplicationDocumentApi

Type aliases

ApplicationDocumentListing

ApplicationDocumentListing: { bycommittee_uploaded: boolean; conversion_status: string; date_received: string; id: number; is_read: boolean; is_received: boolean; name: string; type: string }

Type declaration

  • bycommittee_uploaded: boolean

    if the document was uploaded by the committee

  • conversion_status: string

    status of the document being converted to Interfolio PDF

  • date_received: string

    date the document was received

  • id: number

    id of the document

  • is_read: boolean

    if the document has been read

  • is_received: boolean

    if the document has been received

  • name: string

    name of the document

  • type: string

    document type

ApplicationDocumentUploadResponse

ApplicationDocumentUploadResponse: { application_id: number; bookmarks: any; bycommittee_uploaded: boolean; can_submit_while_pending: boolean; conversion_status: string; created_at: string; date_received: string; description: string; document_location: string; document_original_location: string; document_title: string; document_type: string; id: number; is_received: boolean; media_box_document_id: number; media_format: string; origin: string; origin_document_id: number; required_document_id: number; search_processed_at: string; sort_order: number; thumbnail_url: string; updated_at: string; url: string }

Type declaration

  • application_id: number

    application id of the application for this document

  • bookmarks: any

    bookmarks associated with the document

  • bycommittee_uploaded: boolean

    if the document was not uploaded by the candidate

  • can_submit_while_pending: boolean

    if the application can be submitted with document processing is pending

  • conversion_status: string

    status of the conversion to interfolio pdf

  • created_at: string

    date the document was created in interfolio

  • date_received: string

    date the document was received

  • description: string

    description of the document

  • document_location: string

    location of the document

  • document_original_location: string

    original location of the document

  • document_title: string

    document title

  • document_type: string

    document type

  • id: number

    document id

  • is_received: boolean

    if the document has been received

  • media_box_document_id: number

    the id of the document in the media box

  • media_format: string

    format of the document (e.g. PDF)

  • origin: string

    who the document came from (e.g. byc_user)

  • origin_document_id: number

    document id of the origin

  • required_document_id: number

    id of of the position required document

  • search_processed_at: string

    date the search was processed at

  • sort_order: number

    sort order for the document

  • thumbnail_url: string

    url of the thumbnail

  • updated_at: string

    date the document was updated

  • url: string

    url of the document

Variables

Const APPLICATION_DOC_BASE_URL_V1

APPLICATION_DOC_BASE_URL_V1: string = ...

Const APPLICATION_DOC_CREATE_ON_BEHALF_URL

APPLICATION_DOC_CREATE_ON_BEHALF_URL: string = ...

Const APPLICATION_DOC_DESTROY_ON_BEHALF_URL

APPLICATION_DOC_DESTROY_ON_BEHALF_URL: string = ...

Const APPLICATION_DOC_URL

APPLICATION_DOC_URL: string = ...

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc