Implementation Guideline
Get Vehicle Order
Repository Version Rev4.5.4
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Implementation Guideline
Get Vehicle Order
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 Get Vehicle Order Business Object Document (BOD). Get Vehicle Order has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Get Vehicle Order 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 Get Vehicle Order, this BOD could be used to send Get Vehicle Order information between any two business parties.
The Get Vehicle Order Implementation Guidelines provide detailed information regarding the structure and meaning of the Get Vehicle Order BOD and corresponds directly to the Get Vehicle Order 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 Get Vehicle Order Implementation Guidelines must be used in concert with the Get Vehicle Order 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 Get Vehicle Order 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 Get Vehicle Order BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Get Vehicle Order 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 Get Vehicle Order 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 Get Vehicle Order 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 | Get |
|---|---|
| Type | Get |
| Nillable | no |
| Abstract | no |
| Documentation | The Get verb is to communicate to a business software component a request for an existing piece of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across most of the nouns it may be paired with.The Get is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The Get verb is not used to request several documents at once. The GetList verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned. More information at: http://www.openapplications.org/oagis. |
| Name | GetVehicleOrder |
|---|---|
| Type | GetVehicleOrder |
| Nillable | no |
| Abstract | no |
| Name | Header |
|---|---|
| Type | VehicleOrderHeader |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | Vehicle |
|---|---|
| Type | VehicleOrderVehicle |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
| Name | VehicleOrder |
|---|---|
| Type | VehicleOrder |
| Nillable | no |
| Abstract | no |
| Documentation | More information at: http://www.starstandards.org. |
|
| Name | Verb |
|---|---|
| Type | Verb |
| Nillable | no |
| Abstract | yes |
| Super-types: | AddressBase < Address (by extension) |
|---|---|
| Sub-types: |
|
| Name | Address |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| qualifier | Required |
| 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: |
|
| 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: |
|
| Name | AlternatePartyId |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Id | Alternate Party Identification | Required |
| Super-types: | xsd:decimal < Amount (by extension) |
|---|---|
| Sub-types: | None |
| Name | Amount |
|---|---|
| Abstract | no |
| Documentation | Based on OAGI Amount. Simple content with the currency as an attrbute More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| currency | Required |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | ApplicationArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Sender | Identifies characteristics and control identifiers that relate to the application that created the Business Object Document. The sender area can indicate the logical location of the application and/or database server, the application, and the task that was processing to create the BOD. | Required | |
| CreationDateTime | is the date time stamp that the given instance of the Business Object Document was created. This date must not be modified during the life of the Business Object Document. | Required |
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 | |
| BODId | The BODId provides a place to carry a Globally Unique Identifier (GUID) that will make each Business Object Document instance uniquely identifiable. This is a critical success factor to enable software developers to use the Globally Unique Identifier (GUID) to build the following services or capabilities: 1. Legally binding transactions, 2. Transaction logging, 3. Exception handling, 4. Re-sending, 5. Reporting, 6. Confirmations, 7. Security. | Optional | |
| Destination | Information related to the receiver of the BOD | Required |
| Super-types: | 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: | xsd:string < Id (by extension) < CarrierId (by extension) |
|---|---|
| Sub-types: | None |
| Name | CarrierId |
|---|---|
| Abstract | no |
| Documentation | Carrier Code More information at: http://www.starstandard.org. |
| 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: | None |
|---|---|
| Sub-types: |
|
| Name | ContactBase |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Telephone | Contact telephone numbers | Optional | |
| EMailAddress | Contact Email addresses | Optional | |
| Fax | Contact Fax numbers | Optional | |
| PreferredContactMethod | Preferred contact method | Optional | |
| ContactTime | Preferred contact time (i.e. Best day/time to reach the contact. | Optional | |
| PrimaryContactInd | Indicates if contact is primary contact | Optional |
| Super-types: | xsd:integer < Count (by extension) |
|---|---|
| Sub-types: | None |
| Name | Count |
|---|---|
| Abstract | no |
| Documentation | Simple quantity type with no attributes More information at: http://www.starstandard.org. |
| Super-types: | xsd: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 |
If this is a fleet account order, the fleet account
code would be in the DealerNumber field.
|
| 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: | None |
|---|---|
| Sub-types: | None |
| Name | ExpressionCriteria |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| expressionLanguage | Optional |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| SelectExpression | Allows the 1-n number of selection expressions for the information to be returned. | Required |
| Super-types: | xsd:string < Id (by extension) < FleetVehicleId (by extension) |
|---|---|
| Sub-types: | None |
| Name | FleetVehicleId |
|---|---|
| Abstract | no |
| Documentation | Uniquely identifies the vehicle as part of a fleet company More information at: http://www.starstandard.org. |
| Super-types: | Verb < ConfirmableVerb (by extension) < RequestVerb (by extension) < Get (by extension) |
|---|---|
| Sub-types: | None |
| Name | Get |
|---|---|
| Abstract | no |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| show | Required |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| ReturnCriteria | ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. | Required |
| Super-types: | BusinessObjectDocument < GetVehicleOrder (by extension) |
|---|---|
| Sub-types: | None |
| Name | GetVehicleOrder |
|---|---|
| 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 | GetVehicleOrderDataArea |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Get | The Get verb is to communicate to a business software component a request for an existing piece of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across most of the nouns it may be paired with.The Get is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The Get verb is not used to request several documents at once. The GetList verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned. | Required | |
| VehicleOrder | Required |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | HeaderBase |
|---|---|
| Abstract | no |
| Documentation | Used on all STAR BODs More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional | |
| SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
| SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional |
| Super-types: | xsd:string < Id (by extension) |
|---|---|
| Sub-types: | None |
| Name | Id |
|---|---|
| Abstract | no |
| Documentation | Party Identification number More information at: http://www.starstandard.org. |
| Super-types: | PartyBase < IndividualOwnerParty2 (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualOwnerParty2 |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Individual party alternate party Identification | Optional | |
| PersonName | Individual party name | Optional | |
| Address | Individual party address | Optional | |
| Contact | Individual party contact information | Optional |
| Super-types: | AddressBase < Address (by extension) < IndividualPartyAddress (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualPartyAddress |
|---|---|
| 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: | AlternatePartyId < IndividualPartyAlternatePartyId (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualPartyAlternatePartyId |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Id | Alternate Party Identification | Required | |
| AssigningPartyId | Agency or entity that validates the Party Id | Required | |
| IssuingState | Indicates that State where the license was issued. | Optional | |
| ExpirationDate | Expiration date of the alternate party id (e.g., Driver's License expiration date). | Optional |
| Super-types: | ContactBase < IndividualPartyContact2 (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualPartyContact2 |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Telephone | Contact telephone numbers | Optional | |
| EMailAddress | Contact Email addresses | Optional | |
| Fax | Contact Fax numbers | Optional | |
| PreferredContactMethod | Preferred contact method | Optional | |
| ContactTime | Preferred contact time (i.e. Best day/time to reach the contact. | Optional | |
| PrimaryContactInd | Indicates if contact is primary contact | Optional | |
| PersonName | Contact name | Optional |
| Super-types: | xsd:string < IndividualPartyContactEMail (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualPartyContactEMail |
|---|---|
| Abstract | no |
| Documentation | Individual Party email More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| desc | Required |
| Super-types: | xsd:string < IndividualPartyContactFax (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualPartyContactFax |
|---|---|
| Abstract | no |
| Documentation | Individual Party Fax number More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| desc | Required |
| Super-types: | xsd:string < IndividualPartyContactTelephoneNumber (by extension) |
|---|---|
| Sub-types: | None |
| Name | IndividualPartyContactTelephoneNumber |
|---|---|
| Abstract | no |
| Documentation | IndividualParty telephone number More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| desc | Required | ||
| exten | Required |
| 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: | xsd:string < Id (by extension) < InitiativeId (by extension) |
|---|---|
| Sub-types: | None |
| Name | InitiativeId |
|---|---|
| Abstract | no |
| Documentation | Initiative Identification (i.e., Manufacturer incentive reimbursement program identification or dealer offerings) More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) < ItemQuantity (by extension) |
|---|---|
| Sub-types: | None |
| Name | ItemQuantity |
|---|---|
| Abstract | no |
| Documentation | Quantity of Part number. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < LocationId (by extension) |
|---|---|
| Sub-types: | None |
| Name | LocationId |
|---|---|
| Abstract | no |
| Documentation | Code identifying a physical location More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | MarketingInitiativesVO |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| InitiativeType | Type of program - Incentive or program related initiatives | Optional | |
| InitiativeId | Initiative Identification (i.e., Manufacturer incentive reimbursement program identification or dealer offerings) | Optional | |
| ReimbursementId | Reimbursement certificate or coupon identification | Optional | |
| ReimbursementComment | Reimbursement dealer comments | Optional | |
| ReimbursementAmount | Amount returned to payee | Optional | |
| ReimbursementPayee | Indicates who is paid - It can be either a code (D - Dealer or C - Customer) or the recipient name of reimbursement | Optional | |
| FleetAccount | Manufacturer Fleet number | Optional | |
| InitiativeDate | The date the initiative was processed. | Optional | |
| InitiativeChangeInd | Can the initiative be changed in this order? | Optional |
| Super-types: | xsd:decimal < Measurement (by extension) |
|---|---|
| Sub-types: | None |
| Name | Measurement |
|---|---|
| Abstract | no |
| Documentation | Decimal measurement More information at: http://www.starstandard.org. |
| Super-types: | xsd: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: | xsd:string < Description (by extension) < ModelGroup (by extension) |
|---|---|
| Sub-types: | None |
| Name | ModelGroup |
|---|---|
| Abstract | no |
| Documentation | Grouping of similar models for order management purposes More information at: http://www.starstandard.org. |
| Super-types: | xsd:integer < Count (by extension) < NumberOfOptions (by restriction) |
|---|---|
| Sub-types: | None |
| Name | NumberOfOptions |
|---|---|
| Abstract | no |
| Documentation | Numbers of options in this set More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < OptionCost (by extension) |
|---|---|
| Sub-types: | None |
| Name | OptionCost |
|---|---|
| Abstract | no |
| Documentation | Actual Dealer cost of option More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Amount (by extension) < OptionMSRP (by extension) |
|---|---|
| Sub-types: | None |
| Name | OptionMSRP |
|---|---|
| Abstract | no |
| Documentation | Option MSRP More information at: http://www.starstandard.org. |
| Super-types: | PartyBase < OrganizationPartyBase (by extension) < OrderedByParty (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrderedByParty |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| Name | Company name of organizational party | Optional | |
| Address | Organizational Party address | Optional | |
| DBAName | Doing Business As name. | Optional | |
| Contact | Contact information for the business party | Optional | (INACTIVE) |
| 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: | PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty2 (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationalOwnerParty2 |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| Name | Company name of organizational party | Optional | |
| Address | Organizational Party address | Optional | |
| DBAName | Doing Business As name. | Optional | |
| Contact | Organizational Party contact information | Optional |
| Super-types: | AlternatePartyId < OrganizationalPartyAlternatePartyId (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationalPartyAlternatePartyId |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Id | Alternate Party Identification | Required | |
| AssigningPartyId | Agency or entity that validates the Party Id | Required | |
| IssuingState | Indicates that State where the license was issued. | Optional | |
| ExpirationDate | Expiration date of the alternate party id (e.g., Driver's License expiration date). | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | OrganizationContact |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PersonName | Contact name | Optional | |
| Telephone | Contact telephone numbers | Optional | |
| EMailAddress | Contact Email address | Optional | |
| Fax | Contact Fax number | Optional | |
| PreferredContactMethod | Preferred contact method | Optional | |
| ContactTime | Preferred contact time (i.e. Best day/time to reach the contact. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | OrganizationContactPersonName |
|---|---|
| Abstract | no |
| Documentation | Derived from oa:PersonName More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| GivenName | First Name of business party | Required | |
| FamilyName | Last Name of business party | Required | |
| FormattedName | Full Name of business party. Format for name should be "First Last" with no commas between first and last name | Optional |
| Super-types: | PartyBase < OrganizationPartyBase (by extension) |
|---|---|
| Sub-types: |
|
| Name | OrganizationPartyBase |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| Name | Company name of organizational party | Optional | |
| Address | Organizational Party address | Optional | |
| DBAName | Doing Business As name. | Optional |
| Super-types: | xsd:string < OrganizationPartyEmail (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationPartyEmail |
|---|---|
| Abstract | no |
| Documentation | Organization email More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < OrganizationPartyFax (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationPartyFax |
|---|---|
| Abstract | no |
| Documentation | OrganizationFax number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < OrganizationPartyTelephone (by extension) |
|---|---|
| Sub-types: | None |
| Name | OrganizationPartyTelephone |
|---|---|
| Abstract | no |
| Documentation | OrganizationParty telephone number More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| desc | Required | ||
| exten | Required |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | PartyBase |
|---|---|
| Abstract | no |
| Documentation | Derived from oa:Party More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional |
| Super-types: | xsd:string < Id (by extension) < PartyId (by extension) |
|---|---|
| Sub-types: | None |
| Name | PartyId |
|---|---|
| Abstract | no |
| Documentation | Party Identification Number More information at: http://www.starstandard.org. |
| Super-types: | xsd:decimal < Quantity (by extension) |
|---|---|
| Sub-types: | None |
| Name | Quantity |
|---|---|
| Abstract | no |
| Documentation | A decimal value with uom More information at: http://www.starstandard.org. |
| Attribute | Description | Requirement | Business Rules |
|---|---|---|---|
| uom | Required |
| Super-types: | xsd:decimal < Amount (by extension) < ReimbursementAmount (by extension) |
|---|---|
| Sub-types: | None |
| Name | ReimbursementAmount |
|---|---|
| Abstract | no |
| Documentation | Amount returned to payee More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < ReimbursementId (by extension) |
|---|---|
| Sub-types: | None |
| Name | ReimbursementId |
|---|---|
| Abstract | no |
| Documentation | Reimbursement certificate or coupon identification More information at: http://www.starstandard.org. |
| Super-types: | Verb < ConfirmableVerb (by extension) < RequestVerb (by extension) |
|---|---|
| Sub-types: |
|
| Name | RequestVerb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Verb | Required | ||
| ReturnCriteria | ReturnCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned. ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated. The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. | Required |
| 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 |
If this is a fleet account order, the fleet account
code would be in the DealerNumber field.
|
| StoreNumber | Dealer code store number (DMS assigned) | Optional | |
| AreaNumber | Dealer code area number (DMS vendor assigned) | Optional | |
| DealerCountry | Source Dealer country location | Optional | |
| Language | This code is used to define the language of the data used in this transaction | Optional | |
| DeliverPendingMailInd | Indicates if the user requests to receive pending mail that has been stored and has yet not been delivered yet. By selecting 0, the user will only receive the response for the current transaction the user is performing. | Optional | |
| Password | Token for application specific authentication. Used to authenticate dealership/users through application specific security | Optional | |
| SystemVersion | The sender's software version number. | Optional | |
| PartyId | The Party Id field uniquely identifies the Sender of the message. This element can be used for parties within the Automotive Community as well as external parties. Party Id is not intended as a replacement for the Dealer Number. Suggested formats for OEMs or other large institutions include: DUNs Number, ShortMfgCode + DUNs, or ShortMfgCode. The suggested format for Dealers is: ShortMfgCode+Dealer Number. | Optional | |
| LocationId | The Location Id field uniquely identifies the location of the Sender of a message. This Id may be aligned with a physical address or data centers. This field provides an additional level of granularity beyond the usage of the Party Id for additional routing and deliver of data. | Optional | |
| ServiceId | The Service Id field identifies the particular service from which a message is being sent, e.g., an inventory service. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | SenderBase |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| LogicalId | Provides the logical location of the server and applications from which the Business Object Document originated. It can be used to establish a logical to physical mapping, however its use is optional. Each system or combination of systems should maintain an external central reference table containing the logical names or logical addresses of the application systems in the integration configuration. This enables the logical names to be mapped to the physical network addresses of the resources needed on the network. Note: The technical implementation of this Domain Naming Service is not dictated by this specification. This logical to physical mapping may be done at execution time by the application itself or by a middleware transport mechanism, depending on the integration architecture used. This provides for a simple but effective directory access capability while maintaining application independence from the physical location of those resources on the network | Optional | |
| Component | Provides a finer level of control than Logical Identifier and represents the business application that issued the Business Object Document. Its use is optional. For STAR's use this is the DCS Software code name | Required | |
| Task | Describes the business event that initiated the need for the Business Object Document to be created. For STAR, the task is defined in the Implementation Guidelines for each BOD. It is usually a short description of the BOD. Ex: SalesLead, CreditDecision, etc. | Required | |
| ReferenceId | Enables the sending application to indicate the instance identifier of the event or task that caused the BOD to be created. This is used to correlate a response BOD to an originating BOD | Optional | |
| AuthorizationId | Identifyies the authorization level of the user or application that is sending the Business Object Document Message. This authorization level being recognized be the receiving system indicates what can be done on the receiving system. For STAR, this is the User ID. | Optional |
| Super-types: | xsd:string < Id (by extension) < ServiceId (by extension) |
|---|---|
| Sub-types: | None |
| Name | ServiceId |
|---|---|
| Abstract | no |
| Documentation | The Service Id field identifies the particular service to or from which a message is being sent, e.g., an inventory service. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Id (by extension) < SetId (by extension) |
|---|---|
| Sub-types: | None |
| Name | SetId |
|---|---|
| Abstract | no |
| Documentation | Identification of the group of options More information at: http://www.starstandard.org. |
| Super-types: | PartyBase < OrganizationPartyBase (by extension) < ShipToPartyVO (by extension) |
|---|---|
| Sub-types: | None |
| Name | ShipToPartyVO |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| Name | Company name of organizational party | Optional | |
| Address | Organizational Party address | Optional | |
| DBAName | Doing Business As name. | Optional | |
| Contact | Contact information for the business party | Optional | (INACTIVE) |
| LocationId | Code identifying the physical location of a dealer. | Optional | (INACTIVE) |
| ShipToChangeInd | Indicates if Ship To be changed. | Optional | (INACTIVE) |
| Super-types: | xsd:string < Id (by extension) < Warehouse (by extension) < ShipWarehouse (by extension) |
|---|---|
| Sub-types: | None |
| Name | ShipWarehouse |
|---|---|
| Abstract | no |
| Documentation | Warehouse override code. Indicates which warehouse or distribution center to ship from. 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: | PartyBase < OrganizationPartyBase (by extension) < SoldToPartyExtended (by extension) |
|---|---|
| Sub-types: | None |
| Name | SoldToPartyExtended |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| PartyId | Party Identification Number | Optional | |
| AlternatePartyIds | Alternate organizational party Identification | Optional | |
| Name | Company name of organizational party | Optional | |
| Address | Organizational Party address | Optional | |
| DBAName | Doing Business As name. | Optional | |
| Contact | Contact information for the business party | Optional | (INACTIVE) |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | StatusDetail |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| StatusCode | A code identifying the reason for the status message. | Optional | |
| StatusText | Descriptive status text. | Optional | |
| ItemQuantity | Quantity of the part that has the specified status. | Optional | (INACTIVE) |
| ShipWarehouse | Line item warehouse override code. Indicates which warehouse or distribution center to ship part form. | Optional |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | Vehicle |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| Model | Manufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) | Optional | |
| ModelYear | Vehicle designated model year | Optional | |
| ModelDescription | Descriptive vehicle model name | Optional | |
| Make | Vehicle make code - Usually available in the VIN number (use NCIC code). | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | VehicleOrder |
|---|---|
| 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 | Required |
| Super-types: | HeaderBase < VehicleOrderHeader (by extension) |
|---|---|
| Sub-types: | None |
| Name | VehicleOrderHeader |
|---|---|
| Abstract | no |
| Documentation | Header information related to Vehicle Order More information at: http://www.starstandards.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| DocumentDateTime | Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | Optional | |
| SecondaryPassword | Secondary password used to validate access to the dealer information | Optional | |
| SecondaryDealerNumber | Identifies secondary dealer number if different than primary "Dealer Number" | Optional | |
| DocumentId | Manufacturer order reference number for this Order (VON) | Optional | |
| OrderDate | Date of original vehicle order | Optional | (INACTIVE) YYYY-MM-DD |
| VehicleOrderType | Vehicle order type entered or selected at dealership | Optional | (INACTIVE) |
| OrderedBy | Business party who ordered the vehicle(s) | Optional | |
| SoldTo | Business party wo was invoiced for the vehicle(s) | Optional | |
| ShipTo | Business entity that is receiving the vehicle(s) | Optional | |
| VehicleOrderQty | Total Number of Vehicles in this Order | Optional | (INACTIVE) |
| LoadNumber | Shipment carrier-assigned load number | Optional | |
| BorderCrossingInd | Border crossing Indicator | Optional | (INACTIVE) |
| PortOfEntry | Vehicle Port of Entry | Optional | (INACTIVE) |
| ReqDeliveryRangeStart | Vehicle earliest estimated time of arrival at Ship To dealer | Optional | (INACTIVE) YYYY-MM-DD |
| ReqDeliveryRangeEnd | Vehicle latest estimated time of arrival at Ship To dealer | Optional | (INACTIVE) YYYY-MM-DD |
| CarrierId | Vehicle Shipment Carrier (Name or Code) | Optional | (INACTIVE) |
| Warehouse | Warehouse or Distribution Center vehicle shipped from | Optional | (INACTIVE) |
| DealerAssignedNumber | The number given to an order by a dealer. | Optional | |
| StatusDate | The date the current status was recorded | Optional | (INACTIVE) |
| TargetBuildDate | The date the OEM expects to build the vehicle | Optional | (INACTIVE) |
| PromisedDeliveryDate | Indicates when the order is promised for delivery | Optional | (INACTIVE) |
| PromisedShipDate | Indicates when the order is promised for shipment | Optional | (INACTIVE) |
| SpecialInstructions | Free form text identifying unique handling of order | Optional | (INACTIVE) |
| OrderComments | Free form text of remarks regarding the order | Optional | (INACTIVE) |
| Priority | Shipment priority. | Optional | (INACTIVE) |
| Status | Status of entire order | Optional |
| Super-types: | xsd:integer < Count (by extension) < VehicleOrderQty (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleOrderQty |
|---|---|
| Abstract | no |
| Documentation | Total Number of Vehicles More information at: http://www.starstandard.org. |
| Super-types: | Vehicle < VehicleOrderVehicle (by extension) |
|---|---|
| Sub-types: | None |
| Name | VehicleOrderVehicle |
|---|---|
| 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 | |
| ModelChangeInd | Model can be changed in this order Indicator | Optional | (INACTIVE) |
| ModelYearChangeInd | Model Year can change in this order indicator | Optional | (INACTIVE) |
| OrderNumber | Customer assigned Order Number associated with the vehicle | Optional | |
| SaleClass | Class of Sale | Optional | |
| Condition | Condition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown | Optional | (INACTIVE) |
| CertifiedPreownedInd | Identifies as a certified Pre-Owned Vehicle | Optional | (INACTIVE) |
| VehicleNote | Any vehicle related notes | Optional | (INACTIVE) |
| VIN | Federally defined 17 position vehicle identification number | Optional | |
| PreviousVIN | Previous or Temporary VIN | Optional | (INACTIVE) |
| Plant | Factory or Port of origin of vehicle | Optional | (INACTIVE) |
| DeliveryMileage | Odometer reading of vehicle at time of delivery | Optional | |
| VehicleStock | Dealer assigned vehicle stock number of the sale | Optional | (INACTIVE) |
| TrimCode | Manufacturer assigned trim code | Optional | (INACTIVE) |
| DoorsQuantity | Number of doors on vehicle | Optional | (INACTIVE) |
| BodyStyle | Manufacturer-assigned vehicle body style | Optional | (INACTIVE) |
| InteriorColor | Vehicle Interior Color(s) Description | Optional | (INACTIVE) |
| ExteriorColor | Vehicle Exterior Color(s) Description | Optional | (INACTIVE) |
| TransmissionType | Vehicle Transmission type | Optional | (INACTIVE) |
| Option | Vehicle Options | Optional | (INACTIVE) |
| TransmissionCode | Transmission Serial Number | Optional | (INACTIVE) |
| DeliveryRangeStart | The earliest date of delivery of vehicle to Ship To | Optional | |
| DeliveryRangeEnd | The latest date of delivery of vehicle to Ship To | Optional | (INACTIVE) |
| EngineNumber | Serial number of the engine if vehicle not made for US sale | Optional | (INACTIVE) |
| IgnitionKeyNumber | Vehicle Ignition Key Number | Optional | (INACTIVE) |
| FleetAccount | Manufacturer defined fleet account number | Optional | (INACTIVE) |
| FleetVehicleId | Uniquely identifies the vehicle as part of a fleet company | Optional | (INACTIVE) |
| VehicleWeight | Vehicle weight | Optional | (INACTIVE) |
| ExteriorColorCode | Vehicle exterior color code | Optional | (INACTIVE) |
| ExteriorColorCodeChangeInd | Can the Exterior Color Code be changed in this order indicator | Optional | (INACTIVE) |
| InteriorColorCode | Vehicle Interior color code | Optional | (INACTIVE) |
| InteriorColorCodeChangeInd | Can the Interior Color Code be changed in this order indicator | Optional | (INACTIVE) |
| VehicleStatus | Vehicle status code - Example status could be Built, Scheduled, Shipped, In-Transit, Sold, etc. | Optional | (INACTIVE) |
| VehicleShipDate | Date shipped from warehouse or distribution center | Optional | (INACTIVE) |
| VehicleAllocatedDate | Date vehicle was allocated and/or a delivery work order was cut | Optional | (INACTIVE) |
| VehicleLocation | Indicates the physical location of the vehicle | Optional | (INACTIVE) |
| DealerInvoiceDate | Date the dealer was invoiced for the vehicle | Optional | (INACTIVE) |
| WholesaleDate | Date the vehicle was wholesaled to dealer | Optional | (INACTIVE) |
| OrderPriceProtectDate | Effective date the order price was set | Optional | (INACTIVE) |
| ProductionDate | Date the vehicle is to be built or arrive at port | Optional | (INACTIVE) |
| ModelGroup | Grouping of similar models for order management purposes | Optional | (INACTIVE) |
| IndividualOwner | Individual party who purchased the vehicle(s) | Optional | |
| OrganizationalOwner | Individual party who purchased the vehicle(s) | Optional | |
| ShipTo | Business entity that is receiving the vehicle(s) | Optional | |
| VehicleOrderNumber | Manufacturer assigned Vehicle Order Number (VON) | Optional | |
| PlantOrderNumber | Manufacturing plant vehicle order number | Optional | (INACTIVE) |
| Status | Status of vehicle | Optional | (INACTIVE) |
| MarketingInitiatives | Marketing initiatives related to vehicle sale | Optional | (INACTIVE) |
| VehicleOrderQty | Quantity of this specific vehicle configuration that is being ordered | Optional | (INACTIVE) |
| Super-types: | xsd:decimal < Measurement (by extension) < VehicleWeight (by extension) |
|---|---|
| Sub-types: | None |
| Name | VehicleWeight |
|---|---|
| Abstract | no |
| Documentation | Vehicle Weight More information at: http://www.starstandard.org. |
| Super-types: | None |
|---|---|
| Sub-types: |
|
| Name | Verb |
|---|---|
| Abstract | no |
| Field/Component | Description | Requirement | Business Rules |
|---|
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | VOConflictsOption |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| VOOptionSet | Conflicts Option set | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | VOInclusivesOption |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| VOOptionSet | Inclusives Option set | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | VOOption |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| OptionId | Option identifier code (i.e, AC) | Optional | |
| OptionName | Name of vehicle option | Optional | |
| OptionCost | Actual Dealer cost of option | Optional | |
| OptionMSRP | Option MSRP | Optional | |
| OptionSalesCode | Further definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. | Optional | |
| PortInstalledInd | Indicates Port-installed accessories | Optional | |
| OptionChangeInd | Can the option be changed in this order indicator | Optional | |
| Status | Option status | Optional | |
| Inclusives | Other options that must be ordered in conjunction with this option | Optional | |
| Conflicts | Other options that cannot be ordered with this option | Optional | |
| ColorDependentOptionInd | Option influences color availability indicator | Optional | |
| RequiredOption | Code of why option is required | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | VOOption2 |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| OptionId | Option identifier code (i.e, AC) | Optional | |
| OptionName | Name of vehicle option | Optional | |
| OptionCost | Actual Dealer cost of option | Optional | |
| OptionMSRP | Option MSRP | Optional | |
| OptionSalesCode | Further definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. | Optional | |
| PortInstalledInd | Indicates Port-installed accessories | Optional | |
| OptionChangeInd | Can the option be changed in this order indicator | Optional | |
| Status | Option status | Optional | |
| Inclusives | Other options that must be ordered in conjunction with this option | Optional | |
| Conflicts | Other options that cannot be ordered with this option | Optional | |
| ColorDependentOptionInd | Option influences color availability indicator | Optional | |
| RequiredOption | Code of why option is required | Optional |
| Super-types: | None |
|---|---|
| Sub-types: | None |
| Name | VOOptionSet |
|---|---|
| Abstract | no |
| Documentation | More information at: http://www.starstandard.org. |
| Field/Component | Description | Requirement | Business Rules |
|---|---|---|---|
| SetId | Identification of the group of options | Optional | |
| NumberOfOptions | Numbers of options in this set | Optional | |
| Option | Options within set | Optional |
| Super-types: | xsd:string < Id (by extension) < Warehouse (by extension) |
|---|---|
| Sub-types: | None |
| Name | Warehouse |
|---|---|
| Abstract | no |
| Documentation | Warehouse Number 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 < AddressQualifier (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AddressQualifier |
|---|---|
| Documentation | Address Qualifier More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| WorkAddress | Work Address |
| SeasonalAddress | Seasonal Address |
| DeliveryAddress | Delivery Address |
| HomeAddress | Home Address |
| PreviousAddress | Previous Address |
| Other | Other |
| Garage | Garage |
| Billing | Billing |
| NonSigningSpouseAddress | Non Signing Spouse Address |
| N/A | Not Applicable |
| Super-types: | xsd:string < AssigningOrganizationPartyId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AssigningOrganizationPartyId |
|---|---|
| Documentation | Assigning Organization Party Id More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| LegalId | Legal ID |
| NationalId | Government-assigned ID such as a social security Number |
| Other | Other |
| DUNS | Dun and Bradstreet |
| MotorDealerRegistrationId | Department of Motor Vehicle Registration number for a dealer. This is the dealer's license number to do business. |
| GSTRegistrationId | Canadian Goods and Services Tax Id. |
| HSTRegistrationId | Canadian HarmonizedTax Id. |
| Certification Of Registration Id | Id of the certificate of registration assigned to a business to allow that business to collect and remit certain taxes or fees to a state. |
| QSTRegistrationId | Quebec sales tax id. |
| Super-types: | xsd:string < AssigningPartyId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | AssigningPartyId |
|---|---|
| Documentation | Agency or entity that validates the Party Id More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| LegalId | Legal ID |
| DriversLicense | Drivers License |
| NationalId | Government-assigned ID such as a social security Number |
| Other | Other |
| GSTRegistrationId | Canadian Goods and Services Tax Id. |
| HSTRegistrationId | Canadian HarmonizedTax Id. |
| PreviousAccountNumber | |
| QSTRegistrationId | Quebec sales tax id. |
| Super-types: | xsd:string < Text (by restriction) < BodyStyle (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BodyStyle |
|---|---|
| Documentation | Manufacturer-assigned vehicle body style More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < BorderCrossingInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | BorderCrossingInd |
|---|---|
| Documentation | BorderCrossing Indicator More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| 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 < Indicator (by restriction) < ColorDependentOptionInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ColorDependentOptionInd |
|---|---|
| Documentation | Option influences color availability indicator More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd: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:string < ContactTelephoneNumberDescription (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ContactTelephoneNumberDescription |
|---|---|
| Documentation | Contact Telephone Number Description More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Evening Phone | Evening Phone |
| Day Phone | Day Phone |
| Cell Phone | Cell Phone |
| Pager | Pager |
| Other | Other |
| Super-types: | xsd:string < ContactTelephoneNumberOrganizationDescription (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ContactTelephoneNumberOrganizationDescription |
|---|---|
| Documentation | Contact Telephone Number Organization Description More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Day Phone | Day Phone |
| Cell Phone | Cell Phone |
| Pager | Pager |
| Other | Other |
| Super-types: | xsd:string < Note (by restriction) < ContactTime (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ContactTime |
|---|---|
| Documentation | Preferred contact time (i.e. Best day/time to reach the contact. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Country (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Country |
|---|---|
| Documentation | Country in which the Address is in. Conforms to ISO 3166-2. AF -AFGHANISTAN AL -ALBANIA DZ -ALGERIA AS -AMERICAN SAMOA AD -ANDORRA AO -ANGOLA AI -ANGUILLA AQ -ANTARCTICA AG -ANTIGUA AND BARBUDA AR -ARGENTINA AM -ARMENIA AW -ARUBA AU -AUSTRALIA AT -AUSTRIA AZ -AZERBAIJAN BS -BAHAMAS BH -BAHRAIN BD -BANGLADESH BB -BARBADOS BY -BELARUS BE -BELGIUM BZ -BELIZE BJ -BENIN BM -BERMUDA BT -BHUTAN BO -BOLIVIA BA -BOSNIA AND HERZEGOVINA BW -BOTSWANA BV -BOUVET ISLAND BR -BRAZIL IO-BRITISH INDIAN OCEAN TERRITORY BN -BRUNEI DARUSSALAM BG -BULGARIA BF -BURKINA FASO BI -BURUNDI KH -CAMBODIA CM -CAMEROON CA -CANADA CV -CAPE VERDE KY -CAYMAN ISLANDS CF -CENTRAL AFRICAN REPUBLIC TD -CHAD CL -CHILE CN -CHINA CX -CHRISTMAS ISLAND CC -COCOS (KEELING) ISLANDS CO -COLOMBIA KM -COMOROS CG -CONGO CD -CONGO, THE DEMOCRATIC REPUBLIC OF THE CK -COOK ISLANDS CR -COSTA RICA CI -CÔTE D'IVOIRE HR -CROATIA CU -CUBA CY -CYPRUS CZ -CZECH REPUBLIC DK -DENMARK DJ -DJIBOUTI DM -DOMINICA DO -DOMINICAN REPUBLIC EC -ECUADOR EG -EGYPT SV -EL SALVADOR GQ -EQUATORIAL GUINEA ER -ERITREA EE -ESTONIA ET -ETHIOPIA FK -FALKLAND ISLANDS (MALVINAS) FO -FAROE ISLANDS FJ -FIJI FI -FINLAND FR -FRANCE GF -FRENCH GUIANA PF -FRENCH POLYNESIA TF -FRENCH SOUTHERN TERRITORIES GA -GABON GM -GAMBIA GE -GEORGIA DE -GERMANY GH -GHANA GI -GIBRALTAR GR -GREECE GL -GREENLAND GD -GRENADA GP -GUADELOUPE GU -GUAM GT -GUATEMALA GN -GUINEA GW -GUINEA-BISSAU GY -GUYANA HT -HAITI HM -HEARD ISLAND AND MCDONALD ISLANDS VA -HOLY SEE (VATICAN CITY STATE) HN -HONDURAS HK -HONG KONG HU -HUNGARY IS -ICELAND IN -INDIA ID -INDONESIA IR -IRAN, ISLAMIC REPUBLIC OF IQ -IRAQ IE -IRELAND IL -ISRAEL IT -ITALY JM -JAMAICA JP -JAPAN JO -JORDAN KZ -KAZAKHSTAN KE -KENYA KI -KIRIBATI KP -KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF KR -KOREA, REPUBLIC OF KW -KUWAIT KG -KYRGYZSTAN LA -LAO PEOPLE'S DEMOCRATIC REPUBLIC LV -LATVIA LB -LEBANON LS -LESOTHO LR -LIBERIA LY -LIBYAN ARAB JAMAHIRIYA LI -LIECHTENSTEIN LT -LITHUANIA LU -LUXEMBOURG MO -MACAO MK -MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF MG -MADAGASCAR MW -MALAWI MY -MALAYSIA MV -MALDIVES ML -MALI MT -MALTA MH -MARSHALL ISLANDS MQ -MARTINIQUE MR -MAURITANIA MU -MAURITIUS YT -MAYOTTE MX -MEXICO FM -MICRONESIA, FEDERATED STATES OF MD -MOLDOVA, REPUBLIC OF MC -MONACO MN -MONGOLIA MS -MONTSERRAT MA -MOROCCO MZ -MOZAMBIQUE MM -MYANMAR NA -NAMIBIA NR -NAURU NP -NEPAL NL -NETHERLANDS AN -NETHERLANDS ANTILLES NC -NEW CALEDONIA NZ -NEW ZEALAND NI -NICARAGUA NE -NIGER NG -NIGERIA NU -NIUE NF -NORFOLK ISLAND MP -NORTHERN MARIANA ISLANDS NO -NORWAY OM -OMAN PK -PAKISTAN PW -PALAU PS -PALESTINIAN TERRITORY, OCCUPIED PA -PANAMA PG -PAPUA NEW GUINEA PY -PARAGUAY PE -PERU PH -PHILIPPINES PN -PITCAIRN PL -POLAND PT -PORTUGAL PR -PUERTO RICO QA -QATAR RE -RÉUNION RO -ROMANIA RU -RUSSIAN FEDERATION RW -RWANDA SH -SAINT HELENA KN -SAINT KITTS AND NEVIS LC -SAINT LUCIA PM -SAINT PIERRE AND MIQUELON VC -SAINT VINCENT AND THE GRENADINES WS -SAMOA SM -SAN MARINO ST -SAO TOME AND PRINCIPE SA -SAUDI ARABIA SN -SENEGAL CS -SERBIA AND MONTENEGRO SC -SEYCHELLES SL -SIERRA LEONE SG -SINGAPORE SK -SLOVAKIA SI -SLOVENIA SB -SOLOMON ISLANDS SO -SOMALIA ZA -SOUTH AFRICA GS -SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS ES -SPAIN LK -SRI LANKA SD -SUDAN SR -SURINAME SJ -SVALBARD AND JAN MAYEN SZ -SWAZILAND SE -SWEDEN CH -SWITZERLAND SY -SYRIAN ARAB REPUBLIC TW -TAIWAN, PROVINCE OF CHINA TJ -TAJIKISTAN TZ -TANZANIA, UNITED REPUBLIC OF TH -THAILAND TL -TIMOR-LESTE TG - TOGO TK -TOKELAU TO -TONGA TT -TRINIDAD AND TOBAGO TN -TUNISIA TR -TURKEY TM -TURKMENISTAN TC -TURKS AND CAICOS ISLANDS TV -TUVALU UG -UGANDA UA -UKRAINE AE -UNITED ARAB EMIRATES GB -UNITED KINGDOM US -UNITED STATES UM -UNITED STATES MINOR OUTLYING ISLANDS UY -URUGUAY UZ -UZBEKISTAN VU -VANUATU VE -VENEZUELA VN -VIET NAM VG -VIRGIN ISLANDS, BRITISH VI -VIRGIN ISLANDS, U.S. WF -WALLIS AND FUTUNA EH -WESTERN SAHARA YE -YEMEN ZM -ZAMBIA ZW -ZIMBABWE More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| US | |
| AF | |
| AL | |
| DZ | |
| AS | |
| AD | |
| AO | |
| AI | |
| AQ | |
| AG | |
| AR | |
| AM | |
| AW | |
| AU | |
| AT | |
| AZ | |
| BS | |
| BH | |
| BD | |
| BB | |
| BY | |
| BE | |
| BZ | |
| BJ | |
| BM | |
| BT | |
| BO | |
| BA | |
| BW | |
| BV | |
| BR | |
| IO | |
| BN | |
| BG | |
| BF | |
| BI | |
| KH | |
| CM | |
| CA | |
| CV | |
| KY | |
| CF | |
| TD | |
| CL | |
| CN | |
| CX | |
| CC | |
| CO | |
| KM | |
| CG | |
| CD | |
| CK | |
| CR | |
| CI | |
| HR | |
| CU | |
| CY | |
| CZ | |
| DK | |
| DJ | |
| DM | |
| DO | |
| EC | |
| EG | |
| SV | |
| GQ | |
| ER | |
| EE | |
| ET | |
| FK | |
| FO | |
| FJ | |
| FI | |
| FR | |
| GF | |
| PF | |
| TF | |
| GA | |
| GM | |
| GE | |
| DE | |
| GH | |
| GI | |
| GR | |
| GL | |
| GD | |
| GP | |
| GU | |
| GT | |
| GN | |
| GW | |
| GY | |
| HT | |
| HM | |
| VA | |
| HN | |
| HK | |
| HU | |
| IS | |
| IN | |
| ID | |
| IR | |
| IQ | |
| IE | |
| IL | |
| IT | |
| JM | |
| JP | |
| JO | |
| KZ | |
| KE | |
| KI | |
| KP | |
| KR | |
| KW | |
| KG | |
| LA | |
| LV | |
| LB | |
| LS | |
| LR | |
| LY | |
| LI | |
| LT | |
| LU | |
| MO | |
| MK | |
| MG | |
| MW | |
| MY | |
| MV | |
| ML | |
| MT | |
| MH | |
| MQ | |
| MR | |
| MU | |
| YT | |
| MX | |
| FM | |
| MD | |
| MC | |
| MN | |
| MS | |
| MA | |
| MZ | |
| MM | |
| NA | |
| NR | |
| NP | |
| NL | |
| AN | |
| NC | |
| NZ | |
| NI | |
| NE | |
| NG | |
| NU | |
| NF | |
| MP | |
| NO | |
| OM | |
| PK | |
| PW | |
| PS | |
| PA | |
| PG | |
| PY | |
| PE | |
| PH | |
| PN | |
| PL | |
| PT | |
| PR | |
| QA | |
| RE | |
| RO | |
| RU | |
| RW | |
| SH | |
| KN | |
| LC | |
| PM | |
| VC | |
| WS | |
| SM | |
| ST | |
| SA | |
| SN | |
| CS | |
| SC | |
| SL | |
| SG | |
| SK | |
| SI | |
| SB | |
| SO | |
| ZA | |
| GS | |
| ES | |
| LK | |
| SD | |
| SR | |
| SJ | |
| SZ | |
| SE | |
| CH | |
| SY | |
| TW | |
| TJ | |
| TZ | |
| TH | |
| TL | |
| TG | |
| TK | |
| TO | |
| TT | |
| TN | |
| TR | |
| TM | |
| TC | |
| TV | |
| UG | |
| UA | |
| AE | |
| GB | |
| UM | |
| UY | |
| UZ | |
| VU | |
| VE | |
| VN | |
| VG | |
| VI | |
| WF | |
| EH | |
| YE | |
| ZM | |
| ZW |
| Super-types: | xsd:string < County (by restriction) |
|---|---|
| Sub-types: | None |
| Name | County |
|---|---|
| Documentation | Business party county location More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Currency (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Currency |
|---|---|
| Documentation | The ISO code identifying the type of currency in use. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| USD | |
| ADP | |
| AED | |
| AFA | |
| ALL | |
| ANG | |
| AOK | |
| ARA | |
| ATS | |
| AUD | |
| AWG | |
| BBD | |
| BDT | |
| BEF | |
| BGL | |
| BHD | |
| BIF | |
| BMD | |
| BND | |
| BOB | |
| BRC | |
| BSD | |
| BTN | |
| BUK | |
| BWP | |
| BZD | |
| CAD | |
| CHF | |
| CLF | |
| CLP | |
| CNY | |
| COP | |
| CRC | |
| CSK | |
| CUP | |
| CVE | |
| CYP | |
| DDM | |
| DEM | |
| DJF | |
| DKK | |
| DOP | |
| DZD | |
| ECS | |
| EGP | |
| ESP | |
| ETB | |
| EUR | |
| FIM | |
| FKP | |
| FRF | |
| GBP | |
| GHC | |
| GIP | |
| GMD | |
| GNF | |
| GRD | |
| GTQ | |
| GWP | |
| GYD | |
| HKD | |
| HNL | |
| HTG | |
| HUF | |
| IDR | |
| IEP | |
| ILS | |
| INR | |
| IQD | |
| IRR | |
| ISK | |
| ITL | |
| JMD | |
| JOD | |
| JPY | |
| KES | |
| KHR | |
| KMF | |
| KPW | |
| KRW | |
| KWD | |
| KYD | |
| LAK | |
| LBP | |
| LKR | |
| LRD | |
| LSL | |
| LUF | |
| LYD | |
| MAD | |
| MGF | |
| MNT | |
| MOP | |
| MRO | |
| MTL | |
| MUR | |
| MVR | |
| MWK | |
| MXN | |
| MYR | |
| MZM | |
| NGN | |
| NIC | |
| NLG | |
| NOK | |
| NPR | |
| NZD | |
| OMR | |
| PAB | |
| PEI | |
| PGK | |
| PHP | |
| PKR | |
| PLZ | |
| PTE | |
| PYG | |
| QAR | |
| ROL | |
| RWF | |
| SAR | |
| SBD | |
| SCR | |
| SDP | |
| SEK | |
| SGD | |
| SHP | |
| SLL | |
| SKK | |
| SOS | |
| SRG | |
| STD | |
| SUR | |
| SVC | |
| SYP | |
| SZL | |
| THB | |
| TND | |
| TOP | |
| TPE | |
| TRL | |
| TTD | |
| TWD | |
| TZS | |
| UGS | |
| UYP | |
| VEB | |
| VND | |
| VUV | |
| WST | |
| YDD | |
| YER | |
| YUD | |
| ZAR | |
| ZRZ | |
| ZWD | |
| Other |
| Super-types: | xsd:date < Date (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Date |
|---|---|
| Documentation | Date conforms to ISO 8601 format rules EX: \d\d\d\d-\d\d-\d\d More information at: http://www.starstandard.org. |
| Super-types: | xsd:dateTime < DateTime (by restriction) |
|---|---|
| Sub-types: |
|
| Name | DateTime |
|---|---|
| Documentation | Date and time conforms to ISO 8601format rules without offset EX:2003-11-05T13:15:30Z More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < DBAName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DBAName |
|---|---|
| Documentation | Doing Business As name. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < DealerAssignedNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DealerAssignedNumber |
|---|---|
| Documentation | The number given to an order by a dealer More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < DealerInvoiceDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DealerInvoiceDate |
|---|---|
| Documentation | Date the dealer was invoiced More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < DeliveryRangeEnd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DeliveryRangeEnd |
|---|---|
| Documentation | DeliveryRangeStart More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < DeliveryRangeStart (by restriction) |
|---|---|
| Sub-types: | None |
| Name | DeliveryRangeStart |
|---|---|
| Documentation | DeliveryRangeStart 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) < 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 < Expression (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Expression |
|---|
| Super-types: | xsd:string < ExpressionLanguage (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ExpressionLanguage |
|---|
| 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 < Indicator (by restriction) < ExteriorColorCodeChangeInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ExteriorColorCodeChangeInd |
|---|---|
| Documentation | Can the Exterior Color Code be changed indicator More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| 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 < 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 < 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 < HomeWork (by restriction) |
|---|---|
| Sub-types: | None |
| Name | HomeWork |
|---|---|
| Documentation | Home or Work More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Home | Home |
| Work | Work |
| Other | Other |
| 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 < Indicator (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Indicator |
|---|---|
| Documentation | 0 = No, 1 = Yes More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Indicator (by restriction) < InitiativeChangeInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InitiativeChangeInd |
|---|---|
| Documentation | Can the Initiative be changed indicator More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:date < Date (by restriction) < InitiativeDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InitiativeDate |
|---|---|
| Documentation | The date the initiative was processed. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < InitiativeType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InitiativeType |
|---|---|
| Documentation | Type of program - Incentive or program related initiatives More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Program | Program-related initiative |
| Incentives | Incentive-related initiative |
| N/A | Not Applicable |
| Other | Other |
| Super-types: | xsd:string < Note (by restriction) < InteriorColor (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InteriorColor |
|---|---|
| Documentation | Vehicle Interior Color(s) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < InteriorColorCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InteriorColorCode |
|---|---|
| Documentation | Vehicle Interior color code More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < InteriorColorCodeChangeInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | InteriorColorCodeChangeInd |
|---|---|
| Documentation | Can the Interior Color Code be changed indicator More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < StateOrProvince (by restriction) < IssuingState (by restriction) |
|---|---|
| Sub-types: | None |
| Name | IssuingState |
|---|---|
| Documentation | Indicates that State where the license was issued. 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:string < ReferenceNumber (by restriction) < LoadNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | LoadNumber |
|---|---|
| Documentation | Shipment carrier-assigned load number 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) < 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 < 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 < Indicator (by restriction) < ModelChangeInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ModelChangeInd |
|---|---|
| Documentation | Model can be changed Indicator More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| 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 < Indicator (by restriction) < ModelYearChangeInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ModelYearChangeInd |
|---|---|
| Documentation | Model Year can change indicator More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Name (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Name |
|---|---|
| Documentation | Name of the Party. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Note |
|---|---|
| Documentation | A free form note. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < OptionChangeInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OptionChangeInd |
|---|---|
| Documentation | Can the option be changed indicator More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Code (by restriction) < OptionId (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OptionId |
|---|---|
| Documentation | Option identifier code (i.e., AC) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < OptionName (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OptionName |
|---|---|
| Documentation | Name of vehicle option More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < OptionSalesCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OptionSalesCode |
|---|---|
| Documentation | Further definition of accessories and option packages - Indicates whether ordered option, special package, standard, etc. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < OrderComments (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OrderComments |
|---|---|
| Documentation | Free form text of remarks regarding the order. More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < OrderDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OrderDate |
|---|---|
| Documentation | Date order originally placed More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < OrderNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OrderNumber |
|---|---|
| Documentation | Customer assigned Order Number More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < OrderPriceProtectDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | OrderPriceProtectDate |
|---|---|
| Documentation | Effective date the order price was set More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < Plant (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Plant |
|---|---|
| Documentation | Factory or Port of origin of vehicle More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) < PlantOrderNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PlantOrderNumber |
|---|---|
| Documentation | Manufacturing plant order number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < PortInstalledInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PortInstalledInd |
|---|---|
| Documentation | Indicates Port-installed accessories More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Note (by restriction) < PortOfEntry (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PortOfEntry |
|---|---|
| Documentation | Port of Entry 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 < PreferredContactMethod (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PreferredContactMethod |
|---|---|
| Documentation | Preferred contact method More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Day Phone | Day Phone |
| Evening Phone | Evening Phone |
| Cell Phone | Cell Phone |
| Work Fax | Work Fax |
| Home Fax | Home Fax |
| Pager | Pager |
| Work Email | Work Email |
| Home Email | Home Email |
| US Mail | US Mail |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:string < PreferredContactMethodOrganization (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PreferredContactMethodOrganization |
|---|---|
| Documentation | Preferred Contact Method Organization More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Day Phone | Day Phone |
| Cell Phone | Cell Phone |
| Work Fax | Work Fax |
| Pager | Pager |
| Work Email | Work Email |
| US Mail | US Mail |
| Other | Other |
| Super-types: | xsd:string < VIN (by restriction) < PreviousVIN (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PreviousVIN |
|---|---|
| Documentation | Previous or Temporary VIN More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Indicator (by restriction) < PrimaryContactInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PrimaryContactInd |
|---|---|
| Documentation | Indicates if contact is primary contact More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Priority (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Priority |
|---|---|
| Documentation | Indicates manufacturer handling and processing urgency More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < ProductionDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ProductionDate |
|---|---|
| Documentation | Date the vehicle is to be built or arrive at port More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < PromisedDeliveryDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PromisedDeliveryDate |
|---|---|
| Documentation | Indicates the date in which the order was promised to be delivered to the customer. More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < PromisedShipDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | PromisedShipDate |
|---|---|
| Documentation | Indicates the date in which the order was promised to be shipped from the supplier to the customer. More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) < Reference (by restriction) |
|---|---|
| Sub-types: | None |
| Name | Reference |
|---|---|
| Documentation | Reference notation More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < ReferenceNumber (by restriction) |
|---|---|
| Sub-types: |
|
| Name | ReferenceNumber |
|---|---|
| Documentation | Reference number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < ReimbursementComment (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ReimbursementComment |
|---|---|
| Documentation | Reimbursement dealer comments More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Name (by restriction) < ReimbursementPayee (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ReimbursementPayee |
|---|---|
| Documentation | Indicates who is paid More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < ReqDeliveryRangeEnd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ReqDeliveryRangeEnd |
|---|---|
| Documentation | Latest estimated time of arrival More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < ReqDeliveryRangeStart (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ReqDeliveryRangeStart |
|---|---|
| Documentation | Earliest estimated time of arrival More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < RequiredOption (by restriction) |
|---|---|
| Sub-types: | None |
| Name | RequiredOption |
|---|---|
| Documentation | Code of why option is required More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Regional | |
| Government | |
| Other | Other |
| Super-types: | xsd:string < 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 < Indicator (by restriction) < ShipToChangeInd (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ShipToChangeInd |
|---|---|
| Documentation | Indicates if Ship To be changed. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 0 | |
| 1 |
| Super-types: | xsd:string < Code (by restriction) < ShortMfg (by restriction) |
|---|---|
| Sub-types: | None |
| Name | ShortMfg |
|---|---|
| Documentation | Short Manfacturer or RSP Codes More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Note (by restriction) < SpecialInstructions (by restriction) |
|---|---|
| Sub-types: | None |
| Name | SpecialInstructions |
|---|---|
| Documentation | Free form text identifying unique handling of order. 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 < StatusCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StatusCode |
|---|---|
| Documentation | A code identifying the reason for the status message. More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| Success | The operation completed successfully. This does not necessarily mean that the BOD was processed. Instead it means that the client's role is done and that it won't receive any error messages later. Type of Response Code: Success. |
| Unspecified | An unspecified error occurred. The StatusText field contains the complete text. |
| Not In Inventory | Inventory is not currently available and back ordering was not requested. |
| Discontinued | The part has discontinued. |
| Invalid Part | Invalid part number. |
| Not Yet Available | The part is scheduled for a future release date and is not available at this time. |
| Not Authorized | The part is not authorized for your product line. |
| Under Development | The part is under development and not ready for sale. |
| Assembly Only | The part is a component part and is only available as an assembly. |
| Component Only | The part is an assembly part and is only available as a component. |
| Internal Use Only | The part is reserved for manufacturing and supplier internal use; it is not a service replacement part. |
| Recalled | The part has been recalled. |
| Cannot Sell | The part is not available for sale for an unspecified reason. |
| Export Only | The part is not available for sale in the United States; it is for export vehicles only. |
| Credit Limit Exceeded | Credit limit exceeded. |
| Credit Card Denied | Credit card transaction denied by creditor. |
| Account On Hold | The dealer's account has been put on hold. |
| Invalid Unit Of Measure | The unit of measurement was invalid for this part number. |
| Invalid Promotion Code | The promotion code is invalid. |
| Invalid Shipping Method | The shipping method is invalid, for example, shipping by ground to Puerto Rico. |
| Duplicate Line Number | The line number is the same as another line within this transaction. |
| No Drop Shipment | Drop shipments are not allowed. |
| No Will Call | Will-call pickups are not allowed. |
| Minimum Quantity Not Met | There is a minimum quantity purchase requirement for this part and the quantity has not been met. The minimum quantity is: NN |
| Other | Other |
| N/A | Not Applicable |
| Super-types: | xsd:date < Date (by restriction) < StatusDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StatusDate |
|---|---|
| Documentation | The date the current status was recorded More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) < StatusText (by restriction) |
|---|---|
| Sub-types: | None |
| Name | StatusText |
|---|---|
| Documentation | Descriptive status text. 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:date < Date (by restriction) < TargetBuildDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TargetBuildDate |
|---|---|
| Documentation | The date the OEM expects to build the vehicle More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Text (by restriction) |
|---|---|
| Sub-types: |
|
| Name | Text |
|---|---|
| Documentation | Indicates generic text type More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < TransmissionCode (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TransmissionCode |
|---|---|
| Documentation | Transmission Serial Number More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < TransmissionType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | TransmissionType |
|---|---|
| Documentation | Vehicle Transmission type - 3 = 3 speed, 4 = 4 speed, 5 = 5 speed, 6 = 6 speed, A - Automatic More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| 3 | 3 Speed |
| 4 | 4 Speed |
| 5 | 5 Speed |
| 6 | 6 Speed |
| A | "A" = Automatic |
| Automatic 3 | Automatic 3 speed transmission type |
| Automatic 4 | Automatic 4 speed transmission type |
| Automatic 5 | Automatic 5 speed transmission type |
| Automatic 6 | Automatic 6 speed transmission type |
| Automatic 7 | Automatic 7 speed transmission type |
| 7 | 7 Speed |
| CVT Automatic 3 | Continuously Variable T ransmission Automatic 3 speed transmission type (natural gas and hybrid). |
| CVT Automatic 4 | Continuously Variable T ransmission Automatic 4 speed transmission type (natural gas and hybrid). |
| CVT Automatic 5 | Continuously Variable T ransmission Automatic 5 speed transmission type (natural gas and hybrid). |
| CVT Automatic 6 | Continuously Variable T ransmission Automatic 6 speed transmission type (natural gas and hybrid). |
| CVT Automatic 7 | Continuously Variable T ransmission Automatic 7 speed transmission type (natural gas and hybrid). |
| M | M = Manual |
| Super-types: | xsd:string < 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 < UOM (by restriction) |
|---|---|
| Sub-types: | None |
| Name | UOM |
|---|---|
| Documentation | Units of Measure - ea=Each; bx=Box; case=Case; ctn=Carton; gal=Gallon; qt=Quart; pt=Pint; ft=Feet; yd=Yard; in=Inch; L=Liter; m=Meter; cm=Centimeter; kg=Kilograms; g=grams; other=Other More information at: http://www.starstandard.org. |
| Code Value | Description |
|---|---|
| ea | Each |
| bx | Box |
| case | Case |
| ctn | Carton |
| gal | Gallon |
| qt | Quart |
| pt | Pint |
| ft | ft = feet |
| yd | yd = yard |
| in | in = inch |
| L | "L" = Canceled |
| m | m = meter |
| cm | cm = centimeter |
| kg | Kilogram |
| g | Gram |
| other | |
| tn | Ton |
| km | kilometers |
| mi | miles |
| hp | horsepower |
| kw | kilowatt |
| 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) < VehicleAllocatedDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleAllocatedDate |
|---|---|
| Documentation | Date vehicle was allocated and/or a delivery work order was cut 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 < ReferenceNumber (by restriction) < VehicleOrderNumber (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleOrderNumber |
|---|---|
| Documentation | Vehicle Order Number (VON) More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Type (by restriction) < VehicleOrderType (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleOrderType |
|---|---|
| Documentation | Identifies vehicle order type More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < VehicleShipDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleShipDate |
|---|---|
| Documentation | Date shipped from warehouse or distribution center More information at: http://www.starstandard.org. |
| Super-types: | xsd:string < Code (by restriction) < VehicleStatus (by restriction) |
|---|---|
| Sub-types: | None |
| Name | VehicleStatus |
|---|---|
| Documentation | Vehicle status code - Example status could be Built, Scheduled, Shipped, In-Transit, Sold, etc. 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: |
|
| Name | VIN |
|---|---|
| Documentation | Federally defined 17 position vehicle identification number More information at: http://www.starstandard.org. |
| Super-types: | xsd:date < Date (by restriction) < WholesaleDate (by restriction) |
|---|---|
| Sub-types: | None |
| Name | WholesaleDate |
|---|---|
| Documentation | Date the vehicle was wholesaled to dealer 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. |
Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved
Generated by StarSchemaGuidelineGenerator based on xs3p. Last modified: