Implementation Guideline
Cancel Vehicle Remarketing
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Implementation Guideline
Cancel Vehicle Remarketing
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 Cancel Vehicle Remarketing Business Object Document (BOD). Cancel Vehicle Remarketing has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Cancel Vehicle Remarketing 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 Cancel Vehicle Remarketing, this BOD could be used to send Cancel Vehicle Remarketing information between any two business parties.
The Cancel Vehicle Remarketing Implementation Guidelines provide detailed information regarding the structure and meaning of the Cancel Vehicle Remarketing BOD and corresponds directly to the Cancel Vehicle Remarketing 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 Cancel Vehicle Remarketing Implementation Guidelines must be used in concert with the Cancel Vehicle Remarketing 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 Cancel Vehicle Remarketing 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 Cancel Vehicle Remarketing BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Cancel Vehicle Remarketing 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 Cancel Vehicle Remarketing 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 Cancel Vehicle Remarketing 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 | Cancel |
|---|---|
| Type | Cancel |
| Nillable | no |
| Abstract | no |
| Documentation | The Cancel verb is used when the sender of the BOD is not the owner of the data, but is sending a request for the document to be canceled.An example is the Cancel PO where the business implications must be calculated and a simple data processing term such as delete can not fully convey the business meaning and required processing associated with the meaning. More information at: http://www.openapplications.org/oagis. |
| Name | CancelVehicleRemarketing |
|---|---|
| Type | CancelVehicleRemarketing |
| Nillable | no |
| Abstract | no |
| Name | Header |
|---|---|
| Type | VehicleRemarketingHeader |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | Vehicle |
|---|---|
| Type | VehicleRemarketingVehicle |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | VehicleRemarketing |
|---|---|
| Type | VehicleRemarketing |
| 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: | None |
|---|---|
| Sub-types: | None |
| Name | Advertising |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| AdvertisingCopy | Information that goes in the ad | Optional | |
| AdvertisingMedia | Media where ad is placed. Ex: Internet, newspaper, etc. | Optional | |
| CopyType | Type of copy used for ad. Ex: Teaser text, short description, long description | Optional | |
| Language | Language for the ad copy | Optional |
| 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: | xsd:integer < Count (by extension) < Mileage (by extension) < AnnualMilesAllowed (by extension) |
|---|---|
| Sub-types: | None |
| Name | AnnualMilesAllowed |
|---|---|
| Abstract | no |
| Documentation | The number allowed annually for a balloon contract. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) < AnnualPercentageRate (by extension) |
|---|---|
| Sub-types: | None |
| Name | AnnualPercentageRate |
|---|---|
| Abstract | no |
| Documentation | Annual percentage rate. More information at: http://www.starstandard.org. |
| 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 |
DateTime fields must be formatted as XML Schema
Datetimes in UTC/GMT format without offsets.
Example: 2003-11-05T13:15:30Z
|
| 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 |
Optional. "qualifyingAgency" attribute.
|
| 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 |
See Destination Component.
|
| Super-types: | xsd:decimal < Amount (by extension) < ApprovedAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | ApprovedAmount |
|---|---|
| Abstract | no |
| Documentation | Amount pre-approved More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < BalanceAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | BalanceAmount |
|---|---|
| Abstract | no |
| Documentation | Remaining balance on Current Vehicle More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | BrandedInfo |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| BrandedTitleInd | This tag indicates if a vehicle's title has been branded. (i.e., vehicle totaled and state registration title branded as such) | Optional | |
| BrandedTitleDate | Branding Date | Optional | |
| BrandingStateCode | Branding State Code | Optional | |
| BrandingStateReference | Branding State Reference Number | Optional | |
| BrandingSource | Branding source – (i.e., source who says that the vehicle is branded) | Optional |
| Super-types: | xsd:string < StateOrProvince (by restriction) < BrandingStateCode (by extension) |
|---|---|
| Sub-types: | None |
| Name | BrandingStateCode |
|---|---|
| Abstract | no |
| Documentation | Branding State Code 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: | Verb < ConfirmableVerb (by extension) < Cancel (by extension) |
|---|---|
| Sub-types: | None |
| Name | Cancel |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required |
| Super-types: | BusinessObjectDocument < CancelVehicleRemarketing (by extension) |
|---|---|
| Sub-types: | None |
| Name | CancelVehicleRemarketing |
|---|---|
| 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 | CancelVehicleRemarketingDataArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Cancel | The Cancel verb is used when the sender of the BOD is not the owner of the data, but is sending a request for the document to be canceled.An example is the Cancel PO where the business implications must be calculated and a simple data processing term such as delete can not fully convey the business meaning and required processing associated with the meaning. | Required | |
| VehicleRemarketing | Required |
| Super-types: | xsd:string < CodeType (by extension) |
|---|---|
| Sub-types: | None |
| Name | CodeType |
|---|---|
| Abstract | no |
| Documentation | Unique code name More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| listID | Optional | ||
| listName | Optional | ||
| listAgencyID | Optional | ||
| listAgencyName | Optional | ||
| listVersionID | Optional | ||
| listURI | Optional |
| 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:string < Id (by extension) < ContractId (by extension) |
|---|---|
| Sub-types: | None |
| Name | ContractId |
|---|---|
| Abstract | no |
| Documentation | Identification of Contract More information at: http://www.starstandard.org. |
| 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: | PartyBase < DealerPartyBase (by extension) < DealerExtendedAddress (by extension) |
|---|---|
| Sub-types: | None |
| Name | DealerExtendedAddress |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| DealerName | Dealer name | Optional | |
| DistrictCode | Manufacturer Assigned District Code | Optional | |
| URI | Dealer URI | Optional | |
| ZoneCode | Manufacturer Assigned Zone Code | Optional | |
| Address | Dealer party address | Optional |
| Super-types: | PartyBase < DealerPartyBase (by extension) |
|---|---|
| Sub-types: |
|
| Name | DealerPartyBase |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| DealerName | Dealer name | Optional | |
| DistrictCode | Manufacturer Assigned District Code | Optional | |
| URI | Dealer URI | Optional | |
| ZoneCode | Manufacturer Assigned Zone Code | Optional |
| Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < DeliveryMileage (by extension) |
|---|---|
| Sub-types: | None |
| Name | DeliveryMileage |
|---|---|
| Abstract | no |
| Documentation | Odometer reading of vehicle at time of delivery 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 |
Must use a valid code from the ShortMfg/RSP list on
http://www.starstandards.org
|
| 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: | xsd:string < Id (by extension) < DocumentId (by extension) |
|---|---|
| Sub-types: | None |
| Name | DocumentId |
|---|---|
| Abstract | no |
| Documentation | Is the identifier for the document. More information at: http://www.starstandard.org. |
| 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:decimal < Amount (by extension) < DownPaymentAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | DownPaymentAmount |
|---|---|
| Abstract | no |
| Documentation | Down Payment amount or amount of cap cost reduction. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | EmbeddedData |
|---|---|
| Abstract | no |
| Documentation | embedded data witin a BOD More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| encoding | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Data | Container to carry the embedded data | Required |
| Super-types: | xsd:integer < Count (by extension) < EngineCylinders (by restriction) |
|---|---|
| Sub-types: | None |
| Name | EngineCylinders |
|---|---|
| Abstract | no |
| Documentation | Engine cylinder count More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < EngineDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | EngineDescription |
|---|---|
| Abstract | no |
| Documentation | Text description of engine (e.g. dohc, 32 valves) More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < ExcessMileageRate (by extension) |
|---|---|
| Sub-types: | None |
| Name | ExcessMileageRate |
|---|---|
| Abstract | no |
| Documentation | The rate charged per mile over the annual miles allowed. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < FinalAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | FinalAmount |
|---|---|
| Abstract | no |
| Documentation | Last month payment amount More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < FinanceCharge (by extension) |
|---|---|
| Sub-types: | None |
| Name | FinanceCharge |
|---|---|
| Abstract | no |
| Documentation | The total interest paid on the contract. 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 |
DateTime fields must be formatted as XML Schema
DateTimes in UTC/GMT format without offsets.
Example: 2003-11-05T13:15:30Z
|
| 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: | None |
|---|---|
| Sub-types: |
|
| Name | ImageAttachment |
|---|---|
| Abstract | no |
| Documentation | represents information about the location of on-line vehicle photos. More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| URI | URI | Optional | |
| ImageWidth | Image tag width. Example: "100" | Optional | |
| ImageHeight | Image tag height Example: "120" | Optional | |
| ImageAlternateText | Image alternate text. Example: "1997 Honda Accord" | Optional |
| Super-types: | ImageAttachment < ImageAttachmentExtended (by extension) |
|---|---|
| Sub-types: | None |
| Name | ImageAttachmentExtended |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| URI | URI | Optional | |
| ImageWidth | Image tag width. Example: "100" | Optional | |
| ImageHeight | Image tag height Example: "120" | Optional | |
| ImageAlternateText | Image alternate text. Example: "1997 Honda Accord" | Optional | |
| ImageAttachmentTitle | Image attachment title | Optional | |
| EmbeddedData | Holder for embedded data. (Will have an attribute for type of enbedded document) | Optional |
| Super-types: | xsd:integer < Count (by extension) < ImageHeight (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ImageHeight |
|---|---|
| Abstract | no |
| Documentation | Image tag height Example: "120" More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) < ImageWidth (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ImageWidth |
|---|---|
| Abstract | no |
| Documentation | Image tag width. Example: "100" More information at: http://www.starstandard.org. |
| Super-types: | PartyBase < IndividualPartyMinimal (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualPartyMinimal |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| PersonName | Individual party name | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | IndividualPartyPersonName2 |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Salutation | Title or greeting of business party | Optional | |
| GivenName | First Name of business party | Required | |
| MiddleName | Middle Initial of business party | Optional | |
| FamilyName | Last Name of business party | Required | |
| Suffix | Business Party name suffix designation if individual Ex: Sr, Jr, III, etc. | Optional | |
| FormattedName | Full Name of business party. Format for name should be "First Last" with no commas between first and last name | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | JobCompleted |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| RepairOrderNumber | Identification number of repair order assigned by dealer or DMS | Optional | |
| Description | Description of work completed on vehicle | Optional | |
| TotalAmount | Total amount for operation | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | JobToDo |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Description | Description of work to be completed on vehicle | Optional | |
| TotalAmount | Total amount for operation | Optional |
| 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: | xsd:integer < Count (by extension) < Mileage (by extension) |
|---|---|
| Sub-types: | None |
| Name | Mileage |
|---|---|
| Abstract | no |
| Documentation | Mileage definition More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| uom | Optional |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | NewFinancing |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| FinanceType | Type of financing Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc.. | Optional | |
| PaymentAmount | Monthly Payment Amount | Optional | |
| BalanceAmount | Remaining balance on Current Vehicle | Optional | |
| FinalAmount | Last month payment amount | Optional | |
| ResidualAmount | Remaining residual on current vehicle | Optional | |
| Term | Number of months of contract term | Optional | |
| MaturityDate | Month and year of contract maturity | Optional | |
| FinanceCompanyName | Name of Finance Company | Optional | |
| DownPaymentAmount | Down Payment amount or amount of cap cost reduction. | Optional | |
| PurchasePrice | Purchase Price or Gross Cap cost specified in deal. Total payments at end of purchase | Optional | |
| ApprovedInd | Approved Indicator | Optional | |
| ApprovedAmount | Amount pre-approved | Optional | |
| ExpirationDate | Date pre-approval expires | Optional | |
| RatingIndex | Rating Index Used for Credit Approval | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < NonTaxableAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | NonTaxableAmount |
|---|---|
| Abstract | no |
| Documentation | Total non-taxable price. More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | OptionBase |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| OptionType | An option type for a vehicle or other component. Usually references an OEM supplied list of codes. | Optional | |
| OptionName | Name of vehicle option | Optional | |
| OptionStockNumber | Stock Number of Vehicle Option | Optional | |
| Manufacturer | Manufacturer of Vehicle Option | Optional |
| Super-types: | xsd:string < CodeType (by extension) < OptionType (by extension) |
|---|---|
| Sub-types: | None |
| Name | OptionType |
|---|---|
| Abstract | no |
| Documentation | Option Type from an OEM or other sources list of codes. 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: | xsd:string < Id (by extension) < OrganizationId (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationId |
|---|---|
| Abstract | no |
| Documentation | Member Identification number of affiliate organization More information at: http://www.starstandard.org. |
| Super-types: | PartyBase < OrganizationPartyMinimal (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationPartyMinimal |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| Name | Company name of organizational party | Optional |
| 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) < PaymentAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | PaymentAmount |
|---|---|
| Abstract | no |
| Documentation | Monthly Payment Amount More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) |
|---|---|
| Sub-types: | None |
| Name | Percent |
|---|---|
| Abstract | no |
| Documentation | Percent More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < PurchasePrice (by extension) |
|---|---|
| Sub-types: | None |
| Name | PurchasePrice |
|---|---|
| Abstract | no |
| Documentation | Purchase Price or Gross Cap cost specified in deal. Total payments at end of purchase More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Rating (by extension) |
|---|---|
| Sub-types: | None |
| Name | Rating |
|---|---|
| Abstract | no |
| Documentation | Standing or position on a scale, e.g. credit score. More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| score | Optional |
| Super-types: | xsd:string < Rating (by extension) < RatingIndex (by extension) |
|---|---|
| Sub-types: | None |
| Name | RatingIndex |
|---|---|
| Abstract | no |
| Documentation | Rating Index Used for Credit Approval More information at: http://www.starstandard.org. |
| Super-types: | NewFinancing < RemarketingFinancing (by extension) |
|---|---|
| Sub-types: | None |
| Name | RemarketingFinancing |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| FinanceType | Type of financing Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc.. | Optional | |
| PaymentAmount | Monthly Payment Amount | Optional | |
| BalanceAmount | Remaining balance on Current Vehicle | Optional | |
| FinalAmount | Last month payment amount | Optional | |
| ResidualAmount | Remaining residual on current vehicle | Optional | |
| Term | Number of months of contract term | Optional | |
| MaturityDate | Month and year of contract maturity | Optional | |
| FinanceCompanyName | Name of Finance Company | Optional | |
| DownPaymentAmount | Down Payment amount or amount of cap cost reduction. | Optional | |
| PurchasePrice | Purchase Price or Gross Cap cost specified in deal. Total payments at end of purchase | Optional | |
| ApprovedInd | Approved Indicator | Optional | |
| ApprovedAmount | Amount pre-approved | Optional | |
| ExpirationDate | Date pre-approval expires | Optional | |
| RatingIndex | Rating Index Used for Credit Approval | Optional | |
| MiscellaneousNotes | Free form miscellaneous comments. | Optional | |
| AnnualPercentageRate | Annual percentage rate. | Optional | |
| FleetAccount | Lessor Fleet Account number indicating that this is a Fleet Transaction | Optional | |
| PromotionalRateInd | Promotional lease rate was used | Optional | |
| Tax | Tax related to Financing | Optional | |
| AnnualMilesAllowed | Lease mileage limit per year | Optional | |
| ExcessMileageRate | The rate charged per mile over the annual miles allowed | Optional | |
| FinanceCharge | The total interest paid on the contract | Optional |
| Super-types: | OptionBase < RemarketingOption (by extension) |
|---|---|
| Sub-types: | None |
| Name | RemarketingOption |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| OptionType | An option type for a vehicle or other component. Usually references an OEM supplied list of codes. | Optional | |
| OptionName | Name of vehicle option | Optional | |
| OptionStockNumber | Stock Number of Vehicle Option | Optional | |
| Manufacturer | Manufacturer of Vehicle Option | Optional | |
| OptionOrigin | Identifies the option installer | Optional | |
| OptionSerialNumber | Serial number of Option | Optional | |
| OptionNotes | Free form text related to option | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | RemarketingWarranty |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| WarrantyTypeCode | Type of warranty (Ex: OEM new, OEM used or third party) | Optional | |
| WarrantyTypeDescription | Description of type of warranty Example: Basic /Powertrain, etc | Optional | |
| WarrantyStartMileage | Mileage at start date of vehicle warranty | Optional | |
| WarrantyEndMileage | Mileage limit for vehicle warranty coverage for warranty currently in force at time of repair | Optional | |
| WarrantyStartDate | Start date of vehicle warranty | Optional | |
| WarrantyExpirationDate | Last date of vehicle warranty coverage for warranty currently in force at time of repair | Optional | |
| RoadsideAssistanceInd | Indicates whether coverage includes roadside assistance | Optional | |
| WarrantyTransferInd | Flag indicating if warranty is transferable | Optional | |
| WarrantyNotes | Any Warranty related Notes | Optional | |
| WarrantyClass | A classification of warranty specifications that the warranty must address such as 'tires, power train, rust 'or 'power train only' and can be based on the age or mileage | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | RepairDamage |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Description | Description of damage on vehicle | Optional | |
| TotalAmount | Total amount to repair damage | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < ResidualAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | ResidualAmount |
|---|---|
| Abstract | no |
| Documentation | Remaining residual on current vehicle More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < RestrictionDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | RestrictionDescription |
|---|---|
| Abstract | no |
| Documentation | Description of vehicle use restrictions More information at: http://www.starstandard.org. |
| 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: | 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 |
Must use a valid code from the ShortMfg/RSP list on
http://www.starstandards.org
|
| SenderURI | Physical address of the sender | Optional | |
| DealerNumber | Dealer Code of source of information | Optional |
Dealer Number is Required if originating from DMS.
|
| StoreNumber | Dealer code store number (DMS assigned) | Optional | |
| AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
| DealerCountry | Source Dealer country location | Optional |
Reference Country enumerator.
|
| Language | This code is used to define the language of the data used in this transaction | Optional |
Reference Language enumerator.
|
| 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 |
1 - Receive Pending Mail. 0 - Do not receive pending
mail.
|
| 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: | 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 | Tax |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| TaxType | Identifies the type tax. | Required | |
| TaxDescription | Free form text description of tax amount. | Optional | |
| TaxAmount | Actual amount of tax paid. | Optional | |
| UnitSalesTaxAmount | Unit amount of sales tax. | Optional | |
| TaxRate | Tax Percentage Rate | Optional | |
| TotalTaxableAmount | Total taxble price | Optional | |
| NonTaxableAmount | Total non-taxble price | Optional | |
| TaxTypeId | Tax type identification | Optional | |
| TaxabilityInd | Determines whether the dealer wants to claim tax on the cost. | Optional |
| Super-types: | xsd:decimal < Amount (by extension) < TaxAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TaxAmount |
|---|---|
| Abstract | no |
| Documentation | Actual amount of tax paid. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < TaxDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | TaxDescription |
|---|---|
| Abstract | no |
| Documentation | Free form text description of tax amount. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Percent (by extension) < TaxRate (by extension) |
|---|---|
| Sub-types: | None |
| Name | TaxRate |
|---|---|
| Abstract | no |
| Documentation | Tax Percentage rate. More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) < Term (by extension) |
|---|---|
| Sub-types: | None |
| Name | Term |
|---|---|
| Abstract | no |
| Documentation | Number of months of contract term More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| length | Required |
| Super-types: | xsd:decimal < Amount (by extension) < TotalAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalAmount |
|---|---|
| Abstract | no |
| Documentation | Total price (cost + markup) More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < TotalTaxableAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | TotalTaxableAmount |
|---|---|
| Abstract | no |
| Documentation | Total taxable price. More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < UnitSalesTaxAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | UnitSalesTaxAmount |
|---|---|
| Abstract | no |
| Documentation | Unit amount of sales tax. More information at: http://www.starstandard.org. |
| 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: | Vehicle < VehicleBase (by extension) |
|---|---|
| Sub-types: |
|
| Name | VehicleBase |
|---|---|
| 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 | |
| SaleClass | Class of Sale | Optional | |
| Condition | Condition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown | Optional | |
| CertifiedPreownedInd | Identifies as a certified Pre-Owned Vehicle | Optional | |
| VehicleNote | Any vehicle related notes | Optional | |
| VIN | Federally defined 17 position vehicle identification number | Optional | |
| DeliveryMileage | Odometer reading of vehicle at time of delivery | Optional | |
| VehicleStock | Dealer assigned vehicle stock number | Optional | |
| TrimCode | Manufacturer assigned trim code | Optional | |
| DoorsQuantity | Number of doors on vehicle | Optional | |
| BodyStyle | Manufacturer-assigned vehicle body style | Optional | |
| InteriorColor | Vehicle Interior Color(s) | Optional | |
| ExteriorColor | Vehicle Exterior Color(s) | Optional | |
| TransmissionType | Vehicle Transmission type | Optional | |
| OdometerStatus | Status of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. | Optional | |
| NonUSVehicleInd | Indicates whether the vehicle was produced for the United States or not | Optional | |
| VehicleDemoInd | Indicates whether vehicle was ever a demo | Optional | |
| LicenseNumber | State License plate number of vehicle | Optional | |
| BrandedInfo | Vehicle Branding Information | Optional | |
| RestrictionInd | Indication that vehicle has restrictions on its use | Optional | |
| RestrictionDescription | Description of vehicle use restrictions | Optional | |
| TelematicsServiceInd | Indication whether Telematics Service Subscription is turned on | Optional |
| Super-types: | xsd:integer < Count (by extension) < VehiclePassengers (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehiclePassengers |
|---|---|
| Abstract | no |
| Documentation | Passenger/seat capacity count of vehicle More information at: http://www.starstandard.org. |
| 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 | VehicleRemarketing |
|---|---|
| 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 03/03/2005; effective date 07/04/2005 More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Header | Required | ||
| Vehicle | Optional |
| Super-types: | HeaderBase < VehicleRemarketingHeader (by extension) |
|---|---|
| Sub-types: | None |
| Name | VehicleRemarketingHeader |
|---|---|
| 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 |
DateTime fields must be formatted as XML Schema
DateTimes in UTC/GMT format without offsets.
Example: 2003-11-05T13:15:30Z
|
| SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
| SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional | |
| DocumentId | Sender (Source) Identification of this vehicle | Required | |
| OrganizationId | Member identification number affiliate organization (i.e., association number) | Optional | |
| ContractStartDate | The date the advertising contract starts | Optional | |
| ContractExpirationDate | The date the advertising contract ends | Optional | |
| ContractId | Unique identifier for the particular advertising activity | Optional |
| Super-types: | Vehicle < VehicleBase (by extension) < VehicleRemarketingVehicle (by extension) |
|---|---|
| Sub-types: | None |
| Name | VehicleRemarketingVehicle |
|---|---|
| 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 | |
| SaleClass | Class of Sale | Optional | |
| Condition | Condition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown | Optional | |
| CertifiedPreownedInd | Identifies as a certified Pre-Owned Vehicle | Optional | |
| VehicleNote | Any vehicle related notes | Optional | |
| VIN | Federally defined 17 position vehicle identification number | Optional | |
| DeliveryMileage | Odometer reading of vehicle at time of delivery | Optional | |
| VehicleStock | Dealer assigned vehicle stock number | Optional | |
| TrimCode | Manufacturer assigned trim code | Optional | |
| DoorsQuantity | Number of doors on vehicle | Optional | |
| BodyStyle | Manufacturer-assigned vehicle body style | Optional | |
| InteriorColor | Vehicle Interior Color(s) | Optional | |
| ExteriorColor | Vehicle Exterior Color(s) | Optional | |
| TransmissionType | Vehicle Transmission type | Optional | |
| OdometerStatus | Status of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. | Optional | |
| NonUSVehicleInd | Indicates whether the vehicle was produced for the United States or not | Optional | |
| VehicleDemoInd | Indicates whether vehicle was ever a demo | Optional | |
| LicenseNumber | State License plate number of vehicle | Optional | |
| BrandedInfo | Vehicle Branding Information | Optional | |
| RestrictionInd | Indication that vehicle has restrictions on its use | Optional | |
| RestrictionDescription | Description of vehicle use restrictions | Optional | |
| TelematicsServiceInd | Indication whether Telematics Service Subscription is turned on | Optional | |
| Option | Vehicle Remarketing Vehicle Options | Optional | |
| TransmissionCode | Transmission Serial Number | Optional | |
| DeliveryDate | The date of original retail vehicle sale | Optional | |
| EngineNumber | Serial number of the engine if vehicle not made for US sale | Optional | |
| IgnitionKeyNumber | Vehicle Ignition Key Number | Optional | |
| DoorKeyNumber | Door key number | Optional | |
| ExteriorColorCode | Vehicle exterior color code | Optional | |
| InteriorColorCode | Vehicle Interior color code | Optional | |
| VehicleLocation | Indicates the physical location of the vehicle | Optional | |
| VehicleAcquisitionDate | Actual date vehicle was acquired by Dealership | Optional | |
| VehiclePricing | Vehicle Pricing | Optional | |
| Tax | Vehicle Tax | Optional | |
| Dealer | Vehicle Dealer | Optional | |
| JobToDo | Repairs to be done on vehicle | Optional | |
| JobCompleted | Repairs completed on vehicle | Optional | |
| Damage | Damage to the vehicle that needs repaired | Optional | |
| TransmissionTypeName | Name of transmission type (i.e., Hydromatic, Shiftronic, Manual, Automatic, etc.) | Optional | |
| VehicleClass | VehicleClass | Optional | |
| FuelType | Type of vehicle fuel | Optional | |
| EngineDescription | Text description of engine (e.g. dohc, 32 valves) | Optional | |
| EngineConfiguration | Type of engine configuration | Optional | |
| EngineInduction | Engine induction | Optional | |
| EngineDisplacement | Displacement of engine (i.e., amount of volume in the cylinders) | Optional | |
| EngineCylinders | Engine cylinder count | Optional | |
| EngineHorsepower | Engine horsepower rating | 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 | |
| Warranty | Vehicle warranty | Optional | |
| Financing | Vehicle financing | Optional | |
| PreviousIndividualOwner | Previous Individual owner of vehicle | Optional | |
| PreviousOrganizationalOwner | Previous organization owner of vehicle | Optional | |
| ImageAttachment | Contains vehicle photo and image information | Optional | |
| VehiclePassengers | Passenger/seat capacity count of vehicle | Optional | |
| VehicleInspections | Description of inspections done to the vehicle | Optional | |
| TireCondition | Condition of tires | Optional | |
| VehicleReceivedDate | Date vehicle was received at the dealer | Optional | |
| LastModificationDate | Date vehicle was last modified in the sender's inventory | Optional | |
| PreviousVehicleUse | Previous vehicle use, eg. ambulance, rental, etc | Optional | |
| SoldDate | Date vehicle was sold (useful when dealer wishes to show the car as "SOLD" on his website ) | Optional | |
| CertificationIssuer | Name of issuer of vehicle certification, eg. honda, gm, government, etc | Optional | |
| CertificationValue | Vehicle certification name, eg. gold, optimum | Optional | |
| Advertising | Media advertising information | Optional | |
| FinancingAvailableInd | Indicates is someone is offering financing on this vehicle | Optional |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | Verb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < WarrantyEndMileage (by extension) |
|---|---|
| Sub-types: | None |
| Name | WarrantyEndMileage |
|---|---|
| Abstract | no |
| Documentation | Mileage limit for vehicle warranty coverage for warranty currently in force at time of repair More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) < Mileage (by extension) < WarrantyStartMileage (by extension) |
|---|---|
| Sub-types: | None |
| Name | WarrantyStartMileage |
|---|---|
| Abstract | no |
| Documentation | Mileage at start Date of vehicle warranty More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Description (by extension) < WarrantyTypeDescription (by extension) |
|---|---|
| Sub-types: | None |
| Name | WarrantyTypeDescription |
|---|---|
| Abstract | no |
| Documentation | A code used to classify into coverage categories More information at: http://www.starstandard.org. |
| Super-types: | xsd:gYearMonth < AccountingDate (by restriction) |
|---|---|
| Sub-types: |
|
| Name | AccountingDate |
|---|---|
| Documentation | Month and year accounting date conforms to ISO 8601 format rules Ex: \d\d\d\d-\d\d More information at: http://www.starstandard.org. |
| 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) < AdvertisingCopy (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AdvertisingCopy |
|---|---|
| Documentation | Information that goes in the ad. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) < AdvertisingMedia (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AdvertisingMedia |
|---|---|
| Documentation | Media where ad is placed. Ex: Internet, newspaper, etc More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < ApprovedInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ApprovedInd |
|---|---|
| Documentation | Approved Indicator More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| 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:date < Date (by restriction) < BrandedTitleDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BrandedTitleDate |
|---|---|
| Documentation | Branding Date More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < BrandedTitleInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BrandedTitleInd |
|---|---|
| Documentation | This tag indicates if a vehicle's title has been branded. (i.e., vehicle totaled and state registration title branded as such) More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Note (by restriction) < BrandingSource (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BrandingSource |
|---|---|
| Documentation | Branding source (i.e., source who says that the vehicle is branded) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < BrandingStateReference (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BrandingStateReference |
|---|---|
| Documentation | Branding State Reference Number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < CertificationIssuer (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CertificationIssuer |
|---|---|
| Documentation | Name of issuer of certification More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < CertificationValue (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CertificationValue |
|---|---|
| Documentation | certification value (i.e., gold) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < CertifiedPreownedInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CertifiedPreownedInd |
|---|---|
| Documentation | Identifies as a certified Pre-Owned Vehicle More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| 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 < Name (by restriction) < CompanyName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CompanyName |
|---|---|
| Documentation | Company name of customer More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < Condition (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Condition |
|---|---|
| Documentation | Condition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown 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:date < Date (by restriction) < ContractExpirationDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ContractExpirationDate |
|---|---|
| Documentation | Date the contract expires More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < ContractStartDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ContractStartDate |
|---|---|
| Documentation | Contract sale Date More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < CopyType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | CopyType |
|---|---|
| Documentation | Type of copy used for ad. Ex: Teaser text, short description, long description 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:string < Data (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Data |
|---|---|
| Documentation | Container to carry embedded data More information at: http://www.starstandard.org. |
| 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 < Name (by restriction) < DealerName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DealerName |
|---|---|
| Documentation | Dealer name More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Decimal (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Decimal |
|---|---|
| Documentation | Decimal More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < DeliveryDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DeliveryDate |
|---|---|
| Documentation | The date of original retail vehicle sale More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < DistrictCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DistrictCode |
|---|---|
| Documentation | Manufacturer Assigned District Code 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 < SerialNumber (by restriction) < DoorKeyNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DoorKeyNumber |
|---|---|
| Documentation | Door Key Number 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 < EncodingBase (by restriction) |
|---|---|
| Sub-types: | None |
| Name | EncodingBase |
|---|---|
| Documentation | Encoding values for embedded documents More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| base64 | Base 64 |
| octal | Octal |
| binary | Binary |
| plainText | Plain Text |
| other | |
| N/A | Not Applicable |
| Super-types: | xsd:string < EngineConfiguration (by restriction) |
|---|---|
| Sub-types: | None |
| Name | EngineConfiguration |
|---|---|
| Documentation | Type of engine configuration More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| horizontal | Horizontal engine configuration |
| in-line | In-line engine configuration |
| rotary | Rotary engine configuration |
| V-type | V-type engine configuration |
| W-type | W-type engine configuration |
| other | |
| N/A | Not Applicable |
| Super-types: | xsd:string < EngineDisplacement (by restriction) |
|---|---|
| Sub-types: | None |
| Name | EngineDisplacement |
|---|---|
| Documentation | Displacement of engine (i.e., amount of volume in the cylinders) More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| ci | ci - Cubic Inches |
| cc | cc - Cubic Centimeters |
| liters | liters |
| other | |
| N/A | Not Applicable |
| Super-types: | xsd:string < Note (by restriction) < EngineHorsepower (by restriction) |
|---|---|
| Sub-types: | None |
| Name | EngineHorsepower |
|---|---|
| Documentation | Engine horsepower rating More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < EngineInduction (by restriction) |
|---|---|
| Sub-types: | None |
| Name | EngineInduction |
|---|---|
| Documentation | Engine induction More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| turbo | Turbo engine induction |
| supercharger | Supercharger engine induction |
| twin-turbo | Twin-turbo engine induction |
| normally aspirated | Normally aspirated engine induction |
| other | |
| N/A | Not Applicable |
| Super-types: | xsd:string < SerialNumber (by restriction) < EngineNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | EngineNumber |
|---|---|
| Documentation | Serial number of the engine if vehicle not made for US sale More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < ExpirationDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ExpirationDate |
|---|---|
| Documentation | Expiration Date 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 < Name (by restriction) < FamilyName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FamilyName |
|---|---|
| Documentation | Last Name of business party More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < FinanceCompanyName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FinanceCompanyName |
|---|---|
| Documentation | Name of Finance Company More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < FinanceType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FinanceType |
|---|---|
| Documentation | Type of financing Examples may be F- Finance, L - Lease, C-Cash, 1-Retail, 2-Lease, 3-Balloon, etc. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < FinancingAvailableInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FinancingAvailableInd |
|---|---|
| Documentation | Indicates is someone is offering financing More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| 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 < Name (by restriction) < FormattedName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FormattedName |
|---|---|
| Documentation | Full Name of business party. Format for name should be "First Last" with no commas between first and last name More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < FuelType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | FuelType |
|---|---|
| Documentation | Type of vehicle fuel More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| diesel | Diesel Fuel |
| premium unleaded | Premium Unleaded Fuel |
| unleaded | Unleaded Fuel |
| natural gas | Natural Gas |
| electric | Electric |
| ethanol | Ethanol is an alternative automotive fuel derived from grain and corn; usually blended with gasoline to form gasohol. |
| propane | Propane |
| hybrid | Hybrid is a vehicle that uses two or more distinct power sources to propel the vehicle |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:string < Name (by restriction) < GivenName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | GivenName |
|---|---|
| Documentation | First Name of business party More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < SerialNumber (by restriction) < IgnitionKeyNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | IgnitionKeyNumber |
|---|---|
| Documentation | Vehicle Ignition Key Number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < ImageAlternateText (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ImageAlternateText |
|---|---|
| Documentation | Image alternate text. Example: "1997 Honda Accord" More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < ImageAttachmentTitle (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ImageAttachmentTitle |
|---|---|
| Documentation | Image attachment title More information at: http://www.starstandard.org. |
| 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 < 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: | None |
| 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:date < Date (by restriction) < LastModificationDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LastModificationDate |
|---|---|
| Documentation | Last date modification was made More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < LicenseNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LicenseNumber |
|---|---|
| Documentation | State License plate number of vehicle More information at: http://www.starstandard.org. |
| 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:gYearMonth < AccountingDate (by restriction) < MaturityDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | MaturityDate |
|---|---|
| Documentation | Month and year of contract maturity More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < MiddleName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | MiddleName |
|---|---|
| Documentation | Middle Initial of business party More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < MileageMeasure (by restriction) |
|---|---|
| Sub-types: | None |
| Name | MileageMeasure |
|---|---|
| Documentation | M = Miles, K = KIlometers More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| M | "M" = Modified |
| K | Kilometers |
| Super-types: | xsd:string < Note (by restriction) < MiscellaneousNotes (by restriction) |
|---|---|
| Sub-types: | None |
| Name | MiscellaneousNotes |
|---|---|
| Documentation | Free form miscellaneous comments More information at: http://www.starstandard.org. |
| 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: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 < Indicator (by restriction) < NonUSVehicleInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | NonUSVehicleInd |
|---|---|
| Documentation | Indicates whether the vehicle was produced for the United States or not More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| 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 < Note (by restriction) < OdometerStatus (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OdometerStatus |
|---|---|
| Documentation | Status of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. 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:string < Note (by restriction) < OptionNotes (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OptionNotes |
|---|---|
| Documentation | Free form text related to option More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < OptionOrigin (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OptionOrigin |
|---|---|
| Documentation | Identifies the option installer More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < SerialNumber (by restriction) < OptionSerialNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OptionSerialNumber |
|---|---|
| Documentation | Serial number of Option 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 < 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 < Note (by restriction) < PreviousVehicleUse (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PreviousVehicleUse |
|---|---|
| Documentation | Previous vehicle use, eg: ambulance, rental, etc. More information at: http://www.starstandard.org. |
| 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 < Indicator (by restriction) < PromotionalRateInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PromotionalRateInd |
|---|---|
| Documentation | Promotional rate was used More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| 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 < ReferenceNumber (by restriction) < RepairOrderNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RepairOrderNumber |
|---|---|
| Documentation | Identification number of repair order assignedby dealer or DMS. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < RestrictionInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RestrictionInd |
|---|---|
| Documentation | Indication that vehicle has restrictions on its use More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Indicator (by restriction) < RoadsideAssistanceInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RoadsideAssistanceInd |
|---|---|
| Documentation | Indicates whether coverage includes roadside assistance More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < SaleClass (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SaleClass |
|---|---|
| Documentation | Class of sale. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| New | Never owned. |
| Used | Previously Owned |
| Demo | Demonstration item. |
| Other | Other |
| N/A | Not Applicable |
| Floor Sample | This is a vehicle that is provided in the showroom as an example. |
| Factory | Identifies that the vehicle may have been used as a product demonstration for an official or executive from the manufacturer. |
| Super-types: | xsd:string < Name (by restriction) < Salutation (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Salutation |
|---|---|
| Documentation | Title or greeting of business party 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 < SerialNumber (by restriction) |
|---|---|
| Sub-types: |
|
| Name | SerialNumber |
|---|---|
| Documentation | Serial Number 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:date < Date (by restriction) < SoldDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SoldDate |
|---|---|
| Documentation | Sold date More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < StateOrProvince (by restriction) |
|---|---|
| Sub-types: |
|
| Name | StateOrProvince |
|---|---|
| Documentation | Is the State or Province of a given Address. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < Suffix (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Suffix |
|---|---|
| Documentation | Business Party name suffix designation if individual Ex: Sr, Jr, III, etc. 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 < Indicator (by restriction) < TaxabilityInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxabilityInd |
|---|---|
| Documentation | Determines whether an item or amount is taxable. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < TaxType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxType |
|---|---|
| Documentation | Tax Type More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Total | |
| Amount | |
| Labor | |
| Parts | |
| Claim | |
| Dealer | Dealer |
| Deductible | |
| Prorated | |
| Other | Other |
| Luxury | |
| Vehicle Inventory | |
| Taxes Not In Cash Price | |
| Document Stamp | |
| Sales | |
| Tire | |
| Personal Property | |
| Registration | |
| Monthly/Use | |
| Weight | |
| Adjustment | |
| DownPayment | |
| CapCostReduction | |
| Lieu | |
| CurrentYear | |
| N/A | Not Applicable |
| LocalOption | Tennessee Tax - combination of city and county. |
| SingleArticle | Tennessee Tax - State Tax |
| Gas | Gas tax levied to applicable vehicles or by state/province law. (Referred to in US as "Gas Guzzler" tax). |
| Total Monthly/Use | The total amount of monthly use tax for a payment on a contract. |
| Service Contract | Tax charged on service contracts (where applicable). |
| Adjusted Sales | Adjusted sales tax due to tax modifications when capitalized (i.e. NY) |
| Total Sales/Use | The total amount of sales/use tax for a single payment contract. |
| Air Conditioning Excise | Provincal tax providing for the installation or removal of freon. (Canada) |
| Purchase and Use | A type of tax that is assessed upon "tax free" tangible personal property purchased by a resident of the assessing state for use, storage or consumption of goods in that state (not for resale), regardless of where the purchase took place. The tax is a one time retail tax due at registration or titling of a vehicle. |
| County Tax | A county tax charged based on the location of the dealer and the customer. An example, The Cook County Tax. |
| General Excise | This is a general excise tax that a state or region could impose. |
| Gross Receipt | A gross receipts tax, sometimes referred to as a gross excise tax, is a tax on the total gross revenues of a company, regardless of their source. |
| Tax on Trade-In | Tax due on a trade-in vehicle. |
| Tax on Upfront Fees | Total tax due on fees paid upfront. |
| Tax on Acquisition Fee | Tax due on amount of acquisition fee. |
| Environmental Tax | Environmental Levy / Tax. |
| Motor Vehicle Tax | Tax paid at of registration based on the vehicle's age and MSRP. |
| Wheel Tax | A tax levied by cities and villages to be credited to a road fund of the city or village |
| Super-types: | xsd:string < TaxTypeId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TaxTypeId |
|---|---|
| Documentation | CS - City, CP - County, ST - State, OT - Other, EX - Excise, VAT - Value Added Tax, PST - Provincial Sales Tax , RT - Rental, GST - Goods and Services Tax, HST - Harmonized Tax, ART - Air Tax, QST - Quebec Sales Tax, IMP - Import Tax More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| CS | City |
| CP | County |
| ST | State |
| OT | "OT" = Other |
| EX | Excise |
| VAT | Value Added |
| PST | Provincial Sales Tax |
| RT | Rental |
| GST | Goods and Services Tax |
| HST | Harmonized Tax |
| ART | Air Tax |
| QST | Quebec Sales Tax |
| IMP | Import Tax |
| Super-types: | xsd:string < Indicator (by restriction) < TelematicsServiceInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TelematicsServiceInd |
|---|---|
| Documentation | Indication whether Telematics Service Subscription is turned on More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < TermLength (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TermLength |
|---|---|
| Documentation | Term Length More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Months | Months |
| Weeks | Weeks |
| Years | Years |
| 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 < Note (by restriction) < TireCondition (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TireCondition |
|---|---|
| Documentation | Condition of tires 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 < Note (by restriction) < TransmissionTypeName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TransmissionTypeName |
|---|---|
| Documentation | Name of transmission type (i.e., Hydromatic, Shiftronic, Manual, Automatic, etc.) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < TrimCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TrimCode |
|---|---|
| Documentation | Manufacturer assigned trim code More information at: http://www.starstandard.org. |
| 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:date < Date (by restriction) < VehicleAcquisitionDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleAcquisitionDate |
|---|---|
| Documentation | Actual Date vehicle was acquired by Dealership More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < VehicleClass (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleClass |
|---|---|
| Documentation | Class of vehicle More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| passenger | Passenger |
| minivan | Minivan |
| pickup | Pickup |
| fullsizevan | Full size van |
| sportutil | Sport utility vehicle |
| motorcycle | Motorcycle |
| rv | RV |
| atv | ATV |
| boats | Boats |
| snowmobile | Snowmobile |
| heavy truck | Heavy truck |
| medium duty | Medium duty |
| truck | Truck |
| sedans | Sedans |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:string < Indicator (by restriction) < VehicleDemoInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleDemoInd |
|---|---|
| Documentation | Indicates whether vehicle was ever a demo More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Note (by restriction) < VehicleInspections (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleInspections |
|---|---|
| Documentation | Description of inspections done to the vehicle More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < VehicleLocation (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleLocation |
|---|---|
| Documentation | Indicates the physical location of the vehicle More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < VehicleNote (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleNote |
|---|---|
| Documentation | Any vehicle related notes 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:date < Date (by restriction) < VehicleReceivedDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleReceivedDate |
|---|---|
| Documentation | Date vehicle was received at the dealer More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < VehicleStock (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleStock |
|---|---|
| Documentation | Dealer assigned vehicle stock number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < VIN (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VIN |
|---|---|
| Documentation | Federally defined 17 position vehicle identification number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < WarrantyClass (by restriction) |
|---|---|
| Sub-types: | None |
| Name | WarrantyClass |
|---|---|
| Documentation | A classification of warranty specifications that the warranty must address such as 'tires, power train, rust 'or 'power train only' and can be based on the age or mileage More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < WarrantyExpirationDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | WarrantyExpirationDate |
|---|---|
| Documentation | Last Date of vehicle warranty coverage for warranty currently in force at time of repair More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < WarrantyNotes (by restriction) |
|---|---|
| Sub-types: | None |
| Name | WarrantyNotes |
|---|---|
| Documentation | Any Warranty related Notes More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < WarrantyStartDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | WarrantyStartDate |
|---|---|
| Documentation | Start Date of vehicle warranty More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < WarrantyTransferInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | WarrantyTransferInd |
|---|---|
| Documentation | Indicates if warranty is transferable More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Code (by restriction) < WarrantyTypeCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | WarrantyTypeCode |
|---|---|
| Documentation | A code used to classify into coverage categories. More information at: http://www.starstandard.org. |
| Super-types: | xsd:gYear < Year (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Year |
|---|---|
| Documentation | Year More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < ZoneCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ZoneCode |
|---|---|
| Documentation | Manufacturer Assigned Zone Code 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: