GetFamilyTree

Get Family Tree

Overview

Returns ultimate parent of the given DUNS or Company ID and all of the children/descendants of that ultimate parent. Access to the GetFamilyTree service operation has been restricted. Please contact your sales representative for access.

Input Parameters

Field Name Value Notes
uniqueId Company ID -OR- DUNS Number
filters/includeIncompleteData If true, will return all the unmarketable company records, which have incomplete data.
filters/locationType Location Type Use multiple elements for multiple location type values.
filters/includeOutOfBusiness If true, will return all the unmarketable company records, which are out of business.
filters/includeUndeliverableAddress If true, will return all the unmarketable company records, which have undeliverable address.
filters/includeDoNotMarketTo If true, will return all the unmarketable company records, which have undeliverable address.
filters Optional element used to filter the family tree results.
filters/depthLimit The number of layers or levels of the family tree structure to return. An error will be returned if the value is less than 1.
filters/country Country Use multiple elements for multiple country values.
filters/state State Use multiple elements for multiple state values.
filters/city City Use multiple elements for multiple city values.

Output Parameters

Field Name Value Notes
\return\children\child\revenue Child Revenue in millions of USD
\return\parentDuns Parent Company DUNS Number
\return\city Company City
\return\duns DUNS Number
\return\revenue Revenue in millions
\return\children\child\number Hit Number of the specific child
\return\children\child\parentDuns Child Parent Company DUNS Number
\return\additionalData\doNotMarketTo Indicates true if the company is listed as do not market to.
\return\children\child\additionalData\incompleteData Indicates true, If the company has incomplete data
\return\companyId Company ID
\return\children\child\locationType Child Location Type Headquarters, Branch, etc.
\return\children\child\name Child Company Name
\return\additionalData\undeliverableAddress Indicates true if the company has an undeliverable address
\return\children\child\country Child Company Country
\return\children\child\additionalData\undeliverableAddress Indicates true, If the company has undeliverable address
\return\children\child\companyId Child Company ID
\return\children\child\duns Child DUNS Number
\return\children This company's children Previous version of API did not specify maxOccurs=unbounded, so generated client code was only able to get a single element. The API has changed to return an array or other collection.
\return\ultimateParentDuns Ultimate Parent Company DUNS Number
\return\children\child\additionalData\outOfBusiness Indicates true, If the company is out of business
\return\additionalData Additional data about the company
\return\locationType Location Type Headquarters, Branch, etc.
\return\additionalData\outOfBusiness Indicates true if the company is out of business
\return\additionalData\incompleteData Indicates true if the company has incomplete data
\return\children\child\additionalData AdditionalData about the company
\return\children\child\city Child Company City
\return\children\child\ultimateParentDuns Child Ultimate Parent Company DUNS Number
\return\currencyType CurrencyType of Revenue
\return\children\child\children This company's children Previous version of API did not specify maxOccurs=unbounded, so generated client code was only able to get a single element. The API has changed to return an array or other collection.
\return\children\child\additionalData\doNotMarketTo Indicates true, If the company is delisted as do not market to.
\return\country Country
\return\totalChildren Aggregate Total Number of Children for this unique ID
\return\name Company Name
\return\state Company State
\return\children\child\currencyType Currency type of Revenue
\return\children\child\state Child Company State

Input XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sch="http://applications.dnb.com/webservice/schema/">
   <soapenv:Header>
      <sch:API-KEY>YOUR-API-KEY-HERE</sch:API-KEY>
   </soapenv:Header>
   <soapenv:Body>
      <sch:GetFamilyTreeRequest>
         <sch:uniqueId>15751000000000</sch:uniqueId>
         <sch:filters>           
            <sch:includeUndeliverableAddress>false</sch:includeUndeliverableAddress>
            <sch:includeOutOfBusiness>false</sch:includeOutOfBusiness>
            <sch:includeIncompleteData>false</sch:includeIncompleteData>
            <sch:includeDoNotMarketTo>false</sch:includeDoNotMarketTo>
         </sch:filters>
      </sch:GetFamilyTreeRequest>
   </soapenv:Body>
</soapenv:Envelope>

