Calendar Model
| Property | Type | Description |
|---|---|---|
| code Required | String | Code Identifier for the calendar |
| name Required | String | Display name of the calendar |
| image Optional | String | Calendar image if available |
Tag Model
| Property | Type | Description |
|---|---|---|
| id Required | UUID/GUID | Identifier for the calendar tag |
| name Required | String | Display name of the tag |
Event Model
| Property | Type | Description |
|---|---|---|
| id Required | UUID/GUID | Identifier for the calendar tag |
| name Required | String | Display name of the tag |
| externalId Optional | String | Identifier that represents unique events to you |
| isExcluded Optional | Boolean | Indicates that this event is excluded from the subscriber's calendar. |
EventDetail Model
| Property | Type | Description |
|---|---|---|
| eventId Required | String | A unique identifier for the event. |
| title Required | String | Summary/Title of the event. |
| description Required | String | Text that will appear in the events Description field. |
| location Optional | String | Text that will appear in the event Location field. |
| timezone Optional | String | A Windows timezone identifier. Indicates the timezone that an event occurs in. |
| start Required | DateTime (ISO 8601) | Date and time the event will start in Timezone that it is occurs in. |
| end Required | DateTime (ISO 8601) | Date and time the event will end in Timezone that it is occurs in. |
| allDayEvent Optional | Boolean | Indicated if the event runs all day. |
| notifyBefore Optional | Number | Indicates how many minutes before the event the subscriber should be notified. |
Error Model
| Property | Type | Description |
|---|---|---|
| Code Always present | String | Represents the type of error. |
| Reason Always present | String | Explains why the error occured. |
