API | Interfolio API

Class which has references to all implemented Interfolio API calls

To initialize the API object in javascript:


const INTERFOLIO_API = require('@sas-irad/interfolio-api/lib');

const api = new INTERFOLIO_API.API({
  "restUrl": "https://logic.interfolio.com",
  "graphQlUrl": "https://caasbox.interfolio.com",
  "tenantId": 99999,
  "privateKey": "Interfolio supplied Private Key",
  "publicKey": "Interfolio supplied Public Key"
});

To inialize and use in a typescript project:

import API from '@sas-irad/interfolio-api/lib';
const api = new API({
 "restUrl": "https://logic.interfolio.com",
 "graphQlUrl": "https://caasbox.interfolio.com",
 "tenantId": 99999,
 "privateKey": "Interfolio supplied Private Key",
 "publicKey": "Interfolio supplied Public Key"
});

Hierarchy

Index

Constructors

constructor

Properties

Methods

exec

Constructors

constructor

new API(config: ApiRequest | ApiConfig): API

- Defined in index.ts:128
Creates the Interfolio API class with the tenant info and endpoint roots for accessing Interfolio data

Parameters
- config: ApiRequest | ApiConfig
  
  Configuration for API calls - of type either ApiConfig or ApiRequest
  
  note pass in ApiRequest to keep all errors in one object instance
Returns API

Properties

Readonly Core

Core: { Units: UnitApi }

Type declaration

Units: UnitApi

Readonly Search

Search: { ApplicationDocuments: ApplicationDocumentApi; Applications: ApplicationApi; PositionStatuses: PositionStatusApi; PositionTypes: PositionTypeApi; Positions: PositionApi; Reports: ReportApi }

Faculty Search api calls

Type declaration

ApplicationDocuments: ApplicationDocumentApi

Handle to the Application Document api calls
Applications: ApplicationApi

Handle to the Application Api calls
PositionStatuses: PositionStatusApi

Handle to the Position Status Api Calls
PositionTypes: PositionTypeApi

Handle to the Position Type Api Calls
Positions: PositionApi

Handle to the Search Position api calls
Reports: ReportApi

Handle to the Faculty Search Reports Api Calls

Readonly Tenure

Tenure: { CommitteeMembers: CommitteeMemberApi; Committees: CommitteeApi; EvaluatorSections: EvaluatorSectionApi; Forms: FormApi; PacketAttachments: PacketAttachmentApi; PacketTemplates: PacketTemplateApi; PacketTypes: PacketTypeApi; Packets: PacketApi; PlatformForms: PlatformFormApi; Reports: ReportApi; Statuses: StatusApi; Units: UnitApi; Users: UserApi; WorkflowStepCommittees: WorkflowStepCommitteeApi; WorkflowSteps: WorkflowStepApi }

RPT (Review, Promotion and Tenure) api calls

Type declaration

CommitteeMembers: CommitteeMemberApi

Handle to the CommitteeMember Api calls
Committees: CommitteeApi

Handle to the Committee Api calls
EvaluatorSections: EvaluatorSectionApi

Handle to Packet Evaluator Section Api calls
Forms: FormApi

Handle to the Forms Api calls
PacketAttachments: PacketAttachmentApi

Handle to the PacketAttachment Api
PacketTemplates: PacketTemplateApi

Handle to the PacketTemplate Api
PacketTypes: PacketTypeApi

Handle to the PacketType api
Packets: PacketApi

Handle to the Packet Api
PlatformForms: PlatformFormApi

Handle to the Platform Form Api
Reports: ReportApi

Handle to the Report api
Statuses: StatusApi

Handle to the Status api
Units: UnitApi

Handle to the Unit Api calls
Users: UserApi

Handle to the User Api calls
WorkflowStepCommittees: WorkflowStepCommitteeApi

Handle to the Workflow Step Committee Api Calls
WorkflowSteps: WorkflowStepApi

Handle to Workflow Step Api calls

Readonly Units

Units: UnitApi

Readonly apiRequest

apiRequest: ApiRequest

handle the the apiRequest object

Methods

exec

exec(__namedParameters: { functionName: string; functionParameters: any; moduleName?: "Tenure"; subApiName: string }): Promise<any>

- Defined in index.ts:187
Execute the designated module/subApi/function

Parameters
- __namedParameters: { functionName: string; functionParameters: any; moduleName?: "Tenure"; subApiName: string }
  - functionName: string
  - functionParameters: any
  - Optional moduleName?: "Tenure"
  - subApiName: string
Returns Promise<any>

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: ApiRequest | ApiConfig

Returns API

Properties

Readonly Core

Type declaration

Units: UnitApi

Readonly Search

Type declaration

ApplicationDocuments: ApplicationDocumentApi

Applications: ApplicationApi

PositionStatuses: PositionStatusApi

PositionTypes: PositionTypeApi

Positions: PositionApi

Reports: ReportApi

Readonly Tenure

Type declaration

CommitteeMembers: CommitteeMemberApi

Committees: CommitteeApi

EvaluatorSections: EvaluatorSectionApi

Forms: FormApi

PacketAttachments: PacketAttachmentApi

PacketTemplates: PacketTemplateApi

PacketTypes: PacketTypeApi

Packets: PacketApi

PlatformForms: PlatformFormApi

Reports: ReportApi

Statuses: StatusApi

Units: UnitApi

Users: UserApi

WorkflowStepCommittees: WorkflowStepCommitteeApi

WorkflowSteps: WorkflowStepApi

Readonly Units

Readonly apiRequest

Methods

exec

Parameters

__namedParameters: { functionName: string; functionParameters: any; moduleName?: "Tenure"; subApiName: string }

functionName: string

functionParameters: any

Optional moduleName?: "Tenure"

subApiName: string

Returns Promise<any>