Package org.apache.fineract.client.services

Interface GuarantorsApi

public interface GuarantorsApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<GuarantorData>	accountsTemplate(Long loanId, Long clientId)
retrofit2.Call<GuarantorData>	accountsTemplate(Long loanId, Long clientId, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	createGuarantor(Long loanId)
retrofit2.Call<CommandProcessingResult>	createGuarantor(Long loanId, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	createGuarantor(Long loanId, GuarantorsRequest guarantorsRequest)
retrofit2.Call<CommandProcessingResult>	createGuarantor(Long loanId, GuarantorsRequest guarantorsRequest, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	deleteGuarantor(Long loanId, Long guarantorId, Long guarantorFundingId)
retrofit2.Call<CommandProcessingResult>	deleteGuarantor(Long loanId, Long guarantorId, Long guarantorFundingId, Map<String,String> headers)
retrofit2.Call<Void>	getGuarantorTemplate(Long loanId, Long officeId, String dateFormat)
retrofit2.Call<Void>	getGuarantorTemplate(Long loanId, Long officeId, String dateFormat, Map<String,String> headers)
retrofit2.Call<GuarantorData>	newGuarantorTemplate(Long loanId)
retrofit2.Call<GuarantorData>	newGuarantorTemplate(Long loanId, Map<String,String> headers)
retrofit2.Call<String>	postGuarantorTemplate(Long loanId, String dateFormat, String locale, okhttp3.MultipartBody.Part uploadedInputStream)
retrofit2.Call<String>	postGuarantorTemplate(Long loanId, String dateFormat, String locale, okhttp3.MultipartBody.Part uploadedInputStream, Map<String,String> headers)
retrofit2.Call<List<GuarantorData>>	retrieveGuarantorDetails(Long loanId)
retrofit2.Call<List<GuarantorData>>	retrieveGuarantorDetails(Long loanId, Map<String,String> headers)
retrofit2.Call<GuarantorData>	retrieveGuarantorDetails1(Long loanId, Long guarantorId)
retrofit2.Call<GuarantorData>	retrieveGuarantorDetails1(Long loanId, Long guarantorId, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	updateGuarantor(Long loanId, Long guarantorId)
retrofit2.Call<CommandProcessingResult>	updateGuarantor(Long loanId, Long guarantorId, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	updateGuarantor(Long loanId, Long guarantorId, GuarantorsRequest guarantorsRequest)
retrofit2.Call<CommandProcessingResult>	updateGuarantor(Long loanId, Long guarantorId, GuarantorsRequest guarantorsRequest, Map<String,String> headers)

Method Details

accountsTemplate

@GET("v1/loans/{loanId}/guarantors/accounts/template")
retrofit2.Call<GuarantorData> accountsTemplate(@Path("loanId")
 Long loanId,
 @Query("clientId")
 Long clientId)

Parameters:

loanId - (required)

clientId - (optional)

Returns:

Call<GuarantorData>

createGuarantor

@Headers("Content-Type:application/json")
@POST("v1/loans/{loanId}/guarantors")
retrofit2.Call<CommandProcessingResult> createGuarantor(@Path("loanId")
 Long loanId,
 @Body
 GuarantorsRequest guarantorsRequest)

Parameters:

loanId - (required)

guarantorsRequest - (optional)

Returns:

Call<CommandProcessingResult>

deleteGuarantor

@DELETE("v1/loans/{loanId}/guarantors/{guarantorId}")
retrofit2.Call<CommandProcessingResult> deleteGuarantor(@Path("loanId")
 Long loanId,
 @Path("guarantorId")
 Long guarantorId,
 @Query("guarantorFundingId")
 Long guarantorFundingId)

Parameters:

loanId - (required)

guarantorId - (required)

guarantorFundingId - (optional)

Returns:

Call<CommandProcessingResult>

getGuarantorTemplate

@GET("v1/loans/{loanId}/guarantors/downloadtemplate")
retrofit2.Call<Void> getGuarantorTemplate(@Path("loanId")
 Long loanId,
 @Query("officeId")
 Long officeId,
 @Query("dateFormat")
 String dateFormat)

Parameters:

loanId - (required)

officeId - (optional)

dateFormat - (optional)

Returns:

Call<Void>

newGuarantorTemplate

@GET("v1/loans/{loanId}/guarantors/template")
retrofit2.Call<GuarantorData> newGuarantorTemplate(@Path("loanId")
 Long loanId)

Parameters:

loanId - (required)

Returns:

Call<GuarantorData>

postGuarantorTemplate

@Multipart
@POST("v1/loans/{loanId}/guarantors/uploadtemplate")
retrofit2.Call<String> postGuarantorTemplate(@Path("loanId")
 Long loanId,
 @Part("dateFormat")
 String dateFormat,
 @Part("locale")
 String locale,
 @Part
 okhttp3.MultipartBody.Part uploadedInputStream)

Parameters:

loanId - (required)

dateFormat - (optional)

locale - (optional)

uploadedInputStream - (optional)

Returns:

Call<String>

retrieveGuarantorDetails

@GET("v1/loans/{loanId}/guarantors")
retrofit2.Call<List<GuarantorData>> retrieveGuarantorDetails(@Path("loanId")
 Long loanId)

Parameters:

loanId - (required)

Returns:

Call<List<GuarantorData>>

retrieveGuarantorDetails1

@GET("v1/loans/{loanId}/guarantors/{guarantorId}")
retrofit2.Call<GuarantorData> retrieveGuarantorDetails1(@Path("loanId")
 Long loanId,
 @Path("guarantorId")
 Long guarantorId)

Parameters:

loanId - (required)

guarantorId - (required)

Returns:

Call<GuarantorData>

updateGuarantor

@Headers("Content-Type:application/json")
@PUT("v1/loans/{loanId}/guarantors/{guarantorId}")
retrofit2.Call<CommandProcessingResult> updateGuarantor(@Path("loanId")
 Long loanId,
 @Path("guarantorId")
 Long guarantorId,
 @Body
 GuarantorsRequest guarantorsRequest)

Parameters:

loanId - (required)

guarantorId - (required)

guarantorsRequest - (optional)

Returns:

Call<CommandProcessingResult>

createGuarantor

@Headers("Content-Type:application/json")
@POST("v1/loans/{loanId}/guarantors")
retrofit2.Call<CommandProcessingResult> createGuarantor(@Path("loanId")
 Long loanId)

Parameters:

loanId - (required)

guarantorsRequest - (optional)

Returns:

Call<CommandProcessingResult>

updateGuarantor

@Headers("Content-Type:application/json")
@PUT("v1/loans/{loanId}/guarantors/{guarantorId}")
retrofit2.Call<CommandProcessingResult> updateGuarantor(@Path("loanId")
 Long loanId,
 @Path("guarantorId")
 Long guarantorId)

Parameters:

loanId - (required)

guarantorId - (required)

guarantorsRequest - (optional)

Returns:

Call<CommandProcessingResult>

accountsTemplate

@GET("v1/loans/{loanId}/guarantors/accounts/template")
retrofit2.Call<GuarantorData> accountsTemplate(@Path("loanId")
 Long loanId,
 @Query("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

clientId - (optional)

Returns:

Call<GuarantorData>

createGuarantor

@Headers("Content-Type:application/json")
@POST("v1/loans/{loanId}/guarantors")
retrofit2.Call<CommandProcessingResult> createGuarantor(@Path("loanId")
 Long loanId,
 @Body
 GuarantorsRequest guarantorsRequest,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

guarantorsRequest - (optional)

Returns:

Call<CommandProcessingResult>

deleteGuarantor

@DELETE("v1/loans/{loanId}/guarantors/{guarantorId}")
retrofit2.Call<CommandProcessingResult> deleteGuarantor(@Path("loanId")
 Long loanId,
 @Path("guarantorId")
 Long guarantorId,
 @Query("guarantorFundingId")
 Long guarantorFundingId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

guarantorId - (required)

guarantorFundingId - (optional)

Returns:

Call<CommandProcessingResult>

getGuarantorTemplate

@GET("v1/loans/{loanId}/guarantors/downloadtemplate")
retrofit2.Call<Void> getGuarantorTemplate(@Path("loanId")
 Long loanId,
 @Query("officeId")
 Long officeId,
 @Query("dateFormat")
 String dateFormat,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

officeId - (optional)

dateFormat - (optional)

Returns:

Call<Void>

newGuarantorTemplate

@GET("v1/loans/{loanId}/guarantors/template")
retrofit2.Call<GuarantorData> newGuarantorTemplate(@Path("loanId")
 Long loanId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

Returns:

Call<GuarantorData>

postGuarantorTemplate

@Multipart
@POST("v1/loans/{loanId}/guarantors/uploadtemplate")
retrofit2.Call<String> postGuarantorTemplate(@Path("loanId")
 Long loanId,
 @Part("dateFormat")
 String dateFormat,
 @Part("locale")
 String locale,
 @Part
 okhttp3.MultipartBody.Part uploadedInputStream,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

dateFormat - (optional)

locale - (optional)

uploadedInputStream - (optional)

Returns:

Call<String>

retrieveGuarantorDetails

@GET("v1/loans/{loanId}/guarantors")
retrofit2.Call<List<GuarantorData>> retrieveGuarantorDetails(@Path("loanId")
 Long loanId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

Returns:

Call<List<GuarantorData>>

retrieveGuarantorDetails1

@GET("v1/loans/{loanId}/guarantors/{guarantorId}")
retrofit2.Call<GuarantorData> retrieveGuarantorDetails1(@Path("loanId")
 Long loanId,
 @Path("guarantorId")
 Long guarantorId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

guarantorId - (required)

Returns:

Call<GuarantorData>

updateGuarantor

@Headers("Content-Type:application/json")
@PUT("v1/loans/{loanId}/guarantors/{guarantorId}")
retrofit2.Call<CommandProcessingResult> updateGuarantor(@Path("loanId")
 Long loanId,
 @Path("guarantorId")
 Long guarantorId,
 @Body
 GuarantorsRequest guarantorsRequest,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

guarantorId - (required)

guarantorsRequest - (optional)

Returns:

Call<CommandProcessingResult>

createGuarantor

@Headers("Content-Type:application/json")
@POST("v1/loans/{loanId}/guarantors")
retrofit2.Call<CommandProcessingResult> createGuarantor(@Path("loanId")
 Long loanId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

guarantorsRequest - (optional)

Returns:

Call<CommandProcessingResult>

updateGuarantor

@Headers("Content-Type:application/json")
@PUT("v1/loans/{loanId}/guarantors/{guarantorId}")
retrofit2.Call<CommandProcessingResult> updateGuarantor(@Path("loanId")
 Long loanId,
 @Path("guarantorId")
 Long guarantorId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

loanId - (required)

guarantorId - (required)

guarantorsRequest - (optional)

Returns:

Call<CommandProcessingResult>