getEventConfigurationRequest

Returns one or all event configuration definitions for a GroupWise user.

Request

<getEventConfigurationRequest>
   <key/>
</getEventConfigurationRequest>

Response

<getEventConfigurationResponse>
   <events enabled="">
      <key/>
      <persistence/>
      <ipAddress/>
      <port/>
      <http/>
      <event>
      <event>
       . . .
      <type/>
      <field/>
      <containers/>
      <subType/>
   </events>
   <status>
      <code/>
   </status>
</getEventConfigurationResponse>

Definitions

enabled

Boolean. Enables or disables event processing. True (1) creates event records. False (0), disables event processing for that event configuration. Other event configurations are not affected.

key

String. Uniquely identifies the event configuration in a user's database. It is up to the application to control the uniqueness of the application key. GroupWise Web Services Events uses any key that it is passed. If two applications or two instances of an application pass the same key, GroupWise Web Services Events maps both to one event configuration structure in the user’s database. If a key is not provided, all event definitions for the user are returned.

persistence

A duration, from 0-20 days, that specifies how long old event records remain in a user’s database. If not defined, the default is seven days. For more information on how the persistence value is used to remove event records, see Section 1.4, Event Records.

ipAddress

Identifies the IP address, DNS name, or the HTTP URL that should be used for event notification.

port

Identifies the IP port on which the application is listening for event notifications.

http

Specifies whether event notification should occur through TCP/IP or HTTP. False (0) indicates that the value in ipAddress is treated as an IP address and a TCP/IP stream is used for the notification. True (1) indicates that the value in ipAddress is treated as an HTTP URL, such as http://www.acme.com/events.

event

Identifies the specific events that an application wants to track. For example, if an application wants to create event records when items are added and deleted from a folder, the event element contains FolderItemAdd ItemDelete. The list of event types is space-delimited. For a complete list of event types, see EventType in the events.xsd schema.

type

Identifies the specific item types that an application wants to track. For example, if an application wants to create event records only when a specific action occurs to appointments and tasks, the type element contains Appointment Task. The list of item types is space delimited. For a complete list of item types, see itemType in the events.xsd schema.

field

Identifies the specific item fields that an application wants to track. The field element applies only to items that are modified. For example, if an application wants to create event records only when the PersonalSubject and Category fields are modified, the field element contains PersonalSubject Category. The list of fields is space-delimited. For a complete list of fields, see FieldList in the events.xsd schema.

containers

Identifies specific containers where an application wants to track folder events. If no container is specified, events are reported for all containers in the user's account, except folders shared with the user.

subType

Identifies a custom item type. Applications can create custom item types by adding the subType element when creating an item. The subType element is defined in the GroupWise types.xsd schema.

During the creation of the item, an application could provide a unique string in the subType element. For example, the application could provide Acme as the subType element and any items that are created have an Acme subType. Applications can search and filter items based on the subType element. This is GroupWise Web Services implementation of className in the GroupWise Object API.

The GroupWise Web Services Events subType element can be used to track events only on the items that have a subType field that matches the subType. For example, if an application creates an item with a subType of Acme and wants to track all items with an Acme subType, the application provides Acme in the subType element while calling configureEventsRequest.

status

Specifies whether the getEventConfigurationRequest method was successful.

code

Provides the error number related to the event. 0 means that the request was successful.

Remarks

If the key element is provided in the call to getEventConfigurationRequest, only that specific event definition is returned. If the key element is not provided, all event definitions for the user are returned.

Example

<getEventConfigurationResponse>
   <events>
      <event enabled="1">
         <key>Acme</key>
         <persistence>8</persistence>
         <ipAddress>app1.widgets.com</ipAddress>
         <port>5221</port>
         <http>0</http>
         <event>
            <event>ItemAccept</event>
            <event>ItemComplete</event>
            <event>ItemDecline</event>
            <event>ItemDelete</event>
            <event>ItemPurge</event>
            <event>ItemMarkRead</event>
            <event>ItemUndelete</event>
            <event>ItemMarkUnread</event>
            <event>FolderItemAdd</event>
            <event>FolderItemMove</event>
            <event>FolderItemRemove</event>
         </event>
         <type>Appointment Mail Note Task</type>
      </event>
      <event enabled="1">
         <key>AB</key>
         <persistence>0</persistence>
         <ipAddress>http://prestons/</ipAddress>
         <port>5221</port>
         <http>1</http>
         <event>
            <event>AddressBookDelete</event>
            <event>AddressBookAdd</event>
            <event>AddressBookItemDelete</event>
            <event>AddressBookItemAdd</event>
         </event>
      </event>
      <containers>
         <container>7.AutoDomain.AutoPO1.100.0.1.0.1@16</container>
         <container>A.AutoDomain.AutoPO1.100.0.1.0.1@19</container>
      </containers>
   </events>
   <status>
      <code>0</code>
   </status>
</getEventConfigurationResponse>