getRoleAlertsByEntity() SOAP API method

Requests and obtains the details of all role alerts for a specific entity that is identified by its entity ID or by the external ID of one of its composite identity records. The UMF API equivalent of the getRoleAlertsByEntity method are the SOA_ROLE_ALERTS_BY_ENTITY_REQUEST input document and the SOA_ROLE_ALERTS_BY_ENTITY_RESPONSE output document.

Parameters

entityIdentifier: Type: long integer (64-bit); Nullable: No; This parameter identifies the entity (directly or indirectly) for which the alerts are being requested. It can be either an EntityID object with value long representing entityID, or an ExternalID object with two string values representing the externalID and dataSourceCode.
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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services/">
	<soapenv:Header/>
	<soapenv:Body>
		<ser:getRoleAlertsByEntity>
			<entityIdentifier>
				<entityID>1</entityID>
			</entityIdentifier>
			<depth/>
			<!--Optional:-->
			<additionalInfo/>
		</ser:getRoleAlertsByEntity>
	</soapenv:Body>
</soapenv:Envelope>

Example Response

<soapenv:Envelope xmlns:errdetail="http://rr.eas.ibm.com/EntityResolver/ErrorDetail" 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>
		<getRoleAlertsByEntityResponse xmlns="http://services/">
			<alerts xmlns="">
				<entityID>1</entityID>
				<alerts xsi:type="ns1:RoleAlertDetail" xmlns:ns1="http://alerting/">
					<alertID>
						<alertType>ROLE_ALERT</alertType>
						<alertID>1</alertID>
					</alertID>
					<timestamp>2016-11-16T11:40:25</timestamp>
					<alertAnalysis>
						<dispositionID>10000</dispositionID>
						<timestamp>2016-11-18T13:22:39</timestamp>
						<createdBy>user</createdBy>
					</alertAnalysis>
					<alertAnalysis>
						<dispositionID>10001</dispositionID>
						<timestamp>2016-11-18T13:25:33</timestamp>
						<createdBy>user</createdBy>
					</alertAnalysis>
					<dispositionID>3</dispositionID>
					<roleAlertRuleID>1</roleAlertRuleID>
					<entities>
						<entityID>1</entityID>
						<roleIDs>1</roleIDs>
						<largeEntity>false</largeEntity>
						<entityType>PERSON</entityType>
						<bestName>
							<identityHandle>
								<internalID>1</internalID>
								<externalID>190-010025</externalID>
								<dataSourceCode>100</dataSourceCode>
								<externalReference>190-010025</externalReference>
							</identityHandle>
							<timestamp>2016-11-16T11:40:25</timestamp>
							<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
							<nameID>1</nameID>
							<nameTypeCode>M</nameTypeCode>
							<givenName>BOB</givenName>
							<surname>ASHLY</surname>
							<generation>JR</generation>
							<culture>EUROPEAN</culture>
						</bestName>
						<bestAddress>
							<identityHandle>
								<internalID>1</internalID>
								<externalID>190-010025</externalID>
								<dataSourceCode>100</dataSourceCode>
								<externalReference>190-010025</externalReference>
							</identityHandle>
							<timestamp>2016-11-16T11:40:25</timestamp>
							<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
							<addressID>1</addressID>
							<addressTypeCode>H</addressTypeCode>
							<street1>5861 MESCAL</street1>
							<city>LAS VEGAS</city>
							<state>NV</state>
							<country>USA</country>
							<postalCode>89110</postalCode>
						</bestAddress>
						<identities>
							<identityHandle>
								<internalID>1</internalID>
								<externalID>190-010025</externalID>
								<dataSourceCode>100</dataSourceCode>
								<externalReference>190-010025</externalReference>
							</identityHandle>
							<timestamp>2016-11-16T11:40:24</timestamp>
							<roleIDs>1</roleIDs>
							<attributes xsi:type="ns2:NameDetail" xmlns:ns2="http://entity/results/">
								<identityHandle>
									<internalID>1</internalID>
									<externalID>190-010025</externalID>
									<dataSourceCode>100</dataSourceCode>
									<externalReference>190-010025</externalReference>
								</identityHandle>
								<timestamp>2016-11-16T11:40:25</timestamp>
								<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
								<nameID>1</nameID>
								<nameTypeCode>M</nameTypeCode>
								<givenName>BOB</givenName>
								<surname>ASHLY</surname>
								<generation>JR</generation>
								<culture>EUROPEAN</culture>
							</attributes>
							<attributes xsi:type="ns2:AddressDetail" xmlns:ns2="http://entity/results/">
								<identityHandle>
									<internalID>1</internalID>
									<externalID>190-010025</externalID>
									<dataSourceCode>100</dataSourceCode>
									<externalReference>190-010025</externalReference>
								</identityHandle>
								<timestamp>2016-11-16T11:40:25</timestamp>
								<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
								<addressID>1</addressID>
								<addressTypeCode>H</addressTypeCode>
								<street1>5861 MESCAL</street1>
								<city>LAS VEGAS</city>
								<state>NV</state>
								<country>USA</country>
								<postalCode>89110</postalCode>
							</attributes>
							<attributes xsi:type="ns2:CharacteristicDetail" xmlns:ns2="http://entity/results/">
								<identityHandle>
									<internalID>1</internalID>
									<externalID>190-010025</externalID>
									<dataSourceCode>100</dataSourceCode>
									<externalReference>190-010025</externalReference>
								</identityHandle>
								<timestamp>2016-11-16T11:40:25</timestamp>
								<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
								<characteristicID>1</characteristicID>
								<characteristicValue>M</characteristicValue>
								<characteristicTypeID>2</characteristicTypeID>
							</attributes>
						</identities>
					</entities>
					...
					<relationshipPath>
						<fromEntityID>1</fromEntityID>
						<toEntityID>2</toEntityID>
						<pathStrength>100.00</pathStrength>
						<degreesOfSeparation>1</degreesOfSeparation>
						<relationships>
							<fromEntityID>1</fromEntityID>
							<toEntityID>2</toEntityID>
							<resolutionDetail>
								<relationshipConfidence>100</relationshipConfidence>
								<likenessConfidence>95</likenessConfidence>
								<resolutionID>2</resolutionID>
								<resolutionRuleID>3</resolutionRuleID>
								<resolutionRuleDescription>Name &amp; Address with No Denials</resolutionRuleDescription>
								<contributors xsi:type="ns1:ResolvedName" xmlns:ns1="http://resolution/results/">
									<givenNameScore xsi:type="xsd:double">0.940</givenNameScore>
									<surnameScore xsi:type="xsd:double">0.769</surnameScore>
									<fullNameScore xsi:type="xsd:double">0.845</fullNameScore>
									<nameAlgorithm>GNR</nameAlgorithm>
									<inboundName>
										<timestamp>2016-11-16T11:40:25</timestamp>
										<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
										<nameID>2</nameID>
										<nameTypeCode>M</nameTypeCode>
										<givenName>ROBERT I</givenName>
										<surname>ASHLEY</surname>
										<generation>SR</generation>
										<culture>ANGLO</culture>
									</inboundName>
									<existingName>
										<timestamp>2016-11-16T11:40:25</timestamp>
										<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
										<nameID>1</nameID>
										<nameTypeCode>M</nameTypeCode>
										<givenName>BOB</givenName>
										<surname>ASHLY</surname>
										<generation>JR</generation>
										<culture>EUROPEAN</culture>
									</existingName>
								</contributors>
								<contributors xsi:type="ns1:ResolvedName" xmlns:ns1="http://resolution/results/">
									<givenNameScore xsi:type="xsd:double">79.000</givenNameScore>
									<surnameScore xsi:type="xsd:double">97.000</surnameScore>
									<fullNameScore xsi:type="xsd:double">81.000</fullNameScore>
									<nameAlgorithm>NAME_COMPARATOR_2</nameAlgorithm>
									<inboundName>
										<timestamp>2016-11-16T11:40:25</timestamp>
										<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
										<nameID>2</nameID>
										<nameTypeCode>M</nameTypeCode>
										<givenName>ROBERT I</givenName>
										<surname>ASHLEY</surname>
										<generation>SR</generation>
										<culture>ANGLO</culture>
									</inboundName>
									<existingName>
										<timestamp>2016-11-16T11:40:25</timestamp>
										<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
										<nameID>1</nameID>
										<nameTypeCode>M</nameTypeCode>
										<givenName>BOB</givenName>
										<surname>ASHLY</surname>
										<generation>JR</generation>
										<culture>EUROPEAN</culture>
									</existingName>
								</contributors>
								<contributors xsi:type="ns1:ResolvedAddress" xmlns:ns1="http://resolution/results/">
									<matchType>FULL_ADDRESS</matchType>
									<score>8</score>
									<inboundAddress>
										<timestamp>2016-11-16T11:40:25</timestamp>
										<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
										<addressID>2</addressID>
										<addressTypeCode>H</addressTypeCode>
										<street1>5861 MESCAL</street1>
										<city>LAS VEGAS</city>
										<state>NV</state>
										<country>USA</country>
										<postalCode>89110</postalCode>
									</inboundAddress>
									<existingAddress>
										<timestamp>2016-11-16T11:40:25</timestamp>
										<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
										<addressID>1</addressID>
										<addressTypeCode>H</addressTypeCode>
										<street1>5861 MESCAL</street1>
										<city>LAS VEGAS</city>
										<state>NV</state>
										<country>USA</country>
										<postalCode>89110</postalCode>
									</existingAddress>
								</contributors>
								<contributors xsi:type="ns1:ResolvedCharacteristic" xmlns:ns1="http://resolution/results/">
									<scoreAdjustment>5</scoreAdjustment>
									<inboundCharacteristic xsi:type="ns1:CharacteristicDetail" xmlns:ns1="http://entity/results/">
										<timestamp>2016-11-16T11:40:25</timestamp>
										<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
										<characteristicID>2</characteristicID>
										<characteristicValue>M</characteristicValue>
										<characteristicTypeID>2</characteristicTypeID>
									</inboundCharacteristic>
									<existingCharacteristic xsi:type="ns1:CharacteristicDetail" xmlns:ns1="http://entity/results/">
										<timestamp>2016-11-16T11:40:25</timestamp>
										<lastModifiedTimestamp>2016-11-16T11:40:25</lastModifiedTimestamp>
										<characteristicID>1</characteristicID>
										<characteristicValue>M</characteristicValue>
										<characteristicTypeID>2</characteristicTypeID>
									</existingCharacteristic>
								</contributors>
							</resolutionDetail>
						</relationships>
					</relationshipPath>
					<adjustedPathStrength>100.00</adjustedPathStrength>
				</alerts>
				...
			</alerts>
		</getRoleAlertsByEntityResponse>
	</soapenv:Body>
</soapenv:Envelope>