Ruby
Ruby
Outlook Calendar Create an Event
See more Outlook Calendar Examples
Create an event in the specified time zone, and assign the event an optional transactionId value.Chilkat Ruby Downloads
require 'chilkat'
success = false
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Use your previously obtained access token here: Get Outlook Calendar OAuth2 Access Token (Azure AD v2.0 Endpoint).
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/outlookCalendar.json")
if (success == false)
print jsonToken.lastErrorText() + "\n";
exit
end
http.put_AuthToken(jsonToken.stringOf("access_token"))
# Send the following POST:
# POST https://graph.microsoft.com/v1.0/me/events
# Prefer: outlook.timezone="Pacific Standard Time"
# Content-type: application/json
#
# {
# "subject": "Let's go for lunch",
# "body": {
# "contentType": "HTML",
# "content": "Does noon work for you?"
# },
# "start": {
# "dateTime": "2017-04-15T12:00:00",
# "timeZone": "Pacific Standard Time"
# },
# "end": {
# "dateTime": "2017-04-15T14:00:00",
# "timeZone": "Pacific Standard Time"
# },
# "location":{
# "displayName":"Harry's Bar"
# },
# "attendees": [
# {
# "emailAddress": {
# "address":"samanthab@contoso.onmicrosoft.com",
# "name": "Samantha Booth"
# },
# "type": "required"
# }
# ],
# "allowNewTimeProposals": true,
# "transactionId":"7E163156-7762-4BEB-A1C6-729EA81755A7"
# }
# Build the JSON body of the POST.
json = Chilkat::CkJsonObject.new()
json.UpdateString("subject","Let's go for lunch")
json.UpdateString("body.contentType","HTML")
json.UpdateString("body.content","Does noon work for you?")
json.UpdateString("start.dateTime","2021-05-15T12:00:00")
json.UpdateString("start.timeZone","Pacific Standard Time")
json.UpdateString("end.dateTime","2021-05-15T14:00:00")
json.UpdateString("end.timeZone","Pacific Standard Time")
json.UpdateString("location.displayName","Harry's Bar")
json.UpdateString("attendees[0].emailAddress.address","samanthab@contoso.onmicrosoft.com")
json.UpdateString("attendees[0].emailAddress.name","Samantha Booth")
json.UpdateString("attendees[0].type","required")
json.UpdateBool("allowNewTimeProposals",true)
# Generate a UUID.
crypt = Chilkat::CkCrypt2.new()
json.UpdateString("transactionId",crypt.generateUuid())
# Add the "Prefer" request header.
http.SetRequestHeader("Prefer","outlook.timezone=\"Pacific Standard Time\"")
# Send the HTTP POST
resp = Chilkat::CkHttpResponse.new()
success = http.HttpJson("POST","https://graph.microsoft.com/v1.0/me/events",json,"application/json",resp)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
print "Response status code = " + resp.get_StatusCode().to_s() + "\n";
jResp = Chilkat::CkJsonObject.new()
jResp.Load(resp.bodyStr())
jResp.put_EmitCompact(false)
print jResp.emit() + "\n";
# The send succeeded if the response status code = 201.
if (resp.get_StatusCode() != 201)
print "Failed" + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('user%40example.com')/events/$entity",
# "@odata.etag": "W/\"5+vF7TKKdE6bGCRqXyl2PQAEaGQgcw==\"",
# "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgENAAAA5_vF7TKKdE6bGCRqXyl2PQAEaDkEcAAAAA==",
# "createdDateTime": "2021-04-18T23:38:52.1979259Z",
# "lastModifiedDateTime": "2021-04-18T23:38:53.3747647Z",
# "changeKey": "5+vF7TKKdE6bGCRqXyl2PQAEaGQgcw==",
# "categories": [
# ],
# "transactionId": "1d12b565-3ca3-4ed8-b3f9-e8a14ac3ac17",
# "originalStartTimeZone": "Pacific Standard Time",
# "originalEndTimeZone": "Pacific Standard Time",
# "iCalUId": "040000008200E00074C5B7101A82E00800000000EF0328FDAB34D7010000000000000000100000004478DD5948382543AFD1B52C25E88C02",
# "reminderMinutesBeforeStart": 15,
# "isReminderOn": true,
# "hasAttachments": false,
# "subject": "Let's go for lunch",
# "bodyPreview": "Does noon work for you?",
# "importance": "normal",
# "sensitivity": "normal",
# "isAllDay": false,
# "isCancelled": false,
# "isOrganizer": true,
# "responseRequested": true,
# "seriesMasterId": null,
# "showAs": "busy",
# "type": "singleInstance",
# "webLink": "https://outlook.live.com/owa/?itemid=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAgENAAAA5%2BvF7TKKdE6bGCRqXyl2PQAEaDkEcAAAAA%3D%3D&exvsurl=1&path=/calendar/item",
# "onlineMeetingUrl": null,
# "isOnlineMeeting": false,
# "onlineMeetingProvider": "unknown",
# "allowNewTimeProposals": true,
# "isDraft": false,
# "hideAttendees": false,
# "recurrence": null,
# "onlineMeeting": null,
# "responseStatus": {
# "response": "organizer",
# "time": "0001-01-01T00:00:00Z"
# },
# "body": {
# "contentType": "html",
# "content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta content=\"text/html; charset=us-ascii\">\r\n</head>\r\n<body>\r\nDoes noon work for you?\r\n</body>\r\n</html>\r\n"
# },
# "start": {
# "dateTime": "2021-05-15T12:00:00.0000000",
# "timeZone": "Pacific Standard Time"
# },
# "end": {
# "dateTime": "2021-05-15T14:00:00.0000000",
# "timeZone": "Pacific Standard Time"
# },
# "location": {
# "displayName": "Harry's Bar",
# "locationType": "default",
# "uniqueId": "Harry's Bar",
# "uniqueIdType": "private"
# },
# "locations": [
# {
# "displayName": "Harry's Bar",
# "locationType": "default",
# "uniqueId": "Harry's Bar",
# "uniqueIdType": "private"
# }
# ],
# "attendees": [
# {
# "type": "required",
# "status": {
# "response": "none",
# "time": "0001-01-01T00:00:00Z"
# },
# "emailAddress": {
# "name": "Samantha Booth",
# "address": "samanthab@contoso.onmicrosoft.com"
# }
# }
# ],
# "organizer": {
# "emailAddress": {
# "name": "John Doe",
# "address": "outlook_3A33FCEB9B74CC15@outlook.com"
# }
# }
# }
# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON
odata_context = jResp.stringOf("\"@odata.context\"")
odata_etag = jResp.stringOf("\"@odata.etag\"")
id = jResp.stringOf("id")
createdDateTime = jResp.stringOf("createdDateTime")
lastModifiedDateTime = jResp.stringOf("lastModifiedDateTime")
changeKey = jResp.stringOf("changeKey")
transactionId = jResp.stringOf("transactionId")
originalStartTimeZone = jResp.stringOf("originalStartTimeZone")
originalEndTimeZone = jResp.stringOf("originalEndTimeZone")
iCalUId = jResp.stringOf("iCalUId")
reminderMinutesBeforeStart = jResp.IntOf("reminderMinutesBeforeStart")
isReminderOn = jResp.BoolOf("isReminderOn")
hasAttachments = jResp.BoolOf("hasAttachments")
subject = jResp.stringOf("subject")
bodyPreview = jResp.stringOf("bodyPreview")
importance = jResp.stringOf("importance")
sensitivity = jResp.stringOf("sensitivity")
isAllDay = jResp.BoolOf("isAllDay")
isCancelled = jResp.BoolOf("isCancelled")
isOrganizer = jResp.BoolOf("isOrganizer")
responseRequested = jResp.BoolOf("responseRequested")
seriesMasterId = jResp.stringOf("seriesMasterId")
showAs = jResp.stringOf("showAs")
v_type = jResp.stringOf("type")
webLink = jResp.stringOf("webLink")
onlineMeetingUrl = jResp.stringOf("onlineMeetingUrl")
isOnlineMeeting = jResp.BoolOf("isOnlineMeeting")
onlineMeetingProvider = jResp.stringOf("onlineMeetingProvider")
allowNewTimeProposals = jResp.BoolOf("allowNewTimeProposals")
isDraft = jResp.BoolOf("isDraft")
hideAttendees = jResp.BoolOf("hideAttendees")
recurrence = jResp.stringOf("recurrence")
onlineMeeting = jResp.stringOf("onlineMeeting")
responseStatusResponse = jResp.stringOf("responseStatus.response")
responseStatusTime = jResp.stringOf("responseStatus.time")
bodyContentType = jResp.stringOf("body.contentType")
bodyContent = jResp.stringOf("body.content")
startDateTime = jResp.stringOf("start.dateTime")
startTimeZone = jResp.stringOf("start.timeZone")
endDateTime = jResp.stringOf("end.dateTime")
endTimeZone = jResp.stringOf("end.timeZone")
locationDisplayName = jResp.stringOf("location.displayName")
locationLocationType = jResp.stringOf("location.locationType")
locationUniqueId = jResp.stringOf("location.uniqueId")
locationUniqueIdType = jResp.stringOf("location.uniqueIdType")
organizerEmailAddressName = jResp.stringOf("organizer.emailAddress.name")
organizerEmailAddressAddress = jResp.stringOf("organizer.emailAddress.address")
i = 0
count_i = jResp.SizeOfArray("categories")
while i < count_i
jResp.put_I(i)
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("locations")
while i < count_i
jResp.put_I(i)
displayName = jResp.stringOf("locations[i].displayName")
locationType = jResp.stringOf("locations[i].locationType")
uniqueId = jResp.stringOf("locations[i].uniqueId")
uniqueIdType = jResp.stringOf("locations[i].uniqueIdType")
i = i + 1
end
i = 0
count_i = jResp.SizeOfArray("attendees")
while i < count_i
jResp.put_I(i)
v_type = jResp.stringOf("attendees[i].type")
statusResponse = jResp.stringOf("attendees[i].status.response")
statusTime = jResp.stringOf("attendees[i].status.time")
emailAddressName = jResp.stringOf("attendees[i].emailAddress.name")
emailAddressAddress = jResp.stringOf("attendees[i].emailAddress.address")
i = i + 1
end
print "Event created." + "\n";