get
https://api.genability.com/rest/public/calendars/dates
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieve actual event dates for calendars, such as holiday dates, billing cycle dates, and pricing-period event dates.
Use this endpoint when you need the concrete CalendarDate records for a calendar, utility, locale, date range, event type, or date-definition type.
Resource URI
GET /rest/public/calendars/datesQuery parameters
| Parameter | Type | Description |
|---|---|---|
calendarId | Long | Return only dates for a specific calendar. Optional. |
lseId | Long | Return dates for a specific utility. Optional. You do not need to send this when calendarId is supplied. |
locale | String | ISO country code of the locale to return, such as US. Optional. |
fromDateTime | DateTime | Return event dates on or after this date. Optional. |
toDateTime | DateTime | Return event dates on or before this date. Optional. |
calendarEventTypes | String | Comma-separated calendar event types to include. Choices are HOLIDAY, BILLING, and PRICING_PERIOD. Optional. |
dateDefinitionTypes | String | Comma-separated date definition types to include. Choices are FIXED_DATE, MANUAL, FLOATING_DATE, and EASTER_DATE. Optional. |
For the full CalendarDate data model and examples, see Calendars.
Example
GET /rest/public/calendars/dates?calendarId=2&fromDateTime=2015-01-01&toDateTime=2015-12-31A successful response returns a standard response payload with type set to CalendarDate and results containing matching event dates.