pp108 : GetNotifications

GetNotifications


This method is used to get all the notifications based on search criteria.

SOAP Request
<SOAP:Envelope
            xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP:Body>
    <GetNotifications
                xmlns="http://schemas.cordys.com/notification/workflow/1.0">
      <cursor
                id="" maxRows="" numRows=""
                    position=""/>
      <TaskIdentifiers>
        <TaskIdentifierType
                    id="15d5a9e3-f7c3-4a44-99cb-7146f478616c"
                        name="SalesOrder"/>
    </TaskIdentifiers>
      <Criteria>
        <Query>(Notification.Subject =:subject)</Query>
        <Parameters>
          <Parameter
                        name="subject" type="Notification.Subject" value="Test Send Notification"/>
        </Parameters>
      </Criteria>
      <OrderBy>PARAMETER</OrderBy>
      <ReturnNotificationData>true</ReturnNotificationData>
    </GetNotifications>
  </SOAP:Body>
</SOAP:Envelope>

Request Parameters

Parameter

Description

Data Type

Required

Accepted Input Values

Cursor

Number of rows that would be returned by the query

Criteria

Contains the criteria defined for searching the message.

It can be based on System attributes like Source ,Subject , Sender, Receiver, DeliveryDate, and Priority and prefixed by Notification.For Example, Notification. Source=:source

OrderBy

Contains the way of arranging tasks in ascending or descending order based on the attributes.

For Example:

  • Notification.Assignee ASC - will display the tasks in ascending order based on the Notification.Assignee attribute
  • Notification.Assignee DESC - will display the tasks in descending order based on the Notification.Assignee attribute

TaskIdentifierId Type

Id of the task identifier type

Optional

  • id: Id of the task identifier type.
  • name: Name of the task identifier type.

ReturnNotificationData

To decide Notification Data is required or not

It can be set as true\false to display the notification data or not.


SOAP Response
<GetNotificationsResponse
    xmlns="http://schemas.cordys.com/notification/workflow/1.0"
        xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <cursor
                    id="-1"/>
    <tuple>
      <old>
        <Notification>
          <NotificationId>005056C0-0008-11E0-EF8B-F9BF65251FD3</NotificationId>
          <MessageId/>
          <Sender
                    displayName="npraveen" email="" phone1=""
                    phone2="">cn=npraveen,cn=organizational users,o=system,cn=cordys,cn=signfp1,o=vanenburg.com</Sender>
          <Receiver
                    displayName="npraveen" email="" phone1="" phone2="">cn=npraveen,cn=organizational users,o=system,cn=cordys,cn=signfp1,o=vanenburg.com</Receiver>
          <Subject>Test Send Notification</Subject>
          <Source/>
          <ReadFlag>false</ReadFlag>
          <DeliveryDate>2011-05-12T06:19:35.063</DeliveryDate>
          <DelegatedToUser/>
          <NotificationData>
            <ApplicationData/>
            <CustomData/>
            <Links/>
            <Annotation>
              <Annotation>PARAMETER</Annotation>
            </Annotation>
          </NotificationData>
        </Notification>
      </old>
    </tuple>
  </GetNotificationsResponse>

Response Parameters

Parameter

Description

NotificationId

Contains the unique identifier of the notification.

Sender

Contains the DN of the user who sent the notification.

Receiver

Contains the DN of the user who receives the notification.

Memo

Contains the content of the memo.

Subject

Contains the subject of the notification.

Source

Contains the name of the source that sent the notification.

ReadFlag

Contains boolean value indicating if the notification is read or not read.
If ReadFlag is set to:

  • true - indicates that the notification is read.
  • false - indicates that the notification is not read.

DeliveryDate

Contains the date on which the notification is delivered to the user.

DelegatedToUser

Contains the DN of the user to whom the notification is delivered.