Create Notification Profile

This function allows a customer to specify a user preference and the frequency for testing monitoring profile conditions.

A Notification Profile establishes the protocol by which change events should be delivered to customers, and references user preferences setup in the User Service. This is the PUSH component of the Data Field Monitoring feature.

What to do First

• Create User Preference

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

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.

POST https://direct.dnb.com/V4.2/monitoring/notificationprofiles
Content-Type: application/json
Authorization: <MyToken>

{
  "mon:CreateNotificationProfileRequest": {
    "@xmlns$mon": "http://services.dnb.com/MonitoringServiceV2.0",
    "TransactionDetail": {
      "ApplicationTransactionID": "ID_001"
    },
    "CreateNotificationProfileRequestDetail": {
      "NotificationProfileSpecification": {
        "NotificationProfileName": "Notification_Profile_Email_01",
        "NotificationProfileDescription": "Email Notofication Proile",
        "DeliveryMode": "Email",
        "DeliveryChannelUserPreferenceName": "John-updatedemail",
        "DeliveryFrequency": "Immediate",
        "DeliveryFormat": "XML",
        "StopDeliveryIndicator": "false"
      },
      "InquiryReferenceText": { "CustomerReferenceText": "Notification_Profile_Email_01" }
    }
  }
}

Endpoint

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

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.

{"CreateNotificationProfileResponse": {
   "@ServiceVersionNumber": "4.0",
   "TransactionDetail":    {
      "ApplicationTransactionID": "ID_001",
      "ServiceTransactionID": "Id-774702ef5244685702fb003b-1",
      "TransactionTimestamp": "2013-09-26T13:01:12.041-04:00"
   },
   "TransactionResult":    {
      "SeverityText": "Information",
      "ResultID": "CM000",
      "ResultText": "Success"
   },
   "CreateNotificationProfileResponseDetail":    {
      "NotificationProfileDetail":       {
         "NotificationProfileName": "Notification_Profile_Email_01",
         "NotificationProfileID": 704
      },
      "InquiryReferenceText": {"CustomerReferenceText": ["Notification_Profile_Email_01"]}
   }
}}

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, CM007, CM023, 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:

Feature Notes

The DeliveryChannelUserPreferenceName parameter value should match the PreferenceSpecification.PreferenceName value that was used to create the User Preference.

NOTE: When the HTTPCallBack delivery mode is specified, the corresponding User Preference must include values for both the Credentials.UserID and Credentials.Password, as these fields will be supplied in the header when the call back is performed.

What to do Next

• List Notification Profiles
• Update Notification Profiles
• Add Monitoring Registration

• © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.