Vin Decoder 720 User Guide

Build
with VIN Decoder API

DataOne
Web Services
DataOne Web Services: VIN Decoder API

DATAONE SOFTWARE | A DIVISION OF DOMINION ENTERPRISES
© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

VIN Decoder API v7.2.0
Revised July 2, 2018
Table of Contents
Overview.....................................................................................................................................................................4
Precise Style Matching with the VIN Decoder API ...............................................................................................4
Vehicle Lookups Without a VIN ...........................................................................................................................4
Available Data Packs ............................................................................................................................................5
Accessing the Service via our Client Portal.................................................................................................................5
Querying the Web Service ..........................................................................................................................................6
Input Message Structure......................................................................................................................................6
When Using XML ...........................................................................................................................................6
When Using JSON ....................................................................................................................................... 10
HTTPS POST Request Structure ......................................................................................................................... 10
Interpreting the Web Service Response .................................................................................................................. 11
Decoder Messages ............................................................................................................................................ 11
Query Responses .............................................................................................................................................. 12
Styles .......................................................................................................................................................... 13
Basic Data ................................................................................................................................................... 14
OEM Pricing ................................................................................................................................................ 14
Engines ....................................................................................................................................................... 15
Transmissions ............................................................................................................................................. 16
Specifications .............................................................................................................................................. 17
Standard Generic Equipment ..................................................................................................................... 19
Optional Generic Equipment ...................................................................................................................... 20
OEM Descriptions for Optional Equipment ................................................................................................ 21
Available Interior & Exterior Colors ............................................................................................................ 22
Warranties .................................................................................................................................................. 23
EPA Fuel Economy Ratings ......................................................................................................................... 23
EPA Green Scores ....................................................................................................................................... 24
NHTSA 5-Star Crash Test Ratings ................................................................................................................ 25
NHTSA Recalls ............................................................................................................................................. 26
NHTSA Service Bulletins ............................................................................................................................. 26
ACES (AAIA) Veh/Eng/Trans Mapping ........................................................................................................ 27
2|Page
Kelley Blue Book Mapping .......................................................................................................................... 27
NADA Mapping ........................................................................................................................................... 27
COX (AIS) Incentives & Rebates Mapping .................................................................................................. 28
TGP Tires..................................................................................................................................................... 28
Media.......................................................................................................................................................... 29
Single Stock Images .................................................................................................................................... 30
Multiple Stock Images ................................................................................................................................ 30
Mapping to Evox Images ............................................................................................................................ 31
Evox Single-Angle Studio Images ................................................................................................................ 31
Evox Studio Images..................................................................................................................................... 32
Evox Single-Angle Colorized Images ........................................................................................................... 32
Evox Colorized Images ................................................................................................................................ 33
Mapping to Izmo Images ............................................................................................................................ 33
Mapping to Izmo TLC Images ..................................................................................................................... 33
Awards & Accolades ................................................................................................................................... 34
Vehicle Overviews ...................................................................................................................................... 34
Market Segment ......................................................................................................................................... 34
Common Data ................................................................................................................................................... 35
ID-Only Mode .................................................................................................................................................... 36
ID-Only Mode Syntax .................................................................................................................................. 36
Where to get More Information.............................................................................................................................. 37
Appendix A: Decoder Error Messages ..................................................................................................................... 38
Appendix B: Query Error Messages ......................................................................................................................... 39
Appendix C: Installed & Optional Equipment Category Groups and Categories..................................................... 40

3|Page
Overview
DataOne's VIN Decoder API is a Web Service that provides access to richly detailed and precise vehicle
information, including vehicle descriptors, specifications, installed and optional equipment, warranty data, OEM
pricing, media, awards, and US Government ratings. The API is a REST-based, language-independent HTTPS
interface that you can access using a single HTTPS POST request. Data can be exchanged in either XML or JSON,
and data can be requested for up to 50 vehicles in a single request. The API accepts a wide variety of inputs,
most of which are optional, including 17-digit Vehicle Identification Numbers (VINs), vehicle descriptors such as
year, make, model, trim badging, and OEM model codes, option codes, and color codes.
Precise Style Matching with the VIN Decoder API

VIN Decoding has long been a necessity for many businesses operating in the various sectors of the automotive
industry. Some basic vehicle information is encoded in 10 of the first 11 characters of the VIN (often referred to
as a VIN pattern), and data providers like DataOne have worked fastidiously to tie additional, valuable data to
these VIN patterns. However, the precision of automated VIN decoding has been limited by OEMs that use the
same VIN patterns to represent different trim levels and vehicle styles.
This problem is best illustrated by example. Say we have a VIN, JN8AE2KP9C9123456. Based on the VIN number
alone, any VIN decoder would tell you this as a 2012 Nissan Quest 4-door minivan with front wheel drive and a
3.5L V6 engine. But, since Nissan did not encode the trim in this VIN, there's no way of knowing if it's the 3.5S,
3.5SL, 3.5SV, or 3.5LE. These are significantly different cars with an MSRP ranging from $27,750 to $41,350!
Some OEMs do a better job than others at encoding enough information in the VIN pattern to decode down to a
single vehicle style. For model year 2012, this problem impacts about 30% of the VIN patterns in the US light-
duty passenger vehicle market.
DataOne's VIN Decoder API employs a variety of means to improve the precision with which VINs can be
decoded, and return a precise, single style in as many cases as possible. The VIN Decoder API accepts a wide
variety of inputs in addition to VIN, so that if you have additional vehicle details (perhaps from a DMS system)
such as trim badging, manufacturer model number, or installed transmission description, you can include these
details with your VIN in your request to the API. The VIN Decoder will use these details to determine a single
vehicle style to return whenever possible.
The VIN decoder service can also be configured to return "common data" for each query submitted to the
service. In cases where a single vehicle style cannot be returned using the data submitted to the service, the
"common data" section will show all the vehicle information shared by all of the returned styles.
Vehicle Lookups Without a VIN

In cases when you do not have a VIN, individual styles as well as common data can be accessed by providing a
description of the vehicle's Year, Make, Model, and trim level using DataOne's Search & Research API's getStyles
and getVehicleData API methods. As with our VIN Decoder API, additional inputs can be provided to help
narrow down results to a single style. For more information on how to add this service to your account, please
contact your sales representative or sales@dataonesoftware.com.

4|Page
Available Data Packs
Data in the VIN Decoder API is organized into "Data Packs," as listed below. Some of these data packs may not
currently be available to you, based on the terms of your contract. Please contact your sales representative or
sales@dataonesoftware.com to subscribe to additional data packs.
 Basic data  Single Stock Images*

 Standard Specifications  Multiple Stock Images*
 Optional Specifications*  Mapping to Evox Image IDs*
 Standard Ancillary Specifications*  Evox Single-Angle Studio Image*
 Engines  Evox Studio Images*
 Transmissions  Evox Single-Angle Colorized Image*
 Standard Generic Equipment  Evox Colorized Images*
 Optional Generic Equipment  Izmo Mapping*
 OEM Descriptions for Optional Equipment  Izmo TLC Mapping*
 Available Interior & Exterior Colors  NHTSA Recalls*
 OEM Pricing  NHTSA Service Bulletins*
 Warranties  Vehicle overviews*
 EPA Fuel Economy Ratings  Mapping to ACES (AAIA) Veh/Eng/Trans IDs*
 EPA Green Scores  Kelley Blue Book mapping*
 Awards & Accolades  COX Incentives & Rebates mapping*
 NHTSA 5-Star Crash Test Ratings  NADA mapping*
 Market Segment*  TGP Tires*
* These data packs are disabled by default for VIN Decoder API Trial accounts. To enable these data packs,
please contact our sales team by e-mailing us at sales@dataonesoftware.com or by calling 1-877-GET-VINS.
Accessing the Service via our Client Portal

Our client portal contains a number of tools that you can use to help you get started using the VIN decoder
service. The portal allows you to interact with the API via a web interface, by entering VINs and/or vehicle
details into a simple form. This form generates an XML or JSON document that can be used as input for the web
service, and the interface allows you to submit this input document to the service and receive back results. This
is a great way to experience the data available via the API web service without first having to implement the API
in code.
The client portal also contains links to relevant documentation, whitepapers, XMLSchema (.xsd) files, and code
samples in a number of programming languages.
To access the Client Portal, please visit https://www.dataonesoftware.com/client-portal

