Package io.goobi.viewer.api.rest.v1.records

Class CalendarResource

java.lang.Object

io.goobi.viewer.api.rest.v1.records.CalendarResource

@Path("/records/{pi}/calendar")
public class CalendarResource
extends Object

REST resource for calendar data of a record (newspapers, periodicals, multi-volume works, etc.).

Constructor Summary

Constructors

Constructor	Description
CalendarResource(HttpServletRequest request, String pi)

Method Summary

Modifier and Type	Method	Description
Response	getAvailableMonths()	Returns all year-month combinations that have calendar entries for this record as a sorted JSON array of "YYYY-MM" strings.
Response	getCalendarEntries(int year)	Returns all issues/volumes with a YEARMONTHDAY value for the given year as a flat JSON array.

Methods inherited from class java.lang.Object

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

Constructor Details

CalendarResource

public CalendarResource(@Context
 HttpServletRequest request,
 @PathParam("pi")
 String pi)

Method Details

getCalendarEntries

@GET
@Path("/{year: \\d+}")
@Produces("application/json")
public Response getCalendarEntries(@PathParam("year")
 int year)
                            throws PresentationException,
IndexUnreachableException

Returns all issues/volumes with a YEARMONTHDAY value for the given year as a flat JSON array.

Parameters:

year - Publication year

Returns:

JSON array of calendar entries

Throws:

PresentationException - if any.

IndexUnreachableException - if any.

getAvailableMonths

@GET
@Path("/months")
@Produces("application/json")
public Response getAvailableMonths()
                            throws PresentationException,
IndexUnreachableException

Returns all year-month combinations that have calendar entries for this record as a sorted JSON array of "YYYY-MM" strings. Uses Solr facet query on the YEARMONTH field — no documents loaded, just facet counts.

Returns:

JSON array of "YYYY-MM" strings

Throws:

PresentationException - if any.

IndexUnreachableException - if any.