Community articleiCalendar representation of a notice
Added by IBM contributorIBM on September 27, 2013
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The Domino Calendar Service also uses a iCalendar schema to represent notices.
The Domino Calendar Service supports both JSON and iCalendar so you can decide which is best for your application. JSON is the default representation. This topic provides an example of a notice represented in iCalendar format.

Single notice represented in iCalendar format

The following example is a notice represented in iCalendar format. A notice example looks similar to an event - but there are some subtle differences. For example, it includes the iCalendar METHOD property. It also includes an X-LOTUS-NOTICETYPE property indicating the type of notice.

Example 1. Notice represented in iCalendar format
 
BEGIN:VCALENDAR
X-LOTUS-CHARSET:UTF-8
VERSION:2.0
PRODID:-//Lotus Development Corporation//NONSGML Notes 9.0//EN_API_S
METHOD:REQUEST
BEGIN:VTIMEZONE
TZID:Eastern
BEGIN:STANDARD
DTSTART:19501105T020000
TZOFFSETFROM:-0400
TZOFFSETTO:-0500
RRULE:FREQ=YEARLY;BYMINUTE=0;BYHOUR=2;BYDAY=1SU;BYMONTH=11
END:STANDARD
BEGIN:DAYLIGHT
DTSTART:19500312T020000
TZOFFSETFROM:-0500
TZOFFSETTO:-0400
RRULE:FREQ=YEARLY;BYMINUTE=0;BYHOUR=2;BYDAY=2SU;BYMONTH=3
END:DAYLIGHT
END:VTIMEZONE
BEGIN:VEVENT
DTSTART;TZID="Eastern":20130916T090000
DTEND;TZID="Eastern":20130916T100000
TRANSP:OPAQUE
DTSTAMP:20130826T181422Z
SEQUENCE:0
ATTENDEE;ROLE=CHAIR;PARTSTAT=ACCEPTED;CN="Dean Melnyk/Peaks"
 ;RSVP=FALSE:mailto:DeanMelnyk@swg.usma.ibm.com
ATTENDEE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION
 ;CN="Duke Lawson/Peaks";RSVP=TRUE:mailto:DukeLawson@swg.usma.ibm.com
CLASS:PUBLIC
DESCRIPTION:Status updates\, etc.
SUMMARY:1x1 with Duke
X-LOTUS-UPDATE-SUBJECT:Invitation: 1x1 with Duke (Sep 16 09:00 AM EDT in My office)
LOCATION:My office
ORGANIZER;CN="Dean Melnyk/Peaks":mailto:DeanMelnyk@swg.usma.ibm.com
UID:DB859B563CEFC35585257BD30052548A-Lotus_Notes_Generated
X-LOTUS-BROADCAST:FALSE
X-LOTUS-NOTESVERSION:2
X-LOTUS-NOTICETYPE:I
X-LOTUS-APPTTYPE:3
X-LOTUS-UNID:DB859B563CEFC35585257BD30052548A
END:VEVENT
END:VCALENDAR


The basic notice properties are defined in the following table.

Table 1. Basic notice properties
Property Name TypeDescription JSON Property
hrefString The URL of this event resource.N/A
METHODStringDefines the type of notice that follows. For example:
  • request indicates that the notice is an invitation or reschedule
  • reply indicates that the notice is an response to a request from the organizer (e.g. accept, decline, tentative)
  • cancel indicates that the notice is a cancellation from the organizer.

scheduleMethod
UIDStringThe universal ID of this event.id
SUMMARYStringThe summary (or subject) of this event.summary
LOCATIONStringThe location of this event.location
DESCRIPTIONStringA detailed description of this event.description
DTSTARTObjectThe start date and time. start
DTENDObjectThe end date and time. end
CLASSStringDefines the scope of the access that the calendar owner intends for information within an individual calendar entryclass
TRANSP String Defines whether an event is transparent or not to busy time searches.transparency
SEQUENCEIntegerDefines the revision sequence number of the calendar component within a sequence of revisions. For example, "sequence": 0, indicates a new entry with no revisions.sequence
X-LOTUS-NOTESVERSIONObject ... x-lotus-notesversion
X-LOTUS-NOTICETYPE ObjectProvides further definition of the notice type. For example:
  • I indicates the notice is an invitation
  • A indicates an accept notice
  • R indicates a decline notice
  • P indicates a tentative acceptance.

x-lotus-noticetype
X-LOTUS-APPTYPEObject ... x-lotus-apptype