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

The Product Availability Lookup feature should be utilized PRIOR TO CALLING THIS OPERATION to determine if the D&B Direct product that will monitored is available for a given D-U-N-S Number.

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
POST https://maxcvservices.dnb.com/V{version}/monitoring/registrations

Request Parameters

The following parameters are accepted by this operation.

Restriction: The sequence of Request Parameters submitted to POST/PUT operations currently MUST follow the order presented in this section. This applies to REST calls only.

Restriction: For POST/PUT requests, the ‘Accept’ header item should be set to ‘application/json’ or be left empty. If the value submitted is ‘*/*’, the service will return an error. This applies to REST calls only.

Restriction: An XML namespace statement MUST be included as the first statement within the primary Aggregate of the request. Please refer to the Sample Request for an example. This applies to REST calls only.

Restriction: In addition to the previous restriction, the statement listing the primary Aggregate MUST be prefixed with the corresponding namespace. Please refer to the Sample Request for an example.

NOTE: As of August 22, 2014, for performance reasons, this function no longer performs a Product Availability check during the course of registering a D-U-N-S Number. As a result, it is possible for a registration to be successful, but later result in an unsuccessful state. An upcoming release will provide a method for viewing these cases.

When monitoring the People data layer, a principal identification number (Principal ID) will be required by this operation.

Name Characteristics
AddMonitoringRegistrationRequest Aggregate
AddMonitoringRegistrationRequest@ServiceVersionNumber Attribute
AddMonitoringRegistrationRequest@xsi:schemaLocation Attribute
AddMonitoringRegistrationRequest { TransactionDetail Aggregate, Optional

Records information necessary to process this request.

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

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

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

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

Records the details to add company / companies for monitoring, allowing the customer to receive alerts when there is a data change for the company.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryDetail Aggregate, Required
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { 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.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryDetail { 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.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { InquiryDetail { 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.

END: AddMonitoringRegistrationRequest } AddMonitoringRegistrationRequestDetail } InquiryDetail /Aggregate
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification Aggregate, Required

Records details of an organization to be monitored and the preferences that the customer has set for registering an organization for Monitoring.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { 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.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { NotificationProfileID int, Required

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

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { TradeUpIndicator boolean, Optional

When true (set to 1) this denotes that the customer has requested that D&B return the data for the Headquarters when the requested organization is a Branch. When false (set to 0) this denotes that the customer has not requested that D&B return the data for the Headquarters when the requested organization is a Branch; however as this is the assumed condition there is no requirement to create this tag to represent this fact. Note: There are D&B WorldWide Network operations where the Headquarters information will be returned automatically, regardless of the customer request.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { 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.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { 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

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { MonitoringRegistrationSpecification { 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.

END: AddMonitoringRegistrationRequest } AddMonitoringRegistrationRequestDetail } MonitoringRegistrationSpecification /Aggregate
AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { 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.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { 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.

AddMonitoringRegistrationRequest { AddMonitoringRegistrationRequestDetail { 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: AddMonitoringRegistrationRequest } AddMonitoringRegistrationRequestDetail } InquiryReferenceDetail /Aggregate
END: AddMonitoringRegistrationRequest } AddMonitoringRegistrationRequestDetail /Aggregate
END: AddMonitoringRegistrationRequest /Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail { 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.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { 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.

The volume of resulting change notices is dependent on the product/data field criteria (i.e. Monitoring Profile), volatility of the company being monitored, and the data update frequency (which may vary in certain countries). Change detection is currently based on the latest values as compared to previous values, and therefore is not cumulative from the date of registration.

Sample Request

POST https://maxcvservices.dnb.com/V3.0/monitoring/registrations
Content-Type: application/json
Authorization: <MyToken>

{
  "mon:AddMonitoringRegistrationRequest": {
    "@xmlns$mon": "http://services.dnb.com/MonitoringServiceV2.0",
    "TransactionDetail": {
      "ApplicationTransactionID": "ID_003",
    },
    "AddMonitoringRegistrationRequestDetail": {
      "InquiryDetail": {
        "DUNSNumber": "16144166",
        "CountryISOAlpha2Code": "US"
      },
      "MonitoringRegistrationSpecification": {
        "MonitoringProfileID": 272,
        "NotificationProfileID": 704,
        "TradeUpIndicator": "false",
        "AutoRenewalIndicator": "false",
        "SubjectCategoryText": "High"
      },
      "InquiryReferenceDetail": {
        "CustomerReferenceText": "16144166_Monitoring_Sept2013",
        "CustomerBillingEndorsementText": "16144166_Monitoring"
      }
    }
  }
}

Testing / Sandbox

This operation will return results in the D&B Direct sandbox (test) environment only when a test D-U-N-S Number is provided in the request parameters.

Response Specification

The following is a list of the possible data fields returned by this operation in the JSON response.

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

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

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

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

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

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

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

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

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

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

Possible values: High; Medium; Low

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

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

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

Text that explains the outcome of the transaction.

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

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

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

END: AddMonitoringRegistrationResponse } TransactionResult } ResultMessage /Aggregate
END: AddMonitoringRegistrationResponse } TransactionResult /Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail Aggregate, Optional

Records the details of the company / companies that are registered for monitoring which will allow the customer to receive alerts when there is a data change for the company.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail Aggregate, Required
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { 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.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { InquiryDetail { 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.

END: AddMonitoringRegistrationResponse } AddMonitoringRegistrationResponseDetail } InquiryDetail /Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail Aggregate, Required

Records details of an organization that will be monitored.

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

Records the duns number that is registered for Monitoring.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { 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.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { NotificationProfileID int, Required

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

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { StartDate date, Required

The date when the subject has been registered for monitoring.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { EndDate date, Required

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

END: AddMonitoringRegistrationResponse } AddMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail /Aggregate
AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { 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.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { 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.

AddMonitoringRegistrationResponse { AddMonitoringRegistrationResponseDetail { 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: AddMonitoringRegistrationResponse } AddMonitoringRegistrationResponseDetail } InquiryReferenceDetail /Aggregate
END: AddMonitoringRegistrationResponse } AddMonitoringRegistrationResponseDetail /Aggregate
END: AddMonitoringRegistrationResponse /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, CM009, CM011, CM012, CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.

Operation-specific supplemental response code explanations:

CM001 Invalid Monitoring Profile ID; or Invalid Notification Profile ID.
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).
CM009 Missing reason code
CM012 Invalid subject- Duns number
CM023 Duplicate Registration
PD003 DUNS stop distribution
PD005 Requested Product not available
PD016 DUNS transferred
PD017 DUNS out of business

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), ListMonitoringRegistration (REST), Change Notice (XML), CreateMonitoringProfile (REST), CreateNotificationProfile (REST).

Back to Top