From fbd846bd40ab7c369a91a9db044133d4daae058e Mon Sep 17 00:00:00 2001 From: harshith-venkatesh Date: Tue, 27 Sep 2022 23:04:06 +0530 Subject: [PATCH] API Contract for Event Object for Website Calendar --- calendar/README.md | 96 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 calendar/README.md diff --git a/calendar/README.md b/calendar/README.md new file mode 100644 index 0000000..900441b --- /dev/null +++ b/calendar/README.md @@ -0,0 +1,96 @@ +# Calendar + +## Event object + + +``` +{ + "id": string, + "status": string, + "htmlLink": string, + "created": datetime, + "updated": datetime, + "summary": string, + "description": string, + "location": string, + "colorId": string, + "creator": { + "id": string, + "email": string, + "displayName": string, + "self": boolean + }, + "organizer": { + "id": string, + "email": string, + "displayName": string, + "self": boolean + }, + "start": { + "date": date, + "dateTime": datetime, + "timeZone": string + }, + "end": { + "date": date, + "dateTime": datetime, + "timeZone": string + }, + "endTimeUnspecified": boolean, + "recurrence": [ + string + ], + "originalStartTime": { + "date": date, + "dateTime": datetime, + "timeZone": string + }, + "transparency": string, + "visibility": string, + "tags" : [ + { + "id": string, + "displayName": string, + "colorId": string, + "displayType": string + } + ] + "attendees": [ + { + "id": string, + "email": string, + "displayName": string, + "organizer": boolean, + "self": boolean, + "resource": boolean, + "optional": boolean, + "responseStatus": string, + "comment": string, + "additionalGuests": integer + } + ], + "attendeesOmitted": boolean, + + "hangoutLink": string, + + "anyoneCanAddSelf": boolean, + "guestsCanInviteOthers": boolean, + "guestsCanModify": boolean, + "guestsCanSeeOtherGuests": boolean, + "locked": boolean, + "source": { + "url": string, + "title": string + }, + "attachments": [ + { + "fileUrl": string, + "title": string, + "mimeType": string, + "iconLink": string, + "fileId": string + } + ], + "eventType": string +} +```