IM Relationship Resolution Information Center, Version 4.2

closeAlert() SOAP API method

Transitions an unassigned open alert or an assigned alert to a closed disposition. The UMF API equivalent of the closeAlert method are the SOA_CLOSE_ALERT_REQUEST input document and the SOA_CLOSE_ALERT_RESPONSE output document.

Syntax

closeAlert
(
 alertIdentifier,
 closedByUser,
 closeDispositionID,
 comment,
 additionaInfo,
 
);

Description

Parameters
alertIdentifier
Type: AlertIdentifier
Nullable: No
This parameter identifies the alert for which the disposition is being updated.
closedByUser
Type: String
Nullable: No
This parameter identifies the user name of the analyst performing the change in disposition for the alert. The user should be a recognized active user.
closeDispositionID
Type: long integer (64-bit)
Nullable: No
This parameter identifies the disposition to be assigned to the alert.
comment
Type: String
Nullable: No
This parameter details the reasons why the disposition is being changed for the alert.
additionalinfo
Type: CustomInformation
Nullable: Yes
This parameter is reserved for field customizations to the WSDL and XSLT transforms without changing the signature of the method.
Example Request
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <soapenv:Body>
  <closeAlert xmlns="http://services/">
   <alertIdentifier xmlns="">
    <alertType>ROLE_ALERT</alertType>
    <alertID>71</alertID>
   </alertIdentifier>
   <closedByUser xmlns="">admin</closedByUser>
   <closedDispositionID xsi:type="xsd:long" xmlns="">5</closedDispositionID>
   <comment xmlns="">sample comment</comment>
   <additionalInfo xsi:nil="true" xmlns=""/>
  </closeAlert>
 </soapenv:Body>
</soapenv:Envelope>

Description

Returns
boolean
Values:
TRUE
request executed
FALSE
request NOT executed
Example Response
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
 <soapenv:Body>
  <closeAlertResponse xmlns="http://services/">
   <alertClosed xmlns="">TRUE</alertClosed>
  </closeAlertResponse>
 </soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009