Update Monitoring Profile
Product | D&B Direct 2.0, D&B Direct Onboard |
Product Code(s) | Not Applicable |
Option(s) | None |
Monitoring Available | No |
Interface | SOAP |
WSDL | download |
Format(s) | XML |
Service | Monitoring |
Operation | UpdateMonitoringProfile |
{version} | 6.1 |
6.1 Released on | July 15, 2016 |
This function allows a customer to update or cancel an active monitoring profile.
Update History
- August 26, 2016 (vALL SOAP & REST): Multicondition for Create Monitoring Profile and Update Monitoring Profile now supports up to 10 change conditions.
- July 15, 2016 (v6.1 SOAP & REST)): New multi-condition values, ValueBecomesNULL and ValueBecomesNOTNULL, have been added for create monitoring profile and update monitoring profile.
- April 22, 2016 (v6.0 SOAP &REST): Changed the current implementation on the conditions, Value Goes Beyond and Value Goes Below, based on the ContinuousChangeNotificationIndicator. This establishes the following features: If ContinuousChangeNotificationIndicator is set to TRUE (by default), change notices are sent when the new value is less than or greater than the customer threshold. If ContinuousChangeNotificationIndicator is set to FALSE, change notices are sent only when the new value crosses through the customer threshold range relative to the former value.
- March 11, 2016 (v6.0 SOAP & REST)): Multiple conditions may now be specified for any one particular element in create monitoring profile and update monitoring profile. This feature is applicable for any monitorable numeric element.
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
Monitoring Profiles can be removed by setting the status to "Cancelled"; however, if the profile is referenced in a Monitoring Registration it may not be removed.
<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>Username</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">Password</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <mon:UpdateMonitoringProfileRequest ServiceVersionNumber="4.0"> <UpdateMonitoringProfileRequestDetail> <MonitoringProfileDetail> <MonitoringProfileID>862</MonitoringProfileID> </MonitoringProfileDetail> <MonitoringProfileUpdateSpecification> <MonitoringProfileStatusText>Cancelled</MonitoringProfileStatusText> </MonitoringProfileUpdateSpecification> </UpdateMonitoringProfileRequestDetail> </mon:UpdateMonitoringProfileRequest> </soapenv:Body> </soapenv:Envelope>
Name | Characteristics |
---|---|
UpdateMonitoringProfileRequest | Aggregate |
UpdateMonitoringProfileRequest @ServiceVersionNumber | |
UpdateMonitoringProfileRequest @xsi:schemaLocation | |
UpdateMonitoringProfileRequest. TransactionDetail | Aggregate, Optional Records information necessary to process this request. |
UpdateMonitoringProfileRequest. TransactionDetail. ApplicationTransactionID | string, up to 64 chars, Optional A number assigned by the calling application to uniquely identify this request. |
UpdateMonitoringProfileRequest. TransactionDetail. TransactionTimestamp | dateTime, 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. |
UpdateMonitoringProfileRequest. 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: UpdateMonitoringProfileRequest. TransactionDetail | /Aggregate |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail | Aggregate, Required |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileDetail | Aggregate, Required |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. 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. |
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileDetail | /Aggregate |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification | Aggregate, Required |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringProfileName | string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional A name that is provided by the user to the profile. |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail | Aggregate, Optional |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement | Aggregate, Required (Infinite) |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement. PCMElementXPATHText | string, up to 3000 chars, Required |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges | Aggregate, Required (Infinite) |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeCondition | ChangeConditionEnum, Required Criteria to monitor an element.
Possible values: AnyChange; ValueIncreaseByPercentage; ValueDecreaseByPercentage; ValueChangeByPercentage; ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals; MultiCondition, ValueBecomesNULL, ValueBecomesNOTNULL The Continuous Change Notification Indicator is considered for values: ValueGoesBeyond and ValueGoesBelow. Refer to the MultiCondition table for more details. |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeValue | string, up to 3000 chars., Optional Threshold value corresponding to monitoring criteria. |
CreateMonitoringProfileRequest. CreateMonitoringProfileRequestDetail. MonitoringProfileSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ContinuousChangeNotificationIndicator | boolean, Optional When 'true' (default), change notices are sent when the new value is less than or greater than the customer threshold. When 'false', change notices are sent only when the new value crosses through the customer threshold range relative to the former value. |
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement. MonitoringChanges | /Aggregate |
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail. MonitoringElement | /Aggregate |
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringElementDetail | /Aggregate |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. MonitoringProfileStatusText | MonitoringProfileStatusTextEnum, Optional Records the status of the monitoring profile Possible values: Active; Cancelled |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. ReturnChangedDataOnlyIndicator | boolean When 'true' indicates that Change Notices will only include information for fields whose value has changed. When 'false' indicates that Change Notices will include information for all fields, regardless if the values have changed. The latter scenario applies when a whole data layer and/or aggregate is being monitored. |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. 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. |
UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. 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: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification. InquiryReferenceText | /Aggregate |
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail. MonitoringProfileUpdateSpecification | /Aggregate |
END: UpdateMonitoringProfileRequest. UpdateMonitoringProfileRequestDetail | /Aggregate |
END: UpdateMonitoringProfileRequest | /Aggregate |
Deleting a Profile
To remove a profile, change the status to "Cancelled" through an update request. Canceled items can be restored within 24-hours of the update, after which they are deleted by the system.
<MonitoringProfileUpdateSpecification>
<MonitoringProfileStatusText>Cancelled</MonitoringProfileStatusText>
</MonitoringProfileUpdateSpecification>
Endpoint
Use the following endpoint with the downloadable WSDL to request this feature.
SOAP (Monitoring) |
---|
https://direct.dnb.com/Monitoring/V{version} |
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
Specification
The following is a list of the possible data fields returned by this operation in the XML 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.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <ns2:UpdateMonitoringProfileResponse ServiceVersionNumber="4.0" xmlns:ns2="http://services.dnb.com/MonitoringServiceV2.0" xmlns:ns3="http://services.dnb.com/TransactionFaultV2.0"> <TransactionDetail> <ServiceTransactionID>Id-9f48080a542c1ef00f7b742e-1</ServiceTransactionID> <TransactionTimestamp>2014-10-01T11:34:08.579-04:00</TransactionTimestamp> </TransactionDetail> <TransactionResult> <SeverityText>Information</SeverityText> <ResultID>CM000</ResultID> <ResultText>Success</ResultText> </TransactionResult> <UpdateMonitoringProfileResponseDetail> <MonitoringProfileDetail> <MonitoringProfileID>862</MonitoringProfileID> <MonitoringProfileStatusText>Cancelled</MonitoringProfileStatusText> <FormerMonitoringProfileDetail> <MonitoringProfileName>ATLAS_DCP_STD</MonitoringProfileName> <MonitoringElementDetail> <MonitoringElement> <PCMElementXPATHText>//Organization/OrganizationDetail/StandaloneOrganizationIndicator</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/OrganizationName/OrganizationPrimaryName/OrganizationName</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/RegistrationIssuerName</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/OrganizationDetail/ControlOwnershipTypeText</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/OrganizationDetail/ControlOwnershipDate</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/Financial/KeyFinancialFiguresOverview/SalesRevenueAmount</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/EmployeeFigures/IndividualEntityEmployeeDetails/TotalEmployeeQuantity</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/EmployeeFigures/IndividualEntityEmployeeDetails/ReliabilityText@DNBCodeValue</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/EmployeeFigures/ConsolidatedEmployeeDetails/TotalEmployeeQuantity</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/EmployeeFigures/ConsolidatedEmployeeDetails/ReliabilityText@DNBCodeValue</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/EmployeeFigures/ConsolidatedEmployeeDetails/EmployeeCategoryDetails/EmployeeBasisText@DNBCodeValue</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/ActivitiesAndOperations/SubjectIsAgentDetails/AgentIndicator</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/ActivitiesAndOperations/ImportDetails/ImportIndicator</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/ActivitiesAndOperations/ExportDetails/ExportIndicator</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/SubjectHeader/LastUpdateDate</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/SocioEconomicIdentification/SmallBusinessIndicator</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/SocioEconomicIdentification/MinorityOwnedIndicator</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/SocioEconomicIdentification/LaborSurplusAreaIndicator</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/StartDate</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/Financial/KeyFinancialFiguresOverview/TotalEquityAmount</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/RegistrationIssuerDUNSNumber</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/OrganizationIdentificationNumber</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/FilingOrganizationName</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/AssignmentMethodText</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/OrganizationDetail/OrganizationStartYear</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/FinancialAssetArticle/AssetArticleSummary/AssetTypeText@DNBCodeValue</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/FinancialAssetArticle/AssetArticleSummary/AssetArticleQuantity</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/Financial/KeyFinancialFiguresOverview/StatementHeaderDetails/FinancialStatementToDate</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/Linkage/HeadquartersOrganization/DUNSNumber</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/OrganizationDetail/OperatingStatusText@DNBCodeValue</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/OrganizationName/FormerOrganizationPrimaryName@RegisteredNameIndicator/OrganizationName</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/SubjectHeader/MarketabilityIndicator</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/SubjectHeader/NonMarketableReasonText@DNBCodeValue</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/SubjectHeader/OrganizationSummaryText</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/RegisteredDetail/IncorporationYear</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/EmployeeFigures/EmployeeQuantityGrowthRate</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/Financial/KeyFinancialFiguresOverview/EmployeeQuantityGrowthRate</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> <ChangeValue>null</ChangeValue> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/Location/PrimaryAddress</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/Location/MailingAddress</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/Telecommunication</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/SubjectHeader/TransferDUNSNumberRegistration</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/RegisteredDetail/OrganizationIdentificationNumberDetail@DNBCodeValue/RegistrationLocation/PrimaryAddress</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/RegisteredDetail/StockExchangeDetails</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/IndustryCode/IndustryCode@DNBCodeValue</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/ActivitiesAndOperations/LineOfBusinessDetails</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/PrincipalsAndManagement/CurrentPrincipal</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/PrincipalsAndManagement/MostSeniorPrincipal</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/SocioEconomicIdentification/OwnershipEthnicity</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/OrganizationDetail/FamilyTreeMemberRole</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/ThirdPartyAssessment/ThirdPartyAssessment</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/OrganizationName/TradeStyleName</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> <MonitoringElement> <PCMElementXPATHText>//Organization/Financial/FinancialStatement</PCMElementXPATHText> <MonitoringChanges> <ChangeCondition>AnyChange</ChangeCondition> </MonitoringChanges> </MonitoringElement> </MonitoringElementDetail> <MonitoringProfileStatusText>Active</MonitoringProfileStatusText> <InquiryReferenceText> <CustomerReferenceText>ATLAS_DCP_STD</CustomerReferenceText> <CustomerReferenceText>ATLAS_DCP_STD</CustomerReferenceText> </InquiryReferenceText> </FormerMonitoringProfileDetail> </MonitoringProfileDetail> </UpdateMonitoringProfileResponseDetail> </ns2:UpdateMonitoringProfileResponse> </soap:Body> </soapenv:Envelope>
Name | Characteristics |
---|---|
UpdateMonitoringProfileResponse | Aggregate |
UpdateMonitoringProfileResponse @ServiceVersionNumber | |
UpdateMonitoringProfileResponse @xsi:schemaLocation | |
UpdateMonitoringProfileResponse. TransactionDetail | Aggregate, Required Records information necessary to process a particular request. Examples of a request is the ordering of a product. |
UpdateMonitoringProfileResponse. TransactionDetail. ApplicationTransactionID | string, up to 64 chars, Optional A number assigned by the calling application to uniquely identify this request. |
UpdateMonitoringProfileResponse. TransactionDetail. ServiceTransactionID | string, up to 64 chars, Required A number assigned by the D&B service to uniquely identify this transaction. |
UpdateMonitoringProfileResponse. 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: UpdateMonitoringProfileResponse. TransactionDetail | /Aggregate |
UpdateMonitoringProfileResponse. TransactionResult | Aggregate, Required An aggregate that can repeat multiple times to record the different outcomes of the transaction. |
UpdateMonitoringProfileResponse. TransactionResult. SeverityText | string, up to 16 chars, Required Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal. |
UpdateMonitoringProfileResponse. TransactionResult. ResultID | string, up to 32 chars, Required An alphanumeric string that uniquely identifies the outcome of the transaction. |
UpdateMonitoringProfileResponse. TransactionResult. ResultText | string, up to 512 chars, Optional Text that explains the outcome of the transaction. |
UpdateMonitoringProfileResponse. 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. |
UpdateMonitoringProfileResponse. TransactionResult. ResultMessage. ResultDescription | string, up to 512 chars, Required Text that describes the additional information regarding the outcome of the transaction. |
END: UpdateMonitoringProfileResponse. TransactionResult. ResultMessage | /Aggregate |
END: UpdateMonitoringProfileResponse. TransactionResult | /Aggregate |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail | Aggregate, Optional |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail | Aggregate, Optional |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. 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. |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringProfileName | string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Required A name that is provided by the user to the profile. |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail | Aggregate, Optional |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement | Aggregate, Required (Infinite) |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. PCMElementXPATHText | string, up to 3000 chars, Required |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges | Aggregate, Required (Infinite) |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeCondition | ChangeConditionEnum, Required Criteria to monitor an element.
Possible values: AnyChange; ValueIncreaseByPercentage; ValueDecreaseByPercentage; ValueChangeByPercentage; ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals; MultiCondition Refer to the MultiCondition table for more details. |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeValue | string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional |
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges | /Aggregate |
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail. MonitoringElement | /Aggregate |
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringElementDetail | /Aggregate |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. MonitoringProfileStatusText | MonitoringProfileStatusTextEnum, Optional Records the status of the monitoring profile Possible values: Active; Cancelled |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. 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. |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. 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: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. InquiryReferenceText | /Aggregate |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail | Aggregate, Optional |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringProfileName | string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional A name that is provided by the user to the profile. |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail | Aggregate, Optional |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement | Aggregate, Required (Infinite) |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. PCMElementXPATHText | string, up to 3000 chars, Required |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges | Aggregate, Required (Infinite) |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeCondition | ChangeConditionEnum, Required Possible values: AnyChange; ValueIncreaseByPercentage; ValueDecreaseByPercentage; ValueChangeByPercentage; ValueIncreaseBy; ValueDecreaseBy; ValueChangeBy; ValueGoesBeyond; ValueGoesBelow; ValueEquals; DateChangeBy; DateEquals; MultiCondition |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges. ChangeValue | string, at least 1 char, up to 64 chars Pattern: {*[^\s]*}, Optional |
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement. MonitoringChanges | /Aggregate |
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail. MonitoringElement | /Aggregate |
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringElementDetail | /Aggregate |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. MonitoringProfileStatusText | MonitoringProfileStatusTextEnum, Optional Records the status of the monitoring profile Possible values: Active; Cancelled |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. ReturnChangedDataOnlyIndicator | boolean When 'true' indicates that Change Notices will only include information for fields whose value has changed. When 'false' indicates that Change Notices will include information for all fields, regardless if the values have changed. The latter scenario applies when a whole data layer and/or aggregate is being monitored. |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. 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. |
UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. 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: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail. InquiryReferenceText | /Aggregate |
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail. FormerMonitoringProfileDetail | /Aggregate |
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail. MonitoringProfileDetail | /Aggregate |
END: UpdateMonitoringProfileResponse. UpdateMonitoringProfileResponseDetail | /Aggregate |
END: UpdateMonitoringProfileResponse | /Aggregate |
NOTE: There may be additional request and/or response elements specified in the WSDL that are not applicable for D&B Direct customers. Data elements that are not listed on this page are currently unused by this operation.
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: CM001, CM002, CM004, CM007, CM023, MN001, MN004, 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.
Operation-specific supplemental response code explanations:
CM001 | Profile name is sent as blank; or Blank value passed for PCMElementXpath. |
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 | Monitoring profile cannot be canceled as registrations are available for this profile; Monitoring profile ID not available in the system; Invalid Change Value (Alert threshold); or PCMElementXpath does not belong to the Product. |
CM023 | Duplicate Profile Name |
CM001 | Given expression is invalid if specified operator is wrong in the expression. |
CM001 | Given expression is invalid if specified operant is wrong in the expression. |
CM001 | Given expression is invalid if specified brace is wrong in the expression. |
CM001 | Given expression is invalid if the number of operators given in the multi-condition exceeds the limit. |
Feature Notes
Here are some constraints of the <ChangeCondition> component in the Monitoring profile.
- Profiles may have a single change condition or multiple change conditions per element.
- The default condition for any element is AnyChange
- <ChangeValue> values should match the data type of the element being monitored
The following table highlights the condition options applicable for each data type:
Data type | Supported change condition |
---|---|
String | AnyChange |
Numeric | AnyChange |
String | ValueEquals |
Numeric | ValueEquals |
Numeric | ValueIncreaseByPercentage |
Numeric | ValueDecreaseByPercentage |
Numeric | ValueChangeByPercentage |
Numeric | ValueIncreaseBy |
Numeric | ValueDecreaseBy |
Numeric | ValueChangeBy |
Numeric | ValueGoesBeyond |
Numeric | ValueGoesBelow |
Boolean | AnyChange |
Date | AnyChange |
Date | DateChangeBy |
Date | DateEquals |
EnumString | AnyChange |
EnumString | ValueEquals |
Multiple Conditions
Multiple conditions may be specified for any one element, currently restricted to up to ten conditions. Multiple conditions may not be combined. The following operators support multicondition scenarios.
NOTE: Some of the following operators support single condition scenarios, as well as, multicondition scenarios.
Supported Operators
Operators | Description | Data Types Supported | Operands Supported |
---|---|---|---|
AND, And, and | AND condition | ||
OR, Or, or | OR condition | ||
= | equal to | Numeric/ String | element |
!= | not equal to | Numeric | element |
< | less than | Numeric | element |
> | greater than | Numeric | element |
<= | less than or equal to | Numeric | element |
>= | greater than or equal to | Numeric | element |
ValueIncreaseByPercentage | ValueIncreaseByPercentage | Numeric | element |
ValueIncreaseByPercentage | ValueDecreaseByPercentage | Numeric | element |
ValueIncreaseByPercentage | ValueChangeByPercentage | Numeric | element |
ValueIncreaseBy | ValueIncreaseBy | Numeric | element |
ValueDecreaseBy | ValueDecreaseBy | Numeric | element |
ValueChangeBy | ValueChangeBy | Numeric | element |
ValueGoesBeyond | ValueGoesBeyond | Numeric | element |
ValueGoesBelow | ValueGoesBelow | Numeric | element |
ValueEquals | ValueEquals | Numeric/ String | element, elementPrevious |
ValueBecomesNull | ValueBecomesNull | Numeric/ String | element |
ValueBecomesNotNull | ValueBecomesNotNull | Numeric/ String | element |
Supported Operands
Operators | Description | Data Types Supported |
---|---|---|
element | Represents the new value of the element after the change | Numeric, string |
elementPrevious | Represents the previous value of the element before the change | String |
Sample Multicondition Expression
Example | Operators | Operands |
---|---|---|
((element > 25) AND (element < 100)) | >, < | element, 25, 100 |
An error code will be returned in the event that a given expression is invalid in the request.