ReportApi | Interfolio API

Class representing Report calls

Hierarchy

ReportApi

Index

Constructors

constructor

Properties

apiRequest

Methods

applicationSearch

Constructors

constructor

new ReportApi(config: ApiRequest | ApiConfig): ReportApi

- Defined in search/report-api.ts:130
Constructor for the object

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 ReportApi

Properties

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

applicationSearch

applicationSearch(__namedParameters: ApplicationSearchParams): Promise<ApplicationSearchData>

- Defined in search/report-api.ts:166
Retrieve applications for a position
example
```
let responses = await api.Search.Reports.applicationSearch({
  position_id: 9999,
  from: 0,
  size: 25,
});
```
Parameters
- __namedParameters: ApplicationSearchParams
Returns Promise<ApplicationSearchData>

Generated using TypeDoc