CreateMonitoringProfile (SOAP)

A Monitoring Profile establishes the specific data fields within a given data layer that should be monitored, and the conditions under which a change event should be triggered.

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 Monitoring process triggers events based on the old and new data field values WHEN A CHANGE OCCURS, and is not based on the data layer values when the Monitoring Registration was created. To capture cumulative but gradual changes, using the "ValueGoesBeyond" or "ValueGoesBelow" conditions is recommended.

Developers may now add entries to Monitoring Profiles that specify the combination(s) of XPATH + attribute that they wish to Monitor. This is accomplished by appending an attribute statement to the XPATH within the CreateMonitoringProfile request. The statement may include multiple values for the attribute by using an OR ("||") operator.

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.

CreateMonitoringProfileRequest. 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: CreateMonitoringProfileRequest. TransactionDetail

/Aggregate

CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail

Aggregate, Required

Records details of the request to create a profile, a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

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: CreateMonitoringProfileResponse. TransactionDetail

/Aggregate

CreateMonitoringProfileResponse. TransactionResult

Aggregate, Required

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

CreateMonitoringProfileResponse. TransactionResult. SeverityText

string up to 16 chars., Required

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

CreateMonitoringProfileResponse. TransactionResult. ResultID

string up to 32 chars., Required

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

CreateMonitoringProfileResponse. TransactionResult. ResultText

string up to 512 chars., Optional

Text that explains the outcome of the transaction.

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

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

CM007

PCMElementXpath does not belong to the Product; or Invalid Change Value (Alert threshold)

CM014

Product Not available

CM023

Duplicate Profile Name

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.