التقويم
كل عملية في هذه المجموعة: ما تقبله وما تُرجعه والأخطاء التي قد تردّ بها.
العمليات
Events and invitations, as the Calendar page of the app shows them: list a window, read an event or the one a thread carries, put events on the calendar and change them, call off a meeting, and answer an invitation. A change that invites, updates or cancels attendees, and every answer, goes out by email, so it also needs emails:send.
GET/calendar/events
List occurrences in a window
from and to are REQUIRED. Occurrences are expanded from recurrence rules, so a calendar has no meaningful unbounded listing. A default window would turn an infinite series into a question with no answer. At most a year apart.
Requires the calendar:read scope.
معلمات الاستعلام
fromstringمطلوبStart of the window.
التنسيقdate-timetostringمطلوبEnd of the window, after
fromand at most 366 days later.التنسيقdate-timetimezonestringمطلوبIANA zone. Decides what an all-day event means.
limitintegerRows per page, 1 to 100.
على الأقل 1على الأكثر 100الافتراضي25cursorstringThe previous page's
nextCursor, passed back as it came. It is opaque: it holds where the last row sat in this list's order, so a row deleted or edited between pages never breaks the walk, and the next page starts at the first row that sorts after it. A value this list did not hand out is a 400invalid_cursor.
يُرجع
A page of occurrences, sorted by start and then by event id, with hasMore and nextCursor. Send the same from, to and timezone with every cursor. Nothing in the window is dropped: a series repeats at most once a day, so it gives at most one occurrence per day of the window, and every one is reachable through the pages. The cursor holds the start and event id of the last row, so an event deleted or moved between pages never breaks the walk.
الأخطاء
الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء
متاح أيضًا في
POST/calendar/events
Create an event
Puts an event on the calendar, as New event on the Calendar page of the app does. start and end are ISO 8601 with a zone, and timezone is the IANA zone the event belongs to, UTC unless you say. recurrence takes an RRULE such as FREQ=WEEKLY;BYDAY=MO, and reminders the minutes before the start.
With attendees, an invitation goes to each of them from the address in from, which has to be one the key or app may send as, so the call also needs emails:send. sendInvites: false keeps the change to your own calendar.
Requires the calendar:write scope.
متن الطلب
summarystringمطلوبThe title, 1 to 255 characters.
من 1 إلى 255 من الأحرفdescriptionstringNotes about the event, up to 8,000 characters.
حتى 8000 من الأحرفlocationstringWhere it is: a room, an address or a link.
حتى 255 من الأحرفurlstringA link that belongs to the event.
حتى 2000 من الأحرفالتنسيقuristartstringمطلوبWhen it starts, a
Dateor ISO 8601 with a zone.التنسيقdate-timeendstringمطلوبWhen it ends, after
startand at most two years later.التنسيقdate-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.من 1 إلى 64 من الأحرفrecurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.حتى 512 من الأحرفattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }.حتى 200 من العناصرemailstringمطلوب- حتى 320 من الأحرفالتنسيق
email namestring- حتى 128 من الأحرف
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.حتى 5 من العناصرminutesBeforeintegerمطلوب- على الأقل 0على الأكثر 40320
actionstring- أحد
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.أحد"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.أحد"PUBLIC""PRIVATE""CONFIDENTIAL"sendInvitesbooleanFalse keeps the change to your own calendar, and sends nothing.
fromstringThe address the invitations come from. It has to be one the key may send as.
حتى 320 من الأحرف
يُرجع
The event, with its attendees.
الأخطاء
- 403
from_address_forbidden: the key or app may not send asfrom.insufficient_scopewhen invitations would go out andemails:sendis missing.
الأخطاء التي يمكن أن تُرجعها أي عملية400401404422500دليل الأخطاء
متاح أيضًا في
GET/calendar/events/{id}
Retrieve an event
The event with its attendees and their responses. rawIcs is omitted. Everything understood in it is already structured here, and /ics serves the document.
Requires the calendar:read scope.
معلمات المسار
idstringمطلوبEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.
يُرجع
The event.
الأخطاء
الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء
متاح أيضًا في
PATCH/calendar/events/{id}
Change an event
Changes an event you organise. A field left out keeps its value, and attendees replaces the whole list. Everyone invited gets the updated invitation.
With attendees, an invitation goes to each of them from the address in from, which has to be one the key or app may send as, so the call also needs emails:send. sendInvites: false keeps the change to your own calendar.
Requires the calendar:write scope.
معلمات المسار
idstringمطلوبThe event id from
GET /calendar/events.
متن الطلب
summarystringThe title, 1 to 255 characters.
من 1 إلى 255 من الأحرفdescriptionstringNotes about the event, up to 8,000 characters.
حتى 8000 من الأحرفlocationstringWhere it is: a room, an address or a link.
حتى 255 من الأحرفurlstringA link that belongs to the event.
حتى 2000 من الأحرفالتنسيقuristartstringWhen it starts, a
Dateor ISO 8601 with a zone.التنسيقdate-timeendstringWhen it ends, after
startand at most two years later.التنسيقdate-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.من 1 إلى 64 من الأحرفrecurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.حتى 512 من الأحرفattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }. It replaces the whole list.حتى 200 من العناصرemailstringمطلوب- حتى 320 من الأحرفالتنسيق
email namestring- حتى 128 من الأحرف
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.حتى 5 من العناصرminutesBeforeintegerمطلوب- على الأقل 0على الأكثر 40320
actionstring- أحد
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.أحد"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.أحد"PUBLIC""PRIVATE""CONFIDENTIAL"sendInvitesbooleanFalse keeps the change to your own calendar, and sends nothing.
fromstringThe address the invitations come from. It has to be one the key may send as.
حتى 320 من الأحرف
يُرجع
The event as it stands now.
الأخطاء
- 403
not_organizer: the event was organised by somebody else, so you can only answer it.from_address_forbidden: the key or app may not send asfrom.- 409
event_cancelled: the meeting was called off.
الأخطاء التي يمكن أن تُرجعها أي عملية400401404422500دليل الأخطاء
متاح أيضًا في
DELETE/calendar/events/{id}
Remove an event
Removes an event from the calendar for good, as Remove does in the app. Nobody else is told: to call off a meeting with others in it, use POST /calendar/events/{id}/cancel.
Requires the calendar:write scope.
معلمات المسار
idstringمطلوبThe event id from
GET /calendar/events.
يُرجع
The event is gone.
الأخطاء
- 403
not_organizer: the event was organised by somebody else.
الأخطاء التي يمكن أن تُرجعها أي عملية400401404422500دليل الأخطاء
متاح أيضًا في
GET/calendar/events/{id}/ics
The event as an .ics document
Served as text/calendar with NO METHOD parameter. A METHOD makes a document actionable (a client seeing method=REQUEST draws accept/decline and can reply to the organiser), and this endpoint has no authority to invite anybody on the workspace behalf. It states what the event currently is.
Requires the calendar:read scope.
معلمات المسار
idstringمطلوبEvent id, the
eventIdof an occurrence.
يُرجع
text/calendarAn iCalendar document.
الأخطاء
الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء
متاح أيضًا في
POST/calendar/events/{id}/cancel
Cancel a meeting
Calls off a meeting you organise, as Cancel meeting does in the app. It stays on the calendar with status CANCELLED, and everyone invited is told it is off, from the address in from, so a meeting with attendees also needs emails:send. The body is optional.
Requires the calendar:write scope.
معلمات المسار
idstringمطلوبThe event id from
GET /calendar/events.
متن الطلب
fromstringThe address the cancellation comes from. It has to be one the key may send as.
حتى 320 من الأحرف
يُرجع
The event, cancelled.
الأخطاء
- 403
not_organizer: the event was organised by somebody else.from_address_forbidden: the key or app may not send asfrom.
الأخطاء التي يمكن أن تُرجعها أي عملية400401404422500دليل الأخطاء
متاح أيضًا في
POST/calendar/events/{id}/respond
Answer an invitation
Accepts, declines or tentatively accepts an invitation, as the buttons of an invitation in the app do. The answer goes to the organiser by email from the invited address the key or app may send as, or from respondingAs when the invitation went to more than one of yours.
Requires the calendar:write and emails:send scopes.
معلمات المسار
idstringمطلوبThe event id from
GET /calendar/events.
متن الطلب
responsestringمطلوبACCEPTED,DECLINEDorTENTATIVE.أحد"ACCEPTED""DECLINED""TENTATIVE"respondingAsstringWhich of your invited addresses answers, when there is more than one.
حتى 320 من الأحرف
يُرجع
The event, with your answer.
الأخطاء
- 403
not_invited: the event did not inviterespondingAs, or any address the key or app may send as.- 409
event_cancelled: the meeting was called off.reply_not_sent: the answer could not be sent to the organiser, so nothing changed.
الأخطاء التي يمكن أن تُرجعها أي عملية400401404422500دليل الأخطاء
متاح أيضًا في
GET/threads/{id}/event
The event a thread carries
The calendar event that came with an invitation in the thread, as the invitation card of the reading pane shows it. A thread with no event, or one the key or app does not reach, is a 404. Answer it with POST /calendar/events/{id}/respond.
Requires the calendar:read scope.
معلمات المسار
idstringمطلوبThe thread id.
يُرجع
The event.
الأخطاء
الأخطاء التي يمكن أن تُرجعها أي عملية400401403404422500دليل الأخطاء
متاح أيضًا في
الكائنات
CalendarEventobject
objectstringمطلوب- أحد
"calendar_event" idstringمطلوبuidstringمطلوبThe iCalendar UID every copy of the event shares.
sequenceinteger- على الأقل 0
summarystring- يمكن أن يكون null
descriptionstring- يمكن أن يكون null
locationstring- يمكن أن يكون null
urlstring- يمكن أن يكون null
startstringمطلوب- التنسيق
date-time endstringمطلوب- التنسيق
date-time allDaybooleantimezonestring- يمكن أن يكون null
recurrencestringThe RRULE, when it repeats.
يمكن أن يكون nullexdatesstring[]statusstringمطلوبCONFIRMED,TENTATIVEorCANCELLED.transparencystringvisibilitystringorganizerobject- يمكن أن يكون null
emailstringnamestring- يمكن أن يكون null
isOrganizerbooleanWhether you organise it, and so may change it.
sourcestringmessageIdstring- يمكن أن يكون null
threadIdstring- يمكن أن يكون null
alarmsobject[]minutesBeforeintegeractionstring
attendeesobject[]مطلوبobjectstring- أحد
"calendar_attendee" emailstringnamestring- يمكن أن يكون null
partstatstringNEEDS-ACTION,ACCEPTED,DECLINEDorTENTATIVE.rolestringrsvpbooleancutypestring- يمكن أن يكون null
respondedAtstring- يمكن أن يكون nullالتنسيق
date-time
createdAtstring- التنسيق
date-time updatedAtstring- التنسيق
date-time
DeletedCalendarEventobject
objectstringمطلوب- أحد
"calendar_event" idstringمطلوبdeletedbooleanمطلوب- أحد
true