@ukkidney/ukrdc-axios-ts
    Preparing search index...

    Function CodesApiFp

    • CodesApi - functional programming interface

      Parameters

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

      • getCodeDetails: function
        • Retreive a list of internal codes

          Parameters

          • codingStandard: string
          • code: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getCodeExclusions: function
        • Retreive a list of internal code maps

          Parameters

          • OptionalcodingStandard: string[]
          • Optionalcode: string[]
          • Optionalsystem: string[]
          • Optionalpage: number
          • Optionalsize: number
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getCodeExclusionsExport: function
        • Export a CSV of a list of internal codes

          Parameters

          • OptionalcodingStandard: string[]
          • Optionalcode: string[]
          • Optionalsystem: string[]
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getCodeList: function
        • Retreive a list of internal codes

          Parameters

          • OptionalcodingStandard: string[]
          • Optionalsearch: string
          • Optionalpage: number
          • Optionalsize: number
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getCodeListExport: function
        • Export a CSV of a list of internal codes

          Parameters

          • OptionalcodingStandard: string[]
          • Optionalsearch: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getCodeMaps: function
        • Retreive a list of internal code maps

          Parameters

          • OptionalsourceCodingStandard: string[]
          • OptionaldestinationCodingStandard: string[]
          • OptionalsourceCode: string
          • OptionaldestinationCode: string
          • Optionalpage: number
          • Optionalsize: number
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getCodeMapsExport: function
        • Export a CSV of a list of internal codes

          Parameters

          • OptionalsourceCodingStandard: string[]
          • OptionaldestinationCodingStandard: string[]
          • OptionalsourceCode: string
          • OptionaldestinationCode: string
          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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

      • getCodingStandardsList: function
        • Retreive a list of internal codeing standards

          Parameters

          • Optionaloptions: AxiosRequestConfig

            Override http request option.

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