캘린더
이 그룹의 모든 작업: 받는 값, 반환하는 값, 응답할 수 있는 오류.
작업
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