Package org.apache.fineract.client.services

Interface ClientFamilyMemberApi

public interface ClientFamilyMemberApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<String>	addClientFamilyMembers(Long clientId)
retrofit2.Call<String>	addClientFamilyMembers(Long clientId, String body)
retrofit2.Call<String>	addClientFamilyMembers(Long clientId, String body, Map<String,String> headers)
retrofit2.Call<String>	addClientFamilyMembers(Long clientId, Map<String,String> headers)
retrofit2.Call<String>	deleteClientFamilyMembers(Long familyMemberId, Long clientId)
retrofit2.Call<String>	deleteClientFamilyMembers(Long familyMemberId, Long clientId, String body)
retrofit2.Call<String>	deleteClientFamilyMembers(Long familyMemberId, Long clientId, String body, Map<String,String> headers)
retrofit2.Call<String>	deleteClientFamilyMembers(Long familyMemberId, Long clientId, Map<String,String> headers)
retrofit2.Call<String>	getFamilyMember(Long familyMemberId, Long clientId)
retrofit2.Call<String>	getFamilyMember(Long familyMemberId, Long clientId, Map<String,String> headers)
retrofit2.Call<String>	getFamilyMembers(Long clientId)
retrofit2.Call<String>	getFamilyMembers(Long clientId, Map<String,String> headers)
retrofit2.Call<String>	getTemplate2(Long clientId)
retrofit2.Call<String>	getTemplate2(Long clientId, Map<String,String> headers)
retrofit2.Call<String>	updateClientFamilyMembers(Long familyMemberId, Long clientId)
retrofit2.Call<String>	updateClientFamilyMembers(Long familyMemberId, Long clientId, String body)
retrofit2.Call<String>	updateClientFamilyMembers(Long familyMemberId, Long clientId, String body, Map<String,String> headers)
retrofit2.Call<String>	updateClientFamilyMembers(Long familyMemberId, Long clientId, Map<String,String> headers)

Method Details

addClientFamilyMembers

@Headers("Content-Type:application/json")
@POST("v1/clients/{clientId}/familymembers")
retrofit2.Call<String> addClientFamilyMembers(@Path("clientId")
 Long clientId,
 @Body
 String body)

Parameters:

clientId - (required)

body - (optional)

Returns:

Call<String>

deleteClientFamilyMembers

@Headers("Content-Type:application/json")
@DELETE("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<String> deleteClientFamilyMembers(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId,
 @Body
 String body)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

body - (optional)

Returns:

Call<String>

getFamilyMember

@GET("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<String> getFamilyMember(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

Returns:

Call<String>

getFamilyMembers

@GET("v1/clients/{clientId}/familymembers")
retrofit2.Call<String> getFamilyMembers(@Path("clientId")
 Long clientId)

Parameters:

clientId - (required)

Returns:

Call<String>

getTemplate2

@GET("v1/clients/{clientId}/familymembers/template")
retrofit2.Call<String> getTemplate2(@Path("clientId")
 Long clientId)

Parameters:

clientId - (required)

Returns:

Call<String>

updateClientFamilyMembers

@Headers("Content-Type:application/json")
@PUT("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<String> updateClientFamilyMembers(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId,
 @Body
 String body)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

body - (optional)

Returns:

Call<String>

addClientFamilyMembers

@Headers("Content-Type:application/json")
@POST("v1/clients/{clientId}/familymembers")
retrofit2.Call<String> addClientFamilyMembers(@Path("clientId")
 Long clientId)

Parameters:

clientId - (required)

body - (optional)

Returns:

Call<String>

deleteClientFamilyMembers

@Headers("Content-Type:application/json")
@DELETE("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<String> deleteClientFamilyMembers(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

body - (optional)

Returns:

Call<String>

updateClientFamilyMembers

@Headers("Content-Type:application/json")
@PUT("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<String> updateClientFamilyMembers(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

body - (optional)

Returns:

Call<String>

addClientFamilyMembers

@Headers("Content-Type:application/json")
@POST("v1/clients/{clientId}/familymembers")
retrofit2.Call<String> addClientFamilyMembers(@Path("clientId")
 Long clientId,
 @Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

clientId - (required)

body - (optional)

Returns:

Call<String>

deleteClientFamilyMembers

@Headers("Content-Type:application/json")
@DELETE("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<String> deleteClientFamilyMembers(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId,
 @Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

body - (optional)

Returns:

Call<String>

getFamilyMember

@GET("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<String> getFamilyMember(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

Returns:

Call<String>

getFamilyMembers

@GET("v1/clients/{clientId}/familymembers")
retrofit2.Call<String> getFamilyMembers(@Path("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

clientId - (required)

Returns:

Call<String>

getTemplate2

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

Parameters:

clientId - (required)

Returns:

Call<String>

updateClientFamilyMembers

@Headers("Content-Type:application/json")
@PUT("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<String> updateClientFamilyMembers(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId,
 @Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

body - (optional)

Returns:

Call<String>

addClientFamilyMembers

@Headers("Content-Type:application/json")
@POST("v1/clients/{clientId}/familymembers")
retrofit2.Call<String> addClientFamilyMembers(@Path("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

clientId - (required)

body - (optional)

Returns:

Call<String>

deleteClientFamilyMembers

@Headers("Content-Type:application/json")
@DELETE("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<String> deleteClientFamilyMembers(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

body - (optional)

Returns:

Call<String>

updateClientFamilyMembers

@Headers("Content-Type:application/json")
@PUT("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<String> updateClientFamilyMembers(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

body - (optional)

Returns:

Call<String>