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

Refer to How to Retrieve Monitoring Profiles for an overview of this operation.

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
ListMonitoringProfileRequest Aggregate
ListMonitoringProfileRequest@ServiceVersionNumber Attribute
ListMonitoringProfileRequest@xsi:schemaLocation Attribute
ListMonitoringProfileRequest. TransactionDetail Aggregate, Optional

Records information necessary to process this request.

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

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

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

ListMonitoringProfileRequest. 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: ListMonitoringProfileRequest. TransactionDetail /Aggregate
ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail Aggregate, Required
ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria Aggregate, Optional
ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. MonitoringProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional

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

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. 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.

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. DNBProductID string up to 64 chars., Optional

Records the product code that is provided by the customer to create a profile

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. MonitoringLevel MonitoringLevelTextEnum up to 16 chars., Optional

A alphanumeric string which determines the level of details that the customer will receive during a change event

Possible values: Level1; Level2

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. CreatedFromDate date, Optional

Records the start date of the date range to list the monitoring profiles

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. CreatedToDate date, Optional

Records the enddate of the date range to list the monitoring profiles

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. MonitoringProfileStatusText MonitoringProfileStatusTextEnum, Optional

Records the status of the monitoring profile

Possible values: Active; Cancelled

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. 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.

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. 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: ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. InquiryReferenceText /Aggregate
END: ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria /Aggregate
ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification Aggregate, Optional
ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification. SortBasisText MonitoringProfileSortBasisEnum, Optional

Records the list of fields based on which sorting is possible

Possible values: DNBProductID; MonitoringProfileID; MonitoringProfileName; MonitoringLevel; MonitoringProfileStatusText; MonitoringProfileCreatedDate

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification. SortDirectionText SortDirectionEnum, Optional

Records the direction of sorting. Possbile values are Ascending, Descending

Possible values: Ascending/Descending

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification. CandidatePerPageMaximumQuantity int Less than or equal to 1000., Optional

Records the maximum quantity that can be displayed per page

ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification. CandidateDisplayStartSequenceNumber int, Optional

Records the Display sequence number of the results

END: ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification /Aggregate
END: ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail /Aggregate
END: ListMonitoringProfileRequest /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
ListMonitoringProfileResponse Aggregate
ListMonitoringProfileResponse@ServiceVersionNumber Attribute
ListMonitoringProfileResponse@xsi:schemaLocation Attribute
ListMonitoringProfileResponse. TransactionDetail Aggregate, Required

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

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

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

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

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

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

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

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

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

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

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

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

Text that explains the outcome of the transaction.

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

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

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

END: ListMonitoringProfileResponse. TransactionResult. ResultMessage /Aggregate
END: ListMonitoringProfileResponse. TransactionResult /Aggregate
ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail Aggregate, Optional
ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. CandidateMatchedQuantity int up to 6 digits., Required

The number of registrations listed as possible matches in the result set based on the search criteria in the Customer/User request.

ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. CandidateReturnedQuantity int up to 6 digits., Required

The number of registrations returned in the result set based on the search criteria in the Customer/User request.

ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail Aggregate, Optional (Infinite)
ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. 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.

ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringProfileDescription string up to 256 chars., Optional

A string that records the description of the profile

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

ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. DNBProductID string up to 64 chars., Required

Records the product code that is provided by the customer to create a profile

ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringLevel MonitoringLevelTextEnum up to 16 chars., Required

A alphanumeric string which determines the level of details that the customer will receive during a change event

Possible values: Level1; Level2

ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail Aggregate, Optional
ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement Aggregate, Required (Infinite)
ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. PCMElementXPATHText string up to 3000 chars., Required
ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges Aggregate, Required (Infinite)
ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeCondition ChangeConditionEnum, Required
ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeValue string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
END: ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges /Aggregate
END: ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement /Aggregate
END: ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail /Aggregate
ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringProfileStatusText MonitoringProfileStatusTextEnum, Required

Records the status of the monitoring profile

Possible values: Active; Cancelled

ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringProfileCreatedDate date, Required

Records the start date of the date range to list the Monitoring profiles

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

ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. 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: ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. InquiryReferenceText /Aggregate
ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail. DisplaySequence int, Optional

Records the display sequence number of the results

END: ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail. MonitoringProfileDetail /Aggregate
END: ListMonitoringProfileResponse. ListMonitoringProfileResponseDetail /Aggregate
END: ListMonitoringProfileResponse /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: CM002, CM004, CM018, SC001-SC009.

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), UpdateMonitoringProfile (SOAP).

Back to Top