Community articleCalendar event GET9.0.1
Added by api wiki on October 23, 2013
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Gets a single event from a calendar on a Domino server.

 

Input
Method URI Description
GET /{database}/api/calendar/events/{uid} Gets a single event from a calendar on a Domino server.
GET /{database}/api/calendar/events/{uid}/{recurrenceid} Gets an instance of a recurring event from a calendar on a Domino server.
Name Type Optional Description
database
string No Path name of a database on the server relative to the data directory.
uid
string No Universal ID of the event.
recurrenceid
string Yes Recurrence ID of the event instance.This only used for get one instance of recurring event.
Name Type Optional Description
format
string Yes Requested format for the response. By default, the service returns the events in JSON format. To request iCalendar format, specify "format=icalendar".
Output
Code Description
200
OK. Indicates that the request was handled successfully.
404
Not Found. Indicates the service can't find the event.
Examples
This request gets an event in iCalendar format
GET /mail/sdayrn.nsf/api/calendar/events/77DE07AFA67E221200257BB100137F19-Lotus_Auto_Generated?format=icalendar

Response returned by the server
BEGIN:VCALENDAR
X-LOTUS-CHARSET:UTF-8
VERSION:2.0
PRODID:-//Lotus Development Corporation//NONSGML Notes 9.0//EN_API_S
BEGIN:VEVENT
DTSTART:20130726T011500Z
DTEND:20130726T014500Z
TRANSP:OPAQUE
LAST-MODIFIED:20130723T083203Z
DTSTAMP:20130725T083111Z
SEQUENCE:0
CLASS:PUBLIC
SUMMARY:event1
UID:77DE07AFA67E221200257BB100137F19-Lotus_Auto_Generated
X-LOTUS-NOTESVERSION:2
X-LOTUS-APPTTYPE:0
END:VEVENT
END:VCALENDAR
This request gets an instance of a recurring event
GET /mail/sdayrn.nsf/api/calendar/events/6819187E9A2DEF4900257BB3002A5334-Lotus_Auto_Generated/20130830T070000Z

Response returned by the server
{
  "x-lotus-charset":  {
    "data":"UTF-8"
  },
  "timezones": [
    {
      "tzid":"Greenwich",
      "standard": {
        "start": {
          "date":"1950-01-01",
          "time":"02:00:00"
        },
        "offsetFrom":"+0000",
        "offsetTo":"+0000"
      }
    }
  ],
  "events": [
    {
      "href":"/mail/sdayrn.nsf/api/calendar/events/6819187E9A2DEF4900257BB3002A5334-Lotus_Auto_Generated/20130830T070000Z",
      "id":"6819187E9A2DEF4900257BB3002A5334-Lotus_Auto_Generated",
      "summary":"repeating event",
      "start": {
        "date":"2013-08-30",
        "time":"07:00:00",
        "tzid":"Greenwich"
      },
      "end": {
        "date":"2013-08-31",
        "time":"08:00:00",
        "tzid":"Greenwich"
      },
      "recurrenceId":"20130830T070000Z",
      "class":"public",
      "transparency":"opaque",
      "sequence":0,
      "last-modified":"20130725T074218Z",
      "attendees": [
        {
          "role":"chair",
          "status":"accepted",
          "rsvp":false,
          "displayName":"Samantha Daryn/IBM",
          "email":"SamanthaDaryn@xyz.com"
        },
        {
          "role":"req-participant",
          "status":"accepted",
          "rsvp":true,
          "displayName":"User1/Peaks",
          "email":"User1@xyz.com"
        }
      ],
      "organizer": {
        "displayName":"Samantha Daryn/Peaks",
        "email":"SamanthaDaryn@xyz.com"
      },
      "x-lotus-broadcast": {
        "data":"FALSE"
      },
      "x-lotus-notesversion": {
        "data":"2"
      },
      "x-lotus-appttype": {
        "data":"3"
      }
    }
  ]
}
This request gets a recurring event with an exception
GET /mail/sdayrn.nsf/api/calendar/events/A89442C0691363BF00257BCF002A9D2B-Lotus_Notes_Generated

Response returned by the server
{
  "x-lotus-charset":  {
    "data":"UTF-8"
  },
  "timezones": [
    {
      "tzid":"Greenwich",
      "standard": {
        "start": {
          "date":"1950-01-01",
          "time":"02:00:00"
        },
        "offsetFrom":"+0000",
        "offsetTo":"+0000"
      }
    }
  ],
  "events": [
    {
      "href":"/mail/sdayrn.nsf/api/calendar/events/A89442C0691363BF00257BCF002A9D2B-Lotus_Notes_Generated",
      "id":"A89442C0691363BF00257BCF002A9D2B-Lotus_Notes_Generated",
      "summary":"repeat with exception",
      "start": {
        "date":"2013-09-11",
        "time":"09:00:00",
        "tzid":"Greenwich"
      },
      "end": {
        "date":"2013-09-11",
        "time":"10:00:00",
        "tzid":"Greenwich"
      },
      "recurrenceRule":"FREQ=DAILY;COUNT=3",
      "links": [
        {
          "rel":"instances",
          "href":"/mail/sdayrn.nsf/api/calendar/events/A89442C0691363BF00257BCF002A9D2B-Lotus_Notes_Generated/instances"
        }
      ],
      "class":"public",
      "transparency":"opaque",
      "sequence":0,
      "last-modified":"20130822T074659Z",
      "attendees": [
        {
          "role":"chair",
          "status":"accepted",
          "rsvp":false,
          "displayName":"Samantha Daryn/Peaks",
          "email":"SamanthaDaryn@xyz.com"
        }
      ],
      "organizer": {
          "displayName":"Samantha Daryn/Peaks",
          "email":"SamanthaDaryn@xyz.com"
      },
      "x-lotus-broadcast": {
        "data":"FALSE"
      },
      "x-lotus-notesversion": {
        "data":"2"
      },
      "x-lotus-appttype": {
        "data":"3"
      }
    },
    {
      "href":"/mail/sdayrn.nsf/api/calendar/events/A89442C0691363BF00257BCF002A9D2B-Lotus_Notes_Generated/20130912T090000Z",
      "id":"A89442C0691363BF00257BCF002A9D2B-Lotus_Notes_Generated",
      "summary":"exception",
      "start": {
        "date":"2013-09-12",
        "time":"14:00:00",
        "tzid":"Greenwich"
      },
      "end": {
        "date":"2013-09-12",
        "time":"17:00:00",
        "tzid":"Greenwich"
      },
      "recurrenceId":"20130912T090000Z",
      "class":"public",
      "transparency":"opaque",
      "sequence":0,
      "last-modified":"20130822T074659Z",
      "attendees": [
        {
          "role":"chair",
          "status":"accepted",
          "rsvp":false,
          "displayName":"Samantha Daryn/Peaks",
          "email":"SamanthaDaryn@xyz.com"
        }
      ],
      "organizer": {
        "displayName":"Samantha Daryn/Peaks",
        "email":"SamanthaDaryn@xyz.com"
      },
      "x-lotus-broadcast": {
        "data":"FALSE"
      },
      "x-lotus-notesversion": {
        "data":"2"
      },
      "x-lotus-appttype": {
        "data":"3"
      }
    }
  ]
}