UpdateNotificationProfile (SOAP)

This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.

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.

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.

Authentication, Endpoint & WSDL

D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) is determined by the credentials submitted with each API request. Refer to the service page for the correct version of the operation.

Endpoint
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL

Request Parameters

The following parameters are accepted by this operation.

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

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

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
END: UpdateNotificationProfileRequest. UpdateNotificationProfileRequestDetail. NotificationProfileDetail. InquiryReferenceText /Aggregate
END: UpdateNotificationProfileRequest. UpdateNotificationProfileRequestDetail. NotificationProfileDetail /Aggregate
END: UpdateNotificationProfileRequest. UpdateNotificationProfileRequestDetail /Aggregate
END: UpdateNotificationProfileRequest /Aggregate

Testing / Sandbox

This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.

Response Specification

The following is a list of the possible data fields returned by this operation in the XML response.

Name Characteristics
UpdateNotificationProfileResponse Aggregate
UpdateNotificationProfileResponse@ServiceVersionNumber Attribute
UpdateNotificationProfileResponse@xsi:schemaLocation Attribute
UpdateNotificationProfileResponse. TransactionDetail Aggregate, Required

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

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

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

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

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

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

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

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

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

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

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

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

Text that explains the outcome of the transaction.

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

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

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

END: UpdateNotificationProfileResponse. TransactionResult. ResultMessage /Aggregate
END: UpdateNotificationProfileResponse. TransactionResult /Aggregate
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail Aggregate, Optional
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail Aggregate, Optional
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. 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.

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. 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.

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. DeliveryChannelUserPreferenceName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. DeliveryMode DeliveryModeEnum, Optional

Possible values: Email; HTTPCallBack; MQOutput

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. DeliveryFrequency DeliveryFrequencyEnum, Optional

Possible values: Immediate; Hourly; Daily; Weekly

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. DeliveryFormat DeliveryFormatEnum, Optional

Possible values: XML

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. NotificationProfileStatusText NotificationProfileStatusTextEnum, Optional

Records the status of the monitoring registration

Possible values: Active; Cancelled

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. StopDeliveryIndicator boolean, Optional
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. InquiryReferenceText Aggregate
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. InquiryReferenceText. CustomerReferenceText Element
END: UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. InquiryReferenceText /Aggregate
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail Aggregate, Optional
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail. NotificationProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional

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

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail. DeliveryChannelUserPreferenceName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail. DeliveryMode DeliveryModeEnum, Optional

Possible values: Email; HTTPCallBack; MQOutput

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail. DeliveryFrequency DeliveryFrequencyEnum, Optional

Possible values: Immediate; Hourly; Daily; Weekly

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail. DeliveryFormat DeliveryFormatEnum, Optional

Possible values: XML

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail. NotificationProfileStatusText NotificationProfileStatusTextEnum, Optional

Records the status of the monitoring registration

Possible values: Active; Cancelled

UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail. StopDeliveryIndicator boolean, Optional
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail. InquiryReferenceText Aggregate
UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail. InquiryReferenceText. CustomerReferenceText Element
END: UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail. InquiryReferenceText /Aggregate
END: UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail. FormerNotificationProfileDetail /Aggregate
END: UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail. NotificationProfileDetail /Aggregate
END: UpdateNotificationProfileResponse. UpdateNotificationProfileResponseDetail /Aggregate
END: UpdateNotificationProfileResponse /Aggregate

Language/Character Sets

The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including the D&B Business Information Report (BIR), provide additional language options. Data layers are encoded using the ISO 8859-1 character set standard (also known as Latin-1).

Response Codes

Successful service requests will return a CM000 response code. 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.

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.

Samples (Download)

Request and response samples are available for this D&B Direct web services. The samples may cover a variety of scenarios (when applicable) and are designed for use in the test environment.

Monitoring Service
Samples http://developer.dnb.com/docs/2.0/monitoring/3.0/DnB-Monitoring.zip
Back to Top