Class CodesApi

CodesApi - object-oriented interface

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:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration

Methods

getCodeDetails

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

getCodeExclusions

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

getCodeExclusionsExport

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

getCodeList

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

getCodeListExport

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

getCodeMaps

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

getCodeMapsExport

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

getCodingStandardsList

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

Class CodesApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CodesApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getCodeDetails

Parameters

Returns Promise<AxiosResponse<ExtendedCodeSchema, any, {}>>

Throws

getCodeExclusions

Parameters

Returns Promise<AxiosResponse<PageCodeExclusionSchema, any, {}>>

Throws

getCodeExclusionsExport

Parameters

Returns Promise<AxiosResponse<string, any, {}>>

Throws

getCodeList

Parameters

Returns Promise<AxiosResponse<PageCodeSchema, any, {}>>

Throws

getCodeListExport

Parameters

Returns Promise<AxiosResponse<string, any, {}>>

Throws

getCodeMaps

Parameters

Returns Promise<AxiosResponse<PageCodeMapSchema, any, {}>>

Throws

getCodeMapsExport

Parameters

Returns Promise<AxiosResponse<string, any, {}>>

Throws

getCodingStandardsList

Parameters

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

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration