Package org.apache.fineract.client.services

Interface GlobalConfigurationApi

public interface GlobalConfigurationApi

  • Method Details

    • retrieveConfiguration

      @GET("v1/configurations") retrofit2.Call<GetGlobalConfigurationsResponse> retrieveConfiguration(@Query("survey") Boolean survey)
      Retrieve Global Configuration | Retrieve Global Configuration for surveys Returns the list global enable/disable configurations. Example Requests: configurations Returns the list global enable/disable survey configurations. Example Requests: configurations/survey
      Parameters:
      survey - survey (optional, default to false)
      Returns:
      Call<GetGlobalConfigurationsResponse>

    • retrieveOne3

      @GET("v1/configurations/{configId}") retrofit2.Call<GlobalConfigurationPropertyData> retrieveOne3(@Path("configId") Long configId)
      Retrieve Global Configuration Returns a global enable/disable configurations. Example Requests: configurations/1
      Parameters:
      configId - configId (required)
      Returns:
      Call<GlobalConfigurationPropertyData>

    • retrieveOneByName

      @GET("v1/configurations/name/{name}") retrofit2.Call<GlobalConfigurationPropertyData> retrieveOneByName(@Path("name") String name)
      Retrieve Global Configuration Returns a global enable/disable configuration. Example Requests: configurations/name/enable-address
      Parameters:
      name - name (required)
      Returns:
      Call<GlobalConfigurationPropertyData>

    • updateConfiguration1

      @Headers("Content-Type:application/json") @PUT("v1/configurations/{configId}") retrofit2.Call<PutGlobalConfigurationsResponse> updateConfiguration1(@Path("configId") Long configId, @Body PutGlobalConfigurationsRequest putGlobalConfigurationsRequest)
      Update Global Configuration Updates an enable/disable global configuration item.
      Parameters:
      configId - configId (required)
      putGlobalConfigurationsRequest - (required)
      Returns:
      Call<PutGlobalConfigurationsResponse>

    • updateConfigurationByName

      @Headers("Content-Type:application/json") @PUT("v1/configurations/name/{configName}") retrofit2.Call<PutGlobalConfigurationsResponse> updateConfigurationByName(@Path("configName") String configName, @Body PutGlobalConfigurationsRequest putGlobalConfigurationsRequest)
      Update Global Configuration by name Updates an enable/disable global configuration item by name
      Parameters:
      configName - configName (required)
      putGlobalConfigurationsRequest - (required)
      Returns:
      Call<PutGlobalConfigurationsResponse>

    • retrieveConfiguration

      @GET("v1/configurations") retrofit2.Call<GetGlobalConfigurationsResponse> retrieveConfiguration(@Query("survey") Boolean survey, @HeaderMap Map<String,String> headers)
      Retrieve Global Configuration | Retrieve Global Configuration for surveys Returns the list global enable/disable configurations. Example Requests: configurations Returns the list global enable/disable survey configurations. Example Requests: configurations/survey
      Parameters:
      survey - survey (optional, default to false)
      Returns:
      Call<GetGlobalConfigurationsResponse>

    • retrieveOne3

      @GET("v1/configurations/{configId}") retrofit2.Call<GlobalConfigurationPropertyData> retrieveOne3(@Path("configId") Long configId, @HeaderMap Map<String,String> headers)
      Retrieve Global Configuration Returns a global enable/disable configurations. Example Requests: configurations/1
      Parameters:
      configId - configId (required)
      Returns:
      Call<GlobalConfigurationPropertyData>

    • retrieveOneByName

      @GET("v1/configurations/name/{name}") retrofit2.Call<GlobalConfigurationPropertyData> retrieveOneByName(@Path("name") String name, @HeaderMap Map<String,String> headers)
      Retrieve Global Configuration Returns a global enable/disable configuration. Example Requests: configurations/name/enable-address
      Parameters:
      name - name (required)
      Returns:
      Call<GlobalConfigurationPropertyData>

    • updateConfiguration1

      @Headers("Content-Type:application/json") @PUT("v1/configurations/{configId}") retrofit2.Call<PutGlobalConfigurationsResponse> updateConfiguration1(@Path("configId") Long configId, @Body PutGlobalConfigurationsRequest putGlobalConfigurationsRequest, @HeaderMap Map<String,String> headers)
      Update Global Configuration Updates an enable/disable global configuration item.
      Parameters:
      configId - configId (required)
      putGlobalConfigurationsRequest - (required)
      Returns:
      Call<PutGlobalConfigurationsResponse>

    • updateConfigurationByName

      @Headers("Content-Type:application/json") @PUT("v1/configurations/name/{configName}") retrofit2.Call<PutGlobalConfigurationsResponse> updateConfigurationByName(@Path("configName") String configName, @Body PutGlobalConfigurationsRequest putGlobalConfigurationsRequest, @HeaderMap Map<String,String> headers)
      Update Global Configuration by name Updates an enable/disable global configuration item by name
      Parameters:
      configName - configName (required)
      putGlobalConfigurationsRequest - (required)
      Returns:
      Call<PutGlobalConfigurationsResponse>