IM Relationship Resolution Information Center, Version 4.2

getRoleAlertByID() SOAP API method

Requests and obtains the details of a role alert that is identified by the specified role alert ID. The UMF API equivalent of the getRoleAlertByID method are the SOA_ROLE_ALERT_BY_ID_REQUEST input document and the SOA_ROLE_ALERT_BY_ID_RESPONSE output document.

Syntax

getRoleAlertByID
(
 alertID,
 depth,
 additionalinfo

 
);

Description

Parameters
alertID
Type: long integer (64-bit)
Nullable: No
This parameter identifies the alert being requested.
depth
Type: DepthSetting
Nullable: Yes
This parameter indicates the level of detail for the response. If not specified, then FULL is assumed.
Valid Values: FULL
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>
  <getRoleAlertByID xmlns="http://services/">
   <alertID xsi:type="xsd:long" xmlns="">1</alertID>
   <depth xsi:type="ns1:DepthSetting" xmlns:ns1="http://common/" xmlns="">
    <value>FULL</value>
   </depth>
   <additionalInfo xsi:nil="true" xmlns=""/>
  </getRoleAlertByID>
 </soapenv:Body>
</soapenv:Envelope>

Description

Returns
getRoleAlertByIDResponse
Value:
roleAlert
Type: xsd_2:RoleAlertDetail
Value:
RoleAlertDetail
Value:
AlertDetail
Value:
alertID
Type: xsd_1:AlertIdentifier
Value:
alertIdentifier
Value:
alertType
Type: xsd_2:AlertType
Value:
AlertType
Type: xsd:string
Values: ROLE_ALERT, ATTRIBUTE_ALERT, TRANSACTION_ALERT
alertID
Type: xsd:long
timestamp
Type: xsd:dateTime
alertAnalysis
maxOccurs="unbounded"
minOccurs="0"
Type: xsd_1:AlertAnalysis
Value:
alertAnalysis
Value:
dispositionID
Type: xsd:long:
comment
Type: xsd:string
timestamp
Type: xsd:dateTime
createdBy
Type: xsd:string
dispositionID
Type: xsd:long:
roleAlertRuleID
Type: xsd:long
entities
Type: xsd_2:EntityDetail
Value:
EntityDetail
Value:
entityID
Type: xsd:long
largeEntity
minOccurs="0"
Type: xsd:boolean
entityType
minOccurs="0"
Type: xsd:string
bestName
minOccurs="0"
Type: xsd_1:NameDetail
Value:
NameDetail
Value:
AttributeDetail
Value:
IdentityHandle
Value:
internalID
Type: xsd:long
externalID
Type: xsd:string
dataSourceCode
Type: xsd:string
externalReference
Type: xsd:string
lastModifiedTimestamp
Type: xsd:dateTime
validFromTimestamp
Type: xsd:dateTime
validThroughTimestamp
Type: xsd:dateTime
nameID
Type: xsd:long
nameTypeCode
Type: xsd:string
givenName
Type: xsd:string
surname
Type: xsd:string
generation
Type: xsd:string
prefix
Type: xsd:string
suffix
Type: xsd:string
culture
Type: xsd:string
bestAddress
minOccurs="0"
Type: xsd_1:AddressDetail
Value:
AddressDetail
Value:
AttributeDetail
Value:
IdentityHandle
Value:
internalID
Type: xsd:long
externalID
Type: xsd:string
dataSourceCode
Type: xsd:string
externalReference
Type: xsd:string
lastModifiedTimestamp
Type: xsd:dateTime
validFromTimestamp
Type: xsd:dateTime
validThroughTimestamp
Type: xsd:dateTime
addressID
Type: xsd:long
addressTypeCode
Type: xsd:string
street1
Type: xsd:string
street2
Type: xsd:string
street3
Type: xsd:string
city
Type: xsd:string
state
Type: xsd:string
stateAbbreviation
Type: xsd:string
country
Type: xsd:string
countryISOCode
Type: xsd:string
postalCode
Type: xsd:string
buildingType
Type: xsd:string
latitude
Type: xsd:decimal
longitude
Type: xsd:decimal
leftovers
Type: xsd:string
bestNumber
minOccurs="0"
Type: xsd_1:NumberDetail
Value:
NumberDetail
Value:
AttributeDetail
Value:
IdentityHandle
Value:
internalID
Type: xsd:long
externalID
Type: xsd:string
dataSourceCode
Type: xsd:string
externalReference
Type: xsd:string
lastModifiedTimestamp
Type: xsd:dateTime
validFromTimestamp
Type: xsd:dateTime
validThroughTimestamp
Type: xsd:dateTime
numberID
Type: xsd:long
numberValue
Type: xsd:string
location
Type: xsd:string
numberTypeID
Type: xsd:long
userDefinedStatus
Type: xsd:string
bestEmail
minOccurs="0"
Type: xsd_1:EmailDetail
Value:
EmailDetail
Value:
AttributeDetail
Value:
IdentityHandle
Value:
internalID
Type: xsd:long
externalID
Type: xsd:string
dataSourceCode
Type: xsd:string
externalReference
Type: xsd:string
lastModifiedTimestamp
Type: xsd:dateTime
validFromTimestamp
Type: xsd:dateTime
validThroughTimestamp
Type: xsd:dateTime
emailID
Type: xsd:long
emailAddress
Type: xsd:string
userEmailType
Type: xsd:string
userDefinedStatus
Type: xsd:string
roleIDs
maxOccurs="unbounded"
minOccurs="0"
Type: xsd:long
identities
maxOccurs="unbounded"
minOccurs="0"
Type: xsd_1:IdentityDetail
Value:
identityHandle
Value:
internalID
Type: xsd:long
externalID
Type: xsd:string
dataSourceCode
Type: xsd:string
externalReference
Type: xsd:string
roleIDs
Type: xsd:long
attributes
Type: xsd_1:AttributeDetail
Value:
identityHandle
Type: xsd_1:IdentityHandle
Value:
internalID
Type: xsd:long
externalID
Type: xsd:string
dataSourceCode
Type: xsd:string
externalReference
Type: xsd:string
lastModifiedTimestamp
Type: xsd:dateTime
validFromTimestamp
Type: xsd:dateTime
validThroughTimestamp
Type: xsd:dateTime
relationshipPath
Type: xsd_3:RelationshipPath
Value:
RelationshipPath
Value:
fromEntityID
Type: xsd:long
toEntityID
Type: xsd:long
pathStrength
minOccurs="0"
Type: xsd:float
degreesOfSeparation
minOccurs="0"
Type: xsd:int
relationships
maxOccurs="unbounded"
minOccurs="0"
Type: xsd_1:Relationship
Value:
Relationship
Value:
fromEntityID
Type: xsd:long
toEntityID
Type: xsd:long
resolutionDetail
Type: xsd_2:ResolutionDetail
Value:
ResolutionDetail
Value:
relationshipConfidence
minOccurs="0"
Type: xsd:int
likenessConfidence
minOccurs="0"
Type: xsd:int
resolutionID
minOccurs="0"
Type: xsd:long
resolutionRuleID
minOccurs="0"
Type: xsd:long
resolutionRuleDescription
minOccurs="0"
Type: xsd:string
contributors
maxOccurs="unbounded"
minOccurs="0"
Type: xsd_1:ResolutionContributor
adjustedPathStrength
Type: xsd:float:
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>
  <getRoleAlertByIDResponse xmlns="http://services/">
   <roleAlert xmlns="">
    <alertID>
     <alertType>ROLE_ALERT</alertType>
     <alertID>1</alertID>
    </alertID>
    <timestamp>2008-07-28T15:11:51</timestamp>
    <dispositionID>1</dispositionID>
    <roleAlertRuleID>1</roleAlertRuleID>
    <entities>
     <entityID>2</entityID>
     <roleIDs>1</roleIDs>
     <largeEntity>FALSE</largeEntity>
     <entityType>PERSON</entityType>
     <bestName>
      <identityHandle>
       <internalID>3</internalID>
       <externalID>190-020028</externalID>
       <dataSourceCode>100</dataSourceCode>
       <externalReference>190-020028</externalReference>
      </identityHandle>
      <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
      <nameID>3</nameID>
      <nameTypeCode>M</nameTypeCode>
      <givenName>WILLIAM</givenName>
      <surname>BROWNSR</surname>
     </bestName>
     <bestAddress>
      <identityHandle>
       <internalID>3</internalID>
       <externalID>190-020028</externalID>
       <dataSourceCode>100</dataSourceCode>
       <externalReference>190-020028</externalReference>
      </identityHandle>
      <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
      <addressID>4</addressID>
      <addressTypeCode>O</addressTypeCode>
      <street1>111 First St</street1>
      <city>LV</city>
      <state>NV</state>
      <country>USA</country>
      <postalCode>89110</postalCode>
     </bestAddress>
     <bestNumber>
      <identityHandle>
       <internalID>3</internalID>
       <externalID>190-020028</externalID>
       <dataSourceCode>100</dataSourceCode>
       <externalReference>190-020028</externalReference>
      </identityHandle>
      <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
      <numberID>3</numberID>
      <numberTypeID>2</numberTypeID>
      <numberValue>191-54-2667</numberValue>
     </bestNumber>
     <identities>
      <identityHandle>
       <internalID>2</internalID>
       <externalID>190-020025</externalID>
       <dataSourceCode>100</dataSourceCode>
       <externalReference>190-020025</externalReference>
      </identityHandle>
      <roleIDs>1</roleIDs>
      <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:NameDetail">
       <identityHandle>
        <internalID>2</internalID>
        <externalID>190-020025</externalID>
        <dataSourceCode>100</dataSourceCode>
        <externalReference>190-020025</externalReference>
       </identityHandle>
       <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
       <nameID>2</nameID>
       <nameTypeCode>M</nameTypeCode>
       <givenName>BILL</givenName>
       <surname>BROWNJR</surname>
      </attributes>
      <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:AddressDetail">
       <identityHandle>
        <internalID>2</internalID>
        <externalID>190-020025</externalID>
        <dataSourceCode>100</dataSourceCode>
        <externalReference>190-020025</externalReference>
       </identityHandle>
       <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
       <addressID>2</addressID>
       <addressTypeCode>H</addressTypeCode>
       <street1>4170 Rue Sere</street1>
       <city>St Laurent</city>
       <state>Quebec</state>
       <country>Canada</country>
       <postalCode>h4t1a6</postalCode>
      </attributes>
      <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:NumberDetail">
       <identityHandle>
        <internalID>2</internalID>
        <externalID>190-020025</externalID>
        <dataSourceCode>100</dataSourceCode>
        <externalReference>190-020025</externalReference>
       </identityHandle>
       <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
       <numberID>2</numberID>
       <numberTypeID>2</numberTypeID>
       <numberValue>191-54-2667</numberValue>
      </attributes>
      <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:CharacteristicDetail">
       <identityHandle>
        <internalID>2</internalID>
        <externalID>190-020025</externalID>
        <dataSourceCode>100</dataSourceCode>
        <externalReference>190-020025</externalReference>
       </identityHandle>
       <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
       <characteristicID>2</characteristicID>
       <characteristicValue>M</characteristicValue>
       <characteristicTypeID>2</characteristicTypeID>
      </attributes>
     </identities>
     <identities>
      <identityHandle>
       <internalID>3</internalID>
       <externalID>190-020028</externalID>
       <dataSourceCode>100</dataSourceCode>
       <externalReference>190-020028</externalReference>
      </identityHandle>
      <roleIDs>1</roleIDs>
      <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:NameDetail">
       <identityHandle>
        <internalID>3</internalID>
        <externalID>190-020028</externalID>
        <dataSourceCode>100</dataSourceCode>
        <externalReference>190-020028</externalReference>
       </identityHandle>
       <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
       <nameID>3</nameID>
       <nameTypeCode>M</nameTypeCode>
       <givenName>WILLIAM</givenName>
       <surname>BROWNSR</surname>
      </attributes>
      <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:AddressDetail">
       <identityHandle>
        <internalID>3</internalID>
        <externalID>190-020028</externalID>
        <dataSourceCode>100</dataSourceCode>
        <externalReference>190-020028</externalReference>
       </identityHandle>
       <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
       <addressID>3</addressID>
       <addressTypeCode>B</addressTypeCode>
       <street1>4170 Rue Sere</street1>
       <city>St Laurent</city>
       <state>Quebec</state>
       <country>Canada</country>
       <postalCode>h4t1a6</postalCode>
      </attributes>
      <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:AddressDetail">
       <identityHandle>
        <internalID>3</internalID>
        <externalID>190-020028</externalID>
        <dataSourceCode>100</dataSourceCode>
        <externalReference>190-020028</externalReference>
       </identityHandle>
       <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
       <addressID>4</addressID>
       <addressTypeCode>O</addressTypeCode>
       <street1>111 First St</street1>
       <city>LV</city>
       <state>NV</state>
       <country>USA</country>
       <postalCode>89110</postalCode>
      </attributes>
      <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:NumberDetail">
       <identityHandle>
        <internalID>3</internalID>
        <externalID>190-020028</externalID>
        <dataSourceCode>100</dataSourceCode>
        <externalReference>190-020028</externalReference>
       </identityHandle>
       <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
       <numberID>3</numberID>
       <numberTypeID>2</numberTypeID>
       <numberValue>191-54-2667</numberValue>
      </attributes>
      <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:CharacteristicDetail">
       <identityHandle>
        <internalID>3</internalID>
        <externalID>190-020028</externalID>
        <dataSourceCode>100</dataSourceCode>
        <externalReference>190-020028</externalReference>
       </identityHandle>
       <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
       <characteristicID>3</characteristicID>
       <characteristicValue>M</characteristicValue>
       <characteristicTypeID>2</characteristicTypeID>
      </attributes>
     </identities>
    </entities>
    <relationshipPath>
     <fromEntityID>2</fromEntityID>
     <toEntityID>2</toEntityID>
     <pathStrength>100.00</pathStrength>
     <degreesOfSeparation>0</degreesOfSeparation>
     <relationships>
      <fromEntityID>2</fromEntityID>
      <toEntityID>2</toEntityID>
      <resolutionDetail>
       <relationshipConfidence>100</relationshipConfidence>
       <likenessConfidence>100</likenessConfidence>
       <resolutionID>3</resolutionID>
       <resolutionRuleID>1</resolutionRuleID>
       <resolutionRuleDescription>Name &amp; Unique Number</resolutionRuleDescription>
       <contributors xmlns:ns1="http://resolution/results/" xsi:type="ns1:ResolvedName">
        <givenNameScore xsi:type="xsd:double">95.000</givenNameScore>
        <surnameScore xsi:type="xsd:double">78.000</surnameScore>
        <fullNameScore xsi:type="xsd:double">79.000</fullNameScore>
        <nameAlgorithm>NAME_COMPARATOR_2</nameAlgorithm>
        <inboundName>
         <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
         <nameID>3</nameID>
         <nameTypeCode>M</nameTypeCode>
         <givenName>WILLIAM</givenName>
         <surname>BROWNSR</surname>
        </inboundName>
        <existingName>
         <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
         <nameID>2</nameID>
         <nameTypeCode>M</nameTypeCode>
         <givenName>BILL</givenName>
         <surname>BROWNJR</surname>
        </existingName>
       </contributors>
       <contributors xmlns:ns1="http://resolution/results/" xsi:type="ns1:ResolvedAddress">
        <matchType>FULL_ADDRESS</matchType>
        <score>8</score>
        <inboundAddress>
         <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
         <addressID>3</addressID>
         <addressTypeCode>B</addressTypeCode>
         <street1>4170 Rue Sere</street1>
         <city>St Laurent</city>
         <state>Quebec</state>
         <country>Canada</country>
         <postalCode>h4t1a6</postalCode>
        </inboundAddress>
        <existingAddress>
         <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
         <addressID>2</addressID>
         <addressTypeCode>H</addressTypeCode>
         <street1>4170 Rue Sere</street1>
         <city>St Laurent</city>
         <state>Quebec</state>
         <country>Canada</country>
         <postalCode>h4t1a6</postalCode>
        </existingAddress>
       </contributors>
       <contributors xmlns:ns1="http://resolution/results/" xsi:type="ns1:ResolvedNumber">
        <inboundNumber>
         <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
         <numberID>3</numberID>
         <numberTypeID>2</numberTypeID>
         <numberValue>191-54-2667</numberValue>
        </inboundNumber>
        <existingNumber>
         <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
         <numberID>2</numberID>
         <numberTypeID>2</numberTypeID>
         <numberValue>191-54-2667</numberValue>
        </existingNumber>
       </contributors>
       <contributors xmlns:ns1="http://resolution/results/" xsi:type="ns1:ResolvedDate">
        <scoreAdjustment>5</scoreAdjustment>
        <inboundCharacteristic xmlns:ns1="http://entity/results/"
         xsi:type="ns1:CharacteristicDetail">
         <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
         <characteristicID>3</characteristicID>
         <characteristicValue>M</characteristicValue>
         <characteristicTypeID>2</characteristicTypeID>
        </inboundCharacteristic>
        <existingCharacteristic xmlns:ns1="http://entity/results/"
         xsi:type="ns1:CharacteristicDetail">
         <lastModifiedTimestamp>2008-07-28T15:11:51</lastModifiedTimestamp>
         <characteristicID>2</characteristicID>
         <characteristicValue>M</characteristicValue>
         <characteristicTypeID>2</characteristicTypeID>
        </existingCharacteristic>
        <dateScore>0</dateScore>
       </contributors>
      </resolutionDetail>
     </relationships>
    </relationshipPath>
    <adjustedPathStrength>100.00</adjustedPathStrength>
   </roleAlert>
  </getRoleAlertByIDResponse>
 </soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009