IM Relationship Resolution Information Center, Version 4.2

getAlertDispositions() SOAP API method

Requests and obtains the details of all configured alert dispositions. Client applications will generally call this service and cache the result for later use in order to lookup address type details by their code. If a address type code is ever encountered that is not recognized in the client cache, then this service can be called again in order to update the lookup table within the client application. The UMF API equivalent of the getNameTypes method are the SOA_ALERT_DISPOSITIONS_REQUEST input document and the SOA_ALERT_DISPOSITIONS_RESPONSE output document.

Syntax

getAlertDispositions
(
 additionalinfo
 
);

Description

Parameters
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>
  <getAlertDispositions xmlns="http://services/">
   <additionalInfo xsi:nil="true" xmlns=""/>
  </getAlertDispositions>
 </soapenv:Body>
</soapenv:Envelope>

Description

Returns
getAlertDispositionsResponse
maxOccurs="unbounded"
minOccurs="0"
Value:
dispositions
Type xsd_4:AlertDispositionDetail
Value:
AlertDispositionDetail
Value:
internalID
Type: xsd:long
alertType
Type: xsd_2:AlertType
Value:
AlertType
Type: xsd:string
Values: ROLE_ALERT, ATTRIBUTE_ALERT, TRANSACTION_ALERT
dispositionCode
Type: xsd:string
description
Type: xsd:string
alertStatus
Type: xsd_2:AlertStatus
Value:
AlertStatus
Type: xsd:string
Values: UNASSIGNED, ASSIGNED, CLOSED, SUPPRESSED
status
minOccurs="0"
Type: xsd:xsd_3:Status
Value:
Status
Type: xsd:string
Values: ACTIVE, INACTIVE, OTHER
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>
  <getAlertDispositionsResponse xmlns="http://services/">
   <dispositions xmlns="">
    <internalID>1</internalID>
    <alertType>ROLE_ALERT</alertType>
    <dispositionCode>P</dispositionCode>
    <description>Default</description>
    <alertStatus>UNASSIGNED</alertStatus>
    <status>ACTIVE</status>
   </dispositions>
   <dispositions xmlns="">
    <internalID>2</internalID>
    <alertType>ATTRIBUTE_ALERT</alertType>
    <dispositionCode>P</dispositionCode>
    <description>Default Search</description>
    <alertStatus>UNASSIGNED</alertStatus>
    <status>ACTIVE</status>
   </dispositions>
   <dispositions xmlns="">
    <internalID>3</internalID>
    <alertType>ROLE_ALERT</alertType>
    <dispositionCode>ASSIGNED</dispositionCode>
    <description>Default User Assignment</description>
    <alertStatus>ASSIGNED</alertStatus>
    <status>ACTIVE</status>
   </dispositions>
   <dispositions xmlns="">
    <internalID>4</internalID>
    <alertType>ATTRIBUTE_ALERT</alertType>
    <dispositionCode>ASSIGNED</dispositionCode>
    <description>Default User Assignment</description>
    <alertStatus>ASSIGNED</alertStatus>
    <status>ACTIVE</status>
   </dispositions>
   <dispositions xmlns="">
    <internalID>5</internalID>
    <alertType>ROLE_ALERT</alertType>
    <dispositionCode>CLOSED</dispositionCode>
    <description>Default CLOSED</description>
    <alertStatus>CLOSED</alertStatus>
    <status>ACTIVE</status>
   </dispositions>
   <dispositions xmlns="">
    <internalID>6</internalID>
    <alertType>ATTRIBUTE_ALERT</alertType>
    <dispositionCode>CLOSED</dispositionCode>
    <description>Default CLOSED</description>
    <alertStatus>CLOSED</alertStatus>
    <status>ACTIVE</status>
   </dispositions>
   <dispositions xmlns="">
    <internalID>7</internalID>
    <alertType>ROLE_ALERT</alertType>
    <dispositionCode>F</dispositionCode>
    <description>Default Filtered</description>
    <alertStatus>SUPPRESSED</alertStatus>
    <status>ACTIVE</status>
   </dispositions>
   <dispositions xmlns="">
    <internalID>8</internalID>
    <alertType>TRANSACTION_ALERT</alertType>
    <dispositionCode>PENDING</dispositionCode>
    <description>Default OPEN</description>
    <alertStatus>UNASSIGNED</alertStatus>
    <status>ACTIVE</status>
   </dispositions>
   <dispositions xmlns="">
    <internalID>9</internalID>
    <alertType>TRANSACTION_ALERT</alertType>
    <dispositionCode>ASSIGNED</dispositionCode>
    <description>Default User Assignment</description>
    <alertStatus>ASSIGNED</alertStatus>
    <status>ACTIVE</status>
   </dispositions>
   <dispositions xmlns="">
    <internalID>10</internalID>
    <alertType>TRANSACTION_ALERT</alertType>
    <dispositionCode>CLOSED</dispositionCode>
    <description>Default CLOSED</description>
    <alertStatus>CLOSED</alertStatus>
    <status>ACTIVE</status>
   </dispositions>
  </getAlertDispositionsResponse>
 </soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009