Function CodesApiFp

Returns {
    getCodeDetails(
        codingStandard: string,
        code: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedCodeSchema>,
    >;
    getCodeExclusions(
        codingStandard?: string[] | null,
        code?: string[] | null,
        system?: string[] | null,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageCodeExclusionSchema>,
    >;
    getCodeExclusionsExport(
        codingStandard?: string[] | null,
        code?: string[] | null,
        system?: string[] | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >;
    getCodeList(
        codingStandard?: string[] | null,
        search?: string | null,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageCodeSchema>,
    >;
    getCodeListExport(
        codingStandard?: string[] | null,
        search?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >;
    getCodeMaps(
        sourceCodingStandard?: string[] | null,
        destinationCodingStandard?: string[] | null,
        sourceCode?: string | null,
        destinationCode?: string | null,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageCodeMapSchema>,
    >;
    getCodeMapsExport(
        sourceCodingStandard?: string[] | null,
        destinationCodingStandard?: string[] | null,
        sourceCode?: string | null,
        destinationCode?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >;
    getCodingStandardsList(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>,
    >;
}

• getCodeDetails: function

  • getCodeDetails(
        codingStandard: string,
        code: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedCodeSchema>,
    >

    Retreive a list of internal codes

    Parameters

    • codingStandard: string
    • code: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ExtendedCodeSchema>,
    >

    Throws

• getCodeExclusions: function

  • getCodeExclusions(
        codingStandard?: string[] | null,
        code?: string[] | null,
        system?: string[] | null,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageCodeExclusionSchema>,
    >

    Retreive a list of internal code maps

    Parameters

    • OptionalcodingStandard: string[] | null
    • Optionalcode: string[] | null
    • Optionalsystem: string[] | null
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageCodeExclusionSchema>,
    >

    Throws

• getCodeExclusionsExport: function

  • getCodeExclusionsExport(
        codingStandard?: string[] | null,
        code?: string[] | null,
        system?: string[] | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >

    Export a CSV of a list of internal codes

    Parameters

    • OptionalcodingStandard: string[] | null
    • Optionalcode: string[] | null
    • Optionalsystem: string[] | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>

    Throws

• getCodeList: function

  • getCodeList(
        codingStandard?: string[] | null,
        search?: string | null,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageCodeSchema>,
    >

    Retreive a list of internal codes

    Parameters

    • OptionalcodingStandard: string[] | null
    • Optionalsearch: string | null
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageCodeSchema>,
    >

    Throws

• getCodeListExport: function

  • getCodeListExport(
        codingStandard?: string[] | null,
        search?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >

    Export a CSV of a list of internal codes

    Parameters

    • OptionalcodingStandard: string[] | null
    • Optionalsearch: string | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>

    Throws

• getCodeMaps: function

  • getCodeMaps(
        sourceCodingStandard?: string[] | null,
        destinationCodingStandard?: string[] | null,
        sourceCode?: string | null,
        destinationCode?: string | null,
        page?: number,
        size?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageCodeMapSchema>,
    >

    Retreive a list of internal code maps

    Parameters

    • OptionalsourceCodingStandard: string[] | null
    • OptionaldestinationCodingStandard: string[] | null
    • OptionalsourceCode: string | null
    • OptionaldestinationCode: string | null
    • Optionalpage: number

      Page number

    • Optionalsize: number

      Page size

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PageCodeMapSchema>,
    >

    Throws

• getCodeMapsExport: function

  • getCodeMapsExport(
        sourceCodingStandard?: string[] | null,
        destinationCodingStandard?: string[] | null,
        sourceCode?: string | null,
        destinationCode?: string | null,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>,
    >

    Export a CSV of a list of internal codes

    Parameters

    • OptionalsourceCodingStandard: string[] | null
    • OptionaldestinationCodingStandard: string[] | null
    • OptionalsourceCode: string | null
    • OptionaldestinationCode: string | null
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>

    Throws

• getCodingStandardsList: function

  • getCodingStandardsList(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>,
    >

    Retreive a list of internal codeing standards

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>

    Throws