5|Page
Querying the Web Service
This section explains how to make a call to the VIN Decoder API web service. First, an XML or JSON message
must be constructed to send to the service as input. This message contains a few decoder settings, a list of the
data packs you wish to receive back from the service, and between 1 and 50 vehicle queries. Vehicle queries can
(and should) contain as much information as you have available for the vehicle you're attempting to decode, and
must include at least VIN or Year, Make, Model, and Trim. Then, your application will need to make an HTTPS
POST request containing the XML or JSON message. The response from the service will be in XML if you
submitted an XML input message, and in JSON if you submitted a JSON input message.
Input Message Structure

The input message is an XML or JSON string sent from your application to the VIN Decoder API web service with
each request. The sections below describe the syntax for XML and JSON. You can use whichever message format
is most convenient for you. Samples of both formats, as well as an XMLSchema file are available via our client
portal (https://www.dataonesoftware.com/client-portal)
When Using XML
The root element, decoder_query, contains two sub-elements: decoder_settings and query_requests.
<decoder_query>
<decoder_settings>
...
</decoder_settings>
<query_requests>
...
</query_requests>
</decoder_query>
The decoder_query section of the Input Message

6|Page
Decoder Settings
The element decoder_settings contains six sub-elements: version, display, styles, style_data_packs,
common_data, and common_data_packs. The "version” element should contain the decoder version you wish
to use (the current version is 7.2.0). The "display" element can contain either the value "full" to indicate that you
wish to receive a complete data response, or "ids" to indicate that you wish to receive only IDs that can be used
with DataOne's delivered database. The "styles" element can contain either the value "on" or "off" to indicate
that you would like to receive a full list of vehicle styles tied to the VIN. The "common_data" element can
contain either "on" or "off" to receive data that is common across the styles tied to each VIN.
<decoder_settings>
<version>7.2.0</version>
<display>(full|ids)</display>
<styles>(on|off)</styles>
<style_data_packs>
...
</style_data_packs>
<common_data>(on|off)</common_data>
<common_data_packs>
...
</common_data_packs>
</decoder_settings>
The decoder_settings section of the Input Message

7|Page
Style and Common Data Packs
The "style_data_packs" and "common_data_packs" elements contain a list of the data packs available via the
VIN Decoder API, with a value of "on" or "off" for each data pack. These sections allow you to turn choose which
data packs will be included in the web service's response, for the styles section and, separately, for the
common_data section. Data packs omitted from your input message default to "off."
Our sample input messages exclude data packs that are, by default, not authorized for Free Trial accounts.
Additionally, Optional Equipment w/ Marketing Descriptions are set to "off" in our samples, but can be accessed
using a Trial account by switching the optional_equipment element to "on."
To enable access to additional data packs for your trial or production account, please contact our sales team at
sales@dataonesoftware.com or 1-877-438-8467.
<style_data_packs|common_data_packs>
<basic_data>(on|off)</basic_data>
<standard_specifications>(on|off)</standard_specifications>
<optional_specifications>(on|off)</optional_specifications>
<standard_ancillary_specifications>(on|off)</standard_ancillary_specifications>
<engines>(on|off)</engines>
<transmissions>(on|off)</transmissions>
<standard_generic_equipment>(on|off)</standard_generic_equipment>
<optional_generic_equipment>(on|off)</optional_generic_equipment>
<oem_options>(on|off)</oem_options>
<colors>(on|off)</colors>
<fuel_efficiency>(on|off)</fuel_efficiency>
<warranties>(on|off)</warranties>
<pricing>(on|off)</pricing>
<single_stock>(on|off)</single_stock>
<multi_stock>(on|off)</multi_stock>
<recalls>(on|off)</recalls>
<service_bulletins>(on|off)</service_bulletins>
<awards>(on|off)</awards>
<nada>(on|off)</nada>
<market_segment>(on|off)</market_segment>
<overview>(on|off)</overview>
<green_scores>(on|off)</green_scores>
<crash_test>(on|off)</crash_test>
<aces>(on|off)</aces>
<kelley_blue_book_mapping>(on|off)</kelley_blue_book_mapping>
<izmo_image>(on|off)</izmo_image>
<izmo_tlc_image>(on|off)</izmo_tlc_image>
<evox>(on|off)</evox>
<evox_stills_single_640px>(on|off)</ evox_stills_single_640px>
<evox_stills_640px>(on|off)</ evox_stills_640px>
<evox_colors_single_640px>(on|off)</ evox_colors_single_640px>
<evox_colors_640px>(on|off)</ evox_colors_640px>
</style_data_packs|common_data_packs>
The style_data_packs and common_data_packs Data Pack Toggles

8|Page
Query Requests
The query_requests element can include between 1 and 50 query_request sub-elements: one query_request for
each VIN or vehicle description you wish to decode. Each query_request element can contain sub-elements for
any additional parameters you wish to provide to aid in matching a single style (see the Precise Style Matching
section of this manual on Page 4). Note that you must submit at least a VIN, or the combination of Year, Make,
Model, and Trim.
The VIN Decoder API web service will attempt to match data that has been placed in the wrong field in the input
structure. For example, if you place a valid manufacturer package code in the same field as the manufacturer
model number, the service will recognize the code and match it accordingly. Because of this, you should not feel
obligated to scrub your inventory data prior to submitting it to our service.
Each query_request can be given an "identifier" attribute to uniquely identify that request. This identifier will be
passed back with the response data, allowing you to match your queries to the response data in cases where
multiple queries are submitted with a single HTTP POST request. We recommend populating this field with a
unique identifier such as VIN or stock number, but this attribute is entirely optional.
<query_requests>
<query_request identifier="(Unique Request Identifier)">
<vin/>
<year/>
<make/>
<model/>
<trim/>
<model_number/>
<package_code/>
<drive_type/>
<vehicle_type/>
<body_type/>
<doors/>
<bedlength/>
<wheelbase/>
<msrp/>
<invoice_price/>
<engine description="(Engine Description)">
<block_type/>
<cylinders/>
<displacement/>
<fuel_type/>
</engine>
<transmission description="(Transmission Description)">
<trans_type/>
<trans_speeds/>
</transmission>
<optional_equipment_codes/>
<installed_equipment_descriptions/>
<interior_color description="">
<color_code/>
<exterior_color description="">
<color_code/>
</exterior_color>
</query_request>
...
</query_requests>
Sample XML for the query_requests section of the Input Message
9|Page
Note that the engine and transmission fields below contain "description" attributes. These are optional, and can
be populated with engine or transmission descriptions in cases where you have not already parsed out
individual engine or transmission attributes such as block type or Automatic/Manual.
The query_requests tag structure:
The optional_equipment_codes section can be populated with a comma-separated list of OEM option codes that
are known by your application to be installed on the vehicle. These can often be retrieved from Dealer
Management Systems. Corresponding options will be flagged as "installed" in our response data.
Similarly, installed equipment descriptions can be provided in lieu of option codes to achieve the same affect.
Note that our ability to mark options installed in our response will be limited to the extent that the provided
descriptions match our standard OEM option descriptions.
Interior and exterior colors can be specified either by OEM color code (often available from DMS), or a textual
description of the color. The corresponding interior or exterior color will be flagged as installed in our response.
When Using JSON
The JSON input message structure mirrors exactly the XML structure described in the previous section. For a
sample JSON input message, please log in to our Client Portal athttps://dataonesoftware.com/client-portal
HTTPS POST Request Structure

DataOne's VIN Decoder API web service accepts HTTPS POST requests using the application/x-www-form-
urlencoded content-type. Each call to the web service needs to include three POST parameters: client_id, and
authorization_code, which can be found in your service activation e-mail, as well as decoder_query, which will
contain the contents of our XML or JSON input message, as described in the preceding "Input Message
Structure" section of this manual.
Web Service URL: https://api.dataonesoftware.com/webservices/vindecoder/decode
POST Parameters: client_id=[Your Client ID]

&authorization_code=[Your Authorization Code]
&decoder_query=[XML or JSON Input Message]

10 | P a g e
Interpreting the Web Service Response
The VIN Decoder API web service will automatically interpret your decoder_query POST parameter as either
JSON or XML, and the service will respond with either JSON or XML accordingly. The following sections describe
our response structure in XML, including all available data packs. The JSON response structure mirrors the XML
structure exactly. Complete samples of response data in both XML and JSON can be found at our Client Portal, at
https://www.dataonesoftware.com/client-portal/. Please note that some of the data packs listed in this section
may not be enabled for your account. To discuss enabling additional data packs, please contact our sales team at
sales@dataonesoftware.com.
Each response from the VIN Decoder API web service contains a root element, decoded_data, which contains
two sub-elements: decoder_messages and query_responses.
<decoded_data>
<decoder_messages>
...
</decoder_messages>
<query_responses>
...
</query_responses>
</decoded_data>
Decoder Messages
The decoder_messages element contains three sub-elements: service_provider, which always contains "DataOne
Software, Inc," decoder_version, and decoder_errors. Both service_provider and decoder_version can be safely
ignored. The decoder_errors element will contain a list of important errors related to your web service call or
your DataOne Web Services account. Errors related to individual VIN or vehicle description queries can be found
in the query_response element group, described in the next section of this manual.
<decoder_messages>
<service_provider>DataOne Software, Inc.</service_provider>
<decoder_version>7.2.0</decoder_version>
<decoder_errors>
...
</decoder_errors>
</decoder_messages>
The decoder_errors element can contain 0 or more error elements. Each error element contains two child
elements: code and message. We recommend that you configure your application to check this section for
errors after each call to the service.
A complete listing of possible decoder errors is listed in Appendix A.

11 | P a g e
Query Responses
The query_responses element will contain one query_response sub-element for each query request passed to
the web service. Each query_response element has an "identifier" attribute, which will include the unique
identifier placed in the "identifier" attribute of the query_request element in the input XML message posted to
the service, as well as a transaction_id provided by DataOne that can be referenced by our customer support
team. Each query_response element can contain up to three sub-elements: query_error, us_market_data, and
supplemental_data. The supplemental_data section contains records for vehicles outside the US Passenger and
Light-Duty market. Note that if supplemental data is not enabled for your account, you can contact
sales@dataonesoftware.com to request that it be added.
The query_error element will always appear in the service's response, even when no error has occurred. It
contains two sub-elements: error_code and error_message, which will both be empty if no error has occurred.
Your application should check this section for errors for each query response.
The us_styles and/or supplemental_styles elements will appear when a web service call is made with the styles
element of the input message set to "on." Similarly, the us_common_data and/or supplemental_common_data
element will appear when a web service call is made with the common_data element set to "on."
<query_responses>
<query_response identifier="" transaction_id="">
<query_error>
<error_code/>
<error_message/>
</query_error>
<us_market_data>
<common_us_data>
...
</common_us_data>
<us_styles count="">
...
</us_styles>
</us_market_data>
<supplemental_data>
<common_supplemental_data>
...
</common_supplemental_data>
<supplemental_styles count="">
...
</supplemental_styles>
</supplemental_data>
</query_response>
...
</query_responses>
NOTE: The structure of the *_common_data elements and their child elements is described in
the "Common Data" section, near the end of this manual.

12 | P a g e
Styles
The us_styles and supplemental_styles sections of the XML return contain one or more style elements. Each style
element corresponds to a unique vehicle style associated with the provided VIN or vehicle description. See the
section "Precise Style Matching" in this manual for an explanation of styles and how they relate to VIN numbers.
Each style element contains five attributes: name, vehicle_id, complete, market, and fleet. The name attribute
includes a unique name that differentiates each style from others within a Year-Make-Model. The combination
of Year, Make, Model, and Style Name uniquely describe a single vehicle in DataOne's vehicle data. The
vehicle_id attribute contains a unique numeric identifier for this vehicle style, which can be used with DataOne's
delivered database products. The complete attribute is a "Y" or "N" flag. A value of "N" indicates that DataOne is
still waiting to receive vehicle details from the OEM, and that certain data for this style may be missing. The
market field indicates which market (for example, US Light-Duty or Canadian) the style record is associated with.
Finally, the fleet field indicates whether or not this vehicle was manufactured for sale as a fleet vehicle. Possible
values include Y, N, and UK (for "Unknown").
Each style element contains a child element for each data pack enabled for your account. Your contract with
DataOne may not include all available data packs, so it is possible you will not see all the elements listed below.
Additionally, you must configure the input message you post to the web service to enable each data pack you
wish to use. For more information, see the section "Querying the Web Service" in this manual.
<us_styles count="2">
<style name="4 Dr GLS SUV"complete="Y" vehicle_id="100187594" market="US Light-
Duty" fleet="N">
<basic_data/>
<pricing/>
<engines/>
<transmissions/>
<standard_specifications/>
<optional_specifications/>
<standard_ancillary_specifications/>
<standard_generic_equipment/>
<optional_generic_equipment/>
<oem_options/>
<colors/>
<warranties/>
<epa_fuel_efficiency/>
<epa_green_scores/>
<nhtsa_crash_test_ratings/>
<nhtsa_recalls/>
<nhtsa_service_bulletins/>
<media/>
<awards_accolades/>
<overview/>
<style/>
...
</styles>
Sample XML for the us_styles Section
NOTE: The structure of the us_styles and supplemental_styles elements and their child elements
are identical, though the supplemental_styles section may not contain all of the data groups
found in the us_styles section.

13 | P a g e
Basic Data
<basic_data>
<market>US Light-Duty</market>
<year>2010</year>
<make>Honda</make>
<model>Pilot</model>
<trim>Touring w/Navi w/DVD</trim>
<vehicle_type>SUV</vehicle_type>
<body_type>SUV</body_type>
<body_subtype></body_subtype>
<oem_body_style>SUV</oem_body_style>
<doors>4</doors>
<oem_doors>4</oem_doors>
<model_number>YF3H9AKNW</model_number>
<package_code></package_code>
<package_summary></package_summary>
<rear_axle></rear_axle>
<drive_type>FWD</drive_type>
<brake_system>Hydraulic</brake_system>
<restraint_type>Driver and passenger front airbags</restraint_type>
<country_of_manufacture>United States</country_of_manufacture>
<plant>Lincoln, Alabama</plant>
<glider></glider>
<chassis_type></chassis_type>
<is_oem_build_data>N</is_oem_build_data>
</basic_data>
Sample XML for the basic_data Data Pack
Note that the oem_body_style and oem_doors elements contain OEM compliant versions of the vehicle's body
style and number of doors, intended for use in marketing displays. The vehicle_type, body_type, body_subtype,
and doors elements contain generic versions of these fields and are ideal for dropdown lists and other situations
where normalization across makes is desired.
OEM Pricing
<pricing>
<msrp>38645</msrp>
<invoice_price>34996</invoice_price>
<destination_charge>740</destination_charge>
<gas_guzzler_tax>0</gas_guzzler_tax>
</pricing>
Sample XML for the pricing Data Pack

14 | P a g e
Engines
Vehicle styles often can be configured with any one of several engine options. An exact engine can always be
determined by VIN, so if you're querying our service using VIN, you will only receive one engine record (as
shown below) in your response. In cases where a VIN is provided, the availability element will always contain
the value "Installed." However, if you're querying our service using vehicle descriptors only, without a VIN, you
may receive multiple engine elements for a single vehicle style. In these cases, one engine's availability attribute
will be set to "Default" to indicate it is the default engine, and the others will be set to "Optional."
<engines>
<engine name="3.5L V6 250hp 253ft. lbs." brand="" marketing_name=""
engine_id="300000260">
<availability>Installed</availability>
<ice_aspiration>N/A</ice_aspiration>
<ice_block_type>V</ice_block_type>
<ice_bore>3.50</ice_bore>
<ice_cam_type>SOHC</ice_cam_type>
<ice_compression>10.5</ice_compression>
<ice_cylinders>6</ice_cylinders>
<ice_displacement>3.5</ice_displacement>
<electric_motor_configuration></electric_motor_configuration>
<electric_max_hp>0</electric_max_hp>
<electric_max_kw>0</electric_max_kw>
<electric_max_torque>0</electric_max_torque>
<engine_code></engine_code>
<engine_type>Internal Combustion</engine_type>
<ice_fuel_induction>SMPI</ice_fuel_induction>
<fuel_quality>87</fuel_quality>
<fuel_type>G</fuel_type>
<fleet>N</fleet>
<generator_description></generator_description>
<generator_max_hp>0</generator_max_hp>
<invoice_price>0</invoice_price>
<marketing_name></marketing_name>
<ice_max_hp>250</ice_max_hp>
<ice_max_hp_at>5700</ice_max_hp_at>
<max_payload></max_payload>
<ice_max_torque>253</ice_max_torque>
<ice_max_torque_at>4800</ice_max_torque_at>
<msrp>0</msrp>
<oil_capacity>5.3</oil_capacity>
<order_code></order_code>
<redline>6300</redline>
<standard>Y</standard>
<ice_stroke>3.66</ice_stroke>
<total_max_hp>250</total_max_hp>
<total_max_hp_at>5700</total_max_hp_at>
<total_max_torque>253</total_max_torque>
<total_max_torque_at>4800</total_max_torque_at>
<ice_valve_timing>VVT</ice_valve_timing>
<ice_valves>24</ice_valves>
</engine>
</engines>
Sample XML for the engines Data Pack

