Package org.apache.fineract.client.services

Interface NotesApi

public interface NotesApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostResourceTypeResourceIdNotesResponse>	addNewNote(String resourceType, Long resourceId, NoteRequest noteRequest)	Add a Resource Note Adds a new note to a supported resource.
retrofit2.Call<PostResourceTypeResourceIdNotesResponse>	addNewNote(String resourceType, Long resourceId, NoteRequest noteRequest, Map<String,String> headers)	Add a Resource Note Adds a new note to a supported resource.
retrofit2.Call<DeleteResourceTypeResourceIdNotesNoteIdResponse>	deleteNote(String resourceType, Long resourceId, Long noteId)	Delete a Resource Note Deletes a Resource Note
retrofit2.Call<DeleteResourceTypeResourceIdNotesNoteIdResponse>	deleteNote(String resourceType, Long resourceId, Long noteId, Map<String,String> headers)	Delete a Resource Note Deletes a Resource Note
retrofit2.Call<NoteData>	retrieveNote(String resourceType, Long resourceId, Long noteId)	Retrieve a Resource Note Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername
retrofit2.Call<NoteData>	retrieveNote(String resourceType, Long resourceId, Long noteId, Map<String,String> headers)	Retrieve a Resource Note Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername
retrofit2.Call<List<NoteData>>	retrieveNotesByResource(String resourceType, Long resourceId)	Retrieve a Resource's description Retrieves a Resource's Notes Note: Notes are returned in descending createOn order.
retrofit2.Call<List<NoteData>>	retrieveNotesByResource(String resourceType, Long resourceId, Map<String,String> headers)	Retrieve a Resource's description Retrieves a Resource's Notes Note: Notes are returned in descending createOn order.
retrofit2.Call<PutResourceTypeResourceIdNotesNoteIdResponse>	updateNote(String resourceType, Long resourceId, Long noteId, NoteRequest noteRequest)	Update a Resource Note Updates a Resource Note
retrofit2.Call<PutResourceTypeResourceIdNotesNoteIdResponse>	updateNote(String resourceType, Long resourceId, Long noteId, NoteRequest noteRequest, Map<String,String> headers)	Update a Resource Note Updates a Resource Note

Method Details

addNewNote

@Headers("Content-Type:application/json")
@POST("v1/{resourceType}/{resourceId}/notes")
retrofit2.Call<PostResourceTypeResourceIdNotesResponse> addNewNote(@Path("resourceType")
 String resourceType,
 @Path("resourceId")
 Long resourceId,
 @Body
 NoteRequest noteRequest)

Add a Resource Note Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes

Parameters:

resourceType - resourceType (required)

resourceId - resourceId (required)

noteRequest - (required)

Returns:

Call<PostResourceTypeResourceIdNotesResponse>

deleteNote

@DELETE("v1/{resourceType}/{resourceId}/notes/{noteId}")
retrofit2.Call<DeleteResourceTypeResourceIdNotesNoteIdResponse> deleteNote(@Path("resourceType")
 String resourceType,
 @Path("resourceId")
 Long resourceId,
 @Path("noteId")
 Long noteId)

Delete a Resource Note Deletes a Resource Note

Parameters:

resourceType - resourceType (required)

resourceId - resourceId (required)

noteId - noteId (required)

Returns:

Call<DeleteResourceTypeResourceIdNotesNoteIdResponse>

retrieveNote

@GET("v1/{resourceType}/{resourceId}/notes/{noteId}")
retrofit2.Call<NoteData> retrieveNote(@Path("resourceType")
 String resourceType,
 @Path("resourceId")
 Long resourceId,
 @Path("noteId")
 Long noteId)

Retrieve a Resource Note Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername

Parameters:

resourceType - resourceType (required)

resourceId - resourceId (required)

noteId - noteId (required)

Returns:

Call<NoteData>

retrieveNotesByResource

@GET("v1/{resourceType}/{resourceId}/notes")
retrofit2.Call<List<NoteData>> retrieveNotesByResource(@Path("resourceType")
 String resourceType,
 @Path("resourceId")
 Long resourceId)

Retrieve a Resource's description Retrieves a Resource's Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername

Parameters:

resourceType - resourceType (required)

