Uses the Component:ServiceAppointmentHeaderType
Service Appointment Header
Table 6.2. Fields and Components
| Name | Description | Occurrence | Type | Data Type | User Notes |
|---|---|---|---|---|---|
| DocumentDateTime |
Is the date and time the document was last created. This is not the date and time that the BOD message instance was created. | 0..1 | Field | udt:DateTimeType | |
| SecondaryPassword |
Secondary password used to validate access to the dealer information | 0..1 | Field | udt:TextType | |
| SecondaryDealerNumberID |
Identifies secondary dealer number if different than primary "Dealer Number" | 0..1 | Field | udt:IdentifierType | |
| DocumentIdentificationGroup |
A group of identifications that uniquely identifies this document | 1..1 | Component | DocumentIdentificationGroupType | |
| AccountGroupCode |
Code that identifies the manufacturer for pricing. | 0..1 | Field | udt:CodeType | |
| ServiceHistoryPermissionApprovalIndicator |
Indicates that the customer approved the sharing of any known previous service for this VIN to the Service Dealership where the appointment is being requested. | 0..1 | Field | udt:IndicatorType | |
| DealerParty |
Represents a Dealer | 0..1 | Component | PartyABIEType | |
| ProviderParty |
The party that provides a lead. | 0..1 | Component | PartyABIEType | |
| AppointmentContactParty |
The party to contact in regards to a service appointment. | 0..1 | Component | PartyABIEType | |
| OwnerParty |
The owner of a vehicle, boat, engine, truck, trailer, or other item. | 0..* | Component | PartyABIEType | |
| Co-OwnerParty |
The co-owner of a veheicle, boat, engine, truck, trailer, or other item. | 0..1 | Component | PartyABIEType | |
| PrimaryDriver |
The Primary Driver of a vehicle, boat, or other transportation item. | 0..1 | Component | PrimaryDriverType | |
| SecondaryPrimaryDriver |
The Secondary Primary Driver of a vehicle, boat, or other transportation item. | 0..* | Component | PrimaryDriverType | |
| ServiceAppointmentVehicleLineItem |
Detail information regarding a vehicle for a particular service appointment. | 0..1 | Component | ServiceAppointmentVehicleLineItemType | |
| Warranty |
Warranty information associated with a vehicle. | 0..* | Component | WarrantyType | |
| ServiceContract |
The ServiceContract component represents information about the extended service agreement on the vehicle. | 0..* | Component | ServiceContractType | |
| ServiceAppointmentPriorityCode |
A code list that describes the priority of the service appointment.For example: "Customer Waiting". | 0..1 | Field | udt:CodeType | |
| DateAppointmentInitiated |
The date the Customer contacted the service location to schedule an appointment. | 0..1 | Field | udt:DateTimeType | |
| ServiceScheduleStartDateTime |
The start date and time of the service schedule. | 0..1 | Field | udt:DateTimeType | |
| ServiceScheduleDuration |
The duration of the service schedule. | 0..1 | Field | sqdt:TimeMeasureType |
The XML Sample provided here is an approximation of the generated XML for this component. Not all of the fields are required for implementation.
Example 6.2. ServiceAppointmentHeader
<ServiceAppointmentHeader>
<DocumentDateTime>......</DocumentDateTime> [0..1]
<SecondaryPassword>......</SecondaryPassword> [0..1]
<SecondaryDealerNumberID>......</SecondaryDealerNumberID> [0..1]
<DocumentIdentificationGroup>......</DocumentIdentificationGroup> [1..1]
<AccountGroupCode>......</AccountGroupCode> [0..1]
<ServiceHistoryPermissionApprovalIndicator>......</ServiceHistoryPermissionApprovalIndicator> [0..1]
<DealerParty>......</DealerParty> [0..1]
<ProviderParty>......</ProviderParty> [0..1]
<AppointmentContactParty>......</AppointmentContactParty> [0..1]
<OwnerParty>......</OwnerParty> [0..*]
<Co-OwnerParty>......</Co-OwnerParty> [0..1]
<PrimaryDriver>......</PrimaryDriver> [0..1]
<SecondaryPrimaryDriver>......</SecondaryPrimaryDriver> [0..*]
<ServiceAppointmentVehicleLineItem>......</ServiceAppointmentVehicleLineItem> [0..1]
<Warranty>......</Warranty> [0..*]
<ServiceContract>......</ServiceContract> [0..*]
<ServiceAppointmentPriorityCode>......</ServiceAppointmentPriorityCode> [0..1]
<DateAppointmentInitiated>......</DateAppointmentInitiated> [0..1]
<ServiceScheduleStartDateTime>......</ServiceScheduleStartDateTime> [0..1]
<ServiceScheduleDuration>......</ServiceScheduleDuration> [0..1]
</ServiceAppointmentHeader>