NOTE: A complete Data Dictionary is available in the Documentation section of our Client Portal
at https://www.dataonesoftware.com/ddc

15 | P a g e
Transmissions
Vehicle styles can sometimes be configured with any one of several transmission options. An exact transmission
can sometimes be determined by VIN, and in these cases only a single transmission record will be returned, with
an availability value of "Installed." Additionally, providing a transmission description in the Input Message
posted to our web service may cause the service to select a single transmission out of a pool of more than one.
In cases where a single transmission is returned, the availability element will be set to "Installed." In cases
where both default and optional transmissions are returned, one transmission will have an availability element
set to "Default," and the others will be set to "Optional."
<transmissions>
<transmission name="5-Speed Automatic" brand="" marketing_name=""
transmission_id="222296">
<type>A</type>
<detail_type></detail_type>
<gears>5</gears>
<order_code></order_code>
<msrp>0.00</msrp>
<invoice_price>0.00</invoice_price>
<fleet>N</fleet>
</transmission>
</transmissions>
Sample XML for the transmissions Data Pack

16 | P a g e
Specifications
Specifications are comprised of measurements related to size, performance, and capacity. Specifications are
broken into categories, as shown in the sample below. Certain specifications apply only to certain vehicle types.
For example, the performance specification "Aerodynamic Drag" may not be supplied for an economy car, nor
would "Max Towing Capacity." Similarly, not all categories will be shown for all vehicles. For example, the "Truck
Specifications" category will not be displayed for passenger cars.
Specifications are broken into three data packs, which are described below:
Standard Specifications
These are typical specifications associated with standard vehicle equipment. Note that some specification tied to
specific VINs may not include specification IDs.
<standard_specifications>
<specification_category name="Brakes">
<specification_value id="230059" name="Front Brake Diameter">
12.9
</specification_value>
<specification_value id="230161" name="Rear Brake Diameter">
11.9
</specification_category>
<specification_category name="Weights and Capacities">
<specification_value id="210979" name="Gross Vehicle Weight Range">
5001-6000
<specification_value id="212928" name="Curb Weight">
4041
<specification_value id="220017" name="Fuel Tank Capacity">
18.5
<specification_value id="210147" name="Gross Vehicle Weight Rating">
5137
<specification_value id="228713" name="Max Towing Capacity">
3500
<specification_value id="229988" name="Tonnage">
Compact
<specification_category name="Drivetrain">
<specification_value id="230516" name="Axle Ratio">
3.33
...
</standard_specifications>
Abridged Sample XML for the standard_specifications Data Pack

