GetMonitoringProduct (SOAP)

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

This operation returns the most recent copy of the product data -- not the data available at the date/time the Change Notice was triggered.

NOTE: For level 2 Monitoring registrations, the service returns data layers in the format specified by the latest version of the corresponding service. For example, if the DCP_PREM data layer is being monitored and a new version of the Firmographic service is released, level 2 Monitoring attachments will reflect the newer DCP_PREM layout (if it changed).

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
GetMonitoringProductRequest Aggregate
GetMonitoringProductRequest @ServiceVersionNumber Attribute
GetMonitoringProductRequest. TransactionDetail Aggregate, Optional

Records information necessary to process this request.

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

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

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

GetMonitoringProductRequest. 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: GetMonitoringProductRequest. TransactionDetail /Aggregate
GetMonitoringProductRequest. GetMonitoringProductRequestDetail Aggregate, Required
GetMonitoringProductRequest. GetMonitoringProductRequestDetail. InquiryDetail Aggregate, Required
GetMonitoringProductRequest. GetMonitoringProductRequestDetail. InquiryDetail. DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the duns number that is provided by the customer to register for Monitoring.

GetMonitoringProductRequest. GetMonitoringProductRequestDetail. InquiryDetail. DNBProductID string up to 64 chars., Required

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

End: GetMonitoringProductRequest. GetMonitoringProductRequestDetail. InquiryDetail /Aggregate
End: GetMonitoringProductRequest. GetMonitoringProductRequestDetail /Aggregate
End: GetMonitoringProductRequest /Aggregate

Response Specification

The following is a list of the possible data fields returned by this operation in the XML response. The individual data layer will be returned as base 64 encoded package within the response.

Name Characteristics
GetMonitoringProductResponse Aggregate
GetMonitoringProductResponse @ServiceVersionNumber Attribute
GetMonitoringProductResponse. TransactionDetail Aggregate, Required

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

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

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

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

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

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

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

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

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

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

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

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

Text that explains the outcome of the transaction.

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

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

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

End: GetMonitoringProductResponse. TransactionResult. ResultMessage /Aggregate
End: GetMonitoringProductResponse. TransactionResult /Aggregate
GetMonitoringProductResponse. GetMonitoringProductResponseDetail Aggregate, Optional
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. InquiryDetail Aggregate, Required
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. InquiryDetail. DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the duns number that is provided by the customer to register for Monitoring.

GetMonitoringProductResponse. GetMonitoringProductResponseDetail. InquiryDetail. DNBProductID string up to 64 chars., Required

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

End: GetMonitoringProductResponse. GetMonitoringProductResponseDetail. InquiryDetail /Aggregate
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product Aggregate, Required
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. LanguageCode integer up to 7 digits., Optional

A D&B code value that defines the language in which the requested product is fulfilled.

GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization Aggregate, Optional
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization. SubjectHeader Aggregate, Required

Records high level information about the subject such as the primary language of the subject and the primary currency in which this subject trades. When the subject is an organizantion, this may also include details such as DUNS Number.

GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization. SubjectHeader. DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S).

End: GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization. SubjectHeader /Aggregate
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization. OrganizationName Aggregate, Required

Records the different names of the organization by which it is known as well as names of other organizations that have a similar name to this organization.

GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization. OrganizationName. OrganizationPrimaryName Aggregate, Required (Infinite)

An entry loop which can repeat multiple times to allow the recording of a single name by which the organization is primarily known / identified in different languages and/or writing scripts.

GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization. OrganizationName. OrganizationPrimaryName. OrganizationName string up to 256 chars., Required
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization. OrganizationName. OrganizationPrimaryName. OrganizationName @WritingScriptISOAlpha4Code Attribute
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization. OrganizationName. OrganizationPrimaryName. OrganizationName @LanguageCode Attribute
End: GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization. OrganizationName. OrganizationPrimaryName /Aggregate
End: GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. Organization /Aggregate
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. ObjectAttachment Aggregate, Required
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. ObjectAttachment. ContentObject base64Binary, Required
GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. ObjectAttachment. ObjectFormatCode integer up to 7 digits., Required

SCoTS: 126 [Object Format]

End: GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product. ObjectAttachment /Aggregate
End: GetMonitoringProductResponse. GetMonitoringProductResponseDetail. Product /Aggregate
End: GetMonitoringProductResponse. GetMonitoringProductResponseDetail /Aggregate
End: GetMonitoringProductResponse /Aggregate

NOTE: The OrderProductResponse@ServiceVersionNumber value in the object attachment will NOT match the version of the data layer when retrieved from it's corresponding service.

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, CM011, CM012, CM014, MN003, PD005, SC001-SC009.

Operation-specific supplemental response code explanations:

CM001 Invalid Language code provided
CM007 No Level2 notices available for the given criteria
PD005 Requested Product not available

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

ListChangeNotice (SOAP)

Back to Top