DUN & BRADSTREET. D&B Direct 2.0. API Documentation for ProductCatalog Service. SOAP and REST Service Version 2.1

Transcription

1 DUN & BRADSTREET D&B Direct 2.0 API Documentation for ProductCatalog Service SOAP and REST Service Version 2.1 PREPARED ON WEDNESDAY, APRIL 08, 2015

2 D&B, Dun & Bradstreet, DUNSRight Quality Process, D-U-N-S Number, WorldBase and the D&B logo are registered marks in the U.S., and in other countries, of Dun & Bradstreet, Incorporated. Other trademarks used herein are the trademarks or registered trademarks of their respective owners. This document is a work of authorship that belongs to Dun and Bradstreet, Incorporated and is protected by United States and foreign copyright laws and international copyright treaties. The use of the software and this Documentation is governed by the Dun and Bradstreet Incorporated software license agreement. D&B DOES NOT GUARANTEE OR WARRANT SYSTEMS AVAILABILITY OR PERFORMANCE IN ACCORDANCE WITH THE FIGURES WITHIN THIS DOCUMENT, NOR DOES D&B ACCEPT ANY LIABILITY FOR DAMAGES WHICH MAY BE SUFFERED AS A RESULT OF PLACING ANY RELIANCE ON THESE FIGURES. D&B RESERVES THE RIGHT TO AMEND THIS DOCUMENT AT ANY TIME AND WILL ADVISE THE CUSTOMER ACCORDINGLY OF ANY SUCH AMENDMENTS OR CHANGES. Dun & Bradstreet, Inc All rights reserved. ABOUT DUN & BRADSTREET Dun & Bradstreet (NYSE: DNB) grows the most valuable relationships in business. By uncovering truth and meaning from data, we connect customers with the prospects, suppliers, clients and partners that matter most, and have since Nearly ninety percent of the Fortune 500, and companies of every size around the world, rely on our data, insights and analytics. For more about Dun & Bradstreet, visit DNB.com.

3 Contents These pages provide business overviews; explaining requirements and the business elements that will be delivered. For suggested uses of the API components, please refer to the Solutions menu option on the developer.dnb.com home page. Title / Overview Link Fraud Risk Score Manufacturing Data Product Availability Lookup Product Catalog Download These pages provide the technical specifications that a developer will need to obtain information using D&B Direct. Service Operation / SOAP Resource / REST n/a [Authentication Process] POST Authentication GetFraudScore GET organizations? fraudscore=true OrderManufacturingData GET dataexchange/indinterface/companies/{duns}?id_type=duns_ number Product Catalog Service ListAvailableProduct GetProductCatalog GET organizations/{duns}/products GET productcatalog Service History Version Date Interface(s) Change(s) D&B DIRECT 2.0 DUN & BRADSTREET, INC

4 About this Documentation The D&B Direct 2.0 API Reference materials are organized into product, feature, service and operation pages. Throughout the documentation, certain items are marked as eligible for custom products and/or for inclusion in the monitoring process. Key Concepts Business Elements vs. Data Fields The D&B Direct API has been designed to efficiently deliver information, and as a result, multiple business elements are often delivered in the same data field (with separate attributes signaling the specific contents of a data field). The documentation highlights the business elements (i.e. business-oriented labels) on product pages; and the data fields (i.e. technical, variable-like names used within the delivery packages) on operation pages -- with the business elements linked to the corresponding data field for each available implementation. Data Layers The D&B Direct API delivers information in data layers, some of which have multiple levels. For the purpose of this documentation, the term Product is used to represent a given level for a data layer. For example, "Detailed Company Profile" is the Data Layer, while "Detailed Company Profile - Enhanced" will be referred to as a Product. Custom Products D&B Direct offers a customization service that allows for up to eight pre-configured products to be delivered through the API web service. Throughout the documentation, business elements and data fields which are eligible for inclusion in a custom product are designated with a [C] marker. D&B DIRECT 2.0 DUN & BRADSTREET, INC ABOUT THIS DOCUMENTATION 4

