UpdateMonitoringProfile (SOAP)

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

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.

Monitoring 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

When providing PCMElementXPATHText values, the format should be "//Organization/..." WITHOUT any spaces. Some data elements may only be monitored by the associated aggregate or attribute XPATH.

As displayed in documentation Value in PCMElementXPATHText
OrderProductResponse. OrderProductResponseDetail. Product. Organization. Events. PublicFilingHeader. DisclaimerText //Organization /Events /PublicFilingHeader /DisclaimerText

The following parameters are accepted by this operation.

Name Characteristics
UpdateMonitoringProfileRequest Aggregate
UpdateMonitoringProfileRequest@ServiceVersionNumber Attribute
UpdateMonitoringProfileRequest@xsi:schemaLocation Attribute
UpdateMonitoringProfileRequest. TransactionDetail Aggregate, Optional

Records information necessary to process this request.

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

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

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

UpdateMonitoringProfileRequest. 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: UpdateMonitoringProfileRequest. TransactionDetail /Aggregate
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail Aggregate, Required
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileDetail Aggregate, Required
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileDetail. 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.

END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileDetail /Aggregate
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification Aggregate, Required
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional

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

UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail Aggregate, Optional
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement Aggregate, Required (Infinite)
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement. PCMElementXPATHText string up to 3000 chars., Required
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges Aggregate, Required (Infinite)
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeCondition ChangeConditionEnum, Required

Possible values: AnyChange; ValueIncreaseByPercentage; ValueDecreaseByPercentage; ValueChangeByPercentage; ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals

UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeValue string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges /Aggregate
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement /Aggregate
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail /Aggregate
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringProfileStatusText MonitoringProfileStatusTextEnum, Optional

Records the status of the monitoring profile

Possible values: Active; Cancelled

UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. 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.

UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. 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: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. InquiryReferenceText /Aggregate
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification /Aggregate
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail /Aggregate
END: UpdateMonitoringProfileRequest /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
UpdateMonitoringProfileResponse Aggregate
UpdateMonitoringProfileResponse@ServiceVersionNumber Attribute
UpdateMonitoringProfileResponse@xsi:schemaLocation Attribute
UpdateMonitoringProfileResponse. TransactionDetail Aggregate, Required

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

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

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

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

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

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

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

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

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

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

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

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

Text that explains the outcome of the transaction.

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

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

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

END: UpdateMonitoringProfileResponse. TransactionResult. ResultMessage /Aggregate
END: UpdateMonitoringProfileResponse. TransactionResult /Aggregate
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail Aggregate, Optional
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail Aggregate, Optional
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. 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.

UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required

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

UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail Aggregate, Optional
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. PCMElementXPATHText string up to 3000 chars., Required
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeCondition ChangeConditionEnum, Required

Possible values: AnyChange; ValueIncreaseByPercentage; ValueDecreaseByPercentage; ValueChangeByPercentage; ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals

UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeValue string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges /Aggregate
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement /Aggregate
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail /Aggregate
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringProfileStatusText MonitoringProfileStatusTextEnum, Optional

Records the status of the monitoring profile

Possible values: Active; Cancelled

UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. 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.

UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. 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: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. InquiryReferenceText /Aggregate
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail Aggregate, Optional
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional

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

UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail Aggregate, Optional
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. PCMElementXPATHText string up to 3000 chars., Required
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges Aggregate, Required (Infinite)
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeCondition ChangeConditionEnum, Required

Possible values: AnyChange; ValueIncreaseByPercentage; ValueDecreaseByPercentage; ValueChangeByPercentage; ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals

UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeValue string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges /Aggregate
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement /Aggregate
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail /Aggregate
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringProfileStatusText MonitoringProfileStatusTextEnum, Optional

Records the status of the monitoring profile

Possible values: Active; Cancelled

UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. 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.

UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. 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: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. InquiryReferenceText /Aggregate
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail /Aggregate
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail /Aggregate
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail /Aggregate
END: UpdateMonitoringProfileResponse /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, CM023, MN001, MN004, SC001-SC009.

Operation-specific supplemental response code explanations:

CM001 Profile name is sent as blank; or Blank value passed for PCMElementXpath.
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 Monitoring profile cannot be canceled as registrations are available for this profile; Monitoring profile ID not available in the system; Invalid Change Value (Alert threshold); or PCMElementXpath does not belong to the Product.
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.

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

Related Topics

CreateMonitoringProfile (SOAP), ListMonitoringProfile (SOAP).

Back to Top