GetMonitoringProduct (REST)

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

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

GET https://maxcvservices.dnb.com/V{version}/monitoring/organizations/{DUNS}/products/{productID}

Request Parameters

The following parameters are accepted by this operation.

Name

Characteristics

{version}

Element

ApplicationTransactionID

string up to 64 chars., Optional

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

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.

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.

{DUNS}

string up to 9 chars. Pattern: {([0-9]*)}., Required

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

{productID}

string up to 64 chars., Required

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

Response Specification

The following is a list of the possible data fields returned by this operation in the JSON 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.

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.

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.

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