vehicle identification api reference - motor · written permission of motor information systems....

Vehicles Identification & Premium Options

API Reference

v1.4June 2016

Contents

MOTOR Web Development. . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Development Kits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Help and Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

YMME. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3List Years . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4List Makes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5List Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6List Engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8List Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Vehicle Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Vehicle Details by Attribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Vehicles by Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Vehicle by YMM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Base Vehicle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Base Vehicle Details by Attributes . . . . . . . . . . . . . . . . . . . . . . . . 19Base Vehicle Details by YMM . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Vehicle Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Vehicle Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Vehicle Attributes by Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24Valid Vehicle Configurations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Premium Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Vehicles by VIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Vehicles by Search Term . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Vehicle Identification & Premium Options API Reference i

Vehicle Image Gallery by Image . . . . . . . . . . . . . . . . . . . . . . . . . . 32Vehicle Image Gallery by Attribute . . . . . . . . . . . . . . . . . . . . . . . . 33

Common Response Objects. . . . . . . . . . . . . . . . . . . . . . . . . . . 35

BedTypeInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35BrakeInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35DriveTypeInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35EngineInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36FuelDeliveryInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Links. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38ManufacturerBodyCodeInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38SpringInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39SteeringInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39SubModel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39TransmissionInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Vehicle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40VehicleCountry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40VehicleMakeItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40VehicleModelItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41VehicleSearchItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41VehicleYears . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

©MOTOR Information Systems, a Hearst Business Media Company. No part of this document may be produced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose without the express written permission of MOTOR Information Systems.

Vehicle Identification & Premium Options API Reference ii

MOTOR Web DevelopmentDevelopment Kits

To assist application developers in using Data as a Service, MOTOR created Development Kits. The Development Kits include documentation and developer resources that are necessary to develop applications using the MOTOR web services.

The typical development kit includes:

• Development Handbook - Provides information on the API configurations that are required to use the web services and global principles that are required for all web services. Topics covered in the Handbook include:

Authentication information

Rate limitingHTTP authorization header

Correlation support

Error Codes

• API References - There is an API Reference for each product offered as Data as a Service. The API Reference contains detailed information about the web services included in each product, including:Request details

Resource URL

Route parametersQuery string parameters

Note: Examples of the XML responses are provided for reference. They are examples only and the data contained within the responses may have been changed since the publication of this document.

Note: Some API References are used in multiple development kits.This document, the Vehicles API Reference provides the web services required to identify vehicles by Year Make Model Engine (YMME), by Vehicle Identification Number (VIN), or by a vehicle attribute.

Intended Audience

The contents of this document and other documents included in the Development Kit are technical in nature and therefore intended for a developer. These documents are written for an audience that understands web programming and is familiar with consuming information via web services through HTTP Rest requests.

It is assumed that a developer is familiar with:

• RESTful web services

• Object oriented programming concepts

Vehicle Identification & Premium Options API Reference 1

MOTOR Web Development—Help and Support

• HTTP verbs and how they are used (Create = POST, Retrieve = GET, Update = PUT, Delete = DELETE)

• HTTP message construction and general knowledge of HTTP headers and standards

• Stateless and cacheable programming• Identifying the relationships between resources

• Secure Socket Layer (SSL) programming

Help and Support

For support with Data as a Service development, or to obtain your API key, contact the customer service team:

By email: [email protected]

By website: support.motor.com

An account is required to request support via the web. If you do not have an account, visit support.motor.com and create an account.


[email protected]

mailto:[email protected]

http://support.motor.com

YMMEOverview

The vehicle YMME services allow you to look up specific years, makes, models, sub-models, and engines for a vehicle.

List Years Returns all of the years for which there is data for a specific vehicle, in a specific range of years.

List Makes Returns all of the makes for which there is data for a specific vehicle, in a specific range of years.

List Models Returns a list of models for a given make and year.

List Engines Returns a list of engines based on the supplied year, make, and model information.

List Types Returns a list of vehicle types.


YMME—List Years

List Years

Request DetailsReturns all of the years for which there is data for a specific vehicle.

Resource URL/Information/YMME/Years

Resource VerbGET

Query String Parameters

Sample Request/Information/YMME/Years

Parameter Type Description Required Default

