Get Monitoring Product
| Product | D&B Direct 2.0 |
| Product Code(s) | Not Applicable |
| Options(s) | None |
| Monitoring Available | No |
| Interface | REST |
| Method | GET |
| Format(s) | JSON |
| Service | Monitoring |
| {version} | 5.0 |
| 5.0 Released on | January 8, 2016 |
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 November 09, 2020.
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.
GET https://direct.dnb.com/V5.0/monitoring/organizations/804735132/products/LNK_FF?AttachCompressedProductIndicator=true 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. |
| SubmittingOfficeID | string up to 64 chars., Optional A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated. |
| {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 |
| {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.
{"GetMonitoringProductResponse": {
"@ServiceVersionNumber": "5.0",
"TransactionDetail": {
"ServiceTransactionID": "Id-55ea725600f20000108300007fe9e1a8-1",
"TransactionTimestamp": "2015-12-17T12:01:09.780-05:00"
},
"TransactionResult": {
"SeverityText": "Information",
"ResultID": "CM000",
"ResultText": "Success"
},
"GetMonitoringProductResponseDetail": {
"InquiryDetail": {
"DUNSNumber": "804735132",
"DNBProductID": "LNK_FF"
},
"Product": {
"Organization": {
"SubjectHeader": {"DUNSNumber": "804735132"},
"OrganizationName": {"OrganizationPrimaryName": {"OrganizationName": {"$": "ORGANIZATION_NAME"}}}
}
},
"ObjectAttachment": {
"ContentObject": "H4sIAAAAAAAAALVUy1LCMBRd68+EAjouMplBUWAGCtKyceNc2itE01TTW8f69QZ5lZb3aDfJnHMfJye94X0zAS2/gWSsBffS8SsG1EYI0QjeHLmem0Zju686lUrVuao5nOVQzgoZ+XIuRLiJDIyMwGRl4he5vJh/y7U/bDXczlPD7/TdZ7fRu18QnJW7sJ1ttgTnkSYSSCX4A0RSZb5B7OHsaMNY4XbUxy8SAzCoibOdAdupk/vMfP1IwRCa5IxuHoEOQcUa82fu6FAGQLERL6AStJd4IGzTxKVlXanfYIKrjZdGM9sFv5tKFVp/SsBjCpokZaJ+U6lzVoJ5Uxr7My3xks5d9LrUYQ1+9j737NaADqbr1BVRlnt9ilYy6V9LtUOWyFBa8ii5tf/Vy4r33VLxGNRIkR07ws0X5YgnZG96HGFCMji7+P4C66lpSzRggmnWxU9UwslPVIFbGVCYC/EDl5i8Fk0FAAA=",
"ObjectFormatCode": "126"
}
}
}}
NOTE: The OrderProductResponse@ServiceVersionNumber value in the object attachment will NOT match the version of the data layer when retrieved from it's corresponding service.
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:
| CM001 | Invalid Language code provided |
| CM007 | No Level2 notices available for the given criteria |
| PD005 | Requested Product not available |
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.