Function PersonsApiFactory

PersonsApi - factory interface

Export

PersonsApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    getPerson(
        requestParameters: PersonsApiGetPersonRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDto>;
    getPersons(
        requestParameters?: PersonsApiGetPersonsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    getPerson(
        requestParameters: PersonsApiGetPersonRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDto>;
    getPersons(
        requestParameters?: PersonsApiGetPersonsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
}
- getPerson:function
  - getPerson(
    requestParameters: PersonsApiGetPersonRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDto>
  - Parameters
    - requestParameters: PersonsApiGetPersonRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<BaseItemDto>
    Throws
    - Defined in generated-client/api/persons-api.ts:247
- getPersons:function
  - getPersons(
    requestParameters?: PersonsApiGetPersonsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>
  - Parameters
    - requestParameters: PersonsApiGetPersonsRequest = {}
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<BaseItemDtoQueryResult>
    Throws
    - Defined in generated-client/api/persons-api.ts:257
- Defined in generated-client/api/persons-api.ts:237

Function PersonsApiFactory

Export

Parameters

Returns { getPerson( requestParameters: PersonsApiGetPersonRequest, options?: RawAxiosRequestConfig, ): AxiosPromise<BaseItemDto>; getPersons( requestParameters?: PersonsApiGetPersonsRequest, options?: RawAxiosRequestConfig, ): AxiosPromise<BaseItemDtoQueryResult>;}

getPerson:function

Parameters

Returns AxiosPromise<BaseItemDto>

Throws

getPersons:function

Parameters

Returns AxiosPromise<BaseItemDtoQueryResult>

Throws

Settings

Returns {
getPerson(
requestParameters: PersonsApiGetPersonRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<BaseItemDto>;
getPersons(
requestParameters?: PersonsApiGetPersonsRequest,
options?: RawAxiosRequestConfig,
): AxiosPromise<BaseItemDtoQueryResult>;
}