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

    Function SystemInfoApiFactory

    • SystemInfoApi - factory interface

      Parameters

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

      Returns {
          getSystemInfo(
              options?: AxiosRequestConfig,
          ): AxiosPromise<SystemInfoSchema>;
          getSystemUser(options?: AxiosRequestConfig): AxiosPromise<UserSchema>;
          getSystemUserPreferences(
              options?: AxiosRequestConfig,
          ): AxiosPromise<UserPreferences>;
          putUpdateSystemUserPreferences(
              requestParameters: SystemInfoApiPutUpdateSystemUserPreferencesRequest,
              options?: AxiosRequestConfig,
          ): AxiosPromise<UserPreferences>;
      }

      • getSystemInfo: function
        • Retreive basic system info

          Parameters

          • Optionaloptions: AxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<SystemInfoSchema>

      • getSystemUser: function
        • Retreive basic user info

          Parameters

          • Optionaloptions: AxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<UserSchema>

      • getSystemUserPreferences: function
        • Retreive user preferences

          Parameters

          • Optionaloptions: AxiosRequestConfig

            Override http request option.

          Returns AxiosPromise<UserPreferences>

      • putUpdateSystemUserPreferences: function