Package org.apache.fineract.client.services

Interface EntityDataTableApi

public interface EntityDataTableApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostEntityDatatableChecksTemplateResponse>	createEntityDatatableCheck(PostEntityDatatableChecksTemplateRequest postEntityDatatableChecksTemplateRequest)	Create Entity-Datatable Checks Mandatory Fields : entity, status, datatableName Non-Mandatory Fields : productId
retrofit2.Call<PostEntityDatatableChecksTemplateResponse>	createEntityDatatableCheck(PostEntityDatatableChecksTemplateRequest postEntityDatatableChecksTemplateRequest, Map<String,String> headers)	Create Entity-Datatable Checks Mandatory Fields : entity, status, datatableName Non-Mandatory Fields : productId
retrofit2.Call<DeleteEntityDatatableChecksTemplateResponse>	deleteDatatable1(Long entityDatatableCheckId)	Delete Entity-Datatable Checks Deletes an existing Entity-Datatable Check
retrofit2.Call<DeleteEntityDatatableChecksTemplateResponse>	deleteDatatable1(Long entityDatatableCheckId, Map<String,String> headers)	Delete Entity-Datatable Checks Deletes an existing Entity-Datatable Check
retrofit2.Call<GetEntityDatatableChecksTemplateResponse>	getTemplate()	Retrieve Entity-Datatable Checks Template This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications.
retrofit2.Call<GetEntityDatatableChecksTemplateResponse>	getTemplate(Map<String,String> headers)	Retrieve Entity-Datatable Checks Template This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications.
retrofit2.Call<List<GetEntityDatatableChecksResponse>>	retrieveAll6(Integer status, String entity, Long productId, Integer offset, Integer limit)	List Entity-Datatable Checks The list capability of Entity-Datatable Checks can support pagination.
retrofit2.Call<List<GetEntityDatatableChecksResponse>>	retrieveAll6(Integer status, String entity, Long productId, Integer offset, Integer limit, Map<String,String> headers)	List Entity-Datatable Checks The list capability of Entity-Datatable Checks can support pagination.

Method Details

createEntityDatatableCheck

@Headers("Content-Type:application/json")
@POST("v1/entityDatatableChecks")
retrofit2.Call<PostEntityDatatableChecksTemplateResponse> createEntityDatatableCheck(@Body
 PostEntityDatatableChecksTemplateRequest postEntityDatatableChecksTemplateRequest)

Create Entity-Datatable Checks Mandatory Fields : entity, status, datatableName Non-Mandatory Fields : productId

Parameters:

postEntityDatatableChecksTemplateRequest - (required)

Returns:

Call<PostEntityDatatableChecksTemplateResponse>

deleteDatatable1

@DELETE("v1/entityDatatableChecks/{entityDatatableCheckId}")
retrofit2.Call<DeleteEntityDatatableChecksTemplateResponse> deleteDatatable1(@Path("entityDatatableCheckId")
 Long entityDatatableCheckId)

Delete Entity-Datatable Checks Deletes an existing Entity-Datatable Check

Parameters:

entityDatatableCheckId - entityDatatableCheckId (required)

Returns:

Call<DeleteEntityDatatableChecksTemplateResponse>

getTemplate

@GET("v1/entityDatatableChecks/template")
retrofit2.Call<GetEntityDatatableChecksTemplateResponse> getTemplate()

Retrieve Entity-Datatable Checks Template This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications. The template data returned consists of: Allowed description Lists Example Request: entityDatatableChecks/template

Returns:

Call<GetEntityDatatableChecksTemplateResponse>

retrieveAll6

@GET("v1/entityDatatableChecks")
retrofit2.Call<List<GetEntityDatatableChecksResponse>> retrieveAll6(@Query("status")
 Integer status,
 @Query("entity")
 String entity,
 @Query("productId")
 Long productId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit)

List Entity-Datatable Checks The list capability of Entity-Datatable Checks can support pagination. OPTIONAL ARGUMENTS offset Integer optional, defaults to 0 Indicates the result from which pagination startslimit Integer optional, defaults to 200 Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1 Example Request: entityDatatableChecks?offset=0&limit=15

Parameters:

status - status (optional)

entity - entity (optional)

productId - productId (optional)

offset - offset (optional)

limit - limit (optional)

Returns:

Call<List<GetEntityDatatableChecksResponse>>

createEntityDatatableCheck

@Headers("Content-Type:application/json")
@POST("v1/entityDatatableChecks")
retrofit2.Call<PostEntityDatatableChecksTemplateResponse> createEntityDatatableCheck(@Body
 PostEntityDatatableChecksTemplateRequest postEntityDatatableChecksTemplateRequest,
 @HeaderMap
 Map<String,String> headers)

Create Entity-Datatable Checks Mandatory Fields : entity, status, datatableName Non-Mandatory Fields : productId

Parameters:

postEntityDatatableChecksTemplateRequest - (required)

Returns:

Call<PostEntityDatatableChecksTemplateResponse>

deleteDatatable1

@DELETE("v1/entityDatatableChecks/{entityDatatableCheckId}")
retrofit2.Call<DeleteEntityDatatableChecksTemplateResponse> deleteDatatable1(@Path("entityDatatableCheckId")
 Long entityDatatableCheckId,
 @HeaderMap
 Map<String,String> headers)

Delete Entity-Datatable Checks Deletes an existing Entity-Datatable Check

Parameters:

entityDatatableCheckId - entityDatatableCheckId (required)

Returns:

Call<DeleteEntityDatatableChecksTemplateResponse>

getTemplate

@GET("v1/entityDatatableChecks/template")
retrofit2.Call<GetEntityDatatableChecksTemplateResponse> getTemplate(@HeaderMap
 Map<String,String> headers)

Retrieve Entity-Datatable Checks Template This is a convenience resource useful for building maintenance user interface screens for Entity-Datatable Checks applications. The template data returned consists of: Allowed description Lists Example Request: entityDatatableChecks/template

Returns:

Call<GetEntityDatatableChecksTemplateResponse>

retrieveAll6

@GET("v1/entityDatatableChecks")
retrofit2.Call<List<GetEntityDatatableChecksResponse>> retrieveAll6(@Query("status")
 Integer status,
 @Query("entity")
 String entity,
 @Query("productId")
 Long productId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @HeaderMap
 Map<String,String> headers)

List Entity-Datatable Checks The list capability of Entity-Datatable Checks can support pagination. OPTIONAL ARGUMENTS offset Integer optional, defaults to 0 Indicates the result from which pagination startslimit Integer optional, defaults to 200 Restricts the size of results returned. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1 Example Request: entityDatatableChecks?offset=0&limit=15

Parameters:

status - status (optional)

entity - entity (optional)

productId - productId (optional)

offset - offset (optional)

limit - limit (optional)

Returns:

Call<List<GetEntityDatatableChecksResponse>>