Microsoft: Me calendar schemas
9 Microsoft schemas with complete fields and constraints.
← Me calendar operations · All schemas
Create calendar Permission — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).allowedRoles | array | Optional | List of allowed sharing or delegating permission levels for the calendar. The possible values are: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom. |
$ (allOf 2).allowedRoles[] | JSON | Each item | |
$ (allOf 2).allowedRoles[] (anyOf 1) | string | Alternative | One of: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom |
$ (allOf 2).allowedRoles[] (anyOf 2) | JSON | Alternative | |
$ (allOf 2).allowedRoles[] (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).allowedRoles[] (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).emailAddress | JSON | Optional | Represents a share recipient or delegate who has access to the calendar. For the 'My Organization' share recipient, the address property is null. Read-only. |
$ (allOf 2).emailAddress (anyOf 1) | Model | Alternative | Expand Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name |
$ (allOf 2).emailAddress (anyOf 2) | JSON | Alternative | |
$ (allOf 2).emailAddress (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).emailAddress (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).isInsideOrganization | JSON | Optional | |
$ (allOf 2).isInsideOrganization (anyOf 1) | boolean | Alternative | True if the user in context (recipient or delegate) is inside the same organization as the calendar owner. |
$ (allOf 2).isInsideOrganization (anyOf 2) | null | Alternative | |
$ (allOf 2).isRemovable | JSON | Optional | |
$ (allOf 2).isRemovable (anyOf 1) | boolean | Alternative | True if the user can be removed from the list of recipients or delegates for the specified calendar, false otherwise. The 'My organization' user determines the permissions other people within your organization have to the given calendar. You can't remove 'My organization' as a share recipient to a calendar. |
$ (allOf 2).isRemovable (anyOf 2) | null | Alternative | |
$ (allOf 2).role | JSON | Optional | Current permission level of the calendar share recipient or delegate. |
$ (allOf 2).role (anyOf 1) | string | Alternative | One of: none, freeBusyRead, limitedRead, read, write, delegateWithoutPrivateEventAccess, delegateWithPrivateEventAccess, custom |
$ (allOf 2).role (anyOf 2) | JSON | Alternative | |
$ (allOf 2).role (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).role (anyOf 2) (anyOf 2) | null | Alternative |
Referenced models: Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name, Get rule — response body — @odata type, id
Get calendar — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (allOf 1) | Model | All variants apply | Expand Get rule — response body — @odata type, id |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).@odata.type | string | Optional | |
$ (allOf 2).allowedOnlineMeetingProviders | array | Optional | Represent the online meeting service providers that can be used to create online meetings in this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness. |
$ (allOf 2).allowedOnlineMeetingProviders[] | JSON | Each item | |
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 1) | string | Alternative | Known values: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness |
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 2) | JSON | Alternative | |
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).allowedOnlineMeetingProviders[] (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).calendarPermissions | array | Optional | The permissions of the users with whom the calendar is shared. |
$ (allOf 2).calendarPermissions[] | Model | Each item | Expand Get calendar Permission — response body |
$ (allOf 2).calendarView | array | Optional | The calendar view for the calendar. Navigation property. Read-only. |
$ (allOf 2).calendarView[] | Model | Each item | Expand Get event — response body |
$ (allOf 2).canEdit | JSON | Optional | |
$ (allOf 2).canEdit (anyOf 1) | boolean | Alternative | true if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who shared a calendar and granted write access. |
$ (allOf 2).canEdit (anyOf 2) | null | Alternative | |
$ (allOf 2).canShare | JSON | Optional | |
$ (allOf 2).canShare (anyOf 1) | boolean | Alternative | true if the user has permission to share the calendar, false otherwise. Only the user who created the calendar can share it. |
$ (allOf 2).canShare (anyOf 2) | null | Alternative | |
$ (allOf 2).canViewPrivateItems | JSON | Optional | |
$ (allOf 2).canViewPrivateItems (anyOf 1) | boolean | Alternative | If true, the user can read calendar items that have been marked private, false otherwise. |
$ (allOf 2).canViewPrivateItems (anyOf 2) | null | Alternative | |
$ (allOf 2).changeKey | JSON | Optional | |
$ (allOf 2).changeKey (anyOf 1) | string | Alternative | Identifies the version of the calendar object. Every time the calendar is changed, changeKey changes as well. This allows Exchange to apply changes to the correct version of the object. Read-only. |
$ (allOf 2).changeKey (anyOf 2) | null | Alternative | |
$ (allOf 2).color | JSON | Optional | Specifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightRed, maxColor. |
$ (allOf 2).color (anyOf 1) | string | Alternative | Known values: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightRed, maxColor |
$ (allOf 2).color (anyOf 2) | JSON | Alternative | |
$ (allOf 2).color (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).color (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).defaultOnlineMeetingProvider | JSON | Optional | The default online meeting provider for meetings sent from this calendar. The possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness. |
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 1) | string | Alternative | Known values: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness |
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 2) | JSON | Alternative | |
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).defaultOnlineMeetingProvider (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).events | array | Optional | The events in the calendar. Navigation property. Read-only. |
$ (allOf 2).events[] | Model | Each item | Expand Get event — response body |
$ (allOf 2).hexColor | JSON | Optional | |
$ (allOf 2).hexColor (anyOf 1) | string | Alternative | The calendar color, expressed in a hex color code of three hexadecimal values, each ranging from 00 to FF and representing the red, green, or blue components of the color in the RGB color space. If the user has never explicitly set a color for the calendar, this property is empty. Read-only. |
$ (allOf 2).hexColor (anyOf 2) | null | Alternative | |
$ (allOf 2).isDefaultCalendar | JSON | Optional | |
$ (allOf 2).isDefaultCalendar (anyOf 1) | boolean | Alternative | true if this is the default calendar where new events are created by default, false otherwise. |
$ (allOf 2).isDefaultCalendar (anyOf 2) | null | Alternative | |
$ (allOf 2).isRemovable | JSON | Optional | |
$ (allOf 2).isRemovable (anyOf 1) | boolean | Alternative | Indicates whether this user calendar can be deleted from the user mailbox. |
$ (allOf 2).isRemovable (anyOf 2) | null | Alternative | |
$ (allOf 2).isTallyingResponses | JSON | Optional | |
$ (allOf 2).isTallyingResponses (anyOf 1) | boolean | Alternative | Indicates whether this user calendar supports tracking of meeting responses. Only meeting invites sent from users' primary calendars support tracking of meeting responses. |
$ (allOf 2).isTallyingResponses (anyOf 2) | null | Alternative | |
$ (allOf 2).multiValueExtendedProperties | array | Optional | The collection of multi-value extended properties defined for the calendar. Read-only. Nullable. |
$ (allOf 2).multiValueExtendedProperties[] | Model | Each item | Expand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item |
$ (allOf 2).name | JSON | Optional | |
$ (allOf 2).name (anyOf 1) | string | Alternative | The calendar name. |
$ (allOf 2).name (anyOf 2) | null | Alternative | |
$ (allOf 2).owner | JSON | Optional | If set, this represents the user who created or added the calendar. For a calendar that the user created or added, the owner property is set to the user. For a calendar shared with the user, the owner property is set to the person who shared that calendar with the user. |
$ (allOf 2).owner (anyOf 1) | Model | Alternative | Expand Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name |
$ (allOf 2).owner (anyOf 2) | JSON | Alternative | |
$ (allOf 2).owner (anyOf 2) (anyOf 1) | object | Alternative | |
$ (allOf 2).owner (anyOf 2) (anyOf 2) | null | Alternative | |
$ (allOf 2).singleValueExtendedProperties | array | Optional | The collection of single-value extended properties defined for the calendar. Read-only. Nullable. |
$ (allOf 2).singleValueExtendedProperties[] | Model | Each item | Expand Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item |
Referenced models: Get calendar Permission — response body, Get calendar Permission — response body — @odata type, allowed Roles, email Address, is Inside Organization, is Removable, role email Address @odata type, address, name, Get rule — response body — @odata type, id, Get event — response body, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count multi Value Extended Properties item, Get mail Folder — response body — @odata type, child Folder Count, child Folders, display Name, is Hidden, message Rules, messages, multi Value Extended Properties, parent Folder Id, single Value Extended Properties, total Item Count, unread Item Count single Value Extended Properties item
Invoke action get Schedule — me Calendar get Schedule — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
AvailabilityViewInterval | JSON | Optional | |
AvailabilityViewInterval (anyOf 1) | number | Alternative | Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
AvailabilityViewInterval (anyOf 2) | null | Alternative | |
EndTime | JSON | Optional | |
EndTime (anyOf 1) | Model | Alternative | Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time |
EndTime (anyOf 2) | JSON | Alternative | |
EndTime (anyOf 2) (anyOf 1) | object | Alternative | |
EndTime (anyOf 2) (anyOf 2) | null | Alternative | |
Schedules | array | Optional | |
Schedules[] | JSON | Each item | |
Schedules[] (anyOf 1) | string | Alternative | |
Schedules[] (anyOf 2) | null | Alternative | |
StartTime | JSON | Optional | |
StartTime (anyOf 1) | Model | Alternative | Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time |
StartTime (anyOf 2) | JSON | Alternative | |
StartTime (anyOf 2) (anyOf 1) | object | Alternative | |
StartTime (anyOf 2) (anyOf 2) | null | Alternative |
Referenced models: Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
Invoke action get Schedule — me Calendar get Schedule — response body — value value item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
availabilityView | JSON | Optional | |
availabilityView (anyOf 1) | string | Alternative | Represents a merged view of availability of all the items in scheduleItems. The view consists of time slots. Availability during each time slot is indicated with: 0= free or working elswhere, 1= tentative, 2= busy, 3= out of office.Note: Working elsewhere is set to 0 instead of 4 for backward compatibility. For details, see the Q&A and Exchange 2007 and Exchange 2010 do not use the WorkingElsewhere value. |
availabilityView (anyOf 2) | null | Alternative | |
error | JSON | Optional | Error information from attempting to get the availability of the user, distribution list, or resource. |
error (anyOf 1) | Model | Alternative | Expand Invoke action get Schedule — me Calendar get Schedule — response body — value value item error @odata type, message, response Code |
error (anyOf 2) | JSON | Alternative | |
error (anyOf 2) (anyOf 1) | object | Alternative | |
error (anyOf 2) (anyOf 2) | null | Alternative | |
scheduleId | JSON | Optional | |
scheduleId (anyOf 1) | string | Alternative | An SMTP address of the user, distribution list, or resource, identifying an instance of scheduleInformation. |
scheduleId (anyOf 2) | null | Alternative | |
scheduleItems | array | Optional | Contains the items that describe the availability of the user or resource. |
scheduleItems[] | Model | Each item | Expand Invoke action get Schedule — me Calendar get Schedule — response body — value value item schedule Items item |
workingHours | JSON | Optional | The days of the week and hours in a specific time zone that the user works. These are set as part of the user's mailboxSettings. |
workingHours (anyOf 1) | Model | Alternative | Expand Invoke action get Schedule — me Calendar get Schedule — response body — value value item working Hours @odata type, days Of Week, end Time, start Time, time Zone |
workingHours (anyOf 2) | JSON | Alternative | |
workingHours (anyOf 2) (anyOf 1) | object | Alternative | |
workingHours (anyOf 2) (anyOf 2) | null | Alternative |
Referenced models: Invoke action get Schedule — me Calendar get Schedule — response body — value value item error @odata type, message, response Code, Invoke action get Schedule — me Calendar get Schedule — response body — value value item schedule Items item, Invoke action get Schedule — me Calendar get Schedule — response body — value value item working Hours @odata type, days Of Week, end Time, start Time, time Zone
Invoke action get Schedule — me Calendar get Schedule — response body — value value item error @odata type, message, response Code
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
message | JSON | Optional | |
message (anyOf 1) | string | Alternative | Describes the error. |
message (anyOf 2) | null | Alternative | |
responseCode | JSON | Optional | |
responseCode (anyOf 1) | string | Alternative | The response code from querying for the availability of the user, distribution list, or resource. |
responseCode (anyOf 2) | null | Alternative |
Invoke action get Schedule — me Calendar get Schedule — response body — value value item schedule Items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
end | JSON | Optional | The date, time, and time zone that the corresponding event ends. |
end (anyOf 1) | Model | Alternative | Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time |
end (anyOf 2) | JSON | Alternative | |
end (anyOf 2) (anyOf 1) | object | Alternative | |
end (anyOf 2) (anyOf 2) | null | Alternative | |
isPrivate | JSON | Optional | |
isPrivate (anyOf 1) | boolean | Alternative | The sensitivity of the corresponding event. True if the event is marked private, false otherwise. Optional. |
isPrivate (anyOf 2) | null | Alternative | |
location | JSON | Optional | |
location (anyOf 1) | string | Alternative | The location where the corresponding event is held or attended from. Optional. |
location (anyOf 2) | null | Alternative | |
start | JSON | Optional | The date, time, and time zone that the corresponding event starts. |
start (anyOf 1) | Model | Alternative | Expand Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time |
start (anyOf 2) | JSON | Alternative | |
start (anyOf 2) (anyOf 1) | object | Alternative | |
start (anyOf 2) (anyOf 2) | null | Alternative | |
status | JSON | Optional | The availability status of the user or resource during the corresponding event. The possible values are: free, tentative, busy, oof, workingElsewhere, unknown. |
status (anyOf 1) | string | Alternative | Known values: unknown, free, tentative, busy, oof, workingElsewhere |
status (anyOf 2) | JSON | Alternative | |
status (anyOf 2) (anyOf 1) | object | Alternative | |
status (anyOf 2) (anyOf 2) | null | Alternative | |
subject | JSON | Optional | |
subject (anyOf 1) | string | Alternative | The corresponding event's subject line. Optional. |
subject (anyOf 2) | null | Alternative |
Referenced models: Invoke action snooze Reminder — me Event events Snooze Reminder — request body — body New Reminder Time
Invoke action get Schedule — me Calendar get Schedule — response body — value value item working Hours @odata type, days Of Week, end Time, start Time, time Zone
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
daysOfWeek | array | Optional | The days of the week on which the user works. |
daysOfWeek[] | JSON | Each item | |
daysOfWeek[] (anyOf 1) | string | Alternative | Known values: sunday, monday, tuesday, wednesday, thursday, friday, saturday |
daysOfWeek[] (anyOf 2) | JSON | Alternative | |
daysOfWeek[] (anyOf 2) (anyOf 1) | object | Alternative | |
daysOfWeek[] (anyOf 2) (anyOf 2) | null | Alternative | |
endTime | JSON | Optional | |
endTime (anyOf 1) | string | Alternative | The time of the day that the user stops working. Format: time Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$ |
endTime (anyOf 2) | null | Alternative | |
startTime | JSON | Optional | |
startTime (anyOf 1) | string | Alternative | The time of the day that the user starts working. Format: time Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$ |
startTime (anyOf 2) | null | Alternative | |
timeZone | JSON | Optional | The time zone to which the working hours apply. |
timeZone (anyOf 1) | Model | Alternative | Expand Invoke action get Schedule — me Calendar get Schedule — response body — value value item working Hours @odata type, days Of Week, end Time, start Time, time Zone time Zone @odata type, name |
timeZone (anyOf 2) | JSON | Alternative | |
timeZone (anyOf 2) (anyOf 1) | object | Alternative | |
timeZone (anyOf 2) (anyOf 2) | null | Alternative |
Invoke action get Schedule — me Calendar get Schedule — response body — value value item working Hours @odata type, days Of Week, end Time, start Time, time Zone time Zone @odata type, name
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | discriminator: {"mapping": {}, "propertyName": "@odata.type"} |
@odata.type | string | Optional | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of a time zone. It can be a standard time zone name such as 'Hawaii-Aleutian Standard Time', or 'Customized Time Zone' for a custom time zone. |
name (anyOf 2) | null | Alternative |
List calendars — me Calendar list Calendars — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
$ (allOf 1) | Model | All variants apply | Expand List rules — response body — @odata count, @odata next Link |
$ (allOf 2) | object | All variants apply | |
$ (allOf 2).value | array | Optional | |
$ (allOf 2).value[] | Model | Each item | Expand Get calendar — response body |
Referenced models: List rules — response body — @odata count, @odata next Link, Get calendar — response body