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

Class CentersApiResource

java.lang.Object

org.apache.fineract.portfolio.group.api.CentersApiResource

@Path("/v1/centers")
@Component
public class CentersApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
CentersApiResource()

Method Summary

Modifier and Type	Method	Description
String	activate(Long centerId, String commandParam, String apiRequestBodyAsJson, jakarta.ws.rs.core.UriInfo uriInfo)
String	create(String apiRequestBodyAsJson)
String	delete(Long centerId)
jakarta.ws.rs.core.Response	getCentersTemplate(Long officeId, Long staffId, String dateFormat)
String	postCentersTemplate(InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String locale, String dateFormat)
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, org.apache.fineract.infrastructure.core.api.DateParam meetingDateParam, String dateFormat, String locale)
String	retrieveGroupAccount(Long centerId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveOne(jakarta.ws.rs.core.UriInfo uriInfo, Long centerId, boolean staffInSelectedOfficeOnly)
String	retrieveTemplate(jakarta.ws.rs.core.UriInfo uriInfo, String commandParam, Long officeId, boolean staffInSelectedOfficeOnly)
String	update(Long centerId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

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

Constructor Details

CentersApiResource

public CentersApiResource()

Method Details

retrieveTemplate

@GET
@Path("template")
@Consumes("application/json")
@Produces("application/json")
public String retrieveTemplate(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("command")
 String commandParam,
 @QueryParam("officeId")
 Long officeId,
 @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("meetingDate")
 org.apache.fineract.infrastructure.core.api.DateParam meetingDateParam,
 @QueryParam("dateFormat")
 String dateFormat,
 @QueryParam("locale")
 String locale)

retrieveOne

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

create

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

update

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

delete

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

activate

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

retrieveGroupAccount

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

getCentersTemplate

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

postCentersTemplate

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