Cookies Settings

Loading

dnb-logo
Direct 2.0
Collapse

Listing Medium Batches

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 expiration of Authentication Tokens for this service is 30 minutes.

Exception: The Application TransactionID, TransactionTimestamp and SubmittingOfficeID fields are required for this operation. Please contact a D&B sales associate to obtain the correct SubmittingOfficeID value.

Sample Request (List)
GET https://direct.dnb.com/V1.0/Batches?SubmittingOfficeID=350&ServiceVersionNumber=1&ApplicationTransactionID=APP_TRAN_20130703&TransactionTimestamp=2013-06-27T23%3A43%3A09.000-06%3A00&ServiceBatchID-2=1018 HTTP/1.1
Accept-Encoding: gzip,deflate
Authorization: HoObE/2StpE62O/TDyQBpoFwmvDjiRN7neH6Qp5eEDBqkl6kzZdBwDXaihfxIqH+5g26crK2RUD9SXdDMZ+hbuRKfxCJuuIAYVmVBZBhv4pMjXwvznG687fn7bP3bdTsPy09fjMMnrt5YTZ/RApbcCm8mrg1NYwPFv8QNtDHWKMNXtk0835QZc/msuWN5JUA3Kjfo9Q0st+811sf/NWIaBJSjkZmtLBCgU1uh55kigjfBQvtSABzcwy5Oar7w02/NPJA/QjfOalyrQLDF2NZO3EJ4qu447Ro7wsoElr+dROAfPlE/l2W2wNckIoNYb5GgGDR/WyQ2geVyPp6+ewvWg==
Host: direct.dnb.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
Note: This sample is for illustrative purposes only. Actual calls using the sample parameters may not produce the same results.
Name Characteristics
ServiceVersionNumber Element
ApplicationTransactionID string up to 64 chars., Required

A number assigned by the calling application to uniquely identify this request.

TransactionTimestamp DateTimestamp, Required

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.

SubmittingOfficeID string up to 64 chars., Required

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.

ServiceBatchID string up to 64 chars., Optional

A number assigned by the composite service (e.g., MatchCleanseService, GHM) which is used to uniquely identify a batch request.

BatchSubmittedFromTimestamp dateTime, Optional
BatchSubmittedToTimestamp dateTime, Optional

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 for requesting this feature. The {version} is dependent on the underlying service delivering the response.

Endpoint (Batch)
GET https://direct.dnb.com:8443/V{version}/Batches

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

NOTE: The D&B Direct REST implementation uses the BadgerFish approach for JSON with some minor variations.

Specification

Exception: This operation currently does not support JSON. 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.

