Kernel 8.0 APIs Banner
Office of Information and Technology (OIT) Banner
[skip navigation]

DELSTAT^XQALBUTL(): Get Recipient Information and Alert Status

Reference Type: Supported, Category: Alerts, ICR#: 3197

Description

The DELSTAT^XQALBUTL API obtains information on the recipients of the most recent alert with a specified alert ID and the status of whether the alert has been deleted or not for those recipients.

Format

  DELSTAT^XQALBUTL(xqaidval,.values)

Input Parameters

xqaidval:

(required) This input parameter is a value that has been used as the xqaid value for generating an alert by a software application. This value is used to identify the most recent alert generated with this xqaid value and that alert is used to generate the responses in terms of recipients and deletion status of the alert for each of the recipients.

Output Parameters

.values:

This parameter is passed by reference and is returned as an array. The value of the values array indicates the number of entries in the array. The entries are then ordered in numerical order in the values array. The array contains the DUZ for users along with an indicator of whether or not the alert has been deleted.

NOTE: The contents of the array are KILLed prior to building the list.

For example:

  • DUZ^1—If alert deleted.

  • DUZ^0—If alert not deleted.

Example

>D DELSTAT^XQALBUTL("OR;14765;23",.VALUE)

The value of VALUE indicates the number of entries in the array. The entries are then ordered in numerical order in the VALUE array:

    VALUE = 3
    VALUE(1) = "146^0"   User 146 - not deleted
    VALUE(2) = "297^1"   User 297 - deleted
    VALUE(3) = "673^0"   User 673 - not deleted