Package org.apache.fineract.client.services

Interface RateApi

public interface RateApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<CommandProcessingResult>	createRate()
retrofit2.Call<CommandProcessingResult>	createRate(Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	createRate(RateRequest rateRequest)
retrofit2.Call<CommandProcessingResult>	createRate(RateRequest rateRequest, Map<String,String> headers)
retrofit2.Call<List<RateData>>	getAllRates()
retrofit2.Call<List<RateData>>	getAllRates(Map<String,String> headers)
retrofit2.Call<RateData>	retrieveRate(Long rateId)
retrofit2.Call<RateData>	retrieveRate(Long rateId, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	updateRate(Long rateId)
retrofit2.Call<CommandProcessingResult>	updateRate(Long rateId, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	updateRate(Long rateId, RateRequest rateRequest)
retrofit2.Call<CommandProcessingResult>	updateRate(Long rateId, RateRequest rateRequest, Map<String,String> headers)

Method Details

createRate

@Headers("Content-Type:application/json")
@POST("v1/rates")
retrofit2.Call<CommandProcessingResult> createRate(@Body
 RateRequest rateRequest)

Parameters:

rateRequest - (optional)

Returns:

Call<CommandProcessingResult>

getAllRates

@GET("v1/rates")
retrofit2.Call<List<RateData>> getAllRates()

Returns:

Call<List<RateData>>

retrieveRate

@GET("v1/rates/{rateId}")
retrofit2.Call<RateData> retrieveRate(@Path("rateId")
 Long rateId)

Parameters:

rateId - (required)

Returns:

Call<RateData>

updateRate

@Headers("Content-Type:application/json")
@PUT("v1/rates/{rateId}")
retrofit2.Call<CommandProcessingResult> updateRate(@Path("rateId")
 Long rateId,
 @Body
 RateRequest rateRequest)

Parameters:

rateId - (required)

rateRequest - (optional)

Returns:

Call<CommandProcessingResult>

createRate

@Headers("Content-Type:application/json")
@POST("v1/rates")
retrofit2.Call<CommandProcessingResult> createRate()

Parameters:

rateRequest - (optional)

Returns:

Call<CommandProcessingResult>

updateRate

@Headers("Content-Type:application/json")
@PUT("v1/rates/{rateId}")
retrofit2.Call<CommandProcessingResult> updateRate(@Path("rateId")
 Long rateId)

Parameters:

rateId - (required)

rateRequest - (optional)

Returns:

Call<CommandProcessingResult>

createRate

@Headers("Content-Type:application/json")
@POST("v1/rates")
retrofit2.Call<CommandProcessingResult> createRate(@Body
 RateRequest rateRequest,
 @HeaderMap
 Map<String,String> headers)

Parameters:

rateRequest - (optional)

Returns:

Call<CommandProcessingResult>

getAllRates

@GET("v1/rates")
retrofit2.Call<List<RateData>> getAllRates(@HeaderMap
 Map<String,String> headers)

Returns:

Call<List<RateData>>

retrieveRate

@GET("v1/rates/{rateId}")
retrofit2.Call<RateData> retrieveRate(@Path("rateId")
 Long rateId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

rateId - (required)

Returns:

Call<RateData>

updateRate

@Headers("Content-Type:application/json")
@PUT("v1/rates/{rateId}")
retrofit2.Call<CommandProcessingResult> updateRate(@Path("rateId")
 Long rateId,
 @Body
 RateRequest rateRequest,
 @HeaderMap
 Map<String,String> headers)

Parameters:

rateId - (required)

rateRequest - (optional)

Returns:

Call<CommandProcessingResult>

createRate

@Headers("Content-Type:application/json")
@POST("v1/rates")
retrofit2.Call<CommandProcessingResult> createRate(@HeaderMap
 Map<String,String> headers)

Parameters:

rateRequest - (optional)

Returns:

Call<CommandProcessingResult>

updateRate

@Headers("Content-Type:application/json")
@PUT("v1/rates/{rateId}")
retrofit2.Call<CommandProcessingResult> updateRate(@Path("rateId")
 Long rateId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

rateId - (required)

rateRequest - (optional)

Returns:

Call<CommandProcessingResult>