Loading

dnb-logo
Direct 2.0
Collapse

Update Monitoring Registration

This function allows a customer to update or cancel an active monitoring registration.

Update History

No modifications have been made to this data layer since the initial release.

What to do First

Feature Request

IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.

Data Layer Entitlement

For customers in U.S. and Canadian markets, the API is provisioned for specific collections of products, reports, and/or features (collectively referred to as data layers) for production and trial usage. Entitlement is not required for testing in the sandbox environment.

  • This function does not require entitlement for production and trial usage. Entitlement for monitoring is only required for the Add Monitoring Registration function, and for the data layers that will monitored.

Specification

Caution: This operation will update multiple registrations based on the input parameters provided. For example, if a D-U-N-S Number is not provided, all registrations with matching Monitoring and Notification Profile IDs will be affected by the change requested. If no input criteria provided, all registrations will be affected.

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

Sample Request (Update)
PUT https://direct.dnb.com/V4.1/monitoring/registrations HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
Authorization: <My Token>

{
  "mon:UpdateMonitoringRegistrationRequest": {
    "@xmlns$mon": "http://services.dnb.com/MonitoringServiceV2.0",
    "TransactionDetail": {
      "ApplicationTransactionID": "Update_Registration8",
      "TransactionTimestamp": "2001-12-17T09:30:47Z",
      "SubmittingOfficeID": "4550"
    },
    "UpdateMonitoringRegistrationRequestDetail": {
      "MonitoringRegistrationDetail": {
        "DUNSNumber": "544140197",
        "MonitoringProfileID": "41",
        "NotificationProfileID": "905"
      },
      "MonitoringRegistrationUpdateSpecification": {
        "AutoRenewalIndicator": false,
        "SubjectCategoryText": "Low"
      },
      "InquiryReferenceText": { "CustomerReferenceText": "Upating Category to High" }
    }
  }
}
 NameCharacteristics