17 | P a g e
Optional Specifications
These are specifications associated with optional vehicle equipment, such as wheel diameter, or axle ratio.
Currently covers only a limited number of specification types: 4WD Hub Type, Axle Ratio, Brake Diameter, Brake
Width, Tire Type and Description, Wheel Diameter, Wheel Width, Fuel Tank Capacity, GCWR, GVWR, and Seating
Rows.
<optional_specifications>
<specification_category name="Wheels and Tires">
<specification_value id="230402" name="Front Wheel Diameter">
16.0
<specification_value id="230734" name="Rear Wheel Diameter">
16.0
</optional_specifications>
Sample XML for the optional_specifications Data Pack
Standard Ancillary Specifications

These are specifications with limited coverage that may only be available for certain OEMs or models. These
include specifications such as acceleration, drag, and turning radius. Optional values are not available for
ancillary specifications.
<standard_ancillary_specifications>
<specification_category name="Brakes">
<specification_value id="229994" name="Front Brake Width">
1.10
<specification_category name="Exterior Dimensions">
<specification_value id="200084" name="Turning Circle">
37.6
</standard_ancillary_specifications>
Sample XML for the standard_ancillary_specifications Data Pack

18 | P a g e
Standard Generic Equipment
Standard Generic Equipment includes equipment that is installed on the vehicle in its default configuration. This
equipment is broken into category groups and categories, as shown in the sample below. Note that additional
category groups and categories may be added or changed over time, although such changes are very rare. Not
all possible category groups or categories will necessarily be shown for any single vehicle. For example, the
Standard Generic Equipment section for a vehicle without any Security equipment would not include the
"Security" category. A current list of category names can be found in Appendix C.
Each generic_equipment_category_group element has one or more generic_equipment_category child

elements. Similarly, each generic_equipment_category element has one or more generic_equipment child
elements; one for each equipment type. Note that a single generic_equipment element may have one or more
generic_equipment_value child elements. For example, a vehicle with both a Bluetooth and audio jack inputs
would have an generic_equipment element (as shown below) with a name attribute set to "Auxiliary audio
input" and two generic_equipment_value child elements set to "Bluetooth" and "jack."
The “weight” attribute in the generic_equipment_value tag indicates a rank for each equipment value relative to
all other equipment, and ranges from 0 (least important) to 100 (most important). This weight provides a means
of separating major features, such as leather upholstery and navigation, from minor features, such as cup-
holders and antennae.
<standard_generic_equipment>
<generic_equipment_category_group name="Entertainment and Technology">
<generic_equipment_category name="Audio System">
<generic_equipment name="Antenna type">
<generic_equipment_value id="286" weight="0">
element
</generic_equipment_value>
</generic_equipment>
<generic_equipment name="Auxiliary audio input">
Bluetooth
jack
<generic_equipment name="In-Dash CD">
MP3 Playback
single disc
...
</standard_generic_equipment>
Abridged Sample XML for the standard_generic_equipment Data Pack

19 | P a g e
Optional Generic Equipment
The Optional Generic Equipment data pack uses a similar structure as the Standard Generic Equipment data
pack. This section lists optional equipment available on this vehicle, which may or may not be installed on the
vehicle.
As with the Standard Generic Equipment data pack, Optional Generic Equipment is broken into category groups
and categories, as shown in the sample below. Note that additional category groups and categories may be
added or changed over time, although such changes are very rare. Not all possible category groups or categories
will necessarily be shown for any single vehicle. For example, the Standard Installed Equipment section for a
vehicle without any Security equipment would not include the "Security" category. A current list of category
names can be found in Appendix C.
A detailed explanation of the equipment tag structure can be found in the "Standard Installed Equipment"
section of this manual.
<optional_generic_equipment>
<generic_equipment_category_group name="Entertainment and Technology">
<generic_equipment_category name="Audio System">
<generic_equipment name="In-Dash CD">
<generic_equipment_value id="6343" installed="UK" weight="14">
6 disc
</equipment>
</category>
</category_group>
<generic_equipment_category_group name="Exterior">
<generic_equipment_category name="Exterior Features">
<generic_equipment name="Mudguards">
front
rear
<generic_equipment name="Rear spoiler">
wing
</generic_equipment_category>
</generic_equipment_category_group>
...
<optional_generic_equipment>
Abridged Sample XML for the optional_generic_equipment Data Pack

20 | P a g e
OEM Descriptions for Optional Equipment
The OEM Descriptions for Optional Equipment data pack includes a list of optional equipment available on this
vehicle, using OEM-specific naming for model years 2007 and forward. Note that this data pack provides generic
naming for options for model years 1981-2006.
Some of these options may or may not be installed on the vehicle--this generally cannot be determined by VIN
alone. OEM Option codes for installed options can be provided in the input message posted to the web service.
In these cases, matching options will be flagged as installed in this section with a value of "Y" in the installed
attribute. In cases where it is unknown if the equipment is installed, the installed attribute will be set to "UK."
Optional equipment is broken into category groups and categories, as shown in the sample below. Each
oem_option_category_group element has one or more oem_option_category elements, while each
oem_option_category element has one or more oem_option child elements. Note that additional category
groups and categories may be added or changed over time, although such changes are very rare. Not all possible
category groups or categories will necessarily be shown for any single vehicle. For example, the Standard
Installed Equipment section for a vehicle without Security equipment would not include the "Security" category.
A current list of category names can be found in Appendix C.
<oem_options>
<oem_option_category_group name="Entertainment and Technology">
<oem_option_category name="Audio System">
<oem_option name="AM/FM/Cassette/CD Audio System" id="300002481"
oem_option_code="" installed="UK" fleet="N" >
<oem_option_type></oem_option_type>
<oem_option_invoice_price>0</oem_option_invoice_price>
<oem_option_msrp>0</oem_option_msrp>
<oem_option_description>
<![CDATA[]]>
</oem_option_description>
</oem_option>
<oem_option name="AM/FM/CD Changer Audio System" id="300002540"
oem_option_code="" installed="UK" fleet="N" >
<oem_option_type></oem_option_type>
<oem_option_invoice_price>0</oem_option_invoice_price>
<oem_option_msrp>0</oem_option_msrp>
<oem_option_description>
<![CDATA[]]>
</oem_option_description>
</oem_option>
</oem_option_category>
</oem_option_category_group>
</oem_options>
Abridged Sample XML for the oem_options Data Pack

