Update Notification Profile
| Product | D&B Direct 2.0 |
| Product Code(s) | Not Applicable |
| Options(s) | None |
| Monitoring Available | No |
| Interface | REST |
| Method | PUT |
| Format(s) | JSON |
| Service | Monitoring |
| {version} | 6.0 |
| 6.0 Released on | March 11, 2015 |
This function allows a customer to update or cancel an active notification profile.
Update History
- January 29, 2016 (v5.0 SOAP & REST): PUSH notifications now include CustomerReferenceText for List Change Notice.
- January 8, 2016 (v5.0 SOAP & REST): The input parameter CompressedProductIndicator is added to CreateNotificationProfileRequest and UpdateNotificationProfileRequest. AttachCompressedProductIndicator is added to GetMonitoringProduct Request.
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
Notification Profiles can be removed by setting the status to "Cancelled"; however, if the profile is referenced in a Monitoring Registration it may not be removed.
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/V5.0/monitoring/notificationprofiles/704 HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
Authorization: 7mfvIIe3O/zJlw+ucXHss8VzsGamaIOjO8C5bZ0MEqFqenc5rAEjCV9qp6DztNDTUMHzE3FapqzZUbMPHCAry0cnueyCM8AV8XPoDI5qQAJhRcRH00EVGywLb4Q/21kstTK8iKBNZAWtSD09RKpk1mtrkqcmc0/Ekk3o8h2h1vPtrY4/bj1yumhTaDBuiu3sFcEZP3NBKqW+7wDMMPauwtYsSZpXqvyor/1WtKCFGHC2kmBqatIT71Mr+W+HxS8pofQYZb/nYwUwInGGJ56krHOWLqBiuACFC3Pdx7dRAU55y1ufjZVKbeg5nPqgmGBOuQfKWnwcmqWtQ3lL++4OAA==
Content-Length: 471
Host: direct.dnb.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
{
"mon:UpdateNotificationProfileRequest": {
"@xmlns$mon": "http://services.dnb.com/MonitoringServiceV2.0",
"TransactionDetail": {
"ApplicationTransactionID": "Update_ID_001",
},
"UpdateNotificationProfileRequestDetail": {
"NotificationProfileDetail": {
"DeliveryFrequency": "Weekly"
"CompressedProductIndicator": "true"
},
"InquiryReferenceText": {
"CustomerReferenceText": [
"704: Change Frequency to Weekly"
]
}
}
}
}
| Name | Characteristics |
|---|---|
| {NotificationProfileID} | int, Required A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS. |
| Name | Characteristics |
|---|---|
| UpdateNotificationProfileRequest | Aggregate |
| UpdateNotificationProfileRequest@ServiceVersionNumber | Attribute |
| UpdateNotificationProfileRequest@xsi:schemaLocation | Attribute |
| UpdateNotificationProfileRequest { TransactionDetail | Aggregate, Optional Records information necessary to process this request. |
| UpdateNotificationProfileRequest { TransactionDetail { ApplicationTransactionID | string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. |
| UpdateNotificationProfileRequest { TransactionDetail { TransactionTimestamp | DateTimestamp, Optional The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. |
| UpdateNotificationProfileRequest { TransactionDetail { SubmittingOfficeID | string up to 64 chars., Optional A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated. |
| END: UpdateNotificationProfileRequest } TransactionDetail | /Aggregate |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail | Aggregate, Required |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail | Aggregate, Required |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { NotificationProfileName | string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional A name that is provided by the user to the profile. |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryChannelUserPreferenceName | string up to 64 chars., Optional |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryMode | DeliveryModeEnum, Optional Possible values: Email; HTTPCallBack; MQOutput |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryFrequency | DeliveryFrequencyEnum, Optional Possible values: Immediate; Hourly; Daily; Weekly |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { DeliveryFormat | DeliveryFormatEnum, Optional Possible values: XML, JSON; JSON |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { NotificationProfileStatusText | NotificationProfileStatusTextEnum, Optional Records the status of the monitoring registration Possible values: Active; Cancelled |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { StopDeliveryIndicator | boolean, Optional |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { InquiryReferenceText | Aggregate |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { InquiryReferenceText { CustomerReferenceText | Element |
| UpdateNotificationProfileRequest { UpdateNotificationProfileRequestDetail { NotificationProfileDetail { CompressedProductIndicator. | boolean, Optional When set to TRUE this denotes that the customer has requested that D&B return the compressed product in Level 2 change notice. When set to FALSE this denotes that the customer has not requested that D&B return the compressed product in Level 2 change notice. |
| END: UpdateNotificationProfileRequest } UpdateNotificationProfileRequestDetail } NotificationProfileDetail } InquiryReferenceText | /Aggregate |
| END: UpdateNotificationProfileRequest } UpdateNotificationProfileRequestDetail } NotificationProfileDetail | /Aggregate |
| END: UpdateNotificationProfileRequest } UpdateNotificationProfileRequestDetail | /Aggregate |
| END: UpdateNotificationProfileRequest | /Aggregate |
Deleting a Profile
To remove a profile, change the status to "Cancelled" through an update request. Canceled items can be restored within 24-hours of the update, after which they are deleted by the system.
"NotificationProfileDetail": {
"NotificationProfileStatusText": "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/notificationprofiles/{NotificationProfileID} |
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.
{"UpdateNotificationProfileResponse": {
"@ServiceVersionNumber": "5.0",
"TransactionDetail": {
"ApplicationTransactionID": "Update_ID_001",
"ServiceTransactionID": "Monitoring Service",
"TransactionTimestamp": "2013-09-26T15:16:57.138-04:00"
},
"TransactionResult": {
"SeverityText": "Information",
"ResultID": "CM000",
"ResultText": "Success"
},
"UpdateNotificationProfileResponseDetail": {
"NotificationProfileDetail": {
"NotificationProfileID": 704,
"NotificationProfileName": "Notification_Profile_Email_01",
"DeliveryFrequency": "Weekly",
"FormerNotificationProfileDetail": {"DeliveryFrequency": "Immediate"}
},
"InquiryReferenceText": {"CustomerReferenceText": ["704: Change Frequency to Weekly"]}
}
}}
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, CM007, MN002, MN005, 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 | Blank Notification profile name |
| 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 | Delivery Channel User Preference Name is invalid; Notification profile cannot be canceled as registrations are available for this profile; or Notification profile not available in the system. |
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.