Package org.apache.fineract.portfolio.calendar.api

Class CalendarsApiResource

java.lang.Object

org.apache.fineract.portfolio.calendar.api.CalendarsApiResource

@Path("/v1/{entityType}/{entityId}/calendars")
@Component
public class CalendarsApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
CalendarsApiResource()

Method Summary

Modifier and Type	Method	Description
String	createCalendar(String entityType, Long entityId, String apiRequestBodyAsJson)
String	deleteCalendar(String entityType, Long entityId, Long calendarId)
String	retrieveCalendar(Long calendarId, String entityType, Long entityId, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveCalendarsByEntity(String entityType, Long entityId, jakarta.ws.rs.core.UriInfo uriInfo, String calendarType)
String	retrieveNewCalendarDetails(jakarta.ws.rs.core.UriInfo uriInfo, String entityType, Long entityId)
String	updateCalendar(String entityType, Long entityId, Long calendarId, String jsonRequestBody)

Methods inherited from class java.lang.Object

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

Constructor Details

CalendarsApiResource

public CalendarsApiResource()

Method Details

retrieveCalendar

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

retrieveCalendarsByEntity

@GET
@Consumes("application/json")
@Produces("application/json")
public String retrieveCalendarsByEntity(@PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @DefaultValue("all") @QueryParam("calendarType")
 String calendarType)

Parameters:

entityType -

entityId -

uriInfo -

calendarType -

Returns:

retrieveNewCalendarDetails

@GET
@Path("template")
@Consumes("application/json")
@Produces("application/json")
public String retrieveNewCalendarDetails(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId)

createCalendar

@POST
@Consumes("application/json")
@Produces("application/json")
public String createCalendar(@PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId,
 String apiRequestBodyAsJson)

updateCalendar

@PUT
@Path("{calendarId}")
@Consumes("application/json")
@Produces("application/json")
public String updateCalendar(@PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId,
 @PathParam("calendarId")
 Long calendarId,
 String jsonRequestBody)

deleteCalendar

@DELETE
@Path("{calendarId}")
@Consumes("application/json")
@Produces("application/json")
public String deleteCalendar(@PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId,
 @PathParam("calendarId")
 Long calendarId)