تقویم
هر عملیات در این گروه: آنچه می‌پذیرد، آنچه برمی‌گرداند و خطاهایی که ممکن است با آن‌ها پاسخ دهد.
عملیات‌ها
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.
می‌تواند null باشدexdatesstring[]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