Retrieving Results
| 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 | GetBatchResults |
| {version} | 3.0 |
| Initial Release | October 3, 2013 |
This function allows a customer to obtain the results (and, when applicable, errors) for a completed medium (fewer than 10,000 companies) batch request.
The Output Error File is a text file containing returned will be a failed transaction (ERR) list (i.e., copies of the lines from the Input File that were not able to be processed).
The Output Result File is a text file containing comma-delimited results for each successful transaction in a format specific to the batch operation.
Update History
- June 20, 2014 (v3.0 SOAP & REST): The REST implementation now supports transfer/receipt of embedded base64 encoded ContentObjects. The SOAP implementation now supports transfer/receipt using the MTOM protocol (multi-part attachments).
- May 16, 2014 (v2.0 SOAP & REST): Error codes refined to improve usability/implementation.
- October 3, 2013 (v1.0 SOAP & REST): The current implementation of this service accepts embedded base64 Content Objects for SOAP, and multipart attachments (MTOM) for REST. Both implementations support XML only.
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
The D&B Direct 2.0 API supports HTTP compression. To utilize this option, add the following line to the header of your request: Accept-Encoding: gzip,deflate
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:GetBatchResultsRequest ServiceVersionNumber="3.0" 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>310</SubmittingOfficeID>
</TransactionDetail>
<GetBatchResultsRequestDetail>
<InquiryDetail>
<ServiceBatchID>125873E1</ServiceBatchID>
</InquiryDetail>
</GetBatchResultsRequestDetail>
</bat:GetBatchResultsRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
| Name | Characteristics |
|---|---|
| GetBatchResultsRequest | Aggregate |
| GetBatchResultsRequest @ServiceVersionNumber | Attribute Possible values: 1 |
| GetBatchResultsRequest. TransactionDetail | Aggregate, Optional Records information necessary to process this request. |
| GetBatchResultsRequest. TransactionDetail. ApplicationTransactionID | string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. |
| GetBatchResultsRequest. 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 |
| GetBatchResultsRequest. 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: GetBatchResultsRequest. TransactionDetail | /Aggregate |
| GetBatchResultsRequest. GetBatchResultsRequestDetail | Aggregate, Required |
| GetBatchResultsRequest. GetBatchResultsRequestDetail. InquiryDetail | Aggregate, Required Records data that allows the customer to specify identifying information about the Batch |
| GetBatchResultsRequest. GetBatchResultsRequestDetail. InquiryDetail. ServiceBatchID | string up to 64 chars., Required A number assigned by the composite service (e.g., MatchCleanseService, GHM) which is used to uniquely identify a batch request. |
| END: GetBatchResultsRequest. GetBatchResultsRequestDetail. InquiryDetail | /Aggregate |
| GetBatchResultsRequest. GetBatchResultsRequestDetail. BatchResultsSpecification | Aggregate, Optional |
| GetBatchResultsRequest. GetBatchResultsRequestDetail. BatchResultsSpecification. IncludeAttachmentIndicator | boolean, Optional When true indicates “Multipart/Related” data will be returned. When false or not provided indicates base64content embedded attachment is returned to the user. |
| END: GetBatchResultsRequest. GetBatchResultsRequestDetail. BatchResultsSpecification | /Aggregate |
| END: GetBatchResultsRequest. GetBatchResultsRequestDetail | /Aggregate |
| END: GetBatchResultsRequest | /Aggregate |
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
This operation delivers two text files that will be delivered as embedded Base64 encoded objects. One of the files returned will be a failed transaction (ERR) list; copies of the lines from the request file that were not able to be processed. The other file will be a list of comma-delimited formatted responses.
The following is a list of the possible data fields returned by this operation in the XML response.
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>
<GetBatchResultsResponse ServiceVersionNumber="3.0" xmlns:oracle-xsl-mapper="http://www.oracle.com/xsl/mapper/schemas" xmlns:ns="http://services.dnb.com/BatchServiceV1.0" xmlns="http://services.dnb.com/BatchServiceV1.0">
<TransactionDetail xmlns="">
<ApplicationTransactionID>APP_TRAN_20130508</ApplicationTransactionID>
<ServiceTransactionID>2287792</ServiceTransactionID>
<TransactionTimestamp>2017-12-22T06:43:26.592-05:00</TransactionTimestamp>
</TransactionDetail>
<TransactionResult xmlns="">
<SeverityText>Information</SeverityText>
<ResultID>CM000</ResultID>
<ResultText>Success</ResultText>
<ResultMessage>
<ResultDescription>The request has been processed Successfully</ResultDescription>
</ResultMessage>
</TransactionResult>
<GetBatchResultsResponseDetail xmlns="">
<BatchDetailResponse>
<ApplicationBatchID>plss</ApplicationBatchID>
<ServiceBatchID>125873E1</ServiceBatchID>
</BatchDetailResponse>
<BatchResult>
<SeverityText>Information</SeverityText>
<ResultID>CM000</ResultID>
<ResultText>Success</ResultText>
<ResultMessage>
<ResultDescription>The input records have been successfully processed</ResultDescription>
</ResultMessage>
</BatchResult>
<BatchProcessSummary>
<ExecutionTimeSummary>
<BatchRequestCreatedTimeStamp>2014-03-08T12:48:47.0Z</BatchRequestCreatedTimeStamp>
<BatchReceivedTimeStamp>2017-12-22T06:42:21.129-05:00</BatchReceivedTimeStamp>
<ActualProcessCompletionTimestamp>2017-12-22T06:43:23.639-05:00</ActualProcessCompletionTimestamp>
</ExecutionTimeSummary>
<RecordSummary>
<TotalInputRecordCount>5</TotalInputRecordCount>
<TotalOutputRecordCount>5</TotalOutputRecordCount>
<TotalPassedRecordCount>5</TotalPassedRecordCount>
<TotalFailedRecordCount>0</TotalFailedRecordCount>
</RecordSummary>
<BatchPriorityValue>5</BatchPriorityValue>
</BatchProcessSummary>
<OutputDetail>
<OutputObjectDetail>
<ContentObject>IjAwMDAwMDAwMDEiLCIxIiwiIiwiIiwiIiwiIiwiIiwiIiwiODA0NzM1MTMyIiwiR09STUFOIE1BTlVGQUNUVVJJTkcgQ09NUEFOWSwgSU5DLiIsIiIsIjQ5MiBLT0xMRVIgU1QiLCIiLCJTQU4gRlJBTkNJU0NPIiwiIiwiOTQxMTAiLCIiLCJVUyIsIiIsIjA2NTA1NTUwMDAwIiwiIiwiIiwiIiwiIiwiIiwiODA0NzM1MTMyIiwiR09STUFOIE1BTlVGQUNUVVJJTkcgQ09NUEFOWSwgSU5DLiIsIiIsIiIsIjQ5MiBLT0xMRVIgU1QiLCIiLCJTQU4gRlJBTkNJU0NPIiwiVVMiLCI5NDExMCIsIiIsIiIsIkNBIiwiMCIsIig2NTApIDU1NS0wMDAwIiwiMCIsIk4iLCIiLCIiLCIiLCIwIiwiIiwiIiwiIiwiMTAiLCJBQUFBQVpBQUZGWiIsIjEwMCIsIjEwMCIsIjEwMCIsIjEwMCIsIjEwMCIsIi0wMSIsIjEwMCIsIjEwMCIsIjAwMCIsIjAyMCIsIi0wMSIsIjAwIiwiMDAiLCIwMCIsIjAwIiwiOTkiLCI5OCIsIjAwIiwiMDAiLCIwMCIsIjAwIiwiMDAiLCIwMCIsIjk4IiwiOTgiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCIiCiIwMDAwMDAwMDAyIiwiMiIsIiIsIiIsIiIsIiIsIiIsIiIsIjIxNDU2Nzg4NSIsIkQgJmFtcDsgQiBTQU1QTEUgQ08gTFREIiwiIiwiTUFSTE9XIElOVEVSTkFUSU9OQUwgUEFSS1dBWSIsIiIsIk1BUkxPVyIsIiIsIlNMNyAxQUoiLCIiLCJHQiIsIiIsIjk4ODQxMjEyMTIwIiwiIiwiIiwiIiwiIiwiIiwiMjE0NTY3ODg1IiwiRCAmIEIgU0FNUExFIENPIExURCIsIiIsIiIsIk1hcmxvdyBJbnRlcm5hdGlvbmFsIFBhcmt3YXkiLCIiLCJNQVJMT1ciLCJHQiIsIlNMNyAxQUoiLCIiLCIiLCJVSyIsIjAiLCIwMTYyODQ5MjAwMCIsIjAiLCJOIiwiIiwiIiwiIiwiMCIsIjQzNDU2NyIsIjI1NDEiLCIiLCIwOSIsIkFaQUFaWkZBRkJGIiwiMTAwIiwiLTAxIiwiMTAwIiwiMTAwIiwiLTAxIiwiLTAxIiwiMDAwIiwiMTAwIiwiMDUwIiwiMDMzIiwiMDAwIiwiMDEiLCI5OCIsIjAwIiwiMDAiLCI5OCIsIjk4IiwiMDAiLCIwMCIsIjAwIiwiMDAiLCIwMCIsIjAwIiwiOTgiLCI5OCIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIKIjAwMDAwMDAwMDMiLCIzIiwiIiwiIiwiYmxvb21iZXJnLm5ldCIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIjA1MjQ0Mzg5MiIsIkJMT09NQkVSRyBMLlAuIiwiQkxPT01CRVJHIEJVU0lORVNTV0VFSyIsIiIsIjczMSBMRVhJTkdUT04gQVZFIiwiIiwiTkVXIFlPUksiLCJVUyIsIjEwMDIyMTMzMSIsIiIsIiIsIk5ZIiwiMCIsIjIxMjMxODIwMDAiLCIwIiwiTiIsIiIsIiIsIiIsIjAiLCIiLCIiLCIiLCIwOCIsIlpaWlpaWlpaWkFaIiwiMDAwIiwiMDAwIiwiMDAwIiwiMDAwIiwiMDAwIiwiMDAwIiwiMDAwIiwiMDAwIiwiMDAwIiwiMDAwIiwiMDAwIiwiMDAiLCI5OSIsIjk5IiwiOTkiLCI5OSIsIjk5IiwiOTkiLCI5OSIsIjAwIiwiMDAiLCI5OCIsIjAwIiwiOTgiLCI1MCIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIsIiIKIjAwMDAwMDAwMDQiLCI0IiwiIiwiIiwiIiwidGVzdEBibG9vbWJlcmcubmV0IiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiMDUyNDQzODkyIiwiQkxPT01CRVJHIEwuUC4iLCJCTE9PTUJFUkcgQlVTSU5FU1NXRUVLIiwiIiwiNzMxIExFWElOR1RPTiBBVkUiLCIiLCJORVcgWU9SSyIsIlVTIiwiMTAwMjIxMzMxIiwiIiwiIiwiTlkiLCIwIiwiMjEyMzE4MjAwMCIsIjAiLCJOIiwiIiwiIiwiIiwiMCIsIiIsIiIsIiIsIjA4IiwiWlpaWlpaWlpaQVoiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMCIsIjk5IiwiOTkiLCI5OSIsIjk5IiwiOTkiLCI5OSIsIjk5IiwiMDAiLCIwMCIsIjk4IiwiMDAiLCI5OCIsIjYwIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIgoiMDAwMDAwMDAwNSIsIjUiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCJibG9vbWJlcmcubmV0IiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiVVMiLCIiLCIiLCIiLCIiLCIiLCIiLCIiLCIwNTI0NDM4OTIiLCJCTE9PTUJFUkcgTC5QLiIsIkJMT09NQkVSRyBCVVNJTkVTU1dFRUsiLCIiLCI3MzEgTEVYSU5HVE9OIEFWRSIsIiIsIk5FVyBZT1JLIiwiVVMiLCIxMDAyMjEzMzEiLCIiLCIiLCJOWSIsIjAiLCIoMjEyKSAzMTgtMjAwMCIsIjAiLCJOIiwiIiwiIiwiIiwiMCIsIiIsIiIsIiIsIjA4IiwiWlpaWlpaWlpaQVoiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMDAiLCIwMCIsIjk5IiwiOTkiLCI5OSIsIjk5IiwiOTkiLCI5OSIsIjk5IiwiMDAiLCIwMCIsIjk4IiwiMDAiLCI5OCIsIjUwIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIiwiIgo=</ContentObject>
<ObjectFormatTypeText>CSV</ObjectFormatTypeText>
<LayoutName>PCMGBOMatch</LayoutName>
<RecordsCount>5</RecordsCount>
</OutputObjectDetail>
</OutputDetail>
</GetBatchResultsResponseDetail>
</GetBatchResultsResponse>
</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 |
Possible Codes in Error File
Appended to each line in the error file (which is a cloned copy of the input request file) are one of the following:
| Error Scenario | Code | Description |
|---|---|---|
| Invalid Input Record Format | CM002 | Invalid Input Record |
| Missing Country Code | CM003 | Missing Country Code |
| Invalid / Unsupported Country Code | CM011 | Invalid / Unsupported Country Code |
| Missing Chunks Records | CM004 | Internal D&B system error |
| Invalid Territory Provided | CM016 | Invalid Territory Provided |
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: BC010, 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 |
|---|---|---|---|
| BC010 | Output File not found in NAS path.(Submission for Processing > 1 Week) | Batch files no longer available after retention period. | Batch files no longer available after retention period. |
| CM000 | Success | Success | The request has been processed Successfully |
| CM001 | Service Batch ID not present in request. | The given request is invalid. | Service Batch ID not present in request. |
| CM001 | UserID not present in SAML header. | The given request is invalid. | UserID not present in SAML header. |
| CM001 | Subscriber Number not present in SAML Header. | The given request is invalid. | Subscriber Number not present in SAML Header. |
| CM003 | Missing ServiceBatchID under the aggregate InquiryDetail | Missing Information in the request. | ServiceBatchID is missing in the request |
| CM004 | Output File not found in NAS path. | Internal D&B system error. Please try again or contact your local Customer Service Center | Output File not found in the storage system. |
| CM004 | Notification Message is null. | Internal D&B system error. Please try again or contact your local Customer Service Center | Notification Message is null. |
| CM004 | Billing File not found in NAS. | Internal D&B system error. Please try again or contact your local Customer Service Center | Billing File not found in the storage system. |
| CM004 | Billing File details not present in response XML. | Internal D&B system error. Please try again or contact your local Customer Service Center | Billing File details not present in response XML. |
Feature Notes
The results from this feature will be a list of separate comma-delimited responses.
In addition to the successful responses, an error file may be returned. The error file will contain exact copies of the input requests which failed, with an error code appended.
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.