Package org.apache.fineract.client.services

Interface ClientCollateralManagementApi

public interface ClientCollateralManagementApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostClientCollateralResponse>	addCollateral(Long clientId, PostClientCollateralRequest postClientCollateralRequest)	Add New Collateral For a Client Add New Collateral For a Client
retrofit2.Call<PostClientCollateralResponse>	addCollateral(Long clientId, PostClientCollateralRequest postClientCollateralRequest, Map<String,String> headers)	Add New Collateral For a Client Add New Collateral For a Client
retrofit2.Call<DeleteClientCollateralResponse>	deleteCollateral1(Long clientId, Long collateralId)	Delete Client Collateral Delete Client Collateral
retrofit2.Call<DeleteClientCollateralResponse>	deleteCollateral1(Long clientId, Long collateralId, Map<String,String> headers)	Delete Client Collateral Delete Client Collateral
retrofit2.Call<List<Object>>	getClientCollateral(Long clientId, Long prodId)	Get Clients Collateral Products Get Collateral Product of a Client
retrofit2.Call<List<Object>>	getClientCollateral(Long clientId, Long prodId, Map<String,String> headers)	Get Clients Collateral Products Get Collateral Product of a Client
retrofit2.Call<Object>	getClientCollateralData(Long clientId, Long clientCollateralId)	Get Client Collateral Data Get Client Collateral Data
retrofit2.Call<Object>	getClientCollateralData(Long clientId, Long clientCollateralId, Map<String,String> headers)	Get Client Collateral Data Get Client Collateral Data
retrofit2.Call<List<GetLoanCollateralManagementTemplate>>	getClientCollateralTemplate(Long clientId)	Get Client Collateral Template Get Client Collateral Template
retrofit2.Call<List<GetLoanCollateralManagementTemplate>>	getClientCollateralTemplate(Long clientId, Map<String,String> headers)	Get Client Collateral Template Get Client Collateral Template
retrofit2.Call<PutClientCollateralResponse>	updateCollateral1(Long clientId, Long collateralId, PutClientCollateralRequest putClientCollateralRequest)	Update New Collateral of a Client Update New Collateral of a Client
retrofit2.Call<PutClientCollateralResponse>	updateCollateral1(Long clientId, Long collateralId, PutClientCollateralRequest putClientCollateralRequest, Map<String,String> headers)	Update New Collateral of a Client Update New Collateral of a Client

Method Details

addCollateral

@Headers("Content-Type:application/json")
@POST("v1/clients/{clientId}/collaterals")
retrofit2.Call<PostClientCollateralResponse> addCollateral(@Path("clientId")
 Long clientId,
 @Body
 PostClientCollateralRequest postClientCollateralRequest)

Add New Collateral For a Client Add New Collateral For a Client

Parameters:

clientId - clientId (required)

postClientCollateralRequest - (required)

Returns:

Call<PostClientCollateralResponse>

deleteCollateral1

@DELETE("v1/clients/{clientId}/collaterals/{collateralId}")
retrofit2.Call<DeleteClientCollateralResponse> deleteCollateral1(@Path("clientId")
 Long clientId,
 @Path("collateralId")
 Long collateralId)

Delete Client Collateral Delete Client Collateral

Parameters:

clientId - clientId (required)

collateralId - collateralId (required)

Returns:

Call<DeleteClientCollateralResponse>

getClientCollateral

@GET("v1/clients/{clientId}/collaterals")
retrofit2.Call<List<Object>> getClientCollateral(@Path("clientId")
 Long clientId,
 @Query("prodId")
 Long prodId)

Get Clients Collateral Products Get Collateral Product of a Client

Parameters:

clientId - clientId (required)

prodId - prodId (optional)

Returns:

Call<List<Object>>

getClientCollateralData

@GET("v1/clients/{clientId}/collaterals/{clientCollateralId}")
retrofit2.Call<Object> getClientCollateralData(@Path("clientId")
 Long clientId,
 @Path("clientCollateralId")
 Long clientCollateralId)

Get Client Collateral Data Get Client Collateral Data

Parameters:

clientId - clientId (required)

