ListNotificationProfile (SOAP)

This operation -- part of the Monitoring Service -- is a component of the Data Layer/Field Monitoring feature.

A Notification Profile establishes the protocol by which change events should be delivered to customers, and references user preferences setup in the User Service. This is the PUSH component of the Data Field Monitoring feature.

Refer to How to Retrieve Notification Profiles for an overview of this operation.

Authentication, Endpoint & WSDL

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
https://maxcvservices.dnb.com/Monitoring/V{version} WSDL

Request Parameters

The following parameters are accepted by this operation.

Name Characteristics
ListNotificationProfileRequest Aggregate
ListNotificationProfileRequest@ServiceVersionNumber Attribute
ListNotificationProfileRequest@xsi:schemaLocation Attribute
ListNotificationProfileRequest. TransactionDetail Aggregate, Optional

Records information necessary to process this request.

ListNotificationProfileRequest. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional

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

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

ListNotificationProfileRequest. 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: ListNotificationProfileRequest. TransactionDetail /Aggregate
ListNotificationProfileRequest. ListNotificationProfileRequestDetail Aggregate, Required
ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria Aggregate, Optional
ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria. 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.

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

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

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

Possible values: Email; HTTPCallBack; MQOutput

ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria. DeliveryFrequency DeliveryFrequencyEnum, Optional

Possible values: Immediate; Hourly; Daily; Weekly

ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria. DeliveryFormat DeliveryFormatEnum, Optional

Possible values: XML

ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria. NotificationProfileStatusText NotificationProfileStatusTextEnum, Optional

Records the status of the monitoring registration

Possible values: Active; Cancelled

ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria. StopDeliveryIndicator boolean, Optional
ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria. CreatedFromDate date, Optional

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

ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria. CreatedToDate date, Optional

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

ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria. 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.

ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria. 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: ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria. InquiryReferenceText /Aggregate
END: ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileListCriteria /Aggregate
ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileDisplaySpecification Aggregate, Optional
ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileDisplaySpecification. 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

ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileDisplaySpecification. SortDirectionText SortDirectionEnum, Optional

Records the direction of sorting. Possbile values are Ascending, Descending

ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileDisplaySpecification. CandidatePerPageMaximumQuantity int Less than or equal to 1000., Optional

Records the maximum quantity that can be displayed per page

ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileDisplaySpecification. CandidateDisplayStartSequenceNumber int, Optional

Records the Display sequence number of the results

END: ListNotificationProfileRequest. ListNotificationProfileRequestDetail. NotificationProfileDisplaySpecification /Aggregate
END: ListNotificationProfileRequest. ListNotificationProfileRequestDetail /Aggregate
END: ListNotificationProfileRequest /Aggregate

Sample Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mon="http://services.dnb.com/MonitoringServiceV2.0">
   <soapenv:Header>
      <wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken-7" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <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 ServiceVersionNumber="3.0">
         <ListNotificationProfileRequestDetail>
         	<NotificationProfileListCriteria>
         		<CreatedFromDate>2013-08-01</CreatedFromDate>
			<CreatedToDate>2013-08-30</CreatedToDate>
		</NotificationProfileListCriteria>       	               
         </ListNotificationProfileRequestDetail>
      </mon:ListNotificationProfileRequest>
   </soapenv:Body>
</soapenv:Envelope>

Testing / Sandbox

This operation has no additional limits or restrictions in the D&B Direct sandbox (test) environment.

Response Specification

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

Name Characteristics
ListNotificationProfileResponse Aggregate
ListNotificationProfileResponse@ServiceVersionNumber Attribute
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 (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.

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 (Infinite)
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

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

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: CM002, CM004, CM018, SC001-SC009.

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

CreateNotificationProfile (SOAP), UpdateNotificationProfile (SOAP).

Back to Top