List Monitoring Registration
| Product | D&B Direct 2.0 |
| Product Code(s) | Not Applicable |
| Options(s) | None |
| Monitoring Available | No |
| Interface | REST |
| Method | GET |
| Format(s) | JSON |
| Service | Monitoring |
| {version} | 4.1 |
| 4.1 Released on | December 12, 2014 |
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 November 09, 2020.
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
GET https://direct.dnb.com/V4.1/monitoring/registrations?RegisteredFromDate=2013-01-01&RegisteredToDate=2013-12-31&DNBProductID=PBPR_STD&AutoRenewalIndicator=false&SubjectCategoryText=High Authorization: <MyToken>
| Name | Characteristics |
|---|---|
| {version} | Element |
| ApplicationTransactionID | string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. |
| TransactionTimestamp | DateTimestamp, Optional The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. |
| SubmittingOfficeID | string up to 64 chars., Optional A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated. |
| InquiryDUNSNumber | string up to 9 chars. Pattern: {([0-9]*)}., Required Records the duns number that is provided by the customer to register for Monitoring. |
| DUNSNumber | string up to 9 chars. Pattern: {([0-9]*)}., Optional Records the duns number that is registered for Monitoring. |
| CountryISOAlpha2Code | string at least 2 chars. up to 2 chars., Optional The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject. |
| MonitoringProfileID | int, Optional A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS. |
| DNBProductID | string up to 64 chars., Optional Records the product code that is provided by the customer to create a profile |
| MonitoringLevel | MonitoringLevelTextEnum up to 16 chars., Optional A alphanumeric string which determines the level of details that the customer will receive during a change event Possible values: Level1; Level2 |
| 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.
{"ListMonitoringRegistrationResponse": {
"@ServiceVersionNumber": "4.0",
"TransactionDetail": {
"ServiceTransactionID": "Id-1e199e195244892508eb1441-1",
"TransactionTimestamp": "2013-09-26T15:21:09-04:00"
},
"TransactionResult": {
"SeverityText": "Information",
"ResultID": "CM000",
"ResultText": "Success"
},
"ListMonitoringRegistrationResponseDetail": {
"CandidateMatchedQuantity": 2,
"CandidateReturnedQuantity": 2,
"MonitoringRegistrationDetail": [
{
"DUNSNumber": "016144166",
"CountryISOAlpha2Code": "US ",
"MonitoringProfileID": 272,
"DNBProductID": "PBPR_STD",
"MonitoringLevel": "Level1",
"NotificationProfileID": 704,
"AutoRenewalIndicator": false,
"SubjectCategoryText": "high",
"StartDate": {"$": "2013-09-26"},
"EndDate": {"$": "2014-06-05"},
"MonitoringRegistrationStatusText": "Pending",
"InquiryReferenceDetail": {
"CustomerReferenceText": ["16144166_Monitoring_Sept2013"],
"CustomerBillingEndorsementText": "16144166_Monitoring"
},
"DisplaySequence": 1
},
{
"InquiryDetail": {"DUNSNumber": "243255630"},
"DUNSNumber": "241015486",
"CountryISOAlpha2Code": "CA ",
"MonitoringProfileID": 44,
"DNBProductID": "PBPR_STD",
"MonitoringLevel": "Level1",
"NotificationProfileID": 322,
"AutoRenewalIndicator": false,
"SubjectCategoryText": "high",
"StartDate": {"$": "2013-08-03"},
"EndDate": {"$": "2014-06-05"},
"MonitoringRegistrationStatusText": "Active",
"InquiryReferenceDetail": {
"CustomerReferenceText": [
"ADD",
"DUNS",
"Registration",
"verification",
"Day 1"
],
"CustomerBillingEndorsementText": "EndorsementText"
},
"DisplaySequence": 2
}
]
}
}}
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 AddMonitoringRegistration request, the expiration date will be reset whenever the contract is renewed.
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.