5 Service Versions It is important to note that D&B Direct 2.x implements version control at the service level, in addition to the API level. For example, the current version of the Assessment Product Service is Version 2.0 (API) / 3.0 (Service). D&B Direct services will be updated (major and minor version changes) without a API version change. Following the example given, it will be possible for the Assessment Product Service to change to Version 2.0 (API) / 3.1 (Service) or Version 2.0 (API) / 4.0 (Service) based on the significance of the changes made to the service. Product Pages These are non-technical pages that describe the information (i.e. business elements) returned by the dataoriented operations. In addition, the requirements and options for requesting data are mentioned. Feature Pages These are also non-technical pages, but explain the use of operations that provide a function (e.g. search) and often return the items (i.e. D-U-N-S Number) required to request data products. Service Pages These are technical pages that explain what operations a given API web service provides, the correct version and endpoints, WSDL location (for SOAP), and how to download samples and data dictionaries specific to the service. While services are not applicable for REST implementations, the documentation is organized around them for consistency. Operation Pages These are also technical pages, but describe (for each available implementation method) the individual functions provided by a service, listing the input field names and requirements, and the output with data fields (including data type, size, description and possible values). Release Histories Whenever an operation is enhanced (or a minor correction is made), a notation will be added to a section on the bottom of the affected SOAP/REST operation page. If the change is significant and results in a version change, the release history will maintain a link to the documentation for the previous version(s). Getting Started While the API Reference documentation provides extensive details on each operation and data layer, for more summarized explanations of common tasks/uses refer to the collection of How To Guides. D&B DIRECT 2.0 DUN & BRADSTREET, INC ABOUT THIS DOCUMENTATION 5

6 Product Availability Lookup This feature returns a list of available products for an organization based on the entitlement of the customer's current contract. There is no usage fee for this D&B Direct feature, and all customers are entitled to utilize it. Requirements & Options When implementing this D&B Direct feature, a valid D-U-N-S Number for a company and its country code will be required. If this information is not available, refer to obtaining a company D-U-N-S Number for assistance. A trade up option exists to request data for the headquarters when the requested organization is a branch. When ordering information for organizations located in Germany, you will also be required to provide an order reason code. An option exists to filter the results for a specific D&B Direct product code. Business Elements The following table is an alphabetical list of the elements returned by this feature. Name Description XML* JSON* D-U-N-S Number Identifier of case SOAP REST Fields Exist Indicator Indicates whether required fields are available. Data sufficiency check. Possible values: Yes or No SOAP REST In Date Status In Date Code to indicate product availability. Values are 1 for 'In date' and 2 for 'Promise Later' or 3 for 'Too Old' SOAP REST Investigation Investigation is allowed on this product or not. SOAP REST Investigation Priority Provides the type of investigation priority that s supported for the product SOAP REST Non Branch Indicator Indicates if the product is available on branch or not. SOAP REST D&B DIRECT 2.0 DUN & BRADSTREET, INC PRODUCT AVAILABILITY LOOKUP 6

7 Description XML* JSON* Out of Business Indicator (Organization) Product Availabilty Indicator Indicates if the business if out of business. SOAP REST Whether the product is available or not SOAP REST Product Code A code value that identifies a D&B Product SOAP REST Product Language Code Language code in which the product is available. SOAP REST Product Name A textual description of the product code SOAP REST Report Format Format in which the report is available e.g. HTML, PDF, text, etc. SOAP REST Stop Distribution Indicator Indicator signifying company record is on stop distribution status in the D&B database. SOAP REST * The links in this column provide technical characteristics for the data field characteristics of the respective business element in the XML (SOAP) or JSON (REST) response. The preceding list is not presented in the order, nor manner, in which the information is packaged and delivered via the D&B Direct API. This feature will return a list of all entitled products for the organization. An indicator will designate whether a given data or report product is currently available. Exception: this feature does NOT return availability information for the Data Exchange Service related products. Technical Specification For details on how to implement this feature, please refer to the Product Catalog Service documentation. D&B DIRECT 2.0 DUN & BRADSTREET, INC PRODUCT AVAILABILITY LOOKUP 7

