Package org.apache.fineract.client.services

Interface CalendarApi

public interface CalendarApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<CommandProcessingResult>	createCalendar(String entityType, Long entityId)
retrofit2.Call<CommandProcessingResult>	createCalendar(String entityType, Long entityId, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	createCalendar(String entityType, Long entityId, CalendarRequest calendarRequest)
retrofit2.Call<CommandProcessingResult>	createCalendar(String entityType, Long entityId, CalendarRequest calendarRequest, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	deleteCalendar(String entityType, Long entityId, Long calendarId)
retrofit2.Call<CommandProcessingResult>	deleteCalendar(String entityType, Long entityId, Long calendarId, Map<String,String> headers)
retrofit2.Call<CalendarData>	retrieveCalendar(Long calendarId, String entityType, Long entityId)
retrofit2.Call<CalendarData>	retrieveCalendar(Long calendarId, String entityType, Long entityId, Map<String,String> headers)
retrofit2.Call<List<CalendarData>>	retrieveCalendarsByEntity(String entityType, Long entityId, String calendarType)
retrofit2.Call<List<CalendarData>>	retrieveCalendarsByEntity(String entityType, Long entityId, String calendarType, Map<String,String> headers)
retrofit2.Call<CalendarData>	retrieveNewCalendarDetails(String entityType, Long entityId)
retrofit2.Call<CalendarData>	retrieveNewCalendarDetails(String entityType, Long entityId, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	updateCalendar(String entityType, Long entityId, Long calendarId)
retrofit2.Call<CommandProcessingResult>	updateCalendar(String entityType, Long entityId, Long calendarId, String body)
retrofit2.Call<CommandProcessingResult>	updateCalendar(String entityType, Long entityId, Long calendarId, String body, Map<String,String> headers)
retrofit2.Call<CommandProcessingResult>	updateCalendar(String entityType, Long entityId, Long calendarId, Map<String,String> headers)

Method Details

createCalendar

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/calendars")
retrofit2.Call<CommandProcessingResult> createCalendar(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Body
 CalendarRequest calendarRequest)

Parameters:

entityType - (required)

entityId - (required)

calendarRequest - (optional)

Returns:

Call<CommandProcessingResult>

deleteCalendar

@DELETE("v1/{entityType}/{entityId}/calendars/{calendarId}")
retrofit2.Call<CommandProcessingResult> deleteCalendar(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("calendarId")
 Long calendarId)

Parameters:

entityType - (required)

entityId - (required)

calendarId - (required)

Returns:

Call<CommandProcessingResult>

retrieveCalendar

@GET("v1/{entityType}/{entityId}/calendars/{calendarId}")
retrofit2.Call<CalendarData> retrieveCalendar(@Path("calendarId")
 Long calendarId,
 @Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId)

Parameters:

calendarId - (required)

entityType - (required)

entityId - (required)

Returns:

Call<CalendarData>

retrieveCalendarsByEntity

@GET("v1/{entityType}/{entityId}/calendars")
retrofit2.Call<List<CalendarData>> retrieveCalendarsByEntity(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Query("calendarType")
 String calendarType)

Parameters:

entityType - (required)

entityId - (required)

calendarType - (optional, default to all)

Returns:

Call<List<CalendarData>>

retrieveNewCalendarDetails

@GET("v1/{entityType}/{entityId}/calendars/template")
retrofit2.Call<CalendarData> retrieveNewCalendarDetails(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId)

Parameters:

entityType - (required)

entityId - (required)

Returns:

Call<CalendarData>

updateCalendar

@Headers("Content-Type:application/json")
@PUT("v1/{entityType}/{entityId}/calendars/{calendarId}")
retrofit2.Call<CommandProcessingResult> updateCalendar(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("calendarId")
 Long calendarId,
 @Body
 String body)

Parameters:

entityType - (required)

entityId - (required)

calendarId - (required)

body - (optional)

Returns:

Call<CommandProcessingResult>

createCalendar

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/calendars")
retrofit2.Call<CommandProcessingResult> createCalendar(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId)

Parameters:

entityType - (required)

entityId - (required)

calendarRequest - (optional)

Returns:

Call<CommandProcessingResult>

updateCalendar

@Headers("Content-Type:application/json")
@PUT("v1/{entityType}/{entityId}/calendars/{calendarId}")
retrofit2.Call<CommandProcessingResult> updateCalendar(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("calendarId")
 Long calendarId)

Parameters:

entityType - (required)

entityId - (required)

calendarId - (required)

body - (optional)

Returns:

Call<CommandProcessingResult>

createCalendar

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/calendars")
retrofit2.Call<CommandProcessingResult> createCalendar(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Body
 CalendarRequest calendarRequest,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

calendarRequest - (optional)

Returns:

Call<CommandProcessingResult>

deleteCalendar

@DELETE("v1/{entityType}/{entityId}/calendars/{calendarId}")
retrofit2.Call<CommandProcessingResult> deleteCalendar(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("calendarId")
 Long calendarId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

calendarId - (required)

Returns:

Call<CommandProcessingResult>

retrieveCalendar

@GET("v1/{entityType}/{entityId}/calendars/{calendarId}")
retrofit2.Call<CalendarData> retrieveCalendar(@Path("calendarId")
 Long calendarId,
 @Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

calendarId - (required)

entityType - (required)

entityId - (required)

Returns:

Call<CalendarData>

retrieveCalendarsByEntity

@GET("v1/{entityType}/{entityId}/calendars")
retrofit2.Call<List<CalendarData>> retrieveCalendarsByEntity(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Query("calendarType")
 String calendarType,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

calendarType - (optional, default to all)

Returns:

Call<List<CalendarData>>

retrieveNewCalendarDetails

@GET("v1/{entityType}/{entityId}/calendars/template")
retrofit2.Call<CalendarData> retrieveNewCalendarDetails(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

Returns:

Call<CalendarData>

updateCalendar

@Headers("Content-Type:application/json")
@PUT("v1/{entityType}/{entityId}/calendars/{calendarId}")
retrofit2.Call<CommandProcessingResult> updateCalendar(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("calendarId")
 Long calendarId,
 @Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

calendarId - (required)

body - (optional)

Returns:

Call<CommandProcessingResult>

createCalendar

@Headers("Content-Type:application/json")
@POST("v1/{entityType}/{entityId}/calendars")
retrofit2.Call<CommandProcessingResult> createCalendar(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

calendarRequest - (optional)

Returns:

Call<CommandProcessingResult>

updateCalendar

@Headers("Content-Type:application/json")
@PUT("v1/{entityType}/{entityId}/calendars/{calendarId}")
retrofit2.Call<CommandProcessingResult> updateCalendar(@Path("entityType")
 String entityType,
 @Path("entityId")
 Long entityId,
 @Path("calendarId")
 Long calendarId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

entityType - (required)

entityId - (required)

calendarId - (required)

body - (optional)

Returns:

Call<CommandProcessingResult>