getEvents

Returns, by default, those events that have occurred since the last call to getEventsRequest. It is possible to set one IP address and port to listen for changes for multiple users. After all users for that IP address and port have been removed from the notification list, the IP socket is closed. Following is an example of an event request:

Request

<getEventsRequest>
   <key>
   <from>
   <until>
   <remove>
   <notify>
</getEventsRequest>

Response

<getEventsResponse>
   <events>
      <event>
           <event>
           <id>
           <timeStamp>
           <container>
           <key>
        </event>
      . . .
   </events>
   <status>
     <code>
   </status>
</getEventsResponse>

Elements

key: Uniquely identifies the application instance. It is up to the application to control the uniqueness of the application key. GroupWise Events uses any key that it is passed. If two applications or two instances of an application pass the same key, GroupWise Events maps them both to one event configuration structure in the user's database.
from: Provides the starting point of the date range for which events are returned to the application.
until: Provides the ending point of the date range for which events are returned to the application.
count: Specifies how many events to return in one response. If count is not specified, all events are returned.
remove: Specifies whether the event record is removed from the database upon a successful response to getEventsRequest. When set to TRUE (1), the event is removed from the database.
notify: Specifies whether the application wants to be notified of new occurrences of the types of events it has requested. The notification process maintains a list of all applications that want to be notified when that event occurs. Each time an application receives event notifications, it is removed from the notification list. To be placed back on the notification list, an application must send getEventsRequest with notify TRUE (1).
event: Identifies a GroupWise event that has occurred. Event item types are stored in a <space> separated list. Event modified fields are also stored in a <space> separated list.
id: Item identifier as defined in SOAP.
timeStamp: Specifies the date and time that the GroupWise event occurred.
container: Specifies the location in the GroupWise system where the event occurred.
status: Specifies whether getEventRequest was successful.
code: Provides the error number related to the event, if there is one.

Example

Following is a sample getEventsRequest:

<getEventsRequest>
   <key>Acme</key>
   <remove>1</remove>
   <notify>1</notify>
</getEventsRequest>

Following is a sample response to getEventsRequest:

<getEventsResponse>
   <events>
      <event>
           <event>FolderItemAdd</event>
              <id>41937EE0.AutoDomain.AutoPO1.100.1363230.1.272D.1</id>
            <timeStamp>2004-11-11T22:01:55Z</timeStamp>
              <container>7.AutoDomain.AutoPO1.100.0.1.0.1@16</container>
            <key>Acme</key>
           </event>
        <event>
     <event>FolderItemAdd</event>
           <id>41937F2C.AutoDomain.AutoPO1.100.1363230.1.272E.1</id>
           <timeStamp>2004-11-11T22:03:10Z</timeStamp>
     <container>7.AutoDomain.AutoPO1.100.0.1.0.1@16</container>
           <key>Acme</key>
        </event>
   </events>
   <status>
     <code>0</code>
   </status>
</getEventsResponse>