Loading

dnb-logo
Direct 2.0
Collapse

Retrieving Results

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 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 (Retrieve)
GET http://direct.dnb.com/V3.0/Batches/125873E1?IncludeAttachmentIndicator=true HTTP/1.1
Accept-Encoding: gzip,deflate
Authorization: 1JJgelig7HUp9vLqOWgiL6EJA3c7E24tWEpIFNWX8WFIXUbxM18Us8F5kWDF2XIjqrfr7DA9Jhi
Host: direct.dnb.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
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.

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.

{batchID} 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.

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/{batchID}

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

This operation delivers two text files that will be delivered as plain text MTOM attachments. 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 JSON response

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 (Retrieve)
HTTP/1.1 200 OK
Max-Forwards: 19
Via: 1.1 dbslsigwbv04 (), 1.1 dbslsegwbv04 ()
Connection: keep-alive
X-CorrelationID: Id-3a41465a3d830a76811c6c05 0; Id-3b41465ac0ac2fa026f82559 0
Date: Fri, 29 Dec 2017 13:20:59 GMT
X-ORACLE-DMS-ECID: 0dc7819d-ffbb-4ad7-8ce4-6ecbb21f4a90-00f0c57c
X-ORACLE-DMS-RID: 0
Content-Type: multipart/related; boundary="46d5115a-18ab-4d2e-b73f-dcd2848be3d3"; start="2650885b-f444-41c9-b8b8-9d4c259fc2c5"; type="application/xop+xml"; start-info="text/xml"
Vary: Accept-Encoding
Content-Encoding: gzip
Content-Length: 1632

--46d5115a-18ab-4d2e-b73f-dcd2848be3d3
Content-Id: 2650885b-f444-41c9-b8b8-9d4c259fc2c5
Content-Type: application/xop+xml; type="text/xml"

<?xml version="1.0" encoding="UTF-8"?>
<GetBatchResultsResponse 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" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://www.w3.org/2005/08/addressing" ServiceVersionNumber="3.0"><TransactionDetail xmlns=""><ServiceTransactionID>2305473</ServiceTransactionID><TransactionTimestamp>2017-12-29T08:20:59.735-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><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:1fb2399d-510c-4145-8011-fe350f92a6f7"/></ContentObject>
            <ObjectFormatTypeText>CSV</ObjectFormatTypeText>
            <LayoutName>PCMGBOMatch</LayoutName>
            <RecordsCount>5</RecordsCount>
         </OutputObjectDetail></OutputDetail></GetBatchResultsResponseDetail></GetBatchResultsResponse>

--46d5115a-18ab-4d2e-b73f-dcd2848be3d3
Content-Id: <1fb2399d-510c-4145-8011-fe350f92a6f7>
Content-Type: application/octet-stream

"0000000001","1","","","","","","","804735132","GORMAN MANUFACTURING COMPANY, INC.","","492 KOLLER ST","","SAN FRANCISCO","","94110","","US","","06505550000","","","","","","804735132","GORMAN MANUFACTURING COMPANY, INC.","","","492 KOLLER ST","","SAN FRANCISCO","US","94110","","","CA","0","(650) 555-0000","0","N","","","","0","","","","10","AAAAAZAAFFZ","100","100","100","100","100","-01","100","100","000","020","-01","00","00","00","00","99","98","00","00","00","00","00","00","98","98","","","","","","","","","","","","","","","",""
"0000000002","2","","","","","","","214567885","D &amp; B SAMPLE CO LTD","","MARLOW INTERNATIONAL PARKWAY","","MARLOW","","SL7 1AJ","","GB","","98841212120","","","","","","214567885","D & B SAMPLE CO LTD","","","Marlow International Parkway","","MARLOW","GB","SL7 1AJ","","","UK","0","01628492000","0","N","","","","0","434567","2541","","09","AZAAZZFAFBF","100","-01","100","100","-01","-01","000","100","050","033","000","01","98","00","00","98","98","00","00","00","00","00","00","98","98","","","","","","","","","","","","","","","",""
"0000000003","3","","","bloomberg.net","","","","","","","","","","","","","","","","","","","","","052443892","BLOOMBERG L.P.","BLOOMBERG BUSINESSWEEK","","731 LEXINGTON AVE","","NEW YORK","US","100221331","","","NY","0","2123182000","0","N","","","","0","","","","08","ZZZZZZZZZAZ","000","000","000","000","000","000","000","000","000","000","000","00","99","99","99","99","99","99","99","00","00","98","00","98","50","","","","","","","","","","","","","","","",""
"0000000004","4","","","","test@bloomberg.net","","","","","","","","","","","","","","","","","","","","052443892","BLOOMBERG L.P.","BLOOMBERG BUSINESSWEEK","","731 LEXINGTON AVE","","NEW YORK","US","100221331","","","NY","0","2123182000","0","N","","","","0","","","","08","ZZZZZZZZZAZ","000","000","000","000","000","000","000","000","000","000","000","00","99","99","99","99","99","99","99","00","00","98","00","98","60","","","","","","","","","","","","","","","",""
"0000000005","5","","","","","","","","bloomberg.net","","","","","","","","US","","","","","","","","052443892","BLOOMBERG L.P.","BLOOMBERG BUSINESSWEEK","","731 LEXINGTON AVE","","NEW YORK","US","100221331","","","NY","0","(212) 318-2000","0","N","","","","0","","","","08","ZZZZZZZZZAZ","000","000","000","000","000","000","000","000","000","000","000","00","99","99","99","99","99","99","99","00","00","98","00","98","50","","","","","","","","","","","","","","","",""

--46d5115a-18ab-4d2e-b73f-dcd2848be3d3--


