UpdateMonitoringRegistration (SOAP)

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

The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Number and initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, or events with data layer included.

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.

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.

When monitoring the People data layer, a principal identification number (Principal ID) will be required by this operation.

Name Characteristics
UpdateMonitoringRegistrationRequest Aggregate
UpdateMonitoringRegistrationRequest@ServiceVersionNumber Attribute
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.

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

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

Testing / Sandbox

This operation will return results in the D&B Direct sandbox (test) environment only when a test D-U-N-S Number is provided in the request parameters.

Response Specification

The following is a list of the possible data fields returned by this operation in the XML response. In cases where multiple registrations were affected by the update, only the UpdatedRegistrationCount will be returned.

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

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

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

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

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

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

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

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

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

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

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

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

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

Text that explains the outcome of the transaction.

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

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

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

END: UpdateMonitoringRegistrationResponse. TransactionResult. ResultMessage /Aggregate
END: UpdateMonitoringRegistrationResponse. TransactionResult /Aggregate
UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail Aggregate, Optional

Records the details of the updated monitoring registration(s)

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. UpdatedRegistrationCount int, Required

A numeric value which records the count of registrations updated for the details provided by the customer in the request

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail Aggregate, Optional (Infinite)

Records the details of monitoring registration before and after the update

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the duns number that is provided by the customer to update the Monitoring registration.

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. MonitoringProfileID int, Required

A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. NotificationProfileID int, Optional

A number that uniquely identifies the former delivery preferences that the customer has set for Monitoring Alerts before the update.

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. SubjectCategoryText string up to 32 chars., Optional

An alphanumeric value identifying the former category in which the Customer has classified the subject.

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. AutoRenewalIndicator boolean, Optional

A boolean value which represents whether the registration is set for Auto renewal or not before the update. 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.

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. MonitoringRegistrationStatusText MonitoringRegistrationStatusEnum, Optional

Records the former status of the monitoring registration

Possible values: Active; Cancelled

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. InquiryReferenceText Aggregate
UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. InquiryReferenceText. CustomerReferenceText Element
END: UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. InquiryReferenceText /Aggregate
UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. FormerMonitoringRegistrationDetail Aggregate, Optional
UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. FormerMonitoringRegistrationDetail. NotificationProfileID int, Optional

A number that uniquely identifies the former delivery preferences that the customer has set for Monitoring Alerts before the update.

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. FormerMonitoringRegistrationDetail. SubjectCategoryText string up to 32 chars., Optional

An alphanumeric value identifying the former category in which the Customer has classified the subject.

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. FormerMonitoringRegistrationDetail. AutoRenewalIndicator boolean, Optional

A boolean value which represents whether the registration is set for Auto renewal or not before the update. 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.

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. FormerMonitoringRegistrationDetail. MonitoringRegistrationStatusText MonitoringRegistrationStatusEnum, Optional

Records the former status of the monitoring registration

Possible values: Active; Cancelled

UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. FormerMonitoringRegistrationDetail. InquiryReferenceText Aggregate
UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. FormerMonitoringRegistrationDetail. InquiryReferenceText. CustomerReferenceText Element
END: UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. FormerMonitoringRegistrationDetail. InquiryReferenceText /Aggregate
END: UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail. FormerMonitoringRegistrationDetail /Aggregate
END: UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail. MonitoringRegistrationDetail /Aggregate
END: UpdateMonitoringRegistrationResponse. UpdateMonitoringRegistrationResponseDetail /Aggregate
END: UpdateMonitoringRegistrationResponse /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, CM011, CM012, CM018, CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.

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

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

Related Topics

ListMonitoringRegistration (SOAP), AddMonitoringRegistration (SOAP).

Back to Top