Research - State/Province
|Initial Release||October 3, 2013|
State & Province Profiles deliver industry and economic insight, employment and real estate trends, and valuable resource links for each of the fifty US States, Washington, D.C. and ten Canadian Provinces.
No modifications have been made to this data layer since the initial release.
IMPORTANT: Due to a known issue, please do not include request values for SubmittingOfficeID.
IMPORTANT: Please see the new Online Services Security Enhancement Release, effective November 09, 2020.
When requesting this D&B Directdata layer, you will be required to supply either a two-letter US state or Canadian province abbreviation, and the appropriate product code. Both abbreviations are case-sensitive.
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 product is entitled as "Industry Profile - Advanced Search" 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.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ind="http://services.dnb.com/IndustryProductServiceV2.0"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="0" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsse:UsernameToken wsu:Id="UsernameToken-11"> <wsse:Username>MyUserName</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">MyPassword</wsse:Password> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <ind:OrderProductRequest ServiceVersionNumber=""> <TransactionDetail> <ApplicationTransactionID>Unique Advanced</ApplicationTransactionID> <SubmittingOfficeID>333</SubmittingOfficeID> </TransactionDetail> <OrderProductRequestDetail> <InquiryDetail> <Location> <ISOCountrySubDivisionCode>CA-ON</ISOCountrySubDivisionCode> </Location> </InquiryDetail> <ProductSpecification> <DNBProductID>IND_ADV</DNBProductID> <LanguagePreferenceCode>39</LanguagePreferenceCode> <ProfileChapterName>BusinessChallenges</ProfileChapterName> </ProductSpecification> <InquiryReferenceDetail> <CustomerReferenceText>Industry Profile – Advanced Search</CustomerReferenceText> <CustomerBillingEndorsementText>TC0523-12</CustomerBillingEndorsementText> </InquiryReferenceDetail> </OrderProductRequestDetail> </ind:OrderProductRequest> </soapenv:Body> </soapenv:Envelope>
|OrderProductRequest. TransactionDetail||Aggregate, Optional|
Records information necessary to process this request.
|OrderProductRequest. TransactionDetail. ApplicationTransactionID||string up to 64 chars., Optional|
A number assigned by the calling application to uniquely identify this request.
|OrderProductRequest. TransactionDetail. TransactionTimestamp||DateTimestamp, Optional|
The date and time when this request was created. When the request is from an intermediary, such as a workflow manager or service bus, this is the date and time when the message was sent to the D&B function, i.e., the date and time when the xml document was created by the requesting intermediary.
|OrderProductRequest. TransactionDetail. SubmittingOfficeID||string up to 64 chars., Optional|
A number that identifies the system or the software application from where this request originated. / A number used to uniquely identfy the D&B business segment or delivery channel from where this request originated.
|End: OrderProductRequest. TransactionDetail||/Aggregate|
|OrderProductRequest. OrderProductRequestDetail||Aggregate, Optional|
Records data relating to requests for a product. This may include such details as the product required, the subject about which the product should be produced, the content of the product.
|OrderProductRequest. OrderProductRequestDetail. InquiryDetail||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.
|OrderProductRequest. OrderProductRequestDetail. InquiryDetail. Location||Aggregate, Optional|
Records the components of a location for which the business activity profile information is requested.
|OrderProductRequest. OrderProductRequestDetail. InquiryDetail. Location. ISOCountrySubDivisionCode||string up to 6 chars., Required|
Code represented in ISO 3166-2 scheme defining the name of a principal subdivision (e.g., province or state) of a country coded in ISO 3166-1; e.g., US-NJ represents the state New Jersey in United States, CA-ON represents the province Ontario in Canada. The first part is the ISO 3166-1 alpha-2 code of the country; The second part is a string of up to three alphanumeric characters, which is usually obtained from national sources and stems from coding systems already in use in the country concerned, but may also be developed by the ISO itself.
|End: OrderProductRequest. OrderProductRequestDetail. InquiryDetail. Location||/Aggregate|
|End: OrderProductRequest. OrderProductRequestDetail. InquiryDetail||/Aggregate|
|OrderProductRequest. OrderProductRequestDetail. ProductSpecification||Aggregate, Required|
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.
|OrderProductRequest. OrderProductRequestDetail. ProductSpecification. DNBProductID||string, Optional|
An alphanumeric string that uniquely identifies the product being requested.
|OrderProductRequest. OrderProductRequestDetail. ProductSpecification. LanguagePreferenceCode||integer up to 7 digits., Optional|
A D&B code value that defines the language in which the customer wants this product to be rendered.
|End: OrderProductRequest. OrderProductRequestDetail. ProductSpecification||/Aggregate|
|OrderProductRequest. OrderProductRequestDetail. ArchiveDetail||Aggregate, Optional|
|OrderProductRequest. OrderProductRequestDetail. ArchiveDetail. ArchiveProductOptOutIndicator||boolean, Optional|
When true (set to 1), it indicates that the product being ordered is not to be stored. When false (set to 0), it indicates that the product being ordered is to be stored; however as this is the assumed condition there is no requirement to create this tag to represent this fact.
|OrderProductRequest. OrderProductRequestDetail. ArchiveDetail. ExtendArchivePeriodIndicator||boolean, Optional|
When true (set to 1), the duration to archive the data is to be extended. Note: There is an additional cost for extending the archival period of the data purchased. When false (set to 0), the duration to archive the data is not to be extended.
|OrderProductRequest. OrderProductRequestDetail. ArchiveDetail. PortfolioAssetContainerID||long, Optional|
A number used to uniquely identify the location where this product is to be stored.
|End: OrderProductRequest. OrderProductRequestDetail. ArchiveDetail||/Aggregate|
|OrderProductRequest. OrderProductRequestDetail. InquiryReferenceDetail||Aggregate, Optional|
Records data that allows the customer to specify information to be linked to the request in order to support subsequent order reconciliation.
|OrderProductRequest. OrderProductRequestDetail. InquiryReferenceDetail. CustomerReferenceText||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 order reconciliation.
|OrderProductRequest. OrderProductRequestDetail. InquiryReferenceDetail. 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.
|End: OrderProductRequest. OrderProductRequestDetail. InquiryReferenceDetail||/Aggregate|
|End: OrderProductRequest. OrderProductRequestDetail||/Aggregate|
Use the following endpoint with the downloadable WSDL to request this product.
The following parameters may be used for D&B Direct 2.0 developer sandbox requests to retrieve successful responses. The data returned from sandbox requests may not represent actual values that this feature will deliver.
|Research - Industry Code||Industry code:1958|
|Research - State/Province||ISOCountrySubDivisionCode:US-NJ|
While data for a particular company may not contain values for each of the business elements, there may be items that are considered by D&B to be "essential" to yield the maximum benefit of a data layer. If any of these essential elements do not contain a value for a particular company, a PD005 response code will be returned, and your organization will not incur a usage credit for the request.
For all codified data delivered by D&B Direct, the response package will include the decoded text value as a data element with the code value attached as an attribute. Refer to the Reference Data Service for access to the D&B standard code tables.
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.
NOTE: The D-U-N-S Number returned in the response will be a nine-digit zero-padded, numeric value.(missing or bad snippet)
Legend: [C] = may be included in a Custom Data product; [M] = may be referenced by the Monitoring process; [M+] = Monitored using an aggregate or attribute XPath.
Lists of possible values (when present) are subject to change. Additional values not presented in this documentation may be delivered in the response and should be anticipated in any implementation.
A NULL returned for an element indicates that the information was not provided to D&B when the related data items were collected. The absence of a value for a particular item should not be considered indicative of any implied value (e.g., NULL for a boolean indicator is NOT the same as a value of 'false').
NOTE: There may be additional request and/or response elements specified in the WSDL that are not applicable for D&B Direct customers. Data elements that are not listed on this page are currently unused by this operation.
Response Codes & Error Handling
Successful service requests will return a CM000 response code in the TransactionResult ResultID field. Otherwise, one of the D&B Direct standard response codes will be returned.
This operation may return the following response codes: CM001-CM005, CM007-CM012, CM014, CM017, CM018, PD001, PD003, PD005, PD006, PD015, PD016,PD019 and SC001-SC012.
IMPORTANT: PD006 code - Applicable only for US/CA cases when TradeUpIndicator="true" for Risk packets.
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 D-U-N-S Number and product code are submitted on the same calendar day (which is based on Eastern Standard Time [GMT-5]).
Retrieving Archived Copies
An option exists to retain the results from all successful requests for this product in a Product Request Archive, which may be retrieved without incurring additional usage charges.
NOTE: The default value for ArchiveProductOptOutIndicator is 'true', indicating that the request will NOT be automatically archived.
While D&B Direct uses a product canonical naming model in the request/response, many customers may be more familiar with the following business element labels.
|Industry Profile Chapter Name||[C]|
|Industry Profile Key Fact||[C]|
|Industry Profile Paragraph Details||Text of the First Research chapter paragraph [C]|
|Industry Profile Paragraph Images Link||Text that records the location of images referenced by this Web-based content. [C]|
|Industry Profile Paragraph Site Link||Text that records the location of this Web-based content. [C]|
|Industry Profile Paragraph Title||[C]|
|Industry Profile Territory Code||A code the name of a principal subdivision (e.g., province or state) of a country; e.g., US-NJ represents the state New Jersey in United States, CA-ON represents the province Ontario in Canada. [C]|
|Industry Profile Territory Image Link||Text that records the location of images referenced by this Web-based content. [C]|
|Industry Profile Territory or State Name||Text recording the name of the locally governed area which forms part of a centrally governed nation as received by D&B. Clarification Note: As a guiding principle this is a geographic area which could theoretically exist as a separate nation. In the U.S [C]|
|Location Profile Related Industry Code||An alphanumeric value identifying a business activity based on the scheme specified by the description. For example, 1611 represents the highway and street construction industry in the U.S. SIC (Standard Industrial Classification) system. [C]|
|Location Profile Related Industry Description||Text that describes the business activity based on the scheme specified by the code. For example, 'highway and street construction' is the description of industry code 1611 in the U.S. SIC (Standard Industrial Classification) system. [C]|
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. Legend: [C] = may be included in a Custom Data product; [M] = may be referenced by the Monitoring process; [M+] = Monitored using an aggregate or attribute XPath.
Industry profiles are updated quarterly and comprehensively reviewed once a year. News articles and most statistical data are updated monthly. All industry forecast numbers come from the INFORUM modeling data base, which is built on historic data derived from official government figures.