IM Relationship Resolution Information Center, Version 4.2

getRoleAlertRules() SOAP API method

Requests and obtains the details of all configured role alert rules. Client applications will generally call this service and cache the result for later use in order to lookup role alert rules by their "internal ID". If a role alert rule ID 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 getRoleAlertRules method are the SOA_ROLE_ALERT_RULES_REQUEST input document and the SOA_ROLE_ALERT_RULES_RESPONSE output document.

Syntax

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

Description

Returns
getRoleAlertRulesResponse
Value:
roleAlertRules
Type: xsd_4:RoleAlertRuleDetail
Value:
RoleAlertRuleDetail
Value:
internalID
Type: xsd:long
roleID1
Type: xsd:long
roleID2
Type: xsd:long
description
minOccurs="0"
Type: xsd:string
status
minOccurs="0"
Type: xsd:xsd_3:Status
Value:
Status
Type: xsd:string
Values: ACTIVE, INACTIVE, OTHER
alertSuppression
maxOccurs="unbounded"
minOccurs="0"
Type: xsd_1:AlertSuppression
Value:
AlertSuppression
Value:
minimumPathStrengthThreshold
minOccurs="0"
Type: xsd:float
duplicatePathStrengthAdjustment
minOccurs="0"
Type: xsd:int
duplicateDataSuppression
minOccurs="0"
Type: xsd_1:DuplicateAlertDataSupression
Value:
DuplicateAlertDataSuppression
Type: xsd:string
Values: TEXT, DATE, CUSTOM
duplicateIdentitySuppression
minOccurs="0"
Type: xsd_1:DuplicateIdentitySuppression
Value:
DuplicateAlertIdentitySuppression
Type: xsd:string
Values: NONE, NEW_IDENTITY, NEW_DATA_SOURCE
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>
  <getRoleAlertRulesResponse xmlns="http://services/">
   <roleAlertRules xmlns="">
    <internalID>1</internalID>
    <roleID1>1</roleID1>
    <roleID2>1</roleID2>
    <description>Test Conflict Rule</description>
    <alertSuppression>
     <minimumPathStrengthThreshold>0.00</minimumPathStrengthThreshold>
     <duplicatePathStrengthAdjustment>0</duplicatePathStrengthAdjustment>
     <duplicateIdentitySuppression>NONE</duplicateIdentitySuppression>
     <duplicateDataSuppression>NONE</duplicateDataSuppression>
    </alertSuppression>
   </roleAlertRules>
   <roleAlertRules xmlns="">
    <internalID>1159</internalID>
    <roleID1>1160</roleID1>
    <roleID2>1159</roleID2>
    <description>Bad Knows Good</description>
    <alertSuppression>
     <minimumPathStrengthThreshold>0.00</minimumPathStrengthThreshold>
     <duplicatePathStrengthAdjustment>0</duplicatePathStrengthAdjustment>
     <duplicateIdentitySuppression>NONE</duplicateIdentitySuppression>
     <duplicateDataSuppression>NONE</duplicateDataSuppression>
    </alertSuppression>
   </roleAlertRules>
   <roleAlertRules xmlns="">
    <internalID>1160</internalID>
    <roleID1>1160</roleID1>
    <roleID2>1161</roleID2>
    <description>Bad Knows Neutral</description>
    <alertSuppression>
     <minimumPathStrengthThreshold>0.00</minimumPathStrengthThreshold>
     <duplicatePathStrengthAdjustment>0</duplicatePathStrengthAdjustment>
     <duplicateIdentitySuppression>NONE</duplicateIdentitySuppression>
     <duplicateDataSuppression>NONE</duplicateDataSuppression>
    </alertSuppression>
   </roleAlertRules>
   <roleAlertRules xmlns="">
    <internalID>1161</internalID>
    <roleID1>1160</roleID1>
    <roleID2>1160</roleID2>
    <description>Bad Knows Bad</description>
    <alertSuppression>
     <minimumPathStrengthThreshold>0.00</minimumPathStrengthThreshold>
     <duplicatePathStrengthAdjustment>0</duplicatePathStrengthAdjustment>
     <duplicateIdentitySuppression>NONE</duplicateIdentitySuppression>
     <duplicateDataSuppression>NONE</duplicateDataSuppression>
    </alertSuppression>
   </roleAlertRules>
  </getRoleAlertRulesResponse>
 </soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009