Sample Response (List)
<client:ListBatchResponse ServiceVersionNumber="1" xmlns:client="http://services.dnb.com/BatchServiceV1.0" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing">
   <TransactionDetail>
      <ApplicationTransactionID>APP_TRAN_20130703</ApplicationTransactionID>
      <ServiceTransactionID>2256554</ServiceTransactionID>
      <TransactionTimestamp>2013-08-28T19:02:53-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>50</CandidateReturnedQuantity>
      <CandidateMatchedQuantity>50</CandidateMatchedQuantity>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>1234567</ApplicationBatchID>
            <ServiceBatchID>1018</ServiceBatchID>
            <MessageTimeStamp>2013-08-28T18:42:11.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC004</ResultID>
            <ResultText>Batch request is not processed.</ResultText>
            <ResultMessage>
               <ResultDescription>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</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>1234567</ApplicationBatchID>
            <ServiceBatchID>1017</ServiceBatchID>
            <MessageTimeStamp>2013-08-28T18:41:04.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC004</ResultID>
            <ResultText>Batch request is not processed.</ResultText>
            <ResultMessage>
               <ResultDescription>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</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>1234567</ApplicationBatchID>
            <ServiceBatchID>1016</ServiceBatchID>
            <MessageTimeStamp>2013-08-28T18:44:10.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>1015</ServiceBatchID>
            <MessageTimeStamp>2013-08-27T18:00:19.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>1014</ServiceBatchID>
            <MessageTimeStamp>2013-08-27T17:59:11.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>1013</ServiceBatchID>
            <MessageTimeStamp>2013-08-27T17:55:56.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC004</ResultID>
            <ResultText>Batch request is not processed.</ResultText>
            <ResultMessage>
               <ResultDescription>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</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>1234567</ApplicationBatchID>
            <ServiceBatchID>1012</ServiceBatchID>
            <MessageTimeStamp>2013-08-27T17:55:11.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC004</ResultID>
            <ResultText>Batch request is not processed.</ResultText>
            <ResultMessage>
               <ResultDescription>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</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>1234567</ApplicationBatchID>
            <ServiceBatchID>1011</ServiceBatchID>
            <MessageTimeStamp>2013-08-27T17:49:04.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>1010</ServiceBatchID>
            <MessageTimeStamp>2013-08-27T17:44:20.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>1009</ServiceBatchID>
            <MessageTimeStamp>2013-08-27T16:53:06.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>991</ServiceBatchID>
            <MessageTimeStamp>2013-08-25T01:00:03.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>1234567</ApplicationBatchID>
            <ServiceBatchID>990</ServiceBatchID>
            <MessageTimeStamp>2013-08-25T00:59:53.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>1234567</ApplicationBatchID>
            <ServiceBatchID>989</ServiceBatchID>
            <MessageTimeStamp>2013-08-25T00:59:44.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <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>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>86</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T06:46:08.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>85</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T08:00:05.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC002</ResultID>
            <ResultText>Batch request is not processed since input file is not available in the specified location.</ResultText>
            <ResultMessage>
               <ResultDescription>Input file is not present in the input folder</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>84</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T06:36:07.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>83</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T06:26:18.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>82</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T06:32:11.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC002</ResultID>
            <ResultText>Batch request is not processed since input file is not available in the specified location.</ResultText>
            <ResultMessage>
               <ResultDescription>Input file is not present in the input folder</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>81</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T06:16:26.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>80</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T06:32:11.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC002</ResultID>
            <ResultText>Batch request is not processed since input file is not available in the specified location.</ResultText>
            <ResultMessage>
               <ResultDescription>Input file is not present in the input folder</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>79</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T04:56:54.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>78</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T04:50:47.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>77</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T04:45:46.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>76</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T04:39:51.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>75</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T04:33:05.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>74</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T04:22:45.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>73</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T03:58:10.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>72</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T03:37:52.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC002</ResultID>
            <ResultText>Batch request is not processed since input file is not available in the specified location.</ResultText>
            <ResultMessage>
               <ResultDescription>Input file is not present in the input folder</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>71</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T03:10:40.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC002</ResultID>
            <ResultText>Batch request is not processed since input file is not available in the specified location.</ResultText>
            <ResultMessage>
               <ResultDescription>Input file is not present in the input folder</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>70</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T03:08:00.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>69</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T03:03:59.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>68</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T03:01:22.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC002</ResultID>
            <ResultText>Batch request is not processed since input file is not available in the specified location.</ResultText>
            <ResultMessage>
               <ResultDescription>Input file is not present in the input folder</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>67</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T03:01:22.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC002</ResultID>
            <ResultText>Batch request is not processed since input file is not available in the specified location.</ResultText>
            <ResultMessage>
               <ResultDescription>Input file is not present in the input folder</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>66</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T02:52:59.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC004</ResultID>
            <ResultText>Batch request is not processed.</ResultText>
            <ResultMessage>
               <ResultDescription>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</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>65</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T02:50:26.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>64</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T02:49:30.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC002</ResultID>
            <ResultText>Batch request is not processed since input file is not available in the specified location.</ResultText>
            <ResultMessage>
               <ResultDescription>Input file is not present in the input folder</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>63</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T02:36:37.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC004</ResultID>
            <ResultText>Batch request is not processed.</ResultText>
            <ResultMessage>
               <ResultDescription>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</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>62</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T02:32:24.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>61</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T02:26:20.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>26Jul</ApplicationBatchID>
            <ServiceBatchID>60</ServiceBatchID>
            <MessageTimeStamp>2013-07-26T02:36:31.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Error</SeverityText>
            <ResultID>BC002</ResultID>
            <ResultText>Batch request is not processed since input file is not available in the specified location.</ResultText>
            <ResultMessage>
               <ResultDescription>Input file is not present in the input folder</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>23Jul</ApplicationBatchID>
            <ServiceBatchID>46</ServiceBatchID>
            <MessageTimeStamp>2013-07-23T07:38:12.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>APP_QATEST_JOB1</ApplicationBatchID>
            <ServiceBatchID>21</ServiceBatchID>
            <MessageTimeStamp>2013-07-20T05:29:01.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>APP_QATEST_JOB1</ApplicationBatchID>
            <ServiceBatchID>20</ServiceBatchID>
            <MessageTimeStamp>2013-07-20T04:57:18.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>APP_QATEST_JOB1</ApplicationBatchID>
            <ServiceBatchID>19</ServiceBatchID>
            <MessageTimeStamp>2013-07-20T04:58:39.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>APP_QATEST_JOB1</ApplicationBatchID>
            <ServiceBatchID>18</ServiceBatchID>
            <MessageTimeStamp>2013-07-20T04:58:24.000-04:00</MessageTimeStamp>
         </BatchDetail>
         <BatchResult>
            <SeverityText>Information</SeverityText>
            <ResultID>CM000</ResultID>
            <ResultText>Success</ResultText>
            <ResultMessage>
               <ResultDescription>Completed</ResultDescription>
            </ResultMessage>
         </BatchResult>
         <BatchReferenceDetail/>
      </Batch>
      <Batch>
         <BatchDetail>
            <ApplicationBatchID>APP_QATEST_JOB1</ApplicationBatchID>
            <ServiceBatchID>17</ServiceBatchID>
            <MessageTimeStamp>2013-07-20T04:53:20.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>
   </ListBatchResponseDetail>
