d&b direct 2.0 monitoring service events ......

D&B DirectAPI Documentation for

Monitoring Service

Version 2.0 (API) / 3.0 (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. 2014. 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

Fraud Risk Score

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

GetFraudScore GET organizations? fraudscore=true

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)

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. 2014 3

http://developer.dnb.com/

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


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


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


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


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


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


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)


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 Viability Rating VIAB_RAT

Custom products may not be registered for monitoring.

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


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.


D&B Direct API Documentation Data Field Changes


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")


<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



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


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


D&B Direct API Documentation Corporate Linkage Changes


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


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.


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


Business Elements

For each matching item, this feature will return the Monitoring Profile along with the date it was created.


For details on how to access this feature, please refer to the Monitoring Service documentation.

D&B Direct API Documentation Business Elements


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.




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.


D&B Direct API Documentation How to Retrieve Notification Profiles


Sort field options include: DeliveryChannelUserPreferenceName, NotificationProfileID,NotificationProfileName, DeliveryMode, DeliveryFrequency, DeliveryFormat, StopDeliveryIndicator,NotificationProfileCreatedDate, NotificationProfileStatusText.


Business Elements

For each matching item, this feature will return the Notification Profile along with the date it was created.





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.




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.


D&B Direct API Documentation How to Retrieve Monitoring Registrations


Sort field options include: DUNSNumber, CountryISOAlpha2Code, MonitoringProfileID, DNBProductID,MonitoringLevel, NotificationProfileID, RegistrationStartDate, SubjectCategoryText, AutoRenewalIndicator,MonitoringRegistrationStatusText.


Business Elements

For each matching item, this feature will return the Monitoring Registration along with the date it wasregistered, and (if inactive) the date when the monitoring ended.





Monitoring ServiceVersion 2.0 (API) / 3.0 (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


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 3.0. 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/3.0/MonitoringServiceV30.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 noted in the preceding table(s).

D&B Direct API Documentation Interfaces & Endpoints


CreateMonitoringProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


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


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)


<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>



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



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


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


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.

CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail

Aggregate, Optional

CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail{ MonitoringElement

Aggregate, Required (Infinite)

CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail{ MonitoringElement { PCMElementXPATHText


CreateMonitoringProfileRequest { CreateMonitoringProfileRequestDetail { MonitoringProfileSpecification { MonitoringElementDetail{ MonitoringElement { MonitoringChanges


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




END: CreateMonitoringProfileRequest }CreateMonitoringProfileRequestDetail }MonitoringProfileSpecification } MonitoringElementDetail} MonitoringElement

/Aggregate

END: CreateMonitoringProfileRequest }CreateMonitoringProfileRequestDetail }MonitoringProfileSpecification } MonitoringElementDetail

/Aggregate

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.

Data Field Response

The following is a list of the possible data fields returned by this operation in the JSON response.


CreateMonitoringProfileResponse Aggregate

CreateMonitoringProfileResponse@ServiceVersionNumber Attribute

D&B Direct API Documentation Testing / Sandbox



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




CreateMonitoringProfileResponse { TransactionDetail { ServiceTransactionID


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


Text that records the criticality of the outcome, e.g.,

Information, Warning, Error, Fatal.

CreateMonitoringProfileResponse { TransactionResult { ResultID


An alphanumeric string that uniquely identifies the

outcome of the transaction.

CreateMonitoringProfileResponse { TransactionResult { ResultText


Text that explains the outcome of the transaction.

D&B Direct API Documentation Data Field Response



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


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


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

CreateMonitoringProfileResponse { CreateMonitoringProfileResponseDetail { InquiryReferenceText

Aggregate, Optional







CreateMonitoringProfileResponse { CreateMonitoringProfileResponseDetail { InquiryReferenceText { CustomerReferenceText


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 (sometimes referred to as Latin-1), EXCEPT when the organization isdomiciled in the Czech Republic (CZ), Hungary (HU), Poland (PL) or Slovakia (SK). Data from these markets iscurrently encoded using the ISO 8859-2 character set standard.

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


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)


CreateMonitoringProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


Authentication, Endpoint & WSDL


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.


Example:


OrderProductResponse. OrderProductResponseDetail.Product. Organization. Events. PublicFilingHeader.DisclaimerText



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)


<MonitoringElement><PCMElementXPATHText>//Organization/Events/LegalEvents/OtherLegalEv

entInformation/OtherLegalEvent[FilingTypeText@DNBCodeValue=8035]</PCMElementXPATHText>



<MonitoringElement><PCMElementXPATHText>//Organization/Events/SignificantEvents/Specia

lEvent[EventSubTypeText@DNBCodeValue=12317 || EventSubTypeText@DNBCodeValue=15378 || EventTypeText@DNBCodeValue=28227 || EventSubTypeText@DNBCodeValue=4073]</PCMElementXPATHText>



Note: The combination of attributes may NOT contain duplicate references to the same attribute.


CreateMonitoringProfileRequest Aggregate

CreateMonitoringProfileRequest@ServiceVersionNumber Attribute

CreateMonitoringProfileRequest@xsi:schemaLocation Attribute

CreateMonitoringProfileRequest. TransactionDetail Aggregate, Optional


CreateMonitoringProfileRequest. TransactionDetail.ApplicationTransactionID







CreateMonitoringProfileRequest. TransactionDetail.TransactionTimestamp








CreateMonitoringProfileRequest. TransactionDetail.SubmittingOfficeID






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



CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification.MonitoringProfileDescription



CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification. DNBProductID


Records the product code that is provided by the customer

to create a profile




CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification. MonitoringLevel




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


CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification. MonitoringElementDetail.MonitoringElement. PCMElementXPATHText


CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification. MonitoringElementDetail.MonitoringElement. MonitoringChanges


CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification. MonitoringElementDetail.MonitoringElement. MonitoringChanges.ChangeCondition







CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification. MonitoringElementDetail.MonitoringElement. MonitoringChanges. ChangeValue


END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification. MonitoringElementDetail.MonitoringElement. MonitoringChanges

/Aggregate

END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification. MonitoringElementDetail.MonitoringElement

/Aggregate




END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification. MonitoringElementDetail

/Aggregate

END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.MonitoringProfileSpecification

/Aggregate

CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.InquiryReferenceText

Aggregate, Optional




CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.InquiryReferenceText. CustomerReferenceText




reconciliation.

END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail.InquiryReferenceText

/Aggregate

END: CreateMonitoringProfileRequest.CreateMonitoringProfileRequestDetail

/Aggregate

END: CreateMonitoringProfileRequest /Aggregate

Testing / Sandbox


A static change notice will be generated regardless of the conditions/values specified in test MonitoringProfiles.

Data Field Response

The following is a list of the possible data fields returned by this operation in the XML response.


CreateMonitoringProfileResponse Aggregate

CreateMonitoringProfileResponse@ServiceVersionNumber Attribute

CreateMonitoringProfileResponse@xsi:schemaLocation Attribute




CreateMonitoringProfileResponse. TransactionDetail Aggregate, Required



product.

CreateMonitoringProfileResponse. TransactionDetail.ApplicationTransactionID




CreateMonitoringProfileResponse. TransactionDetail.ServiceTransactionID



this transaction.

CreateMonitoringProfileResponse. TransactionDetail.TransactionTimestamp







intermediary.

END: CreateMonitoringProfileResponse. TransactionDetail /Aggregate

CreateMonitoringProfileResponse. TransactionResult Aggregate, Required



CreateMonitoringProfileResponse. TransactionResult.SeverityText




CreateMonitoringProfileResponse. TransactionResult.ResultID




CreateMonitoringProfileResponse. TransactionResult.ResultText






CreateMonitoringProfileResponse. TransactionResult.ResultMessage




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




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



CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringProfileID

int, Required



END: CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.MonitoringProfileDetail

/Aggregate

CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.InquiryReferenceText

Aggregate, Optional







CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.InquiryReferenceText. CustomerReferenceText





END: CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail.InquiryReferenceText

/Aggregate

END: CreateMonitoringProfileResponse.CreateMonitoringProfileResponseDetail

/Aggregate

END: CreateMonitoringProfileResponse /Aggregate



Response Codes


This operation may return the following response codes: CM001, CM002, CM004, CM007, CM014, CM023,SC001-SC009.


CM001 Blank value passed for PCMElementXpath


CM007 PCMElementXpath does not belong to the Product; or Invalid Change Value (Alert threshold)

CM014 Product Not available




Samples (Download)


Monitoring Service


Related Topics

UpdateMonitoringProfile (SOAP), ListMonitoringProfile (SOAP), Available Products.



UpdateMonitoringProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


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.



Endpoint

PUT https://maxcvservices.dnb.com/V{version}/monitoring/monitoringprofiles/{MonitoringProfileID}

Request Parameters

The following parameter(s) are required in the endpoint.


{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.


Example:

D&B Direct API Documentation UpdateMonitoringProfile (REST)



OrderProductResponse { OrderProductResponseDetail { Product { Organization { Events { PublicFilingHeader { DisclaimerText


The following parameters are accepted by this operation.






UpdateMonitoringProfileRequest Aggregate

UpdateMonitoringProfileRequest@ServiceVersionNumber Attribute

UpdateMonitoringProfileRequest@xsi:schemaLocation Attribute

UpdateMonitoringProfileRequest { TransactionDetail Aggregate, Optional


UpdateMonitoringProfileRequest { TransactionDetail { ApplicationTransactionID




UpdateMonitoringProfileRequest { TransactionDetail { TransactionTimestamp











UpdateMonitoringProfileRequest { TransactionDetail { SubmittingOfficeID






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



UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail

Aggregate, Optional

UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement


UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { PCMElementXPATHText


UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { MonitoringChanges





UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeCondition







UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeValue


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 { MonitoringProfileUpdateSpecification { InquiryReferenceText

Aggregate, Optional




UpdateMonitoringProfileRequest { UpdateMonitoringProfileRequestDetail { MonitoringProfileUpdateSpecification { InquiryReferenceText { CustomerReferenceText




reconciliation.

END: UpdateMonitoringProfileRequest }UpdateMonitoringProfileRequestDetail }MonitoringProfileUpdateSpecification }InquiryReferenceText

/Aggregate




END: UpdateMonitoringProfileRequest }UpdateMonitoringProfileRequestDetail }MonitoringProfileUpdateSpecification

/Aggregate

END: UpdateMonitoringProfileRequest }UpdateMonitoringProfileRequestDetail

/Aggregate

END: UpdateMonitoringProfileRequest /Aggregate

Testing / Sandbox


Data Field Response



UpdateMonitoringProfileResponse Aggregate

UpdateMonitoringProfileResponse@ServiceVersionNumber Attribute

UpdateMonitoringProfileResponse@xsi:schemaLocation Attribute

UpdateMonitoringProfileResponse { TransactionDetail Aggregate, Required



product.

UpdateMonitoringProfileResponse { TransactionDetail { ApplicationTransactionID




UpdateMonitoringProfileResponse { TransactionDetail { ServiceTransactionID


A number assigned by the D&B service to uniquely

identify this transaction.




UpdateMonitoringProfileResponse { TransactionDetail { TransactionTimestamp







intermediary.

END: UpdateMonitoringProfileResponse } TransactionDetail /Aggregate

UpdateMonitoringProfileResponse { TransactionResult Aggregate, Required



UpdateMonitoringProfileResponse { TransactionResult { SeverityText




UpdateMonitoringProfileResponse { TransactionResult { ResultID




UpdateMonitoringProfileResponse { TransactionResult { ResultText



UpdateMonitoringProfileResponse { TransactionResult { ResultMessage




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




END: UpdateMonitoringProfileResponse }TransactionResult } ResultMessage

/Aggregate

END: UpdateMonitoringProfileResponse }TransactionResult

/Aggregate




UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail

Aggregate, Optional

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail

Aggregate, Optional

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { 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.

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileName



UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail

Aggregate, Optional

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement


UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { PCMElementXPATHText


UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges


UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeCondition







UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeValue

string at least 1 chars. 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




UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { InquiryReferenceText

Aggregate, Optional




UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { InquiryReferenceText { CustomerReferenceText





END: UpdateMonitoringProfileResponse }UpdateMonitoringProfileResponseDetail }MonitoringProfileDetail } InquiryReferenceText

/Aggregate

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail

Aggregate, Optional

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringProfileName



UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail

Aggregate, Optional

UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement





UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { PCMElementXPATHText


UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges


UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeCondition







UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeValue


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




UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { InquiryReferenceText

Aggregate, Optional







UpdateMonitoringProfileResponse { UpdateMonitoringProfileResponseDetail { MonitoringProfileDetail { FormerMonitoringProfileDetail { InquiryReferenceText { CustomerReferenceText





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



Response Codes


This operation may return the following response codes: CM001, CM002, CM004, CM007, CM023, MN001,MN004, SC001-SC009.


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.


Samples (Download)


Monitoring Service


Related Topics

CreateMonitoringProfile (REST), ListMonitoringProfile (REST).



UpdateMonitoringProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


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.



Endpoint


Request Parameters


Example:


OrderProductResponse. OrderProductResponseDetail.Product. Organization. Events. PublicFilingHeader.DisclaimerText




UpdateMonitoringProfileRequest Aggregate

UpdateMonitoringProfileRequest@ServiceVersionNumber Attribute

UpdateMonitoringProfileRequest@xsi:schemaLocation Attribute

UpdateMonitoringProfileRequest. TransactionDetail Aggregate, Optional


D&B Direct API Documentation UpdateMonitoringProfile (SOAP)



UpdateMonitoringProfileRequest. TransactionDetail.ApplicationTransactionID




UpdateMonitoringProfileRequest. TransactionDetail.TransactionTimestamp








UpdateMonitoringProfileRequest. TransactionDetail.SubmittingOfficeID






END: UpdateMonitoringProfileRequest. TransactionDetail /Aggregate

UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail

Aggregate, Required

UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileDetail

Aggregate, Required

UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileDetail. MonitoringProfileID

int, Required



END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileDetail

/Aggregate

UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification

Aggregate, Required

UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringProfileName






UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail

Aggregate, Optional

UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail. MonitoringElement


UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail. MonitoringElement.PCMElementXPATHText


UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail. MonitoringElement.MonitoringChanges


UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail. MonitoringElement.MonitoringChanges. ChangeCondition







UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.MonitoringElementDetail. MonitoringElement.MonitoringChanges. ChangeValue


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




UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.InquiryReferenceText

Aggregate, Optional




UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.InquiryReferenceText. CustomerReferenceText




reconciliation.

END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification.InquiryReferenceText

/Aggregate

END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail.MonitoringProfileUpdateSpecification

/Aggregate

END: UpdateMonitoringProfileRequest.UpdateMonitoringProfileRequestDetail

/Aggregate

END: UpdateMonitoringProfileRequest /Aggregate

Testing / Sandbox


Data Field Response



UpdateMonitoringProfileResponse Aggregate

UpdateMonitoringProfileResponse@ServiceVersionNumber Attribute

UpdateMonitoringProfileResponse@xsi:schemaLocation Attribute




UpdateMonitoringProfileResponse. TransactionDetail Aggregate, Required



product.

UpdateMonitoringProfileResponse. TransactionDetail.ApplicationTransactionID




UpdateMonitoringProfileResponse. TransactionDetail.ServiceTransactionID




UpdateMonitoringProfileResponse. TransactionDetail.TransactionTimestamp







intermediary.

END: UpdateMonitoringProfileResponse. TransactionDetail /Aggregate

UpdateMonitoringProfileResponse. TransactionResult Aggregate, Required



UpdateMonitoringProfileResponse. TransactionResult.SeverityText




UpdateMonitoringProfileResponse. TransactionResult.ResultID




UpdateMonitoringProfileResponse. TransactionResult.ResultText






UpdateMonitoringProfileResponse. TransactionResult.ResultMessage








UpdateMonitoringProfileResponse. TransactionResult.ResultMessage. ResultDescription




END: UpdateMonitoringProfileResponse. TransactionResult.ResultMessage

/Aggregate

END: UpdateMonitoringProfileResponse. TransactionResult /Aggregate

UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail

Aggregate, Optional

UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail

Aggregate, Optional

UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringProfileID

int, Required



DUNS.

UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringProfileName



UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail

Aggregate, Optional

UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail.MonitoringElement


UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail.MonitoringElement. PCMElementXPATHText





UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail.MonitoringElement. MonitoringChanges


UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail.MonitoringElement. MonitoringChanges. ChangeCondition







UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail.MonitoringElement. MonitoringChanges. ChangeValue


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




UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. InquiryReferenceText

Aggregate, Optional




UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. InquiryReferenceText.CustomerReferenceText








END: UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. InquiryReferenceText

/Aggregate

UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. FormerMonitoringProfileDetail

Aggregate, Optional

UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. FormerMonitoringProfileDetail.MonitoringProfileName



UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. FormerMonitoringProfileDetail.MonitoringElementDetail

Aggregate, Optional

UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement


UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.PCMElementXPATHText


UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges


UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges. ChangeCondition







UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. FormerMonitoringProfileDetail.MonitoringElementDetail. MonitoringElement.MonitoringChanges. ChangeValue


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




UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. FormerMonitoringProfileDetail.InquiryReferenceText

Aggregate, Optional




UpdateMonitoringProfileResponse.UpdateMonitoringProfileResponseDetail.MonitoringProfileDetail. FormerMonitoringProfileDetail.InquiryReferenceText. CustomerReferenceText





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


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 (sometimes referred to as Latin-1), EXCEPT when the organization is



domiciled in the Czech Republic (CZ), Hungary (HU), Poland (PL) or Slovakia (SK). Data from these markets iscurrently encoded using the ISO 8859-2 character set standard.

Response Codes


This operation may return the following response codes: CM001, CM002, CM004, CM007, CM023, MN001,MN004, SC001-SC009.


CM001 Profile name is sent as blank; or Blank value passed for PCMElementXpath.


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.


Samples (Download)


Monitoring Service


Related Topics

CreateMonitoringProfile (SOAP), ListMonitoringProfile (SOAP).

D&B Direct API Documentation Response Codes


ListMonitoringProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


Refer to How to Retrieve Monitoring Profiles for an overview of this operation.



Endpoint

GET https://maxcvservices.dnb.com/V{version}/monitoring/monitoringprofiles

Request Parameters



{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)



MonitoringProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional


MonitoringProfileID int, Optional



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



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.




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


Data Field Response



ListMonitoringProfileResponse Aggregate

ListMonitoringProfileResponse@ServiceVersionNumber Attribute

ListMonitoringProfileResponse@xsi:schemaLocation Attribute

ListMonitoringProfileResponse { TransactionDetail Aggregate, Required


request. Examples of a request is the ordering of a product.




ListMonitoringProfileResponse { TransactionDetail { ApplicationTransactionID




ListMonitoringProfileResponse { TransactionDetail { ServiceTransactionID



this transaction.

ListMonitoringProfileResponse { TransactionDetail { TransactionTimestamp


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


END: ListMonitoringProfileResponse } TransactionDetail /Aggregate

ListMonitoringProfileResponse { TransactionResult Aggregate, Required



ListMonitoringProfileResponse { TransactionResult { SeverityText




ListMonitoringProfileResponse { TransactionResult { ResultID


An alphanumeric string that uniquely identifies the outcome

of the transaction.

ListMonitoringProfileResponse { TransactionResult { ResultText



ListMonitoringProfileResponse { TransactionResult { ResultMessage


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


Text that describes the additional information regarding the


END: ListMonitoringProfileResponse }TransactionResult } ResultMessage

/Aggregate

END: ListMonitoringProfileResponse }TransactionResult

/Aggregate

ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail

Aggregate, Optional

ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { 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.

ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { CandidateReturnedQuantity


The number of registrations returned in the result set based

on the search criteria in the Customer/User request.

ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail


ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileName



ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileDescription



ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileID

int, Required



ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { DNBProductID


Records the product code that is provided by the customer to

create a profile




ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringLevel





ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail

Aggregate, Optional

ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement


ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { PCMElementXPATHText


ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges


ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeCondition


ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringElementDetail { MonitoringElement { MonitoringChanges { ChangeValue


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



ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { MonitoringProfileCreatedDate

date, Required

Records the start date of the date range to list the Monitoring

profiles

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


ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { InquiryReferenceText { CustomerReferenceText




reconciliation.

END: ListMonitoringProfileResponse }ListMonitoringProfileResponseDetail }MonitoringProfileDetail } InquiryReferenceText

/Aggregate

ListMonitoringProfileResponse { ListMonitoringProfileResponseDetail { MonitoringProfileDetail { DisplaySequence

int, Optional

Records the display sequence number of the results

END: ListMonitoringProfileResponse }ListMonitoringProfileResponseDetail }MonitoringProfileDetail

/Aggregate

END: ListMonitoringProfileResponse }ListMonitoringProfileResponseDetail

/Aggregate

END: ListMonitoringProfileResponse /Aggregate





Response Codes


This operation may return the following response codes: CM002, CM004, CM018, SC001-SC009.

Samples (Download)


Monitoring Service


Related Topics

CreateMonitoringProfile (REST), UpdateMonitoringProfile (REST).



ListMonitoringProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


Refer to How to Retrieve Monitoring Profiles for an overview of this operation.



Endpoint


Request Parameters



ListMonitoringProfileRequest Aggregate

ListMonitoringProfileRequest@ServiceVersionNumber Attribute

ListMonitoringProfileRequest@xsi:schemaLocation Attribute

ListMonitoringProfileRequest. TransactionDetail Aggregate, Optional


ListMonitoringProfileRequest. TransactionDetail.ApplicationTransactionID




ListMonitoringProfileRequest. TransactionDetail.TransactionTimestamp



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


D&B Direct API Documentation ListMonitoringProfile (SOAP)



ListMonitoringProfileRequest. TransactionDetail.SubmittingOfficeID




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



ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. MonitoringProfileID

int, Optional



ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. DNBProductID



create a profile

ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. MonitoringLevel

MonitoringLevelTextEnum up to 16 chars., Optional




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




ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria.MonitoringProfileStatusText




ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. InquiryReferenceText

Aggregate, Optional




ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. InquiryReferenceText.CustomerReferenceText




reconciliation.

END: ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria. InquiryReferenceText

/Aggregate

END: ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileListCriteria

/Aggregate

ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification

Aggregate, Optional

ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification. SortBasisText

MonitoringProfileSortBasisEnum, Optional


Possible values: DNBProductID; MonitoringProfileID;

MonitoringProfileName; MonitoringLevel;

MonitoringProfileStatusText; MonitoringProfileCreatedDate

ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification.SortDirectionText

SortDirectionEnum, Optional


Descending

Possible values: Ascending/Descending

ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification.CandidatePerPageMaximumQuantity

int Less than or equal to 1000., Optional





ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification.CandidateDisplayStartSequenceNumber

int, Optional


END: ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail.MonitoringProfileDisplaySpecification

/Aggregate

END: ListMonitoringProfileRequest.ListMonitoringProfileRequestDetail

/Aggregate

END: ListMonitoringProfileRequest /Aggregate

Testing / Sandbox


Data Field Response



ListMonitoringProfileResponse Aggregate

ListMonitoringProfileResponse@ServiceVersionNumber Attribute

ListMonitoringProfileResponse@xsi:schemaLocation Attribute

ListMonitoringProfileResponse. TransactionDetail Aggregate, Required



ListMonitoringProfileResponse. TransactionDetail.ApplicationTransactionID




ListMonitoringProfileResponse. TransactionDetail.ServiceTransactionID



this transaction.




ListMonitoringProfileResponse. TransactionDetail.TransactionTimestamp







END: ListMonitoringProfileResponse. TransactionDetail /Aggregate

ListMonitoringProfileResponse. TransactionResult Aggregate, Required



ListMonitoringProfileResponse. TransactionResult.SeverityText




ListMonitoringProfileResponse. TransactionResult.ResultID



of the transaction.

ListMonitoringProfileResponse. TransactionResult.ResultText



ListMonitoringProfileResponse. TransactionResult.ResultMessage


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




END: ListMonitoringProfileResponse. TransactionResult.ResultMessage

/Aggregate

END: ListMonitoringProfileResponse. TransactionResult /Aggregate

ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail

Aggregate, Optional




ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.CandidateMatchedQuantity




request.

ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.CandidateReturnedQuantity




ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail


ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringProfileName



ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringProfileDescription



ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringProfileID

int, Required



ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. DNBProductID



create a profile

ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringLevel





ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail

Aggregate, Optional

ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail.MonitoringElement





ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail.MonitoringElement. PCMElementXPATHText


ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail.MonitoringElement. MonitoringChanges


ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail.MonitoringElement. MonitoringChanges.ChangeCondition


ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringElementDetail.MonitoringElement. MonitoringChanges. ChangeValue


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



ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. MonitoringProfileCreatedDate

date, Required

Records the start date of the date range to list the Monitoring

profiles

ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. InquiryReferenceText

Aggregate, Optional







ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. InquiryReferenceText.CustomerReferenceText




reconciliation.

END: ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. InquiryReferenceText

/Aggregate

ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail. DisplaySequence

int, Optional


END: ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail.MonitoringProfileDetail

/Aggregate

END: ListMonitoringProfileResponse.ListMonitoringProfileResponseDetail

/Aggregate

END: ListMonitoringProfileResponse /Aggregate



Response Codes



Samples (Download)


Monitoring Service




Related Topics

CreateMonitoringProfile (SOAP), UpdateMonitoringProfile (SOAP).

D&B Direct API Documentation Related Topics


CreateNotificationProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.




Endpoint

POST https://maxcvservices.dnb.com/V{version}/monitoring/notificationprofiles

Request Parameters







CreateNotificationProfileRequest Aggregate

CreateNotificationProfileRequest@ServiceVersionNumber Attribute

CreateNotificationProfileRequest@xsi:schemaLocation Attribute

CreateNotificationProfileRequest { TransactionDetail Aggregate, Optional


D&B Direct API Documentation CreateNotificationProfile (REST)



CreateNotificationProfileRequest { TransactionDetail { ApplicationTransactionID




CreateNotificationProfileRequest { TransactionDetail { TransactionTimestamp








CreateNotificationProfileRequest { TransactionDetail { SubmittingOfficeID






END: CreateNotificationProfileRequest } TransactionDetail /Aggregate

CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail

Aggregate, Required

CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification

Aggregate, Required

CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { NotificationProfileName



CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { NotificationProfileDescription



CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { DeliveryMode

DeliveryModeEnum, Required

Possible values: Email; HTTPCallBack; MQOutput

CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { NotificationProfileSpecification { DeliveryChannelUserPreferenceName


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




CreateNotificationProfileRequest { CreateNotificationProfileRequestDetail { InquiryReferenceText { CustomerReferenceText




reconciliation.

END: CreateNotificationProfileRequest }CreateNotificationProfileRequestDetail }InquiryReferenceText

/Aggregate

END: CreateNotificationProfileRequest }CreateNotificationProfileRequestDetail

/Aggregate

END: CreateNotificationProfileRequest /Aggregate

Testing / Sandbox


Data Field Response



CreateNotificationProfileResponse Aggregate

CreateNotificationProfileResponse@ServiceVersionNumber Attribute

CreateNotificationProfileResponse@xsi:schemaLocation Attribute




CreateNotificationProfileResponse { TransactionDetail Aggregate, Required



product.

CreateNotificationProfileResponse { TransactionDetail { ApplicationTransactionID




CreateNotificationProfileResponse { TransactionDetail { ServiceTransactionID




CreateNotificationProfileResponse { TransactionDetail { TransactionTimestamp







intermediary.

END: CreateNotificationProfileResponse } TransactionDetail /Aggregate

CreateNotificationProfileResponse { TransactionResult Aggregate, Required



CreateNotificationProfileResponse { TransactionResult { SeverityText




CreateNotificationProfileResponse { TransactionResult { ResultID




CreateNotificationProfileResponse { TransactionResult { ResultText






CreateNotificationProfileResponse { TransactionResult { ResultMessage








CreateNotificationProfileResponse { TransactionResult { ResultMessage { ResultDescription




END: CreateNotificationProfileResponse }TransactionResult } ResultMessage

/Aggregate

END: CreateNotificationProfileResponse }TransactionResult

/Aggregate

CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail

Aggregate, Optional

CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail { NotificationProfileDetail

Aggregate, Required

CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileName



CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileID

int, Required



DUNS.

END: CreateNotificationProfileResponse }CreateNotificationProfileResponseDetail }NotificationProfileDetail

/Aggregate

CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail { InquiryReferenceText

Aggregate, Optional







CreateNotificationProfileResponse { CreateNotificationProfileResponseDetail { InquiryReferenceText { CustomerReferenceText





END: CreateNotificationProfileResponse }CreateNotificationProfileResponseDetail }InquiryReferenceText

/Aggregate

END: CreateNotificationProfileResponse }CreateNotificationProfileResponseDetail

/Aggregate

END: CreateNotificationProfileResponse /Aggregate



Response Codes


This operation may return the following response codes: CM002, CM004, CM007, CM023, SC001-SC009.



CM007 Delivery Channel User Preference Name is invalid.


Samples (Download)


Monitoring Service




Related Topics

UpdateNotificationProfile (REST), ListNotificationProfile (REST), CreatePreference (REST).



CreateNotificationProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.




Endpoint


Request Parameters



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)



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


A string that records the description

of the profile

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. DeliveryMode


Possible values: Email; HTTPCallBack;

MQOutput

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. DeliveryChannelUserPreferenceName

string at least 1 chars. up to 64chars. Pattern: {.*[^\s].*}., Optional




CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. DeliveryFrequency


Possible values: Immediate; Hourly;

Daily; Weekly

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.NotificationProfileSpecification. DeliveryFormat



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


END: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail.InquiryReferenceText

/Aggregate

END: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail /Aggregate

END: CreateNotificationProfileRequest /Aggregate

Testing / Sandbox


Data Field Response



CreateNotificationProfileResponse Aggregate

CreateNotificationProfileResponse@ServiceVersionNumber Attribute




CreateNotificationProfileResponse@xsi:schemaLocation Attribute

CreateNotificationProfileResponse. TransactionDetail Aggregate, Required



product.

CreateNotificationProfileResponse. TransactionDetail.ApplicationTransactionID




CreateNotificationProfileResponse. TransactionDetail.ServiceTransactionID




CreateNotificationProfileResponse. TransactionDetail.TransactionTimestamp







intermediary.

END: CreateNotificationProfileResponse. TransactionDetail /Aggregate

CreateNotificationProfileResponse. TransactionResult Aggregate, Required



CreateNotificationProfileResponse. TransactionResult.SeverityText




CreateNotificationProfileResponse. TransactionResult.ResultID




CreateNotificationProfileResponse. TransactionResult.ResultText






CreateNotificationProfileResponse. TransactionResult.ResultMessage








CreateNotificationProfileResponse. TransactionResult.ResultMessage. ResultDescription




END: CreateNotificationProfileResponse. TransactionResult.ResultMessage

/Aggregate

END: CreateNotificationProfileResponse. TransactionResult /Aggregate

CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail

Aggregate, Optional

CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.NotificationProfileDetail

Aggregate, Required

CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileName



CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileID

int, Required



DUNS.

END: CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.NotificationProfileDetail

/Aggregate

CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.InquiryReferenceText

Aggregate, Optional







CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.InquiryReferenceText. CustomerReferenceText





END: CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail.InquiryReferenceText

/Aggregate

END: CreateNotificationProfileResponse.CreateNotificationProfileResponseDetail

/Aggregate

END: CreateNotificationProfileResponse /Aggregate



Response Codes





CM007 Delivery Channel User Preference Name is invalid.


Samples (Download)


Monitoring Service




Related Topics

UpdateNotificationProfile (SOAP), ListNotificationProfile (SOAP), CreatePreference (SOAP).



UpdateNotificationProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


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.



Endpoint

PUT https://maxcvservices.dnb.com/V{version}/monitoring/notificationprofiles/{NotificationProfileID}

Request Parameters

The following parameter(s) are required in the endpoint.


{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.


D&B Direct API Documentation UpdateNotificationProfile (REST)







UpdateNotificationProfileRequest Aggregate

UpdateNotificationProfileRequest@ServiceVersionNumber Attribute

UpdateNotificationProfileRequest@xsi:schemaLocation Attribute

UpdateNotificationProfileRequest { TransactionDetail Aggregate, Optional


UpdateNotificationProfileRequest { TransactionDetail { ApplicationTransactionID




UpdateNotificationProfileRequest { TransactionDetail { TransactionTimestamp








UpdateNotificationProfileRequest { TransactionDetail { SubmittingOfficeID



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 { NotificationProfileName



UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryChannelUserPreferenceName


UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryMode

DeliveryModeEnum, Optional


UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryFrequency

DeliveryFrequencyEnum, Optional


UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryFormat

DeliveryFormatEnum, Optional

Possible values: XML; JSON

UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { NotificationProfileStatusText

NotificationProfileStatusTextEnum, Optional

Records the status of the monitoring registration


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


Data Field Response



UpdateNotificationProfileResponse Aggregate

UpdateNotificationProfileResponse@ServiceVersionNumber Attribute

UpdateNotificationProfileResponse@xsi:schemaLocation Attribute

UpdateNotificationProfileResponse { TransactionDetail Aggregate, Required



product.

UpdateNotificationProfileResponse { TransactionDetail { ApplicationTransactionID




UpdateNotificationProfileResponse { TransactionDetail { ServiceTransactionID




UpdateNotificationProfileResponse { TransactionDetail { TransactionTimestamp







intermediary.

END: UpdateNotificationProfileResponse } TransactionDetail /Aggregate

UpdateNotificationProfileResponse { TransactionResult Aggregate, Required


the different outcomes of the transaction.




UpdateNotificationProfileResponse { TransactionResult { SeverityText




UpdateNotificationProfileResponse { TransactionResult { ResultID




UpdateNotificationProfileResponse { TransactionResult { ResultText



UpdateNotificationProfileResponse { TransactionResult { ResultMessage








UpdateNotificationProfileResponse { TransactionResult { ResultMessage { ResultDescription




END: UpdateNotificationProfileResponse }TransactionResult } ResultMessage

/Aggregate

END: UpdateNotificationProfileResponse }TransactionResult

/Aggregate

UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail

Aggregate, Optional

UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail

Aggregate, Optional

UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileID

int, Required



DUNS.

UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileName






UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryChannelUserPreferenceName


UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryMode



UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryFrequency



UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryFormat



UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileStatusText




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



UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { DeliveryChannelUserPreferenceName





UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { DeliveryMode



UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { DeliveryFrequency



UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { DeliveryFormat


Possible values: XML; JSON

UpdateNotificationProfileResponse { UpdateNotificationProfileResponseDetail { NotificationProfileDetail { FormerNotificationProfileDetail { NotificationProfileStatusText




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





Response Codes


This operation may return the following response codes: CM001, CM002, CM004, CM007, MN002, MN005,SC001-SC009.


CM001 Blank Notification profile name


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)


Monitoring Service




UpdateNotificationProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


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.



Endpoint


Request Parameters



UpdateNotificationProfileRequest Aggregate

UpdateNotificationProfileRequest@ServiceVersionNumber Attribute

UpdateNotificationProfileRequest@xsi:schemaLocation Attribute

UpdateNotificationProfileRequest. TransactionDetail Aggregate, Optional


UpdateNotificationProfileRequest. TransactionDetail.ApplicationTransactionID




D&B Direct API Documentation UpdateNotificationProfile (SOAP)



UpdateNotificationProfileRequest. TransactionDetail.TransactionTimestamp








UpdateNotificationProfileRequest. TransactionDetail.SubmittingOfficeID






originated.

END: UpdateNotificationProfileRequest. TransactionDetail /Aggregate

UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail

Aggregate, Required

UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail

Aggregate, Required

UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. NotificationProfileID

int, Required



UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. NotificationProfileName



UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail.DeliveryChannelUserPreferenceName


UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. DeliveryMode



UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. DeliveryFrequency



UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. DeliveryFormat






UpdateNotificationProfileRequest.UpdateNotificationProfileRequestDetail.NotificationProfileDetail. NotificationProfileStatusText




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


Data Field Response



UpdateNotificationProfileResponse Aggregate

UpdateNotificationProfileResponse@ServiceVersionNumber Attribute

UpdateNotificationProfileResponse@xsi:schemaLocation Attribute




UpdateNotificationProfileResponse. TransactionDetail Aggregate, Required



product.

UpdateNotificationProfileResponse. TransactionDetail.ApplicationTransactionID




UpdateNotificationProfileResponse. TransactionDetail.ServiceTransactionID




UpdateNotificationProfileResponse. TransactionDetail.TransactionTimestamp







intermediary.

END: UpdateNotificationProfileResponse. TransactionDetail /Aggregate

UpdateNotificationProfileResponse. TransactionResult Aggregate, Required



UpdateNotificationProfileResponse. TransactionResult.SeverityText




UpdateNotificationProfileResponse. TransactionResult.ResultID




UpdateNotificationProfileResponse. TransactionResult.ResultText






UpdateNotificationProfileResponse. TransactionResult.ResultMessage








UpdateNotificationProfileResponse. TransactionResult.ResultMessage. ResultDescription




END: UpdateNotificationProfileResponse. TransactionResult.ResultMessage

/Aggregate

END: UpdateNotificationProfileResponse. TransactionResult /Aggregate

UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail

Aggregate, Optional

UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail

Aggregate, Optional

UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileID

int, Required



DUNS.

UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileName



UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail.DeliveryChannelUserPreferenceName


UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryMode



UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryFrequency



UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryFormat






UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileStatusText




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



UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.DeliveryChannelUserPreferenceName


UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.DeliveryMode



UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.DeliveryFrequency



UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.DeliveryFormat






UpdateNotificationProfileResponse.UpdateNotificationProfileResponseDetail.NotificationProfileDetail. FormerNotificationProfileDetail.NotificationProfileStatusText




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





Response Codes


This operation may return the following response codes: CM001, CM002, CM004, CM007, MN002, MN005,SC001-SC009.


CM001 Blank Notification profile name


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)


Monitoring Service




ListNotificationProfile (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


Refer to How to Retrieve Notification Profiles for an overview of this operation.



Endpoint

GET https://maxcvservices.dnb.com/V{version}/monitoring/notificationprofiles

Request Parameters




A number assigned by the calling application to uniquely identify

this request.



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


D&B Direct API Documentation ListNotificationProfile (REST)




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



NotificationProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional


DeliveryChannelUserPreferenceName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional

DeliveryMode DeliveryModeEnum, Optional


DeliveryFrequency DeliveryFrequencyEnum, Optional


DeliveryFormat DeliveryFormatEnum, Optional


NotificationProfileStatusText NotificationProfileStatusTextEnum, Optional



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.




SortBasisText NotificationProfileSortBasisEnum, Optional


Possible values: DeliveryChannelUserPreferenceName;

NotificationProfileID; NotificationProfileName; DeliveryMode;

DeliveryFrequency; DeliveryFormat; StopDeliveryIndicator;

NotificationProfileCreatedDate; NotificationProfileStatusText



Descending





Testing / Sandbox


Data Field Response



ListNotificationProfileResponse Aggregate

ListNotificationProfileResponse@ServiceVersionNumber Attribute

ListNotificationProfileResponse@xsi:schemaLocation Attribute

ListNotificationProfileResponse { TransactionDetail Aggregate, Required



ListNotificationProfileResponse { TransactionDetail { ApplicationTransactionID







ListNotificationProfileResponse { TransactionDetail { ServiceTransactionID



this transaction.

ListNotificationProfileResponse { TransactionDetail { TransactionTimestamp







END: ListNotificationProfileResponse } TransactionDetail /Aggregate

ListNotificationProfileResponse { TransactionResult Aggregate, Required



ListNotificationProfileResponse { TransactionResult { SeverityText




ListNotificationProfileResponse { TransactionResult { ResultID



of the transaction.

ListNotificationProfileResponse { TransactionResult { ResultText



ListNotificationProfileResponse { TransactionResult { ResultMessage



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







END: ListNotificationProfileResponse }TransactionResult } ResultMessage

/Aggregate

END: ListNotificationProfileResponse }TransactionResult

/Aggregate

ListNotificationProfileResponse { ListNotificationProfileResponseDetail

Aggregate, Optional

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { CandidateMatchedQuantity




request.

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { CandidateReturnedQuantity




ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail


ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileID

int, Required



ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileName



ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryChannelUserPreferenceName


ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileDescription



ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryMode



ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryFrequency



ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryFormat






ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileStatusText

NotificationProfileStatusTextEnum, Required



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




ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { InquiryReferenceText { CustomerReferenceText




reconciliation.

END: ListNotificationProfileResponse }ListNotificationProfileResponseDetail }NotificationProfileDetail } InquiryReferenceText

/Aggregate

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DisplaySequence

int, Optional


END: ListNotificationProfileResponse }ListNotificationProfileResponseDetail }NotificationProfileDetail

/Aggregate

END: ListNotificationProfileResponse }ListNotificationProfileResponseDetail

/Aggregate

END: ListNotificationProfileResponse /Aggregate


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 (sometimes referred to as Latin-1), EXCEPT when the organization is



domiciled in the Czech Republic (CZ), Hungary (HU), Poland (PL) or Slovakia (SK). Data from these markets iscurrently encoded using the ISO 8859-2 character set standard.

Response Codes



Samples (Download)


Monitoring Service


Related Topics

CreateNotificationProfile (REST), UpdateNotificationProfile (REST).



ListNotificationProfile (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


Refer to How to Retrieve Notification Profiles for an overview of this operation.



Endpoint


Request Parameters



ListNotificationProfileRequest Aggregate

ListNotificationProfileRequest@ServiceVersionNumber Attribute

ListNotificationProfileRequest@xsi:schemaLocation Attribute

ListNotificationProfileRequest. TransactionDetail Aggregate, Optional


ListNotificationProfileRequest. TransactionDetail.ApplicationTransactionID




D&B Direct API Documentation ListNotificationProfile (SOAP)



ListNotificationProfileRequest. TransactionDetail.TransactionTimestamp



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




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



ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. NotificationProfileName



ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria.DeliveryChannelUserPreferenceName


ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. DeliveryMode



ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. DeliveryFrequency



ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. DeliveryFormat






ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria.NotificationProfileStatusText




ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. StopDeliveryIndicator

boolean, Optional

ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. CreatedFromDate

date, Optional


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




ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. InquiryReferenceText.CustomerReferenceText




reconciliation.

END: ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria. InquiryReferenceText

/Aggregate

END: ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileListCriteria

/Aggregate

ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification

Aggregate, Optional




ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification. SortBasisText

NotificationProfileSortBasisEnum, Optional


Possible values: DeliveryChannelUserPreferenceName;

NotificationProfileID; NotificationProfileName; DeliveryMode;

DeliveryFrequency; DeliveryFormat; StopDeliveryIndicator;

NotificationProfileCreatedDate; NotificationProfileStatusText

ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification.SortDirectionText



Descending

ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification.CandidatePerPageMaximumQuantity



ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification.CandidateDisplayStartSequenceNumber

int, Optional


END: ListNotificationProfileRequest.ListNotificationProfileRequestDetail.NotificationProfileDisplaySpecification

/Aggregate

END: ListNotificationProfileRequest.ListNotificationProfileRequestDetail

/Aggregate

END: ListNotificationProfileRequest /Aggregate

Testing / Sandbox


Data Field Response



ListNotificationProfileResponse Aggregate

ListNotificationProfileResponse@ServiceVersionNumber Attribute

ListNotificationProfileResponse@xsi:schemaLocation Attribute




ListNotificationProfileResponse. TransactionDetail Aggregate, Required



ListNotificationProfileResponse. TransactionDetail.ApplicationTransactionID




ListNotificationProfileResponse. TransactionDetail.ServiceTransactionID



this transaction.

ListNotificationProfileResponse. TransactionDetail.TransactionTimestamp







END: ListNotificationProfileResponse. TransactionDetail /Aggregate

ListNotificationProfileResponse. TransactionResult Aggregate, Required



ListNotificationProfileResponse. TransactionResult.SeverityText




ListNotificationProfileResponse. TransactionResult.ResultID



of the transaction.

ListNotificationProfileResponse. TransactionResult.ResultText






ListNotificationProfileResponse. TransactionResult.ResultMessage



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




END: ListNotificationProfileResponse. TransactionResult.ResultMessage

/Aggregate

END: ListNotificationProfileResponse. TransactionResult /Aggregate

ListNotificationProfileResponse.ListNotificationProfileResponseDetail

Aggregate, Optional

ListNotificationProfileResponse.ListNotificationProfileResponseDetail.CandidateMatchedQuantity




request.

ListNotificationProfileResponse.ListNotificationProfileResponseDetail.CandidateReturnedQuantity




ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail


ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileID

int, Required



ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileName



ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail.DeliveryChannelUserPreferenceName





ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileDescription



ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryMode



ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryFrequency



ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. DeliveryFormat



ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileStatusText

NotificationProfileStatusTextEnum, Required



ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. StopDeliveryIndicator

boolean, Required

ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. NotificationProfileCreatedDate

date, Required


profiles

ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. InquiryReferenceText

Aggregate, Optional




ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. InquiryReferenceText.CustomerReferenceText




reconciliation.

END: ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. InquiryReferenceText

/Aggregate

ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail. DisplaySequence

int, Optional





END: ListNotificationProfileResponse.ListNotificationProfileResponseDetail.NotificationProfileDetail

/Aggregate

END: ListNotificationProfileResponse.ListNotificationProfileResponseDetail

/Aggregate

END: ListNotificationProfileResponse /Aggregate



Response Codes



Samples (Download)


Monitoring Service


Related Topics

CreateNotificationProfile (SOAP), UpdateNotificationProfile (SOAP).



AddMonitoringRegistration (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


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.



Endpoint

POST https://maxcvservices.dnb.com/V{version}/monitoring/registrations

Request Parameters






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)


When monitoring the People data layer, a principal identification number (Principal ID) will be required bythis operation.


AddMonitoringRegistrationRequest Aggregate

AddMonitoringRegistrationRequest@ServiceVersionNumber Attribute

AddMonitoringRegistrationRequest@xsi:schemaLocation Attribute

AddMonitoringRegistrationRequest { TransactionDetail Aggregate, Optional


AddMonitoringRegistrationRequest { TransactionDetail { ApplicationTransactionID




AddMonitoringRegistrationRequest { TransactionDetail { TransactionTimestamp




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


AddMonitoringRegistrationRequest { TransactionDetail { SubmittingOfficeID






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.

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



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.

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


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


information to be linked to the request in order to

support subsequent order reconciliation.




AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryReferenceDetail { CustomerReferenceText





AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryReferenceDetail { CustomerBillingEndorsementText


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



individual.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber

string, Optional



individual.


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.



Data Field Response



AddMonitoringRegistrationResponse Aggregate

AddMonitoringRegistrationResponse@ServiceVersionNumber Attribute

AddMonitoringRegistrationResponse@xsi:schemaLocation Attribute

AddMonitoringRegistrationResponse { TransactionDetail Aggregate, Required



product.

AddMonitoringRegistrationResponse { TransactionDetail { ApplicationTransactionID




AddMonitoringRegistrationResponse { TransactionDetail { ServiceTransactionID




AddMonitoringRegistrationResponse { TransactionDetail { TransactionTimestamp







intermediary.

END: AddMonitoringRegistrationResponse } TransactionDetail /Aggregate

AddMonitoringRegistrationResponse { TransactionResult Aggregate, Required



AddMonitoringRegistrationResponse { TransactionResult { SeverityText








AddMonitoringRegistrationResponse { TransactionResult { ResultID




AddMonitoringRegistrationResponse { TransactionResult { ResultText



AddMonitoringRegistrationResponse { TransactionResult { ResultMessage



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


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







AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail { CountryISOAlpha2Code





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


Records the duns number that is registered for

Monitoring.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringProfileID

int, Required



DUNS.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { NotificationProfileID

int, Required



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




AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryReferenceDetail { CustomerReferenceText


A freeform reference string provided by the customer

to be linked to the product in order to support


AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText


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



Response Codes


This operation may return the following response codes: CM001, CM002, CM004, CM009, CM011, CM012,CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.




CM001 Invalid Monitoring Profile ID; or Invalid Notification Profile ID.


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)


Monitoring Service


Related Topics

UpdateMonitoringRegistration (REST), ListMonitoringRegistration (REST), Change Notice (XML),CreateMonitoringProfile (REST), CreateNotificationProfile (REST).



AddMonitoringRegistration (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


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.



Endpoint


Request Parameters


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.



AddMonitoringRegistrationRequest Aggregate

AddMonitoringRegistrationRequest@ServiceVersionNumber Attribute

AddMonitoringRegistrationRequest@xsi:schemaLocation Attribute

AddMonitoringRegistrationRequest. TransactionDetail Aggregate, Optional


D&B Direct API Documentation AddMonitoringRegistration (SOAP)



AddMonitoringRegistrationRequest. TransactionDetail.ApplicationTransactionID




AddMonitoringRegistrationRequest. TransactionDetail.TransactionTimestamp








AddMonitoringRegistrationRequest. TransactionDetail.SubmittingOfficeID






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




AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail. InquiryDetail.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber

string, Optional



individual.




AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail. InquiryDetail.CountryISOAlpha2Code





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



DUNS.

AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification. NotificationProfileID

int, Required



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.




AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification. AutoRenewalIndicator

boolean, Optional




AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification. SubjectCategoryText





AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification.RegistrationReasonCode





END: AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.MonitoringRegistrationSpecification

/Aggregate

AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.InquiryReferenceDetail

Aggregate, Optional




AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.InquiryReferenceDetail. CustomerReferenceText





AddMonitoringRegistrationRequest.AddMonitoringRegistrationRequestDetail.InquiryReferenceDetail. CustomerBillingEndorsementText


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



individual.

AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber

string, Optional



individual.


Testing / Sandbox


Data Field Response



AddMonitoringRegistrationResponse Aggregate

AddMonitoringRegistrationResponse@ServiceVersionNumber Attribute

AddMonitoringRegistrationResponse@xsi:schemaLocation Attribute

AddMonitoringRegistrationResponse. TransactionDetail Aggregate, Required



product.

AddMonitoringRegistrationResponse. TransactionDetail.ApplicationTransactionID







AddMonitoringRegistrationResponse. TransactionDetail.ServiceTransactionID




AddMonitoringRegistrationResponse. TransactionDetail.TransactionTimestamp







intermediary.

END: AddMonitoringRegistrationResponse. TransactionDetail /Aggregate

AddMonitoringRegistrationResponse. TransactionResult Aggregate, Required



AddMonitoringRegistrationResponse. TransactionResult.SeverityText





AddMonitoringRegistrationResponse. TransactionResult.ResultID




AddMonitoringRegistrationResponse. TransactionResult.ResultText



AddMonitoringRegistrationResponse. TransactionResult.ResultMessage











AddMonitoringRegistrationResponse. TransactionResult.ResultMessage. ResultDescription




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




AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail. InquiryDetail.CountryISOAlpha2Code





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



Monitoring.

AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. MonitoringProfileID

int, Required



DUNS.




AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. NotificationProfileID

int, Required



Alerts.

AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. StartDate

date, Required


monitoring.

AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. EndDate

date, Required


has been ended.

END: AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail

/Aggregate

AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.InquiryReferenceDetail

Aggregate, Optional




AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.InquiryReferenceDetail. CustomerReferenceText


A freeform reference string provided by the customer

to be linked to the product in order to support


AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.InquiryReferenceDetail. CustomerBillingEndorsementText







process.

END: AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail.InquiryReferenceDetail

/Aggregate

END: AddMonitoringRegistrationResponse.AddMonitoringRegistrationResponseDetail

/Aggregate

END: AddMonitoringRegistrationResponse /Aggregate





Response Codes


This operation may return the following response codes: CM001, CM002, CM004, CM009, CM011, CM012,CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.











Samples (Download)


Monitoring Service




Related Topics

UpdateMonitoringRegistration (SOAP), ListMonitoringRegistration (SOAP), Change Notice(XML), CreateMonitoringProfile (SOAP), CreateNotificationProfile (SOAP).



Change NoticeThe following table is the XML layout of the Change Notices triggered by a monitoring event.


Refer to the section "Understanding Change Notices" for some tips and examples.

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).


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


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

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail


ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail

Aggregate, Required

D&B Direct API Documentation Change Notice



ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail. DUNSNumber


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


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


END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail.OrganizationPrimaryName

/Aggregate

END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectDetail

/Aggregate

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. SubjectCategoryText


An alphanumeric value identifying the category in which the

Customer has classified the subject.


D&B Direct API Documentation Field Details



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



ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. MonitoringProfileDetail.DNBProductID


An alphanumeric string that uniquely identifies this product.

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. MonitoringProfileDetail.MonitoringLevel


A alphanumeric string which determines the level of details that

the customer will receive during a change event


END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. MonitoringProfileDetail

/Aggregate

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent


ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. ChangeEventID

long, Required

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent.ChangeDetectionTimestamp


The date and time when this notification has been generated

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. ElementName


ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent.PCMElementXPATHText


ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. Element

String, Optional (Infinite)

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


ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChangeType

string, RequiredPossible values: Add, Drop.

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChangeReasonText


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


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

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.GlobalUltimateOrganization. DUNSNumber


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




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





END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerGlobalUltimateOrganization

/Aggregate

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.UpwardFamilyMemberOrganization

Aggregate, Optional

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.UpwardFamilyMemberOrganization.AssociationTypeText




Parent

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





END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.UpwardFamilyMemberOrganization

/Aggregate

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerUpwardFamilyMemberOrganization

Aggregate, Optional

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerUpwardFamilyMemberOrganization.AssociationTypeText




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





END: ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.FormerUpwardFamilyMemberOrganization

/Aggregate

ChangeNotice. ChangeNoticeDetail.SubjectChangeDetail. ChangeEvent. LinkageChange.ChildrenSummary


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


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.

Note: The OrderProductResponse@ServiceVersionNumber value in the object attachment will NOT matchthe version of the data layer when retrieved from it's corresponding service.

Sample Notice

<mon:ChangeNotice xmlns:mon="http://services.dnb.com/MonitoringServiceV2.0">

<TransactionDetail><ChangeNoticeID>73485</ChangeNoticeID><ChangeNoticeDeliveryTimestamp>2013-11-08T04:10:35</ChangeNoticeDel

iveryTimestamp></TransactionDetail><ChangeNoticeDetail>

D&B Direct API Documentation Sample Notice


<SubjectChangeDetail><SubjectDetail>

<DUNSNumber>399301670</DUNSNumber><CountryISOAlpha2Code>US</CountryISOAlpha2Code>

</SubjectDetail><SubjectCategoryText>High</SubjectCategoryText><LanguageCode>39</LanguageCode><MonitoringProfileDetail>

<MonitoringProfileID>2526</MonitoringProfileID><DNBProductID>LNK_FF</DNBProductID><MonitoringLevel>Level1</MonitoringLevel>

</MonitoringProfileDetail><NotificationProfileID>1861</NotificationProfileID><ChangeEvent>

<ChangeEventID>1737594</ChangeEventID><ChangeDetectionTimestamp>2013-11-08T04:05:19.000</ChangeDetectio

nTimestamp><ElementName>LinkageChange</ElementName><PCMElementXPATHText>//Organization/Linkage</PCMElementXPATHText><LinkageChange>

<DUNSNumber>399301670</DUNSNumber><ChangeType>Add</ChangeType><GlobalUltimateOrganization>

<AssociationTypeText>GlobalUltimate</AssociationTypeText><DUNSNumber>399301670</DUNSNumber>

</GlobalUltimateOrganization><UpwardFamilyMemberOrganization>

<AssociationTypeText>Parent</AssociationTypeText><DUNSNumber/>

</UpwardFamilyMemberOrganization></LinkageChange>

</ChangeEvent></SubjectChangeDetail><SubjectChangeDetail>

<SubjectDetail><DUNSNumber>399301670</DUNSNumber><CountryISOAlpha2Code>US</CountryISOAlpha2Code>

</SubjectDetail><SubjectCategoryText>High</SubjectCategoryText><LanguageCode>39</LanguageCode><MonitoringProfileDetail>



<MonitoringProfileID>2525</MonitoringProfileID><DNBProductID>LNK_FF</DNBProductID><MonitoringLevel>Level2</MonitoringLevel>

</MonitoringProfileDetail><NotificationProfileID>1861</NotificationProfileID><ChangeEvent>

<ChangeEventID>1737595</ChangeEventID><ChangeDetectionTimestamp>2013-11-08T04:05:19.000</ChangeDetectio

nTimestamp><ElementName>LinkageChange</ElementName><PCMElementXPATHText>//Organization/Linkage</PCMElementXPATHText><LinkageChange>

<DUNSNumber>399301670</DUNSNumber><ChangeType>Add</ChangeType><GlobalUltimateOrganization>

<AssociationTypeText>GlobalUltimate</AssociationTypeText><DUNSNumber>399301670</DUNSNumber>

</GlobalUltimateOrganization><UpwardFamilyMemberOrganization>

<AssociationTypeText>Parent</AssociationTypeText><DUNSNumber/>

</UpwardFamilyMemberOrganization></LinkageChange>

</ChangeEvent></SubjectChangeDetail>

</ChangeNoticeDetail></mon:ChangeNotice>



UpdateMonitoringRegistration (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


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.



Endpoint

PUT https://maxcvservices.dnb.com/V{version}/monitoring/registrations

Request Parameters







UpdateMonitoringRegistrationRequest Aggregate

UpdateMonitoringRegistrationRequest@ServiceVersionNumber Attribute

D&B Direct API Documentation UpdateMonitoringRegistration (REST)



UpdateMonitoringRegistrationRequest@xsi:schemaLocation Attribute

UpdateMonitoringRegistrationRequest { TransactionDetail Aggregate, Optional

Records information necessary to process this

request.

UpdateMonitoringRegistrationRequest { TransactionDetail { ApplicationTransactionID


A number assigned by the calling application to

uniquely identify this request.

UpdateMonitoringRegistrationRequest { TransactionDetail { TransactionTimestamp


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






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






UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { InquiryDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber

Element

UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail { MonitoringProfileID

int, Optional



DUNS.

UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail { NotificationProfileID

int, Optional



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


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


An alphanumeric value identifying the category in

which the Customer has classified the subject.


UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { MonitoringRegistrationStatusText

MonitoringRegistrationStatusEnum, Optional






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


Data Field Response

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.


UpdateMonitoringRegistrationResponse Aggregate

UpdateMonitoringRegistrationResponse@ServiceVersionNumber Attribute

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




UpdateMonitoringRegistrationResponse { TransactionDetail { ServiceTransactionID




UpdateMonitoringRegistrationResponse { TransactionDetail { TransactionTimestamp


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



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




UpdateMonitoringRegistrationResponse { TransactionResult { ResultID




UpdateMonitoringRegistrationResponse { TransactionResult { ResultText






UpdateMonitoringRegistrationResponse { TransactionResult { ResultMessage



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




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


Records the details of monitoring registration before

and after the update

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DUNSNumber



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.




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


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


Records the former status of the monitoring

registration


UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceText

Aggregate

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceText { CustomerReferenceText

Element

END: UpdateMonitoringRegistrationResponse }UpdateMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail } InquiryReferenceText

/Aggregate




UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail

Aggregate, Optional

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { NotificationProfileID

int, Optional




UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { SubjectCategoryText




subject.

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { AutoRenewalIndicator

boolean, Optional






Autorenewal.

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { MonitoringRegistrationStatusText



registration


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

END: UpdateMonitoringRegistrationResponse }UpdateMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail

/Aggregate

END: UpdateMonitoringRegistrationResponse }UpdateMonitoringRegistrationResponseDetail

/Aggregate

END: UpdateMonitoringRegistrationResponse /Aggregate



Response Codes


This operation may return the following response codes: CM001, CM002, CM004, CM011, CM012,CM018, CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.













Samples (Download)


Monitoring Service


Related Topics

ListMonitoringRegistration (REST), AddMonitoringRegistration (REST).



UpdateMonitoringRegistration (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


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.



Endpoint


Request Parameters




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)



UpdateMonitoringRegistrationRequest. TransactionDetail.ApplicationTransactionID




UpdateMonitoringRegistrationRequest. TransactionDetail.TransactionTimestamp



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



intermediary.

UpdateMonitoringRegistrationRequest. TransactionDetail.SubmittingOfficeID






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




UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail. InquiryDetail.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber

Element




UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationDetail. MonitoringProfileID

int, Optional



DUNS.

UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationDetail. NotificationProfileID

int, Optional



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


Alerts.

UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification.AutoRenewalIndicator

boolean, Optional




UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification.SubjectCategoryText





UpdateMonitoringRegistrationRequest.UpdateMonitoringRegistrationRequestDetail.MonitoringRegistrationUpdateSpecification.MonitoringRegistrationStatusText




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


Data Field Response

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.


UpdateMonitoringRegistrationResponse Aggregate

UpdateMonitoringRegistrationResponse@ServiceVersionNumber Attribute

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







UpdateMonitoringRegistrationResponse. TransactionDetail.ServiceTransactionID




UpdateMonitoringRegistrationResponse. TransactionDetail.TransactionTimestamp



submitted or the date and time when the

requesting intermediary, such as a workflow

manager or service bus, sent the message to the



intermediary.

END: UpdateMonitoringRegistrationResponse. TransactionDetail /Aggregate

UpdateMonitoringRegistrationResponse. TransactionResult Aggregate, Required


record the different outcomes of the transaction.

UpdateMonitoringRegistrationResponse. TransactionResult.SeverityText




UpdateMonitoringRegistrationResponse. TransactionResult.ResultID




UpdateMonitoringRegistrationResponse. TransactionResult.ResultText



UpdateMonitoringRegistrationResponse. TransactionResult.ResultMessage



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




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


Records the details of monitoring registration before

and after the update

UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. DUNSNumber



customer to update the Monitoring registration.

UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. MonitoringProfileID

int, Required



set of DUNS.

UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. NotificationProfileID

int, Optional




UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. SubjectCategoryText




subject.




UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. AutoRenewalIndicator

boolean, Optional






Autorenewal.

UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. MonitoringRegistrationStatusText



registration


UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceText

Aggregate

UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceText.CustomerReferenceText

Element

END: UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceText

/Aggregate

UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail

Aggregate, Optional

UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail. NotificationProfileID

int, Optional




UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail. SubjectCategoryText




subject.




UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail. AutoRenewalIndicator

boolean, Optional






Autorenewal.

UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.FormerMonitoringRegistrationDetail.MonitoringRegistrationStatusText



registration


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

END: UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail

/Aggregate

END: UpdateMonitoringRegistrationResponse.UpdateMonitoringRegistrationResponseDetail

/Aggregate

END: UpdateMonitoringRegistrationResponse /Aggregate


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



the ISO 8859-1 character set standard (sometimes referred to as Latin-1), EXCEPT when the organization isdomiciled in the Czech Republic (CZ), Hungary (HU), Poland (PL) or Slovakia (SK). Data from these markets iscurrently encoded using the ISO 8859-2 character set standard.

Response Codes


This operation may return the following response codes: CM001, CM002, CM004, CM011, CM012,CM018, CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.











Samples (Download)


Monitoring Service


Related Topics

ListMonitoringRegistration (SOAP), AddMonitoringRegistration (SOAP).



ListMonitoringRegistration (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


Refer to How to Retrieve Monitoring Registrations for an overview of this operation.



Endpoint

GET https://maxcvservices.dnb.com/V{version}/monitoring/registrations

Request Parameters



{version} Element






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



intermediary.

D&B Direct API Documentation ListMonitoringRegistration (REST)







segment or delivery channel from where this

request originated.

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



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


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



set of DUNS.

DNBProductID string up to 64 chars., Optional

Records the product code that is provided by the

customer to create a profile


A alphanumeric string which determines the level of

details that the customer will receive during a

change event





NotificationProfileID int, Optional


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




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


Possible values: Active; Cancelled; Expired




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


Records the direction of sorting. Possbile values are

Ascending, Descending


Records the maximum quantity that can be

displayed per page



Testing / Sandbox


Data Field Response



ListMonitoringRegistrationResponse Aggregate

ListMonitoringRegistrationResponse@ServiceVersionNumber Attribute

ListMonitoringRegistrationResponse@xsi:schemaLocation Attribute




ListMonitoringRegistrationResponse { TransactionDetail Aggregate, Required



product.

ListMonitoringRegistrationResponse { TransactionDetail { ApplicationTransactionID




ListMonitoringRegistrationResponse { TransactionDetail { ServiceTransactionID




ListMonitoringRegistrationResponse { TransactionDetail { TransactionTimestamp







intermediary.

END: ListMonitoringRegistrationResponse } TransactionDetail /Aggregate

ListMonitoringRegistrationResponse { TransactionResult Aggregate, Required



ListMonitoringRegistrationResponse { TransactionResult { SeverityText




ListMonitoringRegistrationResponse { TransactionResult { ResultID




ListMonitoringRegistrationResponse { TransactionResult { ResultText






ListMonitoringRegistrationResponse { TransactionResult { ResultMessage








ListMonitoringRegistrationResponse { TransactionResult { ResultMessage { ResultDescription




END: ListMonitoringRegistrationResponse }TransactionResult } ResultMessage

/Aggregate

END: ListMonitoringRegistrationResponse }TransactionResult

/Aggregate

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail

Aggregate, Optional

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { CandidateMatchedQuantity


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


The number of registrations returned in the result set

based on the search criteria in the Customer/User

request.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail


Records the details of the registrations returned in the

result set based on the search criteria in the


ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryDetail

Aggregate, Optional

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryDetail { DUNSNumber







END: ListMonitoringRegistrationResponse }ListMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail } InquiryDetail

/Aggregate

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DUNSNumber



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





inquired subject.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringProfileID

int, Required



DUNS.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DNBProductID




ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringLevel



details that the customer will receive during a change

event


ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { NotificationProfileID

int, Required



Alerts.




ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { AutoRenewalIndicator

boolean, Required




ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { SubjectCategoryText





ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { RegistrationReasonCode





ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { StartDate

date, Required


monitoring.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { EndDate

date, Required


has been ended.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringRegistrationStatusText

MonitoringRegistartionStatusTextEnum, Required



ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail

Aggregate, Optional




ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail { CustomerReferenceText








ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail { CustomerBillingEndorsementText







process.

END: ListMonitoringRegistrationResponse }ListMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail } InquiryReferenceDetail

/Aggregate

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DisplaySequence

int, Optional


END: ListMonitoringRegistrationResponse }ListMonitoringRegistrationResponseDetail }MonitoringRegistrationDetail

/Aggregate

END: ListMonitoringRegistrationResponse }ListMonitoringRegistrationResponseDetail

/Aggregate

END: ListMonitoringRegistrationResponse /Aggregate



Response Codes



Samples (Download)




Monitoring Service


Related Topics

UpdateMonitoringRegistration (REST), AddMonitoringRegistration (REST).



ListMonitoringRegistration (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.


Refer to How to Retrieve Monitoring Registrations for an overview of this operation.



Endpoint


Request Parameters



ListMonitoringRegistrationRequest Aggregate

ListMonitoringRegistrationRequest@ServiceVersionNumber Attribute

ListMonitoringRegistrationRequest@xsi:schemaLocation Attribute

ListMonitoringRegistrationRequest. TransactionDetail Aggregate, Optional


ListMonitoringRegistrationRequest. TransactionDetail.ApplicationTransactionID




D&B Direct API Documentation ListMonitoringRegistration (SOAP)



ListMonitoringRegistrationRequest. TransactionDetail.TransactionTimestamp








ListMonitoringRegistrationRequest. TransactionDetail.SubmittingOfficeID






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




END: ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. InquiryDetail

/Aggregate

ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. DUNSNumber



Monitoring.

ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria.PrincipalIdentificationNumberDetail.PrincipalIdentificationNumber

string, Optional


either uniquely identifies or helps to identify an individual.




ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. CountryISOAlpha2Code





inquired subject.

ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. MonitoringProfileID

int, Optional



DUNS.

ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. DNBProductID




ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. MonitoringLevel




event


ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. NotificationProfileID

int, Optional



Alerts.

ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. AutoRenewalIndicator

boolean, Optional




ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationListCriteria. SubjectCategoryText








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



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




ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationDisplaySpecification.CandidatePerPageMaximumQuantity


Records the maximum quantity that can be displayed per

page

ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationDisplaySpecification.CandidateDisplayStartSequenceNumber

int, Optional





END: ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail.MonitoringRegistrationDisplaySpecification

/Aggregate

END: ListMonitoringRegistrationRequest.ListMonitoringRegistrationRequestDetail

/Aggregate

END: ListMonitoringRegistrationRequest /Aggregate

Testing / Sandbox


Data Field Response



ListMonitoringRegistrationResponse Aggregate

ListMonitoringRegistrationResponse@ServiceVersionNumber Attribute

ListMonitoringRegistrationResponse@xsi:schemaLocation Attribute

ListMonitoringRegistrationResponse. TransactionDetail Aggregate, Required



product.

ListMonitoringRegistrationResponse. TransactionDetail.ApplicationTransactionID




ListMonitoringRegistrationResponse. TransactionDetail.ServiceTransactionID







ListMonitoringRegistrationResponse. TransactionDetail.TransactionTimestamp







intermediary.

END: ListMonitoringRegistrationResponse. TransactionDetail /Aggregate

ListMonitoringRegistrationResponse. TransactionResult Aggregate, Required



ListMonitoringRegistrationResponse. TransactionResult.SeverityText




ListMonitoringRegistrationResponse. TransactionResult.ResultID




ListMonitoringRegistrationResponse. TransactionResult.ResultText



ListMonitoringRegistrationResponse. TransactionResult.ResultMessage








ListMonitoringRegistrationResponse. TransactionResult.ResultMessage. ResultDescription




END: ListMonitoringRegistrationResponse. TransactionResult.ResultMessage

/Aggregate

END: ListMonitoringRegistrationResponse. TransactionResult /Aggregate




ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail

Aggregate, Optional

ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.CandidateMatchedQuantity


The number of registrations listed as possible matches

in the result set based on the search criteria in the


ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.CandidateReturnedQuantity


The number of registrations returned in the result set

based on the search criteria in the Customer/User

request.

ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail


Records the details of the registrations returned in the

result set based on the search criteria in the


ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryDetail

Aggregate, Optional

ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryDetail. DUNSNumber




END: ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryDetail

/Aggregate

ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. DUNSNumber



Monitoring.

ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. CountryISOAlpha2Code





inquired subject.




ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. MonitoringProfileID

int, Required



DUNS.

ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. DNBProductID




ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. MonitoringLevel




event


ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. NotificationProfileID

int, Required



Alerts.

ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. AutoRenewalIndicator

boolean, Required




ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. SubjectCategoryText





ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. RegistrationReasonCode





ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. StartDate

date, Required


monitoring.




ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. EndDate

date, Required


has been ended.

ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail.MonitoringRegistrationStatusText

MonitoringRegistartionStatusTextEnum, Required



ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceDetail

Aggregate, Optional




ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceDetail.CustomerReferenceText





ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceDetail.CustomerBillingEndorsementText







process.

END: ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. InquiryReferenceDetail

/Aggregate

ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail. DisplaySequence

int, Optional


END: ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail.MonitoringRegistrationDetail

/Aggregate

END: ListMonitoringRegistrationResponse.ListMonitoringRegistrationResponseDetail

/Aggregate

END: ListMonitoringRegistrationResponse /Aggregate





Response Codes



Samples (Download)


Monitoring Service


Related Topics

UpdateMonitoringRegistration (SOAP), AddMonitoringRegistration (SOAP).



ListChangeNotice (REST)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.





Endpoint

GET https://maxcvservices.dnb.com/V{version}/monitoring/changenotices

Request Parameters



{version} Element











D&B Direct API Documentation ListChangeNotice (REST)








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)


PrincipalIdentificationNumberTypeCode-n Element

PrincipalIdentificationNumber-n string, Optional


either uniquely identifies or helps to identify an individual.

MonitoringProfileID-n (up to 10 times) int, Optional(Up to 10x)



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)



DNBProductID-n (up to 10 times) string up to 64 chars., Optional(Up to 10x)

An alphanumeric string that uniquely identifies this

product.




ReadChangeEventIndicator boolean, Optional

Records the status of the monitoring notification. Possible

values are: Read and unread




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


SortDirectionText-n (up to 4 times) SortDirectionEnum, Optional




Records the maximum quantity that can be displayed per

page



Data Field Response



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


A number assigned by the calling application to uniquely identify this

request.

ListChangeNoticeResponse { TransactionDetail { ServiceTransactionID



transaction.

ListChangeNoticeResponse { TransactionDetail { TransactionTimestamp


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


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

Warning, Error, Fatal.

ListChangeNoticeResponse { TransactionResult { ResultID


An alphanumeric string that uniquely identifies the outcome of the

transaction.

ListChangeNoticeResponse { TransactionResult { ResultText






ListChangeNoticeResponse { TransactionResult { ResultMessage


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


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


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


The number of registrations returned in the result set based on the

search criteria in the Customer/User request.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary


ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { DUNSNumber



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




End: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }NoticeCountSummary

/Aggregate

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail


ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail

Aggregate, Required

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { DUNSNumber



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



End: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } SubjectDetail }PrincipalIdentificationNumberDetail

/Aggregate

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { CountryISOAlpha2Code

Aggregate, Required







ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { OrganizationPrimaryName


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


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


An alphanumeric value identifying the category in which the Customer

has classified the subject.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { LanguageCode




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.




ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { MonitoringProfileDetail{ DNBProductID



ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { MonitoringProfileDetail{ MonitoringLevel


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



ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { ElementName


ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { PCMElementXPATHText


ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element

_, Optional (Infinite)

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element@ChangeType

AttributePossible values: Dropped; NewlyAdded; NoChange; ValueChanged




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


ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeType


ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText


ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText@DNBCodeValue

Attribute

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText@DNBCodeTableNumber

Attribute

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization

Aggregate, Optional




ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization{ AssociationTypeText



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


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




ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { AssociationTypeText@DNBCodeValue

Attribute




ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { AssociationTypeText@DNBCodeTableNumber

Attribute

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { DUNSNumber





END: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } ChangeEvent }LinkageChange }FormerGlobalUltimateOrganization

/Aggregate

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization

Aggregate, Optional

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { AssociationTypeText




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








END: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } ChangeEvent }LinkageChange }UpwardFamilyMemberOrganization

/Aggregate

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization

Aggregate, Optional

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { AssociationTypeText




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





END: ListChangeNoticeResponse }ListChangeNoticeResponseDetail }ChangeNoticeDetail } ChangeEvent }LinkageChange }FormerUpwardFamilyMemberOrganization

/Aggregate

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChildrenSummary



the number of children of various types for the Subject.




ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChildrenSummary { ChildrenQuantity


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


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



Response Codes





Samples (Download)


Monitoring Service




ListChangeNotice (SOAP)This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.





Endpoint


Request Parameters



ListChangeNoticeRequest Aggregate

ListChangeNoticeRequest@ServiceVersionNumber

Attribute

ListChangeNoticeRequest.TransactionDetail

Aggregate, Optional


ListChangeNoticeRequest.TransactionDetail.ApplicationTransactionID


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

ListChangeNoticeRequest.TransactionDetail.TransactionTimestamp


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)



ListChangeNoticeRequest.TransactionDetail. SubmittingOfficeID


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)


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




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


An alphanumeric value identifying the category in which the Customer has

classified the subject.

ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria. DNBProductID



ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.MonitoringLevel




ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.ReadChangeEventIndicator

boolean, Optional

Records the status of the monitoring notification. Possible values are: Read

and unread

ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.ChangeDetectionFromTimestamp



ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria.ChangeDetectionToTimestamp



End: ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeListCriteria

/Aggregate

ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification

Aggregate, Optional




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


ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.SortSpecification. SortDirectionText


Records the direction of sorting. Possbile values are Ascending, Descending

End: ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.SortSpecification

/Aggregate

ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.CandidatePerPageMaximumQuantity



ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification.CandidateDisplayStartSequenceNumber

int, Optional


End: ListChangeNoticeRequest.ListChangeNoticeRequestDetail.ChangeNoticeDisplaySpecification

/Aggregate

End: ListChangeNoticeRequest.ListChangeNoticeRequestDetail

/Aggregate

End: ListChangeNoticeRequest /Aggregate

Data Field Response





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


A number assigned by the calling application to uniquely identify this

request.

ListChangeNoticeResponse.TransactionDetail. ServiceTransactionID



transaction.

ListChangeNoticeResponse.TransactionDetail. TransactionTimestamp


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


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

Warning, Error, Fatal.

ListChangeNoticeResponse.TransactionResult. ResultID



transaction.

ListChangeNoticeResponse.TransactionResult. ResultText






ListChangeNoticeResponse.TransactionResult. ResultMessage



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


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


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


The number of registrations returned in the result set based on the

search criteria in the Customer/User request.

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.NoticeCountSummary


ListChangeNoticeResponse.ListChangeNoticeResponseDetail.NoticeCountSummary. DUNSNumber



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




End: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.NoticeCountSummary

/Aggregate

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail


ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail

Aggregate, Required

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.DUNSNumber



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



End: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.PrincipalIdentificationNumberDetail

/Aggregate

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.CountryISOAlpha2Code

Aggregate, Required







ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.OrganizationPrimaryName



a single name by which the organization is primarily known / identified

in different languages and/or writing scripts.

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. SubjectDetail.OrganizationPrimaryName.OrganizationName


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


An alphanumeric value identifying the category in which the Customer

has classified the subject.

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. LanguageCode




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.




ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. MonitoringProfileDetail.DNBProductID



ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. MonitoringProfileDetail.MonitoringLevel




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



ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.ElementName


ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.PCMElementXPATHText


ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent. Element

_, Optional (Infinite)

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent. Element@ChangeType

AttributePossible values: Dropped; NewlyAdded; NoChange; ValueChanged




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


ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. ChangeType


ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. ChangeReasonText


ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.ChangeReasonText@DNBCodeValue

Attribute

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.ChangeReasonText@DNBCodeTableNumber

Attribute

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. GlobalUltimateOrganization

Aggregate, Optional




ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. GlobalUltimateOrganization.AssociationTypeText




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





END: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. GlobalUltimateOrganization

/Aggregate

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization

Aggregate, Optional

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization.AssociationTypeText




ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization.AssociationTypeText@DNBCodeValue

Attribute




ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization.AssociationTypeText@DNBCodeTableNumber

Attribute

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization.DUNSNumber





END: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerGlobalUltimateOrganization

/Aggregate

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.UpwardFamilyMemberOrganization

Aggregate, Optional

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.UpwardFamilyMemberOrganization.AssociationTypeText




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








END: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.UpwardFamilyMemberOrganization

/Aggregate

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerUpwardFamilyMemberOrganization

Aggregate, Optional

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerUpwardFamilyMemberOrganization.AssociationTypeText




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





END: ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange.FormerUpwardFamilyMemberOrganization

/Aggregate

ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. ChildrenSummary



the number of children of various types for the Subject.




ListChangeNoticeResponse.ListChangeNoticeResponseDetail.ChangeNoticeDetail. ChangeEvent.LinkageChange. ChildrenSummary.ChildrenQuantity


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


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



Response Codes





Samples (Download)


Monitoring Service




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.




Endpoint

GET https://maxcvservices.dnb.com/V{version}/monitoring/organizations/{DUNS}/products/{productID}

Request Parameters



{version} Element




D&B Direct API Documentation GetMonitoringProduct (REST)





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.


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



{productID} string up to 64 chars., Required



Data Field Response

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.


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



GetMonitoringProductResponse { TransactionDetail { ServiceTransactionID


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

GetMonitoringProductResponse { TransactionDetail { TransactionTimestamp


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


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


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

Error, Fatal.

GetMonitoringProductResponse { TransactionResult { ResultID



transaction.

GetMonitoringProductResponse { TransactionResult { ResultText



GetMonitoringProductResponse { TransactionResult { ResultMessage



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


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


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

Monitoring.

GetMonitoringProductResponse { GetMonitoringProductResponseDetail{ InquiryDetail { DNBProductID


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


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


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


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


GetMonitoringProductResponse { GetMonitoringProductResponseDetail{ Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName@WritingScriptISOAlpha4Code

Attribute

GetMonitoringProductResponse { GetMonitoringProductResponseDetail{ Product { Organization { OrganizationName { OrganizationPrimaryName { OrganizationName @LanguageCode

Attribute

End: GetMonitoringProductResponse}GetMonitoringProductResponseDetail} Product } Organization }OrganizationName }OrganizationPrimaryName

/Aggregate

End: GetMonitoringProductResponse}GetMonitoringProductResponseDetail} Product } Organization

/Aggregate




GetMonitoringProductResponse { GetMonitoringProductResponseDetail{ Product { ObjectAttachment

Aggregate, Required

GetMonitoringProductResponse { GetMonitoringProductResponseDetail{ Product { ObjectAttachment { ContentObject


GetMonitoringProductResponse { GetMonitoringProductResponseDetail{ Product { ObjectAttachment { ObjectFormatCode



End: GetMonitoringProductResponse}GetMonitoringProductResponseDetail} Product } ObjectAttachment

/Aggregate

End: GetMonitoringProductResponse}GetMonitoringProductResponseDetail} Product

/Aggregate

End: GetMonitoringProductResponse}GetMonitoringProductResponseDetail

/Aggregate

End: GetMonitoringProductResponse /Aggregate




Response Codes


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




CM001 Invalid Language code provided

CM007 No Level2 notices available for the given criteria


Samples (Download)


Monitoring Service


Related Topics

ListChangeNotice (REST)



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.




Endpoint


Request Parameters



GetMonitoringProductRequest Aggregate

GetMonitoringProductRequest@ServiceVersionNumber

Attribute

GetMonitoringProductRequest.TransactionDetail

Aggregate, Optional


GetMonitoringProductRequest.TransactionDetail.ApplicationTransactionID



D&B Direct API Documentation GetMonitoringProduct (SOAP)



GetMonitoringProductRequest.TransactionDetail.TransactionTimestamp


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


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



Monitoring.

GetMonitoringProductRequest.GetMonitoringProductRequestDetail.InquiryDetail. DNBProductID



End: GetMonitoringProductRequest.GetMonitoringProductRequestDetail.InquiryDetail

/Aggregate

End: GetMonitoringProductRequest.GetMonitoringProductRequestDetail

/Aggregate

End: GetMonitoringProductRequest /Aggregate

Data Field Response

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.




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



GetMonitoringProductResponse.TransactionDetail.ServiceTransactionID


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

GetMonitoringProductResponse.TransactionDetail.TransactionTimestamp


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


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


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

Error, Fatal.

GetMonitoringProductResponse.TransactionResult. ResultID



transaction.

GetMonitoringProductResponse.TransactionResult. ResultText






GetMonitoringProductResponse.TransactionResult. ResultMessage



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


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



Monitoring.

GetMonitoringProductResponse.GetMonitoringProductResponseDetail.InquiryDetail. DNBProductID



End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail.InquiryDetail

/Aggregate

GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product

Aggregate, Required

GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. LanguageCode


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


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


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


GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. Organization.OrganizationName.OrganizationPrimaryName.OrganizationName@WritingScriptISOAlpha4Code

Attribute

GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. Organization.OrganizationName.OrganizationPrimaryName.OrganizationName @LanguageCode

Attribute




End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. Organization.OrganizationName.OrganizationPrimaryName

/Aggregate

End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. Organization

/Aggregate

GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. ObjectAttachment

Aggregate, Required

GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. ObjectAttachment.ContentObject


GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. ObjectAttachment.ObjectFormatCode



End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product. ObjectAttachment

/Aggregate

End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail.Product

/Aggregate

End: GetMonitoringProductResponse.GetMonitoringProductResponseDetail

/Aggregate

End: GetMonitoringProductResponse /Aggregate






Response Codes


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


CM001 Invalid Language code provided

CM007 No Level2 notices available for the given criteria


Samples (Download)


Monitoring Service


Related Topics

ListChangeNotice (SOAP)



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>



D&B Direct API Documentation Authentication Process


http://dnbus.force.com/support?prod=DNBDirect

</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


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: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minorvariations.

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 GMT



Authorization: <MyToken>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."}

}}



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


http://developer.dnb.com/register-v2

http://dnbus.force.com/support?prod=DNBDirect

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


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


http://www.iso.org/iso/country_codes/country_codes

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


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

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

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




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.



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.

Static Responses

Some operations currently return a static set of results, regardless of the request parameters, in the testenvironment.

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 Viability Rating 804735132 (US); 362241452 (US)

D&B Direct API Documentation Sandbox Access


Contact Product Service

Product Test D-U-N-S Number(s) Test Principal Identification Number(s)

People - Standard 220646736 (GB) 2206467361

People - Enhanced 884114609 (GB) 1073021000000000

Financial Product Service


Financial Highlights 001368083 (CA)

Financial Statements 804735132 (US); 362528379 (US); 247933872 (CA); 214567885 (GB); 754683795 (AU)

Firmographic Product Service


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


Corporate Linkage 754683795 (AU); 970814638 (AR); 302150912 (AT); 811761659 (MX); 804735132 (US)

Company Reports

Country Reports

SBRI Product Service


Small Business Risk Insight n/a

D&B Direct API Documentation Contact Product Service


Trade Detail Product Service


Payment Information - Detail 804735132 (US)

Payment Information & Paydex (Rating) - Detail 804735132 (US); 362528379 (US); 247933872 (CA); 214567885 (GB)

D&B Direct API Documentation Trade Detail Product Service


BadgerFish (REST)BadgerFish is a convention for translating an XML document into a JSON object. D&B Direct JSON responsesfollow this convention with a few minor variations. 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 BadgerFish (REST)



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



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


d&b direct 2.0 monitoring service events ......

Documents