Package org.apache.fineract.client.services

Interface AuditsApi

public interface AuditsApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<String>	retrieveAuditEntries(String actionName, String entityName, Long resourceId, Long makerId, String makerDateTimeFrom, String makerDateTimeTo, Long checkerId, String checkerDateTimeFrom, String checkerDateTimeTo, String status, Long clientId, Long loanId, Long officeId, Long groupId, Long savingsAccountId, String processingResult, String dateFormat, String locale, Integer offset, Integer limit, String orderBy, String sortOrder, Boolean paged)	List Audits Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors' data scope.
retrofit2.Call<String>	retrieveAuditEntries(String actionName, String entityName, Long resourceId, Long makerId, String makerDateTimeFrom, String makerDateTimeTo, Long checkerId, String checkerDateTimeFrom, String checkerDateTimeTo, String status, Long clientId, Long loanId, Long officeId, Long groupId, Long savingsAccountId, String processingResult, String dateFormat, String locale, Integer offset, Integer limit, String orderBy, String sortOrder, Boolean paged, Map<String,String> headers)	List Audits Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors' data scope.
retrofit2.Call<AuditData>	retrieveAuditEntry(Long auditId)	Retrieve an Audit Entry Example Requests: audits/20 audits/20?fields=madeOnDate,maker,processingResult
retrofit2.Call<AuditData>	retrieveAuditEntry(Long auditId, Map<String,String> headers)	Retrieve an Audit Entry Example Requests: audits/20 audits/20?fields=madeOnDate,maker,processingResult
retrofit2.Call<AuditSearchData>	retrieveAuditSearchTemplate()	Audit Search Template This is a convenience resource.
retrofit2.Call<AuditSearchData>	retrieveAuditSearchTemplate(Map<String,String> headers)	Audit Search Template This is a convenience resource.

Method Details

retrieveAuditEntries

@GET("v1/audits")
retrofit2.Call<String> retrieveAuditEntries(@Query("actionName")
 String actionName,
 @Query("entityName")
 String entityName,
 @Query("resourceId")
 Long resourceId,
 @Query("makerId")
 Long makerId,
 @Query("makerDateTimeFrom")
 String makerDateTimeFrom,
 @Query("makerDateTimeTo")
 String makerDateTimeTo,
 @Query("checkerId")
 Long checkerId,
 @Query("checkerDateTimeFrom")
 String checkerDateTimeFrom,
 @Query("checkerDateTimeTo")
 String checkerDateTimeTo,
 @Query("status")
 String status,
 @Query("clientId")
 Long clientId,
 @Query("loanId")
 Long loanId,
 @Query("officeId")
 Long officeId,
 @Query("groupId")
 Long groupId,
 @Query("savingsAccountId")
 Long savingsAccountId,
 @Query("processingResult")
 String processingResult,
 @Query("dateFormat")
 String dateFormat,
 @Query("locale")
 String locale,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @Query("paged")
 Boolean paged)

List Audits Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors' data scope. Also it supports pagination and sorting Example Requests: audits audits?fields=madeOnDate,maker,processingResult audits?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 audits?officeId=1 audits?officeId=1&includeJson=true

Parameters:

actionName - (optional)

entityName - (optional)

resourceId - (optional)

makerId - (optional)

makerDateTimeFrom - (optional)

makerDateTimeTo - (optional)

checkerId - (optional)

checkerDateTimeFrom - (optional)

checkerDateTimeTo - (optional)

status - (optional)

clientId - (optional)

loanId - (optional)

officeId - (optional)

groupId - (optional)

savingsAccountId - (optional)

processingResult - (optional)

dateFormat - (optional)

locale - (optional)

offset - offset (optional)

limit - limit (optional)

orderBy - orderBy (optional)

sortOrder - sortOrder (optional)

paged - paged (optional)

Returns:

Call<String>

retrieveAuditEntry

@GET("v1/audits/{auditId}")
retrofit2.Call<AuditData> retrieveAuditEntry(@Path("auditId")
 Long auditId)

Retrieve an Audit Entry Example Requests: audits/20 audits/20?fields=madeOnDate,maker,processingResult

Parameters:

auditId - (required)

Returns:

Call<AuditData>

retrieveAuditSearchTemplate

@GET("v1/audits/searchtemplate")
retrofit2.Call<AuditSearchData> retrieveAuditSearchTemplate()

Audit Search Template This is a convenience resource. It can be useful when building an Audit Search UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. Example Requests: audits/searchtemplate audits/searchtemplate?fields=actionNames

Returns:

Call<AuditSearchData>

retrieveAuditEntries

@GET("v1/audits")
retrofit2.Call<String> retrieveAuditEntries(@Query("actionName")
 String actionName,
 @Query("entityName")
 String entityName,
 @Query("resourceId")
 Long resourceId,
 @Query("makerId")
 Long makerId,
 @Query("makerDateTimeFrom")
 String makerDateTimeFrom,
 @Query("makerDateTimeTo")
 String makerDateTimeTo,
 @Query("checkerId")
 Long checkerId,
 @Query("checkerDateTimeFrom")
 String checkerDateTimeFrom,
 @Query("checkerDateTimeTo")
 String checkerDateTimeTo,
 @Query("status")
 String status,
 @Query("clientId")
 Long clientId,
 @Query("loanId")
 Long loanId,
 @Query("officeId")
 Long officeId,
 @Query("groupId")
 Long groupId,
 @Query("savingsAccountId")
 Long savingsAccountId,
 @Query("processingResult")
 String processingResult,
 @Query("dateFormat")
 String dateFormat,
 @Query("locale")
 String locale,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @Query("paged")
 Boolean paged,
 @HeaderMap
 Map<String,String> headers)

List Audits Get a 200 list of audits that match the criteria supplied and sorted by audit id in descending order, and are within the requestors' data scope. Also it supports pagination and sorting Example Requests: audits audits?fields=madeOnDate,maker,processingResult audits?makerDateTimeFrom=2013-03-25 08:00:00&makerDateTimeTo=2013-04-04 18:00:00 audits?officeId=1 audits?officeId=1&includeJson=true

Parameters:

actionName - (optional)

entityName - (optional)

resourceId - (optional)

makerId - (optional)

makerDateTimeFrom - (optional)

makerDateTimeTo - (optional)

checkerId - (optional)

checkerDateTimeFrom - (optional)

checkerDateTimeTo - (optional)

status - (optional)

clientId - (optional)

loanId - (optional)

officeId - (optional)

groupId - (optional)

savingsAccountId - (optional)

processingResult - (optional)

dateFormat - (optional)

locale - (optional)

offset - offset (optional)

limit - limit (optional)

orderBy - orderBy (optional)

sortOrder - sortOrder (optional)

paged - paged (optional)

Returns:

Call<String>

retrieveAuditEntry

@GET("v1/audits/{auditId}")
retrofit2.Call<AuditData> retrieveAuditEntry(@Path("auditId")
 Long auditId,
 @HeaderMap
 Map<String,String> headers)

Retrieve an Audit Entry Example Requests: audits/20 audits/20?fields=madeOnDate,maker,processingResult

Parameters:

auditId - (required)

Returns:

Call<AuditData>

retrieveAuditSearchTemplate

@GET("v1/audits/searchtemplate")
retrofit2.Call<AuditSearchData> retrieveAuditSearchTemplate(@HeaderMap
 Map<String,String> headers)

Audit Search Template This is a convenience resource. It can be useful when building an Audit Search UI. \"appUsers\" are data scoped to the office/branch the requestor is associated with. Example Requests: audits/searchtemplate audits/searchtemplate?fields=actionNames

Returns:

Call<AuditSearchData>