Package org.apache.fineract.infrastructure.codes.api

Class CodesApiResource

java.lang.Object

org.apache.fineract.infrastructure.codes.api.CodesApiResource

@Path("/v1/codes")
@Component
public class CodesApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
CodesApiResource()

Method Summary

Modifier and Type	Method	Description
String	createCode(String apiRequestBodyAsJson)
String	deleteCode(Long codeId)
String	retrieveCode(Long codeId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveCodeByName(String codeName, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveCodes(jakarta.ws.rs.core.UriInfo uriInfo)
String	updateCode(Long codeId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

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

Constructor Details

CodesApiResource

public CodesApiResource()

Method Details

retrieveCodes

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveCodes(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

createCode

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

retrieveCode

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

retrieveCodeByName

@GET
@Path("name/{codeName}")
@Consumes("application/json")
@Produces("application/json")
public String retrieveCodeByName(@PathParam("codeName")
 String codeName,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

updateCode

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

deleteCode

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