Package org.apache.fineract.client.services

Interface BatchApiApi

public interface BatchApiApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<List<BatchResponse>>	handleBatchRequests(List<BatchRequest> batchRequest, Boolean enclosingTransaction)	Batch requests in a single transaction The Apache Fineract Batch API is also capable of executing all the requests in a single transaction, by setting a Query Parameter, \"enclosingTransaction=true\".
retrofit2.Call<List<BatchResponse>>	handleBatchRequests(List<BatchRequest> batchRequest, Boolean enclosingTransaction, Map<String,String> headers)	Batch requests in a single transaction The Apache Fineract Batch API is also capable of executing all the requests in a single transaction, by setting a Query Parameter, \"enclosingTransaction=true\".

Method Details

handleBatchRequests

@Headers("Content-Type:application/json")
@POST("v1/batches")
retrofit2.Call<List<BatchResponse>> handleBatchRequests(@Body
 List<BatchRequest> batchRequest,
 @Query("enclosingTransaction")
 Boolean enclosingTransaction)

Batch requests in a single transaction The Apache Fineract Batch API is also capable of executing all the requests in a single transaction, by setting a Query Parameter, \"enclosingTransaction=true\". So, if one or more of the requests in a batch returns an erroneous response all of the Data base transactions made by other successful requests will be rolled back. If there has been a rollback in a transaction then a single response will be provided, with a '400' status code and a body consisting of the error details of the first failed request.

Parameters:

batchRequest - (required)

enclosingTransaction - enclosingTransaction (optional, default to false)

Returns:

Call<List<BatchResponse>>

handleBatchRequests

@Headers("Content-Type:application/json")
@POST("v1/batches")
retrofit2.Call<List<BatchResponse>> handleBatchRequests(@Body
 List<BatchRequest> batchRequest,
 @Query("enclosingTransaction")
 Boolean enclosingTransaction,
 @HeaderMap
 Map<String,String> headers)

Batch requests in a single transaction The Apache Fineract Batch API is also capable of executing all the requests in a single transaction, by setting a Query Parameter, \"enclosingTransaction=true\". So, if one or more of the requests in a batch returns an erroneous response all of the Data base transactions made by other successful requests will be rolled back. If there has been a rollback in a transaction then a single response will be provided, with a '400' status code and a body consisting of the error details of the first failed request.

Parameters:

batchRequest - (required)

enclosingTransaction - enclosingTransaction (optional, default to false)

Returns:

Call<List<BatchResponse>>