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

Class SelfClientsApiResource

java.lang.Object

org.apache.fineract.portfolio.self.client.api.SelfClientsApiResource

@Path("/v1/self/clients")
@Component
@Conditional(SelfServiceModuleIsEnabledCondition.class)
public class SelfClientsApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
SelfClientsApiResource()

Method Summary

Modifier and Type	Method	Description
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	addNewClientImage(Long clientId, Long fileSize, InputStream inputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetails, org.glassfish.jersey.media.multipart.FormDataBodyPart bodyPart)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	addNewClientImage(String entityName, Long clientId, String jsonRequestBody)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	deleteClientImage(Long clientId)
String	retrieveAll(jakarta.ws.rs.core.UriInfo uriInfo, String displayName, String firstname, String lastname, Integer offset, String status, Integer limit, String orderBy, String sortOrder, Integer legalForm)
String	retrieveAllClientCharges(Long clientId, String chargeStatus, Boolean pendingPayment, jakarta.ws.rs.core.UriInfo uriInfo, Integer limit, Integer offset)
String	retrieveAllClientTransactions(Long clientId, jakarta.ws.rs.core.UriInfo uriInfo, Integer offset, Integer limit)
String	retrieveAssociatedAccounts(Long clientId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveClientCharge(Long clientId, Long chargeId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveClientTransaction(Long clientId, Long transactionId, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	retrieveImage(Long clientId, Integer maxWidth, Integer maxHeight, String output)
String	retrieveObligeeDetails(Long clientId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveOne(Long clientId, jakarta.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

SelfClientsApiResource

public SelfClientsApiResource()

Method Details

retrieveAll

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveAll(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("displayName")
 String displayName,
 @QueryParam("firstName")
 String firstname,
 @QueryParam("lastName")
 String lastname,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("status")
 String status,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder,
 @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)

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)

retrieveImage

@GET
@Path("{clientId}/images")
@Consumes({"text/plain","text/html","application/json"})
@Produces("text/plain")
public jakarta.ws.rs.core.Response retrieveImage(@PathParam("clientId")
 Long clientId,
 @QueryParam("maxWidth")
 Integer maxWidth,
 @QueryParam("maxHeight")
 Integer maxHeight,
 @QueryParam("output")
 String output)

retrieveAllClientCharges

@GET
@Path("{clientId}/charges")
@Consumes("application/json")
@Produces("application/json")
public String retrieveAllClientCharges(@PathParam("clientId")
 Long clientId,
 @DefaultValue("all") @QueryParam("chargeStatus")
 String chargeStatus,
 @QueryParam("pendingPayment")
 Boolean pendingPayment,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("offset")
 Integer offset)

retrieveClientCharge

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

retrieveAllClientTransactions

@GET
@Path("{clientId}/transactions")
@Consumes("application/json")
@Produces("application/json")
public String retrieveAllClientTransactions(@PathParam("clientId")
 Long clientId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit)

retrieveClientTransaction

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

addNewClientImage

@POST
@Path("{clientId}/images")
@Consumes("multipart/form-data")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult addNewClientImage(@PathParam("clientId")
 Long clientId,
 @HeaderParam("Content-Length")
 Long fileSize,
 InputStream inputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetails,
 org.glassfish.jersey.media.multipart.FormDataBodyPart bodyPart)

addNewClientImage

@POST
@Path("{clientId}/images")
@Consumes({"text/plain","text/html","application/json"})
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult addNewClientImage(@PathParam("entity")
 String entityName,
 @PathParam("clientId")
 Long clientId,
 String jsonRequestBody)

deleteClientImage

@DELETE
@Path("{clientId}/images")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult deleteClientImage(@PathParam("clientId")
 Long clientId)

retrieveObligeeDetails

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