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

    Function CodesApiFactory

    • CodesApi - factory interface

      Parameters

      • Optionalconfiguration: Configuration
      • OptionalbasePath: string
      • Optionalaxios: AxiosInstance

      Returns {
          getCodeDetails(
              requestParameters: CodesApiGetCodeDetailsRequest,
              options?: AxiosRequestConfig,
          ): AxiosPromise<ExtendedCodeSchema>;
          getCodeExclusions(
              requestParameters?: CodesApiGetCodeExclusionsRequest,
              options?: AxiosRequestConfig,
          ): AxiosPromise<PageCodeExclusionSchema>;
          getCodeExclusionsExport(
              requestParameters?: CodesApiGetCodeExclusionsExportRequest,
              options?: AxiosRequestConfig,
          ): AxiosPromise<string>;
          getCodeList(
              requestParameters?: CodesApiGetCodeListRequest,
              options?: AxiosRequestConfig,
          ): AxiosPromise<PageCodeSchema>;
          getCodeListExport(
              requestParameters?: CodesApiGetCodeListExportRequest,
              options?: AxiosRequestConfig,
          ): AxiosPromise<string>;
          getCodeMaps(
              requestParameters?: CodesApiGetCodeMapsRequest,
              options?: AxiosRequestConfig,
          ): AxiosPromise<PageCodeMapSchema>;
          getCodeMapsExport(
              requestParameters?: CodesApiGetCodeMapsExportRequest,
              options?: AxiosRequestConfig,
          ): AxiosPromise<string>;
          getCodingStandardsList(
              options?: AxiosRequestConfig,
          ): AxiosPromise<string[]>;
      }

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

          Parameters

          Returns AxiosPromise<string>

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

          Parameters

          Returns AxiosPromise<string>

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

          Parameters

          Returns AxiosPromise<string>

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

          Parameters

          • Optionaloptions: AxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<string[]>