UpdateMonitoringRegistrationRequest Aggregate
UpdateMonitoringRegistrationRequest@ServiceVersionNumber Attribute
UpdateMonitoringRegistrationRequest@xsi:schemaLocation Attribute
UpdateMonitoringRegistrationRequest { TransactionDetail Aggregate, Optional

Records information necessary to process this request.

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

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

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

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

Records the details of request to update existing monitoring registration(s)

UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail Aggregate, Optional

Records the details of the existing registrations

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

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

UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { InquiryDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber Element
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail { 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.

UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationDetail { NotificationProfileID int, Optional

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

END: UpdateMonitoringRegistrationRequest } UpdateMonitoringRegistrationRequestDetail } MonitoringRegistrationDetail /Aggregate
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification Aggregate, Required

Records the specification of the registrations update

UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { NotificationProfileID int, Optional

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

UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { 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.

UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { 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

UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { MonitoringRegistrationStatusText MonitoringRegistrationStatusEnum, Optional

Records the status of the monitoring registration

Possible values: Active; Cancelled; Pending; Expired; RegistrationFailed:StopDistribution, RegistrationFailed:TooOldData, RegistrationFailed:ProductAvailabilityFailure, RegistrationFailed

UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { InquiryReferenceText Aggregate
UpdateMonitoringRegistrationRequest { UpdateMonitoringRegistrationRequestDetail { MonitoringRegistrationUpdateSpecification { InquiryReferenceText { CustomerReferenceText Element
END: UpdateMonitoringRegistrationRequest } UpdateMonitoringRegistrationRequestDetail } MonitoringRegistrationUpdateSpecification } InquiryReferenceText /Aggregate
END: UpdateMonitoringRegistrationRequest } UpdateMonitoringRegistrationRequestDetail } MonitoringRegistrationUpdateSpecification /Aggregate
END: UpdateMonitoringRegistrationRequest } UpdateMonitoringRegistrationRequestDetail /Aggregate
END: UpdateMonitoringRegistrationRequest /Aggregate

Deleting a Registration

To remove a registration, a customer may change the status to Cancelled immediately, from either a Pending or Active registration status, through an update request. Cancelled items can be restored within 24-hours of the update, after which they are deleted by the system.

"MonitoringRegistrationUpdateSpecification": {
     "MonitoringRegistrationStatusText": "Cancelled"
},

Endpoint

Use the following endpoint for requesting this feature. The {version} is dependent on the underlying service delivering the response.

Endpoint (Monitoring)
PUT https://direct.dnb.com/V{version}/monitoring/registrations

Testing

This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless of the request parameters.

Feature Response

NOTE: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minor variations.

Specification

The following is a list of the possible data fields returned by this operation in the JSON response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.

In cases where multiple registrations were affected by the update, only the UpdatedRegistrationCount will be returned.

NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.

Sample Response (Update)
{"UpdateMonitoringRegistrationResponse": {
   "@ServiceVersionNumber": "4.0",
   "TransactionDetail":    {
      "ApplicationTransactionID": "Update_Registration8",
      "ServiceTransactionID": "Id-1971773852f3b5dcedfbcb47-1",
      "TransactionTimestamp": "2001-12-17T04:30:47-05:00"
   },
   "TransactionResult":    {
      "SeverityText": "Information",
      "ResultID": "CM000",
      "ResultText": "Success"
   },
   "UpdateMonitoringRegistrationResponseDetail":    {
      "UpdatedRegistrationCount": 1,
      "MonitoringRegistrationDetail": [      {
         "DUNSNumber": "544140197",
         "MonitoringProfileID": 41,
         "SubjectCategoryText": "Low",
         "AutoRenewalIndicator": false,
         "FormerMonitoringRegistrationDetail":          {
            "SubjectCategoryText": "High",
            "AutoRenewalIndicator": false
         }
      }],
      "InquiryReferenceText": {"CustomerReferenceText": ["Test Request"]}
   }
}}
Name Characteristics
UpdateMonitoringRegistrationResponse Aggregate
UpdateMonitoringRegistrationResponse@ServiceVersionNumber Attribute
UpdateMonitoringRegistrationResponse@xsi:schemaLocation Attribute
UpdateMonitoringRegistrationResponse { TransactionDetail Aggregate, Required

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

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

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

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

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

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

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

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

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

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

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

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

Text that explains the outcome of the transaction.

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

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

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

END: UpdateMonitoringRegistrationResponse } TransactionResult } ResultMessage /Aggregate
END: UpdateMonitoringRegistrationResponse } TransactionResult /Aggregate
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail Aggregate, Optional

Records the details of the updated monitoring registration(s)

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { UpdatedRegistrationCount int, Required

A numeric value which records the count of registrations updated for the details provided by the customer in the request

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail Aggregate, Optional (Infinite)

Records the details of monitoring registration before and after the update

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

Records the duns number that is provided by the customer to update the Monitoring registration.

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { 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.

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { 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.

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { NotificationProfileID int, Optional

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

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { SubjectCategoryText string up to 32 chars., Optional

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

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { AutoRenewalIndicator boolean, Optional

A boolean value which represents whether the registration is set for Auto renewal or not before the update. 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.

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { MonitoringRegistrationStatusText MonitoringRegistrationStatusEnum, Optional

Records the former status of the monitoring registration

Possible values: Active; Cancelled

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceText Aggregate
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { InquiryReferenceText { CustomerReferenceText Element
END: UpdateMonitoringRegistrationResponse } UpdateMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail } InquiryReferenceText /Aggregate
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail Aggregate, Optional
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { NotificationProfileID int, Optional

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

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { SubjectCategoryText string up to 32 chars., Optional

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

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { AutoRenewalIndicator boolean, Optional

A boolean value which represents whether the registration is set for Auto renewal or not before the update. 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.

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { MonitoringRegistrationStatusText MonitoringRegistrationStatusEnum, Optional

Records the former status of the monitoring registration

Possible values: Active; Cancelled

UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { InquiryReferenceText Aggregate
UpdateMonitoringRegistrationResponse { UpdateMonitoringRegistrationResponseDetail { MonitoringRegistrationDetail { FormerMonitoringRegistrationDetail { InquiryReferenceText { CustomerReferenceText Element
END: UpdateMonitoringRegistrationResponse } UpdateMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail } FormerMonitoringRegistrationDetail } InquiryReferenceText /Aggregate
END: UpdateMonitoringRegistrationResponse } UpdateMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail } FormerMonitoringRegistrationDetail /Aggregate
END: UpdateMonitoringRegistrationResponse } UpdateMonitoringRegistrationResponseDetail } MonitoringRegistrationDetail /Aggregate
END: UpdateMonitoringRegistrationResponse } UpdateMonitoringRegistrationResponseDetail /Aggregate
END: UpdateMonitoringRegistrationResponse /Aggregate

Response Codes & Error Handling

Successful service requests will return a CM000 response code in the TransactionResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.

This operation may return the following response codes: CM001, CM002, CM004, CM011, CM012, CM018, CM023, MN001, MN002, PD003, PD005, PD016, PD017, SC001-SC009.

D&B Direct 2.0 API requests are provided on a metered basis; and may require entitlement prior to use in the production environment. In addition, a concurrency limit (QPS) is monitored to ensure that it is not exceeded. An error code will be returned in the event that a transaction is throttled.

While this operation is provided on a metered basis, usage is tracked; however, no billing for successful calls is recorded.

Operation-specific supplemental response code explanations: