Package org.apache.fineract.client.services

Interface ClientsAddressApi

public interface ClientsAddressApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostClientClientIdAddressesResponse>	addClientAddress(Long clientid, ClientAddressRequest clientAddressRequest, Long type)	Create an address for a Client Mandatory Fields : type and clientId
retrofit2.Call<PostClientClientIdAddressesResponse>	addClientAddress(Long clientid, ClientAddressRequest clientAddressRequest, Long type, Map<String,String> headers)	Create an address for a Client Mandatory Fields : type and clientId
retrofit2.Call<List<AddressData>>	getAddresses1(Long clientid, String status, Long type)	List all addresses for a Client Example Requests: client/1/addresses clients/1/addresses?status=false,true&&type=1,2,3
retrofit2.Call<List<AddressData>>	getAddresses1(Long clientid, String status, Long type, Map<String,String> headers)	List all addresses for a Client Example Requests: client/1/addresses clients/1/addresses?status=false,true&&type=1,2,3
retrofit2.Call<AddressData>	getAddressesTemplate()
retrofit2.Call<AddressData>	getAddressesTemplate(Map<String,String> headers)
retrofit2.Call<PutClientClientIdAddressesResponse>	updateClientAddress(Long clientid, ClientAddressRequest clientAddressRequest)	Update an address for a Client All the address fields can be updated by using update client address API Mandatory Fields type and addressId
retrofit2.Call<PutClientClientIdAddressesResponse>	updateClientAddress(Long clientid, ClientAddressRequest clientAddressRequest, Map<String,String> headers)	Update an address for a Client All the address fields can be updated by using update client address API Mandatory Fields type and addressId

Method Details

addClientAddress

@Headers("Content-Type:application/json")
@POST("v1/client/{clientid}/addresses")
retrofit2.Call<PostClientClientIdAddressesResponse> addClientAddress(@Path("clientid")
 Long clientid,
 @Body
 ClientAddressRequest clientAddressRequest,
 @Query("type")
 Long type)

Create an address for a Client Mandatory Fields : type and clientId

Parameters:

clientid - clientId (required)

clientAddressRequest - (required)

type - type (optional)

Returns:

Call<PostClientClientIdAddressesResponse>

getAddresses1

@GET("v1/client/{clientid}/addresses")
retrofit2.Call<List<AddressData>> getAddresses1(@Path("clientid")
 Long clientid,
 @Query("status")
 String status,
 @Query("type")
 Long type)

List all addresses for a Client Example Requests: client/1/addresses clients/1/addresses?status=false,true&&type=1,2,3

Parameters:

clientid - clientId (required)

status - status (optional)

type - type (optional)

Returns:

Call<List<AddressData>>

getAddressesTemplate

@GET("v1/client/addresses/template")
retrofit2.Call<AddressData> getAddressesTemplate()

Returns:

Call<AddressData>

updateClientAddress

@Headers("Content-Type:application/json")
@PUT("v1/client/{clientid}/addresses")
retrofit2.Call<PutClientClientIdAddressesResponse> updateClientAddress(@Path("clientid")
 Long clientid,
 @Body
 ClientAddressRequest clientAddressRequest)

Update an address for a Client All the address fields can be updated by using update client address API Mandatory Fields type and addressId

Parameters:

clientid - clientId (required)

clientAddressRequest - (required)

Returns:

Call<PutClientClientIdAddressesResponse>

addClientAddress

@Headers("Content-Type:application/json")
@POST("v1/client/{clientid}/addresses")
retrofit2.Call<PostClientClientIdAddressesResponse> addClientAddress(@Path("clientid")
 Long clientid,
 @Body
 ClientAddressRequest clientAddressRequest,
 @Query("type")
 Long type,
 @HeaderMap
 Map<String,String> headers)

Create an address for a Client Mandatory Fields : type and clientId

Parameters:

clientid - clientId (required)

clientAddressRequest - (required)

type - type (optional)

Returns:

Call<PostClientClientIdAddressesResponse>

getAddresses1

@GET("v1/client/{clientid}/addresses")
retrofit2.Call<List<AddressData>> getAddresses1(@Path("clientid")
 Long clientid,
 @Query("status")
 String status,
 @Query("type")
 Long type,
 @HeaderMap
 Map<String,String> headers)

List all addresses for a Client Example Requests: client/1/addresses clients/1/addresses?status=false,true&&type=1,2,3

Parameters:

clientid - clientId (required)

status - status (optional)

type - type (optional)

Returns:

Call<List<AddressData>>

getAddressesTemplate

@GET("v1/client/addresses/template")
retrofit2.Call<AddressData> getAddressesTemplate(@HeaderMap
 Map<String,String> headers)

Returns:

Call<AddressData>

updateClientAddress

@Headers("Content-Type:application/json")
@PUT("v1/client/{clientid}/addresses")
retrofit2.Call<PutClientClientIdAddressesResponse> updateClientAddress(@Path("clientid")
 Long clientid,
 @Body
 ClientAddressRequest clientAddressRequest,
 @HeaderMap
 Map<String,String> headers)

Update an address for a Client All the address fields can be updated by using update client address API Mandatory Fields type and addressId

Parameters:

clientid - clientId (required)

clientAddressRequest - (required)

Returns:

Call<PutClientClientIdAddressesResponse>