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

SUROLIST^XQALSURO(): List Surrogates for a User

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

Description

The SUROLIST^XQALSURO API returns a list of current or future surrogates for the user that is defined by the xqauser input parameter. It also sets the following surrogate fields in the ALERT (#8992) file if there is a current surrogate for this user:

Format

  SUROLIST^XQALSURO(xqauser,.xqalist)

Input Parameters

xqauser:

(required) This is the Internal Entry Number (IEN, DUZ value) in the NEW PERSON (#200) file for the specified user.
xqalist:

(required) Passed by reference; it contains the name of the output array.

Output Parameters

xqalist

The output contains the list of current and future surrogates for the specified user. The data in the list includes the following:

  • User's internal entry number (DUZ)

  • User's name

  • Start and end dates for the surrogate period

Set to a number equal to the count of the total number of surrogates returned in the list:

    XQALIST(n)

Where n is a sequential integer starting with 1. Each entry in the array contains:

    IEN^Name^Start Date/Time^End Date/Time

Example

>D SUROLIST^XQALSURO(duz,.output)

>ZW OUTPUT
OUTPUT=2
OUTPUT(1)="5206652^PERSON,FIRST^3071113.141547^3071113.142"
OUTPUT(2)="5206656^PERSON,SECOND^3071114^3071114.08"