List Monitoring Profile
| Product | D&B DirectOnboard, 2.0 |
| Product Code(s) | Not Applicable |
| Option(s) | None |
| Monitoring Available | No |
| Interface | SOAP |
| WSDL | download |
| Format(s) | XML |
| Service | Monitoring |
| Operation | ListMonitoringProfile |
| {version} | 8.0 |
| 8.0 Released on | February 15, 2019 |
This function allows a customer to review active monitoring profiles.
Update History
- April 21, 2017 (vALL SOAP & REST): Version 8.0 is now available. Added ReturnSignificantChangeOnlyIndicator as a request element to Create, and Update Monitoring Profile features, and as a response element to List Monitoring Profile feature.
- January 27, 2017 (v8.0 SOAP & REST): Removed note regarding Service Version Number request parameter for List Monitoring Profile and List Change Notice.
What to do First
Feature Request
IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.
Overview
There are several options available when implementing this (Undefined variable: DnB API Globals.API Name) feature.
1. Basic Retrieve: If a Profile ID (the value returned when a profile is created) is provided to the List operation, a single profile will be returned.
2. Search by Name: When a profile is created, a customer supplied name is assigned. Searching by the profile name (case-sensitive, no wildcards) is available.
3. List by Product: Monitoring is performed at the product level, and a product ID is specified when a profile is created. The results may be filtered by product ID.
4. Level Filter: The Monitoring feature offers two levels of change notices: Level Two provides the notice with a copy of the product data attached; Level One only provides the notice. The results may be filtered by the level.
5. Date Range: The results can be narrowed by supplying a start and end date range which is compared against the date a profile was created.
6. Status Filter: Profiles that are assigned a status of "Cancelled" remain in the Monitoring system for 24 hours before being deleted. The results may be limited to a specific status.
7. Customer Reference Text: When a profile is created, a free form (240 character) field may be supplied. This field may be used in the List operation; however, it is case-sensitive and there are no wildcard options.
8. Sorting Results: By default, the results will be ascending by ???. Optionally, both the sort direction and a primary sort field can be designated on the request.
Sort field options include: DNBProductID, MonitoringProfileID, MonitoringProfileName, MonitoringLevel, MonitoringProfileStatusText, MonitoringProfileCreatedDate.
9. Pagination: Options exist to designate the maximum number of records per request, and the starting row number. The maximum number of records this feature will return on a single request is 1,000.
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
<soapenv:Envelope xmlns:mon="http://services.dnb.com/MonitoringServiceV2.0" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Header>
<wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-E68F8433964587733514782495599551">
<wsse:Username>MyUserName</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">MyPassword</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<mon:ListMonitoringProfileRequest>
<TransactionDetail>
<ApplicationTransactionID>QA_ListMonitoringProfile_V8.0</ApplicationTransactionID>
<TransactionTimestamp>2016-11-04T08:52:39.897Z</TransactionTimestamp>
</TransactionDetail>
<ListMonitoringProfileRequestDetail>
<MonitoringProfileListCriteria>
<MonitoringProfileID>8932</MonitoringProfileID>
<ServiceVersionNumber>5.1</ServiceVersionNumber>
<MonitoringProfileStatusText>Active</MonitoringProfileStatusText>
</MonitoringProfileListCriteria>
<MonitoringProfileDisplaySpecification>
<SortBasisText>MonitoringProfileID</SortBasisText>
<SortDirectionText>Ascending</SortDirectionText>
<CandidatePerPageMaximumQuantity>1000</CandidatePerPageMaximumQuantity>
<CandidateDisplayStartSequenceNumber>1</CandidateDisplayStartSequenceNumber>
</MonitoringProfileDisplaySpecification>
</ListMonitoringProfileRequestDetail>
</mon:ListMonitoringProfileRequest>
</soapenv:Body>
</soapenv:Envelope>
| Name | Characteristics |
|---|---|
| ListMonitoringProfileRequest | Aggregate |
| ListMonitoringProfileRequest@xsi:schemaLocation | Attribute |
| ListMonitoringProfileRequest. TransactionDetail | Aggregate, Optional Records information necessary to process this request. |
| ListMonitoringProfileRequest. TransactionDetail. ApplicationTransactionID | string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. |
| ListMonitoringProfileRequest. TransactionDetail. TransactionTimestamp | DateTimestamp, Optional The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. |
| END: ListMonitoringProfileRequest. TransactionDetail | /Aggregate |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail | Aggregate, Required |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria | Aggregate, Optional |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. MonitoringProfileName | string at least 1 chars. up to 64 chars. Pattern: {.*[^\s].*}., Optional A name that is provided by the user to the profile. |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. MonitoringProfileID | int, Optional A number that uniquely identifies a set of events and their thresholds, used to monitor a DUNS or a set of DUNS. |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. DNBProductID | string up to 64 chars., Optional Records the product code that is provided by the customer to create a profile |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. ServiceVersionNumber | string up to 10 chars., Optional A number that identifies the version of the Service 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. |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. 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 Possible values: Level1; Level2 |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. CreatedFromDate | date, Optional Records the start date of the date range to list the monitoring profiles |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. CreatedToDate | date, Optional Records the enddate of the date range to list the monitoring profiles |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. MonitoringProfileStatusText | MonitoringProfileStatusTextEnum, Optional Records the status of the monitoring profile Possible values: Active; Cancelled |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. 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. |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. 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: ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria. InquiryReferenceText | /Aggregate |
| END: ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileListCriteria | /Aggregate |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification | Aggregate, Optional |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification. SortBasisText | MonitoringProfileSortBasisEnum, Optional Records the list of fields based on which sorting is possible Possible values: DNBProductID; MonitoringProfileID; MonitoringProfileName; MonitoringLevel; MonitoringProfileStatusText; MonitoringProfileCreatedDate |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification. SortDirectionText | SortDirectionEnum, Optional Records the direction of sorting. Possbile values are Ascending, Descending Possible values: Ascending/Descending |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification. CandidatePerPageMaximumQuantity | int Less than or equal to 1000., Optional Records the maximum quantity that can be displayed per page |
| ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification. CandidateDisplayStartSequenceNumber | int, Optional Records the Display sequence number of the results |
| END: ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail. MonitoringProfileDisplaySpecification | /Aggregate |
| END: ListMonitoringProfileRequest. ListMonitoringProfileRequestDetail | /Aggregate |
| END: ListMonitoringProfileRequest | /Aggregate |
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:ListMonitoringProfileResponse xmlns:ns2="http://services.dnb.com/MonitoringServiceV2.0" xmlns:ns3="http://services.dnb.com/TransactionFaultV2.0">
<TransactionDetail>
<ServiceTransactionID>Id-16e2e558670200008fb405000b65e3c2-1</ServiceTransactionID>
<TransactionTimestamp>2017-04-06T02:37:10.702-04:00</TransactionTimestamp>
</TransactionDetail>
<TransactionResult>
<SeverityText>Information</SeverityText>
<ResultID>CM000</ResultID>
<ResultText>Success</ResultText>
</TransactionResult>
<ListMonitoringProfileResponseDetail>
<CandidateMatchedQuantity>5</CandidateMatchedQuantity>
<CandidateReturnedQuantity>5</CandidateReturnedQuantity>
<MonitoringProfileDetail>
<MonitoringProfileName>TEST MI-188 CREATE MONF PFL - SVC VER</MonitoringProfileName>
<MonitoringProfileID>8932</MonitoringProfileID>
<DNBProductID>DCP_STD</DNBProductID>
<ServiceVersionNumber>5.1</ServiceVersionNumber>
<MonitoringLevel>Level2</MonitoringLevel>
<MonitoringElementDetail>
<MonitoringElement>
<PCMElementXPATHText>//Organization/SubjectHeader/TransferDUNSNumberRegistration</PCMElementXPATHText>
<MonitoringChanges>
<ChangeCondition>AnyChange</ChangeCondition>
</MonitoringChanges>
</MonitoringElement>
</MonitoringElementDetail>
<MonitoringProfileStatusText>Active</MonitoringProfileStatusText>
<MonitoringProfileCreatedDate>2017-04-05</MonitoringProfileCreatedDate>
<ReturnChangedDataOnlyIndicator>false</ReturnChangedDataOnlyIndicator>
<ReturnSignificantChangeOnlyIndicator>false</ReturnSignificantChangeOnlyIndicator>
<DisplaySequence>1</DisplaySequence>
</MonitoringProfileDetail>
</ListMonitoringProfileResponseDetail>
</ns2:ListMonitoringProfileResponse>
</soap:Body>
</soapenv:Envelope>
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: 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
Returns the Monitoring Profiles that match the criteria submitted with the request. If no criteria is specified, all active profiles will be returned.
For each matching item, this feature will return the Monitoring Profile along with the date it was created.
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.