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
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	addNewNote(String resourceType, Long resourceId, NoteRequest noteRequest)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	deleteNote(String resourceType, Long resourceId, Long noteId)
org.apache.fineract.portfolio.note.data.NoteData	retrieveNote(String resourceType, Long resourceId, Long noteId)
List<org.apache.fineract.portfolio.note.data.NoteData>	retrieveNotesByResource(String resourceType, Long resourceId)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	updateNote(String resourceType, Long resourceId, Long noteId, NoteRequest noteRequest)

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 List<org.apache.fineract.portfolio.note.data.NoteData> retrieveNotesByResource(@PathParam("resourceType")
 String resourceType,
 @PathParam("resourceId")
 Long resourceId)

retrieveNote

@GET
@Path("{noteId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.portfolio.note.data.NoteData retrieveNote(@PathParam("resourceType")
 String resourceType,
 @PathParam("resourceId")
 Long resourceId,
 @PathParam("noteId")
 Long noteId)

addNewNote

@POST
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult addNewNote(@PathParam("resourceType")
 String resourceType,
 @PathParam("resourceId")
 Long resourceId,
 NoteRequest noteRequest)

updateNote

@PUT
@Path("{noteId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult updateNote(@PathParam("resourceType")
 String resourceType,
 @PathParam("resourceId")
 Long resourceId,
 @PathParam("noteId")
 Long noteId,
 NoteRequest noteRequest)

deleteNote

@DELETE
@Path("{noteId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult deleteNote(@PathParam("resourceType")
 String resourceType,
 @PathParam("resourceId")
 Long resourceId,
 @PathParam("noteId")
 Long noteId)