Loading

Direct 2.0
Collapse

List Notification Profile

ProductD&B Direct 2.0, D&B Direct Onboard
Product Code(s)Not Applicable
Options(s)None
Monitoring AvailableNo
InterfaceREST
MethodGET
Format(s)JSON
ServiceMonitoring
{version}8.0
8.0 Released onFebruary 15, 2019

This function allows a customer to review active notification profiles.

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 December 14, 2018.

Overview

There are several options available when implementing this (Undefined variable: DnB API Globals.API Name) feature.

1. Basic Retrieve: If a Profile ID (the value returned when a profile is created) is provided to the List operation, a single profile will be returned.

2. Search by Name: When a profile is created, a customer supplied name is assigned. Searching by the profile name (case-sensitive, no wildcards) is available.

3. User Preference: Filter the results by the providing the name (case-sensitive, no wildcards) of a user preference.

4. Delivery: Filter the results by deliver mode (Email, HTTPCalBack, MQOutput), frequency (Immediate, Hourly, Daily, Weekly) or format (XML).

5. Date Range: The results can be narrowed by supplying a start and end date range which is compared against the date a profile was created.

6. Stop Delivery: An option exists to disable notification delivery for a profile. Results can be filtered to include or exclude profiles that have been stopped.

7. Status Filter: Profiles that are assigned a status of "Cancelled" remain in the Monitoring system for 24 hours before being deleted. The results may be limited to a specific status.

8. Customer Reference Text: When a profile is created, a free form (240 character) field may be supplied. This field may be used in the List operation; however, it is case-sensitive and there are no wildcard options.

9. Sorting Results: By default, the results will be ascending by ???. Optionally, both the sort direction and a primary sort field can be designated on the request.

Sort field options include: DeliveryChannelUserPreferenceName, NotificationProfileID, NotificationProfileName, DeliveryMode, DeliveryFrequency, DeliveryFormat, StopDeliveryIndicator, NotificationProfileCreatedDate, NotificationProfileStatusText.

10. Pagination: Options exist to designate the maximum number of records per request, and the starting row number. The maximum number of records this feature will return on a single request is 1,000.

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

Sample Request (List)
GET https://direct.dnb.com/V8.0/monitoring/notificationprofiles?DeliveryFormat=XML&DeliveryMode=Email&amCandidatePerPageMaximumQuantity=10&DeliveryChannelUserPreferenceName=restDemoPreference
Authorization: <MyToken>
Name Characteristics
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.

NotificationProfileID int, Optional

A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

NotificationProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional

A name that is provided by the user to the profile.

DeliveryChannelUserPreferenceName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
DeliveryMode DeliveryModeEnum, Optional

Possible values: Email; HTTPCallBack; MQOutput

DeliveryFrequency DeliveryFrequencyEnum, Optional

Possible values: Immediate; Hourly; Daily; Weekly

DeliveryFormat DeliveryFormatEnum, Optional

Possible values: XML, JSON

NotificationProfileStatusText NotificationProfileStatusTextEnum, Optional

Records the status of the monitoring registration

Possible values: Active; Cancelled

StopDeliveryIndicator boolean, Optional
CreatedFromDate date, Optional

Records the start date of the date range to list the delivery profiles

CreatedToDate date, Optional

Records the enddate of the date range to list the delivery profiles

CustomerReferenceText-n (up to 5 times) 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.

SortBasisText NotificationProfileSortBasisEnum, Optional

Records the list of fields based on which sorting is possible

Possible values: DeliveryChannelUserPreferenceName; NotificationProfileID; NotificationProfileName; DeliveryMode; DeliveryFrequency; DeliveryFormat; StopDeliveryIndicator; NotificationProfileCreatedDate; NotificationProfileStatusText

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

Endpoint

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

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

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.

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

Sample Response (List)
{"ListNotificationProfileResponse": {
   "TransactionDetail":    {
      "ServiceTransactionID": "Id-6f784a582f6311009d3c04007e43bdb1-1",
      "TransactionTimestamp": "2016-12-09T04:25:03.897-05:00"
   },
   "TransactionResult":    {
      "SeverityText": "Information",
      "ResultID": "CM000",
      "ResultText": "Success"
   },
   "ListNotificationProfileResponseDetail":    {
      "CandidateMatchedQuantity": 1,
      "CandidateReturnedQuantity": 1,
      "NotificationProfileDetail": [      {
         "NotificationProfileID": 4336,
         "NotificationProfileName": "Notification_Profile_Email_01",
         "DeliveryChannelUserPreferenceName": "restDemoPreference",
         "NotificationProfileDescription": "Email Notofication Proile",
         "DeliveryMode": "Email",
         "DeliveryFrequency": "Immediate",
         "DeliveryFormat": "XML",
         "NotificationProfileStatusText": "Active",
         "StopDeliveryIndicator": false,
         "NotificationProfileCreatedDate": {"$": "2016-12-01"},
         "InquiryReferenceText": {"CustomerReferenceText": ["Notification_Profile_Email_01"]},
         "DisplaySequence": 1
      }]
   }
}}
Name Characteristics
ListNotificationProfileResponse Aggregate
ListNotificationProfileResponse@xsi:schemaLocation Attribute
ListNotificationProfileResponse { TransactionDetail Aggregate, Required

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

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

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

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

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

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

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

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

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

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

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

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

Text that explains the outcome of the transaction.

ListNotificationProfileResponse { TransactionResult { ResultMessage Aggregate, Optional (Array)

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.

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

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

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

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { 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.

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail Aggregate, Optional (Array)
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileID int, Required

A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS.

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required

A name that is provided by the user to the profile.

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryChannelUserPreferenceName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileDescription string up to 256 chars., Optional

A string that records the description of the profile

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryMode DeliveryModeEnum, Required

Possible values: Email; HTTPCallBack; MQOutput

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryFrequency DeliveryFrequencyEnum, Required

Possible values: Immediate; Hourly; Daily; Weekly

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DeliveryFormat DeliveryFormatEnum, Required

Possible values: XML, JSON

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileStatusText NotificationProfileStatusTextEnum, Required

Records the status of the monitoring registration

Possible values: Active; Cancelled

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { StopDeliveryIndicator boolean, Required
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { NotificationProfileCreatedDate date, Required

Records the start date of the date range to list the delivery profiles

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { InquiryReferenceText Aggregate, Optional

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

ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { InquiryReferenceText { 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.

END: ListNotificationProfileResponse } ListNotificationProfileResponseDetail } NotificationProfileDetail } InquiryReferenceText /Aggregate
ListNotificationProfileResponse { ListNotificationProfileResponseDetail { NotificationProfileDetail { DisplaySequence int, Optional

Records the display sequence number of the results

END: ListNotificationProfileResponse } ListNotificationProfileResponseDetail } NotificationProfileDetail /Aggregate
END: ListNotificationProfileResponse } ListNotificationProfileResponseDetail /Aggregate
END: ListNotificationProfileResponse /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: CM002, CM004, CM018, 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.

Feature Notes

Returns the Notification Profiles that match the criteria submitted with the request. If no criteria is specified, all active profiles will be returned.

For each matching item, this feature will return the Notification Profile along with the date it was created.