Package org.apache.fineract.client.services

Interface ClientFamilyMemberApi

public interface ClientFamilyMemberApi

Method Summary

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

Method Details

addClientFamilyMembers

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

Parameters:

clientId - (required)

clientFamilyMemberRequest - (optional)

Returns:

Call<CommandProcessingResult>

deleteClientFamilyMembers

@DELETE("v1/clients/{clientId}/familymembers/{familyMemberId}")
retrofit2.Call<CommandProcessingResult> deleteClientFamilyMembers(@Path("familyMemberId")
 Long familyMemberId,
 @Path("clientId")
 Long clientId)

Parameters:

familyMemberId - (required)

clientId - clientId (required)

Returns:

Call<CommandProcessingResult>

getFamilyMember

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

Parameters:

familyMemberId - (required)

clientId - clientId (required)

Returns:

Call<ClientFamilyMembersData>

getFamilyMembers

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

Parameters:

clientId - (required)

Returns:

Call<List<ClientFamilyMembersData>>

getTemplate2

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

Parameters:

clientId - (required)

Returns:

Call<ClientFamilyMembersData>

updateClientFamilyMembers

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

Parameters:

familyMemberId - (required)

clientId - clientId (required)

clientFamilyMemberRequest - (optional)

Returns:

Call<CommandProcessingResult>

addClientFamilyMembers

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

Parameters:

clientId - (required)

clientFamilyMemberRequest - (optional)

Returns:

Call<CommandProcessingResult>

updateClientFamilyMembers

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

Parameters:

familyMemberId - (required)

clientId - clientId (required)

clientFamilyMemberRequest - (optional)

Returns:

Call<CommandProcessingResult>

addClientFamilyMembers

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

Parameters:

clientId - (required)

clientFamilyMemberRequest - (optional)

Returns:

Call<CommandProcessingResult>

deleteClientFamilyMembers

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

Parameters:

familyMemberId - (required)

clientId - clientId (required)

Returns:

Call<CommandProcessingResult>

getFamilyMember

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

Parameters:

familyMemberId - (required)

clientId - clientId (required)

Returns:

Call<ClientFamilyMembersData>

getFamilyMembers

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

Parameters:

clientId - (required)

Returns:

Call<List<ClientFamilyMembersData>>

getTemplate2

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

Parameters:

clientId - (required)

Returns:

Call<ClientFamilyMembersData>

updateClientFamilyMembers

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

Parameters:

familyMemberId - (required)

clientId - clientId (required)

clientFamilyMemberRequest - (optional)

Returns:

Call<CommandProcessingResult>

addClientFamilyMembers

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

Parameters:

clientId - (required)

clientFamilyMemberRequest - (optional)

Returns:

Call<CommandProcessingResult>

updateClientFamilyMembers

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

Parameters:

familyMemberId - (required)

clientId - clientId (required)

clientFamilyMemberRequest - (optional)

Returns:

Call<CommandProcessingResult>