8 Product Catalog Service Version 2.0 (API) / 2.1 (Service) All D&B Direct customers are entitled to utilize this service, and no usage fees will be incurred when invoking the operations. Functions This D&B Direct service includes the following functionality. The respective SOAP and/or REST pages provide technical details including input parameters, responses and sample requests. Function / Overview Link Operation / SOAP Resource / REST Product Availability Lookup ListAvailableProduct() GET organizations/{duns}/products Product Catalog Download GetProductCatalog() GET productcatalog The List Available Product function provides lists of available products for organizations based on the entitlement of the customer's current contract. The Get Product Catalog function provides access to a list of entitled products, and, if requested, the fields within each that may be included in the Data Layer/Field Monitoringprocess. Interfaces & Endpoints D&B Direct implements version control at the web service level, in addition to the API level. This D&B Direct 2.0 {version} of the Product Catalog Service is 2.1. When contacting D&B customer support, please provide both the API and Service version numbers. The following table(s) identify version-specific access points for the available API interfaces. D&B DIRECT 2.0 DUN & BRADSTREET, INC PRODUCT CATALOG SERVICE 8

9 SOAP Endpoint WSDL * *There may be operations defined in the WSDL that are not available to D&B Direct customers at this time. REST ListAvailableProduct GetProductCatalog GET GET D&B Direct API calls must be made using Secured Socket Layers (SSL) as reflected in the preceding table(s). D&B DIRECT 2.0 DUN & BRADSTREET, INC PRODUCT CATALOG SERVICE 9

10 ListAvailableProduct (REST) This operation -- part of the Product Catalog Service -- provides access to the Product Availability Lookup feature. Authentication & Endpoint D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) is determined by the credentials submitted with each API request. Refer to the service page for the correct version of the operation. Endpoint GET Feature Request The following parameters are accepted by this operation. Name {version} ApplicationTransactionID Element string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (REST) 10

11 TransactionTimestamp datetime, Optional The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. SubmittingOfficeID string up to 64 chars., Optional A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated. {DUNS} string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required The subject identifier under the Data Universal Numbering System of the inquired subject. CountryISOAlpha2Code string at least 2 chars. up to 2 chars., Required The two-letter country code, defined in the ISO scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject. DNBProductID string up to 64 chars., Optional An alphanumeric string that uniquely identifies the deliverable being requested. PreferredLanguageCode integer up to 7 digits., Optional A code that defines the language in which the requested product or deliverable is required to be fulfilled. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (REST) 11

12 TradeUpIndicator boolean, Optional When true (set to 1) this denotes that the customer has requested that D&B return the data for the Headquarters when the requested organization is a Branch. When false (set to 0) this denotes that the customer has not requested that D&B return the data for the Headquarters when the requested organization is a Branch; however as this is the assumed condition there is no requirement to create this tag to represent this fact. Note: There are D&B WorldWide Network operations where the Headquarters information will be returned automatically, regardless of the customer request. OrderReasonCode integer up to 7 digits., Optional A D&B code value that defines the grounds for the customer requesting the product, e.g., required to support a credit decision. CustomerReferenceText string at least 1 chars. up to 240 chars., Optional A freeform reference string provided by the customer to be linked to the product in order to support subsequent order reconciliation. CustomerBillingEndorsementText string at least 1 chars. up to 240 chars., Optional Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided.this text is a reference used during the billing process. Testing / Sandbox This operation will return results in the D&B Direct sandbox (test) environment only when a test D-U-N-S Number is provided in the request parameters. Feature Response The following is a list of the possible data fields returned by this operation in the JSON response NOTE: For an explanation of the D&B Direct REST implementation, refer to our JSON response guidelines. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (REST) 12

