IM Relationship Resolution Information Center, Version 4.2

getIdentitiesForEntity() SOAP API method

Requests and obtains the details of all identities that comprise a specific entity that is identified by an entity ID or by the external ID and data source code of one of its composite identities. The UMF API equivalent of the getIdentitiesForEntity method are the SOA_IDENTITIES_FOR_ENTITY_REQUEST input document and the SOA_IDENTITIES_FOR_ENTITY_RESPONSE output document.

Syntax

getIdentitiesForEntity
(  
   entityIdentifier,
   depth
   additionalInfo
);

Description

Parameters
entityIdentifier
Type: long integer (64-bit)
Nullable: No
This parameter identifies the entity (directly or indirectly) for which the details 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
<?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>
  <getIdentitiesForEntity xmlns="http://services/">
   <entityIdentifier xsi:type="ns1:EntityID" xmlns:ns1="http://common/" xmlns="">
    <entityID>41</entityID>
   </entityIdentifier>
   <depth xsi:type="ns2:DepthSetting" xmlns:ns2="http://common/" xmlns="">
    <value>FULL</value>
   </depth>
   <additionalInfo xsi:nil="true" xmlns=""/>
  </getIdentitiesForEntity>
 </soapenv:Body>
</soapenv:Envelope>
<?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>
  <getIdentitiesForEntity xmlns="http://services/">
   <entityIdentifier xsi:type="ns1:ExternalID" xmlns:ns1="http://common/" xmlns="">
    <externalID>190-160025</externalID>
    <dataSourceCode>100</dataSourceCode>
   </entityIdentifier>
   <depth xsi:type="ns2:DepthSetting" xmlns:ns2="http://common/" xmlns="">
    <value>FULL</value>
   </depth>
   <additionalInfo xsi:nil="true" xmlns=""/>
  </getIdentitiesForEntity>
 </soapenv:Body>
</soapenv:Envelope>

Description

Returns
getIdentitiesForEntityResponse
Value:
identities
Type: xsd_3:IdentityDetail
Value:
IdentityDetail
Value:
identityHandle
Type: xsd_1:IdentityHandle
Value:
IdentityHandle
Value:
internalID
Type: xsd:long
externalID
Type: xsd:string
dataSourceCode
Type: xsd:string
externalReference
Type: xsd:string
roleIDs
maxOccurs="unbounded"
minOccurs="0"
Type: xsd:long
attributes
maxOccurs="unbounded"
minOccurs="0"
Type: xsd_1:AttributeDetail
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
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>
  <getIdentityDetailResponse xmlns="http://services/">
   <identity xmlns="">
    <identityHandle>
     <internalID>12</internalID>
     <externalID>190-070025</externalID>
     <dataSourceCode>100</dataSourceCode>
     <externalReference>190-070025</externalReference>
    </identityHandle>
    <roleIDs>1</roleIDs>
    <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:NameDetail">
     <identityHandle>
      <internalID>12</internalID>
      <externalID>190-070025</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>190-070025</externalReference>
     </identityHandle>
     <lastModifiedTimestamp>2008-07-28T15:11:52</lastModifiedTimestamp>
     <nameID>12</nameID>
     <nameTypeCode>M</nameTypeCode>
     <givenName>ROBERT EVAN</givenName>
     <surname>GOMEZ</surname>
     <generation>JR</generation>
    </attributes>
    <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:AddressDetail">
     <identityHandle>
      <internalID>12</internalID>
      <externalID>190-070025</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>190-070025</externalReference>
     </identityHandle>
     <lastModifiedTimestamp>2008-07-28T15:11:52</lastModifiedTimestamp>
     <addressID>13</addressID>
     <addressTypeCode>H</addressTypeCode>
     <street1>5861 Mescal Way</street1>
     <city>Las Vegas</city>
     <state>NV</state>
     <country>USA</country>
     <postalCode>89110</postalCode>
    </attributes>
    <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:NumberDetail">
     <identityHandle>
      <internalID>12</internalID>
      <externalID>190-070025</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>190-070025</externalReference>
     </identityHandle>
     <lastModifiedTimestamp>2008-07-28T15:11:52</lastModifiedTimestamp>
     <numberID>12</numberID>
     <numberTypeID>2</numberTypeID>
     <numberValue>191-54-2667</numberValue>
    </attributes>
    <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:CharacteristicDetail">
     <identityHandle>
      <internalID>12</internalID>
      <externalID>190-070025</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>190-070025</externalReference>
     </identityHandle>
     <lastModifiedTimestamp>2008-07-28T15:11:52</lastModifiedTimestamp>
     <characteristicID>10</characteristicID>
     <characteristicValue>M</characteristicValue>
     <characteristicTypeID>2</characteristicTypeID>
    </attributes>
   </identity>
  </getIdentityDetailResponse>
 </soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009