CreateNotificationProfile (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.

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
CreateNotificationProfileRequest Aggregate
CreateNotificationProfileRequest@ServiceVersionNumber Attribute
CreateNotificationProfileRequest@xsi:schemaLocation Attribute
CreateNotificationProfileRequest. TransactionDetail Aggregate, Optional

Records information necessary to process this request.

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

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

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

CreateNotificationProfileRequest. 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: CreateNotificationProfileRequest. TransactionDetail /Aggregate
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail Aggregate, Required
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification Aggregate, Required
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. NotificationProfileName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Required

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

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. NotificationProfileDescription string up to 256 chars., Optional

A string that records the description of the profile

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. DeliveryMode DeliveryModeEnum, Required

Possible values: Email; HTTPCallBack; MQOutput

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. DeliveryChannelUserPreferenceName string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. DeliveryFrequency DeliveryFrequencyEnum, Required

Possible values: Immediate; Hourly; Daily; Weekly

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. DeliveryFormat DeliveryFormatEnum, Required

Possible values: XML

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification. StopDeliveryIndicator boolean, Required
END: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. NotificationProfileSpecification /Aggregate
CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. 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.

CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. 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: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail. InquiryReferenceText /Aggregate
END: CreateNotificationProfileRequest. CreateNotificationProfileRequestDetail /Aggregate
END: CreateNotificationProfileRequest /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:CreateNotificationProfileRequest ServiceVersionNumber="3.0">
         <CreateNotificationProfileRequestDetail>
            <NotificationProfileSpecification>
               <NotificationProfileName>MonitoringNotificationProfile-MikeEmail</NotificationProfileName>
               <NotificationProfileDescription>Monitoring Notification Profile using Mike's Email</NotificationProfileDescription>
               <DeliveryMode>Email</DeliveryMode>
               <DeliveryChannelUserPreferenceName>Mike-Email</DeliveryChannelUserPreferenceName>
               <DeliveryFrequency>Immediate</DeliveryFrequency>
               <DeliveryFormat>XML</DeliveryFormat>
               <StopDeliveryIndicator>false</StopDeliveryIndicator>
            </NotificationProfileSpecification>
         </CreateNotificationProfileRequestDetail>
      </mon:CreateNotificationProfileRequest>
   </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
CreateNotificationProfileResponse Aggregate
CreateNotificationProfileResponse@ServiceVersionNumber Attribute
CreateNotificationProfileResponse@xsi:schemaLocation Attribute
CreateNotificationProfileResponse. TransactionDetail Aggregate, Required

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

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

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

CreateNotificationProfileResponse. TransactionDetail. ServiceTransactionID string up to 64 chars., Required

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

CreateNotificationProfileResponse. 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: CreateNotificationProfileResponse. TransactionDetail /Aggregate
CreateNotificationProfileResponse. TransactionResult Aggregate, Required

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

CreateNotificationProfileResponse. TransactionResult. SeverityText string up to 16 chars., Required

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

CreateNotificationProfileResponse. TransactionResult. ResultID string up to 32 chars., Required

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

CreateNotificationProfileResponse. TransactionResult. ResultText string up to 512 chars., Optional

Text that explains the outcome of the transaction.

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

CreateNotificationProfileResponse. TransactionResult. ResultMessage. ResultDescription string up to 512 chars., Required

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

END: CreateNotificationProfileResponse. TransactionResult. ResultMessage /Aggregate
END: CreateNotificationProfileResponse. TransactionResult /Aggregate
CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail Aggregate, Optional
CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. NotificationProfileDetail Aggregate, Required
CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. 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.

CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. 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.

END: CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. NotificationProfileDetail /Aggregate
CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. 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.

CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. 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: CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail. InquiryReferenceText /Aggregate
END: CreateNotificationProfileResponse. CreateNotificationProfileResponseDetail /Aggregate
END: CreateNotificationProfileResponse /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, CM007, CM023, SC001-SC009.

Operation-specific supplemental response code explanations:

CM002 Any schema validation failure (e.g. elements that are mandatory in the schema are not present in the request, Sequence of the element is not matching in the schema, Data type mismatch or Invalid notification Level).
CM007 Delivery Channel User Preference Name is invalid.
CM023 Duplicate Profile Name

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

UpdateNotificationProfile (SOAP), ListNotificationProfile (SOAP)CreatePreference (SOAP).

Back to Top