21 | P a g e
Available Interior & Exterior Colors
The colors section is broken up into three subsections: exterior_colors, interior_colors, and roof_colors. Note
that roof colors are only provided when the roof is a different color from the rest of the vehicle (generally this
only happens with convertibles).
Each subsection will contain zero or more color elements, as shown below. The secondary_rgb_code attributes
are set to zero whenever two_tone is set to "N." The value of "N" in this attribute indicates that there is no
secondary color for a given color.
<colors>
<exterior_colors>
<color mfr_code="JK" two_tone="N">
<generic_color_name>Beige</generic_color_name>
<mfr_color_name>Sandstone</mfr_color_name>
<primary_rgb_code r="186" g="165" b="127" hex="BAA57F"/>
<secondary_rgb_code r="0" g="0" b="0" hex="000000"/>
<fleet>N</fleet>
</color>
<color mfr_code="EB" two_tone="N">
<generic_color_name>Black</generic_color_name>
<mfr_color_name>Black Obsidian</mfr_color_name>
<primary_rgb_code r="0" g="0" b="0" hex="000000"/>
<fleet>N</fleet>
</color>
...
</exterior_colors>
<interior_colors>
<color mfr_code="TI" two_tone="N">
<generic_color_name>Beige</generic_color_name>
<mfr_color_name>Beige</mfr_color_name>
<primary_rgb_code r="146" g="129" b="104" hex="928168"/>
<fleet>N</fleet>
</color>
<color mfr_code="YD" two_tone="N">>
<generic_color_name>Gray</generic_color_name>
<mfr_color_name>Gray</mfr_color_name>
<primary_rgb_code r="120" g="120" b="124" hex="78787C"/>
<fleet>N</fleet>
</color>
</interior_colors>
<roof_colors/>
</colors>
Abridged Sample XML for the colors Data Pack

22 | P a g e
Warranties
The warranties element can contain zero or more warranty child elements.
<warranties>
<warranty name="New Car Basic Warranty">
<type>Basic</type>
<months>48</months>
<miles>50000</miles>
</warranty>
<warranty name="24 Hour Roadside Assistance">
<type>Roadside Assistance</type>
<months>48</months>
<miles>0</miles>
</warranty>
<warranty name="Corrosion">
<type>Rust</type>
<months>144</months>
<miles>0</miles>
</warranty>
</warranties>
Sample XML for the warranties Data Pack
EPA Fuel Economy Ratings
Fuel economy ratings are based on the vehicle style, installed engine, installed transmission, and the type of fuel
the vehicle is filled with by the driver (ethanol or gas, for flex-fuel vehicles, etc). In many cases both the installed
engine and transmission will be known based on VIN and other data provided in the input message posted to
our web service. In cases where the installed engine or transmissions are unknown, or where the vehicle can be
filled with more than one type of fuel, this section may contain multiple epa_mpg_record elements.
<epa_fuel_efficiency>
<epa_mpg_record engine_id="200351" transmission_id="230943" fuel_type="Gasoline"
fuel_grade="">
<city>16</city>
<highway>24</highway>
<combined>19</combined>
</epa_mpg_record>
</epa_fuel_efficiency>
Sample XML for the epa_fuel_efficiency Data Pack

23 | P a g e
EPA Green Scores
Like fuel economy ratings, EPA Green Scores are based on the vehicle style, installed engine, installed
transmission, and the type of fuel the vehicle is filled with by the driver (ethanol or gas, for flex-fuel vehicles,
etc). Green scores also vary by geographic region ("sales_area"). For example, the same vehicle may be sold in
California and Texas, with slightly different emissions equipment. As a result, this section may contain multiple
epa_green_score_record elements.
<epa_green_scores>
<epa_green_score_record engine_id="200351" transmission_id="230943"
fuel_type="Gasoline" underhood_id="BADXV04.2365" sales_area="FA">
<emissions_standard>B5</emissions_standard>
<air_pollution_score>5</air_pollution_score>
<greenhouse_gas_score>3</greenhouse_gas_score>
<smartway>N</smartway>
</epa_green_score_record>
<epa_green_score_record engine_id="200351" transmission_id="230943"
fuel_type="Gasoline" underhood_id="BADXV04.2365" sales_area="CA">
<emissions_standard>L2</emissions_standard>
<air_pollution_score>5</air_pollution_score>
<greenhouse_gas_score>3</greenhouse_gas_score>
<smartway>N</smartway>
</epa_green_score_record>
</epa_green_scores>
Sample XML for the epa_green_scores Data Pack

24 | P a g e
NHTSA 5-Star Crash Test Ratings
The NHTSA revised its crash test rating criteria for model year 2011, and as a result, not all crash test criteria
listed below will contain scores (note that many contain N/A in the sample below). Please consult our VIN
Decoder API Data Dictionary (available via our Client Portal) for a list of possible values and their meanings, as
well as a list of which values are available for which years.
<nhtsa_crash_test_ratings>
<overall_stars>N/A</overall_stars>
<front_crash_overall_stars>N/A</front_crash_overall_stars>
<front_crash_driver_stars>5</front_crash_driver_stars>
<front_crash_passenger_stars>14</front_crash_passenger_stars>
<side_crash_overall_stars>N/A</side_crash_overall_stars>
<side_barrier_overall_stars>N/A</side_barrier_overall_stars>
<side_barrier_driver_stars>5</side_barrier_driver_stars>
<side_barrier_passenger_stars/>
<side_pole_driver_stars>N/A</side_pole_driver_stars>
<side_combined_front_stars>N/A</side_combined_front_stars>
<side_combined_rear_stars>N/A</side_combined_rear_stars>
<rollover_stars>3</rollover_stars>
<front_crash_driver_comment/>
<front_crash_passenger_comment>
High Likelihood of Thigh Injury
</front_crash_passenger_comment>
<side_barrier_driver_comment/>
<side_barrier_passenger_comment>Not Tested</side_barrier_passenger_comment>
<rollover_comment/>
</nhtsa_crash_test_ratings>
Sample XML for the nhtsa_crash_test_ratings Data Pack
Explanation of Crash Test Values:

1-5: Number of Stars (1 star, 2 stars, etc)
0, 8, 23: Not Tested
11-15: Indicates that a comment must be displayed along with number of stars. The second digit indicates
number of stars (Ex: 12 = 2 stars w/ comment)

