PositionTypeApi | Interfolio API

Class representing Position Type calls

Hierarchy

PositionTypeApi

Index

Constructors

constructor

Properties

apiRequest

Methods

getPositionTypes

Constructors

constructor

new PositionTypeApi(config: ApiRequest | ApiConfig): PositionTypeApi

- Defined in search/position-type-api.ts:22
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 PositionTypeApi

Properties

Readonly apiRequest

apiRequest: ApiRequest

Methods

getPositionTypes

getPositionTypes(): Promise<PositionType[]>

- Defined in search/position-type-api.ts:47
Retrieve position types
example
```
let types = await api.Search.PositionTypes.getPositionTypes();
```
Returns Promise<PositionType[]>

Generated using TypeDoc