API Methods
The Dun and Bradstreet Connector uses API methods to retrieve company data. The methods are detailed below.
DUNS LookupThis method returns general information about companies registered in the Dun and Bradstreet Data Cloud. The call is made using FTOS_EXTD_DUNS_LOOKUP_Endpoint.
Call Example
Request:
Copy
{
"ApiInfo": {
"Token": "{{access_token}}"
},
"Request": {
"ActionName": "FTOS_EXTD_DUNS_LOOKUP_Endpoint",
"Data": "{ match: \"true\", countryISOAlpha2Code: \"US\" }"
}
}Response:
Copy
{
"UIResult": {
"NavigateToEntityPage": false,
"NavigateToEntityPageOnEdit": false,
"NavigateToEntityFormName": null,
"NavigateToEntityName": null,
"NavigateToEntityId": null,
"NavigateToEntityInsertDefaults": null,
"NavigateToUrl": null,
"DownloadFile": null,
"ReloadPage": false,
"Message": null,
"IsSuccess": false,
"Data": "{\"BusinessSearch\":{\"serviceTransactionID\":\"Id-912b8f5c6f8a7138d58a2a20-1\",\"transactionTimestamp\":\"2019-03-18T05:24:33.53\",\"applicationTransactionID\":\"MatchRequest\",\"resultDescription\":null,\"matchDataCriteriaText\":\"Name and Address Lookup\",\"candidateMatchedQuantity\":1.0},\"MatchCandidate\":[{\"fullName\":null,\"primaryAddressUndeliverableIndicator\":false,\"telecommunicationNumber\":\"6505550000\",\"primaryTownName\":\"SAN FRANCISCO\",\"unreachableIndicator\":false,\"dunsNumber\":\"804735132\",\"primaryAddressPostalCodeExtensionCode\":null,\"organizationName\":\"GORMAN MANUFACTURING COMPANY, INC.\",\"undeliverableIndicator\":false,\"territoryAbbreviatedName\":null,\"postalCodeExtensionCode\":null,\"primaryAddressTerritoryAbbrevName\":\"CA\",\"countryISOAlpha2Code\":\"US\",\"lineText\":\"492 KOLLER ST\",\"postalCode\":null,\"primaryAddressPostalCode\":\"94110\",\"operatingStatusText\":\"Active\"}]}",
"NavigateToPageNo": null
},
"Message": null,
"IsSuccess": true,
"ClientScript": null,
"Serialized": null,
"ErrorCode": 0
}This method returns the company's profile and it includes business intelligence such as executive names and titles, financial situations, number of employees, import or export code, branch indicator, and so on.
The call is made using FTOS_EXTD_DUNS_CorpLinkage_Endpoint.
Call Example
Request:
Copy
{
"ApiInfo": {
"Token": "{{access_token}}"
},
"Request": {
"ActionName": "FTOS_EXTD_DUNS_CompProfile_Endpoint",
"Data": "{ dunsNumber: \"804735132\"}"
}
}Respose:
Copy
{
"UIResult": {
"NavigateToEntityPage": false,
"NavigateToEntityPageOnEdit": false,
"NavigateToEntityFormName": null,
"NavigateToEntityName": null,
"NavigateToEntityId": null,
"NavigateToEntityInsertDefaults": null,
"NavigateToUrl": null,
"DownloadFile": null,
"ReloadPage": false,
"Message": null,
"IsSuccess": false,
"Data": "{\"EmployeeFigure\":{\"reliability\":9092.0,\"totalEmployeeQuantity\":110.0,\"employeeFiguresDate\":null},\"FinancialRatios\":{\"itemRatio\":null,\"itemDescription\":null},\"IndustryCodes\":[{\"indCodeDescLangCode\":\"Commercial Printing\",\"dnbCodeValue\":25838.0,\"industryCode\":\"1068\",\"DisplaySequence\":1.0,\"typeText\":\"D&B Hoovers Industry Code\",\"indCodeDesc\":\"Commercial Printing\",\"indCodeDescLengthCode\":\"Commercial Printing\"},{\"indCodeDescLangCode\":\"Commercial Gravure Printing\",\"dnbCodeValue\":700.0,\"industryCode\":\"323111\",\"DisplaySequence\":1.0,\"typeText\":\"NAICS\",\"indCodeDesc\":\"Commercial Gravure Printing\",\"indCodeDescLengthCode\":\"Commercial Gravure Printing\"},{\"indCodeDescLangCode\":\"Commercial Printing (except Screen and Books)\",\"dnbCodeValue\":24664.0,\"industryCode\":\"323111\",\"DisplaySequence\":1.0,\"typeText\":\"North American Industry Classification System 2012\",\"indCodeDesc\":\"Commercial Printing (except Screen and Books)\",\"indCodeDescLengthCode\":\"Commercial Printing (except Screen and Books)\"},{\"indCodeDescLangCode\":\"Other printing\",\"dnbCodeValue\":21182.0,\"industryCode\":\"22.220\",\"DisplaySequence\":1.0,\"typeText\":\"UK SIC 2003\",\"indCodeDesc\":\"Other printing\",\"indCodeDescLengthCode\":\"Other printing\"},{\"indCodeDescLangCode\":\"COMM PRTG LITHO\",\"dnbCodeValue\":3599.0,\"industryCode\":\"27520000\",\"DisplaySequence\":1.0,\"typeText\":\"D&B Standard Industry Code\",\"indCodeDesc\":\"COMM PRTG LITHO\",\"indCodeDescLengthCode\":\"COMM PRTG LITHO\"},{\"indCodeDescLangCode\":\"Lithographic commercial printing\",\"dnbCodeValue\":399.0,\"industryCode\":\"2752\",\"DisplaySequence\":1.0,\"typeText\":\"US SIC (1987)\",\"indCodeDesc\":\"Lithographic commercial printing\",\"indCodeDescLengthCode\":\"Lithographic commercial printing\"}],\"FinancialFigures\":[{\"salesTurnoverGrowthRate\":null,\"salesRevenueAmount\":\"19945238\",\"profitOrLossAmount\":null,\"financialStatementToDate\":\"2015-12-31\",\"financialPeriodDuration\":\"P1Y\"}],\"CurrentPrincipal\":[{\"managementResponsibility\":null,\"jobTitle\":\"Sec-treas\",\"middleName\":\"J\",\"lastName\":\"Hunt\",\"principalAge\":null,\"namePrefix\":\"Mr\",\"firstName\":\"Kevin\",\"nameSuffix\":null}],\"CompProfiles\":{\"nonMarketableReason\":\"De-listed, Insufficient Data\",\"laborSurplusAreaIndicator\":false,\"legalForm\":451.0,\"lastUpdateDate\":\"2016-4-1\",\"dunsNumber\":\"804735132\",\"femaleOwnedIndicator\":false,\"organizationSummary\":\"Commercial printing, lithographic\",\"issuedShareCapitalAmount\":null,\"marketabilityIndicator\":false,\"ethnicityType\":\"Unknown\",\"minorityOwnedIndicator\":false,\"smallBusinessIndicator\":true,\"marketingRiskClass\":\"Low\",\"accountantName\":null,\"operations\":null,\"lineOfBusinessDescription\":\"Commercial printing, lithographic\"}}",
"NavigateToPageNo": null
},
"Message": null,
"IsSuccess": true,
"ClientScript": null,
"Serialized": null,
"ErrorCode": 0
}This method returns only the direct line entities between the requested company and the global ultimate, for example the upward family tree.
The call is made using FTOS_EXTD_DUNS_CompProfile_Endpoint.
Call Example
Request:
Copy
{
"ApiInfo": {
"Token": "{{access_token}}"
},
"Request": {
"ActionName": "FTOS_EXTD_DUNS_CorpLinkage_Endpoint",
"Data": "{ dunsNumber: \"804735132\", attachCompressedProductIndicator: \"true\" }"
}
}Respose:
Copy
{
"UIResult": {
"NavigateToEntityPage": false,
"NavigateToEntityPageOnEdit": false,
"NavigateToEntityFormName": null,
"NavigateToEntityName": null,
"NavigateToEntityId": null,
"NavigateToEntityInsertDefaults": null,
"NavigateToUrl": null,
"DownloadFile": null,
"ReloadPage": false,
"Message": null,
"IsSuccess": false,
"Data": "{\"BusinessSearchCorpLinkage\":{\"transactionTimestamp\":\"2017-01-19T12:13:34.964+00:00\",\"applicationTransactionID\":\"ServiceGovernanceSample\",\"serviceTransactionID\":\"ServiceGovernanceSample\"},\"CorpLinkage\":{\"familyTreeMemberRole\":\"Headquarters, Parent\",\"linkageRoleText\":null,\"siblingCount\":null,\"lineText\":\"NEW RD\",\"linkageOrgPrimaryName\":\"ISC TRADE CORPORATION.\",\"territoryAbbreviatedName\":null,\"postalCode\":\"10001-1700\",\"dunsNumber\":\"000001111\",\"linkageCountry\":\"NL\",\"linkageOrgCount\":6.0,\"directChildrenIndicator\":\"false, true, true, true\",\"linkageUndeliverable\":null,\"linkageStandaloneOrgIndicator\":\"false\",\"parentDUNSNumber\":null,\"linkageTerritoryAbbreviated\":null,\"county\":\"TARNOBRZEG\",\"domesticUltimateDUNSNumber\":\"000001111\",\"standaloneIndicator\":false,\"linkageTerritory\":\"\",\"childrenType\":\"Subsidiary, Branch, Division\",\"globalUltimateDUNSNumber\":\"000001111\",\"linkageMemberAssocType\":\"ParentSubsidiary\",\"territory\":\"New York\",\"headquartersDUNSNumber\":null,\"townName\":\"ANNOPOL\",\"primaryName\":\"INTERNATIONAL SYSTEM CORPORATION\",\"childrenQuantity\":\"2441, 8, 62, 10\",\"familyTreeHierarchyLevel\":1.0,\"isUndeliverable\":null,\"linkageAddressLineText\":\"Robert Johan\",\"linkagePrimaryTownName\":\"Amsterdam\",\"subjectHeaderDUNSNumber\":\"000007777, 000007777\",\"country\":\"US\"}}",
"NavigateToPageNo": null
},
"Message": null,
"IsSuccess": true,
"ClientScript": null,
"Serialized": null,
"ErrorCode": 0
}