d&b direct 2.0 monitoring service · thelist monitoring ......
TRANSCRIPT
D&B DirectAPI Documentation for
Monitoring Service
Version 2.0 (API) / 4.1 (Service)
D&B Direct is a trademark or registered trademark of Dun and Bradstreet, Incorporated. Other trademarks
used herein are the trademarks or registered trademarks of their respective owners.
This document is a work of authorship that belongs to Dun and Bradstreet, Incorporated and is protected
by United States and foreign copyright laws and international copyright treaties. The use of the software
and this Documentation is governed by the Dun and Bradstreet Incorporated software license agreement.
D&B DOES NOT GUARANTEE OR WARRANT SYSTEMS AVAILABILITY OR PERFORMANCE IN ACCORDANCE
WITH THE FIGURES WITHIN THIS DOCUMENT, NOR DOES D&B ACCEPT ANY LIABILITY FOR DAMAGES
WHICH MAY BE SUFFERED AS A RESULT OF PLACING ANY RELIANCE ON THESE FIGURES. D&B RESERVES
THE RIGHT TO AMEND THIS DOCUMENT AT ANY TIME AND WILL ADVISE THE CUSTOMER ACCORDINGLY OF
ANY SUCH AMENDMENTS OR CHANGES.
©Dun & Bradstreet, Inc. 2015. All rights reserved
ContentsThese pages provide business overviews; explaining requirements and the business elements that will bedelivered. For suggested uses of the API components, please refer to the Solutions menu option on thedeveloper.dnb.com home page.
Title / Overview Link
Data Layer/Field Monitoring
These pages provide the technical specifications that a developer will need to obtain information usingD&B Direct.
Service Operation / SOAP Resource / REST
n/a [Authentication Process] POST Authentication
Monitoring Service CreateMonitoringProfile POST monitoring/monitoringprofiles
UpdateMonitoringProfile PUT monitoring/monitoringprofiles/{MonitoringProfileID}
ListMonitoringProfile GET monitoring/monitoringprofiles
CreateNotificationProfile POST monitoring/notificationprofiles
UpdateNotificationProfile PUT monitoring/notificationprofiles/{NotificationProfileID}
ListNotificationProfile GET monitoring/notificationprofiles
AddMonitoringRegistration POST monitoring/registrations
UpdateMonitoringRegistration PUT monitoring/registrations
ListMonitoringRegistration GET monitoring/registrations
ListChangeNotice GET monitoring/changenotices
GetMonitoringProduct GET monitoring/organizations/{DUNS}/products/{productID}
Service History
Version Date Interface(s)
Change(s)
4.1 Dec. 12,2014
SOAP/REST Added ReturnChangedDataOnlyIndicator to the Monitoring Profile, applicable inCreate (Request), Update (Request/Response) and List (Response) functions.
4.0 Nov. 14,2014
SOAP/REST Change Notices will now be triggered by mergers and acquisitions resulting inchanges to the Transferred D-U-N-S Number field, indicating that the event causedthe original D-U-N-S Number to no longer be valid.
4.0 Sept. 19,2014
SOAP/REST The Add Monitoring Registration operation now returns a CM026 error uponcompletion, which sets the request into a pending status. The List MonitoringRegistration operation should be polled to obtain the final status (i.e. active or failed).
D&B Direct API Documentation Service History
©Dun & Bradstreet, Inc. 2015 3
Version Date Interface(s)
Change(s)
3.0 August22, 2014
SOAP/REST 1. CreateMonitoringProfile, UpdateMonitoringProfile now accept criteria on elements
within an aggregate.
2. AddMonitoringRegistration no longer performs a Product Availability check.
Customers wishing to retain this added level of pre-qualification may call the function
directly prior to registering the DUNS.
3. Change Notices will now be triggered by changes to the Transferred D-U-N-S
Number field, indicating that the registered DUNS will no longer receive change
notices.
4. Changes to fields in the /Linkage/ aggregate (often referred to as "upward linkage")
will now trigger change notices when the DUNS of a related entity (e.g. parent, global
ultimate) changes.
3.0 December6, 2013
SOAP/REST Linkage - Change Notice. The event information delivered when corporate linkagechanges occur will now provide an explanation for each affected child company.Details...
2.0 October 2,2013
SOAP/REST Initial release.
D&B Direct API Documentation Service History
©Dun & Bradstreet, Inc. 2015 4
About this DocumentationThe D&B Direct 2.0 API Reference materials are organized into product, feature, service and operation pages.Throughout the documentation, certain items are marked as eligible for custom products and/or for inclusionin the monitoring process.
Key Concepts
Business Elements vs. Data Fields
The D&B Direct API has been designed to efficiently deliver information, and as a result, multiple businesselements are often delivered in the same data field (with separate attributes signaling the specific contents ofa data field).
The documentation highlights the business elements (i.e. business-oriented labels) on product pages; and thedata fields (i.e. technical, variable-like names used within the delivery packages) on operation pages -- withthe business elements linked to the corresponding data field for each available implementation.
Data Layers
The D&B Direct API delivers information in data layers, some of which have multiple levels. For the purpose ofthis documentation, the term Product is used to represent a given level for a data layer.
For example, "Detailed Company Profile" is the Data Layer, while "Detailed Company Profile - Enhanced" willbe referred to as a Product.
Custom Products
D&B Direct offers a customization service that allows for up to eight pre-configured products to be deliveredthrough the API web service. Throughout the documentation, business elements and data fields which areeligible for inclusion in a custom product are designated with a [C] marker.
Monitoring Events
For customers who would like to keep abreast of ongoing changes to data fields for specific companies, amonitoring service is available. Throughout the documentation, business elements and data fields which areeligible for inclusion in a custom product are designated with a [M] marker.
D&B Direct API Documentation About this Documentation
©Dun & Bradstreet, Inc. 2015 5
Service Versions
It is important to note that D&B Direct 2.x implements version control at the service level, in addition to theAPI level. For example, the current version of the Assessment Product Service is Version 2.0 (API) / 3.0 (Service).
D&B Direct services will be updated (major and minor version changes) without a API version change.Following the example given, it will be possible for the Assessment Product Service to change to Version 2.0(API) / 3.1 (Service) or Version 2.0 (API) / 4.0 (Service) based on the significance of the changes made to theservice.
Product Pages
These are non-technical pages that describe the information (i.e. business elements) returned by the data-oriented operations. In addition, the requirements and options for requesting data are mentioned.
Feature Pages
These are also non-technical pages, but explain the use of operations that provide a function (e.g. search) andoften return the items (i.e. D-U-N-S Number) required to request data products.
Service Pages
These are technical pages that explain what operations a given API web service provides, the correct versionand endpoints, WSDL location (for SOAP), and how to download samples and data dictionaries specific to theservice. While services are not applicable for REST implementations, the documentation is organized aroundthem for consistency.
Operation Pages
These are also technical pages, but describe (for each available implementation method) the individualfunctions provided by a service, listing the input field names and requirements, and the output with datafields (including data type, size, description and possible values).
Release Histories
Whenever an operation is enhanced (or a minor correction is made), a notation will be added to a section onthe bottom of the affected SOAP/REST operation page. If the change is significant and results in a versionchange, the release history will maintain a link to the documentation for the previous version(s).
D&B Direct API Documentation Service Versions
©Dun & Bradstreet, Inc. 2015 6
Getting Started
While the API Reference documentation provides extensive details on each operation and data layer, for moresummarized explanations of common tasks/uses refer to the collection of How To Guides.
D&B Direct API Documentation Getting Started
©Dun & Bradstreet, Inc. 2015 7
Data Layer/Field MonitoringFor a given D&B Direct data layer, this feature allows the pre-configuration of D-U-N-S number, data field andchange condition/value combinations, along with a method of communicating triggered events.
Overview
The Monitoring process involves multiple setup steps before cha
Terminology
A Monitoring Profile establishes the specific data fields within a given data layer that should be monitored,and the conditions under which a change event should be triggered.
There are no fees involved with establishing Monitoring Profiles, and customers may create as many profilesas needed.
A Notification Profile establishes the protocol by which change events should be delivered to customers, andreferences user preferences setup in the User Service. This is the PUSH component of the Data Field Monitoringfeature.
There are no fees involved with establishing Notification Profiles, and customers may create as many profilesas needed.
A User Preference captures the technical details required to deliver information through various protocols,including Email, File Transfer Protocol (FTP), HTTP Callback, and IBM WebSphere MQ.
User Preferences are created/maintained through the User Service.
The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Numberand initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, orevents with data layer included.
Fees are incurred only when a Monitoring Registration is created and/or upon contract renewal (if the auto-renew option is active).
A Change Notice is triggered whenever a data field for the D-U-N-S Number specified in a MonitoringRegistration exceeds the thresholds set in the Monitoring Profile. Copies of Change Notices are delivered basedon the Notification Profile and may also be retrieved with the ListChangeNotice operation.
D&B Direct API Documentation Data Layer/Field Monitoring
©Dun & Bradstreet, Inc. 2015 8
Field Monitoring Setup
Monitoring Profiles may be established for entitled D&B Direct data layers that support the process (as notedin the "Available Products" section), and require a valid product code. These profiles can be assigned a user-generated name and description for reference purposes; however, a unique profile ID will be provided for usein creating Monitoring Registrations and for updating the profile.
In addition to the product code, a level ("Level1" or "Level2") must be selected. Level2 provides change eventnotices along with a copy of the data layer; while Level1 only provides the notices.
As an option, specific data fields within the data layer can be designated as trigger criteria. If data fields arenot specified, any change within the data layer will trigger an event and a Change Notice will be generated.Some data fields may only be monitored by the associated aggregate or attribute XPATH.
When specifying a data field, a change condition and value must also be specified. The possible conditionsinclude: AnyChange, ValueIncreaseByPercentage, ValueDecreaseByPercentage, ValueChangeByPercentage,ValueIncreaseBy, ValueDecreaseBy, ValueChangeBy, ValueGoesBeyond, ValueGoesBelow, ValueEquals,DateChangeBy or DateEquals. Each data field specified as a trigger criteria must have a condition defined,along with a value (unless AnyChange is selected).
The Monitoring process triggers events based on the old and new data field values WHEN A CHANGE OCCURS,and is not based on the data layer values when the Monitoring Registration was created. To capturecumulative but gradual changes, using the "ValueGoesBeyond" or "ValueGoesBelow" conditions isrecommended.
In addition to the Create and Update, a List Monitoring Profiles operation exists.
Monitoring Profiles can be removed by setting the status to "Cancelled"; however, if the profile is referenced ina Monitoring Registration it will not be removed.
Notification Setup
The D&B Direct Monitoring process currently supports notification by Email, HTTP CallBack or IBM WebSphereMQ. The actual destination for a given deliver mode is specified in a User Preference (default or named), whichis configured using the User Service. Notification Profiles can be assigned a user-generated name anddescription for reference purposes; however, a unique profile ID will be provided for use in creating MonitoringRegistrations and for updating the profile.
A delivery frequency must also be specified for the profile. Available options include: Immediate (when anevent is detected), Hourly, Daily, or Weekly. Currently, all notifications will be delivered in XML format.
D&B Direct API Documentation Field Monitoring Setup
©Dun & Bradstreet, Inc. 2015 9
The delivery of Change Notices can be paused/resumed by updating an indicator on the profile. While aNotification Profile (Push) is required to establish a Monitoring Registration, this pause/resume indicator canbe used to disable delivery of all notices, if a customer prefers to obtain notices using the ListChangeNoticeoperation (Pull).
In addition to the Create and Update, a List Notification Profiles operation exists.
Notification Profiles can be removed by setting the status to "Cancelled"; however, if the profile is referencedin a Monitoring Registration it will not be removed.
User Preferences
As a requisite to creating a Notification Profile, a minimum of one default user preference needs to beestablished. User preferences can have user-generated names, or be designated as the default (i.e. no name),and capture the specific destination for a given delivery protocol. For example, if the preferred notificationmethod is Email, the user preference will contain the actual Email address(es) to be used.
User Preferences can be removed by setting the status to "Cancelled"; however, if the profile is referenced in aNotification Profile it will not be removed.
Registration Maintenance
The Monitoring process is initiated by the creation of a Monitoring Registration, and requires a minimum ofone Monitoring Profile, one Notification Profile (which requires a user preference) and a valid D-U-N-SNumber. Monitoring and Notification Profiles can be used in multiple Monitoring Registrations, and in anycombination.
When adding a Monitoring Registration, a valid D-U-N-S Number for a company, its country code, and theunique ID's for a Monitoring and Notification profile will be required. A trade up option exists to monitor datafor the headquarters when the requested organization is a branch.
When ordering information for organizations located in Germany, you will be required to provide an orderreason code.
The volume of resulting change notices is dependent on the product/data field criteria (i.e. Monitoring Profile),volatility of the company being monitored, and the data update frequency (which may vary in certaincountries). Change detection is currently based on the latest values as compared to previous values, andtherefore is not cumulative from the date of registration.
The Product Availability Lookup feature should be utilized to determine if the D&B Direct product thatwill monitored is available for a given D-U-N-S Number.
D&B Direct API Documentation User Preferences
©Dun & Bradstreet, Inc. 2015 10
A category field is available that allows user-generated values to be entered. This subject category is includedon all related Change Notices.
An auto-renewal indicator is available that allows for a Monitoring Registration to be preserved when anannual contract is renewed.
In addition to the Add and Update, a List Monitoring Registrations operation exists.
Monitoring Registrations can be removed by setting the status to "Cancelled".
Notification Retrieval (Optional)
Change Notices that have occurred within the past sixty days can be retrieved using the ListChangeNoticeoperation. The format of information available via this (Pull) process differs slightly from the notices that aredelivered (Push) automatically. Change Notices for the same D-U-N-S Number and product code (in the Pushnotification) are bundled together; whereas in the Pull process they are listed separately.
When requesting a list of available Change Notices, up to ten D-U-N-S Numbers, three user-defined subjectcategories, a product code, level (one or two), and a date range may be included. The results for a singlerequest are limited to the first 1,000 matching notices.
For Change Notices generated by level two monitoring registrations, the related product data may be retrievedusing the GetMonitoringProduct operation without incurring any additional usage charges. This operationreturns a copy of the product data taken at the time of the most recent change, which will not necessarily bethe data available at the date/time when a specific the Change Notice was triggered.
Available Products
The following is a list of products that may be included in the Monitoring process. Please refer to the BusinessElement listings for each product to determine which fields may be included in a Monitoring Profile.
Product Code
Corporate Linkage LNK_FF
Detailed Company Profile DCP_STD, DCP_ENH, DCP_PREM
Detailed Company Profile - SDMR DCP_SDMR
Detailed Company Profile - WB1784 DCP_WB1784
Alternative Detailed Company Profile DCP_ALT_STD, DCP_ALT_ENH, DCP_ALT_PREM
Diversity Indicators DVR_STD, DVR_ENH
Financial Highlights FIN_HGLT
Financial Statements FIN_ST_PLUS
D&B Direct API Documentation Notification Retrieval (Optional)
©Dun & Bradstreet, Inc. 2015 11
Product Code
Payment Information & Paydex (Rating) - Detail PIAP_STD, PIAP_ENH, PIAP_PREM
USA PATRIOT Act Plus PAC_PLUS
People CNTCT, CNTCT_PLUS
Predictive Bankruptcy Risk - D&B Financial Stress Score (FSS) PBR_FSS_V7.1
Predictive Payment Risk - D&B Commercial Credit Score (CCS) PPR_CCS_V9
Predictive Bankruptcy & Payment Risk PBPR_STD, PBPR_ENH
Predictive Global Payment Risk - D&B Emerging Market Mediation AlertScore (EMMA)
PGPR_EMMA
D&B Supplier Evaluation Risk Rating SER
D&B Total Loss Predictor TLP
D&B Triple Play TP_STD, TP_ENH, TP_PREM
D&B Viability Rating VIAB_RAT
Custom Products CST_PRD_1 to CST_PRD_6
Special Cases
The Corporate Linkage data layer may only be monitored at the product code level (i.e. individual BusinessElements may NOT be specified), and the change notice will be generated for any change in the entire linkageof the global ultimate parent.
The Financial Statements data layer may only be monitored at the aggregate level and will generate a changenotice whenever any line item in a given financial statement changes. The notice does not specify which lineitems have changed.
Understanding Change Notices
There are two types of changes that will be reported by the monitoring service: changes in data layers (or asubset thereof) and changes to corporate linkage.
Data Field Changes
Here are a couple of things to be aware of when monitoring a data layer, an aggregate within a data layer, orspecific fields within a data layer:
l The monitoring service will trigger notices whenever the values of fields (as defined by the Monitoringprofile) change. This may include the first time the field has a value (NewlyAdded), when it no longerhas a value (Dropped), or the value has been modified (ValueChanged).
l The monitoring change notice may include "changes" for items that fall within the definition of theMonitoring profile, but did not change (No Change). For example, if the MailingAddess is monitored,
D&B Direct API Documentation Special Cases
©Dun & Bradstreet, Inc. 2015 12
and the street address changes, but the city and state do not, the change notice will include entries forthe city and state.
l When the condition is ValueChanged or Dropped, the change notice will also include the previous value.l When there are multiple occurrences of a field, the sequence will be incorporated into the XPATH (e.g.
"/PrimaryAddress[1]/").l Multiple change events for a D-U-N-S Number may be clustered into a single change notice when
delivered to customer (i.e. PUSH), whereas, they will be separate when using the ListChangeNoticefunction (i.e. PULL).
Example #1: CEO Change
Company XYZ announces a new CEO: John Smith is replaced by Edward Jones. The business element for theCEO name is Most Senior Principal Full Name. It is part of an aggregate XPATH, therefore all elements of theaggregate will be included in the change notice.
In the change notice, the following items should be examined:
l SubjectHeader will equal D-U-N-S Number of company XYZ,l Multiple elements will be delivered in the change event.l The attributes on the element explain the change that has occurred.l The outer PCMElementXPATHText represents the aggregate.l The inner (attribute) PCMElementXPATHText represents the business element(s).
<ChangeEvent>
<PCMElementXPATHText>//Organization/PrincipalsAndManagement/MostSeniorPrincipal/</PCMElementXPATHText>
<Element ChangeType="ValueChanged" OldValue="John Smith"PCMElementXPATHText="//Organization/PrincipalsAndManagement/MostSeniorPrincipal/PrincipalName/FullName">Edward Jones</Element>
{ all other aggregate elements will be included here }
</ChangeEvent>
Example #2: Change of Address
Company XYZ announces it's headquarters have moved within New York City from 123 E 81st Street, Suite400 to 200 Park Avenue. These business elements are part of an aggregate. The street address will change,and the suite portion will be dropped. The city and state will be included and reflect no change.
In the change notice, the following items should be examined:
D&B Direct API Documentation Data Field Changes
©Dun & Bradstreet, Inc. 2015 13
l SubjectHeader will equal D-U-N-S Number of company XYZ,l One or more elements will be delivered in the change event.l The attributes on the element explain the change that has occurred.l The outer PCMElementXPATHText represents the aggregate.l The inner (attribute) PCMElementXPATHText represents the business element(s).
<ChangeEvent>
<PCMElementXPATHText>//Organization/Location/PrimaryAddress</PCMElementXPATHText>
<Element ChangeType="ValueChanged" OldValue="123 E 81st Street"PCMElementXPATHText="//Organization/Location/PrimaryAddress[1]/StreetAddressLine[1]/LineText">200Park Avenue</Element>
<Element ChangeType="Dropped" OldValue="Suite 400"PCMElementXPATHText="//Organization/Location/PrimaryAddress[1]/StreetAddressLine[2]/LineText" />
<Element ChangeType="NoChange" PCMElementXPATHText="//Organization/Location/PrimaryAddress[1]/PrimaryTownName">New York</Element>
<Element ChangeType="NoChange" PCMElementXPATHText="//Organization/Location/PrimaryAddress[1]/TerritoryAbbreviatedName">NY</Element>
</ChangeEvent>
D-U-N-S Number Retirement (a.k.a. "Deletes")
As a result of database maintenance and normal business activities (mergers, acquisitions, divestitures) it ispossible that a D-U-N-S Number assigned to a company may change. To capture these events, customersshould monitor the//Organization/SubjectHeader/TransferDUNSNumberRegistration/TransferredToDUNSNumber XPATHavailable in the Detailed Company Profile data layers.
If/when a D-U-N-S Number is retired (or "deleted") from D&B's database, a change notice will be triggeredwith the new "retained" D-U-N-S Number (TransferredToDUNSNumber), the date of the event(TransferReasonText), and a reason that explains the type of event (TransferDate).
Note: Change notices for D-U-N-S Numbers being retired are ONLY available by Monitoring one of theseDetailed Company Profile data layers (DCP_STD, DCP_ENH, DCP_PREM, DCP_ALT_STD, DCP_ALT_ENHand DCP_ALT_PREM).
<ChangeEvent>
D&B Direct API Documentation D-U-N-S Number Retirement (a.k.a. "Deletes")
©Dun & Bradstreet, Inc. 2015 14
<PCMElementXPATHText>//Organization/SubjectHeader/TransferDUNSNumberRegistration</PCMElementXPATHText>
<Element ChangeType="NewlyAdded"PCMElementXPATHText="//Organization/SubjectHeader/TransferDUNSNumberRegistration/TransferReasonText">Duplicate Record Transferred</Element>
<Element ChangeType="NewlyAdded"PCMElementXPATHText="//Organization/SubjectHeader/TransferDUNSNumberRegistration/TransferReasonText@DNBCodeValue">420</Element>
<Element ChangeType="NewlyAdded"PCMElementXPATHText="//Organization/SubjectHeader/TransferDUNSNumberRegistration/TransferDate">2014-01-01</Element>
<Element ChangeType="NewlyAdded"PCMElementXPATHText="//Organization/SubjectHeader/TransferDUNSNumberRegistration/TransferredToDUNSNumber">123456789</Element>
</ChangeEvent>
Note: In the case of a "Straight Deletion" event, the TransferredToDUNSNumber field will not be present inthe Change Notice.
If the AutoRenewalIndicator was set to true when the initial AddMonitoringRegistration request was made, itis recommended that the developer issue a UpdateMonitoringRegistration request for the subject D-U-N-SNumber and set the MonitoringRegistrationStatusText field to "Cancelled" when notified of a retirementevent.
Corporate Linkage Changes
The linkage (or family tree) monitoring feature triggers notifications when a member is added to, moveswithin or departs from a corporate structure. Here are some examples:
Example #1: Company "F" is added to the "A" tree, directly "owned" by company "E"
A|B - C| |D E
+F
D&B Direct API Documentation Corporate Linkage Changes
©Dun & Bradstreet, Inc. 2015 15
In the change notice, the following items should be examined:
l SubjectHeader will equal D-U-N-S Number of "A",l LinkageChange.DunsNumber will equal D-U-N-S Number of "F",l LinkageChange.ChangeType will be Add,l LinkageChange.GlobalUltimateOrganization.DunsNumber will equal D-U-N-S Number of "A"l LinkageChange.UpwardFamilyMemberOrganization.DunsNumber will equal D-U-N-S Number of "E".
Example #2: Company "F" is moves within the "A" tree, directly "owned" by company "C"
A|B - C| |D E
|F
A|B - C| | \D E F
In the change notice, the following items should be examined:
l SubjectHeader will equal D-U-N-S Number of "A",l Change Event 1
o LinkageChange.DunsNumber will equal D-U-N-S Number of "F",o LinkageChange.ChangeType will be Drop,o LinkageChange.FormerUpwardFamilyMemberOrganization.DunsNumber will equal D-U-N-S
Number of "E".l Change Event 2
o LinkageChange.DunsNumber will equal D-U-N-S Number of "F",o LinkageChange.ChangeType will be Add,o LinkageChange.UpwardFamilyMemberOrganization.DunsNumber will equal D-U-N-S Number of
"C".
Example #3: Company "F" leaves the "A" tree, now directly "owned" by company "H"
A|B - C| |D E
|F
A|B - C| |D E
G|H|F
In the change notice, the following items should be examined:
D&B Direct API Documentation Corporate Linkage Changes
©Dun & Bradstreet, Inc. 2015 16
l SubjectHeader will equal D-U-N-S Number of "A",l LinkageChange.DunsNumber will equal D-U-N-S Number of "F",l LinkageChange.ChangeType will be Drop,l LinkageChange.FormerGlobalUltimateOrganization.DunsNumber will equal D-U-N-S Number of "A"l LinkageChange.FormerUpwardFamilyMemberOrganization.DunsNumber will equal D-U-N-S Number of
"C".
If the "G" tree is also being monitored, a second change notice will be triggered:
l SubjectHeader will equal D-U-N-S Number of "G",l LinkageChange.DunsNumber will equal D-U-N-S Number of "F",l LinkageChange.ChangeType will be Add,l LinkageChange.GlobalUltimateOrganization.DunsNumber will equal D-U-N-S Number of "G"l LinkageChange.UpwardFamilyMemberOrganization.DunsNumber will equal D-U-N-S Number of "H".
Technical Specification
For details on how to utilize these features, please refer to the Monitoring Service documentation.
D&B Direct API Documentation Technical Specification
©Dun & Bradstreet, Inc. 2015 17
How to Retrieve Monitoring ProfilesReturns the Monitoring Profiles that match the criteria submitted with the request. If no criteria is specified, allactive profiles will be returned.
A Monitoring Profile establishes the specific data fields within a given data layer that should be monitored,and the conditions under which a change event should be triggered.
Requirements & Options
There are several options available when implementing this D&B Direct feature.
1. Basic Retrieve: If a Profile ID (the value returned when a profile is created) is provided to the List operation,a single profile will be returned.
2. Search by Name: When a profile is created, a customer supplied name is assigned. Searching by the profilename (case-sensitive, no wildcards) is available.
3. List by Product: Monitoring is performed at the product level, and a product ID is specified when a profile iscreated. The results may be filtered by product ID.
4. Level Filter: The Monitoring feature offers two levels of change notices: Level Two provides the notice with acopy of the product data attached; Level One only provides the notice. The results may be filtered by the level.
5. Date Range: The results can be narrowed by supplying a start and end date range which is comparedagainst the date a profile was created.
6. Status Filter: Profiles that are assigned a status of "Cancelled" remain in the Monitoring system for 24 hoursbefore being deleted. The results may be limited to a specific status.
7. Customer Reference Text: When a profile is created, a free form (240 character) field may be supplied. Thisfield may be used in the List operation; however, it is case-sensitive and there are no wildcard options.
8. Sorting Results: By default, the results will be ascending by ???. Optionally, both the sort direction and aprimary sort field can be designated on the request.
Sort field options include: DNBProductID, MonitoringProfileID, MonitoringProfileName, MonitoringLevel,MonitoringProfileStatusText, MonitoringProfileCreatedDate.
9. Pagination: Options exist to designate the maximum number of records per request, and the starting rownumber. The maximum number of records this feature will return on a single request is 1,000.
D&B Direct API Documentation How to Retrieve Monitoring Profiles
©Dun & Bradstreet, Inc. 2015 18
Business Elements
For each matching item, this feature will return the Monitoring Profile along with the date it was created.
Technical Specification
For details on how to access this feature, please refer to the Monitoring Service documentation.
D&B Direct API Documentation Business Elements
©Dun & Bradstreet, Inc. 2015 19
How to Retrieve Notification ProfilesReturns the Notification Profiles that match the criteria submitted with the request. If no criteria is specified,all active profiles will be returned.
A Notification Profile establishes the protocol by which change events should be delivered to customers, andreferences user preferences setup in the User Service. This is the PUSH component of the Data Field Monitoringfeature.
Requirements & Options
There are several options available when implementing this D&B Direct feature.
1. Basic Retrieve: If a Profile ID (the value returned when a profile is created) is provided to the List operation,a single profile will be returned.
2. Search by Name: When a profile is created, a customer supplied name is assigned. Searching by the profilename (case-sensitive, no wildcards) is available.
3. User Preference: Filter the results by the providing the name (case-sensitive, no wildcards) of a userpreference.
4. Delivery: Filter the results by deliver mode (Email, HTTPCalBack, MQOutput), frequency (Immediate,Hourly, Daily, Weekly) or format (XML).
5. Date Range: The results can be narrowed by supplying a start and end date range which is comparedagainst the date a profile was created.
6. Stop Delivery: An option exists to disable notification delivery for a profile. Results can be filtered to includeor exclude profiles that have been stopped.
7. Status Filter: Profiles that are assigned a status of "Cancelled" remain in the Monitoring system for 24 hoursbefore being deleted. The results may be limited to a specific status.
8. Customer Reference Text: When a profile is created, a free form (240 character) field may be supplied. Thisfield may be used in the List operation; however, it is case-sensitive and there are no wildcard options.
9. Sorting Results: By default, the results will be ascending by ???. Optionally, both the sort direction and aprimary sort field can be designated on the request.
D&B Direct API Documentation How to Retrieve Notification Profiles
©Dun & Bradstreet, Inc. 2015 20
Sort field options include: DeliveryChannelUserPreferenceName, NotificationProfileID,NotificationProfileName, DeliveryMode, DeliveryFrequency, DeliveryFormat, StopDeliveryIndicator,NotificationProfileCreatedDate, NotificationProfileStatusText.
10. Pagination: Options exist to designate the maximum number of records per request, and the starting rownumber. The maximum number of records this feature will return on a single request is 1,000.
Business Elements
For each matching item, this feature will return the Notification Profile along with the date it was created.
Technical Specification
For details on how to access this feature, please refer to the Monitoring Service documentation.
D&B Direct API Documentation Business Elements
©Dun & Bradstreet, Inc. 2015 21
How to Retrieve Monitoring RegistrationsReturns the Monitoring Registration that match the criteria submitted with the request. If no criteria isspecified, all active registrations will be returned.
The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Numberand initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, orevents with data layer included.
Requirements & Options
There are several options available when implementing this D&B Direct feature.
1. D-U-N-S Number: Results can be filtered by the D-U-N-S Number supplied at registration OR the registeredD-U-N-S Number (in the case the trade-up option was chosen).
2. Profiles: Results can be filtered by providing the Profile ID(s) (the value returned when a profile is created) ofMonitoring or Notification Profiles..
3. List by Product: Monitoring is performed at the product level, and a product ID is specified when aMonitoring Profile is created. The results may be filtered by product ID.
4. Level Filter: The Monitoring feature offers two levels of change notices: Level Two provides the notice with acopy of the product data attached; Level One only provides the notice. The results may be filtered by the level.
5. Auto-Renewal: An option exists to designation a Monitoring Registration to be preserved when an annualcontract is renewed. Results can be filtered to include or exclude registrations that will auto-renew.
6. Subject Category: When a registration is created, a free form (32 character) field may be supplied. This fieldmay be used in the List operation; however, it is case-sensitive and there are no wildcard options.
7. Date Range: The results can be narrowed by supplying a start and end date range which is comparedagainst the date of registration.
8. Status Filter: Registrations that are assigned a status of "Cancelled" remain in the Monitoring system for 24hours before being deleted. The results may be limited to a specific status.
9. Customer Reference Text: When a registration is created, a free form (240 character) field may be supplied.This field may be used in the List operation; however, it is case-sensitive and there are no wildcard options.
10. Sorting Results: By default, the results will be ascending by ???. Optionally, both the sort direction and aprimary sort field can be designated on the request.
D&B Direct API Documentation How to Retrieve Monitoring Registrations
©Dun & Bradstreet, Inc. 2015 22
Sort field options include: DUNSNumber, CountryISOAlpha2Code, MonitoringProfileID, DNBProductID,MonitoringLevel, NotificationProfileID, RegistrationStartDate, SubjectCategoryText, AutoRenewalIndicator,MonitoringRegistrationStatusText.
11. Pagination: Options exist to designate the maximum number of records per request, and the starting rownumber. The maximum number of records this feature will return on a single request is 1,000.
Business Elements
For each matching item, this feature will return the Monitoring Registration along with the date it wasregistered, the status and the date when the monitoring will expire. If the auto-renewal option was selectedon the AddMonitoringRegistration request, the expiration date will be reset whenever the contract is renewed.
Technical Specification
For details on how to access this feature, please refer to the Monitoring Service documentation.
D&B Direct API Documentation Business Elements
©Dun & Bradstreet, Inc. 2015 23
Monitoring ServiceVersion 2.0 (API) / 4.1 (Service)
Functions
This D&B Direct service includes the following functionality. The respective SOAP and/or REST pages providetechnical details including input parameters, responses and sample requests.
Title / Overview Link Operation / SOAP Resource / REST
Field Monitoring Setup CreateMonitoringProfile() POST monitoring/monitoringprofiles
UpdateMonitoringProfile() PUT monitoring/monitoringprofiles/{MonitoringProfileID}
ListMonitoringProfile() GET monitoring/monitoringprofiles
Notification Setup (Push) CreateNotificationProfile() POST monitoring/notificationprofiles
UpdateNotificationProfile() PUT monitoring/notificationprofiles/{NotificationProfileID}
ListNotificationProfile() GET monitoring/notificationprofiles
Registration Maintenance AddMonitoringRegistration() POST monitoring/registrations
UpdateMonitoringRegistration()
PUT monitoring/registrations
ListMonitoringRegistration() GET monitoring/registrations
Notification Retrieval(Pull)
ListChangeNotice() GET monitoring/changenotices
GetMonitoringProduct() GET monitoring/organizations/{DUNS}/products/{productID}
The Notification Profile functions (Create/Update/List) provide maintenance capabilities for thePUSH component of monitoring registrations. The setup of user preferences will be required prior toestablishing notification profiles.
The Monitoring Profile functions (Create/Update/List) provide maintenance capabilities for the data fielddesignation component of monitoring registrations.
The Monitoring Registration functions (Add/Update/List) link together Notification and Monitoring profileswith the specific D-U-N-S Numbers that will be monitored.
The List Change Notice function is the PULL component of monitoring registrations (level 1 and 2), allowingfor access to change event details.
The Get Monitoring Product function is the PULL component of monitoring registrations (level 2 only),allowing for retrieval of data layers corresponding to change events.
D&B Direct API Documentation Monitoring Service
©Dun & Bradstreet, Inc. 2015 24
Interfaces & Endpoints
D&B Direct implements version control at the web service level, in addition to the API level. This D&B Direct2.0 {version} of the Monitoring Service is 4.1. When contacting D&B customer support, please provide both theAPI and Service version numbers. The following table(s) identify version-specific access points for the availableAPI interfaces.
SOAP
Endpoint https://maxcvservices.dnb.com/Monitoring/V{version}
WSDL* http://developer.dnb.com/docs/2.0/monitoring/4.1/MonitoringServiceV41.zip
*There may be operations defined in the WSDL that are not available to D&B Direct customers at this time.
REST
CreateMonitoringProfile() POST https://maxcvservices.dnb.com/V{version}/monitoring/monitoringprofiles
UpdateMonitoringProfile() PUT https://maxcvservices.dnb.com/V{version}/monitoring/monitoringprofiles/{MonitoringProfileID}
ListMonitoringProfile() GET https://maxcvservices.dnb.com/V{version}/monitoring/monitoringprofiles
CreateNotificationProfile() POST https://maxcvservices.dnb.com/V{version}/monitoring/notificationprofiles
UpdateNotificationProfile() PUT https://maxcvservices.dnb.com/V{version}/monitoring/notificationprofiles/{NotificationProfileID}
ListNotificationProfile() GET https://maxcvservices.dnb.com/V{version}/monitoring/notificationprofiles
AddMonitoringRegistration() POST https://maxcvservices.dnb.com/V{version}/monitoring/registrations
UpdateMonitoringRegistration()
PUT https://maxcvservices.dnb.com/V{version}/monitoring/registrations
ListMonitoringRegistration() GET https://maxcvservices.dnb.com/V{version}/monitoring/registrations
ListChangeNotice() GET https://maxcvservices.dnb.com/V{version}/monitoring/changenotices
GetMonitoringProduct() GET https://maxcvservices.dnb.com/V{version}/monitoring/organizations/{DUNS}/products/{productID}
D&B Direct API calls must be made using Secured Socket Layers (SSL) as reflected in the preceding table(s).
D&B Direct API Documentation Interfaces & Endpoints
©Dun & Bradstreet, Inc. 2015 25
CreateMonitoringProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Monitoring Profile establishes the specific data fields within a given data layer that should be monitored,and the conditions under which a change event should be triggered.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
POST https://maxcvservices.dnb.com/V{version}/monitoring/monitoringprofiles
Request Parameters
The following parameters are accepted by this operation. Please refer to the list of products that may beincluded in the Monitoring process.
When providing PCMElementXPATHText values, the format should be "//Organization/..." WITHOUT anyspaces. Some data elements may only be monitored by the associated aggregate or attribute XPATH.
Example:
As displayed in documentation Value in PCMElementXPATHText
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Events { PublicFilingHeader { DisclaimerText
//Organization /Events /PublicFilingHeader/DisclaimerText
The Monitoring process triggers events based on the old and new data field values WHEN A CHANGE OCCURS,and is not based on the data layer values when the Monitoring Registration was created. To capturecumulative but gradual changes, using the "ValueGoesBeyond" or "ValueGoesBelow" conditions isrecommended.
Developers may now add entries to Monitoring Profiles that specify the combination(s) of XPATH + attributethat they wish to Monitor. This is accomplished by appending an attribute statement to the XPATH within theCreateMonitoringProfile request. The statement may include multiple values for the attribute by using an OR("||") operator.
D&B Direct API Documentation CreateMonitoringProfile (REST)
©Dun & Bradstreet, Inc. 2015 26
<MonitoringElement><PCMElementXPATHText>//Organization/Events/LegalEvents/OtherLegalEv
entInformation/OtherLegalEvent[FilingTypeText@DNBCodeValue=8035]</PCMElementXPATHText>
<MonitoringChanges><ChangeCondition>AnyChange</ChangeCondition><ChangeValue>10</ChangeValue>
</MonitoringChanges></MonitoringElement>
<MonitoringElement><PCMElementXPATHText>//Organization/Events/SignificantEvents/Specia
lEvent[EventSubTypeText@DNBCodeValue=12317 || EventSubTypeText@DNBCodeValue=15378 || EventTypeText@DNBCodeValue=28227 || EventSubTypeText@DNBCodeValue=4073]</PCMElementXPATHText>
<MonitoringChanges><ChangeCondition>AnyChange</ChangeCondition><ChangeValue>10</ChangeValue>
</MonitoringChanges></MonitoringElement>
Note: The combination of attributes may NOT contain duplicate references to the same attribute.
Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST followthe order presented in this section. This applies to REST calls only.
Restriction: For POST/PUT requests, the ‘Accept’ header item should be set to ‘application/json’ or be leftempty. If the value submitted is ‘*/*’, the service will return an error. This applies to REST calls only.
Restriction: An XML namespace statement MUST be included as the first statement within the primaryAggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.
Restriction: In addition to the previous restriction, the statement listing the primary Aggregate MUST beprefixed with the corresponding namespace. Please refer to the Sample Request for an example.
Name Characteristics
CreateMonitoringProfileRequest Aggregate
CreateMonitoringProfileRequest@ServiceVersionNumber Attribute
CreateMonitoringProfileRequest@xsi:schemaLocation Attribute
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 27
Name Characteristics
CreateMonitoringProfileRequest { TransactionDetail Aggregate, Optional
Records information necessary to process this request.
CreateMonitoringProfileRequest { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
CreateMonitoringProfileRequest { TransactionDetail { 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.
CreateMonitoringProfileRequest { TransactionDetail { 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.
END: CreateMonitoringProfileRequest } TransactionDetail /Aggregate
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail
Aggregate, Required
Records details of the request to create a profile, a set of
events and their thresholds, used to monitor a DUNS or a
set of DUNS.
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification
Aggregate, Required
Records the preferences provided by the Customer/User on
the monitoring parameters while enrolling for the
monitoring service.
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Required
A name that is provided by the user to the profile.
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringProfileDescription
string up to 256 chars., Optional
A string that records the description of the profile
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 28
Name Characteristics
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { DNBProductID
string up to 64 chars., Required
Records the product code that is provided by the customer
to create a profile
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringLevel
MonitoringLevelTextEnum up to 16 chars., Required
A alphanumeric string which determines the level of details
that the customer will receive during a change event
Possible values: Level1; Level2. Level2 provides change event
notices along with a copy of the data layer; while Level1 only
provides the notices.
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail
Aggregate, Optional
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail{ MonitoringElement
Aggregate, Required (Infinite)
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail{ MonitoringElement { PCMElementXPATHText
string up to 3000 chars., Required
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail{ MonitoringElement { MonitoringChanges
Aggregate, Required (Infinite)
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail{ MonitoringElement { MonitoringChanges { ChangeCondition
ChangeConditionEnum, Required
Possible values: AnyChange; ValueIncreaseByPercentage;
ValueDecreaseByPercentage; ValueChangeByPercentage;
ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy;
ValueGoesBeyond; ValueGoesBelow; ValueEquals;
DateChangeBy; DateEquals
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail{ MonitoringElement { MonitoringChanges { ChangeValue
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
END: CreateMonitoringProfileRequest }CreateMonitoringProfileRequestDetail }MonitoringProfileSpecification } MonitoringElementDetail} MonitoringElement } MonitoringChanges
/Aggregate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 29
Name Characteristics
END: CreateMonitoringProfileRequest }CreateMonitoringProfileRequestDetail }MonitoringProfileSpecification } MonitoringElementDetail} MonitoringElement
/Aggregate
END: CreateMonitoringProfileRequest }CreateMonitoringProfileRequestDetail }MonitoringProfileSpecification } MonitoringElementDetail
/Aggregate
END: CreateMonitoringProfileRequest }CreateMonitoringProfileRequestDetail }MonitoringProfileSpecification
/Aggregate
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail{ ReturnChangedDataOnlyIndicator
boolean
When 'true' indicates that Change Notices will only include
information for fields whose value has changed. When
'false' indicates that Change Notices will include
information for all fields, regardless if the values have
changed. The latter scenario applies when a whole data
layer and/or aggregate is being monitored.
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to support
subsequent order reconciliation.
CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { InquiryReferenceText { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
END: CreateMonitoringProfileRequest }CreateMonitoringProfileRequestDetail }InquiryReferenceText
/Aggregate
END: CreateMonitoringProfileRequest }CreateMonitoringProfileRequestDetail
/Aggregate
END: CreateMonitoringProfileRequest /Aggregate
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
A static change notice will be generated regardless of the conditions/values specified in test MonitoringProfiles.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 30
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
CreateMonitoringProfileResponse Aggregate
CreateMonitoringProfileResponse@ServiceVersionNumber Attribute
CreateMonitoringProfileResponse@xsi:schemaLocation Attribute
CreateMonitoringProfileResponse { TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
CreateMonitoringProfileResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
CreateMonitoringProfileResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify
this transaction.
CreateMonitoringProfileResponse { 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: CreateMonitoringProfileResponse } TransactionDetail /Aggregate
CreateMonitoringProfileResponse { TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record the
different outcomes of the transaction.
CreateMonitoringProfileResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 31
Name Characteristics
CreateMonitoringProfileResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
CreateMonitoringProfileResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
CreateMonitoringProfileResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
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.
CreateMonitoringProfileResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding
the outcome of the transaction.
END: CreateMonitoringProfileResponse }TransactionResult } ResultMessage
/Aggregate
END: CreateMonitoringProfileResponse }TransactionResult
/Aggregate
CreateMonitoringProfileResponse { CreateMonitoringProfileResponseDetail
Aggregate, Optional
Records the details of events and their thresholds, set to
the profile to monitor a DUNS or a set of DUNS.
CreateMonitoringProfileResponse { CreateMonitoringProfileResponseDetail { MonitoringProfileDetail
Aggregate, Required
Records the preferences set on the monitoring
parameters enrolled for the monitoring service.
CreateMonitoringProfileResponse { CreateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required
A name that is provided by the user to the profile.
CreateMonitoringProfileResponse { CreateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 32
Name Characteristics
END: CreateMonitoringProfileResponse }CreateMonitoringProfileResponseDetail }MonitoringProfileDetail
/Aggregate
CreateMonitoringProfileResponse { CreateMonitoringProfileResponseDetail { InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to support
subsequent order reconciliation.
CreateMonitoringProfileResponse { CreateMonitoringProfileResponseDetail { InquiryReferenceText { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to
be linked to the product in order to support subsequent
order reconciliation.
END: CreateMonitoringProfileResponse }CreateMonitoringProfileResponseDetail }InquiryReferenceText
/Aggregate
END: CreateMonitoringProfileResponse }CreateMonitoringProfileResponseDetail
/Aggregate
END: CreateMonitoringProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM001, CM002, CM004, CM007, CM014, CM023,SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 Blank value passed for PCMElementXpath
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present in the request,Sequence of the element is not matching in the schema, Data type mismatch or Invalid notification Level).
CM007 PCMElementXpath does not belong to the Product; or Invalid Change Value (Alert threshold)
CM014 Product Not available
CM023 Duplicate Profile Name
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 33
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
UpdateMonitoringProfile (REST), ListMonitoringProfile (REST), Available Products.
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 34
CreateMonitoringProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Monitoring Profile establishes the specific data fields within a given data layer that should be monitored,and the conditions under which a change event should be triggered.
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
The following parameters are accepted by this operation. Please refer to the list of products that may beincluded in the Monitoring process.
When providing PCMElementXPATHText values, the format should be "//Organization/..." WITHOUT anyspaces. Some data elements may only be monitored by the associated aggregate or attribute XPATH.
Example:
As displayed in documentation Value in PCMElementXPATHText
OrderProductResponse. OrderProductResponseDetail.Product. Organization. Events. PublicFilingHeader.DisclaimerText
//Organization /Events /PublicFilingHeader/DisclaimerText
The Monitoring process triggers events based on the old and new data field values WHEN A CHANGE OCCURS,and is not based on the data layer values when the Monitoring Registration was created. To capturecumulative but gradual changes, using the "ValueGoesBeyond" or "ValueGoesBelow" conditions isrecommended.
Developers may now add entries to Monitoring Profiles that specify the combination(s) of XPATH + attributethat they wish to Monitor. This is accomplished by appending an attribute statement to the XPATH within theCreateMonitoringProfile request. The statement may include multiple values for the attribute by using an OR("||") operator.
D&B Direct API Documentation CreateMonitoringProfile (SOAP)
©Dun & Bradstreet, Inc. 2015 35
<MonitoringElement><PCMElementXPATHText>//Organization/Events/LegalEvents/OtherLegalEv
entInformation/OtherLegalEvent[FilingTypeText@DNBCodeValue=8035]</PCMElementXPATHText>
<MonitoringChanges><ChangeCondition>AnyChange</ChangeCondition><ChangeValue>10</ChangeValue>
</MonitoringChanges></MonitoringElement>
<MonitoringElement><PCMElementXPATHText>//Organization/Events/SignificantEvents/Specia
lEvent[EventSubTypeText@DNBCodeValue=12317 || EventSubTypeText@DNBCodeValue=15378 || EventTypeText@DNBCodeValue=28227 || EventSubTypeText@DNBCodeValue=4073]</PCMElementXPATHText>
<MonitoringChanges><ChangeCondition>AnyChange</ChangeCondition><ChangeValue>10</ChangeValue>
</MonitoringChanges></MonitoringElement>
Note: The combination of attributes may NOT contain duplicate references to the same attribute.
Name Characteristics
CreateMonitoringProfileRequest Aggregate
CreateMonitoringProfileRequest@ServiceVersionNumber
CreateMonitoringProfileRequest@xsi:schemaLocation
CreateMonitoringProfileRequest.TransactionDetail
Aggregate, Optional
Records information necessary to process this request.
CreateMonitoringProfileRequest.TransactionDetail. ApplicationTransactionID
string, up to 64 chars, Optional
A number assigned by the calling application to uniquely identify this
request.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 36
Name Characteristics
CreateMonitoringProfileRequest.TransactionDetail. TransactionTimestamp
dateTime, 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.
CreateMonitoringProfileRequest.TransactionDetail. 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.
END: CreateMonitoringProfileRequest.TransactionDetail
/Aggregate
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail
Aggregate, Required
Records details of the request to create a profile, a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification
Aggregate, Required
Records the preferences provided by the Customer/User on the
monitoring parameters while enrolling for the monitoring service.
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringProfileName
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Required
A name that is provided by the user to the profile.
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringProfileDescription
string, up to 256 chars, Optional
A string that records the description of the profile
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.DNBProductID
string, up to 64 chars, Required
Records the product code that is provided by the customer to create a
profile
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringLevel
MonitoringLevelTextEnum up to 16 chars, Required
A alphanumeric string which determines the level of details that the
customer will receive during a change event
Possible values: Level1; Level2. Level2 provides change event notices along
with a copy of the data layer; while Level1 only provides the notices.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 37
Name Characteristics
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringElementDetail
Aggregate, Optional
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringElementDetail.MonitoringElement
Aggregate, Required (Infinite)
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringElementDetail.MonitoringElement.PCMElementXPATHText
string, up to 3000 chars, Required
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringElementDetail.MonitoringElement. MonitoringChanges
Aggregate, Required (Infinite)
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringElementDetail.MonitoringElement. MonitoringChanges.ChangeCondition
ChangeConditionEnum, Required
Possible values: AnyChange; ValueIncreaseByPercentage;
ValueDecreaseByPercentage; ValueChangeByPercentage;
ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond;
ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringElementDetail.MonitoringElement. MonitoringChanges.ChangeValue
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringElementDetail.MonitoringElement. MonitoringChanges
/Aggregate
END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringElementDetail.MonitoringElement
/Aggregate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 38
Name Characteristics
END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringElementDetail.MonitoringElement
/Aggregate
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringElementDetail.ReturnChangedDataOnlyIndicator
boolean
When 'true' indicates that Change Notices will only include information
for fields whose value has changed. When 'false' indicates that Change
Notices will include information for all fields, regardless if the values have
changed. The latter scenario applies when a whole data layer and/or
aggregate is being monitored.
END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification
/Aggregate
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information to be linked
to the request in order to support subsequent order reconciliation.
CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.InquiryReferenceText.CustomerReferenceText
string, up to 240 chars, Optional (Up to 5x)
A freeform reference string provided by the customer to be linked to the
product in order to support subsequent order reconciliation.
END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.InquiryReferenceText
/Aggregate
END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail
/Aggregate
END: CreateMonitoringProfileRequest /Aggregate
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
A static change notice will be generated regardless of the conditions/values specified in test MonitoringProfiles.
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 39
Name Characteristics
CreateMonitoringProfileResponse Aggregate
CreateMonitoringProfileResponse@ServiceVersionNumber Attribute
CreateMonitoringProfileResponse@xsi:schemaLocation Attribute
CreateMonitoringProfileResponse. TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
CreateMonitoringProfileResponse. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
CreateMonitoringProfileResponse. TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify
this transaction.
CreateMonitoringProfileResponse. 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: CreateMonitoringProfileResponse. TransactionDetail /Aggregate
CreateMonitoringProfileResponse. TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record the
different outcomes of the transaction.
CreateMonitoringProfileResponse. TransactionResult.SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
CreateMonitoringProfileResponse. TransactionResult.ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 40
Name Characteristics
CreateMonitoringProfileResponse. TransactionResult.ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
CreateMonitoringProfileResponse. TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
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.
CreateMonitoringProfileResponse. TransactionResult.ResultMessage. ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding
the outcome of the transaction.
END: CreateMonitoringProfileResponse. TransactionResult.ResultMessage
/Aggregate
END: CreateMonitoringProfileResponse. TransactionResult /Aggregate
CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail
Aggregate, Optional
Records the details of events and their thresholds, set to
the profile to monitor a DUNS or a set of DUNS.
CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.MonitoringProfileDetail
Aggregate, Required
Records the preferences set on the monitoring
parameters enrolled for the monitoring service.
CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required
A name that is provided by the user to the profile.
CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
END: CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.MonitoringProfileDetail
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 41
Name Characteristics
CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to support
subsequent order reconciliation.
CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.InquiryReferenceText. CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to
be linked to the product in order to support subsequent
order reconciliation.
END: CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.InquiryReferenceText
/Aggregate
END: CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail
/Aggregate
END: CreateMonitoringProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM001, CM002, CM004, CM007, CM014, CM023,SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 Blank value passed for PCMElementXpath
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present in the request,Sequence of the element is not matching in the schema, Data type mismatch or Invalid notification Level).
CM007 PCMElementXpath does not belong to the Product; or Invalid Change Value (Alert threshold)
CM014 Product Not available
CM023 Duplicate Profile Name
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 42
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
UpdateMonitoringProfile (SOAP), ListMonitoringProfile (SOAP), Available Products.
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 43
UpdateMonitoringProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Monitoring Profile establishes the specific data fields within a given data layer that should be monitored,and the conditions under which a change event should be triggered.
Monitoring Profiles can be removed by setting the status to Cancelled; however, if the profile is referenced in aMonitoring Registration it may not be removed. Cancelled items can be restored within 24-hours of theupdate, after which they are deleted.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
PUT https://maxcvservices.dnb.com/V{version}/monitoring/monitoringprofiles/{MonitoringProfileID}
Request Parameters
The following parameter(s) are required in the endpoint.
Name Characteristics
{MonitoringProfileID} int, Required
A number that
uniquely
identifies a set
of events and
their
thresholds,
used to
monitor a
DUNS or a set
of DUNS.
When providing PCMElementXPATHText values, the format should be "//Organization/..." WITHOUT anyspaces. Some data elements may only be monitored by the associated aggregate or attribute XPATH.
D&B Direct API Documentation UpdateMonitoringProfile (REST)
©Dun & Bradstreet, Inc. 2015 44
Example:
As displayed in documentation Value in PCMElementXPATHText
OrderProductResponse { OrderProductResponseDetail { Product { Organization { Events { PublicFilingHeader { DisclaimerText
//Organization /Events /PublicFilingHeader/DisclaimerText
The following parameters are accepted by this operation.
Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST followthe order presented in this section. This applies to REST calls only.
Restriction: For POST/PUT requests, the ‘Accept’ header item should be set to ‘application/json’ or be leftempty. If the value submitted is ‘*/*’, the service will return an error. This applies to REST calls only.
Restriction: An XML namespace statement MUST be included as the first statement within the primaryAggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.
Restriction: In addition to the previous restriction, the statement listing the primary Aggregate MUST beprefixed with the corresponding namespace. Please refer to the Sample Request for an example.
Name Characteristics
UpdateMonitoringProfileRequest Aggregate
UpdateMonitoringProfileRequest@ServiceVersionNumber Attribute
UpdateMonitoringProfileRequest@xsi:schemaLocation Attribute
UpdateMonitoringProfileRequest { TransactionDetail Aggregate, Optional
Records information necessary to process this request.
UpdateMonitoringProfileRequest { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
UpdateMonitoringProfileRequest { TransactionDetail { 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.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 45
Name Characteristics
UpdateMonitoringProfileRequest { TransactionDetail { 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.
END: UpdateMonitoringProfileRequest } TransactionDetail /Aggregate
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail
Aggregate, Required
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileDetail
Aggregate, Required
END: UpdateMonitoringProfileRequest }UpdateMonitoringProfileRequestDetail }MonitoringProfileDetail
/Aggregate
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification
Aggregate, Required
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
A name that is provided by the user to the profile.
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail
Aggregate, Optional
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement
Aggregate, Required (Infinite)
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { PCMElementXPATHText
string up to 3000 chars., Required
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { MonitoringChanges
Aggregate, Required (Infinite)
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 46
Name Characteristics
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeCondition
ChangeConditionEnum, Required
Possible values: AnyChange; ValueIncreaseByPercentage;
ValueDecreaseByPercentage; ValueChangeByPercentage;
ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy;
ValueGoesBeyond; ValueGoesBelow; ValueEquals;
DateChangeBy; DateEquals
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeValue
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
END: UpdateMonitoringProfileRequest }UpdateMonitoringProfileRequestDetail }MonitoringProfileUpdateSpecification }MonitoringElementDetail } MonitoringElement }MonitoringChanges
/Aggregate
END: UpdateMonitoringProfileRequest }UpdateMonitoringProfileRequestDetail }MonitoringProfileUpdateSpecification }MonitoringElementDetail } MonitoringElement
/Aggregate
END: UpdateMonitoringProfileRequest }UpdateMonitoringProfileRequestDetail }MonitoringProfileUpdateSpecification }MonitoringElementDetail
/Aggregate
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringProfileStatusText
MonitoringProfileStatusTextEnum, Optional
Records the status of the monitoring profile
Possible values: Active; Cancelled
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail{ ReturnChangedDataOnlyIndicator
boolean
When 'true' indicates that Change Notices will only include
information for fields whose value has changed. When
'false' indicates that Change Notices will include
information for all fields, regardless if the values have
changed. The latter scenario applies when a whole data
layer and/or aggregate is being monitored.
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to support
subsequent order reconciliation.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 47
Name Characteristics
UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { InquiryReferenceText { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
END: UpdateMonitoringProfileRequest }UpdateMonitoringProfileRequestDetail }MonitoringProfileUpdateSpecification }InquiryReferenceText
/Aggregate
END: UpdateMonitoringProfileRequest }UpdateMonitoringProfileRequestDetail }MonitoringProfileUpdateSpecification
/Aggregate
END: UpdateMonitoringProfileRequest }UpdateMonitoringProfileRequestDetail
/Aggregate
END: UpdateMonitoringProfileRequest /Aggregate
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
UpdateMonitoringProfileResponse Aggregate
UpdateMonitoringProfileResponse@ServiceVersionNumber
UpdateMonitoringProfileResponse@xsi:schemaLocation
UpdateMonitoringProfileResponse { TransactionDetail
Aggregate, Required
Records information necessary to process a particular request.
Examples of a request is the ordering of a product.
UpdateMonitoringProfileResponse { TransactionDetail { ApplicationTransactionID
string, up to 64 chars, Optional
A number assigned by the calling application to uniquely identify this
request.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 48
Name Characteristics
UpdateMonitoringProfileResponse { TransactionDetail { ServiceTransactionID
string, up to 64 chars, Required
A number assigned by the D&B service to uniquely identify this
transaction.
UpdateMonitoringProfileResponse { TransactionDetail { TransactionTimestamp
dateTime, 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: UpdateMonitoringProfileResponse }TransactionDetail
/Aggregate
UpdateMonitoringProfileResponse { TransactionResult
Aggregate, Required
An aggregate that can repeat multiple times to record the different
outcomes of the transaction.
UpdateMonitoringProfileResponse { TransactionResult { SeverityText
string, up to 16 chars, Required
Text that records the criticality of the outcome, e.g., Information,
Warning, Error, Fatal.
UpdateMonitoringProfileResponse { TransactionResult { ResultID
string, up to 32 chars, Required
An alphanumeric string that uniquely identifies the outcome of the
transaction.
UpdateMonitoringProfileResponse { TransactionResult { ResultText
string, up to 512 chars, Optional
Text that explains the outcome of the transaction.
UpdateMonitoringProfileResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
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.
UpdateMonitoringProfileResponse { TransactionResult { ResultMessage { ResultDescription
string, up to 512 chars, Required
Text that describes the additional information regarding the
outcome of the transaction.
END: UpdateMonitoringProfileResponse }TransactionResult } ResultMessage
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 49
Name Characteristics
END: UpdateMonitoringProfileResponse }TransactionResult
/Aggregate
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail
Aggregate, Optional
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail
Aggregate, Optional
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileID
integer, Required
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileName
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Required
A name that is provided by the user to the profile.
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail
Aggregate, Optional
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement
Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement{ PCMElementXPATHText
string, up to 3000 chars, Required
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement{ MonitoringChanges
Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement{ MonitoringChanges { ChangeCondition
ChangeConditionEnum, Required
Possible values: AnyChange; ValueIncreaseByPercentage;
ValueDecreaseByPercentage; ValueChangeByPercentage;
ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy;
ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy;
DateEquals
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement{ MonitoringChanges { ChangeValue
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 50
Name Characteristics
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail }MonitoringElementDetail } MonitoringElement }MonitoringChanges
/Aggregate
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail }MonitoringElementDetail } MonitoringElement
/Aggregate
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail }MonitoringElementDetail
/Aggregate
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileStatusText
MonitoringProfileStatusTextEnum, Optional
Records the status of the monitoring profile
Possible values: Active; Cancelled
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information to be
linked to the request in order to support subsequent order
reconciliation.
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { InquiryReferenceText { CustomerReferenceText
string, up to 240 chars, Optional (Up to 5x)
A freeform reference string provided by the customer to be linked to
the product in order to support subsequent order reconciliation.
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail } InquiryReferenceText
/Aggregate
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail
Aggregate, Optional
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringProfileName
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
A name that is provided by the user to the profile.
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail
Aggregate, Optional
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 51
Name Characteristics
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement
Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement{ PCMElementXPATHText
string, up to 3000 chars, Required
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement{ MonitoringChanges
Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement{ MonitoringChanges { ChangeCondition
ChangeConditionEnum, Required
Possible values: AnyChange; ValueIncreaseByPercentage;
ValueDecreaseByPercentage; ValueChangeByPercentage;
ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy;
ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy;
DateEquals
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement{ MonitoringChanges { ChangeValue
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail }FormerMonitoringProfileDetail }MonitoringElementDetail } MonitoringElement }MonitoringChanges
/Aggregate
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail }FormerMonitoringProfileDetail }MonitoringElementDetail } MonitoringElement
/Aggregate
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail }FormerMonitoringProfileDetail }MonitoringElementDetail
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 52
Name Characteristics
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringProfileStatusText
MonitoringProfileStatusTextEnum, Optional
Records the status of the monitoring profile
Possible values: Active; Cancelled
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { ReturnChangedDataOnlyIndicator
boolean
When 'true' indicates that Change Notices will only include
information for fields whose value has changed. When 'false'
indicates that Change Notices will include information for all fields,
regardless if the values have changed. The latter scenario applies
when a whole data layer and/or aggregate is being monitored.
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information to be
linked to the request in order to support subsequent order
reconciliation.
UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { InquiryReferenceText { CustomerReferenceText
string, up to 240 chars, Optional (Up to 5x)
A freeform reference string provided by the customer to be linked to
the product in order to support subsequent order reconciliation.
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail }FormerMonitoringProfileDetail }InquiryReferenceText
/Aggregate
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail }FormerMonitoringProfileDetail
/Aggregate
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail
/Aggregate
END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail
/Aggregate
END: UpdateMonitoringProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded using
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 53
the ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM001, CM002, CM004, CM007, CM023, MN001,MN004, SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 Profile name is sent as blank; or Blank value passed for PCMElementXpath.
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present inthe request, Sequence of the element is not matching in the schema, Data type mismatch orInvalid notification Level).
CM007 Monitoring profile cannot be canceled as registrations are available for this profile; Monitoringprofile ID not available in the system; Invalid Change Value (Alert threshold); or PCMElementXpathdoes not belong to the Product.
CM023 Duplicate Profile Name
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
CreateMonitoringProfile (REST), ListMonitoringProfile (REST).
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2015 54
UpdateMonitoringProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Monitoring Profile establishes the specific data fields within a given data layer that should be monitored,and the conditions under which a change event should be triggered.
Monitoring Profiles can be removed by setting the status to Cancelled; however, if the profile is referenced in aMonitoring Registration it may not be removed. Cancelled items can be restored within 24-hours of theupdate, after which they are deleted.
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
When providing PCMElementXPATHText values, the format should be "//Organization/..." WITHOUT anyspaces. Some data elements may only be monitored by the associated aggregate or attribute XPATH.
Example:
As displayed in documentation Value in PCMElementXPATHText
OrderProductResponse. OrderProductResponseDetail.Product. Organization. Events. PublicFilingHeader.DisclaimerText
//Organization /Events /PublicFilingHeader/DisclaimerText
The following parameters are accepted by this operation.
Name Characteristics
UpdateMonitoringProfileRequest Aggregate
UpdateMonitoringProfileRequest@ServiceVersionNumber
UpdateMonitoringProfileRequest@xsi:schemaLocation
D&B Direct API Documentation UpdateMonitoringProfile (SOAP)
©Dun & Bradstreet, Inc. 2015 55
Name Characteristics
UpdateMonitoringProfileRequest.TransactionDetail
Aggregate, Optional
Records information necessary to process this request.
UpdateMonitoringProfileRequest.TransactionDetail. ApplicationTransactionID
string, up to 64 chars, Optional
A number assigned by the calling application to uniquely identify this
request.
UpdateMonitoringProfileRequest.TransactionDetail. TransactionTimestamp
dateTime, 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.
UpdateMonitoringProfileRequest.TransactionDetail. 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.
END: UpdateMonitoringProfileRequest.TransactionDetail
/Aggregate
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail
Aggregate, Required
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileDetail
Aggregate, Required
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileDetail. MonitoringProfileID
integer, Required
A number that uniquely identifies a set of events and their thresholds,
used to monitor a DUNS or a set of DUNS.
END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileDetail
/Aggregate
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification
Aggregate, Required
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringProfileName
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
A name that is provided by the user to the profile.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 56
Name Characteristics
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail
Aggregate, Optional
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail.MonitoringElement
Aggregate, Required (Infinite)
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail.MonitoringElement. PCMElementXPATHText
string, up to 3000 chars, Required
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail.MonitoringElement. MonitoringChanges
Aggregate, Required (Infinite)
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail.MonitoringElement. MonitoringChanges.ChangeCondition
ChangeConditionEnum, Required
Possible values: AnyChange; ValueIncreaseByPercentage;
ValueDecreaseByPercentage; ValueChangeByPercentage;
ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond;
ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail.MonitoringElement. MonitoringChanges.ChangeValue
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail.MonitoringElement. MonitoringChanges
/Aggregate
END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail.MonitoringElement
/Aggregate
END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail
/Aggregate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 57
Name Characteristics
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringProfileStatusText
MonitoringProfileStatusTextEnum, Optional
Records the status of the monitoring profile
Possible values: Active; Cancelled
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.ReturnChangedDataOnlyIndicator
boolean
When 'true' indicates that Change Notices will only include information
for fields whose value has changed. When 'false' indicates that Change
Notices will include information for all fields, regardless if the values
have changed. The latter scenario applies when a whole data layer
and/or aggregate is being monitored.
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information to be
linked to the request in order to support subsequent order reconciliation.
UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.InquiryReferenceText.CustomerReferenceText
string, up to 240 chars, Optional (Up to 5x)
A freeform reference string provided by the customer to be linked to the
product in order to support subsequent order reconciliation.
END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.InquiryReferenceText
/Aggregate
END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification
/Aggregate
END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail
/Aggregate
END: UpdateMonitoringProfileRequest /Aggregate
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 58
Name Characteristics
UpdateMonitoringProfileResponse Aggregate
UpdateMonitoringProfileResponse@ServiceVersionNumber
UpdateMonitoringProfileResponse@xsi:schemaLocation
UpdateMonitoringProfileResponse.TransactionDetail
Aggregate, Required
Records information necessary to process a particular request.
Examples of a request is the ordering of a product.
UpdateMonitoringProfileResponse.TransactionDetail. ApplicationTransactionID
string, up to 64 chars, Optional
A number assigned by the calling application to uniquely identify this
request.
UpdateMonitoringProfileResponse.TransactionDetail. ServiceTransactionID
string, up to 64 chars, Required
A number assigned by the D&B service to uniquely identify this
transaction.
UpdateMonitoringProfileResponse.TransactionDetail. TransactionTimestamp
dateTime, 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: UpdateMonitoringProfileResponse.TransactionDetail
/Aggregate
UpdateMonitoringProfileResponse.TransactionResult
Aggregate, Required
An aggregate that can repeat multiple times to record the different
outcomes of the transaction.
UpdateMonitoringProfileResponse.TransactionResult. SeverityText
string, up to 16 chars, Required
Text that records the criticality of the outcome, e.g., Information,
Warning, Error, Fatal.
UpdateMonitoringProfileResponse.TransactionResult. ResultID
string, up to 32 chars, Required
An alphanumeric string that uniquely identifies the outcome of the
transaction.
UpdateMonitoringProfileResponse.TransactionResult. ResultText
string, up to 512 chars, Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 59
Name Characteristics
UpdateMonitoringProfileResponse.TransactionResult. ResultMessage
Aggregate, Optional (Infinite)
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.
UpdateMonitoringProfileResponse.TransactionResult. ResultMessage.ResultDescription
string, up to 512 chars, Required
Text that describes the additional information regarding the outcome
of the transaction.
END: UpdateMonitoringProfileResponse.TransactionResult. ResultMessage
/Aggregate
END: UpdateMonitoringProfileResponse.TransactionResult
/Aggregate
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail
Aggregate, Optional
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail
Aggregate, Optional
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringProfileID
integer, Required
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringProfileName
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Required
A name that is provided by the user to the profile.
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail
Aggregate, Optional
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail. MonitoringElement
Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.PCMElementXPATHText
string, up to 3000 chars, Required
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 60
Name Characteristics
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges
Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges. ChangeCondition
ChangeConditionEnum, Required
Possible values: AnyChange; ValueIncreaseByPercentage;
ValueDecreaseByPercentage; ValueChangeByPercentage;
ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy;
ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy;
DateEquals
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges. ChangeValue
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges
/Aggregate
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail. MonitoringElement
/Aggregate
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail
/Aggregate
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringProfileStatusText
MonitoringProfileStatusTextEnum, Optional
Records the status of the monitoring profile
Possible values: Active; Cancelled
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information to be
linked to the request in order to support subsequent order
reconciliation.
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. InquiryReferenceText.CustomerReferenceText
string, up to 240 chars, Optional (Up to 5x)
A freeform reference string provided by the customer to be linked to
the product in order to support subsequent order reconciliation.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 61
Name Characteristics
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. InquiryReferenceText
/Aggregate
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail
Aggregate, Optional
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringProfileName
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
A name that is provided by the user to the profile.
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringElementDetail
Aggregate, Optional
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement
Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.PCMElementXPATHText
string, up to 3000 chars, Required
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges
Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges. ChangeCondition
ChangeConditionEnum, Required
Possible values: AnyChange; ValueIncreaseByPercentage;
ValueDecreaseByPercentage; ValueChangeByPercentage;
ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy;
ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy;
DateEquals
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 62
Name Characteristics
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges. ChangeValue
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges
/Aggregate
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement
/Aggregate
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringElementDetail
/Aggregate
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.MonitoringProfileStatusText
MonitoringProfileStatusTextEnum, Optional
Records the status of the monitoring profile
Possible values: Active; Cancelled
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.ReturnChangedDataOnlyIndicator
boolean
When 'true' indicates that Change Notices will only include
information for fields whose value has changed. When 'false'
indicates that Change Notices will include information for all fields,
regardless if the values have changed. The latter scenario applies
when a whole data layer and/or aggregate is being monitored.
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information to be
linked to the request in order to support subsequent order
reconciliation.
UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.InquiryReferenceText. CustomerReferenceText
string, up to 240 chars, Optional (Up to 5x)
A freeform reference string provided by the customer to be linked to
the product in order to support subsequent order reconciliation.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 63
Name Characteristics
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail.InquiryReferenceText
/Aggregate
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail.FormerMonitoringProfileDetail
/Aggregate
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail
/Aggregate
END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail
/Aggregate
END: UpdateMonitoringProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM001, CM002, CM004, CM007, CM023, MN001,MN004, SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 Profile name is sent as blank; or Blank value passed for PCMElementXpath.
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present inthe request, Sequence of the element is not matching in the schema, Data type mismatch orInvalid notification Level).
CM007 Monitoring profile cannot be canceled as registrations are available for this profile; Monitoringprofile ID not available in the system; Invalid Change Value (Alert threshold); or PCMElementXpathdoes not belong to the Product.
CM023 Duplicate Profile Name
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 64
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
CreateMonitoringProfile (SOAP), ListMonitoringProfile (SOAP).
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 65
ListMonitoringProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Monitoring Profile establishes the specific data fields within a given data layer that should be monitored,and the conditions under which a change event should be triggered.
Refer to How to Retrieve Monitoring Profiles for an overview of this operation.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
GET https://maxcvservices.dnb.com/V{version}/monitoring/monitoringprofiles
Request Parameters
The following parameters are accepted by this operation.
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.
D&B Direct API Documentation ListMonitoringProfile (REST)
©Dun & Bradstreet, Inc. 2015 66
Name Characteristics
MonitoringProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
A name that is provided by the user to the profile.
MonitoringProfileID int, Optional
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
DNBProductID string up to 64 chars., Optional
Records the product code that is provided by the customer to create
a profile
MonitoringLevel MonitoringLevelTextEnum up to 16 chars., Optional
A alphanumeric string which determines the level of details that
the customer will receive during a change event
Possible values: Level1; Level2
CreatedFromDate date, Optional
Records the start date of the date range to list the monitoring
profiles
CreatedToDate date, Optional
Records the enddate of the date range to list the monitoring
profiles
MonitoringProfileStatusText MonitoringProfileStatusTextEnum, Optional
Records the status of the monitoring profile
Possible values: Active; Cancelled
CustomerReferenceText-n (upto 5 times) string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be linked
to the product in order to support subsequent order reconciliation.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 67
Name Characteristics
SortBasisText MonitoringProfileSortBasisEnum, Optional
Records the list of fields based on which sorting is possible
Possible values: DNBProductID; MonitoringProfileID;
MonitoringProfileName; MonitoringLevel;
MonitoringProfileStatusText; MonitoringProfileCreatedDate
SortDirectionText SortDirectionEnum, Optional
Records the direction of sorting. Possbile values are Ascending,
Descending
Possible values: Ascending; Descending
CandidatePerPageMaximumQuantity int Less than or equal to 1000., Optional
Records the maximum quantity that can be displayed per page
CandidateDisplayStartSequenceNumber int, Optional
Records the Display sequence number of the results
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
ListMonitoringProfileResponse Aggregate
ListMonitoringProfileResponse@ServiceVersionNumber
ListMonitoringProfileResponse@xsi:schemaLocation
ListMonitoringProfileResponse { TransactionDetail
Aggregate, Required
Records information necessary to process a particular request. Examples
of a request is the ordering of a product.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 68
Name Characteristics
ListMonitoringProfileResponse { TransactionDetail { ApplicationTransactionID
string, up to 64 chars, Optional
A number assigned by the calling application to uniquely identify this
request.
ListMonitoringProfileResponse { TransactionDetail { ServiceTransactionID
string, up to 64 chars, Required
A number assigned by the D&B service to uniquely identify this
transaction.
ListMonitoringProfileResponse { TransactionDetail { TransactionTimestamp
dateTime, 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: ListMonitoringProfileResponse }TransactionDetail
/Aggregate
ListMonitoringProfileResponse { TransactionResult
Aggregate, Required
An aggregate that can repeat multiple times to record the different
outcomes of the transaction.
ListMonitoringProfileResponse { TransactionResult { SeverityText
string, up to 16 chars, Required
Text that records the criticality of the outcome, e.g., Information, Warning,
Error, Fatal.
ListMonitoringProfileResponse { TransactionResult { ResultID
string, up to 32 chars, Required
An alphanumeric string that uniquely identifies the outcome of the
transaction.
ListMonitoringProfileResponse { TransactionResult { ResultText
string, up to 512 chars, Optional
Text that explains the outcome of the transaction.
ListMonitoringProfileResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
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.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 69
Name Characteristics
ListMonitoringProfileResponse { TransactionResult { ResultMessage { ResultDescription
string, up to 512 chars, Required
Text that describes the additional information regarding the outcome of
the transaction.
END: ListMonitoringProfileResponse }TransactionResult } ResultMessage
/Aggregate
END: ListMonitoringProfileResponse }TransactionResult
/Aggregate
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail
Aggregate, Optional
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { CandidateMatchedQuantity
integer, up to 6 digits, Required
The number of registrations listed as possible matches in the result set
based on the search criteria in the Customer/User request.
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { CandidateReturnedQuantity
integer, up to 6 digits, Required
The number of registrations returned in the result set based on the search
criteria in the Customer/User request.
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail
Aggregate, Optional (Infinite)
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileName
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Required
A name that is provided by the user to the profile.
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileDescription
string, up to 256 chars, Optional
A string that records the description of the profile
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileID
integer, Required
A number that uniquely identifies a set of events and their thresholds,
used to monitor a DUNS or a set of DUNS.
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { DNBProductID
string, up to 64 chars, Required
Records the product code that is provided by the customer to create a
profile
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 70
Name Characteristics
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringLevel
MonitoringLevelTextEnum up to 16 chars, Required
A alphanumeric string which determines the level of details that the
customer will receive during a change event
Possible values: Level1; Level2
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail
Aggregate, Optional
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement
Aggregate, Required (Infinite)
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { PCMElementXPATHText
string, up to 3000 chars, Required
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges
Aggregate, Required (Infinite)
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges{ ChangeCondition
ChangeConditionEnum, Required
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges{ ChangeValue
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
END: ListMonitoringProfileResponse }ListMonitoringProfileResponseDetail }MonitoringProfileDetail }MonitoringElementDetail }MonitoringElement } MonitoringChanges
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 71
Name Characteristics
END: ListMonitoringProfileResponse }ListMonitoringProfileResponseDetail }MonitoringProfileDetail }MonitoringElementDetail }MonitoringElement
/Aggregate
END: ListMonitoringProfileResponse }ListMonitoringProfileResponseDetail }MonitoringProfileDetail }MonitoringElementDetail
/Aggregate
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileStatusText
MonitoringProfileStatusTextEnum, Required
Records the status of the monitoring profile
Possible values: Active; Cancelled
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileCreatedDate
date, Required
Records the start date of the date range to list the Monitoring profiles
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { ReturnChangedDataOnlyIndicator
boolean
When 'true' indicates that Change Notices will only include information
for fields whose value has changed. When 'false' indicates that Change
Notices will include information for all fields, regardless if the values have
changed. The latter scenario applies when a whole data layer and/or
aggregate is being monitored.
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information to be linked
to the request in order to support subsequent order reconciliation.
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { InquiryReferenceText { CustomerReferenceText
string, up to 240 chars, Optional (Up to 5x)
A freeform reference string provided by the customer to be linked to the
product in order to support subsequent order reconciliation.
END: ListMonitoringProfileResponse }ListMonitoringProfileResponseDetail }MonitoringProfileDetail }InquiryReferenceText
/Aggregate
ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { DisplaySequence
integer, Optional
Records the display sequence number of the results
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 72
Name Characteristics
END: ListMonitoringProfileResponse }ListMonitoringProfileResponseDetail }MonitoringProfileDetail
/Aggregate
END: ListMonitoringProfileResponse }ListMonitoringProfileResponseDetail
/Aggregate
END: ListMonitoringProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM018, SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
CreateMonitoringProfile (REST), UpdateMonitoringProfile (REST).
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 73
ListMonitoringProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Monitoring Profile establishes the specific data fields within a given data layer that should be monitored,and the conditions under which a change event should be triggered.
Refer to How to Retrieve Monitoring Profiles for an overview of this operation.
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
ListMonitoringProfileRequest Aggregate
ListMonitoringProfileRequest@ServiceVersionNumber Attribute
ListMonitoringProfileRequest@xsi:schemaLocation Attribute
ListMonitoringProfileRequest. TransactionDetail Aggregate, Optional
Records information necessary to process this request.
ListMonitoringProfileRequest. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
ListMonitoringProfileRequest. TransactionDetail.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.
D&B Direct API Documentation ListMonitoringProfile (SOAP)
©Dun & Bradstreet, Inc. 2015 74
Name Characteristics
ListMonitoringProfileRequest. TransactionDetail.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.
END: ListMonitoringProfileRequest. TransactionDetail /Aggregate
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail
Aggregate, Required
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria
Aggregate, Optional
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. MonitoringProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
A name that is provided by the user to the profile.
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. MonitoringProfileID
int, Optional
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. DNBProductID
string up to 64 chars., Optional
Records the product code that is provided by the customer to
create a profile
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. MonitoringLevel
MonitoringLevelTextEnum up to 16 chars., Optional
A alphanumeric string which determines the level of details
that the customer will receive during a change event
Possible values: Level1; Level2
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. CreatedFromDate
date, Optional
Records the start date of the date range to list the monitoring
profiles
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. CreatedToDate
date, Optional
Records the enddate of the date range to list the monitoring
profiles
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 75
Name Characteristics
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria.MonitoringProfileStatusText
MonitoringProfileStatusTextEnum, Optional
Records the status of the monitoring profile
Possible values: Active; Cancelled
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information
to be linked to the request in order to support subsequent
order reconciliation.
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. InquiryReferenceText.CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
END: ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. InquiryReferenceText
/Aggregate
END: ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria
/Aggregate
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification
Aggregate, Optional
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification. SortBasisText
MonitoringProfileSortBasisEnum, Optional
Records the list of fields based on which sorting is possible
Possible values: DNBProductID; MonitoringProfileID;
MonitoringProfileName; MonitoringLevel;
MonitoringProfileStatusText; MonitoringProfileCreatedDate
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification.SortDirectionText
SortDirectionEnum, Optional
Records the direction of sorting. Possbile values are Ascending,
Descending
Possible values: Ascending/Descending
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification.CandidatePerPageMaximumQuantity
int Less than or equal to 1000., Optional
Records the maximum quantity that can be displayed per page
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 76
Name Characteristics
ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification.CandidateDisplayStartSequenceNumber
int, Optional
Records the Display sequence number of the results
END: ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification
/Aggregate
END: ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail
/Aggregate
END: ListMonitoringProfileRequest /Aggregate
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
ListMonitoringProfileResponse Aggregate
ListMonitoringProfileResponse@ServiceVersionNumber
ListMonitoringProfileResponse@xsi:schemaLocation
ListMonitoringProfileResponse.TransactionDetail
Aggregate, Required
Records information necessary to process a particular request. Examples of
a request is the ordering of a product.
ListMonitoringProfileResponse.TransactionDetail.ApplicationTransactionID
string, up to 64 chars, Optional
A number assigned by the calling application to uniquely identify this
request.
ListMonitoringProfileResponse.TransactionDetail. ServiceTransactionID
string, up to 64 chars, Required
A number assigned by the D&B service to uniquely identify this transaction.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 77
Name Characteristics
ListMonitoringProfileResponse.TransactionDetail. TransactionTimestamp
dateTime, 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: ListMonitoringProfileResponse.TransactionDetail
/Aggregate
ListMonitoringProfileResponse.TransactionResult
Aggregate, Required
An aggregate that can repeat multiple times to record the different
outcomes of the transaction.
ListMonitoringProfileResponse.TransactionResult. SeverityText
string, up to 16 chars, Required
Text that records the criticality of the outcome, e.g., Information, Warning,
Error, Fatal.
ListMonitoringProfileResponse.TransactionResult. ResultID
string, up to 32 chars, Required
An alphanumeric string that uniquely identifies the outcome of the
transaction.
ListMonitoringProfileResponse.TransactionResult. ResultText
string, up to 512 chars, Optional
Text that explains the outcome of the transaction.
ListMonitoringProfileResponse.TransactionResult. ResultMessage
Aggregate, Optional (Infinite)
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.
ListMonitoringProfileResponse.TransactionResult. ResultMessage.ResultDescription
string, up to 512 chars, Required
Text that describes the additional information regarding the outcome of
the transaction.
END: ListMonitoringProfileResponse.TransactionResult. ResultMessage
/Aggregate
END: ListMonitoringProfileResponse.TransactionResult
/Aggregate
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail
Aggregate, Optional
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 78
Name Characteristics
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.CandidateMatchedQuantity
integer, up to 6 digits, Required
The number of registrations listed as possible matches in the result set
based on the search criteria in the Customer/User request.
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.CandidateReturnedQuantity
integer, up to 6 digits, Required
The number of registrations returned in the result set based on the search
criteria in the Customer/User request.
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail
Aggregate, Optional (Infinite)
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringProfileName
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Required
A name that is provided by the user to the profile.
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringProfileDescription
string, up to 256 chars, Optional
A string that records the description of the profile
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringProfileID
integer, Required
A number that uniquely identifies a set of events and their thresholds,
used to monitor a DUNS or a set of DUNS.
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. DNBProductID
string, up to 64 chars, Required
Records the product code that is provided by the customer to create a
profile
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringLevel
MonitoringLevelTextEnum up to 16 chars, Required
A alphanumeric string which determines the level of details that the
customer will receive during a change event
Possible values: Level1; Level2
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail
Aggregate, Optional
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail.MonitoringElement
Aggregate, Required (Infinite)
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 79
Name Characteristics
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail.MonitoringElement.PCMElementXPATHText
string, up to 3000 chars, Required
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail.MonitoringElement. MonitoringChanges
Aggregate, Required (Infinite)
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail.MonitoringElement. MonitoringChanges.ChangeCondition
ChangeConditionEnum, Required
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail.MonitoringElement. MonitoringChanges.ChangeValue
string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional
END: ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail.MonitoringElement. MonitoringChanges
/Aggregate
END: ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail.MonitoringElement
/Aggregate
END: ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringElementDetail
/Aggregate
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringProfileStatusText
MonitoringProfileStatusTextEnum, Required
Records the status of the monitoring profile
Possible values: Active; Cancelled
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.MonitoringProfileCreatedDate
date, Required
Records the start date of the date range to list the Monitoring profiles
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 80
Name Characteristics
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.ReturnChangedDataOnlyIndicator
boolean
When 'true' indicates that Change Notices will only include information for
fields whose value has changed. When 'false' indicates that Change
Notices will include information for all fields, regardless if the values have
changed. The latter scenario applies when a whole data layer and/or
aggregate is being monitored.
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information to be linked
to the request in order to support subsequent order reconciliation.
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.InquiryReferenceText.CustomerReferenceText
string, up to 240 chars, Optional (Up to 5x)
A freeform reference string provided by the customer to be linked to the
product in order to support subsequent order reconciliation.
END: ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail.InquiryReferenceText
/Aggregate
ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. DisplaySequence
integer, Optional
Records the display sequence number of the results
END: ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail
/Aggregate
END: ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail
/Aggregate
END: ListMonitoringProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM018, SC001-SC009.
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 81
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
CreateMonitoringProfile (SOAP), UpdateMonitoringProfile (SOAP).
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 82
CreateNotificationProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Notification Profile establishes the protocol by which change events should be delivered to customers, andreferences user preferences setup in the User Service. This is the PUSH component of the Data Field Monitoringfeature.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
POST https://maxcvservices.dnb.com/V{version}/monitoring/notificationprofiles
Request Parameters
The following parameters are accepted by this operation.
Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST followthe order presented in this section. This applies to REST calls only.
Restriction: For POST/PUT requests, the ‘Accept’ header item should be set to ‘application/json’ or be leftempty. If the value submitted is ‘*/*’, the service will return an error. This applies to REST calls only.
Restriction: An XML namespace statement MUST be included as the first statement within the primaryAggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.
Restriction: In addition to the previous restriction, the statement listing the primary Aggregate MUST beprefixed with the corresponding namespace. Please refer to the Sample Request for an example.
Name Characteristics
CreateNotificationProfileRequest Aggregate
CreateNotificationProfileRequest@ServiceVersionNumber Attribute
CreateNotificationProfileRequest@xsi:schemaLocation Attribute
CreateNotificationProfileRequest { TransactionDetail Aggregate, Optional
Records information necessary to process this request.
D&B Direct API Documentation CreateNotificationProfile (REST)
©Dun & Bradstreet, Inc. 2015 83
Name Characteristics
CreateNotificationProfileRequest { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
CreateNotificationProfileRequest { TransactionDetail { 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.
CreateNotificationProfileRequest { TransactionDetail { 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.
END: CreateNotificationProfileRequest } TransactionDetail /Aggregate
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail
Aggregate, Required
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification
Aggregate, Required
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Required
A name that is provided by the user to the profile.
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { NotificationProfileDescription
string up to 256 chars., Optional
A string that records the description of the profile
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { DeliveryMode
DeliveryModeEnum, Required
Possible values: Email; HTTPCallBack; MQOutput
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { DeliveryChannelUserPreferenceName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { DeliveryFrequency
DeliveryFrequencyEnum, Required
Possible values: Immediate; Hourly; Daily; Weekly
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 84
Name Characteristics
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { DeliveryFormat
DeliveryFormatEnum, Required
Possible values: XML
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { StopDeliveryIndicator
boolean, Required
END: CreateNotificationProfileRequest }CreateNotificationProfileRequestDetail }NotificationProfileSpecification
/Aggregate
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to support
subsequent order reconciliation.
CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { InquiryReferenceText { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
END: CreateNotificationProfileRequest }CreateNotificationProfileRequestDetail }InquiryReferenceText
/Aggregate
END: CreateNotificationProfileRequest }CreateNotificationProfileRequestDetail
/Aggregate
END: CreateNotificationProfileRequest /Aggregate
Additional Details
The DeliveryChannelUserPreferenceName parameter value should match thePreferenceSpecification.PreferenceName value that was used to create the User Preference.
Note: When the HTTPCallBack delivery mode is specified, the corresponding User Preference must includevalues for both the Credentials.UserID and Credentials.Password, as these fields will be supplied in theheader when the call back is performed.
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
D&B Direct API Documentation Additional Details
©Dun & Bradstreet, Inc. 2015 85
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
CreateNotificationProfileResponse Aggregate
CreateNotificationProfileResponse@ServiceVersionNumber Attribute
CreateNotificationProfileResponse@xsi:schemaLocation Attribute
CreateNotificationProfileResponse { TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
CreateNotificationProfileResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
CreateNotificationProfileResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
CreateNotificationProfileResponse { 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: CreateNotificationProfileResponse } TransactionDetail /Aggregate
CreateNotificationProfileResponse { TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record the
different outcomes of the transaction.
CreateNotificationProfileResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 86
Name Characteristics
CreateNotificationProfileResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
CreateNotificationProfileResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
CreateNotificationProfileResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
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.
CreateNotificationProfileResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding
the outcome of the transaction.
END: CreateNotificationProfileResponse }TransactionResult } ResultMessage
/Aggregate
END: CreateNotificationProfileResponse }TransactionResult
/Aggregate
CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail
Aggregate, Optional
CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail { NotificationProfileDetail
Aggregate, Required
CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required
A name that is provided by the user to the profile.
CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileID
int, Required
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
END: CreateNotificationProfileResponse }CreateNotificationProfileResponseDetail }NotificationProfileDetail
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 87
Name Characteristics
CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail { InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to support
subsequent order reconciliation.
CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail { InquiryReferenceText { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to
be linked to the product in order to support subsequent
order reconciliation.
END: CreateNotificationProfileResponse }CreateNotificationProfileResponseDetail }InquiryReferenceText
/Aggregate
END: CreateNotificationProfileResponse }CreateNotificationProfileResponseDetail
/Aggregate
END: CreateNotificationProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM007, CM023, SC001-SC009.
Operation-specific supplemental response code explanations:
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present inthe request, Sequence of the element is not matching in the schema, Data type mismatch orInvalid notification Level).
CM007 Delivery Channel User Preference Name is invalid.
CM023 Duplicate Profile Name
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 88
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
UpdateNotificationProfile (REST), ListNotificationProfile (REST), CreatePreference (REST).
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 89
CreateNotificationProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Notification Profile establishes the protocol by which change events should be delivered to customers, andreferences user preferences setup in the User Service. This is the PUSH component of the Data Field Monitoringfeature.
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
CreateNotificationProfileRequest Aggregate
CreateNotificationProfileRequest@ServiceVersionNumber Attribute
CreateNotificationProfileRequest@xsi:schemaLocation Attribute
CreateNotificationProfileRequest. TransactionDetail Aggregate, Optional
Records information necessary to
process this request.
CreateNotificationProfileRequest. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional
A number assigned by the calling
application to uniquely identify this
request.
D&B Direct API Documentation CreateNotificationProfile (SOAP)
©Dun & Bradstreet, Inc. 2015 90
Name Characteristics
CreateNotificationProfileRequest. TransactionDetail. 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.
CreateNotificationProfileRequest. TransactionDetail. 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.
END: CreateNotificationProfileRequest. TransactionDetail /Aggregate
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail Aggregate, Required
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification
Aggregate, Required
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. NotificationProfileName
string at least 1 chars. up to 64chars. Pattern: {.*[^\s].*}., Required
A name that is provided by the user
to the profile.
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. NotificationProfileDescription
string up to 256 chars., Optional
A string that records the description
of the profile
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. DeliveryMode
DeliveryModeEnum, Required
Possible values: Email; HTTPCallBack;
MQOutput
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. DeliveryChannelUserPreferenceName
string at least 1 chars. up to 64chars. Pattern: {.*[^\s].*}., Optional
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 91
Name Characteristics
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. DeliveryFrequency
DeliveryFrequencyEnum, Required
Possible values: Immediate; Hourly;
Daily; Weekly
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. DeliveryFormat
DeliveryFormatEnum, Required
Possible values: XML
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. StopDeliveryIndicator
boolean, Required
END: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification
/Aggregate
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.InquiryReferenceText
Aggregate, Optional
Records data that allows the
customer to specify information to be
linked to the request in order to
support subsequent order
reconciliation.
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.InquiryReferenceText. CustomerReferenceText
string up to 240 chars., Optional(Upto 5x)
A freeform reference string provided
by the customer to be linked to the
product in order to support
subsequent order reconciliation.
END: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.InquiryReferenceText
/Aggregate
END: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail /Aggregate
END: CreateNotificationProfileRequest /Aggregate
Additional Details
The DeliveryChannelUserPreferenceName parameter value should match thePreferenceSpecification.PreferenceName value that was used to create the User Preference.
Note: When the HTTPCallBack delivery mode is specified, the corresponding User Preference must includevalues for both the Credentials.UserID and Credentials.Password, as these fields will be supplied in theheader when the call back is performed.
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
D&B Direct API Documentation Additional Details
©Dun & Bradstreet, Inc. 2015 92
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
CreateNotificationProfileResponse Aggregate
CreateNotificationProfileResponse@ServiceVersionNumber Attribute
CreateNotificationProfileResponse@xsi:schemaLocation Attribute
CreateNotificationProfileResponse. TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
CreateNotificationProfileResponse. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
CreateNotificationProfileResponse. TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
CreateNotificationProfileResponse. 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: CreateNotificationProfileResponse. TransactionDetail /Aggregate
CreateNotificationProfileResponse. TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record the
different outcomes of the transaction.
CreateNotificationProfileResponse. TransactionResult.SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 93
Name Characteristics
CreateNotificationProfileResponse. TransactionResult.ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
CreateNotificationProfileResponse. TransactionResult.ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
CreateNotificationProfileResponse. TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
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.
CreateNotificationProfileResponse. TransactionResult.ResultMessage. ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding
the outcome of the transaction.
END: CreateNotificationProfileResponse. TransactionResult.ResultMessage
/Aggregate
END: CreateNotificationProfileResponse. TransactionResult /Aggregate
CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail
Aggregate, Optional
CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.NotificationProfileDetail
Aggregate, Required
CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required
A name that is provided by the user to the profile.
CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileID
int, Required
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
END: CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.NotificationProfileDetail
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 94
Name Characteristics
CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to support
subsequent order reconciliation.
CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.InquiryReferenceText. CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to
be linked to the product in order to support subsequent
order reconciliation.
END: CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.InquiryReferenceText
/Aggregate
END: CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail
/Aggregate
END: CreateNotificationProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM007, CM023, SC001-SC009.
Operation-specific supplemental response code explanations:
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present inthe request, Sequence of the element is not matching in the schema, Data type mismatch orInvalid notification Level).
CM007 Delivery Channel User Preference Name is invalid.
CM023 Duplicate Profile Name
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 95
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
UpdateNotificationProfile (SOAP), ListNotificationProfile (SOAP), CreatePreference (SOAP).
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 96
UpdateNotificationProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Notification Profile establishes the protocol by which change events should be delivered to customers, andreferences user preferences setup in the User Service. This is the PUSH component of the Data Field Monitoringfeature.
Notification Profiles can be removed by setting the status to Cancelled; however, if the profile is referenced ina Monitoring Registration it may not be removed. Cancelled items can be restored within 24-hours of theupdate, after which they are deleted.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
PUT https://maxcvservices.dnb.com/V{version}/monitoring/notificationprofiles/{NotificationProfileID}
Request Parameters
The following parameter(s) are required in the endpoint.
Name Characteristics
{NotificationProfileID} int, Required
A number that
uniquely
identifies a set
of events and
their
thresholds,
used to
monitor a
DUNS or a set
of DUNS.
The following parameters are accepted by this operation.
D&B Direct API Documentation UpdateNotificationProfile (REST)
©Dun & Bradstreet, Inc. 2015 97
Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST followthe order presented in this section. This applies to REST calls only.
Restriction: For POST/PUT requests, the ‘Accept’ header item should be set to ‘application/json’ or be leftempty. If the value submitted is ‘*/*’, the service will return an error. This applies to REST calls only.
Restriction: An XML namespace statement MUST be included as the first statement within the primaryAggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.
Restriction: In addition to the previous restriction, the statement listing the primary Aggregate MUST beprefixed with the corresponding namespace. Please refer to the Sample Request for an example.
Name Characteristics
UpdateNotificationProfileRequest Aggregate
UpdateNotificationProfileRequest@ServiceVersionNumber Attribute
UpdateNotificationProfileRequest@xsi:schemaLocation Attribute
UpdateNotificationProfileRequest { TransactionDetail Aggregate, Optional
Records information necessary to process this request.
UpdateNotificationProfileRequest { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
UpdateNotificationProfileRequest { TransactionDetail { 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.
UpdateNotificationProfileRequest { TransactionDetail { 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.
END: UpdateNotificationProfileRequest } TransactionDetail /Aggregate
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail
Aggregate, Required
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 98
Name Characteristics
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail
Aggregate, Required
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
A name that is provided by the user to the profile.
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryChannelUserPreferenceName
string up to 64 chars., Optional
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryMode
DeliveryModeEnum, Optional
Possible values: Email; HTTPCallBack; MQOutput
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryFrequency
DeliveryFrequencyEnum, Optional
Possible values: Immediate; Hourly; Daily; Weekly
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryFormat
DeliveryFormatEnum, Optional
Possible values: XML; JSON
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { NotificationProfileStatusText
NotificationProfileStatusTextEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { StopDeliveryIndicator
boolean, Optional
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { InquiryReferenceText
Aggregate
UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { InquiryReferenceText { CustomerReferenceText
Element
END: UpdateNotificationProfileRequest }UpdateNotificationProfileRequestDetail }NotificationProfileDetail } InquiryReferenceText
/Aggregate
END: UpdateNotificationProfileRequest }UpdateNotificationProfileRequestDetail }NotificationProfileDetail
/Aggregate
END: UpdateNotificationProfileRequest }UpdateNotificationProfileRequestDetail
/Aggregate
END: UpdateNotificationProfileRequest /Aggregate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 99
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
UpdateNotificationProfileResponse Aggregate
UpdateNotificationProfileResponse@ServiceVersionNumber Attribute
UpdateNotificationProfileResponse@xsi:schemaLocation Attribute
UpdateNotificationProfileResponse { TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
UpdateNotificationProfileResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
UpdateNotificationProfileResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
UpdateNotificationProfileResponse { 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: UpdateNotificationProfileResponse } TransactionDetail /Aggregate
UpdateNotificationProfileResponse { TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record
the different outcomes of the transaction.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 100
Name Characteristics
UpdateNotificationProfileResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
UpdateNotificationProfileResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
UpdateNotificationProfileResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
UpdateNotificationProfileResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
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.
UpdateNotificationProfileResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding
the outcome of the transaction.
END: UpdateNotificationProfileResponse }TransactionResult } ResultMessage
/Aggregate
END: UpdateNotificationProfileResponse }TransactionResult
/Aggregate
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail
Aggregate, Optional
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail
Aggregate, Optional
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileID
int, Required
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required
A name that is provided by the user to the profile.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 101
Name Characteristics
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryChannelUserPreferenceName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryMode
DeliveryModeEnum, Optional
Possible values: Email; HTTPCallBack; MQOutput
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryFrequency
DeliveryFrequencyEnum, Optional
Possible values: Immediate; Hourly; Daily; Weekly
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryFormat
DeliveryFormatEnum, Optional
Possible values: XML
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileStatusText
NotificationProfileStatusTextEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { StopDeliveryIndicator
boolean, Optional
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { InquiryReferenceText
Aggregate
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { InquiryReferenceText { CustomerReferenceText
Element
END: UpdateNotificationProfileResponse }UpdateNotificationProfileResponseDetail }NotificationProfileDetail } InquiryReferenceText
/Aggregate
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail
Aggregate, Optional
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
A name that is provided by the user to the profile.
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { DeliveryChannelUserPreferenceName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 102
Name Characteristics
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { DeliveryMode
DeliveryModeEnum, Optional
Possible values: Email; HTTPCallBack; MQOutput
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { DeliveryFrequency
DeliveryFrequencyEnum, Optional
Possible values: Immediate; Hourly; Daily; Weekly
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { DeliveryFormat
DeliveryFormatEnum, Optional
Possible values: XML; JSON
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { NotificationProfileStatusText
NotificationProfileStatusTextEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { StopDeliveryIndicator
boolean, Optional
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { InquiryReferenceText
Aggregate
UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { InquiryReferenceText { CustomerReferenceText
Element
END: UpdateNotificationProfileResponse }UpdateNotificationProfileResponseDetail }NotificationProfileDetail } FormerNotificationProfileDetail }InquiryReferenceText
/Aggregate
END: UpdateNotificationProfileResponse }UpdateNotificationProfileResponseDetail }NotificationProfileDetail } FormerNotificationProfileDetail
/Aggregate
END: UpdateNotificationProfileResponse }UpdateNotificationProfileResponseDetail }NotificationProfileDetail
/Aggregate
END: UpdateNotificationProfileResponse }UpdateNotificationProfileResponseDetail
/Aggregate
END: UpdateNotificationProfileResponse /Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 103
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM001, CM002, CM004, CM007, MN002, MN005,SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 Blank Notification profile name
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present inthe request, Sequence of the element is not matching in the schema, Data type mismatch orInvalid notification Level).
CM007 Delivery Channel User Preference Name is invalid; Notification profile cannot be canceled asregistrations are available for this profile; or Notification profile not available in the system.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 104
UpdateNotificationProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Notification Profile establishes the protocol by which change events should be delivered to customers, andreferences user preferences setup in the User Service. This is the PUSH component of the Data Field Monitoringfeature.
Notification Profiles can be removed by setting the status to Cancelled; however, if the profile is referenced ina Monitoring Registration it may not be removed. Cancelled items can be restored within 24-hours of theupdate, after which they are deleted.
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
UpdateNotificationProfileRequest Aggregate
UpdateNotificationProfileRequest@ServiceVersionNumber Attribute
UpdateNotificationProfileRequest@xsi:schemaLocation Attribute
UpdateNotificationProfileRequest. TransactionDetail Aggregate, Optional
Records information necessary to process this request.
UpdateNotificationProfileRequest. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
D&B Direct API Documentation UpdateNotificationProfile (SOAP)
©Dun & Bradstreet, Inc. 2015 105
Name Characteristics
UpdateNotificationProfileRequest. TransactionDetail.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.
UpdateNotificationProfileRequest. TransactionDetail.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.
END: UpdateNotificationProfileRequest. TransactionDetail /Aggregate
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail
Aggregate, Required
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail
Aggregate, Required
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. NotificationProfileID
int, Required
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
A name that is provided by the user to the profile.
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail.DeliveryChannelUserPreferenceName
string up to 64 chars., Optional
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. DeliveryMode
DeliveryModeEnum, Optional
Possible values: Email; HTTPCallBack; MQOutput
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. DeliveryFrequency
DeliveryFrequencyEnum, Optional
Possible values: Immediate; Hourly; Daily; Weekly
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. DeliveryFormat
DeliveryFormatEnum, Optional
Possible values: XML
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 106
Name Characteristics
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. NotificationProfileStatusText
NotificationProfileStatusTextEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. StopDeliveryIndicator
boolean, Optional
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. InquiryReferenceText
Aggregate
UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. InquiryReferenceText.CustomerReferenceText
Element
END: UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. InquiryReferenceText
/Aggregate
END: UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail
/Aggregate
END: UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail
/Aggregate
END: UpdateNotificationProfileRequest /Aggregate
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
UpdateNotificationProfileResponse Aggregate
UpdateNotificationProfileResponse@ServiceVersionNumber Attribute
UpdateNotificationProfileResponse@xsi:schemaLocation Attribute
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 107
Name Characteristics
UpdateNotificationProfileResponse. TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
UpdateNotificationProfileResponse. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
UpdateNotificationProfileResponse. TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
UpdateNotificationProfileResponse. 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: UpdateNotificationProfileResponse. TransactionDetail /Aggregate
UpdateNotificationProfileResponse. TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record
the different outcomes of the transaction.
UpdateNotificationProfileResponse. TransactionResult.SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
UpdateNotificationProfileResponse. TransactionResult.ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
UpdateNotificationProfileResponse. TransactionResult.ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 108
Name Characteristics
UpdateNotificationProfileResponse. TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
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.
UpdateNotificationProfileResponse. TransactionResult.ResultMessage. ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding
the outcome of the transaction.
END: UpdateNotificationProfileResponse. TransactionResult.ResultMessage
/Aggregate
END: UpdateNotificationProfileResponse. TransactionResult /Aggregate
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail
Aggregate, Optional
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail
Aggregate, Optional
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileID
int, Required
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required
A name that is provided by the user to the profile.
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail.DeliveryChannelUserPreferenceName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryMode
DeliveryModeEnum, Optional
Possible values: Email; HTTPCallBack; MQOutput
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryFrequency
DeliveryFrequencyEnum, Optional
Possible values: Immediate; Hourly; Daily; Weekly
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryFormat
DeliveryFormatEnum, Optional
Possible values: XML
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 109
Name Characteristics
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileStatusText
NotificationProfileStatusTextEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. StopDeliveryIndicator
boolean, Optional
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. InquiryReferenceText
Aggregate
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. InquiryReferenceText.CustomerReferenceText
Element
END: UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. InquiryReferenceText
/Aggregate
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail
Aggregate, Optional
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
A name that is provided by the user to the profile.
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.DeliveryChannelUserPreferenceName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.DeliveryMode
DeliveryModeEnum, Optional
Possible values: Email; HTTPCallBack; MQOutput
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.DeliveryFrequency
DeliveryFrequencyEnum, Optional
Possible values: Immediate; Hourly; Daily; Weekly
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.DeliveryFormat
DeliveryFormatEnum, Optional
Possible values: XML
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 110
Name Characteristics
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.NotificationProfileStatusText
NotificationProfileStatusTextEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.StopDeliveryIndicator
boolean, Optional
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.InquiryReferenceText
Aggregate
UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.InquiryReferenceText. CustomerReferenceText
Element
END: UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.InquiryReferenceText
/Aggregate
END: UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail
/Aggregate
END: UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail
/Aggregate
END: UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail
/Aggregate
END: UpdateNotificationProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 111
This operation may return the following response codes: CM001, CM002, CM004, CM007, MN002, MN005,SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 Blank Notification profile name
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present inthe request, Sequence of the element is not matching in the schema, Data type mismatch orInvalid notification Level).
CM007 Delivery Channel User Preference Name is invalid; Notification profile cannot be canceled asregistrations are available for this profile; or Notification profile not available in the system.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 112
ListNotificationProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Notification Profile establishes the protocol by which change events should be delivered to customers, andreferences user preferences setup in the User Service. This is the PUSH component of the Data Field Monitoringfeature.
Refer to How to Retrieve Notification Profiles for an overview of this operation.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
GET https://maxcvservices.dnb.com/V{version}/monitoring/notificationprofiles
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
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.
D&B Direct API Documentation ListNotificationProfile (REST)
©Dun & Bradstreet, Inc. 2015 113
Name Characteristics
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.
NotificationProfileID int, Optional
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
NotificationProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
A name that is provided by the user to the profile.
DeliveryChannelUserPreferenceName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
DeliveryMode DeliveryModeEnum, Optional
Possible values: Email; HTTPCallBack; MQOutput
DeliveryFrequency DeliveryFrequencyEnum, Optional
Possible values: Immediate; Hourly; Daily; Weekly
DeliveryFormat DeliveryFormatEnum, Optional
Possible values: XML
NotificationProfileStatusText NotificationProfileStatusTextEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled
StopDeliveryIndicator boolean, Optional
CreatedFromDate date, Optional
Records the start date of the date range to list the delivery profiles
CreatedToDate date, Optional
Records the enddate of the date range to list the delivery profiles
CustomerReferenceText-n (up to 5 times) string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be linked
to the product in order to support subsequent order reconciliation.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 114
Name Characteristics
SortBasisText NotificationProfileSortBasisEnum, Optional
Records the list of fields based on which sorting is possible
Possible values: DeliveryChannelUserPreferenceName;
NotificationProfileID; NotificationProfileName; DeliveryMode;
DeliveryFrequency; DeliveryFormat; StopDeliveryIndicator;
NotificationProfileCreatedDate; NotificationProfileStatusText
SortDirectionText SortDirectionEnum, Optional
Records the direction of sorting. Possbile values are Ascending,
Descending
CandidatePerPageMaximumQuantity int Less than or equal to 1000., Optional
Records the maximum quantity that can be displayed per page
CandidateDisplayStartSequenceNumber int, Optional
Records the Display sequence number of the results
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
ListNotificationProfileResponse Aggregate
ListNotificationProfileResponse@ServiceVersionNumber Attribute
ListNotificationProfileResponse@xsi:schemaLocation Attribute
ListNotificationProfileResponse { TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a product.
ListNotificationProfileResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 115
Name Characteristics
ListNotificationProfileResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify
this transaction.
ListNotificationProfileResponse { 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: ListNotificationProfileResponse } TransactionDetail /Aggregate
ListNotificationProfileResponse { TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record the
different outcomes of the transaction.
ListNotificationProfileResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
ListNotificationProfileResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome
of the transaction.
ListNotificationProfileResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
ListNotificationProfileResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
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.
ListNotificationProfileResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the
outcome of the transaction.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 116
Name Characteristics
END: ListNotificationProfileResponse }TransactionResult } ResultMessage
/Aggregate
END: ListNotificationProfileResponse }TransactionResult
/Aggregate
ListNotificationProfileResponse { ListNotificationProfileResponseDetail
Aggregate, Optional
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { CandidateMatchedQuantity
int up to 6 digits., Required
The number of registrations listed as possible matches in the
result set based on the search criteria in the Customer/User
request.
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { CandidateReturnedQuantity
int up to 6 digits., Required
The number of registrations returned in the result set based
on the search criteria in the Customer/User request.
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail
Aggregate, Optional (Infinite)
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileID
int, Required
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Required
A name that is provided by the user to the profile.
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryChannelUserPreferenceName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileDescription
string up to 256 chars., Optional
A string that records the description of the profile
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryMode
DeliveryModeEnum, Required
Possible values: Email; HTTPCallBack; MQOutput
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryFrequency
DeliveryFrequencyEnum, Required
Possible values: Immediate; Hourly; Daily; Weekly
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryFormat
DeliveryFormatEnum, Required
Possible values: XML
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 117
Name Characteristics
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileStatusText
NotificationProfileStatusTextEnum, Required
Records the status of the monitoring registration
Possible values: Active; Cancelled
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { StopDeliveryIndicator
boolean, Required
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileCreatedDate
date, Required
Records the start date of the date range to list the delivery
profiles
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information
to be linked to the request in order to support subsequent
order reconciliation.
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { InquiryReferenceText { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
END: ListNotificationProfileResponse }ListNotificationProfileResponseDetail }NotificationProfileDetail } InquiryReferenceText
/Aggregate
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DisplaySequence
int, Optional
Records the display sequence number of the results
END: ListNotificationProfileResponse }ListNotificationProfileResponseDetail }NotificationProfileDetail
/Aggregate
END: ListNotificationProfileResponse }ListNotificationProfileResponseDetail
/Aggregate
END: ListNotificationProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 118
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM018, SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
CreateNotificationProfile (REST), UpdateNotificationProfile (REST).
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2015 119
ListNotificationProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Notification Profile establishes the protocol by which change events should be delivered to customers, andreferences user preferences setup in the User Service. This is the PUSH component of the Data Field Monitoringfeature.
Refer to How to Retrieve Notification Profiles for an overview of this operation.
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
ListNotificationProfileRequest Aggregate
ListNotificationProfileRequest@ServiceVersionNumber Attribute
ListNotificationProfileRequest@xsi:schemaLocation Attribute
ListNotificationProfileRequest. TransactionDetail Aggregate, Optional
Records information necessary to process this request.
ListNotificationProfileRequest. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
D&B Direct API Documentation ListNotificationProfile (SOAP)
©Dun & Bradstreet, Inc. 2015 120
Name Characteristics
ListNotificationProfileRequest. TransactionDetail.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.
ListNotificationProfileRequest. TransactionDetail.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.
END: ListNotificationProfileRequest. TransactionDetail /Aggregate
ListNotificationProfileRequest.ListNotificationProfileRequestDetail
Aggregate, Required
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria
Aggregate, Optional
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. NotificationProfileID
int, Optional
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
A name that is provided by the user to the profile.
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria.DeliveryChannelUserPreferenceName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. DeliveryMode
DeliveryModeEnum, Optional
Possible values: Email; HTTPCallBack; MQOutput
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. DeliveryFrequency
DeliveryFrequencyEnum, Optional
Possible values: Immediate; Hourly; Daily; Weekly
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. DeliveryFormat
DeliveryFormatEnum, Optional
Possible values: XML
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 121
Name Characteristics
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria.NotificationProfileStatusText
NotificationProfileStatusTextEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. StopDeliveryIndicator
boolean, Optional
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. CreatedFromDate
date, Optional
Records the start date of the date range to list the delivery
profiles
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. CreatedToDate
date, Optional
Records the enddate of the date range to list the delivery
profiles
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information
to be linked to the request in order to support subsequent
order reconciliation.
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. InquiryReferenceText.CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
END: ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. InquiryReferenceText
/Aggregate
END: ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria
/Aggregate
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification
Aggregate, Optional
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 122
Name Characteristics
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification. SortBasisText
NotificationProfileSortBasisEnum, Optional
Records the list of fields based on which sorting is possible
Possible values: DeliveryChannelUserPreferenceName;
NotificationProfileID; NotificationProfileName; DeliveryMode;
DeliveryFrequency; DeliveryFormat; StopDeliveryIndicator;
NotificationProfileCreatedDate; NotificationProfileStatusText
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification.SortDirectionText
SortDirectionEnum, Optional
Records the direction of sorting. Possbile values are Ascending,
Descending
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification.CandidatePerPageMaximumQuantity
int Less than or equal to 1000., Optional
Records the maximum quantity that can be displayed per page
ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification.CandidateDisplayStartSequenceNumber
int, Optional
Records the Display sequence number of the results
END: ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification
/Aggregate
END: ListNotificationProfileRequest.ListNotificationProfileRequestDetail
/Aggregate
END: ListNotificationProfileRequest /Aggregate
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
ListNotificationProfileResponse Aggregate
ListNotificationProfileResponse@ServiceVersionNumber Attribute
ListNotificationProfileResponse@xsi:schemaLocation Attribute
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 123
Name Characteristics
ListNotificationProfileResponse. TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a product.
ListNotificationProfileResponse. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
ListNotificationProfileResponse. TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify
this transaction.
ListNotificationProfileResponse. 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: ListNotificationProfileResponse. TransactionDetail /Aggregate
ListNotificationProfileResponse. TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record the
different outcomes of the transaction.
ListNotificationProfileResponse. TransactionResult.SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
ListNotificationProfileResponse. TransactionResult.ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome
of the transaction.
ListNotificationProfileResponse. TransactionResult.ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 124
Name Characteristics
ListNotificationProfileResponse. TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
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.
ListNotificationProfileResponse. TransactionResult.ResultMessage. ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the
outcome of the transaction.
END: ListNotificationProfileResponse. TransactionResult.ResultMessage
/Aggregate
END: ListNotificationProfileResponse. TransactionResult /Aggregate
ListNotificationProfileResponse.ListNotificationProfileResponseDetail
Aggregate, Optional
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.CandidateMatchedQuantity
int up to 6 digits., Required
The number of registrations listed as possible matches in the
result set based on the search criteria in the Customer/User
request.
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.CandidateReturnedQuantity
int up to 6 digits., Required
The number of registrations returned in the result set based
on the search criteria in the Customer/User request.
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail
Aggregate, Optional (Infinite)
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileID
int, Required
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Required
A name that is provided by the user to the profile.
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail.DeliveryChannelUserPreferenceName
string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}.,Optional
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 125
Name Characteristics
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileDescription
string up to 256 chars., Optional
A string that records the description of the profile
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryMode
DeliveryModeEnum, Required
Possible values: Email; HTTPCallBack; MQOutput
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryFrequency
DeliveryFrequencyEnum, Required
Possible values: Immediate; Hourly; Daily; Weekly
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryFormat
DeliveryFormatEnum, Required
Possible values: XML
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileStatusText
NotificationProfileStatusTextEnum, Required
Records the status of the monitoring registration
Possible values: Active; Cancelled
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. StopDeliveryIndicator
boolean, Required
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileCreatedDate
date, Required
Records the start date of the date range to list the delivery
profiles
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. InquiryReferenceText
Aggregate, Optional
Records data that allows the customer to specify information
to be linked to the request in order to support subsequent
order reconciliation.
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. InquiryReferenceText.CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to be
linked to the product in order to support subsequent order
reconciliation.
END: ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. InquiryReferenceText
/Aggregate
ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. DisplaySequence
int, Optional
Records the display sequence number of the results
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 126
Name Characteristics
END: ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail
/Aggregate
END: ListNotificationProfileResponse.ListNotificationProfileResponseDetail
/Aggregate
END: ListNotificationProfileResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM018, SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
CreateNotificationProfile (SOAP), UpdateNotificationProfile (SOAP).
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 127
AddMonitoringRegistration (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Numberand initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, orevents with data layer included.
The Product Availability Lookup feature should be utilized PRIOR TO CALLING THIS OPERATION todetermine if the D&B Direct product that will monitored is available for a given D-U-N-S Number.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
POST https://maxcvservices.dnb.com/V{version}/monitoring/registrations
Request Parameters
The following parameters are accepted by this operation.
Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST followthe order presented in this section. This applies to REST calls only.
Restriction: For POST/PUT requests, the ‘Accept’ header item should be set to ‘application/json’ or be leftempty. If the value submitted is ‘*/*’, the service will return an error. This applies to REST calls only.
Restriction: An XML namespace statement MUST be included as the first statement within the primaryAggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.
Restriction: In addition to the previous restriction, the statement listing the primary Aggregate MUST beprefixed with the corresponding namespace. Please refer to the Sample Request for an example.
Note: As of August 22, 2014, for performance reasons, this function no longer performs a ProductAvailability check during the course of registering a D-U-N-S Number. As a result, it is possible for aregistration to be successful, but later result in an unsuccessful state. An upcoming release will provide amethod for viewing these cases.
D&B Direct API Documentation AddMonitoringRegistration (REST)
©Dun & Bradstreet, Inc. 2015 128
When monitoring the People data layer, a principal identification number (Principal ID) will be required bythis operation.
Name Characteristics
AddMonitoringRegistrationRequest Aggregate
AddMonitoringRegistrationRequest@ServiceVersionNumber Attribute
AddMonitoringRegistrationRequest@xsi:schemaLocation Attribute
AddMonitoringRegistrationRequest { TransactionDetail Aggregate, Optional
Records information necessary to process this request.
AddMonitoringRegistrationRequest { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
AddMonitoringRegistrationRequest { TransactionDetail { 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.
AddMonitoringRegistrationRequest { TransactionDetail { 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.
END: AddMonitoringRegistrationRequest } TransactionDetail /Aggregate
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail
Aggregate, Required
Records the details to add company / companies for
monitoring, allowing the customer to receive alerts
when there is a data change for the company.
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryDetail
Aggregate, Required
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { 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.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 129
Name Characteristics
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which
either uniquely identifies or helps to identify an
individual.
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryDetail { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
END: AddMonitoringRegistrationRequest }AddMonitoringRegistrationRequestDetail } InquiryDetail
/Aggregate
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification
Aggregate, Required
Records details of an organization to be monitored and
the preferences that the customer has set for
registering an organization for Monitoring.
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { NotificationProfileID
int, Required
A number that uniquely identifies the delivery
preferences that the customer has set for Monitoring
Alerts.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 130
Name Characteristics
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { TradeUpIndicator
boolean, Optional
When true (set to 1) this denotes that the customer has
requested that D&B return the data for the
Headquarters when the requested organization is a
Branch. When false (set to 0) this denotes that the
customer has not requested that D&B return the data
for the Headquarters when the requested organization is
a Branch; however as this is the assumed condition
there is no requirement to create this tag to represent
this fact. Note: There are D&B WorldWide Network
operations where the Headquarters information will be
returned automatically, regardless of the customer
request.
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { AutoRenewalIndicator
boolean, Optional
When true (set to 1), it means that this registration is set
for Auto Renewal. When false (set to 0), it means that
this registration is not set for Autorenewal.
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the category in which
the Customer has classified the subject.
Possible values: High; Medium; Low
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { RegistrationReasonCode
integer up to 7 digits., Optional
Code identifying the reason for the Customer showing
interest to monitor this subject. This reason needs to be
captured to comply with German Data Protection Laws.
END: AddMonitoringRegistrationRequest }AddMonitoringRegistrationRequestDetail }MonitoringRegistrationSpecification
/Aggregate
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to
support subsequent order reconciliation.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 131
Name Characteristics
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryReferenceDetail { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to
be linked to the product in order to support subsequent
order reconciliation.
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryReferenceDetail { CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains
requesting individual or department name, or customer's
own account/reference number and/or name for the
case on which the product was provided.This text is a
reference used during the billing process.
END: AddMonitoringRegistrationRequest }AddMonitoringRegistrationRequestDetail }InquiryReferenceDetail
/Aggregate
END: AddMonitoringRegistrationRequest }AddMonitoringRegistrationRequestDetail
/Aggregate
END: AddMonitoringRegistrationRequest /Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which
either uniquely identifies or helps to identify an
individual.
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which
either uniquely identifies or helps to identify an
individual.
The volume of resulting change notices is dependent on the product/data field criteria (i.e. Monitoring Profile),volatility of the company being monitored, and the data update frequency (which may vary in certaincountries). Change detection is currently based on the latest values as compared to previous values, andtherefore is not cumulative from the date of registration.
Testing / Sandbox
This operation will return results in the D&B Direct sandbox (test) environment only when a test D-U-N-SNumber is provided in the request parameters.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 132
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
AddMonitoringRegistrationResponse Aggregate
AddMonitoringRegistrationResponse@ServiceVersionNumber Attribute
AddMonitoringRegistrationResponse@xsi:schemaLocation Attribute
AddMonitoringRegistrationResponse { TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
AddMonitoringRegistrationResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
AddMonitoringRegistrationResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
AddMonitoringRegistrationResponse { 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: AddMonitoringRegistrationResponse } TransactionDetail /Aggregate
AddMonitoringRegistrationResponse { TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record
the different outcomes of the transaction.
AddMonitoringRegistrationResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
Possible values: High; Medium; Low
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 133
Name Characteristics
AddMonitoringRegistrationResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
AddMonitoringRegistrationResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
AddMonitoringRegistrationResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
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.
AddMonitoringRegistrationResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information
regarding the outcome of the transaction.
END: AddMonitoringRegistrationResponse }TransactionResult } ResultMessage
/Aggregate
END: AddMonitoringRegistrationResponse }TransactionResult
/Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail
Aggregate, Optional
Records the details of the company / companies that
are registered for monitoring which will allow the
customer to receive alerts when there is a data change
for the company.
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail
Aggregate, Required
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { 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.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 134
Name Characteristics
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
END: AddMonitoringRegistrationResponse }AddMonitoringRegistrationResponseDetail } InquiryDetail
/Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail
Aggregate, Required
Records details of an organization that will be
monitored.
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
Records the duns number that is registered for
Monitoring.
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { NotificationProfileID
int, Required
A number that uniquely identifies the delivery
preferences that the customer has set for Monitoring
Alerts.
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { StartDate
date, Required
The date when the subject has been registered for
monitoring.
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { EndDate
date, Required
The date when the subject registration for monitoring
has been ended.
END: AddMonitoringRegistrationResponse }AddMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 135
Name Characteristics
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to
support subsequent order reconciliation.
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryReferenceDetail { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer
to be linked to the product in order to support
subsequent order reconciliation.
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly
contains requesting individual or department name, or
customer's own account/reference number and/or
name for the case on which the product was
provided.This text is a reference used during the billing
process.
END: AddMonitoringRegistrationResponse }AddMonitoringRegistrationResponseDetail }InquiryReferenceDetail
/Aggregate
END: AddMonitoringRegistrationResponse }AddMonitoringRegistrationResponseDetail
/Aggregate
END: AddMonitoringRegistrationResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM026 response code, however, the registration will be set to apending status until several asynchronous steps are completed. Otherwise, one of the D&B Direct standardresponse codes will be returned.
Use the ListMonitoringRegistation operation to determine when the additional asynchronous steps arecomplete, and for the success/failure of the registration (value in MonitoringRegistrationStatusText).
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 136
This operation may return the following response codes: CM001, CM002, CM004, CM009, CM011, CM012,CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 Invalid Monitoring Profile ID; or Invalid Notification Profile ID.
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present in the request,Sequence of the element is not matching in the schema, Data type mismatch or Invalid notification Level).
CM009 Missing reason code
CM012 Invalid subject- Duns number
CM023 Duplicate Registration
PD003 DUNS stop distribution
PD005 Requested Product not available
PD016 DUNS transferred
PD017 DUNS out of business
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/4.1/DnB-Monitoring.zip
Related Topics
UpdateMonitoringRegistration (REST), ListMonitoringRegistration (REST), Change Notice (XML),CreateMonitoringProfile (REST), CreateNotificationProfile (REST).
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 137
AddMonitoringRegistration (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Numberand initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, orevents with data layer included.
The Product Availability Lookup feature should be utilized PRIOR TO CALLING THIS OPERATION todetermine if the D&B Direct product that will monitored is available for a given D-U-N-S Number.
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
The following parameters are accepted by this operation.
Note: As of August 22, 2014, for performance reasons, this function no longer performs a ProductAvailability check during the course of registering a D-U-N-S Number. As a result, it is possible for aregistration to be successful, but later result in an unsuccessful state. An upcoming release will provide amethod for viewing these cases.
When monitoring the People data layer, a principal identification number (Principal ID) will be required bythis operation.
Name Characteristics
AddMonitoringRegistrationRequest Aggregate
AddMonitoringRegistrationRequest@ServiceVersionNumber Attribute
AddMonitoringRegistrationRequest@xsi:schemaLocation Attribute
AddMonitoringRegistrationRequest. TransactionDetail Aggregate, Optional
Records information necessary to process this request.
D&B Direct API Documentation AddMonitoringRegistration (SOAP)
©Dun & Bradstreet, Inc. 2015 138
Name Characteristics
AddMonitoringRegistrationRequest. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
AddMonitoringRegistrationRequest. TransactionDetail.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.
AddMonitoringRegistrationRequest. TransactionDetail.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.
END: AddMonitoringRegistrationRequest. TransactionDetail /Aggregate
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail
Aggregate, Required
Records the details to add company / companies for
monitoring, allowing the customer to receive alerts
when there is a data change for the company.
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail. InquiryDetail
Aggregate, Required
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail. 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.
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail. InquiryDetail.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which
either uniquely identifies or helps to identify an
individual.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 139
Name Characteristics
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail. InquiryDetail.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
END: AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail. InquiryDetail
/Aggregate
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification
Aggregate, Required
Records details of an organization to be monitored and
the preferences that the customer has set for
registering an organization for Monitoring.
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification. MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification. NotificationProfileID
int, Required
A number that uniquely identifies the delivery
preferences that the customer has set for Monitoring
Alerts.
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification. TradeUpIndicator
boolean, Optional
When true (set to 1) this denotes that the customer has
requested that D&B return the data for the
Headquarters when the requested organization is a
Branch. When false (set to 0) this denotes that the
customer has not requested that D&B return the data
for the Headquarters when the requested organization is
a Branch; however as this is the assumed condition
there is no requirement to create this tag to represent
this fact. Note: There are D&B WorldWide Network
operations where the Headquarters information will be
returned automatically, regardless of the customer
request.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 140
Name Characteristics
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification. AutoRenewalIndicator
boolean, Optional
When true (set to 1), it means that this registration is set
for Auto Renewal. When false (set to 0), it means that
this registration is not set for Autorenewal.
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification. SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the category in which
the Customer has classified the subject.
Possible values: High; Medium; Low
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification.RegistrationReasonCode
integer up to 7 digits., Optional
Code identifying the reason for the Customer showing
interest to monitor this subject. This reason needs to be
captured to comply with German Data Protection Laws.
END: AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification
/Aggregate
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to
support subsequent order reconciliation.
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.InquiryReferenceDetail. CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to
be linked to the product in order to support subsequent
order reconciliation.
AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.InquiryReferenceDetail. CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly contains
requesting individual or department name, or customer's
own account/reference number and/or name for the
case on which the product was provided.This text is a
reference used during the billing process.
END: AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.InquiryReferenceDetail
/Aggregate
END: AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail
/Aggregate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 141
Name Characteristics
END: AddMonitoringRegistrationRequest /Aggregate
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail. InquiryDetail.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which
either uniquely identifies or helps to identify an
individual.
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which
either uniquely identifies or helps to identify an
individual.
The volume of resulting change notices is dependent on the product/data field criteria (i.e. Monitoring Profile),volatility of the company being monitored, and the data update frequency (which may vary in certaincountries). Change detection is currently based on the latest values as compared to previous values, andtherefore is not cumulative from the date of registration.
Testing / Sandbox
This operation will return results in the D&B Direct sandbox (test) environment only when a test D-U-N-SNumber is provided in the request parameters.
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
AddMonitoringRegistrationResponse Aggregate
AddMonitoringRegistrationResponse@ServiceVersionNumber Attribute
AddMonitoringRegistrationResponse@xsi:schemaLocation Attribute
AddMonitoringRegistrationResponse. TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
AddMonitoringRegistrationResponse. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 142
Name Characteristics
AddMonitoringRegistrationResponse. TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
AddMonitoringRegistrationResponse. 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: AddMonitoringRegistrationResponse. TransactionDetail /Aggregate
AddMonitoringRegistrationResponse. TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record
the different outcomes of the transaction.
AddMonitoringRegistrationResponse. TransactionResult.SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
Possible values: High; Medium; Low
AddMonitoringRegistrationResponse. TransactionResult.ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
AddMonitoringRegistrationResponse. TransactionResult.ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
AddMonitoringRegistrationResponse. TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
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.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 143
Name Characteristics
AddMonitoringRegistrationResponse. TransactionResult.ResultMessage. ResultDescription
string up to 512 chars., Required
Text that describes the additional information
regarding the outcome of the transaction.
END: AddMonitoringRegistrationResponse. TransactionResult.ResultMessage
/Aggregate
END: AddMonitoringRegistrationResponse. TransactionResult /Aggregate
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail
Aggregate, Optional
Records the details of the company / companies that
are registered for monitoring which will allow the
customer to receive alerts when there is a data change
for the company.
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail. InquiryDetail
Aggregate, Required
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail. 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.
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail. InquiryDetail.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
END: AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail. InquiryDetail
/Aggregate
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail
Aggregate, Required
Records details of an organization that will be
monitored.
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
Records the duns number that is registered for
Monitoring.
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 144
Name Characteristics
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. NotificationProfileID
int, Required
A number that uniquely identifies the delivery
preferences that the customer has set for Monitoring
Alerts.
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. StartDate
date, Required
The date when the subject has been registered for
monitoring.
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. EndDate
date, Required
The date when the subject registration for monitoring
has been ended.
END: AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail
/Aggregate
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to
support subsequent order reconciliation.
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.InquiryReferenceDetail. CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer
to be linked to the product in order to support
subsequent order reconciliation.
AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.InquiryReferenceDetail. CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly
contains requesting individual or department name, or
customer's own account/reference number and/or
name for the case on which the product was
provided.This text is a reference used during the billing
process.
END: AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.InquiryReferenceDetail
/Aggregate
END: AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail
/Aggregate
END: AddMonitoringRegistrationResponse /Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 145
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM026 response code, however, the registration will be set to apending status until several asynchronous steps are completed. Otherwise, one of the D&B Direct standardresponse codes will be returned.
Use the ListMonitoringRegistation operation to determine when the additional asynchronous steps arecomplete, and for the success/failure of the registration (value in MonitoringRegistrationStatusText).
This operation may return the following response codes: CM001, CM002, CM004, CM009, CM011, CM012,CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 Invalid Monitoring Profile ID; or Invalid Notification Profile ID.
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present in the request,Sequence of the element is not matching in the schema, Data type mismatch or Invalid notification Level).
CM009 Missing reason code
CM012 Invalid subject- Duns number
CM023 Duplicate Registration
PD003 DUNS stop distribution
PD005 Requested Product not available
PD016 DUNS transferred
PD017 DUNS out of business
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 146
Related Topics
UpdateMonitoringRegistration (SOAP), ListMonitoringRegistration (SOAP), Change Notice(XML), CreateMonitoringProfile (SOAP), CreateNotificationProfile (SOAP).
D&B Direct API Documentation Related Topics
©Dun & Bradstreet, Inc. 2015 147
Change NoticeThe following table is the XML layout of the Change Notices triggered by a monitoring event.
The volume of resulting change notices is dependent on the product/data field criteria (i.e. Monitoring Profile),volatility of the company being monitored, and the data update frequency (which may vary in certaincountries). Change detection is currently based on the latest values as compared to previous values, andtherefore is not cumulative from the date of registration.
Refer to the section "Understanding Change Notices" for some tips and examples.
Change notices are not cumulative. For extended notification periods (e.g. weekly), the change notice will onlyreflect the changes since the last notice. For example, if an element which is being monitored changesmultiple times within a week, a weekly change notice would only reflect the difference between the final andlast (weekly change notice) values.
Field Details
Note: For level 2 Monitoring registrations, the service returns data layers in the format specified by thelatest version of the corresponding service. For example, if the DCP_PREM data layer is being monitoredand a new version of the Firmographic service is released, level 2 Monitoring attachments will reflect thenewer DCP_PREM layout (if it changed).
Name Characteristics
ChangeNotice Aggregate
ChangeNotice@xsi:schemaLocation Attribute
ChangeNotice. TransactionDetail Aggregate, Required
ChangeNotice. TransactionDetail. ChangeNoticeID long, Required
A number assigned by the D&B service to uniquely identify this
transaction.
ChangeNotice. TransactionDetail.ChangeNoticeDeliveryTimestamp
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: ChangeNotice. TransactionDetail /Aggregate
ChangeNotice. ChangeNoticeDetail Aggregate, Required
D&B Direct API Documentation Change Notice
©Dun & Bradstreet, Inc. 2015 148
Name Characteristics
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail
Aggregate, Required (Infinite)
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail
Aggregate, Required
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail. DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
Records the duns number that is registered for Monitoring.
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail.PrincipalIdentificationNumberDetail
Aggregate, Optional
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail.PrincipalIdentificationNumberDetail@DNBCodeValue
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which either
uniquely identifies or helps to identify an individual.
END:ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail.PrincipalIdentificationNumberDetail
/Aggregate
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail.CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1 scheme
published by International Organization for Standardization (ISO)
identifying the country of the inquired subject.
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail.OrganizationPrimaryName
Aggregate, Optional (Infinite)
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.
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail.OrganizationPrimaryName. OrganizationName
string up to 256 chars., Required
END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail.OrganizationPrimaryName
/Aggregate
END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail
/Aggregate
D&B Direct API Documentation Field Details
©Dun & Bradstreet, Inc. 2015 149
Name Characteristics
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the category in which the
Customer has classified the subject.
Possible values: High; Medium; Low
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. LanguageCode
integer up to 7 digits., Required
A D&B code value that defines a language in which the specified
product is available.
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. MonitoringProfileDetail
Aggregate, Required
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. MonitoringProfileDetail.MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. MonitoringProfileDetail.DNBProductID
string up to 64 chars., Required
An alphanumeric string that uniquely identifies this product.
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. MonitoringProfileDetail.MonitoringLevel
MonitoringLevelTextEnum up to 16 chars., Required
A alphanumeric string which determines the level of details that
the customer will receive during a change event
Possible values: Level1; Level2
END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. MonitoringProfileDetail
/Aggregate
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent
Aggregate, Required (Infinite)
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. ChangeEventID
long, Required
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent.ChangeDetectionTimestamp
DateTimestamp, Required
The date and time when this notification has been generated
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. ElementName
string up to 64 chars., Required
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent.PCMElementXPATHText
string up to 3000 chars., Required
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. Element
String, Optional (Infinite)
D&B Direct API Documentation Field Details
©Dun & Bradstreet, Inc. 2015 150
Name Characteristics
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent.Element@ChangeType
AttributePossible values: Dropped; NewlyAdded; NoChange;ValueChanged
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent.Element@PCMElementXPATHText
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent.Element@OldValue
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange
Aggregate, Optional
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChangeType
string, RequiredPossible values: Add, Drop.
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChangeReasonText
string up to 256 chars., Optional
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChangeReasonText@DNBCodeValue
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChangeReasonText@DNBCodeTableNumber
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.GlobalUltimateOrganization
Aggregate, Optional
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.GlobalUltimateOrganization. AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint
Parent
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.GlobalUltimateOrganization.AssociationTypeText@DNBCodeValue
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.GlobalUltimateOrganization.AssociationTypeText@DNBCodeTableNumber
Attribute
D&B Direct API Documentation Field Details
©Dun & Bradstreet, Inc. 2015 151
Name Characteristics
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.GlobalUltimateOrganization. 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: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.GlobalUltimateOrganization
/Aggregate
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerGlobalUltimateOrganization
Aggregate, Optional
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerGlobalUltimateOrganization.AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint
Parent
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerGlobalUltimateOrganization.AssociationTypeText@DNBCodeValue
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerGlobalUltimateOrganization.AssociationTypeText@DNBCodeTableNumber
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerGlobalUltimateOrganization. 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: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerGlobalUltimateOrganization
/Aggregate
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.UpwardFamilyMemberOrganization
Aggregate, Optional
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.UpwardFamilyMemberOrganization.AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint
Parent
D&B Direct API Documentation Field Details
©Dun & Bradstreet, Inc. 2015 152
Name Characteristics
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.UpwardFamilyMemberOrganization.AssociationTypeText@DNBCodeValue
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.UpwardFamilyMemberOrganization.AssociationTypeText@DNBCodeTableNumber
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.UpwardFamilyMemberOrganization. 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: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.UpwardFamilyMemberOrganization
/Aggregate
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerUpwardFamilyMemberOrganization
Aggregate, Optional
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerUpwardFamilyMemberOrganization.AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint
Parent
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerUpwardFamilyMemberOrganization.AssociationTypeText@DNBCodeValue
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerUpwardFamilyMemberOrganization.AssociationTypeText@DNBCodeTableNumber
Attribute
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerUpwardFamilyMemberOrganization.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: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerUpwardFamilyMemberOrganization
/Aggregate
D&B Direct API Documentation Field Details
©Dun & Bradstreet, Inc. 2015 153
Name Characteristics
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChildrenSummary
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the
recording of the number of children of various types for the
Subject.
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChildrenSummary. ChildrenQuantity
int up to 8 digits., Optional
The total number of children of the linked Family Tree Subject of
the type specified by Children Type Text.
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChildrenSummary. DirectChildrenIndicator
boolean, Optional
When true (set to 1)it indicates immediate children only.
END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChildrenSummary
/Aggregate
END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange
/Aggregate
END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent
/Aggregate
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ObjectAttachment
Aggregate, Optional
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ObjectAttachment.ContentObject
base64Binary, Required
ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ObjectAttachment.ObjectFormatCode
integer up to 7 digits., Required
SCoTS: 126 [Object Format]
END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ObjectAttachment
/Aggregate
END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail
/Aggregate
END: ChangeNotice. ChangeNoticeDetail /Aggregate
END: ChangeNotice /Aggregate
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered
in the response and should be anticipated in any implementation.
Additional Details
The embedded ObjectAttachment field will contain a copy of the complete data layer in Base64 encodedformat whenever level 2 monitoring is specified on the initial AddMonitoringRegistration call.
D&B Direct API Documentation Additional Details
©Dun & Bradstreet, Inc. 2015 154
Note: The OrderProductResponse@ServiceVersionNumber value in the object attachment will NOT matchthe version of the data layer when retrieved from it's corresponding service.
HTTP Callback Authentication
Using the UserID and PasswordText values provided in the User Preference profile, the D&B service willperform HTTP Basic Authentication before posting the change notice to the URL stored in thePreferenceValueText of field the User Preference profile. Here are the steps that will be followed:
1. The UserID and PasswordText will be combined into a string "username:password",
2. The resulting string is then encoded using the RFC2045-MIME variant of Base64, except not limited to 76char/line,
3. The authorization method and a space (i.e. "Basic ") is then placed before the encoded string.
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
D&B Direct API Documentation Additional Details
©Dun & Bradstreet, Inc. 2015 155
UpdateMonitoringRegistration (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Numberand initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, orevents with data layer included.
Caution: This operation will update multiple registrations based on the input parameters provided. Forexample, if a D-U-N-S Number is not provided, all registrations with matching Monitoring and NotificationProfile IDs will be affected by the change requested. If no input criteria provided, all registrations will beaffected.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
PUT https://maxcvservices.dnb.com/V{version}/monitoring/registrations
Request Parameters
The following parameters are accepted by this operation.
Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST followthe order presented in this section. This applies to REST calls only.
Restriction: For POST/PUT requests, the ‘Accept’ header item should be set to ‘application/json’ or be leftempty. If the value submitted is ‘*/*’, the service will return an error. This applies to REST calls only.
Restriction: An XML namespace statement MUST be included as the first statement within the primaryAggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.
Restriction: In addition to the previous restriction, the statement listing the primary Aggregate MUST beprefixed with the corresponding namespace. Please refer to the Sample Request for an example.
Name Characteristics
UpdateMonitoringRegistrationRequest Aggregate
UpdateMonitoringRegistrationRequest@ServiceVersionNumber Attribute
D&B Direct API Documentation UpdateMonitoringRegistration (REST)
©Dun & Bradstreet, Inc. 2015 156
Name Characteristics
UpdateMonitoringRegistrationRequest@xsi:schemaLocation Attribute
UpdateMonitoringRegistrationRequest { TransactionDetail Aggregate, Optional
Records information necessary to process this
request.
UpdateMonitoringRegistrationRequest { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to
uniquely identify this request.
UpdateMonitoringRegistrationRequest { TransactionDetail { 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.
UpdateMonitoringRegistrationRequest { TransactionDetail { 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.
END: UpdateMonitoringRegistrationRequest } TransactionDetail /Aggregate
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail
Aggregate, Required
Records the details of request to update existing
monitoring registration(s)
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail
Aggregate, Optional
Records the details of the existing registrations
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail { DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Optional
Records the duns number that is provided by the
customer to register for Monitoring.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 157
Name Characteristics
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { InquiryDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber
Element
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail { MonitoringProfileID
int, Optional
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail { NotificationProfileID
int, Optional
A number that uniquely identifies the delivery
preferences that the customer has set for Monitoring
Alerts.
END: UpdateMonitoringRegistrationRequest }UpdateMonitoringRegistrationRequestDetail }MonitoringRegistrationDetail
/Aggregate
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification
Aggregate, Required
Records the specification of the registrations update
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { NotificationProfileID
int, Optional
The number that uniquely identifies the new delivery
preferences that the customer has set for Monitoring
Alerts.
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { AutoRenewalIndicator
boolean, Optional
When true (set to 1), it means that this registration is
set for Auto Renewal. When false (set to 0), it means
that this registration is not set for Autorenewal.
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the category in
which the Customer has classified the subject.
Possible values: High; Medium; Low
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 158
Name Characteristics
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { MonitoringRegistrationStatusText
MonitoringRegistrationStatusEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled; Pending; Expired;
RegistrationFailed:StopDistribution,
RegistrationFailed:TooOldData,
RegistrationFailed:ProductAvailabilityFailure,
RegistrationFailed
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { InquiryReferenceText
Aggregate
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { InquiryReferenceText { CustomerReferenceText
Element
END: UpdateMonitoringRegistrationRequest }UpdateMonitoringRegistrationRequestDetail }MonitoringRegistrationUpdateSpecification }InquiryReferenceText
/Aggregate
END: UpdateMonitoringRegistrationRequest }UpdateMonitoringRegistrationRequestDetail }MonitoringRegistrationUpdateSpecification
/Aggregate
END: UpdateMonitoringRegistrationRequest }UpdateMonitoringRegistrationRequestDetail
/Aggregate
END: UpdateMonitoringRegistrationRequest /Aggregate
Testing / Sandbox
This operation will return results in the D&B Direct sandbox (test) environment only when a test D-U-N-SNumber is provided in the request parameters.
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response. In caseswhere multiple registrations were affected by the update, only the UpdatedRegistrationCount will be returned.
Name Characteristics
UpdateMonitoringRegistrationResponse Aggregate
UpdateMonitoringRegistrationResponse@ServiceVersionNumber Attribute
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 159
Name Characteristics
UpdateMonitoringRegistrationResponse@xsi:schemaLocation Attribute
UpdateMonitoringRegistrationResponse { TransactionDetail Aggregate, Required
Records information necessary to process a
particular request. Examples of a request is the
ordering of a product.
UpdateMonitoringRegistrationResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to
uniquely identify this request.
UpdateMonitoringRegistrationResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
UpdateMonitoringRegistrationResponse { 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: UpdateMonitoringRegistrationResponse } TransactionDetail /Aggregate
UpdateMonitoringRegistrationResponse { TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to
record the different outcomes of the transaction.
UpdateMonitoringRegistrationResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
UpdateMonitoringRegistrationResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
UpdateMonitoringRegistrationResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 160
Name Characteristics
UpdateMonitoringRegistrationResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
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.
UpdateMonitoringRegistrationResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information
regarding the outcome of the transaction.
END: UpdateMonitoringRegistrationResponse }TransactionResult } ResultMessage
/Aggregate
END: UpdateMonitoringRegistrationResponse }TransactionResult
/Aggregate
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail
Aggregate, Optional
Records the details of the updated monitoring
registration(s)
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { UpdatedRegistrationCount
int, Required
A numeric value which records the count of
registrations updated for the details provided by the
customer in the request
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail
Aggregate, Optional (Infinite)
Records the details of monitoring registration before
and after the update
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
Records the duns number that is provided by the
customer to update the Monitoring registration.
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B
which either uniquely identifies or helps to identify
an individual.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 161
Name Characteristics
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringProfileID
int, Required
A number that uniquely identifies a set of events
and their thresholds, used to monitor a DUNS or a
set of DUNS.
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { NotificationProfileID
int, Optional
A number that uniquely identifies the former
delivery preferences that the customer has set for
Monitoring Alerts before the update.
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the former
category in which the Customer has classified the
subject.
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { AutoRenewalIndicator
boolean, Optional
A boolean value which represents whether the
registration is set for Auto renewal or not before the
update. When true (set to 1), it means that this
registration is set for Auto Renewal. When false (set
to 0), it means that this registration is not set for
Autorenewal.
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringRegistrationStatusText
MonitoringRegistrationStatusEnum, Optional
Records the former status of the monitoring
registration
Possible values: Active; Cancelled
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceText
Aggregate
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceText { CustomerReferenceText
Element
END: UpdateMonitoringRegistrationResponse }UpdateMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail } InquiryReferenceText
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 162
Name Characteristics
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail
Aggregate, Optional
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { NotificationProfileID
int, Optional
A number that uniquely identifies the former
delivery preferences that the customer has set for
Monitoring Alerts before the update.
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the former
category in which the Customer has classified the
subject.
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { AutoRenewalIndicator
boolean, Optional
A boolean value which represents whether the
registration is set for Auto renewal or not before the
update. When true (set to 1), it means that this
registration is set for Auto Renewal. When false (set
to 0), it means that this registration is not set for
Autorenewal.
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { MonitoringRegistrationStatusText
MonitoringRegistrationStatusEnum, Optional
Records the former status of the monitoring
registration
Possible values: Active; Cancelled
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { InquiryReferenceText
Aggregate
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { InquiryReferenceText { CustomerReferenceText
Element
END: UpdateMonitoringRegistrationResponse }UpdateMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail }FormerMonitoringRegistrationDetail } InquiryReferenceText
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 163
Name Characteristics
END: UpdateMonitoringRegistrationResponse }UpdateMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail }FormerMonitoringRegistrationDetail
/Aggregate
END: UpdateMonitoringRegistrationResponse }UpdateMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail
/Aggregate
END: UpdateMonitoringRegistrationResponse }UpdateMonitoringRegistrationResponseDetail
/Aggregate
END: UpdateMonitoringRegistrationResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM001, CM002, CM004, CM011, CM012,CM018, CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 Invalid Monitoring Profile ID; or Invalid Notification Profile ID.
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present in the request,Sequence of the element is not matching in the schema, Data type mismatch or Invalid notification Level).
CM009 Missing reason code
CM012 Invalid subject- Duns number
CM023 Duplicate Registration
PD003 DUNS stop distribution
PD005 Requested Product not available
PD016 DUNS transferred
PD017 DUNS out of business
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 164
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
ListMonitoringRegistration (REST), AddMonitoringRegistration (REST).
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 165
UpdateMonitoringRegistration (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Numberand initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, orevents with data layer included.
Caution: This operation will update multiple registrations based on the input parameters provided. Forexample, if a D-U-N-S Number is not provided, all registrations with matching Monitoring and NotificationProfile IDs will be affected by the change requested. If no input criteria provided, all registrations will beaffected.
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
The following parameters are accepted by this operation.
When monitoring the People data layer, a principal identification number (Principal ID) will be required bythis operation.
Name Characteristics
UpdateMonitoringRegistrationRequest Aggregate
UpdateMonitoringRegistrationRequest@ServiceVersionNumber Attribute
UpdateMonitoringRegistrationRequest@xsi:schemaLocation Attribute
UpdateMonitoringRegistrationRequest. TransactionDetail Aggregate, Optional
Records information necessary to process this
request.
D&B Direct API Documentation UpdateMonitoringRegistration (SOAP)
©Dun & Bradstreet, Inc. 2015 166
Name Characteristics
UpdateMonitoringRegistrationRequest. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to
uniquely identify this request.
UpdateMonitoringRegistrationRequest. TransactionDetail.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.
UpdateMonitoringRegistrationRequest. TransactionDetail.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.
END: UpdateMonitoringRegistrationRequest. TransactionDetail /Aggregate
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail
Aggregate, Required
Records the details of request to update existing
monitoring registration(s)
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationDetail
Aggregate, Optional
Records the details of the existing registrations
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationDetail. DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Optional
Records the duns number that is provided by the
customer to register for Monitoring.
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail. InquiryDetail.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber
Element
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 167
Name Characteristics
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationDetail. MonitoringProfileID
int, Optional
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationDetail. NotificationProfileID
int, Optional
A number that uniquely identifies the delivery
preferences that the customer has set for Monitoring
Alerts.
END: UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationDetail
/Aggregate
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification
Aggregate, Required
Records the specification of the registrations update
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification.NotificationProfileID
int, Optional
The number that uniquely identifies the new delivery
preferences that the customer has set for Monitoring
Alerts.
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification.AutoRenewalIndicator
boolean, Optional
When true (set to 1), it means that this registration is
set for Auto Renewal. When false (set to 0), it means
that this registration is not set for Autorenewal.
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification.SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the category in
which the Customer has classified the subject.
Possible values: High; Medium; Low
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 168
Name Characteristics
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification.MonitoringRegistrationStatusText
MonitoringRegistrationStatusEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled; Pending; Expired;
RegistrationFailed:StopDistribution,
RegistrationFailed:TooOldData,
RegistrationFailed:ProductAvailabilityFailure,
RegistrationFailed
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification.InquiryReferenceText
Aggregate
UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification.InquiryReferenceText. CustomerReferenceText
Element
END: UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification.InquiryReferenceText
/Aggregate
END: UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification
/Aggregate
END: UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail
/Aggregate
END: UpdateMonitoringRegistrationRequest /Aggregate
Testing / Sandbox
This operation will return results in the D&B Direct sandbox (test) environment only when a test D-U-N-SNumber is provided in the request parameters.
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response. In caseswhere multiple registrations were affected by the update, only the UpdatedRegistrationCount will be returned.
Name Characteristics
UpdateMonitoringRegistrationResponse Aggregate
UpdateMonitoringRegistrationResponse@ServiceVersionNumber Attribute
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 169
Name Characteristics
UpdateMonitoringRegistrationResponse@xsi:schemaLocation Attribute
UpdateMonitoringRegistrationResponse. TransactionDetail Aggregate, Required
Records information necessary to process a
particular request. Examples of a request is the
ordering of a product.
UpdateMonitoringRegistrationResponse. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to
uniquely identify this request.
UpdateMonitoringRegistrationResponse. TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
UpdateMonitoringRegistrationResponse. 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: UpdateMonitoringRegistrationResponse. TransactionDetail /Aggregate
UpdateMonitoringRegistrationResponse. TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to
record the different outcomes of the transaction.
UpdateMonitoringRegistrationResponse. TransactionResult.SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
UpdateMonitoringRegistrationResponse. TransactionResult.ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
UpdateMonitoringRegistrationResponse. TransactionResult.ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 170
Name Characteristics
UpdateMonitoringRegistrationResponse. TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
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.
UpdateMonitoringRegistrationResponse. TransactionResult.ResultMessage. ResultDescription
string up to 512 chars., Required
Text that describes the additional information
regarding the outcome of the transaction.
END: UpdateMonitoringRegistrationResponse. TransactionResult.ResultMessage
/Aggregate
END: UpdateMonitoringRegistrationResponse. TransactionResult /Aggregate
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail
Aggregate, Optional
Records the details of the updated monitoring
registration(s)
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.UpdatedRegistrationCount
int, Required
A numeric value which records the count of
registrations updated for the details provided by the
customer in the request
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail
Aggregate, Optional (Infinite)
Records the details of monitoring registration before
and after the update
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
Records the duns number that is provided by the
customer to update the Monitoring registration.
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. MonitoringProfileID
int, Required
A number that uniquely identifies a set of events
and their thresholds, used to monitor a DUNS or a
set of DUNS.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 171
Name Characteristics
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. NotificationProfileID
int, Optional
A number that uniquely identifies the former
delivery preferences that the customer has set for
Monitoring Alerts before the update.
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the former
category in which the Customer has classified the
subject.
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. AutoRenewalIndicator
boolean, Optional
A boolean value which represents whether the
registration is set for Auto renewal or not before the
update. When true (set to 1), it means that this
registration is set for Auto Renewal. When false (set
to 0), it means that this registration is not set for
Autorenewal.
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. MonitoringRegistrationStatusText
MonitoringRegistrationStatusEnum, Optional
Records the former status of the monitoring
registration
Possible values: Active; Cancelled
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceText
Aggregate
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceText.CustomerReferenceText
Element
END: UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceText
/Aggregate
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail
Aggregate, Optional
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 172
Name Characteristics
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail. NotificationProfileID
int, Optional
A number that uniquely identifies the former
delivery preferences that the customer has set for
Monitoring Alerts before the update.
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail. SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the former
category in which the Customer has classified the
subject.
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail. AutoRenewalIndicator
boolean, Optional
A boolean value which represents whether the
registration is set for Auto renewal or not before the
update. When true (set to 1), it means that this
registration is set for Auto Renewal. When false (set
to 0), it means that this registration is not set for
Autorenewal.
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail.MonitoringRegistrationStatusText
MonitoringRegistrationStatusEnum, Optional
Records the former status of the monitoring
registration
Possible values: Active; Cancelled
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail. InquiryReferenceText
Aggregate
UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail. InquiryReferenceText.CustomerReferenceText
Element
END: UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail. InquiryReferenceText
/Aggregate
END: UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 173
Name Characteristics
END: UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail
/Aggregate
END: UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail
/Aggregate
END: UpdateMonitoringRegistrationResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM001, CM002, CM004, CM011, CM012,CM018, CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.
Operation-specific supplemental response code explanations:
CM001 Invalid Monitoring Profile ID; or Invalid Notification Profile ID.
CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present in the request,Sequence of the element is not matching in the schema, Data type mismatch or Invalid notification Level).
CM009 Missing reason code
CM012 Invalid subject- Duns number
CM023 Duplicate Registration
PD003 DUNS stop distribution
PD005 Requested Product not available
PD016 DUNS transferred
PD017 DUNS out of business
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 174
Related Topics
ListMonitoringRegistration (SOAP), AddMonitoringRegistration (SOAP).
D&B Direct API Documentation Related Topics
©Dun & Bradstreet, Inc. 2015 175
ListMonitoringRegistration (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Numberand initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, orevents with data layer included.
Refer to How to Retrieve Monitoring Registrations for an overview of this operation.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
GET https://maxcvservices.dnb.com/V{version}/monitoring/registrations
Request Parameters
The following parameters are accepted by this operation.
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.
D&B Direct API Documentation ListMonitoringRegistration (REST)
©Dun & Bradstreet, Inc. 2015 176
Name Characteristics
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.
InquiryDUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required
Records the duns number that is provided by the
customer to register for Monitoring.
DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Optional
Records the duns number that is registered for
Monitoring.
CountryISOAlpha2Code string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-
1 scheme published by International Organization
for Standardization (ISO)identifying the country of
the inquired subject.
MonitoringProfileID int, Optional
A number that uniquely identifies a set of events
and their thresholds, used to monitor a DUNS or a
set of DUNS.
DNBProductID string up to 64 chars., Optional
Records the product code that is provided by the
customer to create a profile
MonitoringLevel MonitoringLevelTextEnum up to 16 chars., Optional
A alphanumeric string which determines the level of
details that the customer will receive during a
change event
Possible values: Level1; Level2
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 177
Name Characteristics
NotificationProfileID int, Optional
A number that uniquely identifies the delivery
preferences that the customer has set for
Monitoring Alerts.
AutoRenewalIndicator boolean, Optional
When true (set to 1), it means that this registration
is set for Auto Renewal. When false (set to 0), it
means that this registration is not set for
Autorenewal.
SubjectCategoryText string up to 32 chars., Optional
An alphanumeric value identifying the category in
which the Customer has classified the subject.
Possible values: High; Medium; Low
RegisteredFromDate date, Optional
Records the start date of the date range to list the
registrations.
RegisteredToDate date, Optional
Records the end date of the date range to list the
registrations.
MonitoringRegistrationStatusText MonitoringRegistartionStatusTextEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled; Pending; Expired,
RegistrationFailed:StopDistribution,
RegistrationFailed:TooOldData,
RegistrationFailed:ProductAvailabilityFailure,
RegistrationFailed
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 178
Name Characteristics
SortBasisText MonitoringSortBasisEnum, Optional
Records the list of fields based on which sorting is
possible
Possible values: DUNSNumber;
CountryISOAlpha2Code; MonitoringProfileID;
DNBProductID; MonitoringLevel;
NotificationProfileID; RegistrationStartDate;
SubjectCategoryText; AutoRenewalIndicator;
MonitoringRegistartionStatusText
SortDirectionText SortDirectionEnum, Optional
Records the direction of sorting. Possbile values are
Ascending, Descending
CandidatePerPageMaximumQuantity int Less than or equal to 1000., Optional
Records the maximum quantity that can be
displayed per page
CandidateDisplayStartSequenceNumber int, Optional
Records the Display sequence number of the results
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
ListMonitoringRegistrationResponse Aggregate
ListMonitoringRegistrationResponse@ServiceVersionNumber Attribute
ListMonitoringRegistrationResponse@xsi:schemaLocation Attribute
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 179
Name Characteristics
ListMonitoringRegistrationResponse { TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
ListMonitoringRegistrationResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
ListMonitoringRegistrationResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
ListMonitoringRegistrationResponse { 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: ListMonitoringRegistrationResponse } TransactionDetail /Aggregate
ListMonitoringRegistrationResponse { TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record
the different outcomes of the transaction.
ListMonitoringRegistrationResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
ListMonitoringRegistrationResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
ListMonitoringRegistrationResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 180
Name Characteristics
ListMonitoringRegistrationResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
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.
ListMonitoringRegistrationResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding
the outcome of the transaction.
END: ListMonitoringRegistrationResponse }TransactionResult } ResultMessage
/Aggregate
END: ListMonitoringRegistrationResponse }TransactionResult
/Aggregate
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail
Aggregate, Optional
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { CandidateMatchedQuantity
int up to 6 digits., Required
The number of registrations listed as possible matches
in the result set based on the search criteria in the
Customer/User request.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { CandidateReturnedQuantity
int up to 6 digits., Required
The number of registrations returned in the result set
based on the search criteria in the Customer/User
request.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail
Aggregate, Optional (Infinite)
Records the details of the registrations returned in the
result set based on the search criteria in the
Customer/User request.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryDetail
Aggregate, Optional
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { 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.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 181
Name Characteristics
END: ListMonitoringRegistrationResponse }ListMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail } InquiryDetail
/Aggregate
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
Records the duns number that is registered for
Monitoring.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B
which either uniquely identifies or helps to identify an
individual.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DNBProductID
string up to 64 chars., Required
Records the product code that is provided by the
customer to create a profile
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringLevel
MonitoringLevelTextEnum up to 16 chars., Required
A alphanumeric string which determines the level of
details that the customer will receive during a change
event
Possible values: Level1; Level2
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { NotificationProfileID
int, Required
A number that uniquely identifies the delivery
preferences that the customer has set for Monitoring
Alerts.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 182
Name Characteristics
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { AutoRenewalIndicator
boolean, Required
When true (set to 1), it means that this registration is
set for Auto Renewal. When false (set to 0), it means
that this registration is not set for Autorenewal.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the category in
which the Customer has classified the subject.
Possible values: High; Medium; Low
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { RegistrationReasonCode
integer up to 7 digits., Optional
Code identifying the reason for the Customer showing
interest to monitor this subject. This reason needs to be
captured to comply with German Data Protection Laws.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { StartDate
date, Required
The date when the subject has been registered for
monitoring.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { EndDate
date, Required
The date when the subject registration for monitoring
has been ended.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringRegistrationStatusText
MonitoringRegistartionStatusTextEnum, Required
Records the status of the monitoring registration
Possible values: Active; Cancelled; Expired,
RegistrationFailed:StopDistribution,
RegistrationFailed:TooOldData,
RegistrationFailed:ProductAvailabilityFailure,
RegistrationFailed
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to
support subsequent order reconciliation.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 183
Name Characteristics
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail { CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to
be linked to the product in order to support subsequent
order reconciliation.
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail { CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly
contains requesting individual or department name, or
customer's own account/reference number and/or
name for the case on which the product was
provided.This text is a reference used during the billing
process.
END: ListMonitoringRegistrationResponse }ListMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail } InquiryReferenceDetail
/Aggregate
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DisplaySequence
int, Optional
Records the display sequence number of the results
END: ListMonitoringRegistrationResponse }ListMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail
/Aggregate
END: ListMonitoringRegistrationResponse }ListMonitoringRegistrationResponseDetail
/Aggregate
END: ListMonitoringRegistrationResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM011, CM018, SC001-SC009.
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 184
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
UpdateMonitoringRegistration (REST), AddMonitoringRegistration (REST).
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 185
ListMonitoringRegistration (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Numberand initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, orevents with data layer included.
Refer to How to Retrieve Monitoring Registrations for an overview of this operation.
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
ListMonitoringRegistrationRequest Aggregate
ListMonitoringRegistrationRequest@ServiceVersionNumber Attribute
ListMonitoringRegistrationRequest@xsi:schemaLocation Attribute
ListMonitoringRegistrationRequest. TransactionDetail Aggregate, Optional
Records information necessary to process this request.
ListMonitoringRegistrationRequest. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
D&B Direct API Documentation ListMonitoringRegistration (SOAP)
©Dun & Bradstreet, Inc. 2015 186
Name Characteristics
ListMonitoringRegistrationRequest. TransactionDetail.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.
ListMonitoringRegistrationRequest. TransactionDetail.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.
END: ListMonitoringRegistrationRequest. TransactionDetail /Aggregate
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail
Aggregate, Required
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria
Aggregate, Optional
Records the search criteria to list the registrations
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. InquiryDetail
Aggregate, Optional
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. 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.
END: ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. InquiryDetail
/Aggregate
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Optional
Records the duns number that is registered for
Monitoring.
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which
either uniquely identifies or helps to identify an individual.
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 187
Name Characteristics
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Optional
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. MonitoringProfileID
int, Optional
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. DNBProductID
string up to 64 chars., Optional
Records the product code that is provided by the
customer to create a profile
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. MonitoringLevel
MonitoringLevelTextEnum up to 16 chars., Optional
A alphanumeric string which determines the level of
details that the customer will receive during a change
event
Possible values: Level1; Level2
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. NotificationProfileID
int, Optional
A number that uniquely identifies the delivery
preferences that the customer has set for Monitoring
Alerts.
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. AutoRenewalIndicator
boolean, Optional
When true (set to 1), it means that this registration is set
for Auto Renewal. When false (set to 0), it means that
this registration is not set for Autorenewal.
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the category in which
the Customer has classified the subject.
Possible values: High; Medium; Low
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 188
Name Characteristics
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. RegisteredFromDate
date, Optional
Records the start date of the date range to list the
registrations.
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. RegisteredToDate
date, Optional
Records the end date of the date range to list the
registrations.
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria.MonitoringRegistrationStatusText
MonitoringRegistartionStatusTextEnum, Optional
Records the status of the monitoring registration
Possible values: Active; Cancelled; Pending; Expired;
RegistrationFailed:StopDistribution,
RegistrationFailed:TooOldData,
RegistrationFailed:ProductAvailabilityFailure,
RegistrationFailed
END: ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria
/Aggregate
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationDisplaySpecification
Aggregate, Optional
Records the specifications of the registraions display
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationDisplaySpecification. SortBasisText
MonitoringSortBasisEnum, Optional
Records the list of fields based on which sorting is
possible
Possible values: DUNSNumber; CountryISOAlpha2Code;
MonitoringProfileID; DNBProductID; MonitoringLevel;
NotificationProfileID; RegistrationStartDate;
SubjectCategoryText; AutoRenewalIndicator;
MonitoringRegistartionStatusText
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationDisplaySpecification.SortDirectionText
SortDirectionEnum, Optional
Records the direction of sorting. Possbile values are
Ascending, Descending
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 189
Name Characteristics
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationDisplaySpecification.CandidatePerPageMaximumQuantity
int Less than or equal to 1000., Optional
Records the maximum quantity that can be displayed per
page
ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationDisplaySpecification.CandidateDisplayStartSequenceNumber
int, Optional
Records the Display sequence number of the results
END: ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationDisplaySpecification
/Aggregate
END: ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail
/Aggregate
END: ListMonitoringRegistrationRequest /Aggregate
Testing / Sandbox
This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response.
Name Characteristics
ListMonitoringRegistrationResponse Aggregate
ListMonitoringRegistrationResponse@ServiceVersionNumber Attribute
ListMonitoringRegistrationResponse@xsi:schemaLocation Attribute
ListMonitoringRegistrationResponse. TransactionDetail Aggregate, Required
Records information necessary to process a particular
request. Examples of a request is the ordering of a
product.
ListMonitoringRegistrationResponse. TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely
identify this request.
ListMonitoringRegistrationResponse. TransactionDetail.ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely
identify this transaction.
D&B Direct API Documentation Testing / Sandbox
©Dun & Bradstreet, Inc. 2015 190
Name Characteristics
ListMonitoringRegistrationResponse. 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: ListMonitoringRegistrationResponse. TransactionDetail /Aggregate
ListMonitoringRegistrationResponse. TransactionResult Aggregate, Required
An aggregate that can repeat multiple times to record
the different outcomes of the transaction.
ListMonitoringRegistrationResponse. TransactionResult.SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g.,
Information, Warning, Error, Fatal.
ListMonitoringRegistrationResponse. TransactionResult.ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the
outcome of the transaction.
ListMonitoringRegistrationResponse. TransactionResult.ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
ListMonitoringRegistrationResponse. TransactionResult.ResultMessage
Aggregate, Optional (Infinite)
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.
ListMonitoringRegistrationResponse. TransactionResult.ResultMessage. ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding
the outcome of the transaction.
END: ListMonitoringRegistrationResponse. TransactionResult.ResultMessage
/Aggregate
END: ListMonitoringRegistrationResponse. TransactionResult /Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 191
Name Characteristics
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail
Aggregate, Optional
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.CandidateMatchedQuantity
int up to 6 digits., Required
The number of registrations listed as possible matches
in the result set based on the search criteria in the
Customer/User request.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.CandidateReturnedQuantity
int up to 6 digits., Required
The number of registrations returned in the result set
based on the search criteria in the Customer/User
request.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail
Aggregate, Optional (Infinite)
Records the details of the registrations returned in the
result set based on the search criteria in the
Customer/User request.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryDetail
Aggregate, Optional
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. 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.
END: ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryDetail
/Aggregate
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
Records the duns number that is registered for
Monitoring.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. CountryISOAlpha2Code
string at least 2 chars. up to 2 chars., Required
The two-letter country code, defined in the ISO 3166-1
scheme published by International Organization for
Standardization (ISO)identifying the country of the
inquired subject.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 192
Name Characteristics
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and
their thresholds, used to monitor a DUNS or a set of
DUNS.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. DNBProductID
string up to 64 chars., Required
Records the product code that is provided by the
customer to create a profile
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. MonitoringLevel
MonitoringLevelTextEnum up to 16 chars., Required
A alphanumeric string which determines the level of
details that the customer will receive during a change
event
Possible values: Level1; Level2
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. NotificationProfileID
int, Required
A number that uniquely identifies the delivery
preferences that the customer has set for Monitoring
Alerts.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. AutoRenewalIndicator
boolean, Required
When true (set to 1), it means that this registration is
set for Auto Renewal. When false (set to 0), it means
that this registration is not set for Autorenewal.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the category in
which the Customer has classified the subject.
Possible values: High; Medium; Low
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. RegistrationReasonCode
integer up to 7 digits., Optional
Code identifying the reason for the Customer showing
interest to monitor this subject. This reason needs to be
captured to comply with German Data Protection Laws.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. StartDate
date, Required
The date when the subject has been registered for
monitoring.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 193
Name Characteristics
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. EndDate
date, Required
The date when the subject registration for monitoring
has been ended.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.MonitoringRegistrationStatusText
MonitoringRegistartionStatusTextEnum, Required
Records the status of the monitoring registration
Possible values: Active; Cancelled; Expired,
RegistrationFailed:StopDistribution,
RegistrationFailed:TooOldData,
RegistrationFailed:ProductAvailabilityFailure,
RegistrationFailed
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceDetail
Aggregate, Optional
Records data that allows the customer to specify
information to be linked to the request in order to
support subsequent order reconciliation.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceDetail.CustomerReferenceText
string up to 240 chars., Optional(Up to 5x)
A freeform reference string provided by the customer to
be linked to the product in order to support subsequent
order reconciliation.
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceDetail.CustomerBillingEndorsementText
string at least 1 chars. up to 240 chars., Optional
Text that is filled in by customer and commonly
contains requesting individual or department name, or
customer's own account/reference number and/or
name for the case on which the product was
provided.This text is a reference used during the billing
process.
END: ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceDetail
/Aggregate
ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. DisplaySequence
int, Optional
Records the display sequence number of the results
END: ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail
/Aggregate
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 194
Name Characteristics
END: ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail
/Aggregate
END: ListMonitoringRegistrationResponse /Aggregate
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM011, CM018, SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
UpdateMonitoringRegistration (SOAP), AddMonitoringRegistration (SOAP).
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 195
ListChangeNotice (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Change Notice is triggered whenever a data field for the D-U-N-S Number specified in a MonitoringRegistration exceeds the thresholds set in the Monitoring Profile. Copies of Change Notices are delivered basedon the Notification Profile and may also be retrieved with the ListChangeNotice operation.
Refer to the section "Understanding Change Notices" for some tips and examples.
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
GET https://maxcvservices.dnb.com/V{version}/monitoring/changenotices
Request Parameters
The following parameters are accepted by this operation.
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.
D&B Direct API Documentation ListChangeNotice (REST)
©Dun & Bradstreet, Inc. 2015 196
Name Characteristics
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.
ChangeEventID-n (up to 10 times) long, Optional(Up to 10x)
DUNSNumber-n (up to 10 times) string up to 9 chars. Pattern: {([0-9]*)}., Optional(Up to 10x)
Records the duns number that is registered for Monitoring.
PrincipalIdentificationNumberTypeCode-n Element
PrincipalIdentificationNumber-n string, Optional
A number assigned by an external body or by D&B which
either uniquely identifies or helps to identify an individual.
MonitoringProfileID-n (up to 10 times) int, Optional(Up to 10x)
A number that uniquely identifies a set of events and their
thresholds, used to monitor a DUNS or a set of DUNS.
NotificationProfileID-n (up to 10 times) int, Optional(Up to 10x)
A number that uniquely identifies the delivery preferences
that the customer has set for Monitoring Alerts.
SubjectCategoryText-n (up to 3 times) string up to 32 chars., Optional(Up to 3x)
An alphanumeric value identifying the category in which
the Customer has classified the subject.
DNBProductID-n (up to 10 times) string up to 64 chars., Optional(Up to 10x)
An alphanumeric string that uniquely identifies this
product.
MonitoringLevel MonitoringLevelTextEnum up to 16 chars., Optional
A alphanumeric string which determines the level of details
that the customer will receive during a change event
ReadChangeEventIndicator boolean, Optional
Records the status of the monitoring notification. Possible
values are: Read and unread
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 197
Name Characteristics
ChangeDetectionFromTimestamp DateTimestamp, Optional
The date and time when this notification has been
generated
ChangeDetectionToTimestamp DateTimestamp, Optional
The date and time when this notification has been
generated
GetCountOnlyIndicator boolean, Optional
When true (set to 1) this indicates that the count related to
the resultset is to be returned in the response. When false
(set to 0) this indicates that the details pertaining to result
is to be returned in the response.
SortBasisText-n (up to 4 times) ChangeNoticeSortBasisEnum, Optional
Records the list of fields based on which sorting is possible
SortDirectionText-n (up to 4 times) SortDirectionEnum, Optional
Records the direction of sorting. Possbile values are
Ascending, Descending
CandidatePerPageMaximumQuantity int Less than or equal to 1000., Optional
Records the maximum quantity that can be displayed per
page
CandidateDisplayStartSequenceNumber int, Optional
Records the Display sequence number of the results
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response.
Name Characteristics
ListChangeNoticeResponse Aggregate
ListChangeNoticeResponse@ServiceVersionNumber
Attribute
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 198
Name Characteristics
ListChangeNoticeResponse { TransactionDetail
Aggregate, Required
Records information necessary to process a particular request.
Examples of a request is the ordering of a product.
ListChangeNoticeResponse { TransactionDetail { ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this
request.
ListChangeNoticeResponse { TransactionDetail { ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify this
transaction.
ListChangeNoticeResponse { 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: ListChangeNoticeResponse }TransactionDetail
/Aggregate
ListChangeNoticeResponse { TransactionResult
Aggregate, Required
An aggregate that can repeat multiple times to record the different
outcomes of the transaction.
ListChangeNoticeResponse { TransactionResult { SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g., Information,
Warning, Error, Fatal.
ListChangeNoticeResponse { TransactionResult { ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome of the
transaction.
ListChangeNoticeResponse { TransactionResult { ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 199
Name Characteristics
ListChangeNoticeResponse { TransactionResult { ResultMessage
Aggregate, Optional (Infinite)
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.
ListChangeNoticeResponse { TransactionResult { ResultMessage { ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the outcome
of the transaction.
End: ListChangeNoticeResponse }TransactionResult } ResultMessage
/Aggregate
End: ListChangeNoticeResponse }TransactionResult
/Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail
Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { CandidateMatchedQuantity
int up to 6 digits., Optional
The number of registrations listed as possible matches in the result set
based on the search criteria in the Customer/User request.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { CandidateReturnedQuantity
int up to 6 digits., Optional
The number of registrations returned in the result set based on the
search criteria in the Customer/User request.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary
Aggregate, Optional (Infinite)
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Optional
Records the duns number that is registered for Monitoring.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { ReadNoticeCount
int, Required
Records the count of read notifications for the input criteria
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { UnreadNoticeCount
int, Required
Records the count of unread notifications for the input criteria
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { TotalNoticeCount
int, Required
Records the count of total notifications for the input criteria
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 200
Name Characteristics
End: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }NoticeCountSummary
/Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail
Aggregate, Optional (Infinite)
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail
Aggregate, Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
Records the duns number that is registered for Monitoring.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { PrincipalIdentificationNumberDetail
Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { PrincipalIdentificationNumberDetail@DNBCodeValue
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { PrincipalIdentificationNumberDetail@TypeText
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which either
uniquely identifies or helps to identify an individual.
End: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } SubjectDetail }PrincipalIdentificationNumberDetail
/Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { CountryISOAlpha2Code
Aggregate, Required
The two-letter country code, defined in the ISO 3166-1 scheme
published by International Organization for Standardization (ISO)
identifying the country of the inquired subject.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 201
Name Characteristics
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { OrganizationPrimaryName
Aggregate, Optional (Infinite)
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.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { OrganizationPrimaryName { OrganizationName
string up to 256 chars., Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { OrganizationPrimaryName { OrganizationName@WritingScriptISOAlpha4Code
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { OrganizationPrimaryName { OrganizationName @LanguageCode
Attribute
End: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } SubjectDetail }OrganizationPrimaryName
/Aggregate
End: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } SubjectDetail
/Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the category in which the Customer
has classified the subject.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { LanguageCode
integer up to 7 digits., Required
A D&B code value that defines a language in which the specified
product is available.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { MonitoringProfileDetail
Aggregate, Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { MonitoringProfileDetail{ MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and their thresholds,
used to monitor a DUNS or a set of DUNS.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 202
Name Characteristics
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { MonitoringProfileDetail{ DNBProductID
string up to 64 chars., Required
An alphanumeric string that uniquely identifies this product.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { MonitoringProfileDetail{ MonitoringLevel
MonitoringLevelTextEnum up to 16 chars., Required
A alphanumeric string which determines the level of details that the
customer will receive during a change event
End: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } MonitoringProfileDetail
/Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { NotificationProfileID
int, Required
A number that uniquely identifies the delivery preferences that the
customer has set for Monitoring Alerts.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent
Aggregate, Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { ChangeEventID
long, Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { ChangeDetectionTimestamp
DateTimestamp, Required
The date and time when this notification has been generated
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { ElementName
string up to 64 chars., Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { PCMElementXPATHText
string up to 3000 chars., Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element
_, Optional (Infinite)
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element@ChangeType
AttributePossible values: Dropped; NewlyAdded; NoChange; ValueChanged
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 203
Name Characteristics
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element@PCMElementXPATHText
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element@OldValue
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { ReadChangeEventIndicator
boolean, Required
Records the status of the monitoring notification. Possible values are:
Read and unread
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange
Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeType
string, RequiredPossible values: Add, Drop.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText
string up to 256 chars., Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText@DNBCodeValue
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText@DNBCodeTableNumber
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization
Aggregate, Optional
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 204
Name Characteristics
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization{ AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint Parent
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization{ AssociationTypeText@DNBCodeValue
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization{ AssociationTypeText@DNBCodeTableNumber
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization{ 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: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } ChangeEvent }LinkageChange } GlobalUltimateOrganization
/Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization
Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint Parent
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { AssociationTypeText@DNBCodeValue
Attribute
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 205
Name Characteristics
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { AssociationTypeText@DNBCodeTableNumber
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { 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: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } ChangeEvent }LinkageChange }FormerGlobalUltimateOrganization
/Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization
Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint Parent
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { AssociationTypeText@DNBCodeValue
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { AssociationTypeText@DNBCodeTableNumber
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { 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).
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 206
Name Characteristics
END: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } ChangeEvent }LinkageChange }UpwardFamilyMemberOrganization
/Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization
Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint Parent
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { AssociationTypeText@DNBCodeValue
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { AssociationTypeText@DNBCodeTableNumber
Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { 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: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } ChangeEvent }LinkageChange }FormerUpwardFamilyMemberOrganization
/Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChildrenSummary
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the recording of
the number of children of various types for the Subject.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 207
Name Characteristics
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChildrenSummary { ChildrenQuantity
int up to 8 digits., Optional
The total number of children of the linked Family Tree Subject of the
type specified by Children Type Text.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChildrenSummary { DirectChildrenIndicator
boolean, Optional
When true (set to 1)it indicates immediate children only.
END: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } ChangeEvent }LinkageChange } ChildrenSummary
/Aggregate
END: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } ChangeEvent }LinkageChange
/Aggregate
End: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } ChangeEvent
/Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { DisplaySequence
int, Optional
End: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail
/Aggregate
End: ListChangeNoticeResponse }ListChangeNoticeResponseDetail
/Aggregate
End: ListChangeNoticeResponse /Aggregate
Additional Details
A copy of the complete data layer in Base64 encoded format may be obtained by using theGetMonitoringProduct operation whenever level 2 monitoring is specified on the initialAddMonitoringRegistration call.
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
D&B Direct API Documentation Additional Details
©Dun & Bradstreet, Inc. 2015 208
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM018, SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2015 209
ListChangeNotice (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
A Change Notice is triggered whenever a data field for the D-U-N-S Number specified in a MonitoringRegistration exceeds the thresholds set in the Monitoring Profile. Copies of Change Notices are delivered basedon the Notification Profile and may also be retrieved with the ListChangeNotice operation.
Refer to the section "Understanding Change Notices" for some tips and examples.
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
ListChangeNoticeRequest Aggregate
ListChangeNoticeRequest@ServiceVersionNumber
Attribute
ListChangeNoticeRequest.TransactionDetail
Aggregate, Optional
Records information necessary to process this request.
ListChangeNoticeRequest.TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this request.
ListChangeNoticeRequest.TransactionDetail.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.
D&B Direct API Documentation ListChangeNotice (SOAP)
©Dun & Bradstreet, Inc. 2015 210
Name Characteristics
ListChangeNoticeRequest.TransactionDetail. 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.
End: ListChangeNoticeRequest.TransactionDetail
/Aggregate
ListChangeNoticeRequest.ListChangeNoticeRequestDetail
Aggregate, Optional
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria
Aggregate, Optional
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.ChangeEventID
long, Optional(Up to 10x)
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria. DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Optional(Up to 10x)
Records the duns number that is registered for Monitoring.
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.PrincipalIdentificationNumberDetail
Aggregate, Optional(Up to 10x)
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.PrincipalIdentificationNumberDetail@DNBCodeValue
Attribute
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.PrincipalIdentificationNumberDetail@TypeText
Attribute
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which either uniquely
identifies or helps to identify an individual.
End: ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.PrincipalIdentificationNumberDetail
/Aggregate
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 211
Name Characteristics
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.MonitoringProfileID
int, Optional(Up to 10x)
A number that uniquely identifies a set of events and their thresholds, used
to monitor a DUNS or a set of DUNS.
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.NotificationProfileID
int, Optional(Up to 10x)
A number that uniquely identifies the delivery preferences that the customer
has set for Monitoring Alerts.
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.SubjectCategoryText
string up to 32 chars., Optional(Up to 3x)
An alphanumeric value identifying the category in which the Customer has
classified the subject.
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria. DNBProductID
string up to 64 chars., Optional(Up to 10x)
An alphanumeric string that uniquely identifies this product.
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.MonitoringLevel
MonitoringLevelTextEnum up to 16 chars., Optional
A alphanumeric string which determines the level of details that the
customer will receive during a change event
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.ReadChangeEventIndicator
boolean, Optional
Records the status of the monitoring notification. Possible values are: Read
and unread
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.ChangeDetectionFromTimestamp
DateTimestamp, Optional
The date and time when this notification has been generated
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.ChangeDetectionToTimestamp
DateTimestamp, Optional
The date and time when this notification has been generated
End: ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria
/Aggregate
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification
Aggregate, Optional
D&B Direct API Documentation Request Parameters
©Dun & Bradstreet, Inc. 2015 212
Name Characteristics
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.GetCountOnlyIndicator
boolean, Optional
When true (set to 1) this indicates that the count related to the resultset is
to be returned in the response. When false (set to 0) this indicates that the
details pertaining to result is to be returned in the response.
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.SortSpecification
Aggregate, Optional(Up to 4x)
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.SortSpecification. SortBasisText
ChangeNoticeSortBasisEnum, Optional
Records the list of fields based on which sorting is possible
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.SortSpecification. SortDirectionText
SortDirectionEnum, Optional
Records the direction of sorting. Possbile values are Ascending, Descending
End: ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.SortSpecification
/Aggregate
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.CandidatePerPageMaximumQuantity
int Less than or equal to 1000., Optional
Records the maximum quantity that can be displayed per page
ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.CandidateDisplayStartSequenceNumber
int, Optional
Records the Display sequence number of the results
End: ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification
/Aggregate
End: ListChangeNoticeRequest.ListChangeNoticeRequestDetail
/Aggregate
End: ListChangeNoticeRequest /Aggregate
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 213
Name Characteristics
ListChangeNoticeResponse Aggregate
ListChangeNoticeResponse@ServiceVersionNumber
Attribute
ListChangeNoticeResponse. TransactionDetail Aggregate, Required
Records information necessary to process a particular request.
Examples of a request is the ordering of a product.
ListChangeNoticeResponse.TransactionDetail. ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this
request.
ListChangeNoticeResponse.TransactionDetail. ServiceTransactionID
string up to 64 chars., Required
A number assigned by the D&B service to uniquely identify this
transaction.
ListChangeNoticeResponse.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: ListChangeNoticeResponse.TransactionDetail
/Aggregate
ListChangeNoticeResponse.TransactionResult
Aggregate, Required
An aggregate that can repeat multiple times to record the different
outcomes of the transaction.
ListChangeNoticeResponse.TransactionResult. SeverityText
string up to 16 chars., Required
Text that records the criticality of the outcome, e.g., Information,
Warning, Error, Fatal.
ListChangeNoticeResponse.TransactionResult. ResultID
string up to 32 chars., Required
An alphanumeric string that uniquely identifies the outcome of the
transaction.
ListChangeNoticeResponse.TransactionResult. ResultText
string up to 512 chars., Optional
Text that explains the outcome of the transaction.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 214
Name Characteristics
ListChangeNoticeResponse.TransactionResult. ResultMessage
Aggregate, Optional (Infinite)
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.
ListChangeNoticeResponse.TransactionResult. ResultMessage.ResultDescription
string up to 512 chars., Required
Text that describes the additional information regarding the outcome
of the transaction.
End: ListChangeNoticeResponse.TransactionResult. ResultMessage
/Aggregate
End: ListChangeNoticeResponse.TransactionResult
/Aggregate
ListChangeNoticeResponse.ListChangeNoticeResponseDetail
Aggregate, Optional
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.CandidateMatchedQuantity
int up to 6 digits., Optional
The number of registrations listed as possible matches in the result set
based on the search criteria in the Customer/User request.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.CandidateReturnedQuantity
int up to 6 digits., Optional
The number of registrations returned in the result set based on the
search criteria in the Customer/User request.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.NoticeCountSummary
Aggregate, Optional (Infinite)
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.NoticeCountSummary. DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Optional
Records the duns number that is registered for Monitoring.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.NoticeCountSummary. ReadNoticeCount
int, Required
Records the count of read notifications for the input criteria
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.NoticeCountSummary. UnreadNoticeCount
int, Required
Records the count of unread notifications for the input criteria
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.NoticeCountSummary. TotalNoticeCount
int, Required
Records the count of total notifications for the input criteria
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 215
Name Characteristics
End: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.NoticeCountSummary
/Aggregate
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail
Aggregate, Optional (Infinite)
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail
Aggregate, Required
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
Records the duns number that is registered for Monitoring.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.PrincipalIdentificationNumberDetail
Aggregate, Optional
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.PrincipalIdentificationNumberDetail@DNBCodeValue
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.PrincipalIdentificationNumberDetail@TypeText
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber
string, Optional
A number assigned by an external body or by D&B which either
uniquely identifies or helps to identify an individual.
End: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.PrincipalIdentificationNumberDetail
/Aggregate
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.CountryISOAlpha2Code
Aggregate, Required
The two-letter country code, defined in the ISO 3166-1 scheme
published by International Organization for Standardization (ISO)
identifying the country of the inquired subject.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 216
Name Characteristics
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.OrganizationPrimaryName
Aggregate, Optional (Infinite)
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.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.OrganizationPrimaryName.OrganizationName
string up to 256 chars., Required
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.OrganizationPrimaryName.OrganizationName@WritingScriptISOAlpha4Code
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.OrganizationPrimaryName.OrganizationName @LanguageCode
Attribute
End: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.OrganizationPrimaryName
/Aggregate
End: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail
/Aggregate
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectCategoryText
string up to 32 chars., Optional
An alphanumeric value identifying the category in which the Customer
has classified the subject.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. LanguageCode
integer up to 7 digits., Required
A D&B code value that defines a language in which the specified
product is available.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. MonitoringProfileDetail
Aggregate, Required
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. MonitoringProfileDetail.MonitoringProfileID
int, Required
A number that uniquely identifies a set of events and their thresholds,
used to monitor a DUNS or a set of DUNS.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 217
Name Characteristics
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. MonitoringProfileDetail.DNBProductID
string up to 64 chars., Required
An alphanumeric string that uniquely identifies this product.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. MonitoringProfileDetail.MonitoringLevel
MonitoringLevelTextEnum up to 16 chars., Required
A alphanumeric string which determines the level of details that the
customer will receive during a change event
End: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. MonitoringProfileDetail
/Aggregate
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. NotificationProfileID
int, Required
A number that uniquely identifies the delivery preferences that the
customer has set for Monitoring Alerts.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent
Aggregate, Required
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.ChangeEventID
long, Required
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.ChangeDetectionTimestamp
DateTimestamp, Required
The date and time when this notification has been generated
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.ElementName
string up to 64 chars., Required
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.PCMElementXPATHText
string up to 3000 chars., Required
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent. Element
_, Optional (Infinite)
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent. Element@ChangeType
AttributePossible values: Dropped; NewlyAdded; NoChange; ValueChanged
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 218
Name Characteristics
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent. Element@PCMElementXPATHText
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent. Element@OldValue
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.ReadChangeEventIndicator
boolean, Required
Records the status of the monitoring notification. Possible values are:
Read and unread
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange
Aggregate, Optional
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. DUNSNumber
string up to 9 chars. Pattern: {([0-9]*)}., Required
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. ChangeType
string, RequiredPossible values: Add, Drop.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. ChangeReasonText
string up to 256 chars., Optional
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.ChangeReasonText@DNBCodeValue
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.ChangeReasonText@DNBCodeTableNumber
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. GlobalUltimateOrganization
Aggregate, Optional
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 219
Name Characteristics
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. GlobalUltimateOrganization.AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint Parent
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. GlobalUltimateOrganization.AssociationTypeText@DNBCodeValue
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. GlobalUltimateOrganization.AssociationTypeText@DNBCodeTableNumber
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. GlobalUltimateOrganization.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: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. GlobalUltimateOrganization
/Aggregate
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization
Aggregate, Optional
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization.AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint Parent
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization.AssociationTypeText@DNBCodeValue
Attribute
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 220
Name Characteristics
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization.AssociationTypeText@DNBCodeTableNumber
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization.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: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization
/Aggregate
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.UpwardFamilyMemberOrganization
Aggregate, Optional
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.UpwardFamilyMemberOrganization.AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint Parent
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.UpwardFamilyMemberOrganization.AssociationTypeText@DNBCodeValue
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.UpwardFamilyMemberOrganization.AssociationTypeText@DNBCodeTableNumber
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.UpwardFamilyMemberOrganization.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).
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 221
Name Characteristics
END: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.UpwardFamilyMemberOrganization
/Aggregate
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerUpwardFamilyMemberOrganization
Aggregate, Optional
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerUpwardFamilyMemberOrganization.AssociationTypeText
string up to 256 chars., Optional
Text that defines the nature of the relationship of the linked
organization to the business subject, e.g., Parent, HQ, Joint Parent
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerUpwardFamilyMemberOrganization.AssociationTypeText@DNBCodeValue
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerUpwardFamilyMemberOrganization.AssociationTypeText@DNBCodeTableNumber
Attribute
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerUpwardFamilyMemberOrganization.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: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerUpwardFamilyMemberOrganization
/Aggregate
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. ChildrenSummary
Aggregate, Optional (Infinite)
An entry loop which can repeat multiple times to allow the recording of
the number of children of various types for the Subject.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 222
Name Characteristics
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. ChildrenSummary.ChildrenQuantity
int up to 8 digits., Optional
The total number of children of the linked Family Tree Subject of the
type specified by Children Type Text.
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. ChildrenSummary.DirectChildrenIndicator
boolean, Optional
When true (set to 1)it indicates immediate children only.
END: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. ChildrenSummary
/Aggregate
END: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange
/Aggregate
End: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent
/Aggregate
ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. DisplaySequence
int, Optional
End: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail
/Aggregate
End: ListChangeNoticeResponse.ListChangeNoticeResponseDetail
/Aggregate
End: ListChangeNoticeResponse /Aggregate
Additional Details
A copy of the complete data layer in Base64 encoded format may be obtained by using theGetMonitoringProduct operation whenever level 2 monitoring is specified on the initialAddMonitoringRegistration call.
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
D&B Direct API Documentation Additional Details
©Dun & Bradstreet, Inc. 2015 223
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM002, CM004, CM018, SC001-SC009.
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2015 224
GetMonitoringProduct (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
This operation returns the most recent copy of the product data -- not the data available at the date/time theChange Notice was triggered.
Note: For level 2 Monitoring registrations, the service returns data layers in the format specified by thelatest version of the corresponding service. For example, if the DCP_PREM data layer is being monitoredand a new version of the Firmographic service is released, level 2 Monitoring attachments will reflect thenewer DCP_PREM layout (if it changed).
Authentication & Endpoint
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
GET https://maxcvservices.dnb.com/V{version}/monitoring/organizations/{DUNS}/products/{productID}
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
{version} Element
ApplicationTransactionID string up to 64 chars., Optional
A number assigned by the calling application to
uniquely identify this request.
D&B Direct API Documentation GetMonitoringProduct (REST)
©Dun & Bradstreet, Inc. 2015 225
Name Characteristics
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 duns 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
Response Specification
The following is a list of the possible data fields returned by this operation in the JSON response. Theindividual data layer will be returned as base 64 encoded package within the response.
Name Characteristics
GetMonitoringProductResponse Aggregate
GetMonitoringProductResponse@ServiceVersionNumber
Attribute
GetMonitoringProductResponse { TransactionDetail
Aggregate, Required
Records information necessary to process a particular request. Examples of a
request is the ordering of a product.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 226
Name Characteristics
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 (Infinite)
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
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 227
Name Characteristics
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
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).
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 228
Name Characteristics
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 (Infinite)
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
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 229
Name Characteristics
GetMonitoringProductResponse { GetMonitoringProductResponseDetail{ Product { ObjectAttachment
Aggregate, Required
GetMonitoringProductResponse { GetMonitoringProductResponseDetail{ Product { ObjectAttachment { ContentObject
base64Binary, Required
GetMonitoringProductResponse { GetMonitoringProductResponseDetail{ Product { ObjectAttachment { ObjectFormatCode
integer up to 7 digits., Required
SCoTS: 126 [Object Format]
End: GetMonitoringProductResponse}GetMonitoringProductResponseDetail} Product } ObjectAttachment
/Aggregate
End: GetMonitoringProductResponse}GetMonitoringProductResponseDetail} Product
/Aggregate
End: GetMonitoringProductResponse}GetMonitoringProductResponseDetail
/Aggregate
End: GetMonitoringProductResponse /Aggregate
Note: The OrderProductResponse@ServiceVersionNumber value in the object attachment will NOT matchthe version of the data layer when retrieved from it's corresponding service.
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
This operation may return the following response codes: CM001, CM002, CM004, CM007, CM011, CM012,CM014, MN003, PD005, SC001-SC009.
Operation-specific supplemental response code explanations:
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 230
CM001 Invalid Language code provided
CM007 No Level2 notices available for the given criteria
PD005 Requested Product not available
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
ListChangeNotice (REST)
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 231
GetMonitoringProduct (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.
This operation returns the most recent copy of the product data -- not the data available at the date/time theChange Notice was triggered.
Note: For level 2 Monitoring registrations, the service returns data layers in the format specified by thelatest version of the corresponding service. For example, if the DCP_PREM data layer is being monitoredand a new version of the Firmographic service is released, level 2 Monitoring attachments will reflect thenewer DCP_PREM layout (if it changed).
Authentication, Endpoint & WSDL
D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) isdetermined by the credentials submitted with each API request. Refer to the service page for the correct versionof the operation.
Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL
Request Parameters
The following parameters are accepted by this operation.
Name Characteristics
GetMonitoringProductRequest Aggregate
GetMonitoringProductRequest@ServiceVersionNumber
Attribute
GetMonitoringProductRequest.TransactionDetail
Aggregate, Optional
Records information necessary to process this request.
GetMonitoringProductRequest.TransactionDetail.ApplicationTransactionID
string up to 64 chars., Optional
A number assigned by the calling application to uniquely identify this request.
D&B Direct API Documentation GetMonitoringProduct (SOAP)
©Dun & Bradstreet, Inc. 2015 232
Name Characteristics
GetMonitoringProductRequest.TransactionDetail.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.
GetMonitoringProductRequest.TransactionDetail.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.
End: GetMonitoringProductRequest.TransactionDetail
/Aggregate
GetMonitoringProductRequest.GetMonitoringProductRequestDetail
Aggregate, Required
GetMonitoringProductRequest.GetMonitoringProductRequestDetail.InquiryDetail
Aggregate, Required
GetMonitoringProductRequest.GetMonitoringProductRequestDetail.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.
GetMonitoringProductRequest.GetMonitoringProductRequestDetail.InquiryDetail. DNBProductID
string up to 64 chars., Required
Records the product code that is provided by the customer to create a profile
End: GetMonitoringProductRequest.GetMonitoringProductRequestDetail.InquiryDetail
/Aggregate
End: GetMonitoringProductRequest.GetMonitoringProductRequestDetail
/Aggregate
End: GetMonitoringProductRequest /Aggregate
Response Specification
The following is a list of the possible data fields returned by this operation in the XML response. Theindividual data layer will be returned as base 64 encoded package within the response.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 233
Name Characteristics
GetMonitoringProductResponse Aggregate
GetMonitoringProductResponse@ServiceVersionNumber
Attribute
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.
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 234
Name Characteristics
GetMonitoringProductResponse.TransactionResult. ResultMessage
Aggregate, Optional (Infinite)
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
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
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 235
Name Characteristics
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 (Infinite)
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
D&B Direct API Documentation Response Specification
©Dun & Bradstreet, Inc. 2015 236
Name Characteristics
End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. Organization.OrganizationName.OrganizationPrimaryName
/Aggregate
End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. Organization
/Aggregate
GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. ObjectAttachment
Aggregate, Required
GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. ObjectAttachment.ContentObject
base64Binary, Required
GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. ObjectAttachment.ObjectFormatCode
integer up to 7 digits., Required
SCoTS: 126 [Object Format]
End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. ObjectAttachment
/Aggregate
End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product
/Aggregate
End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail
/Aggregate
End: GetMonitoringProductResponse /Aggregate
Note: The OrderProductResponse@ServiceVersionNumber value in the object attachment will NOT matchthe version of the data layer when retrieved from it's corresponding service.
Language/Character Sets
The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including theD&B Business Information Report (BIR), provide additional language options. Data layers are encoded usingthe ISO 8859-1 character set standard (also known as Latin-1).
Response Codes
Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standardresponse codes will be returned.
D&B Direct API Documentation Language/Character Sets
©Dun & Bradstreet, Inc. 2015 237
This operation may return the following response codes: CM001, CM002, CM004, CM007, CM011, CM012,CM014, MN003, PD005, SC001-SC009.
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
Samples (Download)
Request and response samples are available for this D&B Direct web services. The samples may cover avariety of scenarios (when applicable) and are designed for use in the test environment.
Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Related Topics
ListChangeNotice (SOAP)
D&B Direct API Documentation Samples (Download)
©Dun & Bradstreet, Inc. 2015 238
Authentication ProcessBefore D&B Direct API services can be invoked, the credentials must be activated. Instructions and a link foractivating username/password combinations will be included in an email sent upon completion of theregistration process. If you do not receive an email, or unable to locate it, please contact the D&B supportteam for assistance (and specify if this a production, trial or sandbox related issue).
The system will generate a unique username for accounts created after December 6, 2013. Prior to that date,the customer-supplied email address was used as the username. No change is required for existing credentials.
Most of the D&B Direct products and features require contractual entitlement prior to production (and trial)environment access. Please refer to the data layer entitlement page for more details.
SOAP Authentication
All D&B Direct API services require that a valid username and password be provided in the SOAP header witheach call to an operation. The 2.0 services do not require that an API key be supplied.
If the credentials are valid and the associated account is entitled to access the product or feature, the requestwill be processed. If the authentication process fails, an error response code will be returned. The securityrelated response codes are prefixed with "SC."
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:com="http://services.dnb.com/CompanyServiceV2.0">
<soapenv:Header><wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://do
cs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-11"><wsse:Username>MyUsername</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/
01/oasis-200401-wss-username-token-profile-1.0#PasswordText">MyPassword</wsse:Password>
</wsse:UsernameToken></wsse:Security>
</soapenv:Header><soapenv:Body>
<!--Request Body as per the service schema-->
D&B Direct API Documentation Authentication Process
©Dun & Bradstreet, Inc. 2015 239
</soapenv:Body></soapenv:Envelope>
Response - Invalid Credentials
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body><com:MatchResponse ServiceVersionNumber="4.0" xmlns:com="http:/
/services.dnb.com/CompanyServiceV2.0"><TransactionDetail>
<ApplicationTransactionID>Id-b118ae275255a7cf0cfb742e</ApplicationTransactionID>
<ServiceTransactionID>Id-b118ae275255a7cf0cfb742e</ServiceTransactionID>
<TransactionTimestamp>2013-10-09T15:00:31</TransactionTimestamp>
</TransactionDetail><TransactionResult>
<SeverityText>Error</SeverityText><ResultID>SC001</ResultID><ResultText>Your user credentials are invalid. Please con
tact your D&B Representative or your local Customer Service Center.</ResultText>
</TransactionResult></com:MatchResponse>
</soapenv:Body></soapenv:Envelope>
REST Authentication
Implementation of D&B Direct API services using REST methodology involves obtaining anAuthentication Token, that is then submitted with subsequent requests during a particular session (up to eighthours).
Secure access to D&B Direct services is managed through the use of an Authentication Token, which can beobtained by sending an HTTP POST request to Authentication Service URL, passing a valid username andpassword in the HTTP header. The 2.0 services do not require that an API key be supplied. If the usercredentials are valid, an Authentication Token (valid for eight hours) will be returned back in theAuthorization tag in the HTTP header of the response.
D&B Direct API Documentation REST Authentication
©Dun & Bradstreet, Inc. 2015 240
Once an Authentication Token is obtained, it should be embedded in the HTTP header of all subsequentrequests. If the Authentication Token is valid and the user is entitled to access the product or feature beingrequested, the service will be processed and requested information returned as a JSON object. If theAuthentication Token is invalid, an error code will be returned in the JSON response.
Note: For an explanation of the D&B Direct REST implementation, refer to our JSON response guidelines.
Sample Request - Get New Token
POST https://maxcvservices.dnb.com/rest/Authenticationx-dnb-user: MyUsernamex-dnb-pwd: MyPassword
A {version} parameter is not required when initiating a request to the Authentication service.
Response - Success
HTTP/1.1 200 OKDate: Wed, 09 Oct 2013 18:47:22 GMTAuthorization: <MyToken>x-dnb-user: MyUsernamex-dnb-pwd: MyPassword
Response - Failed
HTTP/1.1 401 ERRORDate: Wed, 09 Oct 2013 18:51:11 GMTAuthorization: INVALID CREDENTIALSx-dnb-user: MyUsernamex-dnb-pwd: MyPassword
Sample Request - Invoke Operation with Token
GET https://maxcvservices.dnb.com/V4.0/organizations?CountryISOAlpha2Code=US&SubjectName=GORMAN%20MANUFACTURING&match=true&MatchTypeText=Advanced&TerritoryName=CAAuthorization: <MyToken>
Response - Expired Authentication Token
HTTP/1.1 401 UNAUTHORIZEDDate: Thu, 10 Oct 2013 14:55:19 GMTAuthorization: <MyToken>
D&B Direct API Documentation REST Authentication
©Dun & Bradstreet, Inc. 2015 241
Content-Type: application/jsonContent-Encoding: gzip
{"MatchResponse": {"TransactionDetail": {
"ApplicationTransactionID": "REST","ServiceTransactionID": "Id-c04bbdff5256bfd70a7b742e","TransactionTimestamp": "2013-10-10T10:55:19"
},"TransactionResult": {
"SeverityText": "Error","ResultID": "SC001","ResultText": "Your user credentials are invalid. Please contact
your D&B Representative or your local Customer Service Center."}
}}
D&B Direct API Documentation REST Authentication
©Dun & Bradstreet, Inc. 2015 242
Obtaining CredentialsAccess to the D&B Direct web services are secured by a username and password combination. D&B will issueyour organization a production username upon completion of the contract establishment process. Thisusername will be sent to the email address designated on the contract, along with instructions for setting upthe password. This process will also be followed for production trial requests.
D&B offers a non-billable environment (commonly referred to as the sandbox) for testing the D&B Direct webservices. Developers may establish, via a self-service interface, sandbox user id and password combinations.The production credentials assigned to your organization may NOT be used in the sandbox environment toauthenticate web services, and vice-versa.
Before D&B Direct API services can be invoked, the credentials must be activated. Instructions and a link foractivating username/password combinations will be included in an email sent upon completion of theregistration process. If you do not receive an email, or unable to locate it, please contact the D&B supportteam for assistance (and specify if this a production, trial or sandbox related issue).
The system will generate a unique username for accounts created after December 6, 2013. Prior to that date,the customer-supplied email address was used as the username. No change is required for existing credentials.
Most of the D&B Direct products and features require contractual entitlement prior to production (and trial)environment access. Please refer to the data layer entitlement page for more details.
D&B Direct API Documentation Obtaining Credentials
©Dun & Bradstreet, Inc. 2015 243
Data Layer EntitlementD&B Direct 2.0 services are provisioned to customers at the data layer, which, for some of the features, mightnot be intuitive. This page is intended to help developers clearly understand what services and operations theyare entitled to use.
Components Requiring Entitlement
Components Not Requiring Entitlement
These items are available to customers who have one or more entitled data layers.
Data Layer: Monitoring*Service: Monitoring ServiceOperations: (see service page for complete list)Feature: Data Layer/Field Monitoring
*While this component does not require entitlement, customers will only be permitted to monitor data layers to which they have
been entitled.
D&B Direct API Documentation Data Layer Entitlement
©Dun & Bradstreet, Inc. 2015 244
Country CodesMany of the D&B Direct web services expect to receive a country code for the company specified by the D-U-N-S Number being requested. This input parameter is case-sensitive and must be supplied in upper case.On some requests, this parameter is optional; however, D&B recommends that it be provided to reduce theresponse time of the service(s) -- including products limited to results for US companies.
D&B Direct services utilize the two-letter country code as defined by the International Organization forStandardization (ISO) in their ISO 3166-1 specification. For a list of actual country codes supported for aspecific data layer, please refer to the Country Availability tab contained in the downloadable "Extras" file forthe respective Service.
Code Substitutions
Data for the following countries is stored under the alternate country code specified.
Country Name Alternate Instructions
ABU DHABI Use the code of United Arab Emirates (AE)
ADMIRALTY ISLANDS Use the code of Papua New Guinea (PG)
AJMAN Use the code of United Arab Emirates (AE)
AL AIN Use the code of United Arab Emirates (AE)
ASCENSION ISLAND Use the code SH (Saint Helena, Ascension and Tristan da Cunha)
Cocos (Keeling) Islands Use the code AU (Australia)
DUBAI Use the code of United Arab Emirates (AE)
FUJAIRAH Use the code of United Arab Emirates (AE)
MIDWAY ISLANDS Use the code of US
RAS AL KHAIMAH Use the code of United Arab Emirates (AE)
SHARJAH Use the code of United Arab Emirates (AE)
SOUTH SANDWICH ISLANDS Use the code GS (South Georgia and the South Sandwich Islands)
South Sudan Use the code of Sudan (SD)
TURKISH CYPRUS Use the code of Cyprus (Match is not supported)
UMM-AL-QUWAIN Use the code of United Arab Emirates (AE)
While some territories of the United States (e.g. Puerto Rico) have been assigned ISO country codes, theinformation on organizations from those areas will be located under the US country code.
Data Not Available
Data for the following countries is not currently available through the D&B Direct 2.0 API.
D&B Direct API Documentation Country Codes
©Dun & Bradstreet, Inc. 2015 245
Country Name ISO Code
Antarctica AQ
Åland Islands AX
Saint Barthélemy BL
Bonaire, Saint Eustatius and Saba BQ
Bouvet Island BV
CAROLINE ISLANDS ??
Cuba CU
Curaçao CW
Western Sahara EH
Micronesia, Federated States of FM
Guernsey GG
Heard Island and McDonald Islands HM
Isle of Man IM
British Indian Ocean Territory IO
Jersey JE
Korea, Democratic People's Republic of KP
Saint Martin (French part) MF
Mongolia MN
Niue NU
Pitcairn PN
Palestinian Territory, Occupied PS
Palau PW
Svalbard and Jan Mayen SJ
Sint Maarten (Dutch part) SX
French Southern Territories TF
Wallis and Futuna WF
Wake Island ??
Mayotte YT
Please contact your local D&B Customer Service department/representative for more details; or to place aninquiry for a specific organization.
D&B Direct API Documentation Country Codes
©Dun & Bradstreet, Inc. 2015 246
Response CodesWhenever a D&B Direct web service request is unsuccessful, one of the following response codes will bereturned.
Code Description HTTPStatus*
CM000 Success 200
CM001 The given request is invalid. 400
CM002 The format of this request is invalid. 400
CM003 Missing information in the request. 400
CM004 Internal D&B system error. 500
CM005 D&B System temporarily unavailable. 503
CM006 D&B System busy. 503
CM007 Your request cannot be fulfilled for the given criteria. 404
CM008 No match found for the requested Duns number. 404
CM009 Reason Code required for Germany. 400
CM010 Partial Success. 200
CM011 Invalid Country Code provided in the request. 400
CM012 Invalid Duns number provided in the request. 400
CM013 Invalid Subject ID provided in the request. 400
CM014 Invalid Product Code provided in the request. 400
CM016 Invalid Territory provided in the request. 400
CM017 Duns number is missing in the request. 400
CM018 No candidates resulted for the given input criteria. 404
CM022 Only a Subset of request parameters were used for processing the request. 200
CM023 Duplicate record cannot be created. 400
CM026 Request accepted. Processing pending. 200
CP001 No Match for the given input criteria. 404
CP002 No candidates resulted in the Extended Search. 404
CP003 No Match for given Telephone Number. 404
CP004 No Match for given Organization Identifier. 404
CP005 Insufficient Information to determine Fraud Score. 400
PD001 Requested product not available due to insufficient data. 404
PD002 Requested subject is promised later. Preliminary report returned. 200
PD003 Requested product not available - subject is on Stop Distribution. 404
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2015 247
Code Description HTTPStatus*
PD004 Requested product not available due to subject information is too old. 404
PD005 Requested Product not available. 404
PD006 Subject is foreign branch, therefore trade-up to HQ is not available. 404
PD007 Family Tree does not exist for requested subject. 404
PD008 Success. Returned truncated family tree, as family tree member countexceeds maximum limit for requested subject.
200
PD009 Required scoring elements missing - a Commercial or Blended Small Businessreport is not available. You may proceed with a Principal only request.
200
PD010 Requested Product not available as address is undeliverable. 200
PD011 Requested Product not available as address is undeliverable. 404
PD012 Requested Product not available on Self request. 404
PD013 Requested Product is not available currently. Product will be delivered to thecustomer at a later point of time via offline delivery channels (Email/FAX/FTPetc).
404
PD014 Requested data is not available or partially available due to data integrityerrors.
404
PD015 Trade-up to HQ is not available. Therefore delivering the data for branchorganization.
200
PD016 Requested Product is not available since the requested DUNS is transferred toa new DUNS.
200
SC001 Your user credentials are invalid. 401
SC002 Your user credentials are not eligible for this request. 401
SC003 Your user credentials have expired. 401
SC004 Your Subscriber number has expired. 401
SC005 You have reached maximum limit permitted as per the contract. 401
SC006 Transaction not processed as the permitted concurrency limit was exceeded. 401
SC007 Subscriber validation failed. 401
SC008 Your account has been locked out due to repeated attempts to login with anincorrect User ID/Password.
401
SC009 Invalid Sign On Token in the request. 401
SC010 The User ID you provided doesn’t exist in the system. n/a
SC011 The User ID you provided already exist in the system n/a
SC012 Request not processed as user activation key is invalid or expired. n/a
SC014 Your user credentials are not eligible for this request since you are in trialperiod.
401
BC001 Partial Success. One or more records in the input file were not processed. 200
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2015 248
Code Description HTTPStatus*
BC002 Batch request is not processed since input file is not available in the specifiedlocation.
400
BC003 Batch request is not processed since the content of the input file is not in theexpected format.
400
BC004 Batch request is not processed since the count of the records specified in therequest do not match the exact count of records in the input file.
400
BC005 Intermediate Success 200
BC006 Batch request is not processed 400
BC007 Batch Execution in progress n/a
BC008 Batch Execution not yet started n/a
BC009 Batch not processed as the input file contains more records than thepermitted limit.
400
BC010 Batch files no longer available after retention period. 200
BC011 Invalid Batch Process Id provided in the request. 400
MN001 Invalid Monitoring Profile ID provided in the request. 400
MN002 Invalid Notification Profile ID provided in the request. 400
MN003 Product not registered for Level 2 Monitoring 400
MN004 Cannot delete Monitoring Profile - registrations exist 400
MN005 Cannot delete Notification Profile - registrations exist. 400
*This column displays the corresponding HTTP status code that will be returned for REST API calls.
D&B Direct API Documentation Response Codes
©Dun & Bradstreet, Inc. 2015 249
Sandbox AccessD&B Direct provides a test environment (referred to as the sandbox) that requires a separate set of credentials.Service requests made with sandbox credentials should be issued using the same endpoints (and in the case ofSOAP, using the same WSDL file).
When conducting testing in the production environment during a trial period, product requests will be limitedto the local market of the customer.
Some D&B Direct products and features may behave differently in the sandbox environment. Any limitationsor restrictions will be specified on the operation page for each interface.
Test Parameter Values
The following suggested parameters may be used for test environment (sandbox) requests to retrievesuccessful responses.
Assessment Product Service
Product Test D-U-N-S Number(s)
Small Business Company & Owner Risk Profile 804735132 (US); 362241452 (US)
Predictive Bankruptcy Risk - D&B Financial Stress Score(FSS)
804735132 (US); 362241452 (US)
Predictive Payment Risk - D&B Commercial Credit Score(CCS)
804735132 (US); 362241452 (US)
Predictive Bankruptcy & Payment Risk 804735132 (US); 362241452 (US); 214567885 (GB);754683795 (AU); 481794956 (CH)
Predictive Global Payment Risk - D&B Emerging MarketMediation Alert Score (EMMA)
654502665 (CN); 811761659 (MX)
D&B Rating & Trend 804735132 (US); 362241452 (US); 364744867 (RO)
D&B Supplier Evaluation Risk Rating 804735132 (US); 362241452 (US)
D&B Total Loss Predictor 804735132 (US); 362241452 (US)
D&B Triple Play 362241452 (US)
D&B Viability Rating 804735132 (US); 362241452 (US)
Contact Product Service
Product Test D-U-N-S Number(s) Test Principal Identification Number(s)
People - Standard 804735132 (US) 5412658
People - Enhanced 220646736 (GB) 2206467361
D&B Direct API Documentation Sandbox Access
©Dun & Bradstreet, Inc. 2015 250
Financial Product Service
Product Test D-U-N-S Number(s)
Financial Highlights 001368083 (CA)
Financial Statements 804735132 (US); 362528379 (US); 247933872 (CA); 214567885 (GB); 754683795 (AU)
Firmographic Product Service
Product Test D-U-N-S Number(s)
Detailed Company Profile 804735132 (US); 362241452 (US); 214567885 (GB); 754683795 (AU); 481794956(CH)
Alternative Detailed CompanyProfile
804735132 (US); 362241452 (US); 214567885 (GB); 754683795 (AU); 481794956(CH)
Diversity Indicators 804735132 (US); 362241452 (US); 214567885 (GB); 754683795 (AU); 481794956(CH)
USA PATRIOT Act Plus 804735132 (US); 362241452 (US); 214567885 (GB); 754683795 (AU); 481794956(CH)
Linkage Product Service
Product Test D-U-N-S Number(s)
Corporate Linkage 754683795 (AU); 970814638 (AR); 302150912 (AT); 811761659 (MX); 804735132 (US)
Company Reports
Country Reports
SBRI Product Service
Product Test D-U-N-S Number(s)
Small Business Risk Insight n/a
Trade Detail Product Service
Product Test D-U-N-S Number(s)
Payment Information - Detail 804735132 (US)
Payment Information & Paydex (Rating) - Detail 804735132 (US); 362528379 (US); 247933872 (CA); 214567885 (GB)
D&B Direct API Documentation Financial Product Service
©Dun & Bradstreet, Inc. 2015 251
Static Responses
Some operations currently return a static set of results, regardless of the request parameters, in the testenvironment.
Company Service
Match, GetCleanseMatch, SearchByFilingName, SearchByFilingNumber, and CleanseAndStandardize will returna static response in the Sandbox environment.
Entity List Service
FindCompany, FindContact, FindCompetitor, and FindIndustry will return a static response in the Sandboxenvironment.
D&B Direct API Documentation Static Responses
©Dun & Bradstreet, Inc. 2015 252
JSON GuidelinesD&B Direct REST responses are delivered as XML documents translated into JSON objects. The following listexplains the conventions implemented by the D&B Direct API. Exception: The responses supplied by the DataExchange Service follow the convention used by the respective business partner.
l Attributes will always be represented by prefixing with “@”. (see Example 2)l If an element is repeatable, that element will be always returned as an Array of objects in the JSON
response. (see Example 7)o If a repeatable element is not repeating in a specific JSON response, even then that element will
be returned as an Array having a single object. (see Example 9)l Element content will be represented with “$” if it has attributes (see Example 2)
o Consider a scenario where an element has an attribute as per the definition, however theattribute is not returned in a specific JSON response. Even then, the element content will berepresented as “$” in the JSON. (see Example 4)
l String values will be returned within double quotes. (see Example 14)l Numeric and Boolean values will not be returned within double quotes. (see Example 12 and Example
13)
Examples
# Scenario XML Instance JSON Instance
1 Element having noattribute
<DUNSNumber>804735132 </DUNSNumber> "DUNSNumber": "804735132"
2 Element havingAttribute
<FamilyTreeMemberRoleTextDNBCodeValue="12773">Parent</FamilyTreeMemberRoleText>
"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }
3 Aggregate havingattribute
<OrganizationIdentificationNumberDetailTypeText="Federal Taxpayer IdentificationNumber (US)" DNBCodeValue="6863"><OrganizationIdentificationNumber>12345</OrganizationIdentificationNumber></OrganizationIdentificationNumberDetail>
"OrganizationIdentificationNumberDetail":{ "@TypeText": "Federal TaxpayerIdentification Number (US)","@DNBCodeValue": 6863,"OrganizationIdentificationNumber":"12345" }
4 Element havingAttribute as perdefinition, howeverattribute is notreturned for aspecific JSONinstance
<OrganizationName>Gorman ManufacturingCompany, Inc. </OrganizationName>
"OrganizationName": { "$": "GormanManufacturing Company, Inc." }
D&B Direct API Documentation JSON Guidelines
©Dun & Bradstreet, Inc. 2015 253
# Scenario XML Instance JSON Instance
5 Aggregate havingAttribute as perdefinition, howeverattribute is notreturned for aspecific JSONinstance
<OrganizationIdentificationNumberDetail ><OrganizationIdentificationNumber>12345</OrganizationIdentificationNumber></OrganizationIdentificationNumberDetail>
"OrganizationIdentificationNumberDetail":{ "OrganizationIdentificationNumber":"12345" }
6 Non-RepeatingElement
<DUNSNumber>804735132 </DUNSNumber> "DUNSNumber": "804735132"
7 Repeating Element <SalesRevenueAmountCurrencyISOAlpha3Code="USD”>1000000</SalesRevenueAmount><SalesRevenueAmountCurrencyISOAlpha3Code="CAD”>1040000</SalesRevenueAmount>
"SalesRevenueAmount": [ { "@CurrencyISOAlpha3Code": "USD", "$":1000000 }, { "@CurrencyISOAlpha3Code":"CAD", "$": 1040000 } ]
8 Repeating Aggregate <FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12773">Parent</FamilyTreeMemberRoleText></FamilyTreeMemberRole><FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12775">Global Ultimate</FamilyTreeMemberRoleText></FamilyTreeMemberRole><FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12774">Domestic Ultimate</FamilyTreeMemberRoleText></FamilyTreeMemberRole>
"FamilyTreeMemberRole": [ {"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }},{"FamilyTreeMemberRoleText": {
"@DNBCodeValue": 12775, "$": "GlobalUltimate" }},{"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12774, "$": "DomesticUltimate" }} ]
9 Element isrepeatable as per thedefinition. Howeverit is not repeating ina specific JSONinstance.
<SalesRevenueAmountCurrencyISOAlpha3Code="USD”>1000000</SalesRevenueAmount>
"SalesRevenueAmount": [ { "@CurrencyISOAlpha3Code": "USD", "$":1000000 }]
10 Aggregate isrepeatable as per thedefinition. Howeverit is not repeating ina specific JSONinstance.
<FamilyTreeMemberRole><FamilyTreeMemberRoleTextDNBCodeValue="12773">Parent</FamilyTreeMemberRoleText></FamilyTreeMemberRole>
"FamilyTreeMemberRole": [ {"FamilyTreeMemberRoleText": { "@DNBCodeValue": 12773, "$": "Parent" }}]
11 Date Field <TransactionTimestamp>2013-07-11T11:08:48.067-04:00</TransactionTimestamp>
"TransactionTimestamp": "2013-07-11T11:10:39.110-04:00"
12 Boolean Field <StandaloneOrganizationIndicator>false</StandaloneOrganizationIndicator>
"StandaloneOrganizationIndicator": false
D&B Direct API Documentation Examples
©Dun & Bradstreet, Inc. 2015 254
# Scenario XML Instance JSON Instance
13 Numeric Field <RawScore>352</RawScore> "RawScore": 352
14 String Field <LineText>492 Koller Street</LineText> "LineText": "492 Koller Street"
D&B Direct API Documentation Examples
©Dun & Bradstreet, Inc. 2015 255
Dun & Bradstreet (D&B)
103 JFK Parkway
Short Hills, NJ 07078
www.dnb.com
©Dun & Bradstreet, Inc. 2015. All rights reserved.