Star Logo

Implementation Guideline

Acknowledge Service Appointment
Repository Version Rev4.5.4












Copyright © 2007 STAR – Standards for Technology in Automotive Retail. All rights reserved












Acknowledge Service Appointment

Table of Contents

top

Overview

This document is a guideline on how to use the Acknowledge Service Appointment Business Object Document (BOD). Acknowledge Service Appointment has been defined in the context of STAR for the Automotive Retail Industry. The scope of this BOD is to define the Acknowledge Service Appointment 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 Acknowledge Service Appointment, this BOD could be used to send Acknowledge Service Appointment information between any two business parties.

The Acknowledge Service Appointment Implementation Guidelines provide detailed information regarding the structure and meaning of the Acknowledge Service Appointment BOD and corresponds directly to the Acknowledge Service Appointment 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 Acknowledge Service Appointment Implementation Guidelines must be used in concert with the Acknowledge Service Appointment 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 Acknowledge Service Appointment 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 Acknowledge Service Appointment BOD. Where possible, STAR has mapped to existing OAGI fields and components. Note however that the STAR Acknowledge Service Appointment 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.

top

Schema Field Usage

STAR uses the same Noun in the schema for all the Noun/Verb combinations of the Acknowledge Service Appointment 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.

top

Business Scenario

The Service Appointment Binary Collaboration starts with the transmission of a Service Appointment from the OEM or third party service provider. In response, the Dealer may send Service Appointment information back to the OEM or third party service provider indicating availability. At this point the OEM or third party would send the Dealer the accepted appointment date time, etc. This process occurs on demand as is needed. Note: This scenario is an example of how the Service Appointment BOD can be used. Implementations may vary.

top

Relationship Diagram

The relationship diagram identifies all of the various components or building blocks of information used in the Acknowledge Service Appointment 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. Relationship Diagram for ServiceAppointment

top

Schema Document Properties

Target Namespacehttp://www.starstandards.org/STAR
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
DocumentationThis 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/.

Declared Namespaces

PrefixNamespace
Default namespacehttp://www.starstandards.org/STAR
xmlhttp://www.w3.org/XML/1998/namespace
xsdhttp://www.w3.org/2001/XMLSchema

Schema Component Representation
<xsd:schema targetNamespace="http://www.starstandards.org/STAR" elementFormDefault="qualified" attributeFormDefault="unqualified">
...
</xsd:schema>
top

Global Declarations

Element: Acknowledge

  • This element can be used wherever the following element is referenced:

NameAcknowledge
TypeAcknowledge
Nillableno
Abstractno
DocumentationThe Acknowledge verb is used to acknowledge the application receipt of a Process request. This function conveys the result of the original request. An example of this is Acknowledge PO, where a Process PO has been issued and the corresponding business application acknowledges the receipt of the PO and responds with an acceptance or a counter offer.
More information at: http://www.openapplications.org/oagis.

XML Instance Representation
<Acknowledge
confirm="ConfirmType [0..1]"
>
<OriginalBODId> xsd:NMTOKEN </OriginalBODId> [0..1]
</Acknowledge>
Schema Component Representation
<xsd:element name="Acknowledge" type="Acknowledge" substitutionGroup="Verb"/>
top

Element: AcknowledgeServiceAppointment

NameAcknowledgeServiceAppointment
TypeAcknowledgeServiceAppointment
Nillableno
Abstractno

XML Instance Representation
<AcknowledgeServiceAppointment
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
<DataArea> AcknowledgeServiceAppointmentDataArea </DataArea> [1]
</AcknowledgeServiceAppointment>
Schema Component Representation
<xsd:element name="AcknowledgeServiceAppointment" type="AcknowledgeServiceAppointment"/>
top

Element: ApplicationArea

NameApplicationArea
TypeApplicationArea
Nillableno
Abstractno
DocumentationProvides 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.

XML Instance Representation
<ApplicationArea>
<Sender> Sender </Sender> [1] ?
<CreationDateTime> DateTime </CreationDateTime> [1] ?
<Signature> Signature </Signature> [0..1] ?
<BODId> Code </BODId> [0..1] ?
<Destination> Destination </Destination> [1] ?
</ApplicationArea>
Schema Component Representation
<xsd:element name="ApplicationArea" type="ApplicationArea"/>
top

Element: Detail

NameDetail
TypeServiceAppointmentDetail
Nillableno
Abstractno
Documentation More information at: http://www.starstandards.org.

XML Instance Representation
<Detail>
<RequestedService> RequestedServiceExpanded </RequestedService> [0..*] ?
<Appointment> ServiceAppointmentExtended </Appointment> [0..1] ?
<CustomerPaymentMethod> CustomerPaymentMethod </CustomerPaymentMethod> [0..1] ?
</Detail>
Schema Component Representation
<xsd:element name="Detail" type="ServiceAppointmentDetail"/>
top

Element: Header

NameHeader
TypeServiceAppointmentHeader
Nillableno
Abstractno
Documentation More information at: http://www.starstandards.org.

XML Instance Representation
<Header>
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
<SecondaryPassword> SecondaryPassword </SecondaryPassword> [0..1] ?
<SecondaryDealerNumber> SecondaryDealerNumber </SecondaryDealerNumber> [0..1] ?
<DocumentId> DocumentId </DocumentId> [1] ?
<AccountGroupCode> AccountGroupCode </AccountGroupCode> [0..1] ?
<ServiceHistoryPermissionApprovalInd> ServiceHistoryPermissionApprovalInd </ServiceHistoryPermissionApprovalInd> [0..1] ?
<Dealer> DealerParty </Dealer> [0..1] ?
<Provider> ProviderParty </Provider> [0..1] ?
<AppointmentContact> AppointmentContactParty </AppointmentContact> [0..1] ?
<IndividualOwner> IndividualOwnerPartyExtendedSA </IndividualOwner> [0..1] ?
<OrganizationalOwner> OrganizationalOwnerPartyExtendedSA </OrganizationalOwner> [0..1] ?
<IndividualCo-Owner> IndividualOwnerPartyExtendedSA </IndividualCo-Owner> [0..1] ?
<OrganizationalCo-Owner> OrganizationalOwnerPartyExtendedSA </OrganizationalCo-Owner> [0..1] ?
<PrimaryDriver> IndividualOwnerPartyExtendedSA </PrimaryDriver> [0..1] ?
<SecondaryDriver> IndividualOwnerPartyExtendedSA </SecondaryDriver> [0..*] ?
<Vehicle> HistoryVehicle </Vehicle> [0..1] ?
<Warranty> Warranty </Warranty> [0..*] ?
<ServiceContract> FullServiceContract </ServiceContract> [0..*] ?
<MileageIn> MileageIn </MileageIn> [0..1] ?
</Header>
Schema Component Representation
<xsd:element name="Header" type="ServiceAppointmentHeader"/>
top

Element: ServiceAppointment

NameServiceAppointment
TypeServiceAppointment
Nillableno
Abstractno
Documentation More information at: http://www.starstandards.org.

XML Instance Representation
<ServiceAppointment>
<Header> ... </Header> [1]
<Detail> ... </Detail> [1]
</ServiceAppointment>
Schema Component Representation
<xsd:element name="ServiceAppointment" type="ServiceAppointment"/>
top

Element: Verb

  • The following elements can be used wherever this element is referenced:

NameVerb
TypeVerb
Nillableno
Abstractyes

XML Instance Representation
<Verb/>
Schema Component Representation
<xsd:element name="Verb" type="Verb" abstract="true"/>
top

Global Definitions

Components (Complex Type): Acknowledge

Super-types:Verb < ConfirmableVerb (by extension) < ResponseVerb (by extension) < Acknowledge (by extension)
Sub-types:None

NameAcknowledge
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
Verb Required 
OriginalBODId Optional 

XML Instance Representation
<...
confirm="ConfirmType [0..1]"
>
<OriginalBODId> xsd:NMTOKEN </OriginalBODId> [0..1]
</...>
Schema Component Representation
<xsd:complexType name="Acknowledge">
<xsd:complexContent>
<xsd:extension base="ResponseVerb"/>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): AcknowledgeServiceAppointment

Super-types:BusinessObjectDocument < AcknowledgeServiceAppointment (by extension)
Sub-types:None

NameAcknowledgeServiceAppointment
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ApplicationAreaProvides 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 

XML Instance Representation
<...
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
<DataArea> AcknowledgeServiceAppointmentDataArea </DataArea> [1]
</...>
Schema Component Representation
<xsd:complexType name="AcknowledgeServiceAppointment">
<xsd:complexContent>
<xsd:extension base="BusinessObjectDocument">
<xsd:sequence>
<xsd:element name="DataArea" type="AcknowledgeServiceAppointmentDataArea"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): AcknowledgeServiceAppointmentDataArea

Super-types:None
Sub-types:None

NameAcknowledgeServiceAppointmentDataArea
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AcknowledgeThe Acknowledge verb is used to acknowledge the application receipt of a Process request. This function conveys the result of the original request. An example of this is Acknowledge PO, where a Process PO has been issued and the corresponding business application acknowledges the receipt of the PO and responds with an acceptance or a counter offer. Required 
ServiceAppointment Required 

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="AcknowledgeServiceAppointmentDataArea">
<xsd:sequence>
<xsd:element ref="Acknowledge"/>
<xsd:element ref="ServiceAppointment" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Address

Super-types:AddressBase < Address (by extension)
Sub-types:

NameAddress
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
qualifier Required 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 

XML Instance Representation
<...
qualifier="AddressQualifier [0..1]"
>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="Address">
<xsd:complexContent>
<xsd:extension base="AddressBase">
<xsd:attribute name="qualifier" type="AddressQualifier"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): AddressBase

Super-types:None
Sub-types:

NameAddressBase
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 

XML Instance Representation
<...>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="AddressBase">
<xsd:sequence>
<xsd:element name="AddressLine" type="AddressLine" maxOccurs="unbounded"/>
<xsd:element name="City" type="City"/>
<xsd:element name="County" type="County" minOccurs="0"/>
<xsd:element name="StateOrProvince" type="StateOrProvince"/>
<xsd:element name="Country" type="Country"/>
<xsd:element name="PostalCode" type="PostalCode"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): AlternatePartyId

Super-types:None
Sub-types:

NameAlternatePartyId
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
IdAlternate Party Identification Required 

XML Instance Representation
<...>
<Id> Id </Id> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="AlternatePartyId">
<xsd:sequence>
<xsd:element name="Id" type="Id"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Amount

Super-types:xsd:decimal < Amount (by extension)
Sub-types:None

NameAmount
Abstractno
DocumentationBased on OAGI Amount. Simple content with the currency as an attrbute
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
currency Required 

XML Instance Representation
<...
currency="Currency [1]"
>
xsd:decimal
</...>
Schema Component Representation
<xsd:complexType name="Amount">
<xsd:simpleContent>
<xsd:extension base="xsd:decimal">
<xsd:attribute name="currency" type="Currency" use="required"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ApplicationArea

Super-types:None
Sub-types:None

NameApplicationArea
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
SenderIdentifies 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 
CreationDateTimeis 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
 
SignatureIf 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 
BODIdThe 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 
DestinationInformation related to the receiver of the BOD Required 

XML Instance Representation
<...>
<Sender> Sender </Sender> [1] ?
<CreationDateTime> DateTime </CreationDateTime> [1] ?
<Signature> Signature </Signature> [0..1] ?
<BODId> Code </BODId> [0..1] ?
<Destination> Destination </Destination> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="ApplicationArea">
<xsd:sequence>
<xsd:element name="Sender" type="Sender"/>
<xsd:element name="CreationDateTime" type="DateTime"/>
<xsd:element name="Signature" type="Signature" minOccurs="0"/>
<xsd:element name="BODId" type="Code" minOccurs="0"/>
<xsd:element name="Destination" type="Destination"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): Appointment

Super-types:AppointmentBase < Appointment (by extension)
Sub-types:

NameAppointment
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AppointmentDateTimeDate and time of the appointment Optional 
AppointmentLocationLocation of the appointment... For example: Office; Home Optional 
AppointmentNotesComments that relate to the appointment. Optional 

XML Instance Representation
<...>
<AppointmentDateTime> AppointmentDateTime </AppointmentDateTime> [0..1] ?
<AppointmentLocation> AppointmentLocation </AppointmentLocation> [0..1] ?
<AppointmentNotes> AppointmentNotes </AppointmentNotes> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Appointment">
<xsd:complexContent>
<xsd:extension base="AppointmentBase"/>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): AppointmentBase

Super-types:None
Sub-types:

NameAppointmentBase
Abstractno
DocumentationBased on oa:Appointment
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AppointmentDateTimeDate and time of the appointment Optional 
AppointmentLocationLocation of the appointment... For example: Office; Home Optional 
AppointmentNotesComments that relate to the appointment. Optional 

XML Instance Representation
<...>
<AppointmentDateTime> AppointmentDateTime </AppointmentDateTime> [0..1] ?
<AppointmentLocation> AppointmentLocation </AppointmentLocation> [0..1] ?
<AppointmentNotes> AppointmentNotes </AppointmentNotes> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="AppointmentBase">
<xsd:sequence>
<xsd:element name="AppointmentDateTime" type="AppointmentDateTime" minOccurs="0"/>
<xsd:element name="AppointmentLocation" type="AppointmentLocation" minOccurs="0"/>
<xsd:element name="AppointmentNotes" type="AppointmentNotes" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): AppointmentContactParty

Super-types:PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) < IndividualOwnerPartySA (by extension) < AppointmentContactParty (by extension)
Sub-types:None

NameAppointmentContactParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 
ContactIndividual party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
DMSCustomerIdThe DMS system assigned number associated with a customer entity Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
<Contact> IndividualPartyContact </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
<DMSCustomerId> DMSCustomerId </DMSCustomerId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="AppointmentContactParty">
<xsd:complexContent>
<xsd:extension base="IndividualOwnerPartySA"/>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): AuthorizedAmount

Super-types:xsd:decimal < Amount (by extension) < AuthorizedAmount (by extension)
Sub-types:None

NameAuthorizedAmount
Abstractno
DocumentationAuthorized expense limit.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="AuthorizedAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): BrandedInfo

Super-types:None
Sub-types:None

NameBrandedInfo
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
BrandedTitleIndThis tag indicates if a vehicle's title has been branded. (i.e., vehicle totaled and state registration title branded as such) Optional 
BrandedTitleDateBranding Date Optional 
BrandingStateCodeBranding State Code Optional 
BrandingStateReferenceBranding State Reference Number Optional 
BrandingSourceBranding source √ƒ¬Ę¬€¬“ (i.e., source who says that the vehicle is branded) Optional 

XML Instance Representation
<...>
<BrandedTitleInd> BrandedTitleInd </BrandedTitleInd> [0..1] ?
<BrandedTitleDate> BrandedTitleDate </BrandedTitleDate> [0..1] ?
<BrandingStateCode> BrandingStateCode </BrandingStateCode> [0..1] ?
<BrandingStateReference> BrandingStateReference </BrandingStateReference> [0..1] ?
<BrandingSource> BrandingSource </BrandingSource> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="BrandedInfo">
<xsd:sequence>
<xsd:element name="BrandedTitleInd" type="BrandedTitleInd" minOccurs="0"/>
<xsd:element name="BrandedTitleDate" type="BrandedTitleDate" minOccurs="0"/>
<xsd:element name="BrandingStateCode" type="BrandingStateCode" minOccurs="0"/>
<xsd:element name="BrandingStateReference" type="BrandingStateReference" minOccurs="0"/>
<xsd:element name="BrandingSource" type="BrandingSource" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): BrandingStateCode

Super-types:xsd:string < StateOrProvince (by restriction) < BrandingStateCode (by extension)
Sub-types:None

NameBrandingStateCode
Abstractno
DocumentationBranding State Code
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="BrandingStateCode">
<xsd:simpleContent>
<xsd:extension base="StateOrProvince"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): BusinessObjectDocument

Super-types:None
Sub-types:

NameBusinessObjectDocument
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
revisionThis 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 
releaseIndicates the OAGIS release that this BOD belongs. Optional 
environmentIndicates 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 
langIndicates the language that the contents of the BOD is in unless otherwise stated. Optional 
bodVersionDeprecated 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 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ApplicationAreaProvides 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 

XML Instance Representation
<...
revision="Text [0..1] ?"

release="8.1-Lite [0..1] ?"

environment="Text [0..1] ?"

lang="Language [0..1] ?"

bodVersion="Text [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="BusinessObjectDocument">
<xsd:sequence>
<xsd:element ref="ApplicationArea"/>
</xsd:sequence>
<xsd:attribute name="revision" use="optional">
<xsd:simpleType>
<xsd:restriction base="Text"/>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="release" type="Text" use="optional" fixed="8.1-Lite"/>
<xsd:attribute name="environment" use="optional" default="Production">
<xsd:simpleType>
<xsd:restriction base="Text">
<xsd:enumeration value="Test"/>
<xsd:enumeration value="Production"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:attribute>
<xsd:attribute name="lang" type="Language" use="optional"/>
<xsd:attribute name="bodVersion" use="optional">
<xsd:simpleType>
<xsd:restriction base="Text"/>
</xsd:simpleType>
</xsd:attribute>
</xsd:complexType>
top

Components (Complex Type): CampaignDescription

Super-types:xsd:string < Description (by extension) < CampaignDescription (by extension)
Sub-types:None

NameCampaignDescription
Abstractno
DocumentationService Campaign Description
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="CampaignDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CauseDescription

Super-types:xsd:string < Description (by extension) < CauseDescription (by extension)
Sub-types:None

NameCauseDescription
Abstractno
DocumentationDealer explanation of vehicle malfunction cause
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="CauseDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CodesAndCommentsBase

Super-types:None
Sub-types:

NameCodesAndCommentsBase
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
CauseCodeManufacturer assigned reason the part failed Optional 
CauseDescriptionDealer explanation of vehicle malfunction cause Optional 
ComplaintCodeCustomer complaint category Optional 
ComplaintDescriptionCustomer explanation of vehicle malfunction Optional 
CorrectionDescriptionDealer explanation of vehicle repair Optional 
TechnicianNotesFree form technician comments Optional 
MiscellaneousNotesFree form miscellaneous comments Optional 
JobDenialCodeDealer / Manufacturer defined code identifying the reason the customer denied service on a repair order line Optional 
JobDenialDescriptionText description of the reason a customer denied service on a repair order line Optional 

XML Instance Representation
<...>
<CauseCode> CauseCode </CauseCode> [0..1] ?
<CauseDescription> CauseDescription </CauseDescription> [0..1] ?
<ComplaintCode> ComplaintCode </ComplaintCode> [0..1] ?
<ComplaintDescription> ComplaintDescription </ComplaintDescription> [0..1] ?
<CorrectionDescription> CorrectionDescription </CorrectionDescription> [0..1] ?
<TechnicianNotes> TechnicianNotes </TechnicianNotes> [0..1] ?
<MiscellaneousNotes> MiscellaneousNotes </MiscellaneousNotes> [0..1] ?
<JobDenialCode> JobDenialCode </JobDenialCode> [0..1] ?
<JobDenialDescription> JobDenialDescription </JobDenialDescription> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="CodesAndCommentsBase">
<xsd:sequence>
<xsd:element name="CauseCode" type="CauseCode" minOccurs="0"/>
<xsd:element name="CauseDescription" type="CauseDescription" minOccurs="0"/>
<xsd:element name="ComplaintCode" type="ComplaintCode" minOccurs="0"/>
<xsd:element name="ComplaintDescription" type="ComplaintDescription" minOccurs="0"/>
<xsd:element name="CorrectionDescription" type="CorrectionDescription" minOccurs="0"/>
<xsd:element name="TechnicianNotes" type="TechnicianNotes" minOccurs="0"/>
<xsd:element name="MiscellaneousNotes" type="MiscellaneousNotes" minOccurs="0"/>
<xsd:element name="JobDenialCode" type="JobDenialCode" minOccurs="0"/>
<xsd:element name="JobDenialDescription" type="JobDenialDescription" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): CodesAndCommentsExpanded

Super-types:CodesAndCommentsBase < CodesAndCommentsExpanded (by extension)
Sub-types:None