attributeStandard String The standard for the request and the response returned by the service. Supported values are MOTOR or VCdb.

No MOTOR

min Integer Specify the minimum year that can be used. The earliest year is 1896.

No

max Integer Specify the maximum year that should be returned. The year should be no greater than the current calendar year +1.

No

withRel String In the query, specify the relations that should exist for vehicle. This service will only return makes which have a record in the Estimated Work Times Data as a Service product. The only valid value is EWT.

No

VehicleTypes Integer Filter by the VehicleTypeID. No


YMME—List Makes

List Makes

Request DetailsReturns all of the makes (for which there is data), for a specific vehicle year.

Resource URL/Information/YMME/Years/{year}/Makes

Resource VerbGET

Route Parameters


Sample Request/Information/YMME/Years/2013/Makes

Parameter Type Description Required

year Integer A four-digit vehicle year. Valid years start at 1896 and go through the current calendar year +1.

Yes



No MOTOR


No

VehicleTypes Integer Filter by the VehicleTypeID. No


YMME—List Models

List Models

Request DetailsReturns a list of vehicle models and sub-models for a valid combination of a vehicle year and make.

Resource URL/Information/YMME/Years/{year}/Makes/{makeID}/Models

Resource VerbGET

Route Parameters



makeID Integer The makeID identifies the vehicle make (brand), defined within the attributeStandard.

Yes


Yes



No MOTOR


No

VehicleTypes Integer Filter by the VehicleTypeID.

No


YMME—List Models

Sample Request/Information/YMME/Years/2013/Makes/41/Models

CO String The Country ID identifies the country or countries for a vehicle model and sub-model.

No


YMME—List Engines

List Engines

Request DetailsReturns a list of engines based on the supplied year, make, and model information. The results may be further filtered by vehicle attribute identifiers.

Resource URL/Information/YMME/Years/{year}/Makes/{makeID}/Models/{modelID}/Engines

Resource VerbGET

Route Parameters


This table contains the abbreviations for mapped attributes. Each ID correlates with the attributeStandard in use. These are used to filter the available vehicle configurations and ID types supplied in the response. If supplied, only configurations that contain the ID that was


makeID Integer The makeID identifies the vehicle make (brand), defined within the supplied attributeStandard.

Yes

modelID Integer The modelID identifies the vehicle model, defined within the supplied attribute standard.

Yes


Yes



No MOTOR


No


YMME—List Engines

specified, or do not contain a reference to a specific ID type, will be returned in the response.

Sample Request/Information/YMME/Years/2013/Makes/41/Models/323/Engines


SM Integer SubModelID No 0


YMME—List Types

List Types

Request DetailsReturns a list of vehicle types.

Resource URL/Information/Vehicles/Types

Resource VerbGET

Route ParametersN/A


Sample RequestInformation/Vehicles/Types?AttributeStandard=MOTOR



No MOTOR


Vehicle DetailsOverview

The vehicle details web services return information on vehicles based on vehicle attributes or YMME values.

Vehicle Details by Attribute

Returns a list of valid attribute combinations and attribute details for a specific vehicle defined by the supplied vehicle attribute identifier (VehicleID).

Vehicles by Attribute

Returns a list of vehicles for a supplied vehicle attribute identifier (BaseVehicleID).

Vehicle by YMM

Returns a list of vehicles based on year, make, and model.


Vehicle Details by Attribute

Request DetailsReturns a list of valid attribute combinations and attribute details for a specific vehicle (VehicleID).

Resource URL/Information/Vehicles/Attributes/{attributeType}/{attributeID}/Vehicle

Resource VerbGET

Route Parameters


This table contains the abbreviations for mapped attributes. Each ID correlates with the attributeStandard in use. These are used to filter the available vehicle configurations and ID types supplied in the response. If supplied, only configurations that contain the ID that was specified, or do not contain a reference to a specific ID type, will be returned in the response.


attributeID Integer The primary attribute ID of a valid vehicle. The only supported value at this time is VehicleID, defined within the supplied attribute standard.

Yes

attributeType String Describes the type of primary attribute ID supplied in the attributeID route variable. The only supported value at this time is VehicleID.

Yes



No MOTOR


AX Integer AxleTypeID No 0

BS Integer BodyStyleID No 0

CB Integer CabTypeID No 0