Output XML

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <sch:GetFamilyTreeResponse xmlns:sch="http://applications.dnb.com/webservice/schema/">
         <sch:return>
            <sch:name>Craftmade International, Inc.</sch:name>
            <sch:companyId>15751000000000</sch:companyId>
            <sch:duns>007918592</sch:duns>
            <sch:parentDuns>007918592</sch:parentDuns>
            <sch:ultimateParentDuns>007918592</sch:ultimateParentDuns>
            <sch:revenue>153.92</sch:revenue>
            <sch:currencyType>USD</sch:currencyType>
            <sch:locationType>HEADQUARTERS</sch:locationType>
            <sch:city>Coppell</sch:city>
            <sch:state>TX</sch:state>
            <sch:country>United States</sch:country>
            <sch:additionalData>
               <sch:undeliverableAddress>false</sch:undeliverableAddress>
               <sch:outOfBusiness>false</sch:outOfBusiness>
               <sch:incompleteData>false</sch:incompleteData>
               <sch:doNotMarketTo>false</sch:doNotMarketTo>
            </sch:additionalData>
            <sch:totalChildren>7</sch:totalChildren>
            <sch:children>
               <sch:child>
                  <sch:number>1</sch:number>
                  <sch:name>Woodard, LLC</sch:name>
                  <sch:companyId>1955020</sch:companyId>
                  <sch:duns>001955020</sch:duns>
                  <sch:parentDuns>007918592</sch:parentDuns>
                  <sch:ultimateParentDuns>007918592</sch:ultimateParentDuns>
                  <sch:revenue xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <sch:currencyType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <sch:locationType>HEADQUARTERS</sch:locationType>
                  <sch:city>Coppell</sch:city>
                  <sch:state>TX</sch:state>
                  <sch:country>United States</sch:country>
                  <sch:additionalData>
                     <sch:undeliverableAddress>false</sch:undeliverableAddress>
                     <sch:outOfBusiness>false</sch:outOfBusiness>
                     <sch:incompleteData>false</sch:incompleteData>
                     <sch:doNotMarketTo>false</sch:doNotMarketTo>
                  </sch:additionalData>
                  <sch:children>
                     <sch:child>
                        <sch:number>2</sch:number>
                        <sch:name>Woodard--Cm, LLC</sch:name>
                        <sch:companyId>5801631</sch:companyId>
                        <sch:duns>005801631</sch:duns>
                        <sch:parentDuns>001955020</sch:parentDuns>
                        <sch:ultimateParentDuns>007918592</sch:ultimateParentDuns>
                        <sch:revenue xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <sch:currencyType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <sch:locationType>BRANCH</sch:locationType>
                        <sch:city>Owosso</sch:city>
                        <sch:state>MI</sch:state>
                        <sch:country>United States</sch:country>
                        <sch:additionalData>
                           <sch:undeliverableAddress>false</sch:undeliverableAddress>
                           <sch:outOfBusiness>false</sch:outOfBusiness>
                           <sch:incompleteData>false</sch:incompleteData>
                           <sch:doNotMarketTo>false</sch:doNotMarketTo>
                        </sch:additionalData>
                     </sch:child>
                  </sch:children>
               </sch:child>
               <sch:child>
                  <sch:number>3</sch:number>
                  <sch:name>Durocraft International, Inc.</sch:name>
                  <sch:companyId>787443753</sch:companyId>
                  <sch:duns>787443753</sch:duns>
                  <sch:parentDuns>007918592</sch:parentDuns>
                  <sch:ultimateParentDuns>007918592</sch:ultimateParentDuns>
                  <sch:revenue xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <sch:currencyType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                  <sch:locationType>SINGLE_LOCATION</sch:locationType>
                  <sch:city>Coppell</sch:city>
                  <sch:state>TX</sch:state>
                  <sch:country>United States</sch:country>
                  <sch:additionalData>
                     <sch:undeliverableAddress>false</sch:undeliverableAddress>
                     <sch:outOfBusiness>false</sch:outOfBusiness>
                     <sch:incompleteData>false</sch:incompleteData>
                     <sch:doNotMarketTo>false</sch:doNotMarketTo>
                  </sch:additionalData>
               </sch:child>
               <sch:child>
                  <sch:number>4</sch:number>
                  <sch:name>Trade Source International, Inc</sch:name>
                  <sch:companyId>119083640</sch:companyId>
                  <sch:duns>119083640</sch:duns>
                  <sch:parentDuns>007918592</sch:parentDuns>
                  <sch:ultimateParentDuns>007918592</sch:ultimateParentDuns>
                  <sch:revenue>13.60</sch:revenue>
                  <sch:currencyType>USD</sch:currencyType>
                  <sch:locationType>HEADQUARTERS</sch:locationType>
                  <sch:city>Coppell</sch:city>
                  <sch:state>TX</sch:state>
                  <sch:country>United States</sch:country>
                  <sch:additionalData>
                     <sch:undeliverableAddress>false</sch:undeliverableAddress>
                     <sch:outOfBusiness>false</sch:outOfBusiness>
                     <sch:incompleteData>false</sch:incompleteData>
                     <sch:doNotMarketTo>false</sch:doNotMarketTo>
                  </sch:additionalData>
                  <sch:children>
                     <sch:child>
                        <sch:number>5</sch:number>
                        <sch:name>Prime Home Impressions LLC</sch:name>
                        <sch:companyId>119719842</sch:companyId>
                        <sch:duns>119719842</sch:duns>
                        <sch:parentDuns>119083640</sch:parentDuns>
                        <sch:ultimateParentDuns>007918592</sch:ultimateParentDuns>
                        <sch:revenue xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <sch:currencyType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <sch:locationType>SINGLE_LOCATION</sch:locationType>
                        <sch:city>Coppell</sch:city>
                        <sch:state>TX</sch:state>
                        <sch:country>United States</sch:country>
                        <sch:additionalData>
                           <sch:undeliverableAddress>false</sch:undeliverableAddress>
                           <sch:outOfBusiness>false</sch:outOfBusiness>
                           <sch:incompleteData>false</sch:incompleteData>
                           <sch:doNotMarketTo>false</sch:doNotMarketTo>
                        </sch:additionalData>
                     </sch:child>
                     <sch:child>
                        <sch:number>6</sch:number>
                        <sch:name>TRADE SOURCE INTERNATIONAL, INC</sch:name>
                        <sch:companyId>609366109</sch:companyId>
                        <sch:duns>609366109</sch:duns>
                        <sch:parentDuns>119083640</sch:parentDuns>
                        <sch:ultimateParentDuns>007918592</sch:ultimateParentDuns>
                        <sch:revenue xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <sch:currencyType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <sch:locationType>BRANCH</sch:locationType>
                        <sch:city>Dedham</sch:city>
                        <sch:state>MA</sch:state>
                        <sch:country>United States</sch:country>
                        <sch:additionalData>
                           <sch:undeliverableAddress>false</sch:undeliverableAddress>
                           <sch:outOfBusiness>false</sch:outOfBusiness>
                           <sch:incompleteData>false</sch:incompleteData>
                           <sch:doNotMarketTo>false</sch:doNotMarketTo>
                        </sch:additionalData>
                     </sch:child>
                     <sch:child>
                        <sch:number>7</sch:number>
                        <sch:name>Trade Source International, Inc</sch:name>
                        <sch:companyId>175929822</sch:companyId>
                        <sch:duns>175929822</sch:duns>
                        <sch:parentDuns>119083640</sch:parentDuns>
                        <sch:ultimateParentDuns>007918592</sch:ultimateParentDuns>
                        <sch:revenue xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <sch:currencyType xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
                        <sch:locationType>BRANCH</sch:locationType>
                        <sch:city>Prairie Grove</sch:city>
                        <sch:state>AR</sch:state>
                        <sch:country>United States</sch:country>
                        <sch:additionalData>
                           <sch:undeliverableAddress>false</sch:undeliverableAddress>
                           <sch:outOfBusiness>false</sch:outOfBusiness>
                           <sch:incompleteData>false</sch:incompleteData>
                           <sch:doNotMarketTo>false</sch:doNotMarketTo>
                        </sch:additionalData>
                     </sch:child>
                  </sch:children>
               </sch:child>
            </sch:children>
         </sch:return>
      </sch:GetFamilyTreeResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>