Loading

Direct 2.0
Collapse

Get Monitoring Product

ProductD&B Direct 2.0, D&B Direct Onboard
Product Code(s)Not Applicable
Options(s)None
Monitoring AvailableNo
InterfaceREST
MethodGET
Format(s)JSON
ServiceMonitoring
{version}8.0
8.0 Released onFebruary 15, 2019

This function allows a customer to retrieve (i.e., PULL) the latest copy of a data layer registered for level two monitoring -- not the data available at the date/time the Change Notice was triggered.

Update History

  • January 29, 2016 (v5.0 SOAP & REST): PUSH notifications now include CustomerReferenceText for List Change Notice.
  • January 8, 2016 (v5.0 SOAP & REST): The input parameter CompressedProductIndicator is added to CreateNotificationProfileRequest and UpdateNotificationProfileRequest. AttachCompressedProductIndicator is added to GetMonitoringProduct Request.

What to do First

Feature Request

IMPORTANT: Please see the new Online Services Security Enhancement Release, effective December 14, 2018.

Data Layer Entitlement

For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.

  • This function does not require entitlement for production and trial usage. Entitlement for monitoring is only required for the Add Monitoring Registration function, and for the data layers that will monitored.

Specification

This function will only deliver products for level 2 Monitoring Registrations.

Sample Request (Get Product)
GET https://direct.dnb.com/V8.0/monitoring/organizations/804735132/products/DCP_STD?ServiceVersionNumber=5.1&TransactionTimestamp=2017-12-14T12%3A11%3A58.784-04%3A00&ApplicationTransactionID=STG_GetMonitoringProduct
Authorization: <MyToken>
Name Characteristics
{version} Element
ApplicationTransactionID string up to 64 chars., Optional

A number assigned by the calling application to uniquely identify this request.

TransactionTimestamp DateTimestamp, Optional

The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary.

{DUNS} string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the D-U-N-S Number that is provided by the customer to register for Monitoring.

{productID} string up to 64 chars., Required

Records the product code that is provided by the customer to create a profile

ServiceVersionNumber string up to 10 chars., Optional

A number that identifies the version of the Service for the product. If Service version is not provided in the request, then the latest available Service version of the product will be delivered.

If Service version of the product provided in the request does not match with the monitoring profile, an error will be thrown.

{AttachCompressedProductIndicator} boolean., Optional

When set to TRUE this denotes that the customer has requested that D&B return the compressed product in Level 2 change notice. When set to FALSE this denotes that the customer has not requested that D&B return the compressed product in Level 2 change notice.

Endpoint

Use the following endpoint for requesting this feature. The {version} is dependent on the underlying service delivering the response.

Endpoint (Monitoring)
GET https://direct.dnb.com/V{version}/monitoring/organizations/{DUNS}/products/{productID}

Testing

This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless of the request parameters.

Feature Response

NOTE: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minor variations.

Specification

The following is a list of the possible data fields returned by this operation in the JSON response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.

NOTE: For level 2 Monitoring registrations, the service returns data layers in the format specified by the latest version of the corresponding service. For example, if the DCP_PREM data layer is being monitored and a new version of the Firmographic service is released, level 2 Monitoring attachments will reflect the newer DCP_PREM layout (if it changed).

When the customer requests that D&B to return the compressed product in the attachment, the linkage product will be returned as a compressed attachment in base64 response code. Once decoded, the product can be consumed as a .gz file.

NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.

