Class CodesApi

CodesApi - object-oriented interface

Export

CodesApi

Hierarchy

BaseAPI
- CodesApi

Index

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration

Methods

getCodeDetails

getCodeDetails(
requestParameters: CodesApiGetCodeDetailsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<ExtendedCodeSchema, any>>
Retreive a list of internal codes
Parameters
- requestParameters: CodesApiGetCodeDetailsRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ExtendedCodeSchema, any>>
Throws
Memberof
CodesApi
- Defined in api.ts:8354

getCodeExclusions

getCodeExclusions(
requestParameters?: CodesApiGetCodeExclusionsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PageCodeExclusionSchema, any>>
Retreive a list of internal code maps
Parameters
- requestParameters: CodesApiGetCodeExclusionsRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageCodeExclusionSchema, any>>
Throws
Memberof
CodesApi
- Defined in api.ts:8366

getCodeExclusionsExport

getCodeExclusionsExport(
requestParameters?: CodesApiGetCodeExclusionsExportRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<string, any>>
Export a CSV of a list of internal codes
Parameters
- requestParameters: CodesApiGetCodeExclusionsExportRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any>>
Throws
Memberof
CodesApi
- Defined in api.ts:8378

getCodeList

getCodeList(
requestParameters?: CodesApiGetCodeListRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PageCodeSchema, any>>
Retreive a list of internal codes
Parameters
- requestParameters: CodesApiGetCodeListRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageCodeSchema, any>>
Throws
Memberof
CodesApi
- Defined in api.ts:8390

getCodeListExport

getCodeListExport(
requestParameters?: CodesApiGetCodeListExportRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<string, any>>
Export a CSV of a list of internal codes
Parameters
- requestParameters: CodesApiGetCodeListExportRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any>>
Throws
Memberof
CodesApi
- Defined in api.ts:8402

getCodeMaps

getCodeMaps(
requestParameters?: CodesApiGetCodeMapsRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<PageCodeMapSchema, any>>
Retreive a list of internal code maps
Parameters
- requestParameters: CodesApiGetCodeMapsRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PageCodeMapSchema, any>>
Throws
Memberof
CodesApi
- Defined in api.ts:8414

getCodeMapsExport

getCodeMapsExport(
requestParameters?: CodesApiGetCodeMapsExportRequest,
options?: AxiosRequestConfig,
): Promise<AxiosResponse<string, any>>
Export a CSV of a list of internal codes
Parameters
- requestParameters: CodesApiGetCodeMapsExportRequest = {}
  Request parameters.
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any>>
Throws
Memberof
CodesApi
- Defined in api.ts:8426

getCodingStandardsList

getCodingStandardsList(
options?: AxiosRequestConfig,
): Promise<AxiosResponse<string[], any>>
Retreive a list of internal codeing standards
Parameters
- Optionaloptions: AxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string[], any>>
Throws
Memberof
CodesApi
- Defined in api.ts:8437

Class CodesApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CodesApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getCodeDetails

Parameters

Returns Promise<AxiosResponse<ExtendedCodeSchema, any>>

Throws

Memberof

getCodeExclusions

Parameters

Returns Promise<AxiosResponse<PageCodeExclusionSchema, any>>

Throws

Memberof

getCodeExclusionsExport

Parameters

Returns Promise<AxiosResponse<string, any>>

Throws

Memberof

getCodeList

Parameters

Returns Promise<AxiosResponse<PageCodeSchema, any>>

Throws

Memberof

getCodeListExport

Parameters

Returns Promise<AxiosResponse<string, any>>

Throws

Memberof

getCodeMaps

Parameters

Returns Promise<AxiosResponse<PageCodeMapSchema, any>>

Throws

Memberof

getCodeMapsExport

Parameters

Returns Promise<AxiosResponse<string, any>>

Throws

Memberof

getCodingStandardsList

Parameters

Returns Promise<AxiosResponse<string[], any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration