Skip to content

Event

A comprehensive system for representing various types of events including single dates, date ranges, and custom events.

Defines the different types of events that can be represented

ValueDescription
singleDateA single date (and possible time)
dateRangeA period of time with a start and end date
otherOther event type (e.g., a recurring event)

A JSON example of this model.

"singleDate"

The Event union represents all possible event types.

Sub-typeDescription
SingleDateEventA single date (and possible time)
DateRangeEventA period of time with a start and end date
OtherEventOther event type (e.g., a recurring event)

A JSON example of this model.

{
"name": "Sample string value",
"eventType": "singleDate",
"date": "2025-10-09",
"description": "Sample string value",
"time": "23:15:58"
}

Base model for all events with common properties

PropertyTypeRequiredDescription
namestringYesHuman-readable name of the event
eventTypeEventTypeYesType of event (singleDate, dateRange, or other)
descriptionstringNoDescription of what this event represents

A JSON example of this model.

{
"name": "Sample string value",
"eventType": "singleDate",
"description": "Sample string value"
}

Represents an event that has a specific date (and optional time) associated with it.

PropertyTypeRequiredDescription
namestringYesHuman-readable name of the event
eventTypeEventType.singleDateYesMust be “singleDate”
dateisoDateYesDate of the event in ISO 8601 format: YYYY-MM-DD
timeisoTimeNoTime of the event in ISO 8601 format: HH:MM:SS
descriptionstringNoDescription of what this event represents

A JSON example of this model.

{
"name": "Sample string value",
"eventType": "singleDate",
"date": "2025-10-09",
"description": "Sample string value",
"time": "23:15:58"
}

Represents an event that spans a period of time with start and end dates (and optional times).

PropertyTypeRequiredDescription
namestringYesHuman-readable name of the event
eventTypeEventType.dateRangeYesMust be “dateRange”
startDateisoDateYesStart date in ISO 8601 format: YYYY-MM-DD
startTimeisoTimeNoStart time in ISO 8601 format: HH:MM:SS
endDateisoDateYesEnd date in ISO 8601 format: YYYY-MM-DD
endTimeisoTimeNoEnd time in ISO 8601 format: HH:MM:SS
descriptionstringNoDescription of what this event represents

A JSON example of this model.

{
"name": "Sample string value",
"eventType": "dateRange",
"startDate": "2025-10-09",
"endDate": "2025-10-09",
"description": "Sample string value",
"startTime": "23:15:58",
"endTime": "23:15:58"
}

Represents custom events that don’t fit the single date or date range patterns.

PropertyTypeRequiredDescription
namestringYesHuman-readable name of the event
eventTypeEventType.otherYesMust be “other”
detailsstringNoDetails of the event’s timeline
descriptionstringNoDescription of what this event represents

A JSON example of this model.

{
"name": "Sample string value",
"eventType": "other",
"description": "Applications begin being accepted",
"details": "Sample string value"
}