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?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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: Configuration | undefined

Methods

getPerson

getPerson(
requestParameters: PersonsApiGetPersonRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDto, any, {}>>
Parameters
- requestParameters: PersonsApiGetPersonRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDto, any, {}>>
Throws
Memberof
PersonsApi
- Defined in generated-client/api/persons-api.ts:397

getPersons

getPersons(
requestParameters?: PersonsApiGetPersonsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: PersonsApiGetPersonsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Throws
Memberof
PersonsApi
- Defined in generated-client/api/persons-api.ts:409