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

Class representing api calls for documents attached to

Hierarchy

  • ApplicationDocumentApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

createDocumentOnBehalf

  • createDocumentOnBehalf(__namedParameters: { applicationId: number; fileContents?: string; fileExtension?: string; filePath?: string; format: string; positionId: number; requiredDocumentId?: number; title: string; type: string }): Promise<ApplicationDocumentUploadResponse>

  • Submit an application document on behalf of the applicant

    example
    let doc = await api.Search.ApplicationDocuments.createDocumentOnBehalf({
  applicationId: 9999,
  positionId: 9999,
  title: "Supplemental Information",
  type: "Other Document",
  format: "PDF",
  fileContents: "Here is the text of my file",
  fileExtension = 'txt',
});

    Parameters

    • __namedParameters: { applicationId: number; fileContents?: string; fileExtension?: string; filePath?: string; format: string; positionId: number; requiredDocumentId?: number; title: string; type: string }
      • applicationId: number
      • Optional fileContents?: string

        actual contents of the file

      • Optional fileExtension?: string

        (e.g. pdf, txt)

      • Optional filePath?: string

        local filepath where the document is located (either this or fileContents required)

      • format: string

        (PDF etc)

      • positionId: number
      • Optional requiredDocumentId?: number
      • title: string
      • type: string

        From the list of Interfolio document types e.g. Other Document, C.V.

    Returns Promise<ApplicationDocumentUploadResponse>

deleteDocument

  • deleteDocument(__namedParameters: { applicationId: number; documentId: number; positionId: number }): Promise<boolean>

  • Delete an application document

    example
    let deleted = await api.Search.ApplicationDocuments.deleteDocument({documentId: 9999, applicationId: 9999, positionId: 9999});

    Parameters

    • __namedParameters: { applicationId: number; documentId: number; positionId: number }
      • applicationId: number
      • documentId: number
      • positionId: number

    Returns Promise<boolean>

destroyDocumentOnBehalf

  • destroyDocumentOnBehalf(__namedParameters: { applicationId: number; documentId: number; positionId: number }): Promise<boolean>

getDocument

  • getDocument(__namedParameters: { applicationId: number; documentId: number; positionId: number }): Promise<string>

  • Get the contents of an application document that has been submitted

    example
    let document = await api.Search.ApplicationDocuments.getDocument({
  documentId: 9999,
  applicationId: 9999,
  positionId: 9999
});

    Parameters

    • __namedParameters: { applicationId: number; documentId: number; positionId: number }
      • applicationId: number
      • documentId: number
      • positionId: number

    Returns Promise<string>

saveDocument

  • saveDocument(__namedParameters: { applicationId: number; documentId: number; filePath: string; positionId: number }): Promise<string>

  • Save an application document to the local file system

    example
    await api.Search.ApplicationDocuments.saveDocument({
  documentId: 9999,
  applicationId: 9999,
  positionId: 9999,
  filepath: "/Users/username/Documents/file.pdf"
});

    Parameters

    • __namedParameters: { applicationId: number; documentId: number; filePath: string; positionId: number }
      • applicationId: number
      • documentId: number
      • filePath: string
      • positionId: number

    Returns Promise<string>

Legend

  • Class
  • Constructor
  • Property
  • Method
  • Variable
  • Function
  • Type alias

Generated using TypeDoc