Calendar Event Model
| Parameter | Type | Description |
|---|---|---|
| id Always Present | UUID/GUID | Unique identifier of the calendar. |
| title Always Present | String | Summary/Title of the event. |
| description Sometimes Present | String | Text that will appear in the events Description field. |
| location Sometimes Present | String | Text that will appear in the event Location field. |
| reminderMinutes Always Present | Number | Indicates how many minutes before the event the subscriber should be notified. |
| timezoneBclId Sometimes Present | String | A timezone identifier in Windows format. Indicates the timezone that an event occurs in. |
| timezoneIanaId Sometimes Present | String | A timezone identifier in IANA format (https://www.iana.org/time-zones). Indicates the timezone that an event occurs in. |
| startDateTimeUtc Always Present | DateTime (ISO 8601) | Date and time the event will start in UTC Timezone. |
| startDateTimeLocal Always Present | DateTime (ISO 8601) | Date and time the event will start in Timezone that it is occurs in. |
| endDateTimeLocal | DateTime (ISO 8601) | Date and time the event will end in Timezone that it is occurs in. |
| lastUpdateDateTimeUtc Always Present | DateTime (ISO 8601) | Date and time the event details were last updated, in UTC Timezone. |
| calendarTags Sometimes Present | CalendarTags[] | List of Calendar Tags associated with the event. |
| calendarTimezones Sometimes Present | CalendarTimezoneModel[] | List of Timezones associated with the event. |
| calendarCustomFields Sometimes Present | CalendarCustomFieldModel[] | List of Calendar Custom Fields associated with the event. |
Calendar Tag Model
| Parameter | Type | Description |
|---|---|---|
| id Always Present | UUID/GUID | Identifier for the calendar tag |
| text Always Present | Text | Display name of the tag |
Calendar Timezone Model
| Parameter | Type | Description |
|---|---|---|
| bclId Always Present | Text | A timezone identifier in Windows format. |
| ianaId Always Present | Text | A timezone identifier in IANA format (https://www.iana.org/time-zones). |
| offsetMinutes Always Present | Number | Offset minutes to UTC, e.g. -480 for Pacific Standard Time(-08:00:00) |
Calendar Custom Field Model
| Parameter | Type | Description |
|---|---|---|
| Name Always Present | Text | Custom field name. |
| Label Sometimes Present | Text | Display name of the custom field. |
| Url Sometimes Present | Text | URL associated with the custom field. |
| ImageUrl Sometimes Present Sometimes Present | Text | URL of the image used to display the custom field. |