List Notification Profile

This function allows a customer to review active notification profiles.

What to do First

• Create Notification Profiles

Feature Request

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

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mon="http://services.dnb.com/MonitoringServiceV2.0">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken-633F699FC36627C15514785038369061">
            <wsse:Username>MyUserName</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">MyPassword</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
    <mon:ListNotificationProfileRequest>
         <ListNotificationProfileRequestDetail>
            <NotificationProfileListCriteria>
            </NotificationProfileListCriteria>
            <NotificationProfileDisplaySpecification>
               <CandidatePerPageMaximumQuantity>2</CandidatePerPageMaximumQuantity>
               <CandidateDisplayStartSequenceNumber>1</CandidateDisplayStartSequenceNumber>
            </NotificationProfileDisplaySpecification>
         </ListNotificationProfileRequestDetail>
      </mon:ListNotificationProfileRequest>
   </soapenv:Body>
</soapenv:Envelope>

Endpoint

Use the following endpoint with the downloadable WSDL to request this feature.

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

Specification

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soap-env:Body xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/">
      <mon:ListNotificationProfileResponse xmlns:mon="http://services.dnb.com/MonitoringServiceV2.0">
         <TransactionDetail>
            <ServiceTransactionID>Id-81e23f580adb0000d5cb040093abf75d-1</ServiceTransactionID>
            <TransactionTimestamp>2016-12-01T03:42:41.101-05:00</TransactionTimestamp>
         </TransactionDetail>
         <TransactionResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
         </TransactionResult>
         <ListNotificationProfileResponseDetail>
            <CandidateMatchedQuantity>99</CandidateMatchedQuantity>
            <CandidateReturnedQuantity>2</CandidateReturnedQuantity>
            <NotificationProfileDetail>
               <NotificationProfileID>4336</NotificationProfileID>
               <NotificationProfileName>PreferenceDemo01</NotificationProfileName>
               <DeliveryChannelUserPreferenceName>PreferenceDemo01</DeliveryChannelUserPreferenceName>
               <NotificationProfileDescription>PreferenceDemo01</NotificationProfileDescription>
               <DeliveryMode>Email</DeliveryMode>
               <DeliveryFrequency>Immediate</DeliveryFrequency>
               <DeliveryFormat>JSON</DeliveryFormat>
               <NotificationProfileStatusText>Active</NotificationProfileStatusText>
               <StopDeliveryIndicator>false</StopDeliveryIndicator>
               <NotificationProfileCreatedDate>2016-12-01</NotificationProfileCreatedDate>
               <InquiryReferenceText>
                  <CustomerReferenceText>V7notificationprofile</CustomerReferenceText>
               </InquiryReferenceText>
               <DisplaySequence>1</DisplaySequence>
            </NotificationProfileDetail>
            <NotificationProfileDetail>
               <NotificationProfileID>4333</NotificationProfileID>
               <NotificationProfileName>V7notificationprofile</NotificationProfileName>
               <DeliveryChannelUserPreferenceName>RaIn</DeliveryChannelUserPreferenceName>
               <NotificationProfileDescription>V7notificationprofile</NotificationProfileDescription>
               <DeliveryMode>Email</DeliveryMode>
               <DeliveryFrequency>Immediate</DeliveryFrequency>
               <DeliveryFormat>JSON</DeliveryFormat>
               <NotificationProfileStatusText>Active</NotificationProfileStatusText>
               <StopDeliveryIndicator>false</StopDeliveryIndicator>
               <NotificationProfileCreatedDate>2016-11-30</NotificationProfileCreatedDate>
               <InquiryReferenceText>
                  <CustomerReferenceText>V7notificationprofile</CustomerReferenceText>
               </InquiryReferenceText>
               <DisplaySequence>2</DisplaySequence>
            </NotificationProfileDetail>
         </ListNotificationProfileResponseDetail>
      </mon:ListNotificationProfileResponse>
   </soap-env:Body>
</soapenv:Envelope>

NOTE: There may be additional request and/or response elements specified in the WSDL that are not applicable for D&B Direct customers. Data elements that are not listed on this page are currently unused by this operation.

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.

• © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.