List Notification Profile
| Product | D&B Direct 2.0 |
| Product Code(s) | Not Applicable |
| Options(s) | None |
| Monitoring Available | No |
| Interface | REST |
| Method | GET |
| Format(s) | JSON |
| Service | Monitoring |
| {version} | 4.2 |
| 4.2 Released on | October 23, 2015 |
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 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
GET https://direct.dnb.com/V4.2/monitoring/notificationprofiles?DeliveryFormat=XML&DeliveryMode=Email&CandidatePerPageMaximumQuantity=10&DeliveryChannelUserPreferenceName=John-updatedemail 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. |
| 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. |
| 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 | 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.
{"ListNotificationProfileResponse": {
"@ServiceVersionNumber": "4.0",
"TransactionDetail": {
"ServiceTransactionID": "Id-d8ed8c5852447d5f030bffff-1",
"TransactionTimestamp": "2013-09-26T14:30:55.760-04:00"
},
"TransactionResult": {
"SeverityText": "Information",
"ResultID": "CM000",
"ResultText": "Success"
},
"ListNotificationProfileResponseDetail": {
"CandidateMatchedQuantity": 1,
"CandidateReturnedQuantity": 1,
"NotificationProfileDetail": [ {
"NotificationProfileID": 704,
"NotificationProfileName": "Notification_Profile_Email_01",
"DeliveryChannelUserPreferenceName": "John-updatedemail",
"NotificationProfileDescription": "Email Notofication Proile",
"DeliveryMode": "Email",
"DeliveryFrequency": "Immediate",
"DeliveryFormat": "XML",
"NotificationProfileStatusText": "Active",
"StopDeliveryIndicator": false,
"NotificationProfileCreatedDate": {"$": "2013-09-26"},
"InquiryReferenceText": {"CustomerReferenceText": ["Notification_Profile_Email_01"]},
"DisplaySequence": 1
}]
}
}}
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.