ListMonitoringRegistration (REST)

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

The Monitoring Registration combines Monitoring and Notification Profiles with a specific D-U-N-S Number and initiates the Data Field Monitoring process. There are two levels of monitoring: change events only, or events with data layer included.

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

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/registrations

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.

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

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

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

Records the duns number that is registered for Monitoring.

CountryISOAlpha2Code string at least 2 chars. up to 2 chars., Optional

The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject.

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.

DNBProductID string up to 64 chars., Optional

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

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

NotificationProfileID int, Optional

A number that uniquely identifies the delivery preferences that the customer has set for Monitoring Alerts.

AutoRenewalIndicator boolean, Optional

When true (set to 1), it means that this registration is set for Auto Renewal. When false (set to 0), it means that this registration is not set for Autorenewal.

SubjectCategoryText string up to 32 chars., Optional

An alphanumeric value identifying the category in which the Customer has classified the subject.

Possible values: High; Medium; Low

RegisteredFromDate date, Optional

Records the start date of the date range to list the registrations.

RegisteredToDate date, Optional

Records the end date of the date range to list the registrations.

MonitoringRegistrationStatusText MonitoringRegistartionStatusTextEnum, Optional

Records the status of the monitoring registration

Possible values: Active; Cancelled; Expired

SortBasisText MonitoringSortBasisEnum, Optional

Records the list of fields based on which sorting is possible

Possible values: DUNSNumber; CountryISOAlpha2Code; MonitoringProfileID; DNBProductID; MonitoringLevel; NotificationProfileID; RegistrationStartDate; SubjectCategoryText; AutoRenewalIndicator; MonitoringRegistartionStatusText

SortDirectionText SortDirectionEnum, Optional

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

CandidatePerPageMaximumQuantity int Less than or equal to 1000., Optional

Records the maximum quantity that can be displayed per page

CandidateDisplayStartSequenceNumber int, Optional

Records the Display sequence number of the results

Sample Request

GET https://maxcvservices.dnb.com/V3.0/monitoring/registrations?RegisteredFromDate=2013-01-01&RegisteredToDate=2013-12-31&DNBProductID=PBPR_STD&AutoRenewalIndicator=false&SubjectCategoryText=High
Authorization: <MyToken>

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 JSON response.

Name Characteristics
ListMonitoringRegistrationResponse Aggregate
ListMonitoringRegistrationResponse@ServiceVersionNumber Attribute
ListMonitoringRegistrationResponse@xsi:schemaLocation Attribute
ListMonitoringRegistrationResponse { TransactionDetail Aggregate, Required

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

ListMonitoringRegistrationResponse { TransactionDetail { ApplicationTransactionID string up to 64 chars., Optional

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

ListMonitoringRegistrationResponse { TransactionDetail { ServiceTransactionID string up to 64 chars., Required

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

ListMonitoringRegistrationResponse { 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: ListMonitoringRegistrationResponse } TransactionDetail /Aggregate
ListMonitoringRegistrationResponse { TransactionResult Aggregate, Required

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

ListMonitoringRegistrationResponse { TransactionResult { SeverityText string up to 16 chars., Required

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

ListMonitoringRegistrationResponse { TransactionResult { ResultID string up to 32 chars., Required

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

ListMonitoringRegistrationResponse { TransactionResult { ResultText string up to 512 chars., Optional

Text that explains the outcome of the transaction.

ListMonitoringRegistrationResponse { 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.

ListMonitoringRegistrationResponse { TransactionResult { ResultMessage { ResultDescription string up to 512 chars., Required

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

END: ListMonitoringRegistrationResponse } TransactionResult } ResultMessage /Aggregate
END: ListMonitoringRegistrationResponse } TransactionResult /Aggregate
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail Aggregate, Optional
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { 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.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { 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.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail Aggregate, Optional (Infinite)

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

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryDetail Aggregate, Optional
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { 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.

END: ListMonitoringRegistrationResponse } ListMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail } InquiryDetail /Aggregate
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the duns number that is registered for Monitoring.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber string, Optional

A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { CountryISOAlpha2Code string at least 2 chars. up to 2 chars., Required

The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { 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.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DNBProductID string up to 64 chars., Required

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

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { 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

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { NotificationProfileID int, Required

A number that uniquely identifies the delivery preferences that the customer has set for Monitoring Alerts.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { AutoRenewalIndicator boolean, Required

When true (set to 1), it means that this registration is set for Auto Renewal. When false (set to 0), it means that this registration is not set for Autorenewal.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { SubjectCategoryText string up to 32 chars., Optional

An alphanumeric value identifying the category in which the Customer has classified the subject.

Possible values: High; Medium; Low

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { RegistrationReasonCode integer up to 7 digits., Optional

Code identifying the reason for the Customer showing interest to monitor this subject. This reason needs to be captured to comply with German Data Protection Laws.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { StartDate date, Required

The date when the subject has been registered for monitoring.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { EndDate date, Required

The date when the subject registration for monitoring has been ended.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringRegistrationStatusText MonitoringRegistartionStatusTextEnum, Required

Records the status of the monitoring registration

Possible values: Active; Cancelled; Expired

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail Aggregate, Optional

Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail { 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.

ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceDetail { CustomerBillingEndorsementText string at least 1 chars. up to 240 chars., Optional

Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided.This text is a reference used during the billing process.

END: ListMonitoringRegistrationResponse } ListMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail } InquiryReferenceDetail /Aggregate
ListMonitoringRegistrationResponse { ListMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { DisplaySequence int, Optional

Records the display sequence number of the results

END: ListMonitoringRegistrationResponse } ListMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail /Aggregate
END: ListMonitoringRegistrationResponse } ListMonitoringRegistrationResponseDetail /Aggregate
END: ListMonitoringRegistrationResponse /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, CM011, 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

UpdateMonitoringRegistration (REST), AddMonitoringRegistration (REST).

Back to Top