Listing Medium Batches
| Product Code(s) | Not Applicable |
| Option(s) | None |
| Monitoring Available | No |
| Interface | SOAP |
| WSDL | download (Embedded format) |
| Alternate WSDL | download (MTOM attached) |
| Format(s) | XML |
| Service | Batch |
| Operation | ListBatch |
| {version} | 3.0 |
| Initial Release | October 3, 2013 |
This function allows a customer to review recently completed, in process and rejected batch requests. It provides the mechanism for polling the status of jobs as part of the asynchronous medium (fewer than 10,000 companies) batch process.
Update History
No modifications have been made to this data layer since the initial release.
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 in the production and trial environments for D&B Direct 2.0 customers. Entitlement for the batch feature is only required for the Process Batch function, and for the data layers that will ordered in bulk.
For customers in the UK, Ireland, Belgium, Netherlands and Luxembourg markets, the API is provisioned as a specific set of data layers for production, trial, and sandbox usage.
- This particular data layer is NOT included in the D&B Direct Onboard suite.
Specification
Exception: The fields comprising the TransactionDetail aggregate are required for this operation. Please contact a D&B sales associate to obtain the correct SubmittingOfficeID value.
<SOAP-ENV:Envelope xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SOAP-ENV:Header>
<wsse:Security 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-1">
<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>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<bat:ListBatchRequest ServiceVersionNumber="1" xmlns:bat="http://services.dnb.com/BatchServiceV1.0">
<TransactionDetail>
<ApplicationTransactionID>APP_TRAN_20130508</ApplicationTransactionID>
<TransactionTimestamp>2013-04-18T13:12:08.724+05:30</TransactionTimestamp>
<SubmittingOfficeID>333</SubmittingOfficeID>
</TransactionDetail>
<ListBatchRequestDetail>
<InquiryDetail>
<BatchSubmittedFromTimestamp>2013-08-01T12:00:00.000</BatchSubmittedFromTimestamp>
<BatchSubmittedToTimestamp>2013-08-15T12:00:00.000</BatchSubmittedToTimestamp>
</InquiryDetail>
</ListBatchRequestDetail>
</bat:ListBatchRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
| Name | Characteristics |
|---|---|
| ListBatchRequest | Aggregate |
| ListBatchRequest @ServiceVersionNumber | Attribute Possible values: 1 |
| ListBatchRequest. TransactionDetail | Aggregate, Optional Records information necessary to process this request. |
| ListBatchRequest. TransactionDetail. ApplicationTransactionID | string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. |
| ListBatchRequest. 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. Possible values: e.g.: 2013-08-01T23:43:09.000-06:00 |
| ListBatchRequest. 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: ListBatchRequest. TransactionDetail | /Aggregate |
| ListBatchRequest. ListBatchRequestDetail | Aggregate, Optional Records data to view the status of the supplier records in a registration batch file uploaded by the user. |
| ListBatchRequest. ListBatchRequestDetail. InquiryDetail | Aggregate, Optional Records data that allows the customer to specify identifying information about the subject being inquired. |
| ListBatchRequest. ListBatchRequestDetail. InquiryDetail. ServiceBatchID | string up to 64 chars., Optional (Array) A number assigned by the composite service (e.g., MatchCleanseService, GHM) which is used to uniquely identify a batch request. |
| ListBatchRequest. ListBatchRequestDetail. InquiryDetail. BatchSubmittedFromTimestamp | dateTime, Optional Possible values: e.g.: 2013-08-01T23:43:09.000-06:00 |
Up to a maximum of 50 Batches will be returned by this operation. Batches will be returned in the descending order of the submission date (Latest Batch on the top)
Customers can optionally filter the results by providing one of the following filter conditions
1. Up to a maximum of 50 ServiceBatchIds can be provided in the request (separated by a dot [“.”]). In this case, only the details for the given ServiceBatchIds will be returned in the response.
2. The “from” and “to” dates of the batch submission can be provided in the request. In this case, only the batches submitted between the specified dates will be retuned in the response.*
* If both ServiceBatchIds AND “from” / “to” dates are provided in the request, only the ServiceBatchId list will be considered. “From” / “to” dates will be ignored by the service.
Endpoint
Use the following endpoint with the downloadable WSDL to request this feature.
| Endpoint (Batch) |
|---|
| https://direct.dnb.com:8443/V{version}/BatchService |
NOTE: Calls to the Batch service use an alternate port (8443).
Testing
This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless of the request parameters.
NOTE: All sandbox requests for this service require the following fixed authentication token:
jAu4dMpeUcgrDE0J66k3x5AUm+3ej7Dq2+Pl2TTwtbOC06c+szLpjs8yzMYFKvjPXOBrGRCr61LkVedVC9w0NChRFMUlWopw/KQRv9GHWDOV5yvK43Tt4fTYA6cgVef9wb572rHNHlisRFm4789nw8re+K9jgoO9LvlIhs9IgZUbGRaIAttKDYFmtLSKDmjjZWoo7RPiwqaZR4dFLQ86v10038clavB/lqJtu6zo6qmep7Na2xU7Ot+UcWA0bMA18gnFikzptbbqu/DP6Fa89s6itBrEbFn5iD88KCRPQfImtD6li7g+Rt7CdracVkQv7vkxO9LvrVc4YqTVJX51xqzuP1HuCYE3/Kdnn1B3pSZjw4xy5nq03LFu8HJ9VF89
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.
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing">
<env:Header/>
<env:Body>
<client:ListBatchResponse ServiceVersionNumber="1" xmlns:client="http://services.dnb.com/BatchServiceV1.0">
<TransactionDetail>
<ApplicationTransactionID>APP_TRAN_20130508</ApplicationTransactionID>
<ServiceTransactionID>2268292</ServiceTransactionID>
<TransactionTimestamp>2013-08-29T15:29:06-04:00</TransactionTimestamp>
</TransactionDetail>
<TransactionResult>
<SeverityText>Information</SeverityText>
<ResultID>CM000</ResultID>
<ResultText>Success</ResultText>
<ResultMessage>
<ResultDescription>The request has been processed Successfully</ResultDescription>
</ResultMessage>
</TransactionResult>
<ListBatchResponseDetail>
<CandidateReturnedQuantity>4</CandidateReturnedQuantity>
<CandidateMatchedQuantity>4</CandidateMatchedQuantity>
<Batch>
<BatchDetail>
<ApplicationBatchID>1234567</ApplicationBatchID>
<ServiceBatchID>970</ServiceBatchID>
<MessageTimeStamp>2013-08-15T08:34:47.000-04:00</MessageTimeStamp>
</BatchDetail>
<BatchResult>
<SeverityText>Warning</SeverityText>
<ResultID>BC001</ResultID>
<ResultText>Partial Success</ResultText>
<ResultMessage>
<ResultDescription>One or more records in the input file were not processed</ResultDescription>
</ResultMessage>
</BatchResult>
<BatchReferenceDetail/>
</Batch>
<Batch>
<BatchDetail>
<ApplicationBatchID>1234567</ApplicationBatchID>
<ServiceBatchID>969</ServiceBatchID>
<MessageTimeStamp>2013-08-15T08:18:22.000-04:00</MessageTimeStamp>
</BatchDetail>
<BatchResult>
<SeverityText>Warning</SeverityText>
<ResultID>BC001</ResultID>
<ResultText>Partial Success</ResultText>
<ResultMessage>
<ResultDescription>One or more records in the input file were not processed</ResultDescription>
</ResultMessage>
</BatchResult>
<BatchReferenceDetail/>
</Batch>
<Batch>
<BatchDetail>
<ApplicationBatchID>QATESTING_PB_PROD001</ApplicationBatchID>
<ServiceBatchID>723</ServiceBatchID>
<MessageTimeStamp>2013-08-03T03:03:03.000-04:00</MessageTimeStamp>
</BatchDetail>
<BatchResult>
<SeverityText>Warning</SeverityText>
<ResultID>BC001</ResultID>
<ResultText>Partial Success</ResultText>
<ResultMessage>
<ResultDescription>One or more records in the input file were not processed</ResultDescription>
</ResultMessage>
</BatchResult>
<BatchReferenceDetail/>
</Batch>
<Batch>
<BatchDetail>
<ApplicationBatchID>123</ApplicationBatchID>
<ServiceBatchID>721</ServiceBatchID>
<MessageTimeStamp>2013-08-03T02:36:55.000-04:00</MessageTimeStamp>
</BatchDetail>
<BatchResult>
<SeverityText>Information</SeverityText>
<ResultID>CM000</ResultID>
<ResultText>Success</ResultText>
<ResultMessage>
<ResultDescription>Completed</ResultDescription>
</ResultMessage>
</BatchResult>
<BatchReferenceDetail/>
</Batch>
</ListBatchResponseDetail>
</client:ListBatchResponse>
</env:Body>
</env:Envelope>
Batch Result Codes
These codes indicates the status of a specific Batch.
| CM000 | Success | Job successfully processed. |
| CM001 | The given request is invalid. | The given input request(not input file) is incorrect |
| CM004 | Internal D&B system error. Please try again or contact your local Customer Service Center. | Could not process the job due to some internal system error |
| BC001 | Partial Success. | Job processed successfully. However there are some error records. |
| BC003 | Batch request is not processed since the content of the input file is not in the expected format or has invalid data. | The input file is not in the required format |
| BC004 | Batch request is not processed since the count of the records specified in the request do not match the exact count of records in the input file. | Mismatch is the records count field to the number of records in the input file. |
| BC005 | Job In Progress | Job is still under execution |
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, CM003, CM004, and SC001-SC006.
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:
| Return Code | Error Scenario | Result Text | Result Message |
|---|---|---|---|
| CM000 | Success | Success | The request has been processed Successfully |
| CM001 | SubscriberID not present in SAML header. | The given request is invalid. | SubscriberID not present in SAML header. |
| CM001 | UserID not present in SAML header. | The given request is invalid. | UserID not present in SAML header. |
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.