IM Relationship Resolution Information Center, Version 4.2

getEntityDetail() SOAP API method

Requests and obtains the details of particular entity that is identified by the entity ID or by the external ID of one of its composite identity records. The UMF API equivalent of the getEntityDetail method are the SOA_ENTITY_DETAIL_REQUEST input document and the SOA_ENTITY_DETAIL_RESPONSE output document.

Syntax

getEntityDetail
(
 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>
  <getEntityDetail xmlns="http://services/">
   <entityIdentifier xsi:type="ns1:EntityID" xmlns:ns1="http://common/" xmlns="">
    <entityID>60</entityID>
   </entityIdentifier>
   <depth xsi:type="ns2:DepthSetting" xmlns:ns2="http://common/" xmlns="">
    <value>FULL</value>
   </depth>
   <additionalInfo xsi:nil="true" xmlns=""/>
  </getEntityDetail>
 </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>
  <getEntityDetail xmlns="http://services/">
   <entityIdentifier xsi:type="ns1:ExternalID" xmlns:ns1="http://common/" xmlns="">
    <externalID>190-040028</externalID>
    <dataSourceCode>100</dataSourceCode>
   </entityIdentifier>
   <depth xsi:type="ns2:DepthSetting" xmlns:ns2="http://common/" xmlns="">
    <value>FULL</value>
   </depth>
   <additionalInfo xsi:nil="true" xmlns=""/>
  </getEntityDetail>
 </soapenv:Body>
</soapenv:Envelope>

Description

Returns
getEntityDetailResponse
Value:
entity
Type: xsd_3: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
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>
  <getEntityDetailResponse xmlns="http://services/">
   <entities xmlns="">
    <entityID>60</entityID>
    <roleIDs>1</roleIDs>
    <largeEntity>FALSE</largeEntity>
    <entityType>PERSON</entityType>
    <bestName>
     <identityHandle>
      <internalID>71</internalID>
      <externalID>PNR602-10QR</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>PNR602-10QR</externalReference>
     </identityHandle>
     <lastModifiedTimestamp>2008-07-28T15:11:55</lastModifiedTimestamp>
     <nameID>76</nameID>
     <nameTypeCode>M</nameTypeCode>
     <givenName>David</givenName>
     <surname>Henderson</surname>
    </bestName>
    <bestAddress>
     <identityHandle>
      <internalID>71</internalID>
      <externalID>PNR602-10QR</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>PNR602-10QR</externalReference>
     </identityHandle>
     <lastModifiedTimestamp>2008-07-28T15:11:55</lastModifiedTimestamp>
     <addressID>72</addressID>
     <addressTypeCode>H</addressTypeCode>
     <street1>3665 Walnut Street</street1>
     <city>San Francisco</city>
     <state>CA</state>
     <country>USA</country>
     <postalCode>94014</postalCode>
    </bestAddress>
    <bestEmail>
     <lastModifiedTimestamp>2008-07-28T15:11:55</lastModifiedTimestamp>
     <emailID>22</emailID>
     <emailAddress>DAVID1@AOL.COM</emailAddress>
     <userEmailType>H</userEmailType>
     <userDefinedStatus>0</userDefinedStatus>
    </bestEmail>
    <identities>
     <identityHandle>
      <internalID>71</internalID>
      <externalID>PNR602-10QR</externalID>
      <dataSourceCode>100</dataSourceCode>
      <externalReference>PNR602-10QR</externalReference>
     </identityHandle>
     <roleIDs>1</roleIDs>
     <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:NameDetail">
      <identityHandle>
       <internalID>71</internalID>
       <externalID>PNR602-10QR</externalID>
       <dataSourceCode>100</dataSourceCode>
       <externalReference>PNR602-10QR</externalReference>
      </identityHandle>
      <lastModifiedTimestamp>2008-07-28T15:11:55</lastModifiedTimestamp>
      <nameID>76</nameID>
      <nameTypeCode>M</nameTypeCode>
      <givenName>David</givenName>
      <surname>Henderson</surname>
     </attributes>
     <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:AddressDetail">
      <identityHandle>
       <internalID>71</internalID>
       <externalID>PNR602-10QR</externalID>
       <dataSourceCode>100</dataSourceCode>
       <externalReference>PNR602-10QR</externalReference>
      </identityHandle>
      <lastModifiedTimestamp>2008-07-28T15:11:55</lastModifiedTimestamp>
      <addressID>72</addressID>
      <addressTypeCode>H</addressTypeCode>
      <street1>3665 Walnut Street</street1>
      <city>San Francisco</city>
      <state>CA</state>
      <country>USA</country>
      <postalCode>94014</postalCode>
     </attributes>
     <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:CharacteristicDetail">
      <identityHandle>
       <internalID>71</internalID>
       <externalID>PNR602-10QR</externalID>
       <dataSourceCode>100</dataSourceCode>
       <externalReference>PNR602-10QR</externalReference>
      </identityHandle>
      <lastModifiedTimestamp>2008-07-28T15:11:55</lastModifiedTimestamp>
      <characteristicID>60</characteristicID>
      <characteristicValue>M</characteristicValue>
      <characteristicTypeID>2</characteristicTypeID>
     </attributes>
     <attributes xmlns:ns2="http://entity/results/" xsi:type="ns2:EmailDetail">
      <identityHandle>
       <internalID>71</internalID>
       <externalID>PNR602-10QR</externalID>
       <dataSourceCode>100</dataSourceCode>
       <externalReference>PNR602-10QR</externalReference>
      </identityHandle>
      <lastModifiedTimestamp>2008-07-28T15:11:55</lastModifiedTimestamp>
      <emailID>22</emailID>
      <emailAddress>DAVID1@AOL.COM</emailAddress>
      <userEmailType>H</userEmailType>
      <userDefinedStatus>0</userDefinedStatus>
     </attributes>
    </identities>
   </entities>
  </getEntityDetailResponse>
 </soapenv:Body>
</soapenv:Envelope>



Feedback

Last updated: 2009