Class PersonsApi

PersonsApi - object-oriented interface

Export

PersonsApi

Hierarchy

BaseAPI
- PersonsApi

Index

Constructors

Properties

axios basePath configuration

Methods

getPerson getPersons

Constructors

constructor

new PersonsApi(configuration?, basePath?, axios?): PersonsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PersonsApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getPerson

getPerson(requestParameters, options?): Promise<AxiosResponse<BaseItemDto, any>>
Parameters
- requestParameters: PersonsApiGetPersonRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any>>
Summary
Get person by name.

Throws
Memberof
PersonsApi
- Defined in generated-client/api/persons-api.ts:397

getPersons

getPersons(requestParameters?, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: PersonsApiGetPersonsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets all persons.

Throws
Memberof
PersonsApi
- Defined in generated-client/api/persons-api.ts:409