|
![[skip navigation]](images/clr_pxl.gif){kind=small}
|
|
Reference Type: Controlled Subscription, Category: Common Services, ICR#: 4575
The XUPS PERSONQUERY RPC uses the EN1^XUPSQRY API. This API provides the functionality to query the NEW PERSON (#200) file. The calling application can query the NEW PERSON (#200) file by using either the VA Security ID (SECID) of the requested entry or part or all of a last name. Other optional parameters can be passed to the call as additional filters.
NOTE: This API was released with Kernel Patch XU*8.0*325.
EN1^XUPSQRY(result,xupsecid,xupslnam[,xupsfnam][,xupsssn][,xupsprov][,xupsstn][,xupsmnm][,xupsdate])
| result: |
(required) Name of the subscripted return array. In every API that is used as an RPC, the first parameter is the return array. |
| xupsecid: |
(required) This parameter contains the SECID for the requested user. Either the SECID or last name is required. |
| xupslnam: |
(required) This parameter contains all or part of a last name. A last name or SECID are required input variables. |
| xupsfnam: |
(optional) This parameter is set to NULL or the full or partial first name. |
| xupsssn: |
(optional) This parameter is set to NULL or contains the 9 digits of the Social Security Number (SSN). |
| xupsprov: |
(optional) This parameter is set to NULL or P. If set to P, it screens for providers (person with active user class). |
| xupsstn: |
(optional) This parameter is set to NULL or the Station Number. |
| xupsmnm: |
(optional) This parameter is set to the maximum number of entries (1-50) to be returned. Defaults to 50. |
| xupsdate: |
(optional) This parameter contains the date used to determine if person class is active. Defaults to current date. |
| result(): |
Returns a subscripted output array of the input value/subscripted array (i.e., list) with the following possible values shown:
|