NameCodesAndCommentsExpanded
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
CauseCodeManufacturer assigned reason the part failed Optional 
CauseDescriptionDealer explanation of vehicle malfunction cause Optional 
ComplaintCodeCustomer complaint category Optional 
ComplaintDescriptionCustomer explanation of vehicle malfunction Optional 
CorrectionDescriptionDealer explanation of vehicle repair Optional 
TechnicianNotesFree form technician comments Optional 
MiscellaneousNotesFree form miscellaneous comments Optional 
JobDenialCodeDealer / Manufacturer defined code identifying the reason the customer denied service on a repair order line Optional 
JobDenialDescriptionText description of the reason a customer denied service on a repair order line Optional 
ComplaintPriorityPriority from customer's view for specific complaint. Optional 
ComplaintCodeTypeType of problem as related to the CustomerComplaintCode. Optional 
VehicleConcernQuestionAnswerQuestions and Answers related to Service Appointment Optional 
DefectCodeManufacturer assigned code that defines failed component that caused the claim Optional 

XML Instance Representation
<...>
<CauseCode> CauseCode </CauseCode> [0..1] ?
<CauseDescription> CauseDescription </CauseDescription> [0..1] ?
<ComplaintCode> ComplaintCode </ComplaintCode> [0..1] ?
<ComplaintDescription> ComplaintDescription </ComplaintDescription> [0..1] ?
<CorrectionDescription> CorrectionDescription </CorrectionDescription> [0..1] ?
<TechnicianNotes> TechnicianNotes </TechnicianNotes> [0..1] ?
<MiscellaneousNotes> MiscellaneousNotes </MiscellaneousNotes> [0..1] ?
<JobDenialCode> JobDenialCode </JobDenialCode> [0..1] ?
<JobDenialDescription> JobDenialDescription </JobDenialDescription> [0..1] ?
<ComplaintPriority> ComplaintPriority </ComplaintPriority> [0..1] ?
<ComplaintCodeType> ComplaintCodeType </ComplaintCodeType> [0..1] ?
<VehicleConcernQuestionAnswer> VehicleConcernQuestionAnswer </VehicleConcernQuestionAnswer> [0..*] ?
<DefectCode> DefectCode </DefectCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="CodesAndCommentsExpanded">
<xsd:complexContent>
<xsd:extension base="CodesAndCommentsBase">
<xsd:sequence>
<xsd:element name="ComplaintPriority" type="ComplaintPriority" minOccurs="0"/>
<xsd:element name="ComplaintCodeType" type="ComplaintCodeType" minOccurs="0"/>
<xsd:element name="VehicleConcernQuestionAnswer" type="VehicleConcernQuestionAnswer" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="DefectCode" type="DefectCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): CodeType

Super-types:xsd:string < CodeType (by extension)
Sub-types:None

NameCodeType
Abstractno
DocumentationUnique code name
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
listID Optional 
listName Optional 
listAgencyID Optional 
listAgencyName Optional 
listVersionID Optional 
listURI Optional 

XML Instance Representation
<...
listID="xsd:token [0..1]"

listName="xsd:string [0..1]"

listAgencyID="xsd:token [0..1]"

listAgencyName="xsd:string [0..1]"

listVersionID="xsd:token [0..1]"

listURI="xsd:anyURI [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="CodeType">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="listID" type="xsd:token" use="optional"/>
<xsd:attribute name="listName" type="xsd:string" use="optional"/>
<xsd:attribute name="listAgencyID" type="xsd:token" use="optional"/>
<xsd:attribute name="listAgencyName" type="xsd:string" use="optional"/>
<xsd:attribute name="listVersionID" type="xsd:token" use="optional"/>
<xsd:attribute name="listURI" type="xsd:anyURI" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ComplaintDescription

Super-types:xsd:string < Description (by extension) < ComplaintDescription (by extension)
Sub-types:None

NameComplaintDescription
Abstractno
DocumentationCustomer explanation of vehicle malfunction
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="ComplaintDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ConfirmableVerb

Super-types:Verb < ConfirmableVerb (by extension)
Sub-types:

NameConfirmableVerb
Abstractno

Attributes

AttributeDescriptionRequirementBusiness Rules
confirm Required 

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
Verb Required 

XML Instance Representation
<...
confirm="ConfirmType [0..1]"
/>
Schema Component Representation
<xsd:complexType name="ConfirmableVerb">
<xsd:complexContent>
<xsd:extension base="Verb">
<xsd:attribute name="confirm" type="ConfirmType"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): ContactBase

Super-types:None
Sub-types:

NameContactBase
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
TelephoneContact telephone numbers Optional 
EMailAddressContact Email addresses Optional 
FaxContact Fax numbers Optional 
PreferredContactMethodPreferred contact method Optional 
ContactTimePreferred contact time (i.e. Best day/time to reach the contact. Optional 
PrimaryContactIndIndicates if contact is primary contact Optional 

XML Instance Representation
<...>
<Telephone> IndividualPartyContactTelephoneNumber </Telephone> [0..*] ?
<EMailAddress> IndividualPartyContactEMail </EMailAddress> [0..*] ?
<Fax> IndividualPartyContactFax </Fax> [0..*] ?
<PreferredContactMethod> PreferredContactMethod </PreferredContactMethod> [0..1] ?
<ContactTime> ContactTime </ContactTime> [0..1] ?
<PrimaryContactInd> PrimaryContactInd </PrimaryContactInd> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="ContactBase">
<xsd:sequence>
<xsd:element name="Telephone" type="IndividualPartyContactTelephoneNumber" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="EMailAddress" type="IndividualPartyContactEMail" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Fax" type="IndividualPartyContactFax" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="PreferredContactMethod" type="PreferredContactMethod" minOccurs="0"/>
<xsd:element name="ContactTime" type="ContactTime" minOccurs="0"/>
<xsd:element name="PrimaryContactInd" type="PrimaryContactInd" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): ContractDeductible

Super-types:xsd:decimal < Amount (by extension) < ContractDeductible (by extension)
Sub-types:None

NameContractDeductible
Abstractno
DocumentationAmount of Contract Deductible
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="ContractDeductible">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractId

Super-types:xsd:string < Id (by extension) < ContractId (by extension)
Sub-types:None

NameContractId
Abstractno
DocumentationIdentification of Contract
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="ContractId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractPlanDescription

Super-types:xsd:string < Description (by extension) < ContractPlanDescription (by extension)
Sub-types:None

NameContractPlanDescription
Abstractno
DocumentationDescription of contract plan. Example: 36 MONTH/36000 MILE"
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="ContractPlanDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractStartMileage

Super-types:xsd:integer < Count (by extension) < Mileage (by extension) < ContractStartMileage (by extension)
Sub-types:None

NameContractStartMileage
Abstractno
DocumentationOdometer reading when contract becomes effective
More information at: http://www.starstandard.org.

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="ContractStartMileage">
<xsd:simpleContent>
<xsd:extension base="Mileage"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ContractTermMileage

Super-types:xsd:integer < Count (by extension) < Mileage (by extension) < ContractTermMileage (by extension)
Sub-types:None

NameContractTermMileage
Abstractno
DocumentationMileage allowed under terms of contract
More information at: http://www.starstandard.org.

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="ContractTermMileage">
<xsd:simpleContent>
<xsd:extension base="Mileage"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CorrectionDescription

Super-types:xsd:string < Description (by extension) < CorrectionDescription (by extension)
Sub-types:None

NameCorrectionDescription
Abstractno
DocumentationDealer explanation of vehicle repair
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="CorrectionDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Count

Super-types:xsd:integer < Count (by extension)
Sub-types:None

NameCount
Abstractno
DocumentationSimple quantity type with no attributes
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:integer
</...>
Schema Component Representation
<xsd:complexType name="Count">
<xsd:simpleContent>
<xsd:extension base="xsd:integer"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Coupon

Super-types:None
Sub-types:None

NameCoupon
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
CouponIdIdentification of Coupon dealership service application Optional 
CouponDescriptionText identification of Coupon Optional 
CouponDiscountAmountCredit Price for coupons Optional 
CouponCommentComments associated with the coupon (e.g., Please rotate tire to front left). Optional 

XML Instance Representation
<...>
<CouponId> CouponId </CouponId> [0..1] ?
<CouponDescription> CouponDescription </CouponDescription> [0..1] ?
<CouponDiscountAmount> CouponDiscountAmount </CouponDiscountAmount> [0..1] ?
<CouponComment> CouponComment </CouponComment> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Coupon">
<xsd:sequence>
<xsd:element name="CouponId" type="CouponId" minOccurs="0"/>
<xsd:element name="CouponDescription" type="CouponDescription" minOccurs="0"/>
<xsd:element name="CouponDiscountAmount" type="CouponDiscountAmount" minOccurs="0"/>
<xsd:element name="CouponComment" type="CouponComment" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): CouponDescription

Super-types:xsd:string < Description (by extension) < CouponDescription (by extension)
Sub-types:None

NameCouponDescription
Abstractno
DocumentationText identification of Coupon
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="CouponDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CouponDiscountAmount

Super-types:xsd:decimal < Amount (by extension) < CouponDiscountAmount (by extension)
Sub-types:None

NameCouponDiscountAmount
Abstractno
DocumentationCredit Price for coupons
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="CouponDiscountAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CouponId

Super-types:xsd:string < Id (by extension) < CouponId (by extension)
Sub-types:None

NameCouponId
Abstractno
DocumentationIdentification of Coupon dealership service application
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="CouponId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): CustomerPaymentMethod

Super-types:None
Sub-types:None

NameCustomerPaymentMethod
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PaymentMethodIndicates the method of payment (e.g., cash, credit card, etc.) Optional 
AuthorizedAmountPreauthorized expense limit. Optional 

XML Instance Representation
<...>
<PaymentMethod> PaymentMethod </PaymentMethod> [0..1] ?
<AuthorizedAmount> AuthorizedAmount </AuthorizedAmount> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="CustomerPaymentMethod">
<xsd:sequence>
<xsd:element name="PaymentMethod" type="PaymentMethod" minOccurs="0"/>
<xsd:element name="AuthorizedAmount" type="AuthorizedAmount" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): DealerParty

Super-types:PartyBase < DealerPartyBase (by extension) < DealerParty (by extension)
Sub-types:None

NameDealerParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
DealerNameDealer name Optional 
DistrictCodeManufacturer Assigned District Code Optional 
URIDealer URI Optional 
ZoneCodeManufacturer Assigned Zone Code Optional 
AddressDealer party address Optional 
SalesContactDealer party contact information Optional 
SalesPersonNameName of Salesperson. Format for name should be "First Last" with no commas between first and last name Optional 
DepartmentTypeIdentifies the internal department Optional 
OrganizationIdMember Identification number of affiliate organization Optional 
OrganizationNameOrganizationName Optional 
SelectionMethodMethod used to select dealer Example: PF for preferred, PM for PMA, DI for distance, etc. Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<DealerName> DealerName </DealerName> [0..1] ?
<DistrictCode> DistrictCode </DistrictCode> [0..1] ?
<URI> URI </URI> [0..1] ?
<ZoneCode> ZoneCode </ZoneCode> [0..1] ?
<Address> OrganizationAddress </Address> [0..1] ?
<SalesContact> OrganizationContact </SalesContact> [0..1] ?
<SalesPersonName> SalesPersonName </SalesPersonName> [0..1] ?
<DepartmentType> DepartmentType </DepartmentType> [0..1] ?
<OrganizationId> OrganizationId </OrganizationId> [0..1] ?
<OrganizationName> OrganizationName </OrganizationName> [0..1] ?
<SelectionMethod> SelectionMethod </SelectionMethod> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="DealerParty">
<xsd:complexContent>
<xsd:extension base="DealerPartyBase">
<xsd:sequence>
<xsd:element name="Address" type="OrganizationAddress" minOccurs="0"/>
<xsd:element name="SalesContact" type="OrganizationContact" minOccurs="0"/>
<xsd:element name="SalesPersonName" type="SalesPersonName" minOccurs="0"/>
<xsd:element name="DepartmentType" type="DepartmentType" minOccurs="0"/>
<xsd:element name="OrganizationId" type="OrganizationId" minOccurs="0"/>
<xsd:element name="OrganizationName" type="OrganizationName" minOccurs="0"/>
<xsd:element name="SelectionMethod" type="SelectionMethod" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): DealerPartyBase

Super-types:PartyBase < DealerPartyBase (by extension)
Sub-types:

NameDealerPartyBase
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
DealerNameDealer name Optional 
DistrictCodeManufacturer Assigned District Code Optional 
URIDealer URI Optional 
ZoneCodeManufacturer Assigned Zone Code Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<DealerName> DealerName </DealerName> [0..1] ?
<DistrictCode> DistrictCode </DistrictCode> [0..1] ?
<URI> URI </URI> [0..1] ?
<ZoneCode> ZoneCode </ZoneCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="DealerPartyBase">
<xsd:complexContent>
<xsd:extension base="PartyBase">
<xsd:sequence>
<xsd:element name="DealerName" type="DealerName" minOccurs="0"/>
<xsd:element name="DistrictCode" type="DistrictCode" minOccurs="0"/>
<xsd:element name="URI" type="URI" minOccurs="0"/>
<xsd:element name="ZoneCode" type="ZoneCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): DeliveryMileage

Super-types:xsd:integer < Count (by extension) < Mileage (by extension) < DeliveryMileage (by extension)
Sub-types:None

NameDeliveryMileage
Abstractno
DocumentationOdometer reading of vehicle at time of delivery
More information at: http://www.starstandard.org.

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="DeliveryMileage">
<xsd:simpleContent>
<xsd:extension base="Mileage"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Description

Super-types:xsd:string < Description (by extension)
Sub-types:None

NameDescription
Abstractno
DocumentationDescription
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
languageThe ISO language code that the description is written. Optional 

XML Instance Representation
<...
language="Language [0..1] ?"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="Description">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="language" type="Language" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Destination

Super-types:None
Sub-types:None

NameDestination
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DestinationNameCodeCode 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
 
DestinationURIPhysical address of the destination Optional 
DestinationSoftwareCodeAdditional information about the destination application Optional 
DestinationSoftwareFor which software destination file is intended (may not be known). Optional 
DealerNumberTarget Dealer Code receiving information Optional 
StoreNumberDealer code store number (DMS assigned) Optional 
AreaNumberDealer code area number (DMS vendor assigned) Optional 
DealerCountryTarget Dealer country location Optional 
PartyIdThe 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 
LocationIdThe 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 
ServiceIdThe Service Id field identifies the particular service to which a message is being sent, e.g., an inventory service. Optional 

XML Instance Representation
<...>
<DestinationNameCode> ShortMfg </DestinationNameCode> [0..1] ?
<DestinationURI> URI </DestinationURI> [0..1] ?
<DestinationSoftwareCode> Text </DestinationSoftwareCode> [0..1] ?
<DestinationSoftware> Text </DestinationSoftware> [0..1] ?
<DealerNumber> PartyId </DealerNumber> [0..1] ?
<StoreNumber> Text </StoreNumber> [0..1] ?
<AreaNumber> Text </AreaNumber> [0..1] ?
<DealerCountry> Country </DealerCountry> [0..1] ?
<PartyId> PartyId </PartyId> [0..1] ?
<LocationId> LocationId </LocationId> [0..1] ?
<ServiceId> ServiceId </ServiceId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="Destination">
<xsd:sequence>
<xsd:element name="DestinationNameCode" type="ShortMfg" minOccurs="0"/>
<xsd:element name="DestinationURI" type="URI" minOccurs="0"/>
<xsd:element name="DestinationSoftwareCode" type="Text" minOccurs="0"/>
<xsd:element name="DestinationSoftware" type="Text" minOccurs="0"/>
<xsd:element name="DealerNumber" type="PartyId" minOccurs="0"/>
<xsd:element name="StoreNumber" type="Text" minOccurs="0"/>
<xsd:element name="AreaNumber" type="Text" minOccurs="0"/>
<xsd:element name="DealerCountry" type="Country" minOccurs="0"/>
<xsd:element name="PartyId" type="PartyId" minOccurs="0"/>
<xsd:element name="LocationId" type="LocationId" minOccurs="0"/>
<xsd:element name="ServiceId" type="ServiceId" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): DMSCustomerId

Super-types:xsd:string < Id (by extension) < DMSCustomerId (by extension)
Sub-types:None

NameDMSCustomerId
Abstractno
DocumentationThe DMS system assigned number associated with a customer entity
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="DMSCustomerId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): DocumentId

Super-types:xsd:string < Id (by extension) < DocumentId (by extension)
Sub-types:None

NameDocumentId
Abstractno
DocumentationIs the identifier for the document.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="DocumentId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): DoorsQuantity

Super-types:xsd:integer < Count (by extension) < DoorsQuantity (by restriction)
Sub-types:None

NameDoorsQuantity
Abstractno
DocumentationNumber of doors on vehicle
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="DoorsQuantity">
<xsd:simpleContent>
<xsd:restriction base="Count"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): EstimatedLaborHours

Super-types:xsd:decimal < Hours (by extension) < EstimatedLaborHours (by extension)
Sub-types:None

NameEstimatedLaborHours
Abstractno
DocumentationIndicates the estimated labor hours required to complete repair.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="EstimatedLaborHours">
<xsd:simpleContent>
<xsd:extension base="Hours"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): EstimatedPartsAmount

Super-types:xsd:decimal < Amount (by extension) < EstimatedPartsAmount (by extension)
Sub-types:None

NameEstimatedPartsAmount
Abstractno
DocumentationIndicates the estimated amount of parts required to complete repair.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="EstimatedPartsAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): EstimatedRepairAmount

Super-types:xsd:decimal < Amount (by extension) < EstimatedRepairAmount (by extension)
Sub-types:None

NameEstimatedRepairAmount
Abstractno
DocumentationIndicates estimated amount of repair.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="EstimatedRepairAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): FailureCodeDescription

Super-types:xsd:string < Description (by extension) < FailureCodeDescription (by extension)
Sub-types:None

NameFailureCodeDescription
Abstractno
DocumentationDescription of trouble failure code
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="FailureCodeDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): FailureCodes

Super-types:None
Sub-types:None

NameFailureCodes
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
FailureCodeManufacturer-assigned code to describe the reason that a fault or symptom occurred Optional 
FailureCodeDescriptionDescription of trouble failure code Optional 
FailureCodeURIURL address for graphical image of failure code Optional 

XML Instance Representation
<...>
<FailureCode> FailureCode </FailureCode> [0..1] ?
<FailureCodeDescription> FailureCodeDescription </FailureCodeDescription> [0..1] ?
<FailureCodeURI> FailureCodeURI </FailureCodeURI> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="FailureCodes">
<xsd:sequence>
<xsd:element name="FailureCode" type="FailureCode" minOccurs="0"/>
<xsd:element name="FailureCodeDescription" type="FailureCodeDescription" minOccurs="0"/>
<xsd:element name="FailureCodeURI" type="FailureCodeURI" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): FullServiceContract

Super-types:ServiceContractBase < FullServiceContract (by extension)
Sub-types:None

NameFullServiceContract
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ContractCompanyNameService contract company name Optional 
ContractIdIdentification of Service Contract Optional 
ContractPlanCodeService Contract Plan Code Optional 
ContractTypeService contract type and/or area of coverage Optional 
ContractPlanDescriptionDescription of service plan. Example: 36 MONTH/36000 MILE" Optional 
TermNumber of months in contract plan Optional 
ContractStartDateService Contract sale Date Optional 
ContractDeductibleAmount of Deductible at time of service Eg:$50.00 Optional 
ContractExpirationDateDate the Service contract expires Optional 
ContractStartMileageOdometer reading when contract becomes effective Optional 
ContractTermMileageMileage allowed under terms of service contract Optional 
ContractOwnerNameName on service Contract (i.e., full name - First Last) Optional 
InsuranceCompanyNameMemo Field for carrier covering extended service contract Optional 
TotalContractAmountTotal amount of the service contract. Optional 
ContractNoteFree form comments that relate to the contract Optional 
ContractEffectiveDateStart Date of Service Contract Optional 
ContractPlanStatesStates where the plan is valid Optional 
ContractTransferIndIndicates if the contract is transferable Optional 
ContractTransferredIndIndicates if the contract has been transferred Optional 
ContractTripInterruptIndIndicates if the contract allows for trip interruption Optional 
LoanerVehicleIndService contract loaner vehicle indicator Optional 
RoadsideAssistanceIndIndicates whether coverage includes roadside assistance Optional 
RoadHazardIndIndicates whether Roadside hazard is covered in the contract Optional 
FirstDayRentalIndIf first day rental for service is covered in contract Optional 
RentalAllowanceLimit for Rental Allowance per day Optional 
MaximumRentalAmountMax Rental Allowance per occurrence Optional 
TowingAllowanceAmount allowed for towing of RENTAL car Optional 

