Package org.apache.fineract.portfolio.savings.api

Class SavingsAccountsApiResource

java.lang.Object

org.apache.fineract.portfolio.savings.api.SavingsAccountsApiResource

@Path("/v1/savingsaccounts")
@Component
public class SavingsAccountsApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
SavingsAccountsApiResource()

Method Summary

Modifier and Type	Method	Description
String	delete(Long accountId)
String	delete(String externalId)
jakarta.ws.rs.core.Response	getSavingsTemplate(Long officeId, Long staffId, String dateFormat)
jakarta.ws.rs.core.Response	getSavingsTransactionTemplate(Long officeId, String dateFormat)
String	handleCommands(Long accountId, String commandParam, String apiRequestBodyAsJson)
String	handleCommands(String externalId, String commandParam, String apiRequestBodyAsJson)
String	handleGSIMCommands(Long parentAccountId, String commandParam, String apiRequestBodyAsJson)
String	postSavingsTemplate(InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String locale, String dateFormat)
String	postSavingsTransactionTemplate(InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String locale, String dateFormat)
String	retrieveAll(jakarta.ws.rs.core.UriInfo uriInfo, String externalId, Integer offset, Integer limit, String orderBy, String sortOrder)
org.apache.fineract.portfolio.savings.data.SavingsAccountData	retrieveOne(Long accountId, boolean staffInSelectedOfficeOnly, String chargeStatus, String associations, jakarta.ws.rs.core.UriInfo uriInfo)
org.apache.fineract.portfolio.savings.data.SavingsAccountData	retrieveOne(String externalId, boolean staffInSelectedOfficeOnly, String chargeStatus, String associations, jakarta.ws.rs.core.UriInfo uriInfo)
String	submitApplication(String apiRequestBodyAsJson)
String	submitGSIMApplication(String apiRequestBodyAsJson)
String	template(Long clientId, Long groupId, Long productId, boolean staffInSelectedOfficeOnly, jakarta.ws.rs.core.UriInfo uriInfo)
String	update(Long accountId, String apiRequestBodyAsJson, String commandParam)
String	update(String externalId, String apiRequestBodyAsJson, String commandParam)
String	updateGsim(Long parentAccountId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SavingsAccountsApiResource

public SavingsAccountsApiResource()

Method Details

template

@GET
@Path("template")
@Consumes("application/json")
@Produces("application/json")
public String template(@QueryParam("clientId")
 Long clientId,
 @QueryParam("groupId")
 Long groupId,
 @QueryParam("productId")
 Long productId,
 @DefaultValue("false") @QueryParam("staffInSelectedOfficeOnly")
 boolean staffInSelectedOfficeOnly,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveAll

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveAll(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("externalId")
 String externalId,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder)

submitApplication

@POST
@Consumes("application/json")
@Produces("application/json")
public String submitApplication(String apiRequestBodyAsJson)

submitGSIMApplication

@POST
@Path("/gsim")
@Consumes("application/json")
@Produces("application/json")
public String submitGSIMApplication(String apiRequestBodyAsJson)

retrieveOne

@GET
@Path("{accountId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.portfolio.savings.data.SavingsAccountData retrieveOne(@PathParam("accountId")
 Long accountId,
 @DefaultValue("false") @QueryParam("staffInSelectedOfficeOnly")
 boolean staffInSelectedOfficeOnly,
 @DefaultValue("all") @QueryParam("chargeStatus")
 String chargeStatus,
 @QueryParam("associations")
 String associations,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveOne

@GET
@Path("/external-id/{externalId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.portfolio.savings.data.SavingsAccountData retrieveOne(@PathParam("externalId")
 String externalId,
 @DefaultValue("false") @QueryParam("staffInSelectedOfficeOnly")
 boolean staffInSelectedOfficeOnly,
 @DefaultValue("all") @QueryParam("chargeStatus")
 String chargeStatus,
 @QueryParam("associations")
 String associations,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

update

@PUT
@Path("{accountId}")
@Consumes("application/json")
@Produces("application/json")
public String update(@PathParam("accountId")
 Long accountId,
 String apiRequestBodyAsJson,
 @QueryParam("command")
 String commandParam)

update

@PUT
@Path("/external-id/{externalId}")
@Consumes("application/json")
@Produces("application/json")
public String update(@PathParam("externalId")
 String externalId,
 String apiRequestBodyAsJson,
 @QueryParam("command")
 String commandParam)

updateGsim

@PUT
@Path("/gsim/{parentAccountId}")
@Consumes("application/json")
@Produces("application/json")
public String updateGsim(@PathParam("parentAccountId")
 Long parentAccountId,
 String apiRequestBodyAsJson)

handleGSIMCommands

@POST
@Path("/gsimcommands/{parentAccountId}")
@Consumes("application/json")
@Produces("application/json")
public String handleGSIMCommands(@PathParam("parentAccountId")
 Long parentAccountId,
 @QueryParam("command")
 String commandParam,
 String apiRequestBodyAsJson)

handleCommands

@POST
@Path("{accountId}")
@Consumes("application/json")
@Produces("application/json")
public String handleCommands(@PathParam("accountId")
 Long accountId,
 @QueryParam("command")
 String commandParam,
 String apiRequestBodyAsJson)

handleCommands

@POST
@Path("/external-id/{externalId}")
@Consumes("application/json")
@Produces("application/json")
public String handleCommands(@PathParam("externalId")
 String externalId,
 @QueryParam("command")
 String commandParam,
 String apiRequestBodyAsJson)

delete

@DELETE
@Path("{accountId}")
@Consumes("application/json")
@Produces("application/json")
public String delete(@PathParam("accountId")
 Long accountId)

delete

@DELETE
@Path("/external-id/{externalId}")
@Consumes("application/json")
@Produces("application/json")
public String delete(@PathParam("externalId")
 String externalId)

getSavingsTemplate

@GET
@Path("downloadtemplate")
@Produces("application/vnd.ms-excel")
public jakarta.ws.rs.core.Response getSavingsTemplate(@QueryParam("officeId")
 Long officeId,
 @QueryParam("staffId")
 Long staffId,
 @QueryParam("dateFormat")
 String dateFormat)

postSavingsTemplate

@POST
@Path("uploadtemplate")
@Consumes("multipart/form-data")
public String postSavingsTemplate(InputStream uploadedInputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
 String locale,
 String dateFormat)

getSavingsTransactionTemplate

@GET
@Path("transactions/downloadtemplate")
@Produces("application/vnd.ms-excel")
public jakarta.ws.rs.core.Response getSavingsTransactionTemplate(@QueryParam("officeId")
 Long officeId,
 @QueryParam("dateFormat")
 String dateFormat)

postSavingsTransactionTemplate

@POST
@Path("transactions/uploadtemplate")
@Consumes("multipart/form-data")
public String postSavingsTransactionTemplate(InputStream uploadedInputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
 String locale,
 String dateFormat)