ListChangeNotice (REST)

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

A Change Notice is triggered whenever a data field for the D-U-N-S Number specified in a Monitoring Registration exceeds the thresholds set in the Monitoring Profile. Copies of Change Notices are delivered based on the Notification Profile and may also be retrieved with the ListChangeNotice operation.

Refer to the section "Understanding Change Notices" for some tips and examples.

Authentication & Endpoint

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
GET https://maxcvservices.dnb.com/V{version}/monitoring/changenotices

Request Parameters

The following parameters are accepted by this operation.

Name Characteristics
{version} Element
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.

ChangeEventID-n (up to 10 times) long, Optional(Up to 10x)
DUNSNumber-n (up to 10 times) string up to 9 chars. Pattern: {([0-9]*)}., Optional(Up to 10x)

Records the duns number that is registered for Monitoring.

PrincipalIdentificationNumberTypeCode-n Element
PrincipalIdentificationNumber-n string, Optional

A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual.

MonitoringProfileID-n (up to 10 times) int, Optional(Up to 10x)

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

NotificationProfileID-n (up to 10 times) int, Optional(Up to 10x)

A number that uniquely identifies the delivery preferences that the customer has set for Monitoring Alerts.

SubjectCategoryText-n (up to 3 times) string up to 32 chars., Optional(Up to 3x)

An alphanumeric value identifying the category in which the Customer has classified the subject.

DNBProductID-n (up to 10 times) string up to 64 chars., Optional(Up to 10x)

An alphanumeric string that uniquely identifies this product.

MonitoringLevel MonitoringLevelTextEnum up to 16 chars., Optional

A alphanumeric string which determines the level of details that the customer will receive during a change event

ReadChangeEventIndicator boolean, Optional

Records the status of the monitoring notification. Possible values are: Read and unread

ChangeDetectionFromTimestamp DateTimestamp, Optional

The date and time when this notification has been generated

ChangeDetectionToTimestamp DateTimestamp, Optional

The date and time when this notification has been generated

GetCountOnlyIndicator boolean, Optional

When true (set to 1) this indicates that the count related to the resultset is to be returned in the response. When false (set to 0) this indicates that the details pertaining to result is to be returned in the response.

SortBasisText-n (up to 4 times) ChangeNoticeSortBasisEnum, Optional

Records the list of fields based on which sorting is possible

SortDirectionText-n (up to 4 times) 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

Response Specification

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

