Takvim
Bu gruptaki her işlem: neyi kabul ettiği, ne döndürdüğü ve hangi hatalarla yanıt verebileceği.
İşlemler
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.
Sorgu parametreleri
fromstringZorunluStart of the window.
Biçimdate-timetostringZorunluEnd of the window, after
fromand at most 366 days later.Biçimdate-timetimezonestringZorunluIANA zone. Decides what an all-day event means.
limitintegerRows per page, 1 to 100.
En az 1En çok 100Varsayılan25cursorstringThe 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.
Döndürür
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.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
İstek gövdesi
summarystringZorunluThe title, 1 to 255 characters.
1 ile 255 karakter arasıdescriptionstringNotes about the event, up to 8,000 characters.
En çok 8000 karakterlocationstringWhere it is: a room, an address or a link.
En çok 255 karakterurlstringA link that belongs to the event.
En çok 2000 karakterBiçimuristartstringZorunluWhen it starts, a
Dateor ISO 8601 with a zone.Biçimdate-timeendstringZorunluWhen it ends, after
startand at most two years later.Biçimdate-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.1 ile 64 karakter arasırecurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.En çok 512 karakterattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }.En çok 200 öğeemailstringZorunlu- En çok 320 karakterBiçim
email namestring- En çok 128 karakter
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.En çok 5 öğeminutesBeforeintegerZorunlu- En az 0En çok 40320
actionstring- Şunlardan biri
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.Şunlardan biri"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.Şunlardan biri"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.
En çok 320 karakter
Döndürür
The event, with its attendees.
Hatalar
- 403
from_address_forbidden: the key or app may not send asfrom.insufficient_scopewhen invitations would go out andemails:sendis missing.
Her işlemin döndürebileceği hatalar400401404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.
Döndürür
The event.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe event id from
GET /calendar/events.
İstek gövdesi
summarystringThe title, 1 to 255 characters.
1 ile 255 karakter arasıdescriptionstringNotes about the event, up to 8,000 characters.
En çok 8000 karakterlocationstringWhere it is: a room, an address or a link.
En çok 255 karakterurlstringA link that belongs to the event.
En çok 2000 karakterBiçimuristartstringWhen it starts, a
Dateor ISO 8601 with a zone.Biçimdate-timeendstringWhen it ends, after
startand at most two years later.Biçimdate-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.1 ile 64 karakter arasırecurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.En çok 512 karakterattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }. It replaces the whole list.En çok 200 öğeemailstringZorunlu- En çok 320 karakterBiçim
email namestring- En çok 128 karakter
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.En çok 5 öğeminutesBeforeintegerZorunlu- En az 0En çok 40320
actionstring- Şunlardan biri
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.Şunlardan biri"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.Şunlardan biri"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.
En çok 320 karakter
Döndürür
The event as it stands now.
Hatalar
- 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.
Her işlemin döndürebileceği hatalar400401404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe event id from
GET /calendar/events.
Döndürür
The event is gone.
Hatalar
- 403
not_organizer: the event was organised by somebody else.
Her işlemin döndürebileceği hatalar400401404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluEvent id, the
eventIdof an occurrence.
Döndürür
text/calendarAn iCalendar document.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe event id from
GET /calendar/events.
İstek gövdesi
fromstringThe address the cancellation comes from. It has to be one the key may send as.
En çok 320 karakter
Döndürür
The event, cancelled.
Hatalar
- 403
not_organizer: the event was organised by somebody else.from_address_forbidden: the key or app may not send asfrom.
Her işlemin döndürebileceği hatalar400401404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe event id from
GET /calendar/events.
İstek gövdesi
responsestringZorunluACCEPTED,DECLINEDorTENTATIVE.Şunlardan biri"ACCEPTED""DECLINED""TENTATIVE"respondingAsstringWhich of your invited addresses answers, when there is more than one.
En çok 320 karakter
Döndürür
The event, with your answer.
Hatalar
- 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.
Her işlemin döndürebileceği hatalar400401404422500Hata kataloğu
Şurada da var
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.
Yol parametreleri
idstringZorunluThe thread id.
Döndürür
The event.
Hatalar
Her işlemin döndürebileceği hatalar400401403404422500Hata kataloğu
Şurada da var
Nesneler
CalendarEventobject
objectstringZorunlu- Şunlardan biri
"calendar_event" idstringZorunluuidstringZorunluThe iCalendar UID every copy of the event shares.
sequenceinteger- En az 0
summarystring- null olabilir
descriptionstring- null olabilir
locationstring- null olabilir
urlstring- null olabilir
startstringZorunlu- Biçim
date-time endstringZorunlu- Biçim
date-time allDaybooleantimezonestring- null olabilir
recurrencestringThe RRULE, when it repeats.
null olabilirexdatesstring[]statusstringZorunluCONFIRMED,TENTATIVEorCANCELLED.transparencystringvisibilitystringorganizerobject- null olabilir
emailstringnamestring- null olabilir
isOrganizerbooleanWhether you organise it, and so may change it.
sourcestringmessageIdstring- null olabilir
threadIdstring- null olabilir
alarmsobject[]minutesBeforeintegeractionstring
attendeesobject[]Zorunluobjectstring- Şunlardan biri
"calendar_attendee" emailstringnamestring- null olabilir
partstatstringNEEDS-ACTION,ACCEPTED,DECLINEDorTENTATIVE.rolestringrsvpbooleancutypestring- null olabilir
respondedAtstring- null olabilirBiçim
date-time
createdAtstring- Biçim
date-time updatedAtstring- Biçim
date-time
DeletedCalendarEventobject
objectstringZorunlu- Şunlardan biri
"calendar_event" idstringZorunludeletedbooleanZorunlu- Şunlardan biri
true