Name Characteristics
GetBatchResultsResponse Aggregate
GetBatchResultsResponse. TransactionDetail Aggregate, Optional

Records information necessary to process this request.

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

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

GetBatchResultsResponse. TransactionResult. SeverityText string, Required

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

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

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

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

Text that explains the outcome of the transaction.

END: GetBatchResultsResponse. TransactionResult /Aggregate
GetBatchResultsResponse. GetBatchResultsResponseDetail Aggregate, Optional
GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchDetailResponse Aggregate, Required

Records information necessary to return a particular response.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchDetailResponse. 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.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchDetailResponse. 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: GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchDetailResponse /Aggregate
GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchResult Aggregate, Optional

Records information about the result of the process.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchResult. SeverityText string, Required

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

GetBatchResultsResponse. GetBatchResultsResponseDetail. 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

GetBatchResultsResponse. GetBatchResultsResponseDetail. 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;

GetBatchResultsResponse. GetBatchResultsResponseDetail. 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.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchResult. ResultMessage. ResultDescription string up to 512 chars., Required

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

END: GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchResult. ResultMessage /Aggregate
END: GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchResult /Aggregate
GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary Aggregate, Optional

Records information about the process time and the number of records processed.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary. ExecutionTimeSummary Aggregate, Optional

Records information about the process time and completion time.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary. ExecutionTimeSummary. BatchReceivedTimeStamp dateTime, Optional

The date and time when the batch request was received by the service.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary. ExecutionTimeSummary. ActualProcessCompletionTimestamp dateTime, Optional

The date and time when the requested process (i.e., match, cleanse, cleansematch) was actually completed by the service.

END: GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary. ExecutionTimeSummary /Aggregate
GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary. RecordSummary Aggregate, Optional

Records information about the number of input and output records, and the count of the number of records which have passed and failed the requested process.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary. RecordSummary. TotalInputRecordCount integer, Optional

A numeric value denoting the total number of records contained in the input file.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary. RecordSummary. TotalOutputRecordCount integer, Optional

A numeric value denoting the total number of records contained in the output file.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary. RecordSummary. TotalPassedRecordCount string, Optional

A numeric value denoting the total number of records which have passed the requested process.

GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary. RecordSummary. TotalFailedRecordCount string, Optional

A numeric value denoting the total number of records which have failed the requested process.

END: GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary. RecordSummary /Aggregate
END: GetBatchResultsResponse. GetBatchResultsResponseDetail. BatchProcessSummary /Aggregate
GetBatchResultsResponse. GetBatchResultsResponseDetail. OutputDetail Aggregate, Optional

Records information about the output of the Batch process.

GetBatchResultsResponse. GetBatchResultsResponseDetail. OutputDetail. OutputObjectDetail Aggregate, Optional (Array)

Possible values: Can repeat up to 2 times; one for Output file and second for Error file

GetBatchResultsResponse. GetBatchResultsResponseDetail. OutputDetail. OutputObjectDetail. ContentObject For Multipart: Include statement, Required

Example: <Include href=""/>

For Embedded: base64Binary, Required

GetBatchResultsResponse. GetBatchResultsResponseDetail. OutputDetail. OutputObjectDetail. ObjectFormatTypeText string up to 5 chars., Required

XML,CSV,JSON

Possible values: CSV

GetBatchResultsResponse. GetBatchResultsResponseDetail. OutputDetail. OutputObjectDetail. LayoutName string up to 32 chars., Required

The name of the layout for this collection of the data records. For example the layout names 'GBI' denotes the Global Batch Input layout.

Possible values: PCMGBOMatch (For the output file); ERR (For the Error file)

GetBatchResultsResponse. GetBatchResultsResponseDetail. OutputDetail. OutputObjectDetail. RecordsCount unsignedLong, Optional

A numeric value denoting the number of records contained in the input file.

END: GetBatchResultsResponse. GetBatchResultsResponseDetail. OutputDetail. OutputObjectDetail /Aggregate
END: GetBatchResultsResponse. GetBatchResultsResponseDetail. OutputDetail /Aggregate
END: GetBatchResultsResponse. GetBatchResultsResponseDetail /Aggregate
END: GetBatchResultsResponse /Aggregate

Batch Result Codes

These codes indicates the status of a specific Batch.

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 ScenarioCodeDescription
Invalid Input Record FormatCM002Invalid Input Record
Missing Country CodeCM003Missing Country Code
Invalid / Unsupported Country CodeCM011Invalid / Unsupported Country Code
Missing Chunks RecordsCM004Internal D&B system error
Invalid Territory ProvidedCM016Invalid 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 CodeError ScenarioResult TextResult Message
BC010Output 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.
CM000SuccessSuccessThe request has been processed Successfully
CM001Service Batch ID not present in request.The given request is invalid.Service Batch ID not present in request.
CM001UserID not present in SAML header.The given request is invalid.UserID not present in SAML header.
CM001Subscriber Number not present in SAML Header.The given request is invalid.Subscriber Number not present in SAML Header.
CM003Missing ServiceBatchID under the aggregate InquiryDetailMissing Information in the request.ServiceBatchID is missing in the request
CM004Output File not found in NAS path.Internal D&B system error. Please try again or contact your local Customer Service CenterOutput File not found in the storage system.
CM004Notification Message is null.Internal D&B system error. Please try again or contact your local Customer Service CenterNotification Message is null.
CM004Billing File not found in NAS.Internal D&B system error. Please try again or contact your local Customer Service CenterBilling File not found in the storage system.
CM004Billing File details not present in response XML.Internal D&B system error. Please try again or contact your local Customer Service CenterBilling 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.

error-example