Name Characteristics
ListChangeNoticeResponse Aggregate
ListChangeNoticeResponse @ServiceVersionNumber Attribute
ListChangeNoticeResponse { TransactionDetail Aggregate, Required

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

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

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

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

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

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

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

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

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

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

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

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

Text that explains the outcome of the transaction.

ListChangeNoticeResponse { 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.

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

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

End: ListChangeNoticeResponse } TransactionResult } ResultMessage /Aggregate
End: ListChangeNoticeResponse } TransactionResult /Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { CandidateMatchedQuantity int up to 6 digits., Optional

The number of registrations listed as possible matches in the result set based on the search criteria in the Customer/User request.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { CandidateReturnedQuantity int up to 6 digits., Optional

The number of registrations returned in the result set based on the search criteria in the Customer/User request.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary Aggregate, Optional (Infinite)
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Optional

Records the duns number that is registered for Monitoring.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { ReadNoticeCount int, Required

Records the count of read notifications for the input criteria

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { UnreadNoticeCount int, Required

Records the count of unread notifications for the input criteria

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { TotalNoticeCount int, Required

Records the count of total notifications for the input criteria

End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } NoticeCountSummary /Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail Aggregate, Optional (Infinite)
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail Aggregate, Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

Records the duns number that is registered for Monitoring.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { PrincipalIdentificationNumberDetail Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { PrincipalIdentificationNumberDetail @DNBCodeValue Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { PrincipalIdentificationNumberDetail @TypeText Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { PrincipalIdentificationNumberDetail { PrincipalIdentificationNumber string, Optional

A number assigned by an external body or by D&B which either uniquely identifies or helps to identify an individual.

End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } SubjectDetail } PrincipalIdentificationNumberDetail /Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { CountryISOAlpha2Code Aggregate, Required

The two-letter country code, defined in the ISO 3166-1 scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { OrganizationPrimaryName Aggregate, Optional (Infinite)

An entry loop which can repeat multiple times to allow the recording of a single name by which the organization is primarily known / identified in different languages and/or writing scripts.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { OrganizationPrimaryName { OrganizationName string up to 256 chars., Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { OrganizationPrimaryName { OrganizationName @WritingScriptISOAlpha4Code Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { OrganizationPrimaryName { OrganizationName @LanguageCode Attribute
End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } SubjectDetail } OrganizationPrimaryName /Aggregate
End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } SubjectDetail /Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectCategoryText string up to 32 chars., Optional

An alphanumeric value identifying the category in which the Customer has classified the subject.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { LanguageCode integer up to 7 digits., Required

A D&B code value that defines a language in which the specified product is available.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { MonitoringProfileDetail Aggregate, Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { MonitoringProfileDetail { MonitoringProfileID int, Required

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

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { MonitoringProfileDetail { DNBProductID string up to 64 chars., Required

An alphanumeric string that uniquely identifies this product.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { MonitoringProfileDetail { MonitoringLevel MonitoringLevelTextEnum up to 16 chars., Required

A alphanumeric string which determines the level of details that the customer will receive during a change event

End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } MonitoringProfileDetail /Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { NotificationProfileID int, Required

A number that uniquely identifies the delivery preferences that the customer has set for Monitoring Alerts.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent Aggregate, Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { ChangeEventID long, Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { ChangeDetectionTimestamp DateTimestamp, Required

The date and time when this notification has been generated

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { ElementName string up to 64 chars., Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { PCMElementXPATHText string up to 3000 chars., Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element _, Optional (Infinite)
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element @ChangeType Attribute
Possible values: Dropped; NewlyAdded; NoChange; ValueChanged
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element @PCMElementXPATHText Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element @OldValue Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { ReadChangeEventIndicator boolean, Required

Records the status of the monitoring notification. Possible values are: Read and unread

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeType string, Required
Possible values: Add, Drop.
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText string up to 256 chars., Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText@DNBCodeValue Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText@DNBCodeTableNumber Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization { AssociationTypeText string up to 256 chars., Optional

Text that defines the nature of the relationship of the linked organization to the business subject, e.g., Parent, HQ, Joint Parent

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization { AssociationTypeText@DNBCodeValue Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization { AssociationTypeText@DNBCodeTableNumber Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S).

END: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } ChangeEvent } LinkageChange } GlobalUltimateOrganization /Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { AssociationTypeText string up to 256 chars., Optional

Text that defines the nature of the relationship of the linked organization to the business subject, e.g., Parent, HQ, Joint Parent

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { AssociationTypeText@DNBCodeValue Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { AssociationTypeText@DNBCodeTableNumber Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S).

END: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } ChangeEvent } LinkageChange } FormerGlobalUltimateOrganization /Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { AssociationTypeText string up to 256 chars., Optional

Text that defines the nature of the relationship of the linked organization to the business subject, e.g., Parent, HQ, Joint Parent

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { AssociationTypeText@DNBCodeValue Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { AssociationTypeText@DNBCodeTableNumber Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S).

END: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } ChangeEvent } LinkageChange } UpwardFamilyMemberOrganization /Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization Aggregate, Optional
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { AssociationTypeText string up to 256 chars., Optional

Text that defines the nature of the relationship of the linked organization to the business subject, e.g., Parent, HQ, Joint Parent

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { AssociationTypeText@DNBCodeValue Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { AssociationTypeText@DNBCodeTableNumber Attribute
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { DUNSNumber string up to 9 chars. Pattern: {([0-9]*)}., Required

The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S).

END: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } ChangeEvent } LinkageChange } FormerUpwardFamilyMemberOrganization /Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChildrenSummary Aggregate, Optional (Infinite)

An entry loop which can repeat multiple times to allow the recording of the number of children of various types for the Subject.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChildrenSummary { ChildrenQuantity int up to 8 digits., Optional

The total number of children of the linked Family Tree Subject of the type specified by Children Type Text.

ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChildrenSummary { DirectChildrenIndicator boolean, Optional

When true (set to 1)it indicates immediate children only.

END: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } ChangeEvent } LinkageChange } ChildrenSummary /Aggregate
END: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } ChangeEvent } LinkageChange /Aggregate
End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } ChangeEvent /Aggregate
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { DisplaySequence int, Optional
End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail /Aggregate
End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail /Aggregate
End: ListChangeNoticeResponse /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
Back to Top