Package org.apache.fineract.portfolio.note.api

Class NotesApiResource

java.lang.Object

org.apache.fineract.portfolio.note.api.NotesApiResource

@Path("/v1/{resourceType}/{resourceId}/notes")
@Component
public class NotesApiResource
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENTNOTE
static final String	GROUPNOTE
static final String	INVALIDNOTE
static final String	LOANNOTE
static final String	LOANTRANSACTIONNOTE
static final String	SAVINGNOTE

Constructor Summary

Constructors

Constructor	Description
NotesApiResource()

Method Summary

Modifier and Type	Method	Description
String	addNewNote(String resourceType, Long resourceId, String apiRequestBodyAsJson)
String	deleteNote(String resourceType, Long resourceId, Long noteId)
String	retrieveNote(String resourceType, Long resourceId, Long noteId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveNotesByResource(String resourceType, Long resourceId, jakarta.ws.rs.core.UriInfo uriInfo)
String	updateNote(String resourceType, Long resourceId, Long noteId, String apiRequestBodyAsJson)

Methods inherited from class java.lang.Object

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

Field Details

CLIENTNOTE

public static final String CLIENTNOTE

See Also:

• Constant Field Values

LOANNOTE

public static final String LOANNOTE

See Also:

• Constant Field Values

LOANTRANSACTIONNOTE

public static final String LOANTRANSACTIONNOTE

See Also:

• Constant Field Values

SAVINGNOTE

public static final String SAVINGNOTE

See Also:

• Constant Field Values

GROUPNOTE

public static final String GROUPNOTE

See Also:

• Constant Field Values

INVALIDNOTE

public static final String INVALIDNOTE

See Also:

• Constant Field Values

Constructor Details

NotesApiResource

public NotesApiResource()

Method Details

retrieveNotesByResource

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveNotesByResource(@PathParam("resourceType")
 String resourceType,
 @PathParam("resourceId")
 Long resourceId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveNote

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

addNewNote

@POST
@Consumes("application/json")
@Produces("application/json")
public String addNewNote(@PathParam("resourceType")
 String resourceType,
 @PathParam("resourceId")
 Long resourceId,
 String apiRequestBodyAsJson)

updateNote

@PUT
@Path("{noteId}")
@Consumes("application/json")
@Produces("application/json")
public String updateNote(@PathParam("resourceType")
 String resourceType,
 @PathParam("resourceId")
 Long resourceId,
 @PathParam("noteId")
 Long noteId,
 String apiRequestBodyAsJson)

deleteNote

@DELETE
@Path("{noteId}")
@Consumes("application/json")
@Produces("application/json")
public String deleteNote(@PathParam("resourceType")
 String resourceType,
 @PathParam("resourceId")
 Long resourceId,
 @PathParam("noteId")
 Long noteId)