resourceId - resourceId (required)

Returns:

Call<List<NoteData>>

updateNote

@Headers("Content-Type:application/json")
@PUT("v1/{resourceType}/{resourceId}/notes/{noteId}")
retrofit2.Call<PutResourceTypeResourceIdNotesNoteIdResponse> updateNote(@Path("resourceType")
 String resourceType,
 @Path("resourceId")
 Long resourceId,
 @Path("noteId")
 Long noteId,
 @Body
 NoteRequest noteRequest)

Update a Resource Note Updates a Resource Note

Parameters:

resourceType - resourceType (required)

resourceId - resourceId (required)

noteId - noteId (required)

noteRequest - (required)

Returns:

Call<PutResourceTypeResourceIdNotesNoteIdResponse>

addNewNote

@Headers("Content-Type:application/json")
@POST("v1/{resourceType}/{resourceId}/notes")
retrofit2.Call<PostResourceTypeResourceIdNotesResponse> addNewNote(@Path("resourceType")
 String resourceType,
 @Path("resourceId")
 Long resourceId,
 @Body
 NoteRequest noteRequest,
 @HeaderMap
 Map<String,String> headers)

Add a Resource Note Adds a new note to a supported resource. Example Requests: clients/1/notes groups/1/notes

Parameters:

resourceType - resourceType (required)

resourceId - resourceId (required)

noteRequest - (required)

Returns:

Call<PostResourceTypeResourceIdNotesResponse>

deleteNote

@DELETE("v1/{resourceType}/{resourceId}/notes/{noteId}")
retrofit2.Call<DeleteResourceTypeResourceIdNotesNoteIdResponse> deleteNote(@Path("resourceType")
 String resourceType,
 @Path("resourceId")
 Long resourceId,
 @Path("noteId")
 Long noteId,
 @HeaderMap
 Map<String,String> headers)

Delete a Resource Note Deletes a Resource Note

Parameters:

resourceType - resourceType (required)

resourceId - resourceId (required)

noteId - noteId (required)

Returns:

Call<DeleteResourceTypeResourceIdNotesNoteIdResponse>

retrieveNote

@GET("v1/{resourceType}/{resourceId}/notes/{noteId}")
retrofit2.Call<NoteData> retrieveNote(@Path("resourceType")
 String resourceType,
 @Path("resourceId")
 Long resourceId,
 @Path("noteId")
 Long noteId,
 @HeaderMap
 Map<String,String> headers)

Retrieve a Resource Note Retrieves a Resource Note Example Requests: clients/1/notes/76 groups/1/notes/20 clients/1/notes/76?fields=note,createdOn,createdByUsername groups/1/notes/20?fields=note,createdOn,createdByUsername

Parameters:

resourceType - resourceType (required)

resourceId - resourceId (required)

noteId - noteId (required)

Returns:

Call<NoteData>

retrieveNotesByResource

@GET("v1/{resourceType}/{resourceId}/notes")
retrofit2.Call<List<NoteData>> retrieveNotesByResource(@Path("resourceType")
 String resourceType,
 @Path("resourceId")
 Long resourceId,
 @HeaderMap
 Map<String,String> headers)

Retrieve a Resource's description Retrieves a Resource's Notes Note: Notes are returned in descending createOn order. Example Requests: clients/2/notes groups/2/notes?fields=note,createdOn,createdByUsername

Parameters:

resourceType - resourceType (required)

resourceId - resourceId (required)

Returns:

Call<List<NoteData>>

updateNote

@Headers("Content-Type:application/json")
@PUT("v1/{resourceType}/{resourceId}/notes/{noteId}")
retrofit2.Call<PutResourceTypeResourceIdNotesNoteIdResponse> updateNote(@Path("resourceType")
 String resourceType,
 @Path("resourceId")
 Long resourceId,
 @Path("noteId")
 Long noteId,
 @Body
 NoteRequest noteRequest,
 @HeaderMap
 Map<String,String> headers)

Update a Resource Note Updates a Resource Note

Parameters:

resourceType - resourceType (required)

resourceId - resourceId (required)

noteId - noteId (required)

noteRequest - (required)

Returns:

Call<PutResourceTypeResourceIdNotesNoteIdResponse>