13 ListAvailableProductResponse Aggregate Attribute ListAvailableProductResponse { TransactionDetail Aggregate, Required Records information necessary to process a particular request. Examples of a request is the ordering of a product. ListAvailableProductResponse { TransactionDetail { ApplicationTransactionID ListAvailableProductResponse { TransactionDetail { ServiceTransactionID ListAvailableProductResponse { TransactionDetail { TransactionTimestamp string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. string up to 64 chars., Required A number assigned by the D&B service to uniquely identify this transaction. datetime, 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: ListAvailableProductResponse } TransactionDetail ListAvailableProductResponse { TransactionResult Aggregate, Required An aggregate that can repeat multiple times to record the different outcomes of the transaction. ListAvailableProductResponse { TransactionResult { SeverityText ListAvailableProductResponse { TransactionResult { ResultID ListAvailableProductResponse { TransactionResult { ResultText string up to 16 chars., Required Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal. string up to 32 chars., Required An alphanumeric string that uniquely identifies the outcome of the transaction. string up to 512 chars., Optional Text that explains the outcome of the transaction. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (REST) 13

14 ListAvailableProductResponse { TransactionResult { ResultMessage ListAvailableProductResponse { TransactionResult { ResultMessage { ResultDescription END: ListAvailableProductResponse } TransactionResult } ResultMessage END: ListAvailableProductResponse } TransactionResult ListAvailableProductResponse { ListAvailableProductResponseDetail ListAvailableProductResponse { ListAvailableProductResponseDetail { InquiryDetail ListAvailableProductResponse { ListAvailableProductResponseDetail { InquiryDetail { DUNSNumber ListAvailableProductResponse { ListAvailableProductResponseDetail { InquiryDetail { CountryISOAlpha2Code END: ListAvailableProductResponse } ListAvailableProductResponseDetail } InquiryDetail ListAvailableProductResponse { ListAvailableProductResponseDetail { DUNSNumber Aggregate, Optional (Infinite) 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. string up to 512 chars., Required Text that describes the additional information regarding the outcome of the transaction. Aggregate, Optional Records data being returned to the customer as a result of products availability request for a given Duns Number and Country. Aggregate, Required Records data that allows the customer to specify identifying information about the subject being inquired, e.g., the DUNS Number, the address, the telephone number. string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required The subject identifier under the Data Universal Numbering System of the inquired subject. string at least 2 chars. up to 2 chars., Required The two-letter country code, defined in the ISO scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject. string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S). D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (REST) 14

15 ListAvailableProductResponse { ListAvailableProductResponseDetail { StopDistributionIndicator ListAvailableProductResponse { ListAvailableProductResponseDetail { OutOfBusinessIndicator ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { DNBProductID ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { DNBProductName ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { LanguageAvailability ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { LanguageAvailability { LanguageCode END: ListAvailableProductResponse } ListAvailableProductResponseDetail } AvailableProductDetail } LanguageAvailability boolean, Optional When true (set to 1) this indicates that D&B should not fabricate or supply the data recorded in the D&B Database on this subject. When false (set to 0) this indicates that D&B can fabricate or supply the data recorded in the D&B Database on this subject; however, as this is the assumed condition there is no requirement to create this tag to represent this fact. boolean, Optional When true (set to 1) it indicates that this organization is no longer actively trading. When false (set to 0) it indicates that this organization is actively trading; however as this is the assumed condition there is no requirement to create this tag to represent this fact. Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of the products and their availability status delivered to the customer for a given Duns Number and Country. string up to 64 chars., Required An alphanumeric string that uniquely identifies this product. string up to 256 chars., Required Text that specifies the name of the product. Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of one or more languages in which this product is available. integer up to 7 digits., Required A D&B code value that defines a language in which the specified product is available. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (REST) 15

16 ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { ProductFormatAvailability ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { ProductFormatAvailability { ProductFormatText ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { ProductFormatAvailability { ProductFormatText@DNBCodeValue ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { ProductFormatAvailability { ProductFormatText@DNBCodeTableNumber END: ListAvailableProductResponse } ListAvailableProductResponseDetail } AvailableProductDetail } ProductFormatAvailability ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { DeliverableProductIndicator ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { IndateStatusText Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of one or more formats which are available for the specified product. string up to 256 chars., Required Text that defines a format in which the specified product is available. Attribute Attribute boolean, Required When true (set to 1) this indicates that the specified product is currently available to be supplied to the customer. When false (set to 0) this indicates that the specified product is not currently available to be supplied to the customer. When NULL (tag is absent) this indicates that it is not known whether the specified product is currently available to be supplied to the customer or that the type of product is not applicable for delivery. string up to 256 chars., Optional Text denoting status of the product on the subject; e.g. in-date, promised later, too old, DUNS Support Record. This status determines what is returned to the customer. A status of in-date would mean that the report is answered from file (AFF) and returned to the customer. A status of promised later would mean that the report is out of date, it is returned to the customer as it currently stands and the customer will receive an updated report after D&B has completed the update. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (REST) 16

17 ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { IndateStatusText@DNBCodeValue ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { IndateStatusText@DNBCodeTableNumber ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { SufficientDataAvailableIndicator ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { ProductAvailableOnBranchIndicator ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { InvestigationAvailabilityIndicator ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { InvestigationPriorityAvailability ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { InvestigationPriorityAvailability { InvestigationPriorityText ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { InvestigationPriorityAvailability { InvestigationPriorityText@DNBCodeValue Attribute Possible values: [Too Old]; [In date]; [Promise Later] Attribute boolean, Optional When true (set to 1), it indicates that is enough data available for this product to be vended. When false (set to 0), it indicates that there is not enough data available for this product to be vended. boolean, Optional When true (set to 1), it indicates that this product is available for organizations that are classified as a branch. When false (set to 0), it indicates that this product is not available for organizations that are classified as a branch. boolean, Optional When true (set to 1) this indicates that it is possible to request that research is undertaken to update or fulfill the requirements of the specified product. When false (set to 0) this indicates that it is not possible to request that research is undertaken to update or fulfill the requirements of the specified product. Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of one or more levels of priority which are available if a request for research is placed in order to fulfill the specified product. string up to 256 chars., Required Text that describes a level of priority which is available if a request for research is placed in order to fulfill the specified product. Attribute Possible values: 6347 [Routine]; 6344 [Priority] D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (REST) 17

18 ListAvailableProductResponse { ListAvailableProductResponseDetail { AvailableProductDetail { InvestigationPriorityAvailability { InvestigationPriorityText@DNBCodeTableNumber END: ListAvailableProductResponse } ListAvailableProductResponseDetail } AvailableProductDetail } InvestigationPriorityAvailability END: ListAvailableProductResponse } ListAvailableProductResponseDetail } AvailableProductDetail ListAvailableProductResponse { ListAvailableProductResponseDetail { InquiryReferenceDetail ListAvailableProductResponse { ListAvailableProductResponseDetail { InquiryReferenceDetail { CustomerReferenceText ListAvailableProductResponse { ListAvailableProductResponseDetail { InquiryReferenceDetail { CustomerBillingEndorsementText END: ListAvailableProductResponse } ListAvailableProductResponseDetail } InquiryReferenceDetail END: ListAvailableProductResponse } ListAvailableProductResponseDetail END: ListAvailableProductResponse Attribute Aggregate, Optional Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation. string at least 1 chars. 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 order reconciliation. string at least 1 chars. up to 240 chars., Optional Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided.this text is a reference used during the billing process. Language/Character Sets The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including the D&B Business Information Report (BIR), provide additional language options. Data layers are encoded using the ISO character set standard (also known as Latin-1). Response Codes Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standard response codes will be returned. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (REST) 18

19 This operation may return the following response codes: CM002, CM003, CM004, CM008, CM010, CM011, CM012, CM014, CM017, PD005, SC001-SC008. Samples (Download) Request and response samples are available for this D&B Direct web services. The samples may cover a variety of scenarios (when applicable) and are designed for use in the test environment. Product Catalog Service Samples D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (REST) 19

20 ListAvailableProduct (SOAP) This operation -- part of the Product Catalog Service -- provides access to the Product Availability Lookup feature. Authentication, Endpoint & WSDL D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) is determined by the credentials submitted with each API request. Refer to the service page for the correct version of the operation. Endpoint Feature Request The following parameters are accepted by this operation. Name ListAvailableProductRequest Aggregate Attribute ListAvailableProductRequest. TransactionDetail Aggregate, Optional Records information necessary to process this request. ListAvailableProductRequest. TransactionDetail. ApplicationTransactionID string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (SOAP) 20

21 ListAvailableProductRequest. TransactionDetail. TransactionTimestamp ListAvailableProductRequest. TransactionDetail. SubmittingOfficeID END: ListAvailableProductRequest. TransactionDetail ListAvailableProductRequest. ListAvailableProductRequestDetail ListAvailableProductRequest. ListAvailableProductRequestDetail. InquiryDetail ListAvailableProductRequest. ListAvailableProductRequestDetail. InquiryDetail. DUNSNumber ListAvailableProductRequest. ListAvailableProductRequestDetail. InquiryDetail. CountryISOAlpha2Code END: ListAvailableProductRequest. ListAvailableProductRequestDetail. InquiryDetail ListAvailableProductRequest. ListAvailableProductRequestDetail. ProductAvailabilitySpecification datetime, Optional The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary. string up to 64 chars., Optional A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated. Aggregate, Required Records data required to check product availability for a given DUNS Number and Country and deliver the list of all products and their availability status to the customer. Aggregate, Required Records data that allows the customer to specify identifying information about the subject being inquired, e.g., the DUNS Number, the address, the telephone number. string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required The subject identifier under the Data Universal Numbering System of the inquired subject. string at least 2 chars. up to 2 chars., Required The two-letter country code, defined in the ISO scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject. Aggregate, Optional Records data that allows the customer to specify the details of the requested product. This may include details such as the identifier of the product, the language in which the product needs to be rendered, the format in which the product needs to be rendered. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (SOAP) 21

22 ListAvailableProductRequest. ListAvailableProductRequestDetail. ProductAvailabilitySpecification. DNBProductID ListAvailableProductRequest. ListAvailableProductRequestDetail. ProductAvailabilitySpecification. PreferredLanguageCode ListAvailableProductRequest. ListAvailableProductRequestDetail. ProductAvailabilitySpecification. TradeUpIndicator ListAvailableProductRequest. ListAvailableProductRequestDetail. ProductAvailabilitySpecification. OrderReasonCode END: ListAvailableProductRequest. ListAvailableProductRequestDetail. ProductAvailabilitySpecification ListAvailableProductRequest. ListAvailableProductRequestDetail. InquiryReferenceDetail ListAvailableProductRequest. ListAvailableProductRequestDetail. InquiryReferenceDetail. CustomerReferenceText ListAvailableProductRequest. ListAvailableProductRequestDetail. InquiryReferenceDetail. CustomerBillingEndorsementText string up to 64 chars., Optional An alphanumeric string that uniquely identifies the deliverable being requested. integer up to 7 digits., Optional A code that defines the language in which the requested product or deliverable is required to be fulfilled. boolean, Optional When true (set to 1) this denotes that the customer has requested that D&B return the data for the Headquarters when the requested organization is a Branch. When false (set to 0) this denotes that the customer has not requested that D&B return the data for the Headquarters when the requested organization is a Branch; however as this is the assumed condition there is no requirement to create this tag to represent this fact. Note: There are D&B WorldWide Network operations where the Headquarters information will be returned automatically, regardless of the customer request. integer up to 7 digits., Optional A D&B code value that defines the grounds for the customer requesting the product, e.g., required to support a credit decision. Aggregate, Optional Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation. string at least 1 chars. 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 order reconciliation. string at least 1 chars. up to 240 chars., Optional Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided.this text is a reference used during the billing process. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (SOAP) 22

23 END: ListAvailableProductRequest. ListAvailableProductRequestDetail. InquiryReferenceDetail END: ListAvailableProductRequest. ListAvailableProductRequestDetail END: ListAvailableProductRequest Testing / Sandbox This operation will return results in the D&B Direct sandbox (test) environment only when a test D-U-N-S Number is provided in the request parameters. Feature Response The following is a list of the possible data fields returned by this operation in the XML response. Name ListAvailableProductResponse Aggregate ListAvailableProductResponse@ServiceVersionNumber Attribute ListAvailableProductResponse. TransactionDetail Aggregate, Required Records information necessary to process a particular request. Examples of a request is the ordering of a product. ListAvailableProductResponse. TransactionDetail. ApplicationTransactionID ListAvailableProductResponse. TransactionDetail. ServiceTransactionID ListAvailableProductResponse. TransactionDetail. TransactionTimestamp END: ListAvailableProductResponse. TransactionDetail string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. string up to 64 chars., Required A number assigned by the D&B service to uniquely identify this transaction. datetime, 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. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (SOAP) 23

24 ListAvailableProductResponse. TransactionResult Aggregate, Required An aggregate that can repeat multiple times to record the different outcomes of the transaction. ListAvailableProductResponse. TransactionResult. SeverityText ListAvailableProductResponse. TransactionResult. ResultID ListAvailableProductResponse. TransactionResult. ResultText ListAvailableProductResponse. TransactionResult. ResultMessage ListAvailableProductResponse. TransactionResult. ResultMessage. ResultDescription END: ListAvailableProductResponse. TransactionResult. ResultMessage END: ListAvailableProductResponse. TransactionResult ListAvailableProductResponse. ListAvailableProductResponseDetail ListAvailableProductResponse. ListAvailableProductResponseDetail. InquiryDetail string up to 16 chars., Required Text that records the criticality of the outcome, e.g., Information, Warning, Error, Fatal. string up to 32 chars., Required An alphanumeric string that uniquely identifies the outcome of the transaction. string up to 512 chars., Optional Text that explains the outcome of the transaction. Aggregate, Optional (Infinite) 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. string up to 512 chars., Required Text that describes the additional information regarding the outcome of the transaction. Aggregate, Optional Records data being returned to the customer as a result of products availability request for a given Duns Number and Country. Aggregate, Required Records data that allows the customer to specify identifying information about the subject being inquired, e.g., the DUNS Number, the address, the telephone number. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (SOAP) 24

25 ListAvailableProductResponse. ListAvailableProductResponseDetail. InquiryDetail. DUNSNumber ListAvailableProductResponse. ListAvailableProductResponseDetail. InquiryDetail. CountryISOAlpha2Code END: ListAvailableProductResponse. ListAvailableProductResponseDetail. InquiryDetail ListAvailableProductResponse. ListAvailableProductResponseDetail. DUNSNumber ListAvailableProductResponse. ListAvailableProductResponseDetail. StopDistributionIndicator ListAvailableProductResponse. ListAvailableProductResponseDetail. OutOfBusinessIndicator ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. DNBProductID string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required The subject identifier under the Data Universal Numbering System of the inquired subject. string at least 2 chars. up to 2 chars., Required The two-letter country code, defined in the ISO scheme published by International Organization for Standardization (ISO)identifying the country of the inquired subject. string up to 15 chars. Pattern: {([0-9a-zA-Z]*)}., Required The D-U-N-S Number is D&B's identification number, which provides unique identification of this organization, in accordance with the Data Universal Numbering System (D-U-N-S). boolean, Optional When true (set to 1) this indicates that D&B should not fabricate or supply the data recorded in the D&B Database on this subject. When false (set to 0) this indicates that D&B can fabricate or supply the data recorded in the D&B Database on this subject; however, as this is the assumed condition there is no requirement to create this tag to represent this fact. boolean, Optional When true (set to 1) it indicates that this organization is no longer actively trading. When false (set to 0) it indicates that this organization is actively trading; however as this is the assumed condition there is no requirement to create this tag to represent this fact. Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of the products and their availability status delivered to the customer for a given Duns Number and Country. string up to 64 chars., Required An alphanumeric string that uniquely identifies this product. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (SOAP) 25

26 ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. DNBProductName ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. LanguageAvailability ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. LanguageAvailability. LanguageCode END: ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. LanguageAvailability ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. ProductFormatAvailability ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. ProductFormatAvailability. ProductFormatText ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. ProductFormatAvailability. ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. ProductFormatAvailability. END: ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. ProductFormatAvailability string up to 256 chars., Required Text that specifies the name of the product. Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of one or more languages in which this product is available. integer up to 7 digits., Required A D&B code value that defines a language in which the specified product is available. Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of one or more formats which are available for the specified product. string up to 256 chars., Required Text that defines a format in which the specified product is available. Attribute Attribute D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (SOAP) 26

27 ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. DeliverableProductIndicator ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. IndateStatusText ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. boolean, Required When true (set to 1) this indicates that the specified product is currently available to be supplied to the customer. When false (set to 0) this indicates that the specified product is not currently available to be supplied to the customer. When NULL (tag is absent) this indicates that it is not known whether the specified product is currently available to be supplied to the customer or that the type of product is not applicable for delivery. string up to 256 chars., Optional Text denoting status of the product on the subject; e.g. in-date, promised later, too old, DUNS Support Record. This status determines what is returned to the customer. A status of in-date would mean that the report is answered from file (AFF) and returned to the customer. A status of promised later would mean that the report is out of date, it is returned to the customer as it currently stands and the customer will receive an updated report after D&B has completed the update. Attribute Possible values: [Too Old]; [In date]; [Promise Later] Attribute ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. SufficientDataAvailableIndicator boolean, Optional When true (set to 1), it indicates that is enough data available for this product to be vended. When false (set to 0), it indicates that there is not enough data available for this product to be vended. ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. ProductAvailableOnBranchIndicator boolean, Optional When true (set to 1), it indicates that this product is available for organizations that are classified as a branch. When false (set to 0), it indicates that this product is not available for organizations that are classified as a branch. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (SOAP) 27

28 ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. InvestigationAvailabilityIndicator ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. InvestigationPriorityAvailability boolean, Optional When true (set to 1) this indicates that it is possible to request that research is undertaken to update or fulfill the requirements of the specified product. When false (set to 0) this indicates that it is not possible to request that research is undertaken to update or fulfill the requirements of the specified product. Aggregate, Optional (Infinite) An entry loop which can repeat multiple times to allow the recording of one or more levels of priority which are available if a request for research is placed in order to fulfill the specified product. ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. InvestigationPriorityAvailability. InvestigationPriorityText ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. InvestigationPriorityAvailability. InvestigationPriorityText@DNBCodeValue ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. InvestigationPriorityAvailability. InvestigationPriorityText@DNBCodeTableNumber END: ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail. InvestigationPriorityAvailability END: ListAvailableProductResponse. ListAvailableProductResponseDetail. AvailableProductDetail ListAvailableProductResponse. ListAvailableProductResponseDetail. InquiryReferenceDetail ListAvailableProductResponse. ListAvailableProductResponseDetail. InquiryReferenceDetail. CustomerReferenceText string up to 256 chars., Required Text that describes a level of priority which is available if a request for research is placed in order to fulfill the specified product. Attribute Possible values: 6347 [Routine]; 6344 [Priority] Attribute Aggregate, Optional Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation. string at least 1 chars. 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 order reconciliation. D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (SOAP) 28

29 ListAvailableProductResponse. ListAvailableProductResponseDetail. InquiryReferenceDetail. CustomerBillingEndorsementText END: ListAvailableProductResponse. ListAvailableProductResponseDetail. InquiryReferenceDetail END: ListAvailableProductResponse. ListAvailableProductResponseDetail END: ListAvailableProductResponse string at least 1 chars. up to 240 chars., Optional Text that is filled in by customer and commonly contains requesting individual or department name, or customer's own account/reference number and/or name for the case on which the product was provided.this text is a reference used during the billing process. Language/Character Sets The text contained within D&B Direct 2.0 data layers is returned in English. Several reports, including the D&B Business Information Report (BIR), provide additional language options. Data layers are encoded using the ISO character set standard (also known as Latin-1). Response Codes Successful service requests will return a CM000 response code. Otherwise, one of the D&B Direct standard response codes will be returned. This operation may return the following response codes: CM002, CM003, CM004, CM008, CM010, CM011, CM012, CM014, CM017, PD005, SC001-SC008. Samples (Download) Request and response samples are available for this D&B Direct web services. The samples may cover a variety of scenarios (when applicable) and are designed for use in the test environment. Product Catalog Service Samples D&B DIRECT 2.0 DUN & BRADSTREET, INC LISTAVAILABLEPRODUCT (SOAP) 29

30 GetProductCatalog (REST) This operation -- part of the Product Catalog Service -- provides access to a list of entitled products, and, if requested, the fields within each that may be included in the Data Layer/Field Monitoring process. Authentication & Endpoint D&B Direct web services require authentication, and the data environment (i.e. production, trial or sandbox) is determined by the credentials submitted with each API request. Refer to the service page for the correct version of the operation. Endpoint GET Feature Request The following parameters are accepted by this operation. Name {version} ApplicationTransactionID Element string up to 64 chars., Optional A number assigned by the calling application to uniquely identify this request. D&B DIRECT 2.0 DUN & BRADSTREET, INC GETPRODUCTCATALOG (REST) 30