Package org.apache.fineract.portfolio.products.api

Class ProductsApiResource

java.lang.Object

org.apache.fineract.portfolio.products.api.ProductsApiResource

@Path("/v1/products/{type}")
@Component
public class ProductsApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
ProductsApiResource()

Method Summary

Modifier and Type	Method	Description
String	createProduct(String productType, String apiRequestBodyAsJson)
String	handleCommands(String productType, Long productId, String commandParam, jakarta.ws.rs.core.UriInfo uriInfo, String apiRequestBodyAsJson)
String	retrieveAllProducts(String productType, Integer offset, Integer limit, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveProduct(Long productId, String productType, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveTemplate(String productType, jakarta.ws.rs.core.UriInfo uriInfo)
String	updateProduct(String productType, Long productId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

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

Constructor Details

ProductsApiResource

public ProductsApiResource()

Method Details

retrieveTemplate

@GET
@Path("template")
@Consumes("application/json")
@Produces("application/json")
public String retrieveTemplate(@PathParam("type")
 String productType,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveProduct

@GET
@Path("{productId}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveProduct(@PathParam("productId")
 Long productId,
 @PathParam("type")
 String productType,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveAllProducts

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveAllProducts(@PathParam("type")
 String productType,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

createProduct

@POST
@Consumes("application/json")
@Produces("application/json")
public String createProduct(@PathParam("type")
 String productType,
 String apiRequestBodyAsJson)

handleCommands

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

updateProduct

@PUT
@Path("{productId}")
@Consumes("application/json")
@Produces("application/json")
public String updateProduct(@PathParam("type")
 String productType,
 @PathParam("productId")
 Long productId,
 String apiRequestBodyAsJson)