Vehicle Details—Vehicle Details by Attribute

Sample Request/Information/Vehicles/Attributes/VehicleID/77622/Vehicle

CO Integer CountryID No 0

DT Integer DriveTypeID No 0

EN Integer EngineID No 0


TR Integer TransmissionID No 0


Vehicles by Attribute

Request DetailsReturns a list of vehicles for a supplied vehicle attribute identifiers (VehicleID).

Resource URL/Information/Vehicles/Attributes/{AttributeType}/{AttributeID}/Vehicles

Resource VerbGET

Route Parameters



attributeID Integer The primary attribute ID of a valid vehicle. The only supported value at this time is a BaseVehicleID defined within the supplied attribute standard.

Yes

attributeType String Describes the type of primary attribute ID supplied in the attributeID route variable. The only supported value at this time is BaseVehicleID.

Yes



No MOTOR


No


Vehicle Details—Vehicles by Attribute


Sample Request/Information/Vehicles/Attributes/BaseVehicleID/26590/Vehicles











Vehicle Details—Vehicle by YMM


Vehicle by YMM

Request DetailsReturns a list of vehicles for a supplied year, make, and model.

Resource URL/Information/YMME/Years/{year}/Makes/{makeID}/Models/{modelID}/Vehicles

Resource VerbGET

Route Parameters




Yes


Yes


Yes



No MOTOR


No


Sample Request/Information/YMME/Years/2013/Makes/41/Models/323/Vehicles











Base Vehicle—Overview

Base VehicleOverview

The Base Vehicle web services return vehicle information by attribute or YMME.

Base Vehicle Details by Attributes

Returns information for a base vehicle by a supplied primary vehicle attribute ID.

Base Vehicle Details by YMM

Returns information for base vehicle based on supplied YMME values.


Base Vehicle—Base Vehicle Details by Attributes

Base Vehicle Details by Attributes

Request DetailsReturns information for a base vehicle by a supplied primary vehicle attribute ID.

Resource URL/Information/Vehicles/Attributes/{attributeType}/{attributeID}/BaseVehicle

Resource VerbGET

Route Parameters


Sample Request/Information/Vehicles/Attributes/BaseVehicleID/26590/BaseVehicle



Yes


Yes



No MOTOR


Base Vehicle Details by YMM

Request DetailsReturns a specific base vehicle based on the supplied YMM values.

Resource URL/Information/YMME/Years/{year}/Makes/{makeID}/Models/{modelID}/BaseVehicle

Resource VerbGET

Route Parameters


Sample Request/Information/YMME/Years/2013/Makes/41/Models/323/BaseVehicle



Yes


Yes


Yes



No MOTOR


Vehicle Attributes—Overview

Vehicle AttributesOverview

The Vehicle Attributes web services return information on the vehicles attributes available for a specific base vehicle.

Vehicle Attributes

Returns information on the complete set of attributes available for a base vehicle.

Base Vehicle Attribute Lookup

Returns information on a specific attribute set available for a base vehicle.

Valid Vehicle Configurations

Returns a specific vehicle detail for a supplied vehicle attribute identifier (VehicleID).


Vehicle Attributes—Vehicle Attributes

Vehicle Attributes

Request DetailsReturns information on the complete set of attributes available for a base vehicle.

Resource URL/Information/Vehicles/Attributes/{attributeType}/{attributeID}/BaseVehicle/Attributes

Resource VerbGET

Route Parameters





Yes


Yes



No MOTOR







Sample Request/Information/Vehicles/Attributes/BaseVehicleID/26590/BaseVehicle/Attributes




Vehicle Attributes—Vehicle Attributes by Type

Vehicle Attributes by Type

Request DetailsReturns information on a specific attribute set available for a base vehicle.

Resource URL/Information/Vehicles/Attributes/{attributeType}/{attributeID}/BaseVehicle/Attributes/{vehicleAttributeLookupType}

Resource VerbGET

Route Parameters



Yes


Yes

vehicleAttributeLookupType String Valid values are:

• AxleTypes

• BedTypes

• BodyStyles

• BrakeTypes

• CabTypes

• Countries

• DriveTypes

• Engines

• ManufacturerBodyCodes

• SpringTypes

• SubModels

• Transmissions

• SteeringTypes

• WheelBases

Yes



Sample Request/Information/Vehicles/Attributes/BaseVehicleID/26590/BaseVehicle/Attributes/SubModels



No MOTOR


Valid Vehicle Configurations

Request DetailsReturns a specific vehicle detail for a supplied vehicle attribute identifier (VehicleID).

Resource URL/Information/Vehicles/Attributes/{attributeType}/{attributeID}/Vehicles/Attributes/Configurations

Resource VerbGET

Route Parameters


Sample Request/Information/Vehicles/Attributes/VehicleID/77622/Vehicles/Attributes/Configurations


attributeID Integer The primary attribute ID of a valid vehicle. The only supported value at this time is a VehicleID defined within the supplied attribute standard.

Yes

attributeType String Describes the type of primary attribute ID supplied in the attributeID route variable. The supported values are VehicleID and BaseVehicleID.

Yes



No MOTOR

CO Integer CountryID Yes, if using BaseVehicleID

0

DT Integer DriveTypeID Yes, if using BaseVehicleID

0


Premium Options—Overview

Premium OptionsOverview

The vehicle summary web services identify vehicles by a VIN, a partial VIN, or by free text search that may include standard year, make, and model names.

Vehicles by VIN

Returns a list of vehicles based on a VIN or partial VIN.

Vehicles by Search Term

Returns a list of vehicles based on free text value search that may include year, make name, or model name.

Vehicle Image Gallery by Image

Returns images for a specific vehicle, or returns a specific image.

Vehicle Image Gallery by Attribute

Returns images for a specific vehicle.


Vehicles by VIN

Request DetailsReturns a list of vehicles based on a partial or complete VIN. The results can be filtered to include only vehicles for which Estimated Work Times are available; or to include vehicles within a supplied year range.

Resource URL/Information/Vehicles/Search/ByVIN

Resource VerbGET




No MOTOR

vin String The vehicle identification number issued by the manufacturer. The minimum length is 3 characters, the maximum length is 20 characters.

Yes

withRel String In the query, specify the relations that should exist for vehicle. The only valid value is ‘EWT'.

No

pageIndex Integer The index of the page to return. Each page will contain a maximum of 30 vehicles in each page.

No 0

minYear Integer The minimum year to search against.

No

maxYear Integer The maximum year to search against.

No


Premium Options—Vehicles by VIN

Sample Request/Information/Vehicles/Search/ByVIN?vin=1c4ajwag4d

ItemsPerPage Integer The number of results to include in each page.

No


Premium Options—Vehicles by Search Term

Vehicles by Search Term

Request DetailsReturns a list of vehicles based on free text value search that may include year, make name, or model name.

Resource URL/Information/Vehicles/Search/ByTerm

Resource VerbGET




No MOTOR

searchTerm String Searching supports phrases that include two or four digit years, partial or complete vehicle make names, and partial or complete vehicle model names or a combination of all three.

No

withRel String In the query, specify the relations that should exist for vehicle. The only valid value is ‘EWT'.

No

pageIndex Integer The index of the page to return. Each page will contain a maximum of 30 vehicles in each page.

Yes 0

minYear Integer The minimum year to search against.

No

maxYear Integer The maximum year to search against.

No


Premium Options—Vehicles by Search Term

Sample Request/Information/Vehicles/Search/ByTerm?searchTerm=2013%20Jeep%20Wrangler


Premium Options—Vehicle Image Gallery by Image

Vehicle Image Gallery by Image

Request DetailsReturns a specific vehicle image.

Resource URL/Information/Vehicles/Attributes/{attributeType}/{attributeID}/Content/Documents/Of/VehicleImages/{documentID}

Resource VerbGET

Route Parameters

Query String ParametersNot applicable for this web service.

Sample Request/Information/Vehicles/Attributes/BaseVehicleID/26590/Content/Documents/Of/VehicleImages/9589


documentID Integer The ID of the document (image). Yes


Yes


Yes


Premium Options—Vehicle Image Gallery by Attribute

Vehicle Image Gallery by Attribute

Request DetailsReturns images for a specific vehicle.

Resource URL/Information/Vehicles/Attributes/{attributeType}/{attributeID}/Content/Details/Of/VehicleImages

Resource VerbGET

Route Parameters





Yes


