Update Monitoring Registration
| Product | D&B Direct 2.0, D&B Direct Onboard |
| Product Code(s) | Not Applicable |
| Options(s) | None |
| Monitoring Available | No |
| Interface | REST |
| Method | PUT |
| Format(s) | JSON |
| Service | Monitoring |
| {version} | 7.0 |
| 7.0 Released on | December 9, 2016 |
This function allows a customer to update or cancel an active monitoring registration.
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.
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
Caution: This operation will update multiple registrations based on the input parameters provided. For example, if a D-U-N-S Number is not provided, all registrations with matching Monitoring and Notification Profile IDs will be affected by the change requested. If no input criteria provided, all registrations will be affected.
Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST follow the order presented in this section. This applies to REST calls only.
Restriction: An XML namespace statement MUST be included as the first statement within the primary Aggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.
PUT https://direct.dnb.com/V7.0/monitoring/registrations
Content-Type: application/json
Authorization: <MyToken>
{
"mon:UpdateMonitoringRegistrationRequest": {
"@xmlns$mon": "http://services.dnb.com/MonitoringServiceV2.0",
"TransactionDetail": {
"ApplicationTransactionID": "UPDATE_REGISTRATION",
"TransactionTimestamp": "2016-12-16T05:52:07.753Z"
},
"UpdateMonitoringRegistrationRequestDetail": {
"MonitoringRegistrationDetail": {
"DUNSNumber": "804735132",
"MonitoringProfileID": "8932",
"NotificationProfileID": "4336"
},
"MonitoringRegistrationUpdateSpecification": {
"MonitoringRegistrationStatusText": "Active"
},
"InquiryReferenceText": {
"CustomerReferenceText": [
"UPDATE_REGISTRATION"
]
}
}
}
}
| Name | Characteristics |
|---|---|
| UpdateMonitoringRegistrationRequest | Aggregate |
| UpdateMonitoringRegistrationRequest@xsi:schemaLocation | Attribute |
| UpdateMonitoringRegistrationRequest { TransactionDetail | Aggregate, Optional Records information necessary to process this request. |
| UpdateMonitoringRegistrationRequest { TransactionDetail { ApplicationTransactionID | string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. |
| UpdateMonitoringRegistrationRequest { TransactionDetail { TransactionTimestamp | DateTimestamp, Optional The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. |
| END: UpdateMonitoringRegistrationRequest } TransactionDetail | /Aggregate |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail | Aggregate, Required Records the details of request to update existing monitoring registration(s) |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail | Aggregate, Optional Records the details of the existing registrations |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail { DUNSNumber | string up to 9 chars. Pattern: {([0-9]*)}., Optional Records the duns number that is provided by the customer to register for Monitoring. |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { InquiryDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber | Element |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail { MonitoringProfileID | int, Optional A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS. |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail { NotificationProfileID | int, Optional A number that uniquely identifies the delivery preferences that the customer has set for Monitoring Alerts. |
| END: UpdateMonitoringRegistrationRequest } UpdateMonitoringRegistrationRequestDetail } MonitoringRegistrationDetail | /Aggregate |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification | Aggregate, Required Records the specification of the registrations update |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { NotificationProfileID | int, Optional The number that uniquely identifies the new delivery preferences that the customer has set for Monitoring Alerts. |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { AutoRenewalIndicator | boolean, Optional When true (set to 1), it means that this registration is set for Auto Renewal. When false (set to 0), it means that this registration is not set for Autorenewal. |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { SubjectCategoryText | string up to 32 chars., Optional An alphanumeric value identifying the category in which the Customer has classified the subject. Possible values: High; Medium; Low |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { MonitoringRegistrationStatusText | MonitoringRegistrationStatusEnum, Optional Records the status of the monitoring registration Possible values: Active; Cancelled; Pending; Expired; RegistrationFailed:StopDistribution, RegistrationFailed:TooOldData, RegistrationFailed:ProductAvailabilityFailure, RegistrationFailed |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { InquiryReferenceText | Aggregate |
| UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { InquiryReferenceText { CustomerReferenceText | Element |
| END: UpdateMonitoringRegistrationRequest } UpdateMonitoringRegistrationRequestDetail } MonitoringRegistrationUpdateSpecification } InquiryReferenceText | /Aggregate |
| END: UpdateMonitoringRegistrationRequest } UpdateMonitoringRegistrationRequestDetail } MonitoringRegistrationUpdateSpecification | /Aggregate |
| END: UpdateMonitoringRegistrationRequest } UpdateMonitoringRegistrationRequestDetail | /Aggregate |
| END: UpdateMonitoringRegistrationRequest | /Aggregate |
Deleting a Registration
To remove a registration, a customer may change the status to Cancelled immediately, from either a Pending or Active registration status, through an update request. Cancelled items can be restored within 24-hours of the update, after which they are deleted by the system.
"MonitoringRegistrationUpdateSpecification": {
"MonitoringRegistrationStatusText": "Cancelled"
},
Endpoint
Use the following endpoint for requesting this feature. The {version} is dependent on the underlying service delivering the response.
| Endpoint (Monitoring) |
|---|
| PUT 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.
In cases where multiple registrations were affected by the update, only the UpdatedRegistrationCount will be returned.
NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.
{"UpdateMonitoringRegistrationResponse": {
"TransactionDetail": {
"ApplicationTransactionID": "UPDATE_REGISTRATION",
"ServiceTransactionID": "Id-74815358a37c1700dcf7040054b70215-1",
"TransactionTimestamp": "2016-12-16T05:52:07.753Z"
},
"TransactionResult": {
"SeverityText": "Information",
"ResultID": "CM000",
"ResultText": "Success"
},
"UpdateMonitoringRegistrationResponseDetail": {
"UpdatedRegistrationCount": 1,
"MonitoringRegistrationDetail": [ {
"DUNSNumber": "804735132",
"MonitoringProfileID": 8932,
"NotificationProfileID": 4336,
"SubjectCategoryText": "Medium",
"AutoRenewalIndicator": true,
"MonitoringRegistrationStatusText": "Active",
"FormerMonitoringRegistrationDetail": {"MonitoringRegistrationStatusText": "Cancelled"}
}],
"InquiryReferenceText": {"CustomerReferenceText": ["UPDATE_REGISTRATION"]}
}
}}
Response Codes & Error Handling
Successful service requests will return a CM000 response code in the TransactionResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.
This operation may return the following response codes: CM001, CM002, CM004, CM011, CM012, CM018, CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.
D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.
While this operation is provided on a metered basis, usage is tracked; however, no billing for successful calls is recorded.
Operation-specific supplemental response code explanations:
| CM001 | Invalid Monitoring Profile ID; or Invalid Notification Profile ID. |
| CM002 | Any schema validation failure (e.g. elements that are mandatory in the schema are not present in the request, Sequence of the element is not matching in the schema, Data type mismatch or Invalid notification Level). |
| CM009 | Missing reason code |
| CM012 | Invalid subject- Duns number |
| CM023 | Duplicate Registration |
| PD003 | DUNS stop distribution |
| PD005 | Requested Product not available |
| PD016 | DUNS transferred |
| PD017 | DUNS out of business |
Feature Notes
Active registrations, those with the AutoRenewalIndicator set to 'true' and not subsequently updated to 'cancelled', will be re-registered at the time of contract renewal by extending the registration EndDate to the last day of the contract year.
If the contract renewal occurs after the previous contract expires, the registrations will NOT be auto-renewed.
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.