Package org.apache.fineract.client.services

Interface CodeValuesApi

public interface CodeValuesApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostCodeValueDataResponse>	createCodeValue(Long codeId, PostCodeValuesDataRequest postCodeValuesDataRequest)	Create a Code description
retrofit2.Call<PostCodeValueDataResponse>	createCodeValue(Long codeId, PostCodeValuesDataRequest postCodeValuesDataRequest, Map<String,String> headers)	Create a Code description
retrofit2.Call<DeleteCodeValueDataResponse>	deleteCodeValue(Long codeId, Long codeValueId)	Delete a Code description Deletes a code description
retrofit2.Call<DeleteCodeValueDataResponse>	deleteCodeValue(Long codeId, Long codeValueId, Map<String,String> headers)	Delete a Code description Deletes a code description
retrofit2.Call<List<GetCodeValuesDataResponse>>	retrieveAllCodeValues(Long codeId)	List Code Values Returns the list of Code Values for a given Code Example Requests: codes/1/codevalues
retrofit2.Call<List<GetCodeValuesDataResponse>>	retrieveAllCodeValues(Long codeId, Map<String,String> headers)	List Code Values Returns the list of Code Values for a given Code Example Requests: codes/1/codevalues
retrofit2.Call<GetCodeValuesDataResponse>	retrieveCodeValue(Long codeValueId, Long codeId)	Retrieve a Code description Returns the details of a Code Value Example Requests: codes/1/codevalues/1
retrofit2.Call<GetCodeValuesDataResponse>	retrieveCodeValue(Long codeValueId, Long codeId, Map<String,String> headers)	Retrieve a Code description Returns the details of a Code Value Example Requests: codes/1/codevalues/1
retrofit2.Call<PutCodeValueDataResponse>	updateCodeValue(Long codeId, Long codeValueId, PutCodeValuesDataRequest putCodeValuesDataRequest)	Update a Code description Updates the details of a code description.
retrofit2.Call<PutCodeValueDataResponse>	updateCodeValue(Long codeId, Long codeValueId, PutCodeValuesDataRequest putCodeValuesDataRequest, Map<String,String> headers)	Update a Code description Updates the details of a code description.

Method Details

createCodeValue

@Headers("Content-Type:application/json")
@POST("v1/codes/{codeId}/codevalues")
retrofit2.Call<PostCodeValueDataResponse> createCodeValue(@Path("codeId")
 Long codeId,
 @Body
 PostCodeValuesDataRequest postCodeValuesDataRequest)

Create a Code description

Parameters:

codeId - codeId (required)

postCodeValuesDataRequest - (required)

Returns:

Call<PostCodeValueDataResponse>

deleteCodeValue

@DELETE("v1/codes/{codeId}/codevalues/{codeValueId}")
retrofit2.Call<DeleteCodeValueDataResponse> deleteCodeValue(@Path("codeId")
 Long codeId,
 @Path("codeValueId")
 Long codeValueId)

Delete a Code description Deletes a code description

Parameters:

codeId - codeId (required)

codeValueId - codeValueId (required)

Returns:

Call<DeleteCodeValueDataResponse>

retrieveAllCodeValues

@GET("v1/codes/{codeId}/codevalues")
retrofit2.Call<List<GetCodeValuesDataResponse>> retrieveAllCodeValues(@Path("codeId")
 Long codeId)

List Code Values Returns the list of Code Values for a given Code Example Requests: codes/1/codevalues

Parameters:

codeId - codeId (required)

Returns:

Call<List<GetCodeValuesDataResponse>>

retrieveCodeValue

@GET("v1/codes/{codeId}/codevalues/{codeValueId}")
retrofit2.Call<GetCodeValuesDataResponse> retrieveCodeValue(@Path("codeValueId")
 Long codeValueId,
 @Path("codeId")
 Long codeId)

Retrieve a Code description Returns the details of a Code Value Example Requests: codes/1/codevalues/1

Parameters:

codeValueId - codeValueId (required)

codeId - codeId (required)

Returns:

Call<GetCodeValuesDataResponse>

updateCodeValue

@Headers("Content-Type:application/json")
@PUT("v1/codes/{codeId}/codevalues/{codeValueId}")
retrofit2.Call<PutCodeValueDataResponse> updateCodeValue(@Path("codeId")
 Long codeId,
 @Path("codeValueId")
 Long codeValueId,
 @Body
 PutCodeValuesDataRequest putCodeValuesDataRequest)

Update a Code description Updates the details of a code description.

Parameters:

codeId - codeId (required)

codeValueId - codeValueId (required)

putCodeValuesDataRequest - (required)

Returns:

Call<PutCodeValueDataResponse>

createCodeValue

@Headers("Content-Type:application/json")
@POST("v1/codes/{codeId}/codevalues")
retrofit2.Call<PostCodeValueDataResponse> createCodeValue(@Path("codeId")
 Long codeId,
 @Body
 PostCodeValuesDataRequest postCodeValuesDataRequest,
 @HeaderMap
 Map<String,String> headers)

Create a Code description

Parameters:

codeId - codeId (required)

postCodeValuesDataRequest - (required)

Returns:

Call<PostCodeValueDataResponse>

deleteCodeValue

@DELETE("v1/codes/{codeId}/codevalues/{codeValueId}")
retrofit2.Call<DeleteCodeValueDataResponse> deleteCodeValue(@Path("codeId")
 Long codeId,
 @Path("codeValueId")
 Long codeValueId,
 @HeaderMap
 Map<String,String> headers)

Delete a Code description Deletes a code description

Parameters:

codeId - codeId (required)

codeValueId - codeValueId (required)

Returns:

Call<DeleteCodeValueDataResponse>

retrieveAllCodeValues

@GET("v1/codes/{codeId}/codevalues")
retrofit2.Call<List<GetCodeValuesDataResponse>> retrieveAllCodeValues(@Path("codeId")
 Long codeId,
 @HeaderMap
 Map<String,String> headers)

List Code Values Returns the list of Code Values for a given Code Example Requests: codes/1/codevalues

Parameters:

codeId - codeId (required)

Returns:

Call<List<GetCodeValuesDataResponse>>

retrieveCodeValue

@GET("v1/codes/{codeId}/codevalues/{codeValueId}")
retrofit2.Call<GetCodeValuesDataResponse> retrieveCodeValue(@Path("codeValueId")
 Long codeValueId,
 @Path("codeId")
 Long codeId,
 @HeaderMap
 Map<String,String> headers)

Retrieve a Code description Returns the details of a Code Value Example Requests: codes/1/codevalues/1

Parameters:

codeValueId - codeValueId (required)

codeId - codeId (required)

Returns:

Call<GetCodeValuesDataResponse>

updateCodeValue

@Headers("Content-Type:application/json")
@PUT("v1/codes/{codeId}/codevalues/{codeValueId}")
retrofit2.Call<PutCodeValueDataResponse> updateCodeValue(@Path("codeId")
 Long codeId,
 @Path("codeValueId")
 Long codeValueId,
 @Body
 PutCodeValuesDataRequest putCodeValuesDataRequest,
 @HeaderMap
 Map<String,String> headers)

Update a Code description Updates the details of a code description.

Parameters:

codeId - codeId (required)

codeValueId - codeValueId (required)

putCodeValuesDataRequest - (required)

Returns:

Call<PutCodeValueDataResponse>