Package org.apache.fineract.portfolio.client.api

Class ClientsApiResource

java.lang.Object

org.apache.fineract.portfolio.client.api.ClientsApiResource

@Path("/v1/clients")
@Component
public class ClientsApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
ClientsApiResource()

Method Summary

Modifier and Type	Method	Description
String	activate(Long clientId, String commandParam, String apiRequestBodyAsJson)
String	applyCommand(String externalId, String commandParam, String apiRequestBodyAsJson)
String	create(String apiRequestBodyAsJson)
String	delete(Long clientId)
String	delete(String externalId)
jakarta.ws.rs.core.Response	getClientTemplate(String legalFormType, Long officeId, Long staffId, String dateFormat)
String	postClientTemplate(String legalFormType, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String locale, String dateFormat)
String	retrieveAll(jakarta.ws.rs.core.UriInfo uriInfo, Long officeId, String externalId, String displayName, String firstname, String lastname, String status, Integer legalForm, String hierarchy, Integer offset, Integer limit, String orderBy, String sortOrder, Boolean orphansOnly, boolean isSelfUser)
String	retrieveAll(jakarta.ws.rs.core.UriInfo uriInfo, Long officeId, String externalId, String displayName, String firstname, String lastname, String status, String hierarchy, Integer offset, Integer limit, String orderBy, String sortOrder, Boolean orphansOnly, Integer legalForm)
String	retrieveAssociatedAccounts(Long clientId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveAssociatedAccounts(String externalId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveObligeeDetails(Long clientId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveObligeeDetails(String externalId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveOne(Long clientId, jakarta.ws.rs.core.UriInfo uriInfo, boolean staffInSelectedOfficeOnly)
String	retrieveOne(String externalId, jakarta.ws.rs.core.UriInfo uriInfo, boolean staffInSelectedOfficeOnly)
String	retrieveTemplate(jakarta.ws.rs.core.UriInfo uriInfo, Long officeId, String commandParam, boolean staffInSelectedOfficeOnly)
String	retrieveTransferTemplate(Long clientId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveTransferTemplate(String externalId, jakarta.ws.rs.core.UriInfo uriInfo)
String	update(Long clientId, String apiRequestBodyAsJson)
String	update(String externalId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

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

Constructor Details

ClientsApiResource

public ClientsApiResource()

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("commandParam")
 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("externalId")
 String externalId,
 @QueryParam("displayName")
 String displayName,
 @QueryParam("firstName")
 String firstname,
 @QueryParam("lastName")
 String lastname,
 @QueryParam("status")
 String status,
 @QueryParam("underHierarchy")
 String hierarchy,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder,
 @QueryParam("orphansOnly")
 Boolean orphansOnly,
 @QueryParam("legalForm")
 Integer legalForm)

retrieveOne

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

create

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

update

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

delete

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

activate

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

retrieveAssociatedAccounts

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

getClientTemplate

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

postClientTemplate

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

retrieveObligeeDetails

@GET
@Path("{clientId}/obligeedetails")
@Produces("application/json")
public String retrieveObligeeDetails(@PathParam("clientId")
 Long clientId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveTransferTemplate

@GET
@Path("{clientId}/transferproposaldate")
@Produces("application/json")
public String retrieveTransferTemplate(@PathParam("clientId")
 Long clientId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveOne

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

retrieveAssociatedAccounts

@GET
@Path("/external-id/{externalId}/accounts")
@Produces("application/json")
public String retrieveAssociatedAccounts(@PathParam("externalId")
 String externalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

update

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

applyCommand

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

delete

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

retrieveObligeeDetails

@GET
@Path("/external-id/{externalId}/obligeedetails")
@Produces("application/json")
public String retrieveObligeeDetails(@PathParam("externalId")
 String externalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveTransferTemplate

@GET
@Path("/external-id/{externalId}/transferproposaldate")
@Produces("application/json")
public String retrieveTransferTemplate(@PathParam("externalId")
 String externalId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveAll

public String retrieveAll(jakarta.ws.rs.core.UriInfo uriInfo,
 Long officeId,
 String externalId,
 String displayName,
 String firstname,
 String lastname,
 String status,
 Integer legalForm,
 String hierarchy,
 Integer offset,
 Integer limit,
 String orderBy,
 String sortOrder,
 Boolean orphansOnly,
 boolean isSelfUser)