clientCollateralId - clientCollateralId (required)

Returns:

Call<Object>

getClientCollateralTemplate

@GET("v1/clients/{clientId}/collaterals/template")
retrofit2.Call<List<GetLoanCollateralManagementTemplate>> getClientCollateralTemplate(@Path("clientId")
 Long clientId)

Get Client Collateral Template Get Client Collateral Template

Parameters:

clientId - clientId (required)

Returns:

Call<List<GetLoanCollateralManagementTemplate>>

updateCollateral1

@Headers("Content-Type:application/json")
@PUT("v1/clients/{clientId}/collaterals/{collateralId}")
retrofit2.Call<PutClientCollateralResponse> updateCollateral1(@Path("clientId")
 Long clientId,
 @Path("collateralId")
 Long collateralId,
 @Body
 PutClientCollateralRequest putClientCollateralRequest)

Update New Collateral of a Client Update New Collateral of a Client

Parameters:

clientId - clientId (required)

collateralId - collateralId (required)

putClientCollateralRequest - (required)

Returns:

Call<PutClientCollateralResponse>

addCollateral

@Headers("Content-Type:application/json")
@POST("v1/clients/{clientId}/collaterals")
retrofit2.Call<PostClientCollateralResponse> addCollateral(@Path("clientId")
 Long clientId,
 @Body
 PostClientCollateralRequest postClientCollateralRequest,
 @HeaderMap
 Map<String,String> headers)

Add New Collateral For a Client Add New Collateral For a Client

Parameters:

clientId - clientId (required)

postClientCollateralRequest - (required)

Returns:

Call<PostClientCollateralResponse>

deleteCollateral1

@DELETE("v1/clients/{clientId}/collaterals/{collateralId}")
retrofit2.Call<DeleteClientCollateralResponse> deleteCollateral1(@Path("clientId")
 Long clientId,
 @Path("collateralId")
 Long collateralId,
 @HeaderMap
 Map<String,String> headers)

Delete Client Collateral Delete Client Collateral

Parameters:

clientId - clientId (required)

collateralId - collateralId (required)

Returns:

Call<DeleteClientCollateralResponse>

getClientCollateral

@GET("v1/clients/{clientId}/collaterals")
retrofit2.Call<List<Object>> getClientCollateral(@Path("clientId")
 Long clientId,
 @Query("prodId")
 Long prodId,
 @HeaderMap
 Map<String,String> headers)

Get Clients Collateral Products Get Collateral Product of a Client

Parameters:

clientId - clientId (required)

prodId - prodId (optional)

Returns:

Call<List<Object>>

getClientCollateralData

@GET("v1/clients/{clientId}/collaterals/{clientCollateralId}")
retrofit2.Call<Object> getClientCollateralData(@Path("clientId")
 Long clientId,
 @Path("clientCollateralId")
 Long clientCollateralId,
 @HeaderMap
 Map<String,String> headers)

Get Client Collateral Data Get Client Collateral Data

Parameters:

clientId - clientId (required)

clientCollateralId - clientCollateralId (required)

Returns:

Call<Object>

getClientCollateralTemplate

@GET("v1/clients/{clientId}/collaterals/template")
retrofit2.Call<List<GetLoanCollateralManagementTemplate>> getClientCollateralTemplate(@Path("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Get Client Collateral Template Get Client Collateral Template

Parameters:

clientId - clientId (required)

Returns:

Call<List<GetLoanCollateralManagementTemplate>>

updateCollateral1

@Headers("Content-Type:application/json")
@PUT("v1/clients/{clientId}/collaterals/{collateralId}")
retrofit2.Call<PutClientCollateralResponse> updateCollateral1(@Path("clientId")
 Long clientId,
 @Path("collateralId")
 Long collateralId,
 @Body
 PutClientCollateralRequest putClientCollateralRequest,
 @HeaderMap
 Map<String,String> headers)

Update New Collateral of a Client Update New Collateral of a Client

Parameters:

clientId - clientId (required)

collateralId - collateralId (required)

putClientCollateralRequest - (required)

Returns:

Call<PutClientCollateralResponse>