Sample Response (Get Product)
{
    "GetMonitoringProductResponse": {
        "TransactionDetail": {
            "ApplicationTransactionID": "123",
            "ServiceTransactionID": "Id-823d755cdcf86befdc42d6d8-1",
            "TransactionTimestamp": "2019-02-26T08:22:21.374-05:00"
        },
        "TransactionResult": {
            "SeverityText": "Information",
            "ResultID": "CM000",
            "ResultText": "Success"
        },
        "GetMonitoringProductResponseDetail": {
            "InquiryDetail": {
                "DUNSNumber": "804735132",
                "DNBProductID": "DCP_STD"
            },
            "Product": {
                "LanguageCode": 39,
                "Organization": {
                    "SubjectHeader": {
                        "DUNSNumber": "804735132"
                    },
                    "OrganizationName": {
                        "OrganizationPrimaryName": [
                            {
                                "OrganizationName": {
                                    "$": "Gorman Manufacturing Company, Inc."
                                }
                            }
                        ]
                    }
                },
                "ObjectAttachment": {
                    "ContentObject": "{"@ServiceVersionNumber":"5","TransactionDetail":{"ApplicationTransactionID":"123","ServiceTransactionID":"Id-823d755cdcf86befdc42d6d8-1","TransactionTimestamp":"2019-02-26T08:22:11.870-05:00"},"TransactionResult":{"SeverityText":"Information","ResultID":"CM000","ResultText":"Success"},"OrderProductResponseDetail":{"InquiryDetail":{"DUNSNumber":"804735132","CountryISOAlpha2Code":"US"},"Product":{"DNBProductID":"DCP_STD","LanguageCode":39,"Organization":{"SubjectHeader":{"DUNSNumber":"804735132","OrganizationSummaryText":"Commercial printing, lithographic","LastUpdateDate":{"$":"2011-01-10"},"TransferDUNSNumberRegistration":[{"TransferDate":{"$":"2015-11-05"},"TransferredFromDUNSNumber":"114315195","TransferredToDUNSNumber":"804735132","TransferReasonText":[{"@DNBCodeValue":421,"$":"Internal Structure Change"}]}],"MarketabilityIndicator":false,"NonMarketableReasonText":[{"@DNBCodeValue":11028,"$":"Opted out of Direct Marketing"},{"@DNBCodeValue":25837,"$":"Insufficient Data"}]},"Telecommunication":{"TelephoneNumber":[{"TelecommunicationNumber":"(650) 555-0000","InternationalDialingCode":"1","UnreachableIndicator":false}]},"Location":{"PrimaryAddress":[{"StreetAddressLine":[{"LineText":"492 KOLLER ST"}],"PrimaryTownName":"San Francisco","CountryISOAlpha2Code":"US","TerritoryAbbreviatedName":"CA","PostalCode":"94110","AddressUsageTenureDetail":[{"TenureTypeText":{"@DNBCodeValue":1129,"$":"Rents"}}],"CountyOfficialName":"San Francisco County","TerritoryOfficialName":"California","CountryGroupName":"North America","UndeliverableIndicator":false,"RegisteredAddressIndicator":false,"ResidentialAddressIndicator":false}],"MailingAddress":[{"CountryISOAlpha2Code":"US","UndeliverableIndicator":false}]},"Financial":{"KeyFinancialFiguresOverview":[{"StatementHeaderDetails":{"FinancialStatementToDate":{"$":"2016-12-31"},"FinancialPeriodDuration":"P1Y"},"SalesRevenueAmount":[{"@CurrencyISOAlpha3Code":"USD","@ReliabilityText":"Actual","@UnitOfSize":"SingleUnits","$":21665429}]}]},"OrganizationName":{"OrganizationPrimaryName":[{"OrganizationName":{"$":"Gorman Manufacturing Company, Inc."}}]},"OrganizationDetail":{"FamilyTreeMemberRole":[{"FamilyTreeMemberRoleText":{"@DNBCodeValue":12775,"$":"Global Ultimate"}},{"FamilyTreeMemberRoleText":{"@DNBCodeValue":12774,"$":"Domestic Ultimate"}},{"FamilyTreeMemberRoleText":{"@DNBCodeValue":12773,"$":"Parent"}}],"StandaloneOrganizationIndicator":false,"ControlOwnershipDate":{"$":"1985"},"ControlOwnershipTypeText":{"@DNBCodeValue":9058,"$":"Privately owned"},"OperatingStatusText":{"@DNBCodeValue":9074,"$":"Active"},"OrganizationStartYear":"1985"},"RegisteredDetail":{"OrganizationIdentificationNumberDetail":[{"@DNBCodeValue":6863,"@TypeText":"Federal Taxpayer Identification Number (US)","OrganizationIdentificationNumber":"123456789"}],"IncorporationYear":"1985"},"IndustryCode":{"IndustryCode":[{"@DNBCodeValue":25838,"@TypeText":"D&B Hoovers Industry Code","IndustryCode":{"$":"1068"},"IndustryCodeDescription":[{"@LanguageCode":39,"@IndustryCodeDescriptionLengthCode":9120,"$":"Commercial Printing"}],"DisplaySequence":1},{"@DNBCodeValue":700,"@TypeText":"NAICS","IndustryCode":{"$":"323111"},"IndustryCodeDescription":[{"@LanguageCode":39,"@IndustryCodeDescriptionLengthCode":9120,"$":"Commercial Printing (except Screen and Books)"}],"DisplaySequence":1},{"@DNBCodeValue":24664,"@TypeText":"North American Industry Classification System 2012","IndustryCode":{"$":"323111"},"IndustryCodeDescription":[{"@LanguageCode":39,"@IndustryCodeDescriptionLengthCode":9120,"$":"Commercial Printing (except Screen and Books)"}],"DisplaySequence":1},{"@DNBCodeValue":21182,"@TypeText":"UK SIC 2003","IndustryCode":{"$":"22.220"},"IndustryCodeDescription":[{"@LanguageCode":39,"@IndustryCodeDescriptionLengthCode":9120,"$":"Other printing"}],"DisplaySequence":1},{"@DNBCodeValue":3599,"@TypeText":"D&B Standard Industry Code","IndustryCode":{"$":"27520000"},"IndustryCodeDescription":[{"@LanguageCode":39,"@IndustryCodeDescriptionLengthCode":2121,"$":"COMM PRTG  LITHO"}],"DisplaySequence":1},{"@DNBCodeValue":399,"@TypeText":"US SIC (1987)","IndustryCode":{"$":"2752"},"IndustryCodeDescription":[{"@LanguageCode":39,"@IndustryCodeDescriptionLengthCode":1441,"$":"Lithographic commercial printing"}],"SalesPercentage":100,"DisplaySequence":1}]},"ActivitiesAndOperations":{"LineOfBusinessDetails":[{"LineOfBusinessDescription":{"$":"Commercial printing, lithographic"}}],"PrimarySICCategoryValue":"D"},"EmployeeFigures":{"IndividualEntityEmployeeDetails":{"TotalEmployeeQuantity":110,"ReliabilityText":{"@DNBCodeValue":9092,"$":"Actual"}},"ConsolidatedEmployeeDetails":{"TotalEmployeeQuantity":125,"EmployeeCategoryDetails":[{"EmployeeBasisText":{"@DNBCodeValue":9064,"$":"Principals"}}],"ReliabilityText":{"@DNBCodeValue":9092,"$":"Actual"}}},"Linkage":{"LinkageSummary":{"GlobalUltimateFamilyTreeLinkageCount":7},"GlobalUltimateOrganization":{"DUNSNumber":"804735132","OrganizationPrimaryName":[{"OrganizationName":{"$":"GORMAN MANUFACTURING COMPANY, INC."}}],"PrimaryAddress":[{"StreetAddressLine":[{"LineText":"492 KOLLER ST"}],"PrimaryTownName":"SAN FRANCISCO","CountryISOAlpha2Code":"US","TerritoryAbbreviatedName":"CA","PostalCode":"94110","TerritoryOfficialName":"CA"}]},"DomesticUltimateOrganization":{"DUNSNumber":"804735132","OrganizationPrimaryName":[{"OrganizationName":{"$":"GORMAN MANUFACTURING COMPANY, INC."}}],"PrimaryAddress":[{"StreetAddressLine":[{"LineText":"492 KOLLER ST"}],"PrimaryTownName":"SAN FRANCISCO","CountryISOAlpha2Code":"US","TerritoryAbbreviatedName":"CA","PostalCode":"94110","TerritoryOfficialName":"CA"}]}},"PrincipalsAndManagement":{"CurrentPrincipal":[{"PrincipalName":{"@type":"cus:IndividualNameType","FullName":"Kevin J Hunt"},"JobTitle":[{"JobTitleText":{"$":"Sec-treas"}}],"PrincipalIdentificationNumberDetail":[{"@DNBCodeValue":24215,"@TypeText":"Professional Contact Identifier","PrincipalIdentificationNumber":"220656221"}]},{"PrincipalName":{"@type":"cus:IndividualNameType","FullName":"Leslie Smith"},"JobTitle":[{"JobTitleText":{"$":"Pres"}}],"PrincipalIdentificationNumberDetail":[{"@DNBCodeValue":24215,"@TypeText":"Professional Contact Identifier","PrincipalIdentificationNumber":"5412657"}]}]},"SocioEconomicIdentification":{"MinorityOwnedIndicator":false,"SmallBusinessIndicator":true,"OwnershipEthnicity":[{"EthnicityTypeText":{"@DNBCodeValue":0,"$":"Unknown"}}],"LaborSurplusAreaIndicator":false}}}}}",
                    "ObjectFormatCode": 126
                }
            }
        }
    }
}
Name Characteristics
GetMonitoringProductResponse Aggregate
GetMonitoringProductResponse { TransactionDetail Aggregate, Required

Records information necessary to process a particular request. Examples of a request is the ordering of a product.

GetMonitoringProductResponse { TransactionDetail { ApplicationTransactionID string up to 64 chars., Optional

A number assigned by the calling application to uniquely identify this request.

GetMonitoringProductResponse { TransactionDetail { ServiceTransactionID string up to 64 chars., Required

A number assigned by the D&B service to uniquely identify this transaction.

GetMonitoringProductResponse { TransactionDetail { TransactionTimestamp DateTimestamp, Required

The date and time when this request was submitted or the date and time when the requesting intermediary, such as a workflow manager or service bus, sent the message to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary.

End: GetMonitoringProductResponse } TransactionDetail /Aggregate
GetMonitoringProductResponse { TransactionResult Aggregate, Required

An aggregate that can repeat multiple times to record the different outcomes of the transaction.

GetMonitoringProductResponse { TransactionResult { SeverityText string up to 16 chars., Required

Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal.

GetMonitoringProductResponse { TransactionResult { ResultID string up to 32 chars., Required

An alphanumeric string that uniquely identifies the outcome of the transaction.

GetMonitoringProductResponse { TransactionResult { ResultText string up to 512 chars., Optional

Text that explains the outcome of the transaction.

GetMonitoringProductResponse { TransactionResult { ResultMessage Aggregate, Optional (Array)

An aggregate that can repeat multiple times to record textual data that expands on the ResultID and ResultText to provide additional information to the user regarding the status of the transaction. If the status implies that there is a problem this may also provide guidance to the user on how to address it.

GetMonitoringProductResponse { TransactionResult { ResultMessage { ResultDescription string up to 512 chars., Required

Text that describes the additional information regarding the outcome of the transaction.

End: GetMonitoringProductResponse } TransactionResult } ResultMessage /Aggregate
End: GetMonitoringProductResponse } TransactionResult /Aggregate
GetMonitoringProductResponse { GetMonitoringProductResponseDetail Aggregate, Optional
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { InquiryDetail Aggregate, Required
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { InquiryDetail { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the duns number that is provided by the customer to register for Monitoring.

GetMonitoringProductResponse { GetMonitoringProductResponseDetail { InquiryDetail { DNBProductID string up to 64 chars., Required

Records the product code that is provided by the customer to create a profile

GetMonitoringProductResponse { GetMonitoringProductResponseDetail { InquiryDetail { ServiceVersionNumber string up to 10 chars., Optional

A number that identifies the version of the Service for the product.

GetMonitoringProductResponse { GetMonitoringProductResponseDetail { InquiryDetail { AttachCompressedProductIndicator boolean., Optional

When set to TRUE this denotes that the customer has requested that D&B return the compressed product in Level 2 change notice. When set to FALSE this denotes that the customer has not requested that D&B return the compressed product in Level 2 change notice.

End: GetMonitoringProductResponse } GetMonitoringProductResponseDetail } InquiryDetail /Aggregate
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product Aggregate, Required
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { LanguageCode integer up to 7 digits., Optional

A D&B code value that defines the language in which the requested product is fulfilled.

GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { Organization Aggregate, Optional
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { Organization { SubjectHeader Aggregate, Required

Records high level information about the subject such as the primary language of the subject and the primary currency in which this subject trades. When the subject is an organizantion, this may also include details such as DUNS Number.

GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { Organization { SubjectHeader { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S).

End: GetMonitoringProductResponse } GetMonitoringProductResponseDetail } Product } Organization } SubjectHeader /Aggregate
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { Organization { OrganizationName Aggregate, Required

Records the different names of the organization by which it is known as well as names of other organizations that have a similar name to this organization.

GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName Aggregate, Required (Array)

An entry loop which can repeat multiple times to allow the recording of a single name by which the organization is primarily known / identified in different languages and/or writing scripts.

GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName string up to 256 chars., Required
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName @WritingScriptISOAlpha4Code Attribute
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName @LanguageCode Attribute
End: GetMonitoringProductResponse } GetMonitoringProductResponseDetail } Product } Organization } OrganizationName } OrganizationPrimaryName /Aggregate
End: GetMonitoringProductResponse } GetMonitoringProductResponseDetail } Product } Organization /Aggregate
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { ObjectAttachment Aggregate
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { ObjectAttachment { ContentObject Element
GetMonitoringProductResponse { GetMonitoringProductResponseDetail { Product { ObjectAttachment { ObjectFormatCode Element
End: GetMonitoringProductResponse } GetMonitoringProductResponseDetail } Product } ObjectAttachment /Aggregate
End: GetMonitoringProductResponse } GetMonitoringProductResponseDetail } Product /Aggregate
End: GetMonitoringProductResponse } GetMonitoringProductResponseDetail /Aggregate
End: GetMonitoringProductResponse /Aggregate

Response Codes & Error Handling

Successful service requests will return a CM000 response code in the TransactionResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.

This operation may return the following response codes: CM001, CM002, CM004, CM007, CM011, CM012, CM014, MN003, PD005, SC001-SC009.

D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.

While this operation is provided on a metered basis, usage is tracked; however, no billing for successful calls is recorded.

Operation-specific supplemental response code explanations:

CM001Invalid Language code provided
CM001The given request is invalid.
CM002The format of this request is invalid. Please refer to Online Documentation.
CM004Internal D&B system error. Please try again or contact your local Customer Service Center.
CM007No Level2 notices available for the given criteria
CM011Invalid Country Code provided in the request. Please refer to Online Documentation.
CM012Invalid Duns number provided in the request. Please refer to Online Documentation.
CM014Invalid Product Code provided in the request. Please refer to Online Documentation.
MN003Value provided for element Service Version Number is not registered for Level 2 Monitoring of the product.
MN003Product is not registered for Level2 Monitoring.
PD005Requested Product not available