XML Instance Representation
<...>
<ContractCompanyName> ContractCompanyName </ContractCompanyName> [0..1] ?
<ContractId> ContractId </ContractId> [0..1] ?
<ContractPlanCode> ContractPlanCode </ContractPlanCode> [0..1] ?
<ContractType> ContractType </ContractType> [0..1] ?
<ContractPlanDescription> ContractPlanDescription </ContractPlanDescription> [0..1] ?
<Term> Term </Term> [0..1] ?
<ContractStartDate> ContractStartDate </ContractStartDate> [0..1] ?
<ContractDeductible> ContractDeductible </ContractDeductible> [0..1] ?
<ContractExpirationDate> ContractExpirationDate </ContractExpirationDate> [0..1] ?
<ContractStartMileage> ContractStartMileage </ContractStartMileage> [0..1] ?
<ContractTermMileage> ContractTermMileage </ContractTermMileage> [0..1] ?
<ContractOwnerName> ContractOwnerName </ContractOwnerName> [0..1] ?
<InsuranceCompanyName> InsuranceCompanyName </InsuranceCompanyName> [0..1] ?
<TotalContractAmount> TotalContractAmount </TotalContractAmount> [0..1] ?
<ContractNote> ContractNote </ContractNote> [0..1] ?
<ContractEffectiveDate> ContractEffectiveDate </ContractEffectiveDate> [0..1] ?
<ContractPlanStates> ContractPlanStates </ContractPlanStates> [0..*] ?
<ContractTransferInd> ContractTransferInd </ContractTransferInd> [0..1] ?
<ContractTransferredInd> ContractTransferredInd </ContractTransferredInd> [0..1] ?
<ContractTripInterruptInd> ContractTripInterruptInd </ContractTripInterruptInd> [0..1] ?
<LoanerVehicleInd> LoanerVehicleInd </LoanerVehicleInd> [0..1] ?
<RoadsideAssistanceInd> RoadsideAssistanceInd </RoadsideAssistanceInd> [0..1] ?
<RoadHazardInd> RoadHazardInd </RoadHazardInd> [0..1] ?
<FirstDayRentalInd> FirstDayRentalInd </FirstDayRentalInd> [0..1] ?
<RentalAllowance> RentalAllowance </RentalAllowance> [0..1] ?
<MaximumRentalAmount> MaximumRentalAmount </MaximumRentalAmount> [0..1] ?
<TowingAllowance> TowingAllowance </TowingAllowance> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="FullServiceContract">
<xsd:complexContent>
<xsd:extension base="ServiceContractBase">
<xsd:sequence>
<xsd:element name="ContractEffectiveDate" type="ContractEffectiveDate" minOccurs="0"/>
<xsd:element name="ContractPlanStates" type="ContractPlanStates" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="ContractTransferInd" type="ContractTransferInd" minOccurs="0"/>
<xsd:element name="ContractTransferredInd" type="ContractTransferredInd" minOccurs="0"/>
<xsd:element name="ContractTripInterruptInd" type="ContractTripInterruptInd" minOccurs="0"/>
<xsd:element name="LoanerVehicleInd" type="LoanerVehicleInd" minOccurs="0"/>
<xsd:element name="RoadsideAssistanceInd" type="RoadsideAssistanceInd" minOccurs="0"/>
<xsd:element name="RoadHazardInd" type="RoadHazardInd" minOccurs="0"/>
<xsd:element name="FirstDayRentalInd" type="FirstDayRentalInd" minOccurs="0"/>
<xsd:element name="RentalAllowance" type="RentalAllowance" minOccurs="0"/>
<xsd:element name="MaximumRentalAmount" type="MaximumRentalAmount" minOccurs="0"/>
<xsd:element name="TowingAllowance" type="TowingAllowance" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): HeaderBase

Super-types:None
Sub-types:

NameHeaderBase
Abstractno
DocumentationUsed on all STAR BODs
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
DocumentDateTimeIs the date and time the document was last created. This is not the date and time that the BOD message instance was created. Optional 
SecondaryPasswordSecondary password used to validate access to the dealer information Optional 
SecondaryDealerNumberIdentifies secondary dealer number if different than primary "Dealer Number" Optional 

XML Instance Representation
<...>
<DocumentDateTime> DocumentDateTime </DocumentDateTime> [0..1] ?
<SecondaryPassword> SecondaryPassword </SecondaryPassword> [0..1] ?
<SecondaryDealerNumber> SecondaryDealerNumber </SecondaryDealerNumber> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="HeaderBase">
<xsd:sequence>
<xsd:element name="DocumentDateTime" type="DocumentDateTime" minOccurs="0"/>
<xsd:element name="SecondaryPassword" type="SecondaryPassword" minOccurs="0"/>
<xsd:element name="SecondaryDealerNumber" type="SecondaryDealerNumber" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): HistoryVehicle

Super-types:Vehicle < VehicleBase (by extension) < HistoryVehicle (by extension)
Sub-types:None

NameHistoryVehicle
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
ModelManufacturer-assigned model code of vehicle - Usually available in the VIN number (use NCIC code) Optional 
ModelYearVehicle designated model year Optional 
ModelDescriptionDescriptive vehicle model name Optional 
MakeVehicle make code - Usually available in the VIN number (use NCIC code). Optional 
SaleClassClass of Sale Optional 
ConditionCondition of Vehicle - Example: Excellent, Good, Fair, Poor, Unknown Optional 
CertifiedPreownedIndIdentifies as a certified Pre-Owned Vehicle Optional 
VehicleNoteAny vehicle related notes Optional 
VINFederally defined 17 position vehicle identification number Optional 
DeliveryMileageOdometer reading of vehicle at time of delivery Optional 
VehicleStockDealer assigned vehicle stock number Optional 
TrimCodeManufacturer assigned trim code Optional 
DoorsQuantityNumber of doors on vehicle Optional 
BodyStyleManufacturer-assigned vehicle body style Optional 
InteriorColorVehicle Interior Color(s) Optional 
ExteriorColorVehicle Exterior Color(s) Optional 
TransmissionTypeVehicle Transmission type Optional 
OdometerStatusStatus of odometer at trade-in. Example:: Replaced, Tampered, Miles> 90,000, etc. Optional 
NonUSVehicleIndIndicates whether the vehicle was produced for the United States or not Optional 
VehicleDemoIndIndicates whether vehicle was ever a demo Optional 
LicenseNumberState License plate number of vehicle Optional 
BrandedInfoVehicle Branding Information Optional 
RestrictionIndIndication that vehicle has restrictions on its use Optional 
RestrictionDescriptionDescription of vehicle use restrictions Optional 
TelematicsServiceIndIndication whether Telematics Service Subscription is turned on Optional 
OptionService Vehicle Options Optional 
TransmissionCodeTransmission Serial Number Optional 
DeliveryDateThe date of original retail vehicle sale Optional 
EngineNumberSerial number of the engine if vehicle not made for US sale Optional 
IgnitionKeyNumberVehicle Ignition Key Number Optional 
AxleCodeThe code on the axle of the vehicle. Optional 
SoldAreaEmissionCodeThe code for the geographical Area that the unit is sold Optional 
VehicleOriginCountryThe country code where the unit was manufactured. Optional 
VehicleImageContains information about a vehicle graphical image. Optional 
InteriorColorCodeVehicle Interior color code. Optional 
ExteriorColorCodeVehicle Exterior color code. Optional 

XML Instance Representation
<...>
<Model> Model </Model> [0..1] ?
<ModelYear> ModelYear </ModelYear> [0..1] ?
<ModelDescription> ModelDescription </ModelDescription> [0..1] ?
<Make> Make </Make> [0..1] ?
<SaleClass> SaleClass </SaleClass> [0..1] ?
<Condition> Condition </Condition> [0..1] ?
<CertifiedPreownedInd> CertifiedPreownedInd </CertifiedPreownedInd> [0..1] ?
<VehicleNote> VehicleNote </VehicleNote> [0..*] ?
<VIN> VIN </VIN> [0..1] ?
<DeliveryMileage> DeliveryMileage </DeliveryMileage> [0..1] ?
<VehicleStock> VehicleStock </VehicleStock> [0..1] ?
<TrimCode> TrimCode </TrimCode> [0..1] ?
<DoorsQuantity> DoorsQuantity </DoorsQuantity> [0..1] ?
<BodyStyle> BodyStyle </BodyStyle> [0..1] ?
<InteriorColor> InteriorColor </InteriorColor> [0..*] ?
<ExteriorColor> ExteriorColor </ExteriorColor> [0..*] ?
<TransmissionType> TransmissionType </TransmissionType> [0..1] ?
<OdometerStatus> OdometerStatus </OdometerStatus> [0..1] ?
<NonUSVehicleInd> NonUSVehicleInd </NonUSVehicleInd> [0..1] ?
<VehicleDemoInd> VehicleDemoInd </VehicleDemoInd> [0..1] ?
<LicenseNumber> LicenseNumber </LicenseNumber> [0..1] ?
<BrandedInfo> BrandedInfo </BrandedInfo> [0..1] ?
<RestrictionInd> RestrictionInd </RestrictionInd> [0..1] ?
<RestrictionDescription> RestrictionDescription </RestrictionDescription> [0..1] ?
<TelematicsServiceInd> TelematicsServiceInd </TelematicsServiceInd> [0..1] ?
<Option> ServiceOption </Option> [0..*] ?
<TransmissionCode> TransmissionCode </TransmissionCode> [0..1] ?
<DeliveryDate> DeliveryDate </DeliveryDate> [0..1] ?
<EngineNumber> EngineNumber </EngineNumber> [0..1] ?
<IgnitionKeyNumber> IgnitionKeyNumber </IgnitionKeyNumber> [0..1] ?
<AxleCode> AxleCode </AxleCode> [0..1] ?
<SoldAreaEmissionCode> SoldAreaEmissionCode </SoldAreaEmissionCode> [0..1] ?
<VehicleOriginCountry> VehicleOriginCountry </VehicleOriginCountry> [0..1] ?
<VehicleImage> ImageAttachment </VehicleImage> [0..1] ?
<InteriorColorCode> InteriorColorCode </InteriorColorCode> [0..1] ?
<ExteriorColorCode> ExteriorColorCode </ExteriorColorCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="HistoryVehicle">
<xsd:complexContent>
<xsd:extension base="VehicleBase">
<xsd:sequence>
<xsd:element name="Option" type="ServiceOption" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="TransmissionCode" type="TransmissionCode" minOccurs="0"/>
<xsd:element name="DeliveryDate" type="DeliveryDate" minOccurs="0"/>
<xsd:element name="EngineNumber" type="EngineNumber" minOccurs="0"/>
<xsd:element name="IgnitionKeyNumber" type="IgnitionKeyNumber" minOccurs="0"/>
<xsd:element name="AxleCode" type="AxleCode" minOccurs="0"/>
<xsd:element name="SoldAreaEmissionCode" type="SoldAreaEmissionCode" minOccurs="0"/>
<xsd:element name="VehicleOriginCountry" type="VehicleOriginCountry" minOccurs="0"/>
<xsd:element name="VehicleImage" type="ImageAttachment" minOccurs="0"/>
<xsd:element name="InteriorColorCode" type="InteriorColorCode" minOccurs="0"/>
<xsd:element name="ExteriorColorCode" type="ExteriorColorCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): Hours

