Loading

Direct 2.0
Collapse

List Monitoring Registration

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

This function allows a customer to review active monitoring registrations.

Update History

No modifications have been made to this data layer since the initial release.

What to do First

Feature Request

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

Overview

There are several options available when implementing this (Undefined variable: DnB API Globals.API Name) feature.

1. D-U-N-S Number: Results can be filtered by the D-U-N-S Number supplied at registration OR the registered D-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) of Monitoring or Notification Profiles..

3. List by Product: Monitoring is performed at the product level, and a product ID is specified when a Monitoring 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 a copy 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 annual contract 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 field may 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 compared against the date of registration.

8. Status Filter: Registrations that are assigned a status of "Cancelled" remain in the Monitoring system for 24 hours before being deleted. The results may be limited to a specific status.

9. Customer Reference Text: When a registration is created, a free form (240 character) field may be supplied. This field may be used in the List operation; however, it is case-sensitive and there are no wildcard options.

10. Sorting Results: By default, the results will be ascending by ???. Optionally, both the sort direction and a primary sort field can be designated on the request.

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

11. Pagination: Options exist to designate the maximum number of records per request, and the starting row number. The maximum number of records this feature will return on a single request is 1,000.

Data Layer Entitlement

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

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

Specification

Sample Request (List)
GET https://direct.dnb.com/V8.0/monitoring/registrations?ServiceVersionNumber=3.2&ApplicationTransactionID=ListMonitoringRegistration&DNBProductID=DCP_STD&MonitoringLevel=Level2&SortBasisText=MonitoringLevel&SortDirectionText=Ascending&CandidatePerPageMaximumQuantity=10&CandidateDisplayStartSequenceNumber=1
Authorization: <Token>
Name Characteristics
{version} Element
ApplicationTransactionID string up to 64 chars., Optional

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

TransactionTimestamp DateTimestamp, Optional

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

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

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

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

Records the duns number that is registered for Monitoring.

CountryISOAlpha2Code string at least 2 chars. up to 2 chars., Optional

The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject.

MonitoringProfileID int, Optional

A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

DNBProductID string up to 64 chars., Optional

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

ServiceVersionNumber string up to 10 chars., Optional

A number that identifies the version of the Service.

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

NotificationProfileID int, Optional

A number that uniquely identifies the delivery preferences that the customer has set for Monitoring Alerts.

AutoRenewalIndicator boolean, Optional

When true (set to 1), it means that this registration is set for Auto Renewal. When false (set to 0), it means that this registration is not set for Autorenewal.

SubjectCategoryText string up to 32 chars., Optional

An alphanumeric value identifying the category in which the Customer has classified the subject.

Possible values: High; Medium; Low

RegisteredFromDate date, Optional

Records the start date of the date range to list the registrations.

RegisteredToDate date, Optional

Records the end date of the date range to list the registrations.

MonitoringRegistrationStatusText MonitoringRegistartionStatusTextEnum, Optional

Records the status of the monitoring registration

Possible values: Active; Cancelled; Pending; Expired, RegistrationFailed:StopDistribution, RegistrationFailed:TooOldData, RegistrationFailed:ProductAvailabilityFailure, RegistrationFailed

SortBasisText MonitoringSortBasisEnum, Optional

Records the list of fields based on which sorting is possible

Possible values: DUNSNumber; CountryISOAlpha2Code; MonitoringProfileID; DNBProductID; MonitoringLevel; NotificationProfileID; RegistrationStartDate; SubjectCategoryText; AutoRenewalIndicator; MonitoringRegistartionStatusText

SortDirectionText SortDirectionEnum, Optional

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

CandidatePerPageMaximumQuantity int Less than or equal to 1000., Optional

Records the maximum quantity that can be displayed per page

CandidateDisplayStartSequenceNumber int, Optional

Records the Display sequence number of the results

Endpoint

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

Endpoint (Monitoring)
GET https://direct.dnb.com/V{version}/monitoring/registrations

Testing

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

Feature Response

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

Specification

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

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

Sample Response (List)
{"ListMonitoringRegistrationResponse": {
   "TransactionDetail":    {
      "ApplicationTransactionID": "ListMonitoringRegistration",
      "ServiceTransactionID": "Id-33a57c58c8b401004466050030699be8-1",
      "TransactionTimestamp": "2017-01-16T07:07:45.523Z"
   },
   "TransactionResult":    {
      "SeverityText": "Information",
      "ResultID": "CM000",
      "ResultText": "Success"
   },
   "ListMonitoringRegistrationResponseDetail":    {
      "CandidateMatchedQuantity": 1,
      "CandidateReturnedQuantity": 1,
      "MonitoringRegistrationDetail": [      {
         "DUNSNumber": "804735132",
         "CountryISOAlpha2Code": "US",
         "MonitoringProfileID": 13474,
         "DNBProductID": "DCP_STD",
         "ServiceVersionNumber": "3.2",
         "MonitoringLevel": "Level2",
         "NotificationProfileID": 5180,
         "AutoRenewalIndicator": true,
         "SubjectCategoryText": "Medium",
         "StartDate": {"$": "2017-01-13"},
         "EndDate": {"$": "2017-09-12"},
         "MonitoringRegistrationStatusText": "Active",
         "InquiryReferenceDetail":          {
            "CustomerReferenceText": ["STG_ADDVERMON_UAT"],
            "CustomerBillingEndorsementText": "STG_ADDVERMON_UAT"
         },
         "DisplaySequence": 1
      }]
   }
}}
Name Characteristics
ListMonitoringRegistrationResponse Aggregate
ListMonitoringRegistrationResponse@xsi:schemaLocation Attribute
ListMonitoringRegistrationResponse { TransactionDetail Aggregate, Required

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

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

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

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

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

ListMonitoringRegistrationResponse { TransactionDetail { TransactionTimestamp DateTimestamp, Required

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

END: ListMonitoringRegistrationResponse } TransactionDetail /Aggregate
ListMonitoringRegistrationResponse { TransactionResult Aggregate, Required

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

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

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

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

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

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

Text that explains the outcome of the transaction.

ListMonitoringRegistrationResponse { TransactionResult { ResultMessage Aggregate, Optional (Array)

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

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

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

END: ListMonitoringRegistrationResponse } TransactionResult } ResultMessage /Aggregate
END: ListMonitoringRegistrationResponse } TransactionResult /Aggregate
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail Aggregate, Optional
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { CandidateMatchedQuantity int up to 6 digits., Required

The number of registrations listed as possible matches in the result set based on the search criteria in the Customer/User request.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { CandidateReturnedQuantity int up to 6 digits., Required

The number of registrations returned in the result set based on the search criteria in the Customer/User request.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail Aggregate, Optional (Array)

Records the details of the registrations returned in the result set based on the search criteria in the Customer/User request.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryDetail Aggregate, Optional
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryDetail { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

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

END: ListMonitoringRegistrationResponse } ListMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail } InquiryDetail /Aggregate
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the duns number that is registered for Monitoring.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber string, Optional

A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { CountryISOAlpha2Code string at least 2 chars. up to 2 chars., Required

The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringProfileID int, Required

A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DNBProductID string up to 64 chars., Required

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

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { ServiceVersionNumber string up to 10 chars., Optional

A number that identifies the version of the Service.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringLevel MonitoringLevelTextEnum up to 16 chars., Required

A alphanumeric string which determines the level of details that the customer will receive during a change event

Possible values: Level1; Level2

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { NotificationProfileID int, Required

A number that uniquely identifies the delivery preferences that the customer has set for Monitoring Alerts.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { AutoRenewalIndicator boolean, Required

When true (set to 1), it means that this registration is set for Auto Renewal. When false (set to 0), it means that this registration is not set for Autorenewal.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { SubjectCategoryText string up to 32 chars., Optional

An alphanumeric value identifying the category in which the Customer has classified the subject.

Possible values: High; Medium; Low

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { RegistrationReasonCode integer up to 7 digits., Optional

Code identifying the reason for the Customer showing interest to monitor this subject. This reason needs to be captured to comply with German Data Protection Laws.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { StartDate date, Required

The date when the subject has been registered for monitoring.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { EndDate date, Required

The date when the subject registration for monitoring has been ended.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringRegistrationStatusText MonitoringRegistartionStatusTextEnum, Required

Records the status of the monitoring registration

Possible values: Active; Cancelled; Expired, RegistrationFailed:StopDistribution, RegistrationFailed:TooOldData, RegistrationFailed:ProductAvailabilityFailure, RegistrationFailed

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail Aggregate, Optional

Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail { CustomerReferenceText string up to 240 chars., Optional(Up to 5x)

A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail { CustomerBillingEndorsementText string at least 1 chars. up to 240 chars., Optional

Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided.This text is a reference used during the billing process.

END: ListMonitoringRegistrationResponse } ListMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail } InquiryReferenceDetail /Aggregate
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DisplaySequence int, Optional

Records the display sequence number of the results.

END: ListMonitoringRegistrationResponse } ListMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail /Aggregate
END: ListMonitoringRegistrationResponse } ListMonitoringRegistrationResponseDetail /Aggregate
END: ListMonitoringRegistrationResponse /Aggregate

Response Codes & Error Handling

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

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

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

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

Feature Notes

Returns the Monitoring Registration that match the criteria submitted with the request. If no criteria is specified, all active registrations will be returned. For each matching item, this feature will return the Monitoring Registration along with the date it was registered, the status and the date when the monitoring will expire.

If the auto-renewal option was selected on the Add Monitoring Registration request, the expiration date will be extended whenever the contract is renewed.

Registrations for customers with multi-year contracts will be extended each year for the duration of the contract only if the AutoRenewalIndicator is set to 'true'. For example, a customer with a five-year contract (e.g., 2015-2020) will see initially that their registrations have an EndDate of 2016. On each subsequent anniversary, the EndDate will be extended another year.