Microsoft: Me event schemas (part 2)
8 Microsoft schemas with complete fields and constraints.
← Me event operations · All schemas
Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link locations item coordinates @odata type, accuracy, altitude, altitude Accuracy, latitude, longitude
Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link locations item coordinates @odata type, accuracy, altitude, altitude Accuracy, latitude, longitude accuracy value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: -INF, INF, NaN |
$ (anyOf 2) | null | Alternative |
Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link online Meeting @odata type, conference Id, join Url, phones, quick Dial, toll Free Numbers, toll Number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
conferenceId | JSON | Optional | |
conferenceId (anyOf 1) | string | Alternative | The ID of the conference. |
conferenceId (anyOf 2) | null | Alternative | |
joinUrl | JSON | Optional | |
joinUrl (anyOf 1) | string | Alternative | The external link that launches the online meeting. This is a URL that clients launch into a browser and will redirect the user to join the meeting. |
joinUrl (anyOf 2) | null | Alternative | |
phones | array | Optional | All of the phone numbers associated with this conference. |
phones[] | Model | Each item | Expand Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link online Meeting @odata type, conference Id, join Url, phones, quick Dial, toll Free Numbers, toll Number phones item |
quickDial | JSON | Optional | |
quickDial (anyOf 1) | string | Alternative | The preformatted quick dial for this call. |
quickDial (anyOf 2) | null | Alternative | |
tollFreeNumbers | array | Optional | The toll free numbers that can be used to join the conference. |
tollFreeNumbers[] | JSON | Each item | |
tollFreeNumbers[] (anyOf 1) | string | Alternative | |
tollFreeNumbers[] (anyOf 2) | null | Alternative | |
tollNumber | JSON | Optional | |
tollNumber (anyOf 1) | string | Alternative | The toll number that can be used to join the conference. |
tollNumber (anyOf 2) | null | Alternative |
Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link online Meeting @odata type, conference Id, join Url, phones, quick Dial, toll Free Numbers, toll Number phones item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
language | JSON | Optional | |
language (anyOf 1) | string | Alternative | |
language (anyOf 2) | null | Alternative | |
number | JSON | Optional | |
number (anyOf 1) | string | Alternative | The phone number. |
number (anyOf 2) | null | Alternative | |
region | JSON | Optional | |
region (anyOf 1) | string | Alternative | |
region (anyOf 2) | null | Alternative | |
type | JSON | Optional | The type of phone number. The possible values are: home, business, mobile, other, assistant, homeFax, businessFax, otherFax, pager, radio. |
type (anyOf 1) | string | Alternative | One of: home, business, mobile, other, assistant, homeFax, businessFax, otherFax, pager, radio |
type (anyOf 2) | JSON | Alternative | |
type (anyOf 2) (anyOf 1) | object | Alternative | |
type (anyOf 2) (anyOf 2) | null | Alternative |
Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link recurrence @odata type, pattern, range
Referenced models: Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link recurrence @odata type, pattern, range pattern @odata type, day Of Month, days Of Week, first Day Of Week, index, interval, month, type, Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link recurrence @odata type, pattern, range range @odata type, end Date, number Of Occurrences, recurrence Time Zone, start Date, type
Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link recurrence @odata type, pattern, range pattern @odata type, day Of Month, days Of Week, first Day Of Week, index, interval, month, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
dayOfMonth | number | Optional | The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
daysOfWeek | array | Optional | A collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly. |
daysOfWeek[] | JSON | Each item | |
daysOfWeek[] (anyOf 1) | string | Alternative | One of: 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 | |
firstDayOfWeek | JSON | Optional | The first day of the week. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. Default is sunday. Required if type is weekly. |
firstDayOfWeek (anyOf 1) | string | Alternative | One of: sunday, monday, tuesday, wednesday, thursday, friday, saturday |
firstDayOfWeek (anyOf 2) | JSON | Alternative | |
firstDayOfWeek (anyOf 2) (anyOf 1) | object | Alternative | |
firstDayOfWeek (anyOf 2) (anyOf 2) | null | Alternative | |
index | JSON | Optional | Specifies on which instance of the allowed days specified in daysOfWeek the event occurs, counted from the first instance in the month. The possible values are: first, second, third, fourth, last. Default is first. Optional and used if type is relativeMonthly or relativeYearly. |
index (anyOf 1) | string | Alternative | One of: first, second, third, fourth, last |
index (anyOf 2) | JSON | Alternative | |
index (anyOf 2) (anyOf 1) | object | Alternative | |
index (anyOf 2) (anyOf 2) | null | Alternative | |
interval | number | Optional | The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
month | number | Optional | The month in which the event occurs. This is a number from 1 to 12. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
type | JSON | Optional | The recurrence pattern type: daily, weekly, absoluteMonthly, relativeMonthly, absoluteYearly, relativeYearly. Required. For more information, see values of type property. |
type (anyOf 1) | string | Alternative | One of: daily, weekly, absoluteMonthly, relativeMonthly, absoluteYearly, relativeYearly |
type (anyOf 2) | JSON | Alternative | |
type (anyOf 2) (anyOf 1) | object | Alternative | |
type (anyOf 2) (anyOf 2) | null | Alternative |
Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link recurrence @odata type, pattern, range range @odata type, end Date, number Of Occurrences, recurrence Time Zone, start Date, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
endDate | JSON | Optional | |
endDate (anyOf 1) | string | Alternative | The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate. Format: date Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$ |
endDate (anyOf 2) | null | Alternative | |
numberOfOccurrences | number | Optional | The number of times to repeat the event. Required and must be positive if type is numbered. Format: int32 Maximum: 2147483647 Minimum: -2147483648 |
recurrenceTimeZone | JSON | Optional | |
recurrenceTimeZone (anyOf 1) | string | Alternative | Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used. |
recurrenceTimeZone (anyOf 2) | null | Alternative | |
startDate | JSON | Optional | |
startDate (anyOf 1) | string | Alternative | The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required. Format: date Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$ |
startDate (anyOf 2) | null | Alternative | |
type | JSON | Optional | The recurrence range. The possible values are: endDate, noEnd, numbered. Required. |
type (anyOf 1) | string | Alternative | One of: endDate, noEnd, numbered |
type (anyOf 2) | JSON | Alternative | |
type (anyOf 2) (anyOf 1) | object | Alternative | |
type (anyOf 2) (anyOf 2) | null | Alternative |
Update event — request body — body @odata type, allow New Time Proposals, attachments, attendees, body, body Preview, calendar, cancelled Occurrences, end, exception Occurrences, extensions, has Attachments, hide Attendees, i Cal U Id, importance, instances, is All Day, is Cancelled, is Draft, is Online Meeting, is Organizer, is Reminder On, location, locations, multi Value Extended Properties, online Meeting, online Meeting Provider, online Meeting Url, organizer, original End Time Zone, original Start, original Start Time Zone, recurrence, reminder Minutes Before Start, response Requested, response Status, sensitivity, series Master Id, show As, single Value Extended Properties, start, subject, transaction Id, type, web Link response Status @odata type, response, time
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
@odata.type | string | Optional | |
response | JSON | Optional | The response type. The possible values are: none, organizer, tentativelyAccepted, accepted, declined, notResponded.To differentiate between none and notResponded: none – from organizer's perspective. This value is used when the status of an attendee/participant is reported to the organizer of a meeting. notResponded – from attendee's perspective. Indicates the attendee has not responded to the meeting request. Clients can treat notResponded == none. As an example, if attendee Alex hasn't responded to a meeting request, getting Alex' response status for that event in Alex' calendar returns notResponded. Getting Alex' response from the calendar of any other attendee or the organizer's returns none. Getting the organizer's response for the event in anybody's calendar also returns none. |
response (anyOf 1) | string | Alternative | One of: none, organizer, tentativelyAccepted, accepted, declined, notResponded |
response (anyOf 2) | JSON | Alternative | |
response (anyOf 2) (anyOf 1) | object | Alternative | |
response (anyOf 2) (anyOf 2) | null | Alternative | |
time | JSON | Optional | |
time (anyOf 1) | string | Alternative | The date and time when the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z Format: date-time Pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$ |
time (anyOf 2) | null | Alternative |