List Change Notice
Product | D&B Direct 2.0, D&B Direct Onboard |
Product Code(s) | Not Applicable |
Options(s) | None |
Monitoring Available | No |
Interface | REST |
Method | GET |
Format(s) | JSON |
Service | Monitoring |
{version} | 8.0 |
8.0 Released on | February 15, 2019 |
This function allows a customer to retrieve (i.e., PULL) change notices triggered within a specific time frame.
Update History
- October 11, 2019 (ALL SOAP & REST): Fix corrupted special characters issue in list change notices response.
- January 27, 2017 (v8.0 SOAP & REST): Removed note regarding Service Version Number request parameter for List Monitoring Profile and List Change Notice.
- December 9, 2016 (v8.0 SOAP & REST): ServiceVersionNumber response element has been added for List Change Notice.
- August 26, 2016 (v6.1 SOAP & REST): ChangeReasonText response aggregate has been added for List Change Notice to add meaning to change notices.
- August 26, 2016 (v6.1 SOAP & REST): CustomerReferenceText and OrganizationName request elements have been added for List Change Notice.
- January 29, 2016 (v5.0 SOAP & REST): PUSH notifications now include CustomerReferenceText for List Change Notice.
- October 9, 2015 (v4.1 SOAP & REST): The limit of returned candidates is increased from 100 to 1,000 for List Change Notice.
What to do First
Feature Request
IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.
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/V8.0/monitoring/changenotices?ServiceVersionNumber=5.1&TransactionTimestamp=2016-12-15T12%3A11%3A58.784-04%3A00&DUNSNumber=804735132&MonitoringProfileID-1=8932&MonitoringLevel=Level2&GetCountOnlyIndicator=false&SortBasisText-1=DNBProductID&SortDirectionText-1=Ascending&CandidatePerPageMaximumQuantity=10&CandidateDisplayStartSequenceNumber=0 Authorization: <MyToken>
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. |
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. |
OrganizationName-n (up to 10 times) | string, Optional(Up to 10x) OrganizationPrimaryName by which the organization is primarily known / identified in different languages and/or writing scripts. Records matching any of the OrganizationPrimaryName will be returned, when customer provides more than one value in the criteria. |
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. |
ServiceVersionNumber | string up to 10 chars., Optional (Up to 10x) A number that identifies the version of the Service Version for the product being monitored. If the Service Version is not provided in the request, the response will contain results for all the available versions. |
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: True and False. The value TRUE indicates monitoring notification is read. The value FALSE indicates monitoring notification is 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 |
CustomerReferenceText-n (up to 5 times) | string up to 240 chars, Optional A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation. Records matching any of the CustomerReferenceText will be returned, when customer provides more than one value in the criteria. |
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 |
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/changenotices |
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.
{"ListChangeNoticeResponse": { "TransactionDetail": { "ServiceTransactionID": "Id-615b52582b1518002b4c04009a8b8f02-1", "TransactionTimestamp": "2016-12-15T12:11:58.784-04:00" }, "TransactionResult": { "SeverityText": "Information", "ResultID": "CM000", "ResultText": "Success" }, "ListChangeNoticeResponseDetail": { "CandidateMatchedQuantity": 2, "CandidateReturnedQuantity": 2, "ChangeNoticeDetail": [ { "SubjectDetail": { "DUNSNumber": "804735132", "CountryISOAlpha2Code": "US", "OrganizationPrimaryName": [{"OrganizationName": {"$": "Gorman Manufacturing Company, Inc."}}] }, "SubjectCategoryText": "Medium", "LanguageCode": 39, "MonitoringProfileDetail": { "MonitoringProfileID": 8932, "DNBProductID": "DCP_STD", "MonitoringLevel": "Level2" }, "NotificationProfileID": 4336, "ChangeEvent": { "ChangeEventID": 26294558, "ChangeDetectionTimestamp": "2016-12-07T06:01:24.000", "ElementName": "ReliabilityText", "PCMElementXPATHText": "//Organization/EmployeeFigures/IndividualEntityEmployeeDetails[1]/ReliabilityText[@DNBCodeValue=9092]", "Element": [ { "@PCMElementXPATHText": "//Organization/EmployeeFigures/IndividualEntityEmployeeDetails[1]/ReliabilityText[@DNBCodeValue=9092]", "@ChangeType": "ValueChanged", "@OldValue": "Expected", "$": "Actual" }], "ReadChangeEventIndicator": true }, "DisplaySequence": 1 }, { "SubjectDetail": { "DUNSNumber": "804735132", "CountryISOAlpha2Code": "US", "OrganizationPrimaryName": [{"OrganizationName": {"$": "Gorman Manufacturing Company, Inc."}}] }, "SubjectCategoryText": "Medium", "LanguageCode": 39, "MonitoringProfileDetail": { "MonitoringProfileID": 8932, "DNBProductID": "DCP_STD", "MonitoringLevel": "Level2" }, "NotificationProfileID": 4336, "ChangeEvent": { "ChangeEventID": 26294559, "ChangeDetectionTimestamp": "2016-12-07T06:01:24.000", "ElementName": "TotalEmployeeQuantity", "PCMElementXPATHText": "//Organization/EmployeeFigures/IndividualEntityEmployeeDetails[1]/TotalEmployeeQuantity", "Element": [ { "@PCMElementXPATHText": "//Organization/EmployeeFigures/IndividualEntityEmployeeDetails[1]/TotalEmployeeQuantity", "@ChangeType": "ValueChanged", "@OldValue": "999", "$": "110" }], "ReadChangeEventIndicator": true }, "DisplaySequence": 2 } ] } }}
Name | Characteristics |
---|---|
ListChangeNoticeResponse | Aggregate |
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 | dateTime, 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 (Array) 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 | integer, 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 | integer, 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 (Array) |
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 | integer, Required Records the count of read notifications for the input criteria |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { UnreadNoticeCount | integer, Required Records the count of unread notifications for the input criteria |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { NoticeCountSummary { TotalNoticeCount | integer, Required Records the count of total notifications for the input criteria |
End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } NoticeCountSummary | /Aggregate |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail | Aggregate, Optional (Array) |
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 | |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { PrincipalIdentificationNumberDetail @TypeText | |
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 (Array) 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 | |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { SubjectDetail { OrganizationPrimaryName { OrganizationName @LanguageCode | |
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 | integer, 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 { ServiceVersionNumber | string, up to 10 chars, Optional A number that identifies the version of the Service in which the profile is created for the respective product. If Service version was not provided when then the profile was created or subsequently this will be the latest available Service version of the 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 | integer, 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 | dateTime, 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 (Array) |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element @ChangeType | |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element @PCMElementXPATHText | |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { Element @OldValue | |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { ReadChangeEventIndicator | boolean, Required Records the status of the monitoring notification. Possible values are: True and False. The value TRUE indicates monitoring notification is read. The value FALSE indicates monitoring notification is 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 |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText | string, up to 256 chars, Optional |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText @DNBCodeValue | Optional |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { ChangeReasonText @DNBCodeTableNumber | Optional |
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 Possible values: GlobalUltimate; DomesticUltimate; Headquarters; Parent; Branch; Division; Subsidiary |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization { AssociationTypeText @DNBCodeValue | |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { GlobalUltimateOrganization { AssociationTypeText @DNBCodeTableNumber | |
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 Possible values: GlobalUltimate; DomesticUltimate; Headquarters; Parent; Branch; Division; Subsidiary |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { AssociationTypeText @DNBCodeValue | |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerGlobalUltimateOrganization { AssociationTypeText @DNBCodeTableNumber | |
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 Possible values: GlobalUltimate; DomesticUltimate; Headquarters; Parent; Branch; Division; Subsidiary |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { AssociationTypeText @DNBCodeValue | |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { UpwardFamilyMemberOrganization { AssociationTypeText @DNBCodeTableNumber | |
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 Possible values: GlobalUltimate; DomesticUltimate; Headquarters; Parent; Branch; Division; Subsidiary |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { AssociationTypeText @DNBCodeValue | |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { ChangeEvent { LinkageChange { FormerUpwardFamilyMemberOrganization { AssociationTypeText @DNBCodeTableNumber | |
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 (Array) 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 | integer, 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 { InquiryReferenceText | Aggregate |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { InquiryReferenceText { CustomerReferenceText | string, up to 240 characters Text entered by customer for future reference. This field will be used to capture system (Toolkit, etc) specific elements like customer endorsement, or Toolkit account ID. |
End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail } InquiryReferenceText | /Aggregate |
ListChangeNoticeResponse { ListChangeNoticeResponseDetail { ChangeNoticeDetail { DisplaySequence | integer, Optional |
End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail } ChangeNoticeDetail | /Aggregate |
End: ListChangeNoticeResponse } ListChangeNoticeResponseDetail | /Aggregate |
End: ListChangeNoticeResponse | /Aggregate |
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
A copy of the complete data layer in Base64 encoded format may be obtained by using the GetMonitoringProduct operation whenever level 2 monitoring is specified on the initial AddMonitoringRegistration call.