Yes



No MOTOR



BD Integer BedTypeID No 0

BR Integer BrakeTypeID No 0


Sample Request/Information/Vehicles/Attributes/BaseVehicleID/13123/Content/Details/Of/VehicleImages






MB Integer ManufactureBodyCodeID No 0


SP Integer SpringID No 0

ST Integer SteeringID No 0


WB Integer WheelBaseID No 0


Common Response Objects—BedTypeInfo

Common Response ObjectsThere are many response parameters that are used across all of the Selectline web services. The following parameters are used in multiple web services and are included here for reference.

BedTypeInfo

BrakeInfo

DriveTypeInfo

Parameter Type Description

BedTypeID Integer Unique, system generated identifier.

Type String Marketing or industry accepted terminology for bed type (Styleside, Fleetside).

Length String Pickup bed length represented in inches to one decimal point of precision.

LengthMetric String Pickup bed length represented in centimeters to one decimal point of precision.


BrakeID Integer Unique, system generated identifier.

System String Brake system: Manual or Power.

FrontType String Brake type: Disc or Drum.

RearType String Brake type: Disc or Drum.

ABS String Brake ABS: Non-ABS, 2-Wheel ABS or 4-Wheel ABS.


DriveTypeID Integer Unique, system generated identifier.

Type String Drive Type name or description – FWD, AWD, RWD, 4WD.


Common Response Objects—EngineInfo

EngineInfo


Aspiration String Aspiration or Boost Type name - Normal, Turbocharger, Supercharged, etc.

BlockType String Engine block type – V, In-line, Rotary, etc.

CID String Cubic inches of displacement represented as a whole number – 350, 400, etc.

CylinderCC String Cubic centimeters represented as a whole number – 2800, 3200, etc.

CylinderHeadType String Value of cylinder head name, SOHC, DOHC and OHV.

CylinderLiter String Number of engine liters to one decimal point of precision - 2.8, 3.0, etc.

Cylinders String Number of engine cylinders represented as a whole number – 4, 6, 8, etc.

Designation String Manufacturer unique code, 2-TC, etc.

EngineBoreInch String Engine cylinder bore in inches to a minimum of two decimal points of precision – 1.14, 3.50, etc., or to a maximum of four decimal points of significant precision – eg. 1.233 not 1.2330.

EngineBoreMetric String Engine cylinder bore in millimeters to a minimum of one decimal point of precision – 28.0, 32.5, etc., or to a maximum of four decimal points of significant precision – eg. 2.093 not 2.0930.

EngineID String Unique, system generated identifier.

EngineStrokeInch String Engine cylinder stroke in inches to a minimum of two decimal points of precision – 1.14, 3.50, etc., or to a maximum of four decimal points of significant precision – eg. 1.233 not 1.2330.


Common Response Objects—FuelDeliveryInfo

FuelDeliveryInfo

EngineStrokeMetric String Engine cylinder stroke in millimeters to a minimum of one decimal point of precision – 54.0, 67.5, etc., to a maximum of four decimal points of significant precision – eg. 2.093 not 2.0930.

EngineVIN String Unique, system generated identifier from the EngineVIN table.

FuelDeliveryInfo See Fuel Delivery Info.

FuelType String Fuel type - Diesel, Gas, etc.

Horsepower String Engine Power output expressed in Horsepower, including a decimal point only when required to represent fractional values.

IgnitionSystem String Basic ignition system type - Distributor-Breaker, Distributorless, etc.

KilowattPower String Engine Power output expressed in Kilowatts, including a decimal point only when required to represent fractional values.

Manufacturer String Name of component manufacturer – Allison, Borg Warner, Ford, Toyota, etc.

ManufacturerType String

ValvesString

Total number of intake and exhaust vales in the engine – 8, 16, 24, etc.

VersionString

Engine version, i.e. "Windsor", "Cleveland", "Modified", etc.


ControlType Integer Description of fuel delivery method - Carburetion, Fuel Injection, etc.

FuelDeliveryID Integer Unique, system generated identifier.

SubType Integer Unique, system generated identifier from the FuelDeliverySubType table.

SystemDesign String Unique, system generated identifier from the FuelSystemDesign table.

Type String Description of fuel delivery method - Carburetion, Fuel Injection, etc.



