Kalendari
Çdo veprim në këtë grup: çfarë pranon, çfarë kthen dhe gabimet me të cilat mund të përgjigjet.
Veprimet
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.
Parametrat e pyetjes
fromstringE detyrueshmeStart of the window.
Formatidate-timetostringE detyrueshmeEnd of the window, after
fromand at most 366 days later.Formatidate-timetimezonestringE detyrueshmeIANA zone. Decides what an all-day event means.
limitintegerRows per page, 1 to 100.
Të paktën 1Më së shumti 100Parazgjedhja25cursorstringThe 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.
Kthen
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.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Trupi i kërkesës
summarystringE detyrueshmeThe title, 1 to 255 characters.
Nga 1 deri në 255 karakteredescriptionstringNotes about the event, up to 8,000 characters.
Deri në 8000 karakterelocationstringWhere it is: a room, an address or a link.
Deri në 255 karaktereurlstringA link that belongs to the event.
Deri në 2000 karaktereFormatiuristartstringE detyrueshmeWhen it starts, a
Dateor ISO 8601 with a zone.Formatidate-timeendstringE detyrueshmeWhen it ends, after
startand at most two years later.Formatidate-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.Nga 1 deri në 64 karaktererecurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.Deri në 512 karaktereattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }.Deri në 200 elementeemailstringE detyrueshme- Deri në 320 karaktereFormati
email namestring- Deri në 128 karaktere
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.Deri në 5 elementeminutesBeforeintegerE detyrueshme- Të paktën 0Më së shumti 40320
actionstring- Një nga
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.Një nga"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.Një nga"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.
Deri në 320 karaktere
Kthen
The event, with its attendees.
Gabimet
- 403
from_address_forbidden: the key or app may not send asfrom.insufficient_scopewhen invitations would go out andemails:sendis missing.
Gabimet që mund të kthejë çdo veprim400401404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeEvent id, the
eventIdof an occurrence, such ascal_followed by 24 hex characters.
Kthen
The event.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe event id from
GET /calendar/events.
Trupi i kërkesës
summarystringThe title, 1 to 255 characters.
Nga 1 deri në 255 karakteredescriptionstringNotes about the event, up to 8,000 characters.
Deri në 8000 karakterelocationstringWhere it is: a room, an address or a link.
Deri në 255 karaktereurlstringA link that belongs to the event.
Deri në 2000 karaktereFormatiuristartstringWhen it starts, a
Dateor ISO 8601 with a zone.Formatidate-timeendstringWhen it ends, after
startand at most two years later.Formatidate-timeallDaybooleanWhether it fills whole days.
startandendthen mark the days.timezonestringThe IANA zone the event belongs to,
UTCunless you say.Nga 1 deri në 64 karaktererecurrencestringAn RRULE such as
FREQ=WEEKLY;BYDAY=MOwhen it repeats.Deri në 512 karaktereattendeesobject[]Up to 200 people to invite, each
{ email, name?, optional? }. It replaces the whole list.Deri në 200 elementeemailstringE detyrueshme- Deri në 320 karaktereFormati
email namestring- Deri në 128 karaktere
optionalboolean
remindersobject[]Up to five reminders, each
{ minutesBefore, action? }.Deri në 5 elementeminutesBeforeintegerE detyrueshme- Të paktën 0Më së shumti 40320
actionstring- Një nga
"DISPLAY""EMAIL""AUDIO"
transparencystringOPAQUEshows you busy andTRANSPARENTfree.Një nga"OPAQUE""TRANSPARENT"visibilitystringPUBLIC,PRIVATEorCONFIDENTIAL.Një nga"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.
Deri në 320 karaktere
Kthen
The event as it stands now.
Gabimet
- 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.
Gabimet që mund të kthejë çdo veprim400401404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe event id from
GET /calendar/events.
Kthen
The event is gone.
Gabimet
- 403
not_organizer: the event was organised by somebody else.
Gabimet që mund të kthejë çdo veprim400401404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeEvent id, the
eventIdof an occurrence.
Kthen
text/calendarAn iCalendar document.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe event id from
GET /calendar/events.
Trupi i kërkesës
fromstringThe address the cancellation comes from. It has to be one the key may send as.
Deri në 320 karaktere
Kthen
The event, cancelled.
Gabimet
- 403
not_organizer: the event was organised by somebody else.from_address_forbidden: the key or app may not send asfrom.
Gabimet që mund të kthejë çdo veprim400401404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe event id from
GET /calendar/events.
Trupi i kërkesës
responsestringE detyrueshmeACCEPTED,DECLINEDorTENTATIVE.Një nga"ACCEPTED""DECLINED""TENTATIVE"respondingAsstringWhich of your invited addresses answers, when there is more than one.
Deri në 320 karaktere
Kthen
The event, with your answer.
Gabimet
- 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.
Gabimet që mund të kthejë çdo veprim400401404422500Katalogu i gabimeve
E disponueshme edhe në
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.
Parametrat e shtegut
idstringE detyrueshmeThe thread id.
Kthen
The event.
Gabimet
Gabimet që mund të kthejë çdo veprim400401403404422500Katalogu i gabimeve
E disponueshme edhe në
Objektet
CalendarEventobject
objectstringE detyrueshme- Një nga
"calendar_event" idstringE detyrueshmeuidstringE detyrueshmeThe iCalendar UID every copy of the event shares.
sequenceinteger- Të paktën 0
summarystring- Mund të jetë null
descriptionstring- Mund të jetë null
locationstring- Mund të jetë null
urlstring- Mund të jetë null
startstringE detyrueshme- Formati
date-time endstringE detyrueshme- Formati
date-time allDaybooleantimezonestring- Mund të jetë null
recurrencestringThe RRULE, when it repeats.
Mund të jetë nullexdatesstring[]statusstringE detyrueshmeCONFIRMED,TENTATIVEorCANCELLED.transparencystringvisibilitystringorganizerobject- Mund të jetë null
emailstringnamestring- Mund të jetë null
isOrganizerbooleanWhether you organise it, and so may change it.
sourcestringmessageIdstring- Mund të jetë null
threadIdstring- Mund të jetë null
alarmsobject[]minutesBeforeintegeractionstring
attendeesobject[]E detyrueshmeobjectstring- Një nga
"calendar_attendee" emailstringnamestring- Mund të jetë null
partstatstringNEEDS-ACTION,ACCEPTED,DECLINEDorTENTATIVE.rolestringrsvpbooleancutypestring- Mund të jetë null
respondedAtstring- Mund të jetë nullFormati
date-time
createdAtstring- Formati
date-time updatedAtstring- Formati
date-time
DeletedCalendarEventobject
objectstringE detyrueshme- Një nga
"calendar_event" idstringE detyrueshmedeletedbooleanE detyrueshme- Një nga
true