25 | P a g e
NHTSA Recalls
The NHTSA Recalls data pack can contain zero or more recall child elements, as shown below:
<nhtsa_recalls>
<recall nhtsa_campaign_number="03V520000" mfr_campaign_number="064">
<component_description>equipment:other:labels</component_description>
<report_manufacturer>HYUNDAI MOTOR COMPANY</report_manufacturer>
<manufacturing_start_date>2000-03-31</manufacturing_start_date>
<manufacturing_end_date>2003-09-29</manufacturing_end_date>
<recall_type_code>V</recall_type_code>
<potential_units_affected>249309</potential_units_affected>
<owner_notification_date>2003-10-29</owner_notification_date>
<recall_initiator>MFR</recall_initiator>
<product_manufacturer>HYUNDAI MOTOR COMPANY</product_manufacturer>
<report_received_date>2003-12-18</report_received_date>
<record_creation_date>2003-12-18</record_creation_date>
<regulation_part_number>571</regulation_part_number>
<fmvvs_number><![CDATA[120]]></fmvvs_number>
<defect_summary><![CDATA[Certain sport utility vehicles fail to comply with the
requirements of federal motor vehicle safety standard no. 120, "tire selection and rims
for motor vehicles other than passenger cars."]]></defect_summary>
<consequence_summary><![CDATA[The tire pressure labels do not contain the
information required by the standard.]]></consequence_summary>
<corrective_action_summary><![CDATA[Owners will be provided with a correct label
and installation instructions. Owner notification began on october 29, 2003. Owners
should contact hyundai at 1-800-633-5151.]]></corrective_action_summary>
<notes><![CDATA[Hyundai recall no. 064.Customers can also contact the national
highway traffic safety administration's auto safety hotline at 1-888-dash-2-dot (1-888-
327-4236).]]></notes>
<recalled_component_id>000020831000105554000000349</recalled_component_id>
</recall>
...
</nhtsa_recalls>
Abridged Sample XML for the nhtsa_recalls Data Pack
NHTSA Service Bulletins
The NHTSA Service Bulletins data pack can contain zero or more service_bulletin child elements:
<nhtsa_service_bulletins>
<service_bulletin nhtsa_item_number="10005630" bulletin_number="0440001">
<replacement_bulletin_number>0540014</replacement_bulletin_number>
<bulletin_date>2005-09-01</bulletin_date>
<component>103000 power train:automatic transmission</component>
<date_added>2004-03-08</date_added>
<summary><![CDATA[Automatic transaxle oil leak between transaxle and transfer
case. *tt]]></summary>
</service_bulletin>
...
</nhtsa_service_bulletins>
Abridged Sample XML for the nhtsa_service_bulletins Data Pack

26 | P a g e
ACES (AAIA) Veh/Eng/Trans Mapping
The ACES (AAIA) Mapping data pack contains a map from DataOne’s vehicle_id, engine_id, and transmission_ids
to the ACES VehicleID, EngineConfigID, and TransmissionID from the ACES database. The aces_mapping data
pack can contain one or more aces_record child elements:
<aces_mapping>
<aces_record engine_id="200351" transmission_id="230943">
<ACES_VehicleID>156166</ACES_VehicleID>
<ACES_EngineConfigID>8275</ACES_EngineConfigID>
<ACES_TransmissionID>2482</ACES_TransmissionID>
<ACES_VehicleToEngineConfigID>314383</ACES_VehicleToEngineConfigID>
</aces_record
...
</aces_mapping>
Abridged Sample XML for the aces_mapping Data Pack
Kelley Blue Book Mapping
The Kelley Blue Book Mapping data pack contains a map from DataOne’s vehicle_ids to Kelley Blue Book’s
vehicleid, trimid, and vehicletypedisplayname. The kelley_blue_book_mapping data pack can contain one or
more kelley_blue_book_mapping_record child elements:
<kelley_blue_book_mapping>
<kelley_blue_book_mapping_record>
<kbb_vehicleid>252623</kbb_vehicleid>
<kbb_trimid>269985</kbb_trimid>
<kbb_vehicletypedisplayname>OlderCar</kbb_vehicletypedisplayname>
</kelley_blue_book_mapping_record>
...
</kelley_blue_book_mapping>
Abridged Sample XML for the kelley_blue_book_mapping Data Pack
NADA Mapping
The NADA Mapping data pack contains a map from DataOne’s vehicle_id and engine_ids to NADA’s vid. The
nada_mapping data pack can contain one or more nada_record child elements:
<nada_mapping>
<nada_record engine_id="300001832">
<nada_vid>00000088285</nada_vid>
</nada_record>
...
</nada_mapping>
Abridged Sample XML for the nada_mapping Data Pack

27 | P a g e
COX (AIS) Incentives & Rebates Mapping
The COX (formerly AIS) Incentives & Rebates Mapping data pack contains a map from DataOne’s vehicle_id,
engine_id, and transmission_ids to COX’s descvehicleid and optiongroup. The ais_mapping data pack can
contain one or more ais_record child elements:
<ais_mapping>
<ais_record engine_id="300001832" transmission_id="300000034">
<ais_descvehicleid>1054936</ais_descvehicleid>
<ais_optiongroup>Base</ais_optiongroup>
</ais_record>
...
</ais_mapping>
Abridged Sample XML for the ais_mapping Data Pack
TGP Tires
The TGP Tires Data Pack is encapsulated in the tgp_tires element, as shown below. This element may contain
zero or more one or more tgp_tire child elements. These tgp_tire elements contain tgp_cartireid and tgp_sizeid
attributes, as well as tgp_option, stgp_stdoropt, and tgp_frb child elements.
<tgp_tires>
<tgp_tire tgp_cartireid="145211" tgp_sizeid="131707" >
<tgp_option1>Base Front</tgp_option1>
<tgp_stdoropt>1</tgp_stdoropt>
<tgp_frb>F</tgp_frb>
</tgp_tire>
...
</tgp_tires>
Sample XML for the tgp_tires Data Pack

28 | P a g e
Media
The Media section contains nine data packs:
 Single Stock Images (single_stock_image)

 Multiple Stock Images (lifestyle_gallery)
 Mapping to Evox Images (evox_mapping)
 Evox Single-Angle Studio Images (evox_stills_single_640px)
 Evox Studio Images (evox_stills_640px)
 Evox Single-Angle Colorized Images (evox_colors_single_640px)
 Evox Colorized Images (evox_colors_640px)
 Mapping to Izmo Images (izmo_mapping)
 Mapping to Izmo TLC Images (izmo_tlc_mapping)
<media>
<single_stock_image>
...
</single_stock_image>
<lifestyle_gallery>
...
</lifestyle_gallery>
<evox_mapping>
...
</evox_mapping>
<evox_stills_single_640px>
...
</evox_stills_single_640px >
<evox_stills_640px>
...
</evox_stills_640px >
<evox_colors_single_640px>
...
</evox_colors_single_640px>
<evox_colors_640px>
...
</evox_colors_640px>
<izmo_mapping>
...
</izmo_mapping>
<izmo_tlc_mapping>
...
</izmo_tlc_mapping>
</media>
Abridged Sample XML for the media section, showing nine Data Packs

29 | P a g e
Single Stock Images
The Single Stock Images data pack is encapsulated in the single_stock_image element, as shown below. Its
description attribute describes the shot type. The partial URLs included in thumb_location and full_location are
relative to http://img.dataonesoftware.com/. Thumbnails are 160px by 120px, and full images are 640px by
400px.
<single_stock_image description="Front 3/4 Shot - Straight">

<thumb_location>
lifestyle_gallery/hash/7/d/a/bceeeb41b700314ecba55bec6fbe468c08b00ad7.jpg
</thumb_location>
<full_location>
lifestyle_gallery/hash/0/b/4/326094c846cbe4d4f6272548abb4faa2419cd4b0.jpg
</full_location>
</single_stock_image>
Sample XML for the single_stock_image Data Pack
Multiple Stock Images
The Multiple Stock Images data pack is organized similarly to the Single Stock Images data pack, but with more
than one image for most vehicles. The data pack is encapsulated in the lifestyle_gallery element, as shown
below. The lifestyle_gallery element can contain zero or more lifestyle_image child elements, each with a
description attribute describing the shot type.
Like Single Stock Images, Multiple Stock Image’s partial URLs included in thumb_location and full_location are
relative to http://img.dataonesoftware.com/. Thumbnails are 160px by 120px, and full images are 640px by
400px.
<lifestyle_gallery>
<lifestyle_image description="Rear 3/4 Shot">
<thumb_location>
lifestyle_gallery/hash/8/a/d/e91092614d8202969c85817c232654feebb67da8.jpg
</thumb_location>
<full_location>
lifestyle_gallery/hash/1/f/9/a873369dbaca81dbabd60f9389d6bdf7b4a069f1.jpg
</full_location>
</lifestyle_image>
...
</lifestyle_image>
Abridged Sample XML for the lifestyle_gallery Data Pack

30 | P a g e
Mapping to Evox Images
The Mapping to Evox Image IDs data pack is encapsulated in the evox_mapping element, as shown below. This
element has a number of child elements indicating the degree to which Evox's image matches the vehicle style
in question. Evox's VIF identifier is given as an attribute of the evox_mapping element. The example below
indicates that Evox Image #12345 has a different Trim level than the vehicle style in question.
<evox_mapping vif="12345">
<matches_year>Y</matches_year>
<matches_make>Y</matches_make>
<matches_model>Y</matches_model>
<matches_trim>N</matches_trim>
<matches_body_type>Y</matches_body_type>
<matches_cab_type>Y</matches_cab_type>
<matches_doors>Y</matches_doors>
<matches_drive_type>Y</matches_drive_type>
</evox_mapping>
Sample XML for the evox_mapping Data Pack
Evox Single-Angle Studio Images
Evox Studio Images are composed of evox_still_640px elements, each of which contains angle_id,
angle_description, fullsize_path, midsize_path, and thumbnail_path child elements.
The Evox Single-Angle Studio Image data pack is encapsulated in the evox_stills_single_640px element, as shown
below. The element will contain a single evox_still_640px child element.
<evox_still_640px>
<angle_id>89</angle_id>
<angle_description>
<![CDATA[Front angle medium view.]]>
</angle_description>
<fullsize_path>//d1ypc8j62c29y8.cloudfront.net/fullsize/….png</fullsize_path>
<midsize_path>//d1ypc8j62c29y8.cloudfront.net/midsize/….png</midsize_path>
<thumbnail_path>//d1ypc8j62c29y8.cloudfront.net/thumbnail/….png</thumbnail_path>
</evox_still_640px>
</evox_stills_single_640px>
Sample XML for the evox_stills_single_640px Data Pack

31 | P a g e
Evox Studio Images
The Evox Studio Images data pack is encapsulated in the evox_stills_single_640px element, as shown below. The
element will contain one or more evox_still_640px child elements.
<evox_still_640px>
<angle_description>
<![CDATA[Driver's side profile with drivers side door open.]]>
</evox_still_640px>
<evox_still_640px>
...
</evox_still_640px>
...
</evox_stills_single_640px>
Abridged Sample XML for the evox_stills_640px Data Pack
Evox Single-Angle Colorized Images
Evox Colorized Images are composed of evox_color_640px elements, each of which contains angle_id,
angle_description, a DataOne exterior_color_id, a DataOne roof_color_id, fullsize_path, midsize_path, and
thumbnail_path child elements. In cases in which no specific roof color is specified a default roof_color_id of ‘0’
will be used.
The Evox Single-Angle Colorized Image data pack is encapsulated in the evox_colors_single_640px element, as
shown below. The element will contain one or more evox_color_640px child elements, each representing a
different color, but only the front driver’s side three-quarter angle.
<evox_colors_single_640px>
<evox_color_640px>
<angle_description>
<![CDATA[Driver's side front three-quarter view]]>
<ext_color_id>300001411</ext_color_id>
<roof_color_id>0</roof_color_id>
</evox_color_640px>
...
</evox_colors_single_640px>
Abridged Sample XML for the evox_colors_single_640px Data Pack

32 | P a g e
Evox Colorized Images
The Evox Colorized Images data pack is encapsulated in the evox_colors_640px element, as shown below. The
element will contain one or more evox_color_640px child elements, each representing a different color and
angle combination.
<evox_colors_640px>
<evox_color_640px>
<angle_description>
<![CDATA[Driver's side profile view.]]>
<ext_color_id>300001411</ext_color_id>
<roof_color_id>0</roof_color_id>
</evox_color_640px>
...
</evox_colors_640px>
Abridged Sample XML for the evox_colors_640px Data Pack
Mapping to Izmo Images
The Izmo Mapping data pack is encapsulated in the izmo_mapping element, as shown below. This element has
two child elements indicating the degree to which Izmo’s image matches the vehicle style in question, as well as
the “IZMO_FOLDER” path from Izmo’s vehicle data file.
<izmo_mapping path=”/10ford/10fordf150crewcabxlt/”>
<matches_trim>N</matches_trim>
<matches_body_subtype>Y</matches_body_subtype>
</izmo_mapping>
Sample XML for the izmo_mapping Data Pack
Mapping to Izmo TLC Images
The Izmo TLC Mapping data pack is encapsulated in the izmo_tlc_mapping element, as shown below. This
element has a number of child elements indicating the degree to which Izmo’s image matches the vehicle style
in question, as well as the “IZMO_FOLDER” path from Izmo’s TLC (trim-level) vehicle data file.
<izmo_tlc_mapping path=“/10ford/10fordf150supcrwxl”>
<matches_year>Y</matches_year>
<matches_make>Y</matches_make>
<matches_model>Y</matches_model>
<matches_trim>Y</matches_trim>
<matches_body_type>Y</matches_body_type>
<matches_body_subtype>Y</matches_body_subtype>
<matches_drive_type>N</matches_drive_type>
</izmo_tlc_mapping>
Sample XML for the izmo_tlc_mapping Data Pack

33 | P a g e
Awards & Accolades
The awards_accolades element can contain zero or more award_accolade child elements, as shown:
<awards_accolades>
<award_accolade name="Editors Choice Awards: SUVs" source="Car And Driver">
<website><![CDATA[http://www.caranddriver.com/]]></website>
<citation><![CDATA[]]></citation>
<snippet><![CDATA[]]></snippet>
</award_accolade>
<award_accolade name="New Best Bets, SUV/Crossovers" source="Cars.com">
<website><![CDATA[http://www.cars.com]]></website>
<citation<![CDATA[]]>></citation>
<snippet><![CDATA[]]></snippet>
</award_accolade>
...
</awards_accolades>
Abridged Sample XML for the awards_accolades Data Pack
Vehicle Overviews
The Vehicle Overviews data pack is encapsulated in the vehicle_overview element, which does not have any child
elements. A path to an overview text file is given as an attribute of the vehicle_overview element. Note that you
will have to download these text files from DataOne's FTP server to access this data. For more information on
how to access these overviews, please contact your sales or support representative or call 1-877-GET-VINS.
<overview
path="motormatters/overviews/d/e/2/37777cae6586f498b8eb02e120d61887933422ed.txt">
</overview>
Sample XML for the vehicle_overviews Data Pack
Market Segment
The Market Segment data pack includes eight child elements, as shown below. Market Segment values are
available for model year 2005-present. Note that values are not provided for Commercial/Cargo Vans, Chassis
vehicles, and certain Specialty vehicles such as Limousines. The market segment data has been designed to allow
for several segment values to be combined into a single string for display. For example, you may choose to
display the sample below as "Mid-Size Luxury Sedan."
<market_segment>
<body_segment>Sedan</body_segment>
<size_segment>Mid-Size</size_segment>
<luxury>Y</luxury>
<hybrid>N</hybrid>
<electric>N</electric>
<sport>N</sport>
<crossover>N</crossover>
<exotic>N</exotic>
</market_segment>
Sample XML for the market_segment Data Pack

34 | P a g e
Common Data
The common_us_data and common_supplemental_data sections contain a number of child elements, populated
with data that is shared across all of the vehicle styles associated with the VIN or vehicle description listed in its
parent query_response element. The syntax is an exact copy of the Vehicle Style (style) section, but can be
configured to contain a different set of data packs than the style section by updating the common_data_packs
section of the Input Message. Note that the entire common_data section can be toggled on or off using the
common_data field in the Input Message.
We recommend using data from the common_data section only when the count attribute of the styles element
is greater than 1, and when it would be impractical to ask your application's users to select a style from a list of
style names.
<common_us_data>
<basic_data/>
<pricing/>
<engines/>
<transmissions/>
<standard_specifications>(on|off)</standard_specifications>
<optional_specifications>(on|off)</optional_specifications>
<standard_ancillary_specifications>(on|off)</standard_ancillary_specifications>
<standard_generic_equipment/>
<optional_generic quipment/>
<oem_options/>
<colors/>
<warranties/>
<epa_fuel_efficiency/>
<epa_green_scores/>
<nhtsa_crash_test_ratings/>
<nhtsa_recalls/>
<nhtsa_service_bulletins/>
<media/>
<awards_accolades/>
<overview/>
</common_us_data>
Sample XML for the common_us_data section. The format is identical for common_supplemental_data

35 | P a g e
ID-Only Mode
Calling the VIN Decoder API web service in ID-only mode allows you to receive back a significantly smaller
response message containing only our vehicle_ids, engine_ids, and transmission_ids. Additionally, in ID-only
mode, the service can be configured to return Optional Equipment Marketing Descriptions (optional_equipment)
that have been identified as "installed" based on codes and descriptions provided in the input message.ID-only
mode is intended for use in conjunction with our delivered database files, and allows you to leverage the
advanced decoding logic built into our VIN Decoder API while also enjoying the convenience of having the data
in-house.
Note that to receive engine_ids in ID-only mode, the engines data pack must be turned on in the Input Message
submitted to the web service. Similarly, the transmissions data pack must be turned on to receive
transmission_id, and the options data pack must be turned on to receive Optional Equipment Marketing
Description IDs. Note that only Optional Equipment known to be installed on the vehicle is provided in ID-only
mode. Optional equipment that may be installed on the vehicle, but is not known to be based on the provided
input data, is not returned in this mode.
ID-Only Mode Syntax
The response syntax for ID-only mode is identical to the response syntax for full-data mode, but with most fields
removed. Within the style element, the only child elements available in ID-only mode are engine, transmission,
and optional_equipment. Each of these elements are delivered with a reduced set of child elements as well.
<us_styles count="1">
<style name="Prestige 4dr Sedan" vehicle_id="400874563" complete="Y">
<engines>
<engine name="4.2L V8 350hp 325ft. lbs." brand="" engine_id="200351">
</engine>
</engines>
<transmissions>
<transmission name="6-Speed Automatic" brand="" transmission_id="230943">
</transmission>
</transmissions>
<optional_equipment>
<category name="Safety">
<option name="Rear Side Airbags" option_id="151739"
order_code="4X4" installed="Y"/>
<option name="Audi Side Assist" option_id="300003349"
order_code="7Y1" installed="Y"/>
</category>
<category name="Marketing Package">
<option name="18 In. Sport Package" option_id="300007070"
order_code="PPS" installed="Y"/>
</category>
</optional_equipment>
</style>
</us_styles>
Sample XML for us_styles in ID-Only Mode

36 | P a g e
Where to get More Information
Our client management portal (https://dataonesoftware.com/client-portal) contains whitepapers, a complete
data dictionary, XMLSchema (.xsd) files, API input and output samples, and code samples in a number of
programming languages.
Additionally, our support department is available to assist you with any questions you might have about our web
services. Support can be reached by e-mail at support@dataonesoftware.com, or by phone at 1-877-438-8467,
ext. 130.

37 | P a g e
Appendix A: Decoder Error Messages
Code Message
AF Authentication failed.
IP Your IP address cannot access the service at this time. Please call 1-877-GET-VINS for more
information.
SP Access denied. Service is suspended.
ET Access denied. Trial ended on (end_date).
ED Access denied. Maximum decodes has been reached for your trial.
ES Access denied. Maximum number of returned styles has been reached for your trial.
IN Your account is awaiting approval by our sales team. Please call 1-877-GET-VINS for more
information.
NS Access denied. Trial does not start until (start_date).
ET Access denied. Trial ended on (end_date).
MD Access denied. Maximum number of decodes exceeded for this request.
MS Access denied. Maximum number of returned styles exceeded for this request.
IQ Query must be properly formatted JSON.
IQ Query must be properly formatted XML.
IQ Query must be properly formatted JSON or XML.
IQ Invalid query. 'display' must one of the following: 'ids', 'full'.
RI The “styles” data is not available for display. Please contact 1-877-GET-VINS for more information on
how to activate this data.
RI The “common” data is not available for display. Please contact 1-877-GET-VINS for more information
on how to activate this data.
RI Requested data group and common data group “(data_group)” are not available for display. Please
contact 1-877-GET-VINS for more information on how to activate this data.
RI Requested data group “(data_group)” is not available for display. Please contact 1-877-GET-VINS for
more information on how to activate this data.
RI Requested common data group “(data_group)” is not available for display. Please contact 1-877-GET-
VINS for more information on how to activate this data.
RI Requested full data, but only IDs can be displayed. Please contact 1-877-GET-VINS for more
information on how to activate “full” data.

38 | P a g e
Appendix B: Query Error Messages
Code Message
VD VIN-less decode does not meet the minimum field requirements: year, make, and model.
VD VIN-less decode does not meet the minimum field requirements: year, make, model, trim.
VD VIN-less decoding has not been enabled for your account.
AT This VIN could not be decoded. It appears to be an ATV.
OM This VIN could not be decoded. It appears to be an Out Of Market vehicle
OM This VIN is for an out of market vehicle. Please contact 1-877-GET-VINS for more information on how
to activate out of market decoding.
CA This VIN could not be decoded. It appears to be a Canadian vehicle.
CH This VIN could not be decoded. It appears to be a Chassis vehicle.
EU This VIN could not be decoded. It appears to be a European vehicle.
FL This VIN could not be decoded. It appears to be a Fleet vehicle.
GM This VIN could not be decoded. It appears to be a Grey Market vehicle.
HV This VIN could not be decoded. It appears to be a Heavy-duty vehicle.
IV This VIN could not be decoded. Invalid Engine Code.
IV This VIN could not be decoded. Invalid Plant Digit.
IV This VIN could not be decoded. Invalid Restraint Digit
IV This VIN could not be decoded. Invalid VDS.
IV This VIN could not be decoded. Invalid WMI.
IV Invalid VIN: Invalid characters.
VF VIN contained invalid characters, but was able to be fixed for decoding.
IV Invalid VIN: Not 17 characters.
IV Invalid VIN: Failed Checksum.
IV This VIN could not be decoded.
MD This VIN could not be decoded. It appears to be a Mid-duty vehicle.
MO This VIN could not be decoded. It appears to be a Motorcycle.
MO This VIN is for a motorcycle. Please contact 1-877-GET-VINS for more information on how to to
activate motorcycle decoding.
MM This VIN could not be decoded. It appears to be a Motorcycle that is Out Of Market.
MY This VIN could not be decoded. It appears to be a Motorcycle that is out of the model year range.
PR This VIN could not be decoded. It appears to be a pre-1981 vehicle.
RV This VIN could not be decoded. It appears to be a Recreational vehicle.
TR This VIN could not be decoded. It appears to be a Trailer.
39 | P a g e
Appendix C: Installed & Optional Equipment Category Groups and
Categories
 Entertainment and Technology

o Audio System
o In Car Entertainment
o Telematics
 Exterior
o Doors
o Exterior Features
o Lights
o Mirrors
o Roof
o Tires and Rims
o Windows
 Interior
o Air Conditioning
o Comfort Features
o Convenience Features
o Instrumentation
o Seats
 Other
o Miscellaneous
 Packages
o Marketing Package
 Performance
o Powertrain
o Suspension
o Towing and Hauling
 Safety and Security
o Airbags
o Brakes
o Safety
o Seatbelts
o Security
o Stability and Traction

40 | P a g e

Vin Decoder 720 User Guide

Transféré par

Informations du document

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

Vin Decoder 720 User Guide

Transféré par

Droits d'auteur :

Formats disponibles

Build

with VIN Decoder API

DataOne Web Services: VIN Decoder API

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Precise Style Matching with the VIN Decoder API

Vehicle Lookups Without a VIN

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

 Basic data  Single Stock Images*

Accessing the Service via our Client Portal

To access the Client Portal, please visit https://www.dataonesoftware.com/client-portal

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Input Message Structure

When Using XML

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

The style_data_packs and common_data_packs Data Pack Toggles

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

When Using JSON

HTTPS POST Request Structure

Web Service URL: https://api.dataonesoftware.com/webservices/vindecoder/decode

POST Parameters: client_id=[Your Client ID]

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

A complete listing of possible decoder errors is listed in Appendix A.

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Sample XML for the basic_data Data Pack

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Sample XML for the engines Data Pack

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Sample XML for the transmissions Data Pack

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Abridged Sample XML for the standard_specifications Data Pack

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Standard Ancillary Specifications

Sample XML for the standard_ancillary_specifications Data Pack

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Each generic_equipment_category_group element has one or more generic_equipment_category child

Abridged Sample XML for the standard_generic_equipment Data Pack

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Abridged Sample XML for the optional_generic_equipment Data Pack

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Abridged Sample XML for the oem_options Data Pack

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

EPA Fuel Economy Ratings

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Explanation of Crash Test Values:

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

NHTSA Service Bulletins

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

Abridged Sample XML for the aces_mapping Data Pack

Kelley Blue Book Mapping

Abridged Sample XML for the kelley_blue_book_mapping Data Pack

Abridged Sample XML for the nada_mapping Data Pack

Abridged Sample XML for the ais_mapping Data Pack

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

The Media section contains nine data packs:

 Single Stock Images (single_stock_image)

© 2018 DataOne Software, division of Dominion Enterprises. All rights reserved.

<single_stock_image description="Front 3/4 Shot - Straight">

Multiple Stock Images