Common Response Objects—Links

Links

A response may contain links. Links are useful for several reasons. They provide customers with information that is related to the information returned by the service.

<Href><Href> links contain the URI to identify the location of additional information

<Rel><Rel> describes the type of link.

A self link is a link to the object itself. This is a RESTful good practice to include a self link so that the object can be easily retrieved or referenced later.

ExampleIf the response contains an estimated work time, as shown in the example below, the links inform the user of additional information that is related to that estimated work time. In this example, the links include Parts Summary, Service Procedures, and Wiring Diagrams.

<Links> <Link> <Href>/Information/Content/Details/Of/EstimatedWorkTimes/24864615/24/For/Attribute/13123</Href> <Rel>Self</Rel> </Link> <Link> <Href>/Information/Content/Summaries/Of/Parts/For/Attribute/13123/RelatedTo/EstimatedWorkTimes/24864615/24</Href> <Rel>PartsSummary</Rel> </Link> <Link> <Href>/Information/Content/Summaries/Of/ServiceProcedures/For/Attribute/13123/RelatedTo/EstimatedWorkTimes/24864615/24</Href> <Rel>ServiceProceduresSummary</Rel> </Link> <Link> <Href>/Information/Content/Summaries/Of/WiringDiagrams/For/Attribute/13123/RelatedTo/EstimatedWorkTimes/24864615/24</Href> <Rel>WiringDiagramsSummary</Rel> </Link> </Links>

ManufacturerBodyCodeInfo


ManufacturerBodyCodeID Integer Unique, system generated identifier.

Code String Manufacturers unique code for body platform - "A" body, "C" Platform - Not all manufacturers designate body codes.


Common Response Objects—SpringInfo

SpringInfo

SteeringInfo

SubModel

TransmissionInfo


SpringID Integer Unique, system generated identifier.

FrontType String Suspension spring type - Coil, Leaf, Torsion Bar, Air.

RearType String Suspension spring type - Coil, Leaf, Torsion Bar, Air.


SteeringID Integer Unique, system generated identifier.

Type String Steering type: Gear or Rack.

System String Steering system: Manual or Power.


SubModelID Integer Unique, system generated identifier.

SubModelName String The name of the submodel as designated by the manufacturer.


TransmissionID Integer Unique, system generated identifier.

Type String Transmission or Transaxle.

ControlType String Type of transmission or transaxle - Automatic, Standard, etc.

ManufacturerCode String A manufacturer assigned model or unit designation code - AW03-72L, 4HP22H, etc.


Common Response Objects—Vehicle

Vehicle

VehicleCountry

VehicleMakeItem

Speed Integer Number of forward speeds for transmission or transaxle - 3, 4, 5, etc.


BaseVehicleID Integer Unique, system generated identifier.

Make String The name of the manufacturer of the vehicle.

Model See VehicleModelItem..

Year Integer The year of manufacture.

VehicleID Integer Unique, system generated identifier.

Country See VehicleCountry.

SubModel See SubModel.


CountryID Integer Unique, system generated identifier.

Code String ISO standard country abbreviations.

Name String Description of Region – United States, Canada, Mexico.


MakeName String Make name - Subaru, Volvo, etc.

MakeID Integer Unique, system generated identifier.


Common Response Objects—VehicleModelItem

VehicleModelItem

VehicleSearchItem


ModelID Integer Unique, system generated identifier.

ModelName String Name of model based on manufactures marketing nomenclature – Malibu, Corolla, etc.

SubModels String Name of submodel based on manufactures marketing nomenclature.


VehicleID Integer Unique, system generated identifier.

BaseVehicleID Integer Unique, system generated identifier.

EngineID Integer Unique, system generated identifier.

EngineDescription String Text description of the engine.

CountryID Integer Unique, system generated identifier.

CountryCode Integer Unique, system generated identifier.

MakeName String The name of the manufacturer of the vehicle.

MakeID Integer Unique, system generated identifier.

ModelName String The name of the model of the vehicle.

ModelID Integer Unique, system generated identifier.

SubModelName String The name of the submodel of the vehicle.

SubModelID Integer Unique, system generated identifier.

Year Integer The year of manufacture.


Common Response Objects—VehicleYears

VehicleYears


VehicleYearItem Integer Vehicle year.
