Implementation Guideline
Show Vehicle Specifications
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
This document is a guideline on how to use the Show Vehicle Specifications Business Object Document (BOD). Show Vehicle Specifications has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Show Vehicle Specifications process for individual consumers who service their automobiles through their OEM’s authorized Dealers. The focus is on Dealer and OEM interactions, not third party organizations. NOTE: Although this is the traditional use of the Show Vehicle Specifications, this BOD could be used to send Show Vehicle Specifications information between any two business parties.
The Show Vehicle Specifications Implementation Guidelines provide detailed information regarding the structure and meaning of the Show Vehicle Specifications BOD and corresponds directly to the Show Vehicle Specifications schema. In addition to structure and meaning, the Implementation Guidelines identify various business rules for specific fields/components that due to their nature, i.e. field interdependence, are not possible to express using schema. Please note that although these business rules are not included in the schema, they MUST be followed to be STAR Compliant. Therefore, the Show Vehicle Specifications Implementation Guidelines must be used in concert with the Show Vehicle Specifications schema during development and should NOT be considered a supplement or substitution to the schema. For more information regarding STAR XML Data Compliance, please review the STAR Data Compliance Guidelines document located on the STAR Web site.
For a copy of the corresponding Show Vehicle Specifications schema, please download the appropriate STAR schema repository from the XML portion of the STAR website (www.starstandard.org). Prior to downloading the schema, users are encouraged to download the STAR XML Reference/Implementation document also located on the XML portion of the STAR website. This document provides an overview of the STAR BOD development methodology, how to download and read STAR schema, and various frequently asked questions related to the implementation of STAR BODs.
STAR has followed the Open Application Group’s Business Object Document methodology to develop the Show Vehicle Specifications BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Show Vehicle Specifications BOD is unique to the Retail Automotive industry and is not an extension of any existing OAGIS BODs.
For more information on the Open Applications Group's BODs and related documentation please refer to the Open Applications Group’s Web site at www.openapplications.org.
STAR uses the same Noun in the schema for all the Noun/Verb combinations of the Show Vehicle Specifications except the Get verb. Please refer to each Noun/Verb combination within this document to understand the requirements for each specific BOD. Although the Noun will always have every field defined for the Noun in the schema, each Noun/Verb combination may not use all of the fields. If a field is not used by a BOD, it will be noted in the business rules.
BUSINESS SCENARIO MISSING. Please make sure it is defined in the build script.
The relationship diagram identifies all of the various components or building blocks of information used in the Show Vehicle Specifications BOD. This diagram visually depicts the relationships of the components using symbolic indentation and their occurrence in the BOD. Note: That this is an approximation of the Components, and may not reflect the exact implementation. Also, some fields are displayed in the diagram. This diagram should only be used as a starting point and not an absolute reference.
Target Namespace | http://www.starstandards.org/STAR |
---|---|
Element and Attribute Namespaces |
|
Documentation | This schema is made available under an Eclipse Public Licenses 1.0. This license may be found in the STAR/License directory as well as the STAR BOD Guidelines. More information at: http://www.starstandard.org/. |
Prefix | Namespace |
---|---|
Default namespace | http://www.starstandards.org/STAR |
xml | http://www.w3.org/XML/1998/namespace |
xsd | http://www.w3.org/2001/XMLSchema |
Name | ApplicationArea |
---|---|
Type | ApplicationArea |
Nillable | no |
Abstract | no |
Documentation | Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. More information at: http://www.openapplications.org/oagis. Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. More information at: http://www.openapplications.org/oagis. |
Name | Header |
---|---|
Type | VehicleSpecificationsHeader |
Nillable | no |
Abstract | no |
Documentation | More information at: http://www.starstandards.org. |
|
Name | Show |
---|---|
Type | Show |
Nillable | no |
Abstract | no |
Documentation | The Show verb is used when sending the information about a specific instance of a business document or entity. The Show verb may be used to respond to a Get request or it can be used in a publish scenario, where it pushes information to other applications based on a business event.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the Show decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the Show verb is quite straight forward with one exception. The Show response to any Get request needs to read the request carefully to ensure the response is returning the requested Data Types. More information at: http://www.openapplications.org/oagis. |
Name | ShowVehicleSpecifications |
---|---|
Type | ShowVehicleSpecifications |
Nillable | no |
Abstract | no |
Name | VehicleSpecifications |
---|---|
Type | VehicleSpecifications |
Nillable | no |
Abstract | no |
Documentation | More information at: http://www.starstandards.org. |
|
Name | Verb |
---|---|
Type | Verb |
Nillable | no |
Abstract | yes |
Super-types: | None |
---|---|
Sub-types: |
|
Name | AddressBase |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
AddressLine | Indicates the multiple lines of an address. The first line is typically the street name and number. | Required | |
City | Is the City of the Address. | Required | |
County | County in which the Address is in. | Optional | |
StateOrProvince | Is the State or Province of a given Address. | Required | |
Country | Country in which the Address is in. | Required | |
PostalCode | Postal Code of the Address. | Required |
Super-types: | xsd:string < Description (by extension) < AltExteriorColorDescription (by extension) |
---|---|
Sub-types: | None |
Name | AltExteriorColorDescription |
---|---|
Abstract | no |
Documentation | Alternate description of exterior color More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) |
---|---|
Sub-types: | None |
Name | Amount |
---|---|
Abstract | no |
Documentation | Based on OAGI Amount. Simple content with the currency as an attrbute More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
currency | Required |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ApplicationArea |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Sender | Identifies characteristics and control identifiers that relate to the application that created the Business Object Document. The sender area can indicate the logical location of the application and/or database server, the application, and the task that was processing to create the BOD. | Required | |
CreationDateTime | is the date time stamp that the given instance of the Business Object Document was created. This date must not be modified during the life of the Business Object Document. | Required | |
Signature | If the BOD is to be signed the signature element is included, otherwise it is not. Signature supports any digital signature that maybe used by an implementation of OAGIS. The qualifyingAgency identifies the agency that provided the format for the signature. This element supports any digital signature specification that is available today and in the future. This is accomplished by not actually defining the content but by allowing the implementation to specify the digital signature to be used via an external XML Schema namespace declaration. The Signature element is defined to have any content from any other namespace. This allows the user to carry a digital signature in the xml instance of a BOD. The choice of which digital signature to use is left up to the user and their integration needs. | Optional | |
BODId | The BODId provides a place to carry a Globally Unique Identifier (GUID) that will make each Business Object Document instance uniquely identifiable. This is a critical success factor to enable software developers to use the Globally Unique Identifier (GUID) to build the following services or capabilities: 1. Legally binding transactions, 2. Transaction logging, 3. Exception handling, 4. Re-sending, 5. Reporting, 6. Confirmations, 7. Security. | Optional | |
Destination | Information related to the receiver of the BOD | Required |
Super-types: | xsd:string < Description (by extension) < BeginningUrbanization (by extension) |
---|---|
Sub-types: | None |
Name | BeginningUrbanization |
---|---|
Abstract | no |
Documentation | Beginning of Geographical area of urbanization. Ex: zip code or state More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: |
|
Name | BusinessObjectDocument |
---|---|
Abstract | no |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
revision | This should contain the STAR repository version in the following recommended format. 4.2.1_M20080416. Where the first part indicates the version of the STAR repository and anything after the _ indicates the Milestone build that is being used. If referring to an official published version then only the STAR Repository version is required. | Optional | |
release | Indicates the OAGIS release that this BOD belongs. | Optional | |
environment | Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). | Optional | |
lang | Indicates the language that the contents of the BOD is in unless otherwise stated. | Optional | |
bodVersion | Deprecated as of STAR 4.2.2. It is recommended to use the revision attribute to identify the repository and the noun. May be removed in a new major version of the STAR repository. | Optional |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ApplicationArea | Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. | Required |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ColorExclusionSet |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
SetId | Identification of the group of options | Optional | |
NumberOfOptions | Numbers of options in this set | Optional | |
Option | Options within set | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ColorOptionExclusions |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ExclusionsSet | Inclusives Option set | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ColorOptionRequirements |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
RequirementsSet | Inclusives Option set | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ColorPricingComponent |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
VehiclePrice | Customer price of vehicle | Required | |
PriceExplanation | Explanatory Note for Pricing Example: Anniversary Edition | Optional | |
VehiclePricingType | Designates type of pricing for vehicle transaction | Optional | |
PricingTypeSource | Source from which pricing type data originated (i.e. Blue Book, NADA, etc.) | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ColorRequirementSet |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
SetId | Identification of the group of options | Optional | |
NumberOfOptions | Numbers of options in this set | Optional | |
Option | Options within set | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ColorsCombination |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
SecondaryColor | Component to describe secondary colors | Optional | |
ColorPricingComponent | Additional amount based on color option | Optional | |
ColorOptionRequirements | Requirements related to color combination | Optional | |
ColorOptionExclusions | Exclusions related to color combination | Optional | |
FleetAvailableInd | Color combination available To Fleet Indicator | Optional | |
FleetOnlyInd | Indicates that this Color combination only available to Fleet | Optional | |
ColorOrderStartDate | Color Order Start Date | Optional | |
ColorOrderEndDate | Color Order End Date | Optional | |
ColorsCombinationGroup | The ColorsCombinationGroup component groups the various combinations of vehicle interior colors and interior color codes. | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ColorsCombinationDetail |
---|---|
Abstract | no |
Documentation | The ColorsCombinationDetail component identifies the vehicle interior color. More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
InteriorColor | Vehicle Interior Color(s) | Required | |
InteriorColorCode | Vehicle Interior color code(s) | Required |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ColorsCombinationGroup |
---|---|
Abstract | no |
Documentation | The ColorsCombinationGroup component groups the various combinations of vehicle interior colors and interior color codes. More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ColorsCombinationDetail | The ColorsCombinationDetail component identifies the vehicle interior color. | Required |
Super-types: | Verb < ConfirmableVerb (by extension) |
---|---|
Sub-types: |
|
Name | ConfirmableVerb |
---|---|
Abstract | no |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
confirm | Required |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Verb | Required |
Super-types: | xsd:integer < Count (by extension) |
---|---|
Sub-types: | None |
Name | Count |
---|---|
Abstract | no |
Documentation | Simple quantity type with no attributes More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) |
---|---|
Sub-types: | None |
Name | Description |
---|---|
Abstract | no |
Documentation | Description More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
language | The ISO language code that the description is written. | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | Destination |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
DestinationNameCode | Code for destination of file (i.e.Short Manufacturer or DSP code) | Optional | |
DestinationURI | Physical address of the destination | Optional | |
DestinationSoftwareCode | Additional information about the destination application | Optional | |
DestinationSoftware | For which software destination file is intended (may not be known). | Optional | |
DealerNumber | Target Dealer Code receiving information | Optional | |
StoreNumber | Dealer code store number (DMS assigned) | Optional | |
AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
DealerCountry | Target Dealer country location | Optional | |
PartyId | The Party Id field uniquely identifies the Receiver of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. | Optional | |
LocationId | The Location Id field uniquely identifies the location of the Receiver of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. | Optional | |
ServiceId | The Service Id field identifies the particular service to which a message is being sent, e.g., an inventory service. | Optional |
Super-types: | PartyBase < DistributorParty (by extension) |
---|---|
Sub-types: | None |
Name | DistributorParty |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
Name | Name of distributor | Optional | |
Address | Distributor address | Optional | |
Contact | Distributor contact information | Optional | |
Vehicle | Information about the vehicle(s) | Optional |
Super-types: | xsd:integer < Count (by extension) < DoorsQuantity (by restriction) |
---|---|
Sub-types: | None |
Name | DoorsQuantity |
---|---|
Abstract | no |
Documentation | Number of doors on vehicle More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < EndingUrbanization (by extension) |
---|---|
Sub-types: | None |
Name | EndingUrbanization |
---|---|
Abstract | no |
Documentation | Ending of Geographical area of urbanization. Ex: zip code or state More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Weight (by extension) < GrossWeight (by extension) |
---|---|
Sub-types: | None |
Name | GrossWeight |
---|---|
Abstract | no |
Documentation | Gross Weight More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: |
|
Name | HeaderBase |
---|---|
Abstract | no |
Documentation | Used on all STAR BODs More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional | |
SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional |
Super-types: | xsd:string < Id (by extension) |
---|---|
Sub-types: | None |
Name | Id |
---|---|
Abstract | no |
Documentation | Party Identification number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < InitiativeId (by extension) |
---|---|
Sub-types: | None |
Name | InitiativeId |
---|---|
Abstract | no |
Documentation | Initiative Identification (i.e., Manufacturer incentive reimbursement program identification or dealer offerings) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < ItemId (by extension) |
---|---|
Sub-types: | None |
Name | ItemId |
---|---|
Abstract | no |
Documentation | Item part number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < LocationId (by extension) |
---|---|
Sub-types: | None |
Name | LocationId |
---|---|
Abstract | no |
Documentation | Code identifying a physical location More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | MainExteriorColor |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ExteriorColor | Main Vehicle Exterior Color | Optional | |
ExteriorColorCode | Vehicle exterior color code(s) Note: This is the highlight or secondary color code for the exterior of the vehicle | Optional | |
AltExteriorColorDescription | Alternate description of exterior color | Optional | |
ColorsCombination | Color Combination of Vehicle | Optional |
Super-types: | PartyBase < ManufacturerPartyDistributor (by extension) |
---|---|
Sub-types: | None |
Name | ManufacturerPartyDistributor |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional | |
Name | Name of manufacturer or distributor | Optional | |
DistributorParty | Distributors of the manufacturer of the vehicle(s) | Optional |
Super-types: | None |
---|---|
Sub-types: |
|
Name | MarketingInitiativesVO |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
InitiativeType | Type of program - Incentive or program related initiatives | Optional | |
InitiativeId | Initiative Identification (i.e., Manufacturer incentive reimbursement program identification or dealer offerings) | Optional | |
ReimbursementId | Reimbursement certificate or coupon identification | Optional | |
ReimbursementComment | Reimbursement dealer comments | Optional | |
ReimbursementAmount | Amount returned to payee | Optional | |
ReimbursementPayee | Indicates who is paid - It can be either a code (D - Dealer or C - Customer) or the recipient name of reimbursement | Optional | |
FleetAccount | Manufacturer Fleet number | Optional | |
InitiativeDate | The date the initiative was processed. | Optional | |
InitiativeChangeInd | Can the initiative be changed in this order? | Optional |
Super-types: | MarketingInitiativesVO < MarketingInitiativesVS (by extension) |
---|---|
Sub-types: | None |
Name | MarketingInitiativesVS |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
InitiativeType | Type of program - Incentive or program related initiatives | Optional | |
InitiativeId | Initiative Identification (i.e., Manufacturer incentive reimbursement program identification or dealer offerings) | Optional | |
ReimbursementId | Reimbursement certificate or coupon identification | Optional | |
ReimbursementComment | Reimbursement dealer comments | Optional | |
ReimbursementAmount | Amount returned to payee | Optional | |
ReimbursementPayee | Indicates who is paid - It can be either a code (D - Dealer or C - Customer) or the recipient name of reimbursement | Optional | |
FleetAccount | Manufacturer Fleet number | Optional | |
InitiativeDate | The date the initiative was processed. | Optional | |
InitiativeChangeInd | Can the initiative be changed in this order? | Optional | |
InitiativeStartDate | Initiative begin date | Optional | |
InitiativeEndDate | Initiative ending date | Optional | |
Urbanization | Urbanization/region Initiative information | Optional |
Super-types: | xsd:decimal < Measurement (by extension) |
---|---|
Sub-types: | None |
Name | Measurement |
---|---|
Abstract | no |
Documentation | Decimal measurement More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < ModelGroup (by extension) |
---|---|
Sub-types: | None |
Name | ModelGroup |
---|---|
Abstract | no |
Documentation | Grouping of similar models for order management purposes More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < MonroneyOptionDescription (by extension) |
---|---|
Sub-types: | None |
Name | MonroneyOptionDescription |
---|---|
Abstract | no |
Documentation | Description that appears on window stickers that is required by federal law More information at: http://www.starstandard.org. |
Super-types: | xsd:integer < Count (by extension) < NumberOfOptions (by restriction) |
---|---|
Sub-types: | None |
Name | NumberOfOptions |
---|---|
Abstract | no |
Documentation | Numbers of options in this set More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < OptionCost (by extension) |
---|---|
Sub-types: | None |
Name | OptionCost |
---|---|
Abstract | no |
Documentation | Actual Dealer cost of option More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < OptionMSRP (by extension) |
---|---|
Sub-types: | None |
Name | OptionMSRP |
---|---|
Abstract | no |
Documentation | Option MSRP More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < OptionPackageDiscount (by extension) |
---|---|
Sub-types: | None |
Name | OptionPackageDiscount |
---|---|
Abstract | no |
Documentation | Discount on Option Package More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < OptionPackageId (by extension) |
---|---|
Sub-types: | None |
Name | OptionPackageId |
---|---|
Abstract | no |
Documentation | Option package number or identifier used as a method for grouping option package items from manufacturer(s) Ex: OptPkg1,cost, More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | OptionPricingComponent |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
VehiclePrice | Customer price of vehicle | Required | |
PriceExplanation | Explanatory Note for Pricing Example: Anniversary Edition | Optional | |
VehiclePricingType | Designates type of pricing for vehicle transaction | Optional | |
PricingTypeSource | Source from which pricing type data originated (i.e. Blue Book, NADA, etc.) | Optional |
Super-types: | xsd:string < Description (by extension) < OptionShortDescription (by extension) |
---|---|
Sub-types: | None |
Name | OptionShortDescription |
---|---|
Abstract | no |
Documentation | Abbreviated description of the option More information at: http://www.starstandard.org. |
Super-types: | AddressBase < OrganizationAddress (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationAddress |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
AddressLine | Indicates the multiple lines of an address. The first line is typically the street name and number. | Required | |
City | Is the City of the Address. | Required | |
County | County in which the Address is in. | Optional | |
StateOrProvince | Is the State or Province of a given Address. | Required | |
Country | Country in which the Address is in. | Required | |
PostalCode | Postal Code of the Address. | Required | |
UrbanizationCode | Geographic definition of a metropolitan or suburban area | Optional |
Super-types: | None |
---|---|
Sub-types: |
|
Name | OrganizationContact |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PersonName | Contact name | Optional | |
Telephone | Contact telephone numbers | Optional | |
EMailAddress | Contact Email address | Optional | |
Fax | Contact Fax number | Optional | |
PreferredContactMethod | Preferred contact method | Optional | |
ContactTime | Preferred contact time (i.e. Best day/time to reach the contact. | Optional |
Super-types: | OrganizationContact < OrganizationContactExtended (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationContactExtended |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PersonName | Contact name | Optional | |
Telephone | Contact telephone numbers | Optional | |
EMailAddress | Contact Email address | Optional | |
Fax | Contact Fax number | Optional | |
PreferredContactMethod | Preferred contact method | Optional | |
ContactTime | Preferred contact time (i.e. Best day/time to reach the contact. | Optional | |
PreferredLanguage | Organization's preferred language | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | OrganizationContactPersonName |
---|---|
Abstract | no |
Documentation | Derived from oa:PersonName More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
GivenName | First Name of business party | Required | |
FamilyName | Last Name of business party | Required | |
FormattedName | Full Name of business party. Format for name should be "First Last" with no commas between first and last name | Optional |
Super-types: | xsd:string < OrganizationPartyEmail (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationPartyEmail |
---|---|
Abstract | no |
Documentation | Organization email More information at: http://www.starstandard.org. |
Super-types: | xsd:string < OrganizationPartyFax (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationPartyFax |
---|---|
Abstract | no |
Documentation | OrganizationFax number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < OrganizationPartyTelephone (by extension) |
---|---|
Sub-types: | None |
Name | OrganizationPartyTelephone |
---|---|
Abstract | no |
Documentation | OrganizationParty telephone number More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
desc | Required | ||
exten | Required |
Super-types: | None |
---|---|
Sub-types: |
|
Name | PartyBase |
---|---|
Abstract | no |
Documentation | Derived from oa:Party More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
PartyId | Party Identification Number | Optional |
Super-types: | xsd:string < Id (by extension) < PartyId (by extension) |
---|---|
Sub-types: | None |
Name | PartyId |
---|---|
Abstract | no |
Documentation | Party Identification Number More information at: http://www.starstandard.org. |
Super-types: | xsd:decimal < Amount (by extension) < ReimbursementAmount (by extension) |
---|---|
Sub-types: | None |
Name | ReimbursementAmount |
---|---|
Abstract | no |
Documentation | Amount returned to payee More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < ReimbursementId (by extension) |
---|---|
Sub-types: | None |
Name | ReimbursementId |
---|---|
Abstract | no |
Documentation | Reimbursement certificate or coupon identification More information at: http://www.starstandard.org. |
Super-types: | Verb < ConfirmableVerb (by extension) < ResponseVerb (by extension) |
---|---|
Sub-types: |
|
Name | ResponseVerb |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Verb | Required | ||
OriginalBODId | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | SecondaryColor |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
SecondaryExteriorColor | Secondary Vehicle Exterior Color(s) Note: This is the highlight or secondary color for the exterior of the vehicle | Optional | |
SecondaryExteriorColorCode | Secondary Vehicle exterior color code(s) Note: This is the highlight or secondary color code for the exterior of the vehicle | Optional | |
SecondaryExteriorColorDesc | Secondary Vehicle Exterior Color(s) Description Note: This is the description of what the secondary color represents. Ex: Convertible top or secondary exterior color | Optional |
Super-types: | xsd:string < Id (by extension) < SecondaryDealerNumber (by extension) |
---|---|
Sub-types: | None |
Name | SecondaryDealerNumber |
---|---|
Abstract | no |
Documentation | Identifies secondary dealer number if different than primary "Dealer Number" More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Description (by extension) < SecondaryExteriorColorDesc (by extension) |
---|---|
Sub-types: | None |
Name | SecondaryExteriorColorDesc |
---|---|
Abstract | no |
Documentation | Secondary Vehicle Exterior Color(s) Description Note: This is the description of what the secondary color represents. Ex: Convertible top or secondary exterior color More information at: http://www.starstandard.org. |
Super-types: | SenderBase < Sender (by extension) |
---|---|
Sub-types: | None |
Name | Sender |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
LogicalId | Provides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network | Optional | |
Component | Provides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. For STAR's use this is the DCS Software code name | Required | |
Task | Describes the business event that initiated the need for the Business Object Document to be created. For STAR, the task is defined in the Implementation Guidelines for each BOD. It is usually a short description of the BOD. Ex: SalesLead, CreditDecision, etc. | Required | |
ReferenceId | Enables the sending application to indicate the instance identifier of the event or task that caused the BOD to be created. This is used to correlate a response BOD to an originating BOD | Optional | |
AuthorizationId | Identifyies the authorization level of the user or application that is sending the Business Object Document Message. This authorization level being recognized be the receiving system indicates what can be done on the receiving system. For STAR, this is the User ID. | Optional | |
CreatorNameCode | DCS Software Creator Code | Required | |
SenderNameCode | Additional information about the sending platform (i.e., Short MFG or DSP code). | Required | |
SenderURI | Physical address of the sender | Optional | |
DealerNumber | Dealer Code of source of information | Optional | |
StoreNumber | Dealer code store number (DMS assigned) | Optional | |
AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
DealerCountry | Source Dealer country location | Optional | |
Language | This code is used to define the language of the data used in this transaction | Optional | |
DeliverPendingMailInd | Indicates if the user requests to receive pending mail that has been stored and has yet not been delivered yet. By selecting 0, the user will only receive the response for the current transaction the user is performing. | Optional | |
Password | Token for application specific authentication. Used to authenticate dealership/users through application specific security | Optional | |
SystemVersion | The sender's software version number. | Optional | |
PartyId | The Party Id field uniquely identifies the Sender of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. | Optional | |
LocationId | The Location Id field uniquely identifies the location of the Sender of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. | Optional | |
ServiceId | The Service Id field identifies the particular service from which a message is being sent, e.g., an inventory service. | Optional |
Super-types: | None |
---|---|
Sub-types: |
|
Name | SenderBase |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
LogicalId | Provides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network | Optional | |
Component | Provides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. For STAR's use this is the DCS Software code name | Required | |
Task | Describes the business event that initiated the need for the Business Object Document to be created. For STAR, the task is defined in the Implementation Guidelines for each BOD. It is usually a short description of the BOD. Ex: SalesLead, CreditDecision, etc. | Required | |
ReferenceId | Enables the sending application to indicate the instance identifier of the event or task that caused the BOD to be created. This is used to correlate a response BOD to an originating BOD | Optional | |
AuthorizationId | Identifyies the authorization level of the user or application that is sending the Business Object Document Message. This authorization level being recognized be the receiving system indicates what can be done on the receiving system. For STAR, this is the User ID. | Optional |
Super-types: | xsd:string < Id (by extension) < ServiceId (by extension) |
---|---|
Sub-types: | None |
Name | ServiceId |
---|---|
Abstract | no |
Documentation | The Service Id field identifies the particular service to or from which a message is being sent, e.g., an inventory service. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Id (by extension) < SetId (by extension) |
---|---|
Sub-types: | None |
Name | SetId |
---|---|
Abstract | no |
Documentation | Identification of the group of options More information at: http://www.starstandard.org. |
Super-types: | Verb < ConfirmableVerb (by extension) < ResponseVerb (by extension) < Show (by extension) |
---|---|
Sub-types: | None |
Name | Show |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Verb | Required | ||
OriginalBODId | Optional |
Super-types: | BusinessObjectDocument < ShowVehicleSpecifications (by extension) |
---|---|
Sub-types: | None |
Name | ShowVehicleSpecifications |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ApplicationArea | Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of. | Required | |
DataArea | Required |
Super-types: | None |
---|---|
Sub-types: | None |
Name | ShowVehicleSpecificationsDataArea |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Show | The Show verb is used when sending the information about a specific instance of a business document or entity. The Show verb may be used to respond to a Get request or it can be used in a publish scenario, where it pushes information to other applications based on a business event.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the Show decides to use the information it receives to update. This is entirely the decision of the receiving software component and is not forbidden.The behavior of the Show verb is quite straight forward with one exception. The Show response to any Get request needs to read the request carefully to ensure the response is returning the requested Data Types. | Required | |
VehicleSpecifications | Required |
Super-types: | None |
---|---|
Sub-types: | None |
Name | Signature |
---|---|
Abstract | no |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
qualifyingAgency | Optional |
Field/Component | Description | Requirement | Business Rules |
---|
Super-types: | None |
---|---|
Sub-types: | None |
Name | Urbanization |
---|---|
Abstract | no |
Documentation | Component to define urbanization areas such as region More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
UrbanizationCode | Geographic definition of a metropolitan or suburban area. | Optional | |
UrbanizationDescription | Description of the marketing region. Ex: Northeastern US | Optional | |
BeginningUrbanization | Beginning of Geographical area of urbanization. Ex: zip code or state | Optional | |
EndingUrbanization | Ending of Geographical area of urbanization. Ex: zip code or state | Optional |
Super-types: | xsd:string < Description (by extension) < UrbanizationDescription (by extension) |
---|---|
Sub-types: | None |
Name | UrbanizationDescription |
---|---|
Abstract | no |
Documentation | Description of the urbanization region. Ex: Northeastern US More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | VDSOption |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
VDSCode | Vehicle description Section - part of the VIN that correlates to a specific vehicle model, bodystyle and grade | Optional | |
InclusivesOption | Requirements related to color combination | Optional | |
ConflictsOption | Exclusions related to color combination | Optional |
Super-types: | None |
---|---|
Sub-types: |
|
Name | Vehicle |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Model | Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) | Optional | |
ModelYear | Vehicle designated model year | Optional | |
ModelDescription | Descriptive vehicle model name | Optional | |
Make | Vehicle make code - Usually available in the VIN number (use NCIC code). | Optional |
Super-types: | xsd:decimal < Amount (by extension) < VehiclePrice (by extension) |
---|---|
Sub-types: | None |
Name | VehiclePrice |
---|---|
Abstract | no |
Documentation | Customer price of vehicle More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: | None |
Name | VehiclePricing |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
VehiclePrice | Customer price of vehicle | Required | |
PriceExplanation | Explanatory Note for Pricing Example: Anniversary Edition | Optional | |
VehiclePricingType | Designates type of pricing for vehicle transaction | Optional | |
PricingTypeSource | Source from which pricing type data originated (i.e. Blue Book, NADA, etc.) | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | VehicleSpecifications |
---|---|
Abstract | no |
Documentation | STAR Version 2.0 - Draft More information at: http://www.starstandards.org. STAR Version 1.0, STAR approved 04/20/2005; OAGI approved XX/XX/XXXX; effective date 07/04/2005 More information at: http://www.starstandards.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Header | Required |
Super-types: | HeaderBase < VehicleSpecificationsHeader (by extension) |
---|---|
Sub-types: | None |
Name | VehicleSpecificationsHeader |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional | |
SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional | |
ManufacturerParty | Manufacturer of the vehicle(s) | Optional | |
IncrementalInd | Specifies whether to send full specifications or incremental changes | Optional | |
IncrementalDateTime | Send all changes that have occurred since this date | Optional |
Super-types: | Vehicle < VehicleSpecificationsVehicle (by extension) |
---|---|
Sub-types: | None |
Name | VehicleSpecificationsVehicle |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
Model | Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) | Optional | |
ModelYear | Vehicle designated model year | Optional | |
ModelDescription | Descriptive vehicle model name | Optional | |
Make | Vehicle make code - Usually available in the VIN number (use NCIC code). | Optional | |
DistributorModelCode | Alternate model code, usually used for vehicle ordering | Optional | |
DoorsQuantity | Number of doors on vehicle | Optional | |
BodyStyle | Manufacturer-assigned vehicle body style | Optional | |
TransmissionType | Vehicle Transmission type | Optional | |
TransmissionCode | Transmission Serial Number | Optional | |
VehicleWeight | Vehicle weight | Optional | |
VehiclePricing | Vehicle pricing | Optional | |
ModelGroup | Grouping of similar models for order management purposes (EX: series model group such as Camry) | Optional | |
EngineType | Manufacturer-assigned code to designate vehicle engine type (i.e., 1EZ) | Optional | |
Grade | Indicates the specific class of vehicle attached to the model description (i.e., GT, XLE, SE) | Optional | |
DriveTrain | Indicates whether the vehicle is 2 or 4 wheel drive (i.e., 2WD, 4WD, 4x4, 4x2) | Optional | |
DriveType | Designates vehicle drive type | Optional | |
GrossWeight | Fully loaded weight for one vehicle as determined by manufacturer | Optional | |
StandardOptions | Standard equipment options available on the vehicle (i.e., base model options included in the vehicle) | Optional | |
ModelOrderStartDate | First Order Date when you can order this model | Optional | |
ModelOrderEndDate | Last Order Date when you can order this model | Optional | |
PoolModelInd | Indicates that this is a Model that is pre-ordered for Order Pools | Optional | |
MainExteriorColor | Main Vehicle Exterior Color | Optional | |
VDS | VDS option component | Optional | |
FleetAvailableInd | Vehicle available To Fleet Indicator | Optional | |
FleetOnlyInd | Indicates that this vehicle only available to Fleet | Optional | |
Option | Vehicle option component | Optional | |
MarketingInitiatives | Marketing Initiatives associated with the vehicle(s) | Optional | |
ModelUrbanizationInclusions | Inclusions by Model will be defined by using the Urbanization component | Optional | |
ModelUrbanizationExclusions | Exclusions by Model will be defined by using the Urbanization component | Optional |
Super-types: | xsd:decimal < Measurement (by extension) < VehicleWeight (by extension) |
---|---|
Sub-types: | None |
Name | VehicleWeight |
---|---|
Abstract | no |
Documentation | Vehicle Weight More information at: http://www.starstandard.org. |
Super-types: | None |
---|---|
Sub-types: |
|
Name | Verb |
---|---|
Abstract | no |
Field/Component | Description | Requirement | Business Rules |
---|
Super-types: | None |
---|---|
Sub-types: | None |
Name | VSConflictsOption |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
ConflictSet | Conflicts Option set | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | VSInclusivesOption |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
InclusiveSet | Inclusives Option set | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | VSOption |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
OptionId | Option identifier code (i.e, AC) | Optional | |
OptionName | Name of vehicle option | Optional | |
OptionCost | Actual Dealer cost of option | Optional | |
OptionMSRP | Option MSRP | Optional | |
OptionSalesCode | Further definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. | Optional | |
PortInstalledInd | Indicates Port-installed accessories | Optional | |
Inclusives | Other options that must be ordered in conjunction with this option | Optional | |
Conflicts | Other options that cannot be ordered with this option | Optional | |
ColorDependentOptionInd | Option influences color availability indicator | Optional | |
OptionStockNumber | Stock Number of Vehicle Option | Optional | |
Manufacturer | Manufacturer of Vehicle Option | Optional | |
OptionPricingComponent | Price of Vehicle Option | Optional | |
ManufacturerInstalledInd | Indicates manufacturer-installed accessories | Optional | |
ItemId | Part number identifier of Option | Optional | |
DealerInstallationInd | Dealer installed accessories, before delivery of vehicle - Could be used for new or used vehicle, if applicable | Optional | |
OptionPackageId | Option package number or identifier used as a method for grouping option package items from manufacturer(s) Ex: OptPkg1,cost,OptPkg1; Item1,nocost,OptPkg1; Item2,nocost,Optpkg1; Item3,cost,nullOptPkg; OptPkg2,cost,Optpkg2; Item5,nocost,OptPkg2âÂæ | Optional | |
StandardOptionReplacement | Description of standard features replaced if you pick this option | Optional | |
FleetAvailableInd | Option available To Fleet Indicator | Optional | |
FleetOnlyInd | Indicates that this Option only available to Fleet | Optional | |
OptionOrderStartDate | Option Order Start Date | Optional | |
OptionOrderEndDate | Option Order End Date | Optional | |
MonroneyOptionDescription | Description that appears on window stickers that is required by federal law | Optional | |
OptionShortDescription | Abbreviated description of the option | Optional | |
OptionPackageDiscount | Discount on Option Package | Optional | |
OptionUrbanizationInclusions | Inclusions for Option will be defined by using the Urbanization component | Optional | |
OptionUrbanizationExclusions | Exclusions for Option will be defined by using the Urbanization component | Optional | |
RequiredOption | Code of why option is required | Required | |
RequiredOptionGroup | The group of required options to which an option belongs. EX: Option A1, Option A2, Option A3 of which you may chose only 1. | Required | |
RequiredOptionGroup | The group of required options to which an option belongs. EX: Option A1, Option A2, Option A3 of which you may chose only 1. | Optional | |
RequiredOptionGroupPriority | Identifies the priority of the required option within the required option category. For example, in an emission Required Option Group in California PZEV maybe priority 1 and Federal Emissions may be priority 2. | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | VSOption2 |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
OptionId | Option identifier code (i.e, AC) | Optional | |
OptionName | Name of vehicle option | Optional | |
OptionCost | Actual Dealer cost of option | Optional | |
OptionMSRP | Option MSRP | Optional | |
OptionSalesCode | Further definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. | Optional | |
PortInstalledInd | Indicates Port-installed accessories | Optional | |
Inclusives | Other options that must be ordered in conjunction with this option | Optional | |
Conflicts | Other options that cannot be ordered with this option | Optional | |
ColorDependentOptionInd | Option influences color availability indicator | Optional | |
OptionStockNumber | Stock Number of Vehicle Option | Optional | |
Manufacturer | Manufacturer of Vehicle Option | Optional | |
OptionPricingComponent | Price of Vehicle Option | Optional | |
ManufacturerInstalledInd | Indicates manufacturer-installed accessories | Optional | |
ItemId | Part number identifier of Option | Optional | |
DealerInstallationInd | Dealer installed accessories, before delivery of vehicle - Could be used for new or used vehicle, if applicable | Optional | |
OptionPackageId | Option package number or identifier used as a method for grouping option package items from manufacturer(s) Ex: OptPkg1,cost,OptPkg1; Item1,nocost,OptPkg1; Item2,nocost,Optpkg1; Item3,cost,nullOptPkg; OptPkg2,cost,Optpkg2; Item5,nocost,OptPkg2âÂæ | Optional | |
StandardOptionReplacement | Description of standard features replaced if you pick this option | Optional | |
FleetAvailableInd | Option available To Fleet Indicator | Optional | |
FleetOnlyInd | Indicates that this Option only available to Fleet | Optional | |
OptionOrderStartDate | Option Order Start Date | Optional | |
OptionOrderEndDate | Option Order End Date | Optional | |
MonroneyOptionDescription | Description that appears on window stickers that is required by federal law | Optional | |
OptionShortDescription | Abbreviated description of the option | Optional | |
OptionPackageDiscount | Discount on Option Package | Optional | |
OptionUrbanizationInclusions | Inclusions for Option will be defined by using the Urbanization component | Optional | |
OptionUrbanizationExclusions | Exclusions for Option will be defined by using the Urbanization component | Optional | |
RequiredOption | Code of why option is required | Required | |
RequiredOptionGroup | The group of required options to which an option belongs. EX: Option A1, Option A2, Option A3 of which you may chose only 1. | Required | |
RequiredOptionGroup | The group of required options to which an option belongs. EX: Option A1, Option A2, Option A3 of which you may chose only 1. | Optional | |
RequiredOptionGroupPriority | Identifies the priority of the required option within the required option category. For example, in an emission Required Option Group in California PZEV maybe priority 1 and Federal Emissions may be priority 2. | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | VSOptionConflictSet |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
SetId | Identification of the group of options | Optional | |
NumberOfOptions | Numbers of options in this set | Optional | |
ConflictOption | Options within set | Optional |
Super-types: | None |
---|---|
Sub-types: | None |
Name | VSOptionInclusiveSet |
---|---|
Abstract | no |
Documentation | More information at: http://www.starstandard.org. |
Field/Component | Description | Requirement | Business Rules |
---|---|---|---|
SetId | Identification of the group of options | Optional | |
NumberOfOptions | Numbers of options in this set | Optional | |
InclusiveOption | Options within set | Optional |
Super-types: | xsd:decimal < Weight (by extension) |
---|---|
Sub-types: | None |
Name | Weight |
---|---|
Abstract | no |
Documentation | Weight measurement More information at: http://www.starstandard.org. |
Attribute | Description | Requirement | Business Rules |
---|---|---|---|
uom | Required |
Super-types: | xsd:string < AddressLine (by restriction) |
---|---|
Sub-types: | None |
Name | AddressLine |
---|---|
Documentation | Indicates the multiple lines of an address. The first line is typically the street name and number. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) < BodyStyle (by restriction) |
---|---|
Sub-types: | None |
Name | BodyStyle |
---|---|
Documentation | Manufacturer-assigned vehicle body style More information at: http://www.starstandard.org. |
Super-types: | xsd:string < City (by restriction) |
---|---|
Sub-types: | None |
Name | City |
---|---|
Documentation | City of the Address. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) |
---|---|
Sub-types: |
|
Name | Code |
---|---|
Documentation | Unique code name More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < ColorDependentOptionInd (by restriction) |
---|---|
Sub-types: | None |
Name | ColorDependentOptionInd |
---|---|
Documentation | Option influences color availability indicator More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:date < Date (by restriction) < ColorOrderEndDate (by restriction) |
---|---|
Sub-types: | None |
Name | ColorOrderEndDate |
---|---|
Documentation | Color Order End Date More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < ColorOrderStartDate (by restriction) |
---|---|
Sub-types: | None |
Name | ColorOrderStartDate |
---|---|
Documentation | Color Order Start Date More information at: http://www.starstandard.org. |
Super-types: | xsd:NMTOKEN < ConfirmType (by restriction) |
---|---|
Sub-types: | None |
Name | ConfirmType |
---|
Code Value | Description |
---|---|
Always | |
OnChange | |
Never |
Super-types: | xsd:string < ContactTelephoneNumberOrganizationDescription (by restriction) |
---|---|
Sub-types: | None |
Name | ContactTelephoneNumberOrganizationDescription |
---|---|
Documentation | Contact Telephone Number Organization Description More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Day Phone | Day Phone |
Cell Phone | Cell Phone |
Pager | Pager |
Other | Other |
Super-types: | xsd:string < Note (by restriction) < ContactTime (by restriction) |
---|---|
Sub-types: | None |
Name | ContactTime |
---|---|
Documentation | Preferred contact time (i.e. Best day/time to reach the contact. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Country (by restriction) |
---|---|
Sub-types: | None |
Name | Country |
---|---|
Documentation | Country in which the Address is in. Conforms to ISO 3166-2. AF -AFGHANISTAN AL -ALBANIA DZ -ALGERIA AS -AMERICAN SAMOA AD -ANDORRA AO -ANGOLA AI -ANGUILLA AQ -ANTARCTICA AG -ANTIGUA AND BARBUDA AR -ARGENTINA AM -ARMENIA AW -ARUBA AU -AUSTRALIA AT -AUSTRIA AZ -AZERBAIJAN BS -BAHAMAS BH -BAHRAIN BD -BANGLADESH BB -BARBADOS BY -BELARUS BE -BELGIUM BZ -BELIZE BJ -BENIN BM -BERMUDA BT -BHUTAN BO -BOLIVIA BA -BOSNIA AND HERZEGOVINA BW -BOTSWANA BV -BOUVET ISLAND BR -BRAZIL IO-BRITISH INDIAN OCEAN TERRITORY BN -BRUNEI DARUSSALAM BG -BULGARIA BF -BURKINA FASO BI -BURUNDI KH -CAMBODIA CM -CAMEROON CA -CANADA CV -CAPE VERDE KY -CAYMAN ISLANDS CF -CENTRAL AFRICAN REPUBLIC TD -CHAD CL -CHILE CN -CHINA CX -CHRISTMAS ISLAND CC -COCOS (KEELING) ISLANDS CO -COLOMBIA KM -COMOROS CG -CONGO CD -CONGO, THE DEMOCRATIC REPUBLIC OF THE CK -COOK ISLANDS CR -COSTA RICA CI -CÃÂTE D'IVOIRE HR -CROATIA CU -CUBA CY -CYPRUS CZ -CZECH REPUBLIC DK -DENMARK DJ -DJIBOUTI DM -DOMINICA DO -DOMINICAN REPUBLIC EC -ECUADOR EG -EGYPT SV -EL SALVADOR GQ -EQUATORIAL GUINEA ER -ERITREA EE -ESTONIA ET -ETHIOPIA FK -FALKLAND ISLANDS (MALVINAS) FO -FAROE ISLANDS FJ -FIJI FI -FINLAND FR -FRANCE GF -FRENCH GUIANA PF -FRENCH POLYNESIA TF -FRENCH SOUTHERN TERRITORIES GA -GABON GM -GAMBIA GE -GEORGIA DE -GERMANY GH -GHANA GI -GIBRALTAR GR -GREECE GL -GREENLAND GD -GRENADA GP -GUADELOUPE GU -GUAM GT -GUATEMALA GN -GUINEA GW -GUINEA-BISSAU GY -GUYANA HT -HAITI HM -HEARD ISLAND AND MCDONALD ISLANDS VA -HOLY SEE (VATICAN CITY STATE) HN -HONDURAS HK -HONG KONG HU -HUNGARY IS -ICELAND IN -INDIA ID -INDONESIA IR -IRAN, ISLAMIC REPUBLIC OF IQ -IRAQ IE -IRELAND IL -ISRAEL IT -ITALY JM -JAMAICA JP -JAPAN JO -JORDAN KZ -KAZAKHSTAN KE -KENYA KI -KIRIBATI KP -KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF KR -KOREA, REPUBLIC OF KW -KUWAIT KG -KYRGYZSTAN LA -LAO PEOPLE'S DEMOCRATIC REPUBLIC LV -LATVIA LB -LEBANON LS -LESOTHO LR -LIBERIA LY -LIBYAN ARAB JAMAHIRIYA LI -LIECHTENSTEIN LT -LITHUANIA LU -LUXEMBOURG MO -MACAO MK -MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF MG -MADAGASCAR MW -MALAWI MY -MALAYSIA MV -MALDIVES ML -MALI MT -MALTA MH -MARSHALL ISLANDS MQ -MARTINIQUE MR -MAURITANIA MU -MAURITIUS YT -MAYOTTE MX -MEXICO FM -MICRONESIA, FEDERATED STATES OF MD -MOLDOVA, REPUBLIC OF MC -MONACO MN -MONGOLIA MS -MONTSERRAT MA -MOROCCO MZ -MOZAMBIQUE MM -MYANMAR NA -NAMIBIA NR -NAURU NP -NEPAL NL -NETHERLANDS AN -NETHERLANDS ANTILLES NC -NEW CALEDONIA NZ -NEW ZEALAND NI -NICARAGUA NE -NIGER NG -NIGERIA NU -NIUE NF -NORFOLK ISLAND MP -NORTHERN MARIANA ISLANDS NO -NORWAY OM -OMAN PK -PAKISTAN PW -PALAU PS -PALESTINIAN TERRITORY, OCCUPIED PA -PANAMA PG -PAPUA NEW GUINEA PY -PARAGUAY PE -PERU PH -PHILIPPINES PN -PITCAIRN PL -POLAND PT -PORTUGAL PR -PUERTO RICO QA -QATAR RE -RÃÂUNION RO -ROMANIA RU -RUSSIAN FEDERATION RW -RWANDA SH -SAINT HELENA KN -SAINT KITTS AND NEVIS LC -SAINT LUCIA PM -SAINT PIERRE AND MIQUELON VC -SAINT VINCENT AND THE GRENADINES WS -SAMOA SM -SAN MARINO ST -SAO TOME AND PRINCIPE SA -SAUDI ARABIA SN -SENEGAL CS -SERBIA AND MONTENEGRO SC -SEYCHELLES SL -SIERRA LEONE SG -SINGAPORE SK -SLOVAKIA SI -SLOVENIA SB -SOLOMON ISLANDS SO -SOMALIA ZA -SOUTH AFRICA GS -SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS ES -SPAIN LK -SRI LANKA SD -SUDAN SR -SURINAME SJ -SVALBARD AND JAN MAYEN SZ -SWAZILAND SE -SWEDEN CH -SWITZERLAND SY -SYRIAN ARAB REPUBLIC TW -TAIWAN, PROVINCE OF CHINA TJ -TAJIKISTAN TZ -TANZANIA, UNITED REPUBLIC OF TH -THAILAND TL -TIMOR-LESTE TG - TOGO TK -TOKELAU TO -TONGA TT -TRINIDAD AND TOBAGO TN -TUNISIA TR -TURKEY TM -TURKMENISTAN TC -TURKS AND CAICOS ISLANDS TV -TUVALU UG -UGANDA UA -UKRAINE AE -UNITED ARAB EMIRATES GB -UNITED KINGDOM US -UNITED STATES UM -UNITED STATES MINOR OUTLYING ISLANDS UY -URUGUAY UZ -UZBEKISTAN VU -VANUATU VE -VENEZUELA VN -VIET NAM VG -VIRGIN ISLANDS, BRITISH VI -VIRGIN ISLANDS, U.S. WF -WALLIS AND FUTUNA EH -WESTERN SAHARA YE -YEMEN ZM -ZAMBIA ZW -ZIMBABWE More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
US | |
AF | |
AL | |
DZ | |
AS | |
AD | |
AO | |
AI | |
AQ | |
AG | |
AR | |
AM | |
AW | |
AU | |
AT | |
AZ | |
BS | |
BH | |
BD | |
BB | |
BY | |
BE | |
BZ | |
BJ | |
BM | |
BT | |
BO | |
BA | |
BW | |
BV | |
BR | |
IO | |
BN | |
BG | |
BF | |
BI | |
KH | |
CM | |
CA | |
CV | |
KY | |
CF | |
TD | |
CL | |
CN | |
CX | |
CC | |
CO | |
KM | |
CG | |
CD | |
CK | |
CR | |
CI | |
HR | |
CU | |
CY | |
CZ | |
DK | |
DJ | |
DM | |
DO | |
EC | |
EG | |
SV | |
GQ | |
ER | |
EE | |
ET | |
FK | |
FO | |
FJ | |
FI | |
FR | |
GF | |
PF | |
TF | |
GA | |
GM | |
GE | |
DE | |
GH | |
GI | |
GR | |
GL | |
GD | |
GP | |
GU | |
GT | |
GN | |
GW | |
GY | |
HT | |
HM | |
VA | |
HN | |
HK | |
HU | |
IS | |
IN | |
ID | |
IR | |
IQ | |
IE | |
IL | |
IT | |
JM | |
JP | |
JO | |
KZ | |
KE | |
KI | |
KP | |
KR | |
KW | |
KG | |
LA | |
LV | |
LB | |
LS | |
LR | |
LY | |
LI | |
LT | |
LU | |
MO | |
MK | |
MG | |
MW | |
MY | |
MV | |
ML | |
MT | |
MH | |
MQ | |
MR | |
MU | |
YT | |
MX | |
FM | |
MD | |
MC | |
MN | |
MS | |
MA | |
MZ | |
MM | |
NA | |
NR | |
NP | |
NL | |
AN | |
NC | |
NZ | |
NI | |
NE | |
NG | |
NU | |
NF | |
MP | |
NO | |
OM | |
PK | |
PW | |
PS | |
PA | |
PG | |
PY | |
PE | |
PH | |
PN | |
PL | |
PT | |
PR | |
QA | |
RE | |
RO | |
RU | |
RW | |
SH | |
KN | |
LC | |
PM | |
VC | |
WS | |
SM | |
ST | |
SA | |
SN | |
CS | |
SC | |
SL | |
SG | |
SK | |
SI | |
SB | |
SO | |
ZA | |
GS | |
ES | |
LK | |
SD | |
SR | |
SJ | |
SZ | |
SE | |
CH | |
SY | |
TW | |
TJ | |
TZ | |
TH | |
TL | |
TG | |
TK | |
TO | |
TT | |
TN | |
TR | |
TM | |
TC | |
TV | |
UG | |
UA | |
AE | |
GB | |
UM | |
UY | |
UZ | |
VU | |
VE | |
VN | |
VG | |
VI | |
WF | |
EH | |
YE | |
ZM | |
ZW |
Super-types: | xsd:string < County (by restriction) |
---|---|
Sub-types: | None |
Name | County |
---|---|
Documentation | Business party county location More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Currency (by restriction) |
---|---|
Sub-types: | None |
Name | Currency |
---|---|
Documentation | The ISO code identifying the type of currency in use. More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
USD | |
ADP | |
AED | |
AFA | |
ALL | |
ANG | |
AOK | |
ARA | |
ATS | |
AUD | |
AWG | |
BBD | |
BDT | |
BEF | |
BGL | |
BHD | |
BIF | |
BMD | |
BND | |
BOB | |
BRC | |
BSD | |
BTN | |
BUK | |
BWP | |
BZD | |
CAD | |
CHF | |
CLF | |
CLP | |
CNY | |
COP | |
CRC | |
CSK | |
CUP | |
CVE | |
CYP | |
DDM | |
DEM | |
DJF | |
DKK | |
DOP | |
DZD | |
ECS | |
EGP | |
ESP | |
ETB | |
EUR | |
FIM | |
FKP | |
FRF | |
GBP | |
GHC | |
GIP | |
GMD | |
GNF | |
GRD | |
GTQ | |
GWP | |
GYD | |
HKD | |
HNL | |
HTG | |
HUF | |
IDR | |
IEP | |
ILS | |
INR | |
IQD | |
IRR | |
ISK | |
ITL | |
JMD | |
JOD | |
JPY | |
KES | |
KHR | |
KMF | |
KPW | |
KRW | |
KWD | |
KYD | |
LAK | |
LBP | |
LKR | |
LRD | |
LSL | |
LUF | |
LYD | |
MAD | |
MGF | |
MNT | |
MOP | |
MRO | |
MTL | |
MUR | |
MVR | |
MWK | |
MXN | |
MYR | |
MZM | |
NGN | |
NIC | |
NLG | |
NOK | |
NPR | |
NZD | |
OMR | |
PAB | |
PEI | |
PGK | |
PHP | |
PKR | |
PLZ | |
PTE | |
PYG | |
QAR | |
ROL | |
RWF | |
SAR | |
SBD | |
SCR | |
SDP | |
SEK | |
SGD | |
SHP | |
SLL | |
SKK | |
SOS | |
SRG | |
STD | |
SUR | |
SVC | |
SYP | |
SZL | |
THB | |
TND | |
TOP | |
TPE | |
TRL | |
TTD | |
TWD | |
TZS | |
UGS | |
UYP | |
VEB | |
VND | |
VUV | |
WST | |
YDD | |
YER | |
YUD | |
ZAR | |
ZRZ | |
ZWD | |
Other |
Super-types: | xsd:date < Date (by restriction) |
---|---|
Sub-types: |
|
Name | Date |
---|---|
Documentation | Date conforms to ISO 8601 format rules EX: \d\d\d\d-\d\d-\d\d More information at: http://www.starstandard.org. |
Super-types: | xsd:dateTime < DateTime (by restriction) |
---|---|
Sub-types: |
|
Name | DateTime |
---|---|
Documentation | Date and time conforms to ISO 8601format rules without offset EX:2003-11-05T13:15:30Z More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < DealerInstallationInd (by restriction) |
---|---|
Sub-types: | None |
Name | DealerInstallationInd |
---|---|
Documentation | Indicates whether or not the dealership installed the part More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Text (by restriction) < DistributorModelCode (by restriction) |
---|---|
Sub-types: | None |
Name | DistributorModelCode |
---|---|
Documentation | Alternate model code, usually used for vehicle ordering More information at: http://www.starstandard.org. |
Super-types: | xsd:dateTime < DateTime (by restriction) < DocumentDateTime (by restriction) |
---|---|
Sub-types: | None |
Name | DocumentDateTime |
---|---|
Documentation | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < DriveTrain (by restriction) |
---|---|
Sub-types: | None |
Name | DriveTrain |
---|---|
Documentation | Indicates whether the vehicle is 2 or 4 wheel drive (ie: 2WD, 4WD, 4x4, 4x2) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < DriveType (by restriction) |
---|---|
Sub-types: | None |
Name | DriveType |
---|---|
Documentation | Designates vehicle drive type More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Front | Front wheel drive |
Rear | Rear wheel drive |
Super-types: | xsd:string < Type (by restriction) < EngineType (by restriction) |
---|---|
Sub-types: | None |
Name | EngineType |
---|---|
Documentation | Manufacturer-assigned code to designate vehicle engine type (ie: 1EZ More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < ExteriorColor (by restriction) |
---|---|
Sub-types: | None |
Name | ExteriorColor |
---|---|
Documentation | Vehicle Exterior Color(s) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < ExteriorColorCode (by restriction) |
---|---|
Sub-types: | None |
Name | ExteriorColorCode |
---|---|
Documentation | Vehicle exterior color code More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < FleetAccount (by restriction) |
---|---|
Sub-types: | None |
Name | FleetAccount |
---|---|
Documentation | Manufacturer defined fleet account number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < FleetAvailableInd (by restriction) |
---|---|
Sub-types: | None |
Name | FleetAvailableInd |
---|---|
Documentation | Vehicle available To Fleet Indicator More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < FleetOnlyInd (by restriction) |
---|---|
Sub-types: | None |
Name | FleetOnlyInd |
---|---|
Documentation | Indicates that this vehicle only available to Fleet More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Note (by restriction) < Grade (by restriction) |
---|---|
Sub-types: | None |
Name | Grade |
---|---|
Documentation | Indicates the specific class of vehicle attached to the model description (ie: GT, XLE, SE) More information at: http://www.starstandard.org. |
Super-types: | xsd:dateTime < DateTime (by restriction) < IncrementalDateTime (by restriction) |
---|---|
Sub-types: | None |
Name | IncrementalDateTime |
---|---|
Documentation | Send all changes that have occurred since this date More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < IncrementalInd (by restriction) |
---|---|
Sub-types: | None |
Name | IncrementalInd |
---|---|
Documentation | Specifies whether to send full specifications or incremental changes More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) |
---|---|
Sub-types: |
|
Name | Indicator |
---|---|
Documentation | 0 = No, 1 = Yes More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < InitiativeChangeInd (by restriction) |
---|---|
Sub-types: | None |
Name | InitiativeChangeInd |
---|---|
Documentation | Can the Initiative be changed indicator More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:date < Date (by restriction) < InitiativeDate (by restriction) |
---|---|
Sub-types: | None |
Name | InitiativeDate |
---|---|
Documentation | The date the initiative was processed. More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < InitiativeEndDate (by restriction) |
---|---|
Sub-types: | None |
Name | InitiativeEndDate |
---|---|
Documentation | Initiative ending date More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < InitiativeStartDate (by restriction) |
---|---|
Sub-types: | None |
Name | InitiativeStartDate |
---|---|
Documentation | Initiative begin date More information at: http://www.starstandard.org. |
Super-types: | xsd:string < InitiativeType (by restriction) |
---|---|
Sub-types: | None |
Name | InitiativeType |
---|---|
Documentation | Type of program - Incentive or program related initiatives More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Program | Program-related initiative |
Incentives | Incentive-related initiative |
N/A | Not Applicable |
Other | Other |
Super-types: | xsd:string < Note (by restriction) < InteriorColor (by restriction) |
---|---|
Sub-types: | None |
Name | InteriorColor |
---|---|
Documentation | Vehicle Interior Color(s) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < InteriorColorCode (by restriction) |
---|---|
Sub-types: | None |
Name | InteriorColorCode |
---|---|
Documentation | Vehicle Interior color code More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Language (by restriction) |
---|---|
Sub-types: |
|
Name | Language |
---|---|
Documentation | Language conforms to ISO 639-2 rules. Note the format for this field is language-Country (see Country data type for the list of countries with definitions). AA "Afar", AB "Abkhazian", AF "Afrikaans", AM "Amharic", AR "Arabic", AS "Assamese", AY "Aymara", AZ "Azerbaijani", BA "Bashkir", BE "Byelorussian", BG "Bulgarian", BH "Bihari", BI "Bislama", BN "Bengali" "Bangla", BO "Tibetan", BR "Breton", CA "Catalan", CO "Corsican", CS "Czech", CY "Welsh", DA "Danish", DE "German", DZ "Bhutani", EL "Greek", EN "English" "American", ES "Spanish", ET "Estonian", EU "Basque", FA "Persian", FI "Finnish", FJ "Fiji", FO "Faeroese", FR "French", FY "Frisian", GA "Irish", GD "Gaelic" "Scots Gaelic", GL "Galician", GN "Guarani", GU "Gujarati", HA "Hausa", HI "Hindi", HR "Croatian", HU "Hungarian", HY "Armenian", IK "Inupiak", IN "Indonesian", IS "Icelandic", IT "Italian", IW "Hebrew", JA "Japanese", JI "Yiddish", JW "Javanese", KA "Georgian", KK "Kazakh", KL "Greenlandic", KM "Cambodian", KN "Kannada", KO "Korean", KS "Kashmiri", KU "Kurdish", KY "Kirghiz", LA "Latin", LN "Lingala", LO "Laothian", LT "Lithuanian", LV "Latvian" "Lettish", MG "Malagasy". MI "Maori", MK "Macedonian", ML "Malayalam", MN "Mongolian", MO "Moldavian", MR "Marathi", MS "Malay", MT "Maltese", MY "Burmese", NA "Nauru", NE "Nepali", NL "Dutch", NO "Norwegian", OC "Occitan", OM "Oromo" "Afan", OR "Oriya", PA "Punjabi", PL "Polish", PS "Pashto" "Pushto", PT "Portuguese", QU "Quechua", RM "Rhaeto-Romance", RN "Kirundi", RO "Romanian", RU "Russian", RW "Kinyarwanda", SA "Sanskrit", SD "Sindhi", SG "Sangro", SH "Serbo-Croatian", SI "Singhalese", SK "Slovak", SL "Slovenian", SM "Samoan", SN "Shona", SO "Somali", SQ "Albanian", SR "Serbian", SS "Siswati", ST "Sesotho", SU "Sudanese", SV "Swedish", SW "Swahili", TA "Tamil", TE "Tegulu", TG "Tajik", TH "Thai", TI "Tigrinya", TK "Turkmen", TL "Tagalog", TN "Setswana", TO "Tonga", TR "Turkish", TS "Tsonga", TT "Tatar", TW "Twi", UK "Ukrainian", UR "Urdu", UZ "Uzbek", VI "Vietnamese", WO "Wolof", XH "Xhosa", YO "Yoruba", ZH "Chinese", ZU "Zulu" More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
en-US | |
en-CA | |
aa-ET | |
ab-GE | |
af-ZA | |
am- ET | |
ar-SA | |
as-IN | |
ay-BO | |
az-AZ | |
ba-RU | |
be-BY | |
bg-BG | |
bh-IN | |
bi-VU | |
bn-BD | |
bo-BT | |
br-FR | |
ca-ES | |
co-FR | |
cs-CZ | |
cy-GB | |
da-DE | |
de-DE | |
dz-BT | |
el-GR | |
es-ES | |
et-EE | |
eu-ES | |
fa-AF | |
fi-FI | |
fj-FJ | |
fo-FO | |
fr-CA | |
fr-FR | |
fy-NL | |
ga-IE | |
gd-GB | |
gl-ES | |
gn-PY | |
gu-IN | |
ha-NG | |
hi-IN | |
hr-HR | |
hu-HU | |
hy-AM | |
ik-GL | |
in-ID | |
is-IS | |
it-IT | |
iw-IL | |
ja-JP | |
ji-IL | |
jw-ID | |
ka-GE | |
kk-KZ | |
kl-GL | |
km-KH | |
kn-IN | |
ko-KP | |
ko-KR | |
ks-IN | |
ku-IQ | |
ky-CN | |
la-VA | |
ln-CD | |
lo-LA | |
lt-LT | |
lv-LV | |
mg-MG | |
mi-NZ | |
mk-MK | |
ml-IN | |
mn-MN | |
mo-MO | |
mr-IN | |
ms-MY | |
mt-MH | |
my-MM | |
na-NR | |
ne-NP | |
nl-NL | |
no-NO | |
oc-FR | |
om- ET | |
or-IN | |
pa-IN | |
pl-PL | |
ps-PK | |
pt-PT | |
qu-PE | |
rm-CH | |
rn-BI | |
ro-RO | |
ru-RU | |
rw-RW | |
sa-IN | |
sd-PK | |
sg-CF | |
sh-HR | |
si-LK | |
sk-SK | |
sl-SI | |
sm-WS | |
sn-ZW | |
so-SO | |
sq-AL | |
sr-CS | |
ss-ZA | |
st-ZA | |
su-SD | |
sv-SE | |
sw-TL | |
ta-IN | |
te-IN | |
tg-TJ | |
th-TH | |
ti-ET | |
tk-TM | |
tl-PH | |
tn-ZA | |
to-TO | |
tr-TR | |
ts-ZA | |
tt-RU | |
tw-GH | |
uk-UA | |
ur-PK | |
uz-UZ | |
vi-VN | |
wo-SN | |
xh-ZA | |
yo-NG | |
zh-CN | |
zu-ZA |
Super-types: | xsd:string < Make (by restriction) |
---|---|
Sub-types: | None |
Name | Make |
---|---|
Documentation | Vehicle make code - Usually available in the VIN number (use NCIC code). More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < Manufacturer (by restriction) |
---|---|
Sub-types: | None |
Name | Manufacturer |
---|---|
Documentation | Manufacturer Name More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < ManufacturerInstalledInd (by restriction) |
---|---|
Sub-types: | None |
Name | ManufacturerInstalledInd |
---|---|
Documentation | Indicates manufacturer-installed accessories More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Text (by restriction) < Model (by restriction) |
---|---|
Sub-types: | None |
Name | Model |
---|---|
Documentation | Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) < ModelDescription (by restriction) |
---|---|
Sub-types: | None |
Name | ModelDescription |
---|---|
Documentation | Descriptive vehicle model name More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < ModelOrderEndDate (by restriction) |
---|---|
Sub-types: | None |
Name | ModelOrderEndDate |
---|---|
Documentation | Last Order Date when you can order this model More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < ModelOrderStartDate (by restriction) |
---|---|
Sub-types: | None |
Name | ModelOrderStartDate |
---|---|
Documentation | First Order Date when you can order this model More information at: http://www.starstandard.org. |
Super-types: | xsd:gYear < Year (by restriction) < ModelYear (by restriction) |
---|---|
Sub-types: | None |
Name | ModelYear |
---|---|
Documentation | Vehicle designated model year More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) |
---|---|
Sub-types: |
|
Name | Name |
---|---|
Documentation | Name of the Party. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) |
---|---|
Sub-types: |
|
Name | Note |
---|---|
Documentation | A free form note. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < OptionId (by restriction) |
---|---|
Sub-types: | None |
Name | OptionId |
---|---|
Documentation | Option identifier code (i.e., AC) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < OptionName (by restriction) |
---|---|
Sub-types: | None |
Name | OptionName |
---|---|
Documentation | Name of vehicle option More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < OptionOrderEndDate (by restriction) |
---|---|
Sub-types: | None |
Name | OptionOrderEndDate |
---|---|
Documentation | Option Order End Date More information at: http://www.starstandard.org. |
Super-types: | xsd:date < Date (by restriction) < OptionOrderStartDate (by restriction) |
---|---|
Sub-types: | None |
Name | OptionOrderStartDate |
---|---|
Documentation | Option Order Start Date More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < OptionSalesCode (by restriction) |
---|---|
Sub-types: | None |
Name | OptionSalesCode |
---|---|
Documentation | Further definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < OptionStockNumber (by restriction) |
---|---|
Sub-types: | None |
Name | OptionStockNumber |
---|---|
Documentation | Stock Number of Vehicle Option More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Indicator (by restriction) < PoolModelInd (by restriction) |
---|---|
Sub-types: | None |
Name | PoolModelInd |
---|---|
Documentation | Indicates that this is a Model that is pre-ordered for Order Pools More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Indicator (by restriction) < PortInstalledInd (by restriction) |
---|---|
Sub-types: | None |
Name | PortInstalledInd |
---|---|
Documentation | Indicates Port-installed accessories More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
0 | |
1 |
Super-types: | xsd:string < Code (by restriction) < PostalCode (by restriction) |
---|---|
Sub-types: | None |
Name | PostalCode |
---|---|
Documentation | Postal Code of the Address. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < PreferredContactMethodOrganization (by restriction) |
---|---|
Sub-types: | None |
Name | PreferredContactMethodOrganization |
---|---|
Documentation | Preferred Contact Method Organization More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Day Phone | Day Phone |
Cell Phone | Cell Phone |
Work Fax | Work Fax |
Pager | Pager |
Work Email | Work Email |
US Mail | US Mail |
Other | Other |
Super-types: | xsd:string < Language (by restriction) < PreferredLanguage (by restriction) |
---|---|
Sub-types: | None |
Name | PreferredLanguage |
---|---|
Documentation | Preferred language More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
en-US | |
en-CA | |
aa-ET | |
ab-GE | |
af-ZA | |
am- ET | |
ar-SA | |
as-IN | |
ay-BO | |
az-AZ | |
ba-RU | |
be-BY | |
bg-BG | |
bh-IN | |
bi-VU | |
bn-BD | |
bo-BT | |
br-FR | |
ca-ES | |
co-FR | |
cs-CZ | |
cy-GB | |
da-DE | |
de-DE | |
dz-BT | |
el-GR | |
es-ES | |
et-EE | |
eu-ES | |
fa-AF | |
fi-FI | |
fj-FJ | |
fo-FO | |
fr-CA | |
fr-FR | |
fy-NL | |
ga-IE | |
gd-GB | |
gl-ES | |
gn-PY | |
gu-IN | |
ha-NG | |
hi-IN | |
hr-HR | |
hu-HU | |
hy-AM | |
ik-GL | |
in-ID | |
is-IS | |
it-IT | |
iw-IL | |
ja-JP | |
ji-IL | |
jw-ID | |
ka-GE | |
kk-KZ | |
kl-GL | |
km-KH | |
kn-IN | |
ko-KP | |
ko-KR | |
ks-IN | |
ku-IQ | |
ky-CN | |
la-VA | |
ln-CD | |
lo-LA | |
lt-LT | |
lv-LV | |
mg-MG | |
mi-NZ | |
mk-MK | |
ml-IN | |
mn-MN | |
mo-MO | |
mr-IN | |
ms-MY | |
mt-MH | |
my-MM | |
na-NR | |
ne-NP | |
nl-NL | |
no-NO | |
oc-FR | |
om- ET | |
or-IN | |
pa-IN | |
pl-PL | |
ps-PK | |
pt-PT | |
qu-PE | |
rm-CH | |
rn-BI | |
ro-RO | |
ru-RU | |
rw-RW | |
sa-IN | |
sd-PK | |
sg-CF | |
sh-HR | |
si-LK | |
sk-SK | |
sl-SI | |
sm-WS | |
sn-ZW | |
so-SO | |
sq-AL | |
sr-CS | |
ss-ZA | |
st-ZA | |
su-SD | |
sv-SE | |
sw-TL | |
ta-IN | |
te-IN | |
tg-TJ | |
th-TH | |
ti-ET | |
tk-TM | |
tl-PH | |
tn-ZA | |
to-TO | |
tr-TR | |
ts-ZA | |
tt-RU | |
tw-GH | |
uk-UA | |
ur-PK | |
uz-UZ | |
vi-VN | |
wo-SN | |
xh-ZA | |
yo-NG | |
zh-CN | |
zu-ZA |
Super-types: | xsd:string < Note (by restriction) < PriceExplanation (by restriction) |
---|---|
Sub-types: | None |
Name | PriceExplanation |
---|---|
Documentation | Explanatory Note for Pricing More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < PricingTypeSource (by restriction) |
---|---|
Sub-types: | None |
Name | PricingTypeSource |
---|---|
Documentation | Source from which pricing type data originated (i.e. Blue Book, NADA, etc.). More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) < Reference (by restriction) |
---|---|
Sub-types: | None |
Name | Reference |
---|---|
Documentation | Reference notation More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) |
---|---|
Sub-types: |
|
Name | ReferenceNumber |
---|---|
Documentation | Reference number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < ReimbursementComment (by restriction) |
---|---|
Sub-types: | None |
Name | ReimbursementComment |
---|---|
Documentation | Reimbursement dealer comments More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Name (by restriction) < ReimbursementPayee (by restriction) |
---|---|
Sub-types: | None |
Name | ReimbursementPayee |
---|---|
Documentation | Indicates who is paid More information at: http://www.starstandard.org. |
Super-types: | xsd:string < RequiredOption (by restriction) |
---|---|
Sub-types: | None |
Name | RequiredOption |
---|---|
Documentation | Code of why option is required More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Regional | |
Government | |
Other | Other |
Super-types: | xsd:string < Text (by restriction) < RequiredOptionGroup (by restriction) |
---|---|
Sub-types: | None |
Name | RequiredOptionGroup |
---|---|
Documentation | The group of required options to which an option belongs. EX: Option A1, Option A2, Option A3 of which you may chose only 1. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) < RequiredOptionGroupPriority (by restriction) |
---|---|
Sub-types: | None |
Name | RequiredOptionGroupPriority |
---|---|
Documentation | Identifies the priority of the required option within the required option category. For example, in an emission Required Option Group in California PZEV maybe priority 1 and Federal Emissions may be priority 2. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < SecondaryExteriorColor (by restriction) |
---|---|
Sub-types: | None |
Name | SecondaryExteriorColor |
---|---|
Documentation | Secondary Vehicle Exterior Color(s) Note: This is the highlight or secondary color for the exterior of the vehicle More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < SecondaryExteriorColorCode (by restriction) |
---|---|
Sub-types: | None |
Name | SecondaryExteriorColorCode |
---|---|
Documentation | Secondary Vehicle exterior color code(s) Note: This is the highlight or secondary color code for the exterior of the vehicle More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Note (by restriction) < SecondaryPassword (by restriction) |
---|---|
Sub-types: | None |
Name | SecondaryPassword |
---|---|
Documentation | Secondary password used to validate access to the dealer information More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < ShortMfg (by restriction) |
---|---|
Sub-types: | None |
Name | ShortMfg |
---|---|
Documentation | Short Manfacturer or RSP Codes More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) < StandardOptionReplacement (by restriction) |
---|---|
Sub-types: | None |
Name | StandardOptionReplacement |
---|---|
Documentation | Description of standard features replaced if you pick this option More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) < StandardOptions (by restriction) |
---|---|
Sub-types: | None |
Name | StandardOptions |
---|---|
Documentation | Standard equipment options available on the vehicle (i.e., base model options included in the vehicle) More information at: http://www.starstandard.org. |
Super-types: | xsd:string < StateOrProvince (by restriction) |
---|---|
Sub-types: | None |
Name | StateOrProvince |
---|---|
Documentation | Is the State or Province of a given Address. More information at: http://www.starstandard.org. |
Super-types: | xsd:string < ReferenceNumber (by restriction) < SystemVersion (by restriction) |
---|---|
Sub-types: | None |
Name | SystemVersion |
---|---|
Documentation | The sender's software version number . More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Text (by restriction) |
---|---|
Sub-types: |
|
Name | Text |
---|---|
Documentation | Indicates generic text type More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < TransmissionCode (by restriction) |
---|---|
Sub-types: | None |
Name | TransmissionCode |
---|---|
Documentation | Transmission Serial Number More information at: http://www.starstandard.org. |
Super-types: | xsd:string < TransmissionType (by restriction) |
---|---|
Sub-types: | None |
Name | TransmissionType |
---|---|
Documentation | Vehicle Transmission type - 3 = 3 speed, 4 = 4 speed, 5 = 5 speed, 6 = 6 speed, A - Automatic More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
3 | 3 Speed |
4 | 4 Speed |
5 | 5 Speed |
6 | 6 Speed |
A | "A" = Automatic |
Automatic 3 | Automatic 3 speed transmission type |
Automatic 4 | Automatic 4 speed transmission type |
Automatic 5 | Automatic 5 speed transmission type |
Automatic 6 | Automatic 6 speed transmission type |
Automatic 7 | Automatic 7 speed transmission type |
7 | 7 Speed |
CVT Automatic 3 | Continuously Variable T ransmission Automatic 3 speed transmission type (natural gas and hybrid). |
CVT Automatic 4 | Continuously Variable T ransmission Automatic 4 speed transmission type (natural gas and hybrid). |
CVT Automatic 5 | Continuously Variable T ransmission Automatic 5 speed transmission type (natural gas and hybrid). |
CVT Automatic 6 | Continuously Variable T ransmission Automatic 6 speed transmission type (natural gas and hybrid). |
CVT Automatic 7 | Continuously Variable T ransmission Automatic 7 speed transmission type (natural gas and hybrid). |
M | M = Manual |
Super-types: | xsd:string < Type (by restriction) |
---|---|
Sub-types: |
|
Name | Type |
---|---|
Documentation | Type More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < UrbanizationCode (by restriction) |
---|---|
Sub-types: | None |
Name | UrbanizationCode |
---|---|
Documentation | Geographic definition of a metropolitan or suburban area More information at: http://www.starstandard.org. |
Super-types: | xsd:anyURI < URI (by restriction) |
---|---|
Sub-types: | None |
Name | URI |
---|---|
Documentation | URI More information at: http://www.starstandard.org. |
Super-types: | xsd:string < Code (by restriction) < VDSCode (by restriction) |
---|---|
Sub-types: | None |
Name | VDSCode |
---|---|
Documentation | Vehicle Description Section- part of the VIN that correlates to a specific vehicle model, bodystyle, and grade More information at: http://www.starstandard.org. |
Super-types: | xsd:string < VehiclePricingType (by restriction) |
---|---|
Sub-types: | None |
Name | VehiclePricingType |
---|---|
Documentation | Designates type of pricing for vehicle More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
MSRP | |
Hold Back | |
Destination/Handling | |
Group Fund Price | |
Wholesale Price | |
Wholesale Cost | |
Actual Cash Value | |
Employee | |
Invoice | |
Sale Price | |
Final MSRP | |
Base MSRP | |
Employee Order Price | |
Employee Stock Price | |
Other | Other |
Selling Price | |
Cap Cost | |
Total Option Price | |
Total Option Cost | |
Retail | |
N/A | Not Applicable |
MSRP Discount | |
Gross Cap Cost | |
Net Cap Cost | |
Taxable Selling Price | |
Loan | Amount lenders typically loan on the listed vehicle. |
Trade-In | Amount allowed by dealers on a trade. |
Adjusted Gross Cap Cost | Adjusted gross cap cost due to tax calculations. |
Adjusted Net Cap Cost | Adjusted net cap cost due to tax calculations. |
Total Option MSRP | Total of all itemized products of the Manufactured Suggested Retail Price. |
Super-types: | xsd:string < WeightMeasure (by restriction) |
---|---|
Sub-types: | None |
Name | WeightMeasure |
---|---|
Documentation | Weight Measurements More information at: http://www.starstandard.org. |
Code Value | Description |
---|---|
Pounds | Pounds |
Kilos | Kilos |
Other | Other |
Super-types: | xsd:gYear < Year (by restriction) |
---|---|
Sub-types: |
|
Name | Year |
---|---|
Documentation | Year More information at: http://www.starstandard.org. |
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: