FindActiveUserNotifications

Returns a list of all active notifications for the specified User; may also be limited to a specific Event Domain or incident ID.

Sample SOAP Request

Request Parameters

Name

Description

Type

Optional

searchParameters

Specifies the criteria to use when searching for notifications; the following parameters are supported:

  • owner: target name of the User
  • eventDomain: the specific Event Domain to which the returned notifications should be associated (Optional)
  • incidentId: the ID of the specific incident to which the returned notifications should be associated (Optional)

list

no

Sample SOAP Response

Response Parameters

Name

Description

Type

personNotificationList

List of User notifications matching the specified search criteria. Each notification returned includes the following details:

  • eventIdentifier: event ID of the notification's associated event
  • incident_id: incident ID of the notification's associated event
  • message: the notification's content
  • notificationTimestamp: time at which the notification was created
  • personNotificationId: User notification identifier for this event
  • responseChoices: list of available responses
  • subject: the notification's subject
  • targetName: target name of the User
  • targetNameId: person ID associated to the target name

list

serverTimestamp

Time corresponding to the server time when the request was made (this should match the associated persisted audit event)

string

status

Final status of the request

string

Note: The result set for this web service only contains records from the runtime data tables; any matching results for the specified date range in the archive tables will not be returned.

Standard SOAP Parameters

SOAP Response Status Messages