Package org.apache.fineract.portfolio.group.api

Class GroupsApiResource

java.lang.Object

org.apache.fineract.portfolio.group.api.GroupsApiResource

@Path("/v1/groups")
@Component
public class GroupsApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
GroupsApiResource()

Method Summary

Modifier and Type	Method	Description
String	activateOrGenerateCollectionSheet(Long groupId, String commandParam, Long roleId, String apiRequestBodyAsJson, jakarta.ws.rs.core.UriInfo uriInfo)
String	create(String apiRequestBodyAsJson)
String	delete(Long groupId)
jakarta.ws.rs.core.Response	getGroupsTemplate(Long officeId, Long staffId, String dateFormat)
String	postGroupTemplate(InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String locale, String dateFormat)
String	retrieveAccounts(Long groupId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveAll(jakarta.ws.rs.core.UriInfo uriInfo, Long officeId, Long staffId, String externalId, String name, String hierarchy, Boolean paged, Integer offset, Integer limit, String orderBy, String sortOrder, Boolean orphansOnly)
String	retrieveglimAccounts(Long groupId, String parentLoanAccountNo, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveGsimAccounts(Long groupId, String parentGSIMAccountNo, Long parentGSIMId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveOne(jakarta.ws.rs.core.UriInfo uriInfo, Long groupId, boolean staffInSelectedOfficeOnly, Long roleId)
String	retrieveTemplate(jakarta.ws.rs.core.UriInfo uriInfo, Long officeId, boolean isCenterGroup, Long centerId, String commandParam, boolean staffInSelectedOfficeOnly)
String	unassignLoanOfficer(Long groupId, String apiRequestBodyAsJson)
String	update(Long groupId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

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

Constructor Details

GroupsApiResource

public GroupsApiResource()

Method Details

retrieveTemplate

@GET
@Path("template")
@Consumes("application/json")
@Produces("application/json")
public String retrieveTemplate(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("officeId")
 Long officeId,
 @QueryParam("center")
 boolean isCenterGroup,
 @QueryParam("centerId")
 Long centerId,
 @QueryParam("command")
 String commandParam,
 @DefaultValue("false") @QueryParam("staffInSelectedOfficeOnly")
 boolean staffInSelectedOfficeOnly)

retrieveAll

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveAll(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("officeId")
 Long officeId,
 @QueryParam("staffId")
 Long staffId,
 @QueryParam("externalId")
 String externalId,
 @QueryParam("name")
 String name,
 @QueryParam("underHierarchy")
 String hierarchy,
 @QueryParam("paged")
 Boolean paged,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder,
 @QueryParam("orphansOnly")
 Boolean orphansOnly)

retrieveOne

@GET
@Path("{groupId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveOne(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("groupId")
 Long groupId,
 @DefaultValue("false") @QueryParam("staffInSelectedOfficeOnly")
 boolean staffInSelectedOfficeOnly,
 @QueryParam("roleId")
 Long roleId)

create

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

unassignLoanOfficer

@POST
@Path("{groupId}/command/unassign_staff")
@Consumes("application/json")
@Produces("application/json")
public String unassignLoanOfficer(@PathParam("groupId")
 Long groupId,
 String apiRequestBodyAsJson)

update

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

delete

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

activateOrGenerateCollectionSheet

@POST
@Path("{groupId}")
@Consumes("application/json")
@Produces("application/json")
public String activateOrGenerateCollectionSheet(@PathParam("groupId")
 Long groupId,
 @QueryParam("command")
 String commandParam,
 @QueryParam("roleId")
 Long roleId,
 String apiRequestBodyAsJson,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveAccounts

@GET
@Path("{groupId}/accounts")
@Consumes("application/json")
@Produces("application/json")
public String retrieveAccounts(@PathParam("groupId")
 Long groupId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getGroupsTemplate

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

postGroupTemplate

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

retrieveglimAccounts

@GET
@Path("{groupId}/glimaccounts")
@Consumes("application/json")
@Produces("application/json")
public String retrieveglimAccounts(@PathParam("groupId")
 Long groupId,
 @QueryParam("parentLoanAccountNo")
 String parentLoanAccountNo,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveGsimAccounts

@GET
@Path("{groupId}/gsimaccounts")
@Consumes("application/json")
@Produces("application/json")
public String retrieveGsimAccounts(@PathParam("groupId")
 Long groupId,
 @QueryParam("parentGSIMAccountNo")
 String parentGSIMAccountNo,
 @QueryParam("parentGSIMId")
 Long parentGSIMId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)