Cookies Settings

Loading

dnb-logo
Direct 2.0
Collapse

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.

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

Sample Request (Create)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mon="http://services.dnb.com/MonitoringServiceV2.0">
     <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken-7" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>MyUserName</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">MyPassword</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <mon:CreateNotificationProfileRequest ServiceVersionNumber="5.0">
         <CreateNotificationProfileRequestDetail>
            <NotificationProfileSpecification>
               <NotificationProfileName>MonitoringNotificationProfile-MikeEmail</NotificationProfileName>
               <NotificationProfileDescription>Monitoring Notification Profile using Mike's Email</NotificationProfileDescription>
               <DeliveryMode>Email</DeliveryMode>
               <DeliveryChannelUserPreferenceName>Mike-Email</DeliveryChannelUserPreferenceName>
               <DeliveryFrequency>Immediate</DeliveryFrequency>
               <DeliveryFormat>XML</DeliveryFormat>
               <StopDeliveryIndicator>false</StopDeliveryIndicator>
               <CompressedProductIndicator>true</CompressedProductIndicator>
            </NotificationProfileSpecification>
         </CreateNotificationProfileRequestDetail>
      </mon:CreateNotificationProfileRequest>
   </soapenv:Body>
</soapenv:Envelope>
Note: This sample is for illustrative purposes only. Actual calls using the sample parameters may not produce the same results.
Name Characteristics
CreateNotificationProfileRequest Aggregate
CreateNotificationProfileRequest@ServiceVersionNumber Attribute
CreateNotificationProfileRequest@xsi:schemaLocation Attribute
CreateNotificationProfileRequest. TransactionDetail Aggregate, Optional

Records information necessary to process this request.

CreateNotificationProfileRequest. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional

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

CreateNotificationProfileRequest. 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.

CreateNotificationProfileRequest. 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: CreateNotificationProfileRequest. TransactionDetail /Aggregate
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail Aggregate, Required
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification Aggregate, Required
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. NotificationProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required

A name that is provided by the user to the profile.

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. NotificationProfileDescription string up to 256 chars., Optional

A string that records the description of the profile

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. DeliveryMode DeliveryModeEnum, Required

Possible values: Email; HTTPCallBack; MQOutput

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. DeliveryChannelUserPreferenceName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. DeliveryFrequency DeliveryFrequencyEnum, Required

Possible values: Immediate; Hourly; Daily; Weekly

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. DeliveryFormat DeliveryFormatEnum, Required

Possible values: XML, JSON

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. StopDeliveryIndicator boolean, Required
END: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification /Aggregate
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. InquiryReferenceText Aggregate, Optional

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

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. InquiryReferenceText. 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.

CreateNotificationProfileRequest. CreateMonitoringProfileRequestDetail. NotificationProfileSpecification. 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: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. InquiryReferenceText /Aggregate
END: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail /Aggregate
END: CreateNotificationProfileRequest /Aggregate

Endpoint

Use the following endpoint with the downloadable WSDL to request this feature.

SOAP (Monitoring)
https://direct.dnb.com/Monitoring/V{version}

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

Specification

The following is a list of the possible data fields returned by this operation in the XML 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 (Create)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soap-env:Body xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
      <mon:CreateNotificationProfileResponse ServiceVersionNumber="5.0" xmlns:mon="http://services.dnb.com/MonitoringServiceV2.0">
         <TransactionDetail>
            <ServiceTransactionID>Id-a867e332520e3ed4044b5d09-1</ServiceTransactionID>
            <TransactionTimestamp>2013-08-16T11:01:40.163-04:00</TransactionTimestamp>
         </TransactionDetail>
         <TransactionResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
         </TransactionResult>
         <CreateNotificationProfileResponseDetail>
            <NotificationProfileDetail>
               <NotificationProfileName>MonitoringNotificationProfile-MikeEmail</NotificationProfileName>
               <NotificationProfileID>1583</NotificationProfileID>
            </NotificationProfileDetail>
         </CreateNotificationProfileResponseDetail>
      </mon:CreateNotificationProfileResponse>
   </soap-env:Body>
</soapenv:Envelope>
Name Characteristics
CreateNotificationProfileResponse Aggregate
CreateNotificationProfileResponse@ServiceVersionNumber Attribute
CreateNotificationProfileResponse@xsi:schemaLocation Attribute
CreateNotificationProfileResponse. TransactionDetail Aggregate, Required

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

CreateNotificationProfileResponse. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional

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

CreateNotificationProfileResponse. TransactionDetail. ServiceTransactionID string up to 64 chars., Required

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

CreateNotificationProfileResponse. 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: CreateNotificationProfileResponse. TransactionDetail /Aggregate
CreateNotificationProfileResponse. TransactionResult Aggregate, Required

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

CreateNotificationProfileResponse. TransactionResult. SeverityText string up to 16 chars., Required

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

CreateNotificationProfileResponse. TransactionResult. ResultID string up to 32 chars., Required

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

CreateNotificationProfileResponse. TransactionResult. ResultText string up to 512 chars., Optional

Text that explains the outcome of the transaction.

CreateNotificationProfileResponse. TransactionResult. ResultMessage Aggregate, Optional (Infinite)

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.

CreateNotificationProfileResponse. TransactionResult. ResultMessage. ResultDescription string up to 512 chars., Required

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

END: CreateNotificationProfileResponse. TransactionResult. ResultMessage /Aggregate
END: CreateNotificationProfileResponse. TransactionResult /Aggregate
CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail Aggregate, Optional
CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. NotificationProfileDetail Aggregate, Required
CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. NotificationProfileDetail. NotificationProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required

A name that is provided by the user to the profile.

CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. NotificationProfileDetail. 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.

END: CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. NotificationProfileDetail /Aggregate
CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. InquiryReferenceText Aggregate, Optional

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

CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. InquiryReferenceText. 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.

END: CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. InquiryReferenceText /Aggregate
END: CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail /Aggregate
END: CreateNotificationProfileResponse /Aggregate

NOTE: There may be additional request and/or response elements specified in the WSDL that are not applicable for D&B Direct customers. Data elements that are not listed on this page are currently unused by this operation.

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