Super-types:xsd:decimal < Hours (by extension)
Sub-types:None

NameHours
Abstractno
DocumentationHours
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:decimal
</...>
Schema Component Representation
<xsd:complexType name="Hours">
<xsd:simpleContent>
<xsd:extension base="xsd:decimal"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Id

Super-types:xsd:string < Id (by extension)
Sub-types:None

NameId
Abstractno
DocumentationParty Identification number
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="Id">
<xsd:simpleContent>
<xsd:extension base="xsd:string"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ImageAttachment

Super-types:None
Sub-types:None

NameImageAttachment
Abstractno
Documentationrepresents information about the location of on-line vehicle photos.
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
URIURI Optional 
ImageWidthImage tag width. Example: "100" Optional 
ImageHeightImage tag height Example: "120" Optional 
ImageAlternateTextImage alternate text. Example: "1997 Honda Accord" Optional 

XML Instance Representation
<...>
<URI> URI </URI> [0..1] ?
<ImageWidth> ImageWidth </ImageWidth> [0..1] ?
<ImageHeight> ImageHeight </ImageHeight> [0..1] ?
<ImageAlternateText> ImageAlternateText </ImageAlternateText> [0..*] ?
</...>
Schema Component Representation
<xsd:complexType name="ImageAttachment">
<xsd:sequence>
<xsd:element name="URI" type="URI" minOccurs="0"/>
<xsd:element name="ImageWidth" type="ImageWidth" minOccurs="0"/>
<xsd:element name="ImageHeight" type="ImageHeight" minOccurs="0"/>
<xsd:element name="ImageAlternateText" type="ImageAlternateText" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): ImageHeight

Super-types:xsd:integer < Count (by extension) < ImageHeight (by restriction)
Sub-types:None

NameImageHeight
Abstractno
DocumentationImage tag height Example: "120"
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="ImageHeight">
<xsd:simpleContent>
<xsd:restriction base="Count"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): ImageWidth

Super-types:xsd:integer < Count (by extension) < ImageWidth (by restriction)
Sub-types:None

NameImageWidth
Abstractno
DocumentationImage tag width. Example: "100"
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="ImageWidth">
<xsd:simpleContent>
<xsd:restriction base="Count"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualOwnerParty

Super-types:PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension)
Sub-types:

NameIndividualOwnerParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 
ContactIndividual party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
<Contact> IndividualPartyContact </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualOwnerParty">
<xsd:complexContent>
<xsd:extension base="IndividualPartyBase">
<xsd:sequence>
<xsd:element name="Contact" type="IndividualPartyContact" minOccurs="0"/>
<xsd:element name="RelationshipCode" type="RelationshipCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualOwnerPartyExtended

Super-types:PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) < IndividualOwnerPartyExtended (by extension)
Sub-types:

NameIndividualOwnerPartyExtended
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 
ContactIndividual party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
DemographicsIndividual party demographic information Optional 
MarketingMailIndIndicates customers whom have requested no marketing mail Optional 
PrimaryDriverIndIdentifies customer as primary driver Optional 
DriverActionDriver action (Ex: Drop-Off, Pick-Up, etc) Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
<Contact> IndividualPartyContact </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
<Demographics> MinimalDemographics </Demographics> [0..1] ?
<MarketingMailInd> MarketingMailInd </MarketingMailInd> [0..1] ?
<PrimaryDriverInd> PrimaryDriverInd </PrimaryDriverInd> [0..1] ?
<DriverAction> DriverAction </DriverAction> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualOwnerPartyExtended">
<xsd:complexContent>
<xsd:extension base="IndividualOwnerParty">
<xsd:sequence>
<xsd:element name="Demographics" type="MinimalDemographics" minOccurs="0"/>
<xsd:element name="MarketingMailInd" type="MarketingMailInd" minOccurs="0"/>
<xsd:element name="PrimaryDriverInd" type="PrimaryDriverInd" minOccurs="0"/>
<xsd:element name="DriverAction" type="DriverAction" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualOwnerPartyExtendedSA

Super-types:PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) < IndividualOwnerPartyExtended (by extension) < IndividualOwnerPartyExtendedSA (by extension)
Sub-types:None

NameIndividualOwnerPartyExtendedSA
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 
ContactIndividual party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
DemographicsIndividual party demographic information Optional 
MarketingMailIndIndicates customers whom have requested no marketing mail Optional 
PrimaryDriverIndIdentifies customer as primary driver Optional 
DriverActionDriver action (Ex: Drop-Off, Pick-Up, etc) Optional 
DMSCustomerIdThe DMS system assigned number associated with a customer entity Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
<Contact> IndividualPartyContact </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
<Demographics> MinimalDemographics </Demographics> [0..1] ?
<MarketingMailInd> MarketingMailInd </MarketingMailInd> [0..1] ?
<PrimaryDriverInd> PrimaryDriverInd </PrimaryDriverInd> [0..1] ?
<DriverAction> DriverAction </DriverAction> [0..1] ?
<DMSCustomerId> DMSCustomerId </DMSCustomerId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualOwnerPartyExtendedSA">
<xsd:complexContent>
<xsd:extension base="IndividualOwnerPartyExtended">
<xsd:sequence>
<xsd:element name="DMSCustomerId" type="DMSCustomerId" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualOwnerPartySA

Super-types:PartyBase < IndividualPartyBase (by extension) < IndividualOwnerParty (by extension) < IndividualOwnerPartySA (by extension)
Sub-types:

NameIndividualOwnerPartySA
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 
ContactIndividual party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
DMSCustomerIdThe DMS system assigned number associated with a customer entity Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
<Contact> IndividualPartyContact </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
<DMSCustomerId> DMSCustomerId </DMSCustomerId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualOwnerPartySA">
<xsd:complexContent>
<xsd:extension base="IndividualOwnerParty">
<xsd:sequence>
<xsd:element name="DMSCustomerId" type="DMSCustomerId" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyAddress

Super-types:AddressBase < Address (by extension) < IndividualPartyAddress (by extension)
Sub-types:None

NameIndividualPartyAddress
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 
UrbanizationCodeGeographic definition of a metropolitan or suburban area Optional 

XML Instance Representation
<...
qualifier="AddressQualifier [0..1]"
>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
<UrbanizationCode> UrbanizationCode </UrbanizationCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyAddress">
<xsd:complexContent>
<xsd:extension base="Address">
<xsd:sequence>
<xsd:element name="UrbanizationCode" type="UrbanizationCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyAlternatePartyId

Super-types:AlternatePartyId < IndividualPartyAlternatePartyId (by extension)
Sub-types:None

