The SOA_EVENT_DETAILS_REQUEST input document contains the
request and search criteria to obtain the details of those events
that match the specified criteria. The results of this Web services
input document are returned to the calling application in a SOA_EVENT_DETAILS_RESPONSE
output document.
These UMF tags comprise the ROOT segment for the SOA_EVENT_DETAILS_REQUEST
input document:
- ENTITY_ID
- Required: Yes, if DSRC_ACCT is not provided.
- Identifies the entity for which the event alerts are being requested.
This tag should not be provided if the DSRC_CODE or DSRC_ACCT
tags are provided.
- DSRC_ACCT
- Required: Yes, if ENTITY_ID is not provided.
- Identifies an identity record of the entity for which the event
alerts are being requested within a specific data source. This tag
should not be provided if the ENTITY_ID tag is provided. This
tag should always be accompanied by the DSRC_CODE tag when
it is provided.
- DSRC_CODE
- Required: Yes, if the DSRC_ACCT tag is provided.
- Identifies the data source for the identity record of the entity
for which the event alerts are being requested. This tag should not be
provided if the ENTITY_ID tag is provided. This tag should always be
accompanied by the DSRC_ACCT tag when it is provided.
- EVENT_REF
- Required: No
- The specific event reference to use for filtering the events.
If not provided then events with any event reference will be included.
- DEPTH
- Required: No
- It indicates the level of detail for the response. If not specified,
then FULL is assumed.
The SOAP-RPC equivalent of the SOA_EVENT_DETAILS_REQUEST
input document and the SOA_EVENT_DETAILS_RESPONSE output document
is the getEventDetailsByFilter method.
Example SOA_EVENT_DETAILS_REQUEST input document
This
example SOA_EVENT_DETAILS_REQUEST query requests the details of an
event that is identified by the event reference value of
342.
Note: This example is formatted for
readability and does not follow the required one line per UMF record
format.
<SOA_EVENT_DETAILS_REQUEST>
<ENTITY_ID >12345</ENTITY_ID>
<EVENT_REF>342</EVENT_REF>
<DEPTH>STANDARD</DEPTH>
</SOA_EVENT_DETAILS_REQUEST>
Example SOA_EVENT_DETAILS_RESPONSE output document
This
example SOA_EVENT_DETAILS_RESPONSE output document shows the details
of an event that is identified by the event reference value of
342.
Output document elements:
- EVENT
- Parent tag: [ROOT]
- Required: No
- Zero or more of these container tags are provided (one for each
event). If not provided, then no matching alerts matched the specified
criteria. This is a standard SOA event alert segment
- SYS_CREATE_DT
- Parent tag: [ROOT]
- Required: Yes
- Timestamp of when the output message was generated.
Note: This example is formatted for readability
and does not follow the required one line per UMF record format.
<SOA_EVENT_DETAILS_RESPONSE>
<EVENT>
<EVENT_ID>123</EVENT_ID>
<DSRC_ACCT_ID>345</DSRC_ACCT_ID>
<DSRC_CODE>EMPL</DSRC_CODE>
<DSRC_REF>ABC</DSRC_REF>
<EVENT_REF>342</EVENT_REF>
<EVENT_TYPE_ID>6789</EVENT_TYPE_ID>
<EVENT_LOC>ATM 345678</EVENT_LOC>
<EVENT_MEMO1>Blah blah blah</EVENT_MEMO1>
<EVENT_MEMO2>Blah boo blah boo</EVENT_MEMO2>
<EVENT_START_DT>2009-04-23 15:50:21</EVENT_START_DT>
<EVENT_END_DT>2009-04-25 17:22:11</EVENT_END_DT>
<EVENT_QTY>456.22</EVENT_QTY>
<EVENT_UNIT_VALUE>456.22</EVENT_UNIT_VALUE>
<EVENT_VALUE>456.22</EVENT_VALUE>
<EVENT_STATUS>Open</EVENT_STATUS>
<SYS_CREATE_DT>2009-04-23 15:50:21</SYS_CREATE_DT>
<SYS_LSTUPD_DT>2009-04-23 15:50:21</SYS_CREATE_DT>
</EVENT>
<EVENT>
<EVENT_ID>145</EVENT_ID>
<DSRC_ACCT_ID>345</DSRC_ACCT_ID>
<DSRC_CODE>EMPL</DSRC_CODE>
<DSRC_REF>ABC</DSRC_REF>
<EVENT_REF>342</EVENT_REF>
<EVENT_TYPE_ID>6789</EVENT_TYPE_ID>
<EVENT_LOC>ATM 115178</EVENT_LOC>
<EVENT_MEMO1>Blah blah blah</EVENT_MEMO1>
<EVENT_MEMO2>Blah boo blah boo</EVENT_MEMO2>
<EVENT_START_DT>2009-03-21 13:22:11</EVENT_START_DT>
<EVENT_END_DT>2009-03-22 17:22:11</EVENT_END_DT>
<EVENT_QTY>326.13</EVENT_QTY>
<EVENT_UNIT_VALUE>326.13</EVENT_UNIT_VALUE>
<EVENT_VALUE>326.132</EVENT_VALUE>
<EVENT_STATUS>Closed</EVENT_STATUS>
<SYS_CREATE_DT>2009-03-21 13:22:11</SYS_CREATE_DT>
<SYS_LSTUPD_DT>2009-03-21 13:22:11</SYS_CREATE_DT>
</EVENT>
<SYS_CREATE_DT>2008-06-26 05:18:55</SYS_CREATE_DT>
</SOA_EVENT_DETAILS_RESPONSE>
Table 1. Error
segments for getEventDetailsByFilter (UMF)Message ID |
Cause |
CWUAE####E |
If a required tag is not provided. |