UpdateMonitoringRegistration (SOAP)

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.

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.

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.

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.

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.

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.

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.

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.

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

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.