</client:ListBatchResponse>
Name Characteristics
ListBatchResponse Aggregate
ListBatchResponse. TransactionDetail Aggregate, Optional

Records information necessary to process this request.

ListBatchResponse. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional

A number assigned by the calling application to uniquely identify this request.

ListBatchResponse. TransactionDetail. ServiceTransactionID string up to 64 chars., Required

A number assigned by the D&B service to uniquely identify this transaction.

ListBatchResponse. TransactionDetail. TransactionTimestamp DateTimestamp, 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: ListBatchResponse. TransactionDetail /Aggregate
ListBatchResponse. TransactionResult Aggregate, Required

An aggregate that can repeat multiple times to record the different outcomes of the transaction.

ListBatchResponse. TransactionResult. SeverityText string, Required

Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal.

ListBatchResponse. TransactionResult. ResultID string up to 32 chars., Required

An alphanumeric string that uniquely identifies the outcome of the transaction.

ListBatchResponse. TransactionResult. ResultText string up to 512 chars., Optional

Text that explains the outcome of the transaction.

ListBatchResponse. 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.

ListBatchResponse. TransactionResult. ResultMessage. ResultDescription string up to 512 chars., Required

Text that describes the additional information regarding the outcome of the batch.

END: ListBatchResponse. TransactionResult. ResultMessage /Aggregate
END: ListBatchResponse. TransactionResult /Aggregate
ListBatchResponse. ListBatchResponseDetail Aggregate, Optional

An entry loop which can repeat multiple times to allow the recording of the details on the status of the supplier records in a registration batch file uploaded by the user.

ListBatchResponse. ListBatchResponseDetail. CandidateReturnedQuantity int up to 6 digits., Required

The number of candidates returned for the search criteria.

Possible values: maximum 50

ListBatchResponse. ListBatchResponseDetail. CandidateMatchedQuantity int up to 6 digits., Required

The number of candidates matched for the search criteria.

Possible values: maximum 50

ListBatchResponse. ListBatchResponseDetail. Batch Aggregate, Optional (Array)
ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail Aggregate, Required

Records information necessary to return a particular response.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail. ApplicationBatchID string up to 64 chars., Required

A number assigned by consuming application (e.g., GIH) which is used to uniquely identify a batch request.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail. 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.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail. MessageTimeStamp dateTime, Required

The date and time when this message was created. When the message is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to or from the D&B function.

END: ListBatchResponse. ListBatchResponseDetail. Batch. BatchDetail /Aggregate
ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult Aggregate, Optional

Records information about the result of the process.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult. SeverityText string, Required

Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult. ResultID string up to 32 chars., Required

An alphanumeric string that uniquely identifies the outcome of the batch.

Possible values: BC005; CM001; CM004; BC001; BC002; BC003; BC004

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult. ResultText string up to 512 chars., Optional

Text that explains the outcome of the batch.

Possible values: CM000 Success; BC005 Intermediate Notification; CM001 The given request is invalid; CM004 Internal D&B system error. Please try again or contact your local Customer Service Center; BC001 Partial Success; BC002 Batch request is not processed since input file is not available in the specified location; BC003 Batch request is not processed since the content of the input file is not in the expected format or has invalid data; 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;

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult. 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 batch. If the status implies that there is a problem this may also provide guidance to the user on how to address it.

ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult. ResultMessage. ResultDescription string up to 512 chars., Required

Text that describes the additional information regarding the outcome of the batch.

END: ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult. ResultMessage /Aggregate
END: ListBatchResponse. ListBatchResponseDetail. Batch. BatchResult /Aggregate
END: ListBatchResponse. ListBatchResponseDetail. Batch /Aggregate
END: ListBatchResponse. ListBatchResponseDetail /Aggregate
END: ListBatchResponse /Aggregate

Batch Result Codes

These codes indicates the status of a specific Batch.

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 CodeError ScenarioResult TextResult Message
CM000SuccessSuccessThe request has been processed Successfully
CM001SubscriberID not present in SAML header.The given request is invalid.SubscriberID not present in SAML header.
CM001UserID not present in SAML header.The given request is invalid.UserID not present in SAML header.