On-Demand Multiple Entity Resolution (Synchronous)
Also referred to as Small (up to 100 companies) Batch/Cleanse Processing.
| Product | D&B Direct 2.0 |
| Batch Process ID(s) | CPCM_CM |
| Options(s) | None |
| Monitoring Available | No |
| Interface | REST |
| Method(s) | POST |
| Format(s) | XML |
| Service | TransactionalMiniBatch |
| {version} | 2.0 |
| Initial Release | October 3, 2013 |
This feature allows multiple cleanse and match requests to be issued from a single API call, using the Transactional Mini-Batch Service to support small-sized batches (fewer than 100 companies).
Update History
No modifications have been made to this data layer since the initial release.
Quick Start for Small Batches
The process for small batches requires the following steps:
- List Preparation - this feature uses the same request format as the single cleanse/match (in XML) concatenated into a single submission.
- List Uploads - when you're ready to initiate a batch, submit the list (i.e. ProcessBatch) for processing.
- Get Ready for the Results - like the initial list, the results will be in same layout/format as the single cleanse/match (in XML) concatenated into a single result.
- Downloading Results - since this feature is synchronous, the response from the ProcessBatch request will contain the cleansed records.
Feature Request
IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.
Overview
The list of product request details is packaged (in one of two formats), base 64 encoded and embedded in a typical D&B Direct API call. The available formats include text (comma-delimited) or XML.
To prepare the product request list using XML, concatenate multiple copies of the On-Demand Single Entity Resolution request detail package and place within BatchCleanseMatchRequest tags before encoding.
The maximum number of product requests for this operation is 100.
The InputObjectDetail LayoutVersion value should match the latest version of the Company service as stated on the On-Demand Single Entity Resolution page.
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 feature is entitled as "On-Demand Single Entity Resolution" for D&B Direct 2.0 customers.
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: Requests to this operation must be submitted in XML format via a POST command regardless of the ObjectFormatTypeText value.
POST https://direct.dnb.com/V2/TransactionalMiniBatch HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: multipart/form-data; boundary="----=_Part_0_7350969.1468334235922"
MIME-Version: 1.0
Authorization: <MyAuth Token>
Content-Length: 5315
Host: 10.162.228.116:80
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
------=_Part_0_7350969.1468334235922
Content-Type: multipart/form-data
Content-Transfer-Encoding: 8bit
<tmb:ProcessBatchRequest xmlns:tmb="http://services.dnb.com/TransactionalMiniBatchV1.0">
<BatchDetail>
<ApplicationBatchID>ServiceGovernance-MiniBatchSamples</ApplicationBatchID>
<MessageTimeStamp>2001-12-17T09:30:47-05:00</MessageTimeStamp>
</BatchDetail>
<BatchSpecification>
<BatchProcessID>CPCM_CM</BatchProcessID>
<BatchPriorityValue>5</BatchPriorityValue>
<!--LanguagePreferenceCode>39</LanguagePreferenceCode-->
<CharacterSetPreferenceCode>23423</CharacterSetPreferenceCode>
<BatchSpecificationObject>
<ContentObject>R0lGODlhcgGSALMAAAQCAEMmCZtuMFQxDS8b</ContentObject>
<ObjectFormatTypeText>0</ObjectFormatTypeText>
<LayoutName>GBICleanse</LayoutName>
<CharacterSetCode>23423</CharacterSetCode>
<LanguageCode>39</LanguageCode>
<CompressTypeValue>None</CompressTypeValue>
</BatchSpecificationObject>
</BatchSpecification>
<InputDetail>
<InputObjectDetail>
<ContentObject>
<Include href="cid:ee9e4bbc-6a55-422c-93ff-041c8f1544c3"/>
</ContentObject>
<ObjectFormatTypeText>XML</ObjectFormatTypeText>
<LayoutName>CleanseMatch</LayoutName>
<LayoutVersion>3.0</LayoutVersion>
<!--CharacterSetCode>23423</CharacterSetCode-->
<LanguageCode>331</LanguageCode>
<CompressTypeValue>None</CompressTypeValue>
<RecordsCount>4294967295</RecordsCount>
</InputObjectDetail>
</InputDetail>
<OutputSpecification>
<OutputMethodValue>Online</OutputMethodValue>
<ObjectFormatTypeText>XML</ObjectFormatTypeText>
<CompressTypeValue>None</CompressTypeValue>
</OutputSpecification>
<BatchReferenceDetail>
<BatchReferenceText>String</BatchReferenceText>
</BatchReferenceDetail>
</tmb:ProcessBatchRequest>
------=_Part_0_7350969.1468334235922
Content-Type: application/octet-stream;
name=attachment-attach-clnstxt1419439046092640363.dat
Content-Transfer-Encoding: binary
Content-Disposition: form-data; name="attachment-attach-clnstxt1419439046092640363.dat"; filename="attachment-attach-clnstxt1419439046092640363.dat"
<BatchCleanseMatchRequest>
<com:GetCleanseMatchRequest ServiceVersionNumber="5.0" xmlns:com="http://services.dnb.com/CompanyServiceV2.0" xmlns:gbs="http://services.dnb.com/GlobalBatchServiceV1.0" xmlns:tns="http://services.dnb.com/ProcessBatchServiceV1.0">
<TransactionDetail>
<ApplicationTransactionID>ServiceGovernance-MiniBatchSamples</ApplicationTransactionID>
<TransactionTimestamp>2011-12-22T06:40:58.906Z</TransactionTimestamp>
<SubmittingOfficeID>325</SubmittingOfficeID>
</TransactionDetail>
<GetCleanseMatchRequestDetail>
<InquiryDetail>
<DUNSNumber>804735132</DUNSNumber>
<Address>
<StreetAddressLine>
<LineText>492 KOLLER ST</LineText>
</StreetAddressLine>
<PrimaryTownName>SAN FRANCISCO</PrimaryTownName>
<CountryISOAlpha2Code>US</CountryISOAlpha2Code>
<TerritoryName>CO</TerritoryName>
<FullPostalCode>94110</FullPostalCode>
</Address>
</InquiryDetail>
<MatchSpecification>
<CandidateMaximumQuantity>1</CandidateMaximumQuantity>
</MatchSpecification>
<InquiryReferenceDetail>
<CustomerReferenceText>ServiceGovernance-MiniBatchSamples</CustomerReferenceText>
<CustomerBillingEndorsementText>ServiceGovernance-MiniBatchSamples</CustomerBillingEndorsementText>
</InquiryReferenceDetail>
</GetCleanseMatchRequestDetail>
</com:GetCleanseMatchRequest>
<com:GetCleanseMatchRequest ServiceVersionNumber="5.0" xmlns:com="http://services.dnb.com/CompanyServiceV2.0" xmlns:gbs="http://services.dnb.com/GlobalBatchServiceV1.0" xmlns:tns="http://services.dnb.com/ProcessBatchServiceV1.0">
<TransactionDetail>
<ApplicationTransactionID>ServiceGovernance-Samples</ApplicationTransactionID>
<TransactionTimestamp>2011-12-22T06:40:58.906Z</TransactionTimestamp>
<SubmittingOfficeID>325</SubmittingOfficeID>
</TransactionDetail>
<GetCleanseMatchRequestDetail>
<InquiryDetail>
<SubjectName>D & B SAMPLE CO LTD</SubjectName>
<Address>
<StreetAddressLine>
<LineText>MARLOW INTERNATIONAL PARKWAY</LineText>
</StreetAddressLine>
<PrimaryTownName>MARLOW</PrimaryTownName>
<CountryISOAlpha2Code>GB</CountryISOAlpha2Code>
<FullPostalCode>SL7 1AJ</FullPostalCode>
</Address>
</InquiryDetail>
<MatchSpecification>
<CandidateMaximumQuantity>1</CandidateMaximumQuantity>
</MatchSpecification>
<InquiryReferenceDetail>
<CustomerReferenceText>ServiceGovernance-MiniBatchSamples</CustomerReferenceText>
<CustomerBillingEndorsementText>ServiceGovernance-MiniBatchSamples</CustomerBillingEndorsementText>
</InquiryReferenceDetail>
</GetCleanseMatchRequestDetail>
</com:GetCleanseMatchRequest>
</BatchCleanseMatchRequest>
------=_Part_0_7350969.1468334235922--
| Name | Characteristics |
|---|---|
| ProcessBatchRequest | Aggregate |
| ProcessBatchRequest@ServiceVersionNumber | Attribute |
| ProcessBatchRequest. BatchDetail | Aggregate, Required Records information necessary to process a particular request. |
| ProcessBatchRequest. 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. |
| ProcessBatchRequest. 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: ProcessBatchRequest. BatchDetail | /Aggregate |
| ProcessBatchRequest. BatchSpecification | Aggregate, Required Records specific information that are required for processing a Batch Request. |
| ProcessBatchRequest. BatchSpecification. BatchProcessID | string up to 32 chars., Required Code used to uniquely identify the business function to be performed (e.g., Match, Cleanse, Match and Cleanse). |
| ProcessBatchRequest. InputDetail | Aggregate, Required Records information about the input into the Batch process. |
| ProcessBatchRequest. InputDetail. InputObjectDetail | Aggregate, Optional (Array) |
| ProcessBatchRequest. InputDetail. InputObjectDetail. ContentObject | base64Binary, Required Records or holds the actual file (e.g. data, picture, blob) stored within the attachment. |
| ProcessBatchRequest. InputDetail. InputObjectDetail. ObjectFormatTypeText | string up to 5 chars., Required Format of the Content Object (eg: XML, CSV etc) |
| ProcessBatchRequest. InputDetail. InputObjectDetail. 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. |
| ProcessBatchRequest. InputDetail. InputObjectDetail. LayoutVersion | string up to 10 chars., Required The version of the service for the underlying request. |
| END: ProcessBatchRequest. InputDetail. InputObjectDetail | /Aggregate |
| END: ProcessBatchRequest. InputDetail | /Aggregate |
| ProcessBatchRequest. OutputSpecification | Aggregate, Required Records information about the output specification. |
| ProcessBatchRequest. OutputSpecification. OutputMethodValue | string, Required Call Back, FTP, JMS Queue, Web Service Possible value(s): Online |
| ProcessBatchRequest. OutputSpecification. ObjectFormatTypeText | string, Required XML,CSV,JSON Possible value(s): XML |
| END: ProcessBatchRequest. OutputSpecification | /Aggregate |
| ProcessBatchRequest. BatchReferenceDetail | Aggregate, Optional Records data that allows the customer to specify information to be linked to the request in order to support subsequent process. |
| ProcessBatchRequest. BatchReferenceDetail. BatchReferenceText | string up to 240 chars., Optional(Up to 5x) A freeform reference string provided by the customer to be linked to the product in order to support subsequent process. |
| END: ProcessBatchRequest. BatchReferenceDetail | /Aggregate |
| END: ProcessBatchRequest | /Aggregate |
Endpoint
Use the following endpoint for requesting this feature. The {version} is dependent on the underlying service delivering the response.
| Endpoint (TransactionalMiniBatch) |
|---|
| POST https://direct.dnb.com/V{version}/TransactionalMiniBatch/Batches |
Testing
This operation will return a static set of results in the D&B Direct test environment (sandbox), regardless of the request parameters.
Feature Response
Specification
The following is a list of the possible data fields returned by this operation in the XML response. Samples are provided for testing successful and failed retrieval, and to demonstrate the basic layout of a response. The data returned in samples may not represent actual values that this feature will deliver.
The MTOM attachment specified in the ContentObject is a base64 encoded field that, when decoded, will be in the format specified by ObjectFormatTypeText.
NOTE: This operation will send back a response in XML, regardless of the ObjectFormatTypeText value submitted on the request.
HTTP/1.1 200 OK Via: 1.1 dbslsigwb02 (), 1.1 dbslsegwb01 () Connection: Keep-Alive X-CorrelationID: Id-9d008557ce1004004c6f0800eb145518 0; Id-9d008557983e0000b9fa020093063534 0 Date: Tue, 12 Jul 2016 14:37:17 GMT X-Powered-By: Servlet/2.5 JSP/2.1 Content-Type: multipart/related; boundary=MIME_Boundary; start=1929615216734855129-26222b14.155def02c16.528; type="application/xop+xml"; start-info="text/xml" Vary: Accept-Encoding Content-Encoding: gzip Content-Length: 2699 --MIME_Boundary Content-ID: 1929615216734855129-26222b14.155def02c16.528 Content-Type: application/xop+xml; charset="utf-8"; type="text/xml" <?xml version="1.0" encoding="utf-8"?> <tran:ProcessBatchResponse xmlns:tran="http://services.dnb.com/TransactionalMiniBatchV1.0" xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" ServiceVersionNumber="2"><BatchDetail><ApplicationBatchID>ServiceGovernance-MiniBatchSamples</ApplicationBatchID><ServiceBatchID>Id-9d008557ce1004004c6f0800eb145518-1</ServiceBatchID><MessageTimeStamp>2001-12-17T09:30:47-05:00</MessageTimeStamp></BatchDetail><BatchResult><SeverityText>Information</SeverityText><ResultID>CM000</ResultID><ResultText>Success</ResultText></BatchResult><OutputDetail><OutputObjectDetail><ObjectFormatTypeText>XML</ObjectFormatTypeText><LayoutName>CleanseMatch</LayoutName><LanguageCode>331</LanguageCode><CompressTypeValue>None</CompressTypeValue><RecordsCount>4294967295</RecordsCount><ContentObject><inc:Include xmlns:inc="http://www.w3.org/2004/08/xop/include" href="cid:26222b14:155def02c16:54c"/></ContentObject></OutputObjectDetail></OutputDetail><BatchProcessSummary><ExectuionTimeSummary><BatchRequestCreatedTimeStamp>2001-12-17T09:30:47-05:00</BatchRequestCreatedTimeStamp><BatchReceivedTimeStamp>2001-12-17T09:30:47-05:00</BatchReceivedTimeStamp><ActualProcessCompletionTimestamp>2016-07-12T10:37:20</ActualProcessCompletionTimestamp></ExectuionTimeSummary><RecordSummary><TotalInputRecordCount>2</TotalInputRecordCount><TotalOutputRecordCount>2</TotalOutputRecordCount><TotalPassedRecordCount>2</TotalPassedRecordCount><TotalFailedRecordCount>0</TotalFailedRecordCount></RecordSummary></BatchProcessSummary></tran:ProcessBatchResponse> --MIME_Boundary Content-ID: <26222b14:155def02c16:54c> Content-Type: application/octet-stream <BatchCleanseMatchResponse xmlns:soap-env="http://schemas.xmlsoap.org/soap/envelope/"><com:GetCleanseMatchResponse ServiceVersionNumber="5.0" xmlns:com="http://services.dnb.com/CompanyServiceV2.0" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><TransactionDetail><ApplicationTransactionID>ServiceGovernance-MiniBatchSamples</ApplicationTransactionID><ServiceTransactionID>Id-9f0085574d6504009735090046e71c7e-2</ServiceTransactionID><TransactionTimestamp>2016-07-12T10:37:20</TransactionTimestamp></TransactionDetail><TransactionResult><SeverityText>Information</SeverityText><ResultID>CM000</ResultID><ResultText>Success</ResultText></TransactionResult><GetCleanseMatchResponseDetail><InquiryDetail><DUNSNumber>804735132</DUNSNumber><Address><StreetAddressLine><LineText>492 KOLLER ST</LineText></StreetAddressLine><PrimaryTownName>SAN FRANCISCO</PrimaryTownName><CountryISOAlpha2Code>US</CountryISOAlpha2Code><TerritoryName>CO</TerritoryName><FullPostalCode>94110</FullPostalCode></Address></InquiryDetail><MatchResponseDetail><MatchDataCriteriaText>DUNS Number Lookup</MatchDataCriteriaText><CandidateMatchedQuantity>1</CandidateMatchedQuantity><MatchCandidate><DUNSNumber>804735132</DUNSNumber><OrganizationPrimaryName><OrganizationName>GORMAN MANUFACTURING COMPANY, INC.</OrganizationName></OrganizationPrimaryName><PrimaryAddress><StreetAddressLine><LineText>492 KOLLER ST</LineText></StreetAddressLine><PrimaryTownName>SAN FRANCISCO</PrimaryTownName><CountryISOAlpha2Code>US</CountryISOAlpha2Code><PostalCode>94110</PostalCode><TerritoryAbbreviatedName>CA</TerritoryAbbreviatedName><UndeliverableIndicator>false</UndeliverableIndicator></PrimaryAddress><MailingAddress><CountryISOAlpha2Code>US</CountryISOAlpha2Code><UndeliverableIndicator>false</UndeliverableIndicator></MailingAddress><TelephoneNumber><TelecommunicationNumber>6505550000</TelecommunicationNumber><UnreachableIndicator>false</UnreachableIndicator></TelephoneNumber><OperatingStatusText>Active</OperatingStatusText><FamilyTreeMemberRole><FamilyTreeMemberRoleText>Headquarters</FamilyTreeMemberRoleText></FamilyTreeMemberRole><StandaloneOrganizationIndicator>false</StandaloneOrganizationIndicator><MatchQualityInformation><ConfidenceCodeValue>10</ConfidenceCodeValue><MatchGradeText>AAAAAAAAAAA</MatchGradeText><MatchGradeComponentCount>11</MatchGradeComponentCount><MatchGradeComponent><MatchGradeComponentTypeText>Name</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchGradeComponent><MatchGradeComponentTypeText>Street Number</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchGradeComponent><MatchGradeComponentTypeText>Street Name</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchGradeComponent><MatchGradeComponentTypeText>City</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchGradeComponent><MatchGradeComponentTypeText>State</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchGradeComponent><MatchGradeComponentTypeText>PO Box</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchGradeComponent><MatchGradeComponentTypeText>Phone</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchGradeComponent><MatchGradeComponentTypeText>Postal Code</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchGradeComponent><MatchGradeComponentTypeText>Density</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchGradeComponent><MatchGradeComponentTypeText>Uniqueness</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchGradeComponent><MatchGradeComponentTypeText>Sic</MatchGradeComponentTypeText><MatchGradeComponentRating>A</MatchGradeComponentRating><MatchGradeComponentScore>0.0</MatchGradeComponentScore></MatchGradeComponent><MatchDataProfileComponentCount>0</MatchDataProfileComponentCount></MatchQualityInformation><DisplaySequence>1</DisplaySequence></MatchCandidate></MatchResponseDetail><InquiryReferenceDetail><CustomerReferenceText>ServiceGovernance-MiniBatchSamples</CustomerReferenceText><CustomerBillingEndorsementText>ServiceGovernance-MiniBatchSamples</CustomerBillingEndorsementText></InquiryReferenceDetail></GetCleanseMatchResponseDetail></com:GetCleanseMatchResponse><com:GetCleanseMatchResponse ServiceVersionNumber="5.0" xmlns:com="http://services.dnb.com/CompanyServiceV2.0" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><TransactionDetail><ApplicationTransactionID>ServiceGovernance-Samples</ApplicationTransactionID><ServiceTransactionID>Id-9f008557e8570400474e0200a5494fdc-1</ServiceTransactionID><TransactionTimestamp>2016-07-12T10:37:20</TransactionTimestamp></TransactionDetail><TransactionResult><SeverityText>Information</SeverityText><ResultID>CM000</ResultID><ResultText>Success</ResultText></TransactionResult><GetCleanseMatchResponseDetail><InquiryDetail><SubjectName>D & B SAMPLE CO LTD</SubjectName><Address><StreetAddressLine><LineText>MARLOW INTERNATIONAL PARKWAY</LineText></StreetAddressLine><PrimaryTownName>MARLOW</PrimaryTownName><CountryISOAlpha2Code>GB</CountryISOAlpha2Code><FullPostalCode>SL7 1AJ</FullPostalCode></Address></InquiryDetail><MatchResponseDetail><MatchDataCriteriaText>Name and Address Lookup</MatchDataCriteriaText><CandidateMatchedQuantity>1</CandidateMatchedQuantity><MatchCandidate><DUNSNumber>229515499</DUNSNumber><OrganizationPrimaryName><OrganizationName>DUN & BRADSTREET LIMITED</OrganizationName></OrganizationPrimaryName><PrimaryAddress><StreetAddressLine><LineText>MARLOW INTERNATIONAL</LineText></StreetAddressLine><PrimaryTownName>MARLOW</PrimaryTownName><CountryISOAlpha2Code>GB</CountryISOAlpha2Code><PostalCode>SL7 1AJ</PostalCode><UndeliverableIndicator>false</UndeliverableIndicator></PrimaryAddress><MailingAddress><CountryISOAlpha2Code>GB</CountryISOAlpha2Code><UndeliverableIndicator>false</UndeliverableIndicator></MailingAddress><TelephoneNumber><TelecommunicationNumber>01628492000</TelecommunicationNumber><UnreachableIndicator>false</UnreachableIndicator></TelephoneNumber><OperatingStatusText>Active</OperatingStatusText><FamilyTreeMemberRole><FamilyTreeMemberRoleText>Headquarters</FamilyTreeMemberRoleText></FamilyTreeMemberRole><StandaloneOrganizationIndicator>false</StandaloneOrganizationIndicator><OrganizationIdentificationNumberDetail TypeText="CRO Number" DNBCodeTableNumber="7" DNBCodeValue="2541"><OrganizationIdentificationNumber>00160043</OrganizationIdentificationNumber></OrganizationIdentificationNumberDetail><MatchQualityInformation><ConfidenceCodeValue>8</ConfidenceCodeValue><MatchBasis><EndIndicator>false</EndIndicator><SubjectTypeText>Business</Subjec
| Name | Characteristics |
|---|---|
| ProcessBatchResponse | Aggregate |
| ProcessBatchResponse @ServiceVersionNumber | Attribute |
| ProcessBatchResponse { BatchDetail | Aggregate, Required Records information necessary to return a particular response. |
| ProcessBatchResponse { 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. |
| ProcessBatchResponse { 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. |
| ProcessBatchResponse { BatchDetail { MessageTimeStamp | Element |
| END: ProcessBatchResponse } BatchDetail | /Aggregate |
| ProcessBatchResponse { BatchResult | Aggregate, Optional Records information about the result of the process. |
| ProcessBatchResponse { BatchResult { SeverityText | string, Required Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal. |
| ProcessBatchResponse { BatchResult { ResultID | string, up to 32 chars, Required An alphanumeric string that uniquely identifies the outcome of the batch. |
| ProcessBatchResponse { BatchResult { ResultText | string, up to 512 chars, Optional Text that explains the outcome of the batch. |
| ProcessBatchResponse { 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. |
| ProcessBatchResponse { BatchResult { ResultMessage { ResultDescription | string, up to 512 chars, Required Text that describes the additional information regarding the outcome of the batch. |
| END: ProcessBatchResponse } BatchResult } ResultMessage | /Aggregate |
| END: ProcessBatchResponse } BatchResult | /Aggregate |
| ProcessBatchResponse { OutputDetail | Aggregate, Optional Records information about the output of the Batch process. |
| ProcessBatchResponse { OutputDetail { OutputObjectDetail | Aggregate, Optional (Array) |
| ProcessBatchResponse { OutputDetail { OutputObjectDetail { ObjectFormatTypeText | string, up to 5 chars, Required Describes the format of the attached file, e.g., txt, pdf, html. Possible values: JSON; XML |
| ProcessBatchResponse { 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. |
| ProcessBatchResponse { OutputDetail { OutputObjectDetail { ContentObject | base64Binary, Required Records or holds the actual file (e.g. data, picture, blob) stored within the attachment. |
| END: ProcessBatchResponse } OutputDetail } OutputObjectDetail | /Aggregate |
| END: ProcessBatchResponse } OutputDetail | /Aggregate |
| ProcessBatchResponse { BatchProcessSummary | Aggregate, Optional Records information about the process time and the number of records processed. |
| ProcessBatchResponse { BatchProcessSummary { ExecutionTimeSummary | Aggregate, Optional Records information about the process time and completion time. |
| ProcessBatchResponse { BatchProcessSummary { ExecutionTimeSummary { BatchRequestCreatedTimeStamp | dateTime, Required The date and time when the batch request was created by the submitting application. |
| ProcessBatchResponse { BatchProcessSummary { ExecutionTimeSummary { BatchReceivedTimeStamp | dateTime, Optional The date and time when the batch request was received by the service. |
| ProcessBatchResponse { 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: ProcessBatchResponse } BatchProcessSummary } ExecutionTimeSummary | /Aggregate |
| ProcessBatchResponse { 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. |
| ProcessBatchResponse { BatchProcessSummary { RecordSummary { TotalInputRecordCount | integer, Optional A numeric value denoting the total number of records contained in the input file. |
| ProcessBatchResponse { BatchProcessSummary { RecordSummary { TotalOutputRecordCount | integer, Optional A numeric value denoting the total number of records contained in the output file. |
| ProcessBatchResponse { BatchProcessSummary { RecordSummary { TotalPassedRecordCount | string, Optional A numeric value denoting the total number of records which have passed the requested process. |
| ProcessBatchResponse { BatchProcessSummary { RecordSummary { TotalFailedRecordCount | string, Optional A numeric value denoting the total number of records which have failed the requested process. |
| END: ProcessBatchResponse } BatchProcessSummary } RecordSummary | /Aggregate |
| END: ProcessBatchResponse } BatchProcessSummary | /Aggregate |
| END: ProcessBatchResponse | /Aggregate |
Response Codes & Error Handling
Successful service requests will return a CM000 response code in the BatchResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.
This operation may return the following response codes: CM002, CM004, and SC001-SC008.
NOTE: Each individual request will return a response code in the GetCleanseMatchResponse TransactionResult ResultID field. Refer to On-Demand Single Entity Resolution for a list of valid response codes.
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.
Qualified usage (e.g., a successful response) is tracked and billed according to the terms & conditions of the customer's contract. The response codes CM000, CM010, PD002 and PD015 are considered successful. A built-in feature exists to prevent duplicate billing when multiple successful requests with the same criteria are submitted on the same calendar day (which is based on Eastern Standard Time [GMT-5]).
The usage details for a Small batch request are recorded as a series of individual requests of the underlying request type. Therefore, customer online usage (OLUS) reports will display multiple entries for each batch submitted.
Feature Notes
The results from this feature will be a base 64 encoded concatenated block of separate On-Demand Single Entity Resolution responses (based on the format specified on the request).
This feature may make multiple attempts to locate the D-U-N-S Number, initially using the cleansed input criteria. If a high confidence match is not located, a subsequent search will be performed using the original input criteria, and the results of both attempts will be merged and sorted to provide the highest confidence matches available..
When a multi-line address is provided (e.g. building number, street name and post office box in a single request), this feature will return the proper address for mailing purposes.
Response codes will be returned for the overall result, as well as, for each individual product request.
What to do Next
- Medium Batch Cleanse Process (up to 10,000 companies per batch)
- Single Cleanse/Match Option
- © Dun & Bradstreet, Inc. 2019 – 2024. All rights reserved.