NameIndividualPartyAlternatePartyId
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
IdAlternate Party Identification Required 
AssigningPartyIdAgency or entity that validates the Party Id Required 
IssuingStateIndicates that State where the license was issued. Optional 
ExpirationDateExpiration date of the alternate party id (e.g., Driver's License expiration date). Optional 

XML Instance Representation
<...>
<Id> Id </Id> [1] ?
<AssigningPartyId> AssigningPartyId </AssigningPartyId> [1] ?
<IssuingState> IssuingState </IssuingState> [0..1] ?
<ExpirationDate> ExpirationDate </ExpirationDate> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyAlternatePartyId">
<xsd:complexContent>
<xsd:extension base="AlternatePartyId">
<xsd:sequence>
<xsd:element name="AssigningPartyId" type="AssigningPartyId"/>
<xsd:element name="IssuingState" type="IssuingState" minOccurs="0"/>
<xsd:element name="ExpirationDate" type="ExpirationDate" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyBase

Super-types:PartyBase < IndividualPartyBase (by extension)
Sub-types:

NameIndividualPartyBase
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsIndividual party alternate party Identification Optional 
PersonNameIndividual party name Optional 
AddressIndividual party address Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> IndividualPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
<Address> IndividualPartyAddress </Address> [0..*] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyBase">
<xsd:complexContent>
<xsd:extension base="PartyBase">
<xsd:sequence>
<xsd:element name="AlternatePartyIds" type="IndividualPartyAlternatePartyId" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="PersonName" type="IndividualPartyPersonName" minOccurs="0"/>
<xsd:element name="Address" type="IndividualPartyAddress" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContact

Super-types:ContactBase < IndividualPartyContact (by extension)
Sub-types:None

NameIndividualPartyContact
Abstractno
DocumentationIndividual contact informaion
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
TelephoneContact telephone numbers Optional 
EMailAddressContact Email addresses Optional 
FaxContact Fax numbers Optional 
PreferredContactMethodPreferred contact method Optional 
ContactTimePreferred contact time (i.e. Best day/time to reach the contact. Optional 
PrimaryContactIndIndicates if contact is primary contact Optional 
PersonNameContact name Optional 

XML Instance Representation
<...>
<Telephone> IndividualPartyContactTelephoneNumber </Telephone> [0..*] ?
<EMailAddress> IndividualPartyContactEMail </EMailAddress> [0..*] ?
<Fax> IndividualPartyContactFax </Fax> [0..*] ?
<PreferredContactMethod> PreferredContactMethod </PreferredContactMethod> [0..1] ?
<ContactTime> ContactTime </ContactTime> [0..1] ?
<PrimaryContactInd> PrimaryContactInd </PrimaryContactInd> [0..1] ?
<PersonName> IndividualPartyPersonName </PersonName> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContact">
<xsd:complexContent>
<xsd:extension base="ContactBase">
<xsd:sequence>
<xsd:element name="PersonName" type="IndividualPartyPersonName" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContactEMail

Super-types:xsd:string < IndividualPartyContactEMail (by extension)
Sub-types:None

NameIndividualPartyContactEMail
Abstractno
DocumentationIndividual Party email
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
desc Required 

XML Instance Representation
<...
desc="HomeWork [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContactEMail">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="desc" type="HomeWork"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContactFax

Super-types:xsd:string < IndividualPartyContactFax (by extension)
Sub-types:None

NameIndividualPartyContactFax
Abstractno
DocumentationIndividual Party Fax number
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
desc Required 

XML Instance Representation
<...
desc="HomeWork [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContactFax">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="desc" type="HomeWork"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyContactTelephoneNumber

Super-types:xsd:string < IndividualPartyContactTelephoneNumber (by extension)
Sub-types:None

NameIndividualPartyContactTelephoneNumber
Abstractno
DocumentationIndividualParty telephone number
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
desc Required 
exten Required 

XML Instance Representation
<...

exten="Note [0..1]"
>
xsd:string
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyContactTelephoneNumber">
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="desc" type="ContactTelephoneNumberDescription"/>
<xsd:attribute name="exten" type="Note"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): IndividualPartyPersonName

Super-types:None
Sub-types:None

NameIndividualPartyPersonName
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
SalutationTitle or greeting of business party Optional 
GivenNameFirst Name of business party Required 
MiddleNameMiddle Initial of business party Optional 
FamilyNameLast Name of business party Required 
SuffixBusiness Party name suffix designation if individual Ex: Sr, Jr, III, etc. Optional 
FormattedNameFull Name of business party. Format for name should be "First Last" with no commas between first and last name Optional 
SortNameIndex name used as a sort for report purposes Optional 

XML Instance Representation
<...>
<Salutation> Salutation </Salutation> [0..1] ?
<GivenName> GivenName </GivenName> [1] ?
<MiddleName> MiddleName </MiddleName> [0..1] ?
<FamilyName> FamilyName </FamilyName> [1] ?
<Suffix> Suffix </Suffix> [0..1] ?
<FormattedName> FormattedName </FormattedName> [0..1] ?
<SortName> SortName </SortName> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="IndividualPartyPersonName">
<xsd:sequence>
<xsd:element name="Salutation" type="Salutation" minOccurs="0"/>
<xsd:element name="GivenName" type="GivenName"/>
<xsd:element name="MiddleName" type="MiddleName" minOccurs="0"/>
<xsd:element name="FamilyName" type="FamilyName"/>
<xsd:element name="Suffix" type="Suffix" minOccurs="0"/>
<xsd:element name="FormattedName" type="FormattedName" minOccurs="0"/>
<xsd:element name="SortName" type="SortName" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): JobDenialDescription

Super-types:xsd:string < Description (by extension) < JobDenialDescription (by extension)
Sub-types:None

NameJobDenialDescription
Abstractno
DocumentationText description of the reason a customer denied service on a repair order line
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="JobDenialDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): LaborAllowanceHours

Super-types:xsd:decimal < Hours (by extension) < LaborAllowanceHours (by extension)
Sub-types:None

NameLaborAllowanceHours
Abstractno
DocumentationFlat rate labor hour allowance for this operation
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="LaborAllowanceHours">
<xsd:simpleContent>
<xsd:extension base="Hours"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): LaborNarrative

Super-types:None
Sub-types:None

NameLaborNarrative
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
NarrativeTypeDefines the Type of Labor Narrative/Comment like 'RL' - Recall comment, 'ML' etc., Optional 
NarrativeLabor Comment/Narrative can occur multiple times for each Labor depending on LaborNarrative type Optional 

XML Instance Representation
<...>
<NarrativeType> NarrativeType </NarrativeType> [0..1] ?
<Narrative> Narrative </Narrative> [0..*] ?
</...>
Schema Component Representation
<xsd:complexType name="LaborNarrative">
<xsd:sequence>
<xsd:element name="NarrativeType" type="NarrativeType" minOccurs="0"/>
<xsd:element name="Narrative" type="Narrative" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): LaborOperationDescription

Super-types:xsd:string < Description (by extension) < LaborOperationDescription (by extension)
Sub-types:None

NameLaborOperationDescription
Abstractno
DocumentationDescription of a particular operation code
More information at: http://www.starstandard.org.

XML Instance Representation
<...
language="Language [0..1] ?"
>
</...>
Schema Component Representation
<xsd:complexType name="LaborOperationDescription">
<xsd:simpleContent>
<xsd:extension base="Description"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): LaborOperationId

Super-types:xsd:string < Id (by extension) < LaborOperationId (by extension)
Sub-types:None

NameLaborOperationId
Abstractno
DocumentationCurrently assigned code for this operation (preferably manufacturer code)
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="LaborOperationId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): LocationId

Super-types:xsd:string < Id (by extension) < LocationId (by extension)
Sub-types:None

NameLocationId
Abstractno
DocumentationCode identifying a physical location
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
Id
</...>
Schema Component Representation
<xsd:complexType name="LocationId">
<xsd:simpleContent>
<xsd:extension base="Id"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): MaximumRentalAmount

Super-types:xsd:decimal < Amount (by extension) < MaximumRentalAmount (by extension)
Sub-types:None

NameMaximumRentalAmount
Abstractno
DocumentationMax Rental Allowance per occurrence
More information at: http://www.starstandard.org.

XML Instance Representation
<...
currency="Currency [1]"
>
</...>
Schema Component Representation
<xsd:complexType name="MaximumRentalAmount">
<xsd:simpleContent>
<xsd:extension base="Amount"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): Mileage

Super-types:xsd:integer < Count (by extension) < Mileage (by extension)
Sub-types:None

NameMileage
Abstractno
DocumentationMileage definition
More information at: http://www.starstandard.org.

Attributes

AttributeDescriptionRequirementBusiness Rules
uom Optional 

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="Mileage">
<xsd:simpleContent>
<xsd:extension base="Count">
<xsd:attribute name="uom" type="MileageMeasure" use="optional"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): MileageIn

Super-types:xsd:integer < Count (by extension) < Mileage (by extension) < MileageIn (by extension)
Sub-types:None

NameMileageIn
Abstractno
DocumentationOdometer reading of vehicle when repair order was opened
More information at: http://www.starstandard.org.

XML Instance Representation
<...
uom="MileageMeasure [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="MileageIn">
<xsd:simpleContent>
<xsd:extension base="Mileage"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): MinimalDemographics

Super-types:None
Sub-types:None

NameMinimalDemographics
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
GenderGender of party Optional 
LanguageBusiness party native language Optional 
BirthDateBirth date of party Optional 

XML Instance Representation
<...>
<Gender> Gender </Gender> [0..1] ?
<Language> Language </Language> [0..1] ?
<BirthDate> BirthDate </BirthDate> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="MinimalDemographics">
<xsd:sequence>
<xsd:element name="Gender" type="Gender" minOccurs="0"/>
<xsd:element name="Language" type="Language" minOccurs="0"/>
<xsd:element name="BirthDate" type="BirthDate" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): NumberOfDays

Super-types:xsd:integer < Count (by extension) < NumberOfDays (by restriction)
Sub-types:None

NameNumberOfDays
Abstractno
DocumentationThe number of days from the Payment Term date by which payment is expected.
More information at: http://www.starstandard.org.

XML Instance Representation
<...>
</...>
Schema Component Representation
<xsd:complexType name="NumberOfDays">
<xsd:simpleContent>
<xsd:restriction base="Count"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OptionBase

Super-types:None
Sub-types:

NameOptionBase
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
OptionTypeAn option type for a vehicle or other component. Usually references an OEM supplied list of codes. Optional 
OptionNameName of vehicle option Optional 
OptionStockNumberStock Number of Vehicle Option Optional 
ManufacturerManufacturer of Vehicle Option Optional 

XML Instance Representation
<...>
<OptionType> OptionType </OptionType> [0..1] ?
<OptionName> OptionName </OptionName> [0..1] ?
<OptionStockNumber> OptionStockNumber </OptionStockNumber> [0..1] ?
<Manufacturer> Manufacturer </Manufacturer> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OptionBase">
<xsd:sequence>
<xsd:element name="OptionType" type="OptionType" minOccurs="0"/>
<xsd:element name="OptionName" type="OptionName" minOccurs="0"/>
<xsd:element name="OptionStockNumber" type="OptionStockNumber" minOccurs="0"/>
<xsd:element name="Manufacturer" type="Manufacturer" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): OptionType

Super-types:xsd:string < CodeType (by extension) < OptionType (by extension)
Sub-types:None

NameOptionType
Abstractno
DocumentationOption Type from an OEM or other sources list of codes.
More information at: http://www.starstandard.org.

XML Instance Representation
<...
listID="xsd:token [0..1]"

listName="xsd:string [0..1]"

listAgencyID="xsd:token [0..1]"

listAgencyName="xsd:string [0..1]"

listVersionID="xsd:token [0..1]"

listURI="xsd:anyURI [0..1]"
>
</...>
Schema Component Representation
<xsd:complexType name="OptionType">
<xsd:simpleContent>
<xsd:extension base="CodeType"/>
</xsd:simpleContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationAddress

Super-types:AddressBase < OrganizationAddress (by extension)
Sub-types:None

NameOrganizationAddress
Abstractno
DocumentationBasic address used for organizations
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
AddressLineIndicates the multiple lines of an address. The first line is typically the street name and number. Required 
CityIs the City of the Address. Required 
CountyCounty in which the Address is in. Optional 
StateOrProvinceIs the State or Province of a given Address. Required 
CountryCountry in which the Address is in. Required 
PostalCodePostal Code of the Address. Required 
UrbanizationCodeGeographic definition of a metropolitan or suburban area Optional 

XML Instance Representation
<...>
<AddressLine> AddressLine </AddressLine> [1..*] ?
<City> City </City> [1] ?
<County> County </County> [0..1] ?
<StateOrProvince> StateOrProvince </StateOrProvince> [1] ?
<Country> Country </Country> [1] ?
<PostalCode> PostalCode </PostalCode> [1] ?
<UrbanizationCode> UrbanizationCode </UrbanizationCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationAddress">
<xsd:complexContent>
<xsd:extension base="AddressBase">
<xsd:sequence>
<xsd:element name="UrbanizationCode" type="UrbanizationCode" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationalOwnerParty

Super-types:PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty (by extension)
Sub-types:

NameOrganizationalOwnerParty
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsAlternate organizational party Identification Optional 
NameCompany name of organizational party Optional 
AddressOrganizational Party address Optional 
DBANameDoing Business As name. Optional 
ContactOrganizational Party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> OrganizationalPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<Name> CompanyName </Name> [0..1] ?
<Address> OrganizationAddress </Address> [0..1] ?
<DBAName> DBAName </DBAName> [0..1] ?
<Contact> OrganizationContactExtended </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationalOwnerParty">
<xsd:complexContent>
<xsd:extension base="OrganizationPartyBase">
<xsd:sequence>
<xsd:element name="Contact" type="OrganizationContactExtended" minOccurs="0"/>
<xsd:element name="RelationshipCode" type="RelationshipCode" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationalOwnerPartyExtended

Super-types:PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty (by extension) < OrganizationalOwnerPartyExtended (by extension)
Sub-types:

NameOrganizationalOwnerPartyExtended
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsAlternate organizational party Identification Optional 
NameCompany name of organizational party Optional 
AddressOrganizational Party address Optional 
DBANameDoing Business As name. Optional 
ContactOrganizational Party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
MarketingMailIndIndicates customers whom have requested no marketing mail Optional 
PrimaryDriverIndIdentifies customer as primary driver Optional 
DriverActionDriver action (Ex: Drop-Off, Pick-Up, etc) Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> OrganizationalPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<Name> CompanyName </Name> [0..1] ?
<Address> OrganizationAddress </Address> [0..1] ?
<DBAName> DBAName </DBAName> [0..1] ?
<Contact> OrganizationContactExtended </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
<MarketingMailInd> MarketingMailInd </MarketingMailInd> [0..1] ?
<PrimaryDriverInd> PrimaryDriverInd </PrimaryDriverInd> [0..1] ?
<DriverAction> DriverAction </DriverAction> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationalOwnerPartyExtended">
<xsd:complexContent>
<xsd:extension base="OrganizationalOwnerParty">
<xsd:sequence>
<xsd:element name="MarketingMailInd" type="MarketingMailInd" minOccurs="0"/>
<xsd:element name="PrimaryDriverInd" type="PrimaryDriverInd" minOccurs="0"/>
<xsd:element name="DriverAction" type="DriverAction" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationalOwnerPartyExtendedSA

Super-types:PartyBase < OrganizationPartyBase (by extension) < OrganizationalOwnerParty (by extension) < OrganizationalOwnerPartyExtended (by extension) < OrganizationalOwnerPartyExtendedSA (by extension)
Sub-types:None

NameOrganizationalOwnerPartyExtendedSA
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PartyIdParty Identification Number Optional 
AlternatePartyIdsAlternate organizational party Identification Optional 
NameCompany name of organizational party Optional 
AddressOrganizational Party address Optional 
DBANameDoing Business As name. Optional 
ContactOrganizational Party contact information Optional 
RelationshipCodeIndicates the Business Party√ƒ¬Ę¬€¬™s relationship to the primary Party (e.g., mother, father, husband, etc.)l Optional 
MarketingMailIndIndicates customers whom have requested no marketing mail Optional 
PrimaryDriverIndIdentifies customer as primary driver Optional 
DriverActionDriver action (Ex: Drop-Off, Pick-Up, etc) Optional 
DMSCustomerIdThe DMS system assigned number associated with a customer entity Optional 

XML Instance Representation
<...>
<PartyId> PartyId </PartyId> [0..1] ?
<AlternatePartyIds> OrganizationalPartyAlternatePartyId </AlternatePartyIds> [0..*] ?
<Name> CompanyName </Name> [0..1] ?
<Address> OrganizationAddress </Address> [0..1] ?
<DBAName> DBAName </DBAName> [0..1] ?
<Contact> OrganizationContactExtended </Contact> [0..1] ?
<RelationshipCode> RelationshipCode </RelationshipCode> [0..1] ?
<MarketingMailInd> MarketingMailInd </MarketingMailInd> [0..1] ?
<PrimaryDriverInd> PrimaryDriverInd </PrimaryDriverInd> [0..1] ?
<DriverAction> DriverAction </DriverAction> [0..1] ?
<DMSCustomerId> DMSCustomerId </DMSCustomerId> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationalOwnerPartyExtendedSA">
<xsd:complexContent>
<xsd:extension base="OrganizationalOwnerPartyExtended">
<xsd:sequence>
<xsd:element name="DMSCustomerId" type="DMSCustomerId" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationalPartyAlternatePartyId

Super-types:AlternatePartyId < OrganizationalPartyAlternatePartyId (by extension)
Sub-types:None

NameOrganizationalPartyAlternatePartyId
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
IdAlternate Party Identification Required 
AssigningPartyIdAgency or entity that validates the Party Id Required 
IssuingStateIndicates that State where the license was issued. Optional 
ExpirationDateExpiration date of the alternate party id (e.g., Driver's License expiration date). Optional 

XML Instance Representation
<...>
<Id> Id </Id> [1] ?
<AssigningPartyId> AssigningOrganizationPartyId </AssigningPartyId> [1] ?
<IssuingState> IssuingState </IssuingState> [0..1] ?
<ExpirationDate> ExpirationDate </ExpirationDate> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationalPartyAlternatePartyId">
<xsd:complexContent>
<xsd:extension base="AlternatePartyId">
<xsd:sequence>
<xsd:element name="AssigningPartyId" type="AssigningOrganizationPartyId"/>
<xsd:element name="IssuingState" type="IssuingState" minOccurs="0"/>
<xsd:element name="ExpirationDate" type="ExpirationDate" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationContact

Super-types:None
Sub-types:

NameOrganizationContact
Abstractno
Documentation More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PersonNameContact name Optional 
TelephoneContact telephone numbers Optional
If the address has a North American country code, the telephone number must be a minimum of 10 numbers.
(INACTIVE)
 
EMailAddressContact Email address Optional
Should conform to the Internet message format as set forth by RFC 8822.
 
FaxContact Fax number Optional
If the address has a North American country code, the telephone number must be a minimum of 10 numbers.
(INACTIVE)
 
PreferredContactMethodPreferred contact method Optional 
ContactTimePreferred contact time (i.e. Best day/time to reach the contact. Optional 

XML Instance Representation
<...>
<PersonName> OrganizationContactPersonName </PersonName> [0..1] ?
<Telephone> OrganizationPartyTelephone </Telephone> [0..*] ?
<EMailAddress> OrganizationPartyEmail </EMailAddress> [0..*] ?
<Fax> OrganizationPartyFax </Fax> [0..*] ?
<PreferredContactMethod> PreferredContactMethodOrganization </PreferredContactMethod> [0..1] ?
<ContactTime> ContactTime </ContactTime> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationContact">
<xsd:sequence>
<xsd:element name="PersonName" type="OrganizationContactPersonName" minOccurs="0"/>
<xsd:element name="Telephone" type="OrganizationPartyTelephone" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="EMailAddress" type="OrganizationPartyEmail" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Fax" type="OrganizationPartyFax" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="PreferredContactMethod" type="PreferredContactMethodOrganization" minOccurs="0"/>
<xsd:element name="ContactTime" type="ContactTime" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Components (Complex Type): OrganizationContactExtended

Super-types:OrganizationContact < OrganizationContactExtended (by extension)
Sub-types:None

NameOrganizationContactExtended
Abstractno

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
PersonNameContact name Optional 
TelephoneContact telephone numbers Optional
If the address has a North American country code, the telephone number must be a minimum of 10 numbers.
(INACTIVE)
 
EMailAddressContact Email address Optional
Should conform to the Internet message format as set forth by RFC 8822.
 
FaxContact Fax number Optional
If the address has a North American country code, the telephone number must be a minimum of 10 numbers.
(INACTIVE)
 
PreferredContactMethodPreferred contact method Optional 
ContactTimePreferred contact time (i.e. Best day/time to reach the contact. Optional 
PreferredLanguageOrganization's preferred language Optional 

XML Instance Representation
<...>
<PersonName> OrganizationContactPersonName </PersonName> [0..1] ?
<Telephone> OrganizationPartyTelephone </Telephone> [0..*] ?
<EMailAddress> OrganizationPartyEmail </EMailAddress> [0..*] ?
<Fax> OrganizationPartyFax </Fax> [0..*] ?
<PreferredContactMethod> PreferredContactMethodOrganization </PreferredContactMethod> [0..1] ?
<ContactTime> ContactTime </ContactTime> [0..1] ?
<PreferredLanguage> PreferredLanguage </PreferredLanguage> [0..1] ?
</...>
Schema Component Representation
<xsd:complexType name="OrganizationContactExtended">
<xsd:complexContent>
<xsd:extension base="OrganizationContact">
<xsd:sequence>
<xsd:element name="PreferredLanguage" type="PreferredLanguage" minOccurs="0"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
top

Components (Complex Type): OrganizationContactPersonName

Super-types:None
Sub-types:None

NameOrganizationContactPersonName
Abstractno
DocumentationDerived from oa:PersonName
More information at: http://www.starstandard.org.

Data Elements and Components

Field/ComponentDescriptionRequirementBusiness Rules
GivenNameFirst Name of business party Required 
FamilyNameLast Name of business party Required 
FormattedNameFull Name of business party. Format for name should be "First Last" with no commas between first and last name Optional 

XML Instance Representation
<...>
<GivenName> Name </GivenName> [1] ?
<FamilyName> Name </FamilyName> [1] ?
<FormattedName> Name </FormattedName> [0..1] ?
</...>
Schema Component Repres