ApplicationApi | Interfolio API

Class representing packet evaluator section api calls

Hierarchy

ApplicationApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ApplicationApi(config: ApiRequest | ApiConfig): ApplicationApi

- Defined in search/positions/application-api.ts:224
Constructor for the object

Parameters
- config: ApiRequest | ApiConfig
  
  Configuration for API calls
Returns ApplicationApi

Properties

Documents

Documents: ApplicationDocumentApi

apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

create

create(__namedParameters: { email: string; firstName: string; lastName: string; positionId: number }): Promise<Application>

- Defined in search/positions/application-api.ts:257
Create a new application for a position
example
```
let application = await api.Search.Applications.create({
  positionId: 9999,
  firstName: "Jane",
  lastName: "Doe",
  email: "janedoe@example.com"
  });
```
Parameters
- __namedParameters: { email: string; firstName: string; lastName: string; positionId: number }
  - email: string
    
    email of the applicant
  - firstName: string
    
    first name of the applicant
  - lastName: string
    
    last name of the applicant
  - positionId: number
    
    position id for the application
Returns Promise<Application>

getDetail

getDetail(__namedParameters: { applicationId: number; positionId: number }): Promise<ApplicationDetail>

- Defined in search/positions/application-api.ts:298
Get an application from the application Id
example
```
let application = await api.Search.Applications.getDetail({applicationId: 9999, positionId: 9999});
```
Parameters
- __namedParameters: { applicationId: number; positionId: number }
  - applicationId: number
  - positionId: number
Returns Promise<ApplicationDetail>

Generated using TypeDoc