Uses the Component:ServiceAppointmentExtendedType
The Appointment component represents information about an appointment such as service appointment including appointment date, appointment time, etc.
Table 6.104. Fields and Components
| Name | Description | Occurrence | Type | Data Type | User Notes |
|---|---|---|---|---|---|
| AppointmentDateTime |
Date and time of the appointment | 0..1 | Field | udt:DateTimeType | |
| AppointmentLocation |
Location of the appointment... For example: Office; Home | 0..1 | Field | udt:TextType | |
| AppointmentNotes |
Comments that relate to the appointment. | 0..1 | Field | udt:TextType | |
| RequestedConsultantName |
The name of the consultant with whom the consumer indicated they would like to work. | 0..1 | Field | udt:NameType | |
| DayOfWeekCode |
The DaysOfWeek component is used to identify availability based on days of the week. | 0..1 | Field | sqdt:DayOfWeekCodeType | |
| LeadSourceCode |
Source that brought the lead to the dealership. | 0..1 | Field | udt:CodeType | |
| AppointmentConfirmationRequestIndicator |
Indicates that the customer has requested to be notified that the appointment date and time was confirmed. | 0..1 | Field | udt:IndicatorType | |
| AppointmentConfirmationCode |
Code confirming appointment | 0..1 | Field | udt:CodeType | |
| AppointmentStatus |
Notes the status of the appointment (e.g, in progress). | 0..1 | Field | udt:TextType | |
| AlternateTransportation |
Free form text indicating customer's requirement or transportation while the vehilce is in service (i.e., concierge service, shuttle, rental car, waiting room, etc.). | 0..1 | Field | udt:TextType | |
| AppointmentMethod |
Free form text indicating the method used to make appointment (e.g., Web, Walk-in, etc.). | 0..1 | Field | udt:TextType | |
| EndAppointmentDateTime |
Earliest possible pick up date and time for appointment. | 0..1 | Field | udt:DateTimeType | |
| AlternateAppointmentDateTime |
Identifies alternate appointment date and time. | 0..1 | Field | udt:DateTimeType | |
| DesiredPickupDateTime |
Identifies the customer's desired pickup date and time. | 0..1 | Field | udt:DateTimeType | |
| DropOffDateTime |
Identifies the time the vehicle will be dropped off for service. | 0..1 | Field | udt:DateTimeType | |
| OpenAppointmentDateTime |
Identifies available appointment dates and times. | 0..* | Field | udt:DateTimeType | |
| NumberOfDaysNumeric | 0..1 | Field | udt:NumericType | ||
| EstimatedRepairAmount |
Indicates estimated amount of repair. | 0..1 | Field | udt:AmountType | |
| EstimatedLaborHoursNumeric |
Indicates the estimated labor hours required to complete repair. | 0..1 | Field | udt:NumericType | |
| EstimatedPartsAmount |
Indicates the estimated amount of parts required to complete repair. | 0..1 | Field | udt:AmountType | |
| RequestedService |
Communicates the type of service to be performed during the service appointment. | 0..* | Component | RequestedServiceType | |
| ServiceAdvisorParty |
Represents the Service Advisor for the Service Appointment | 0..1 | Component | PartyABIEType | |
| RequestedAppointmentPeriod |
The periods that an appointment has been requested. This can include the start date and end dates. | 0..* | Component | PeriodABIEType | |
| AppointmentType |
Type of the appointment. Main reason for the customer scheduling the appointment.Maintenance, Customer pay Repair, Warranty repair, Safety Recall, Service Campaign, Body Shop Repair | 0..1 | Field | udt:TextType | |
| LeadID |
The Service Lead that lead associated with this booked service | 0..1 | Field | udt:IdentifierType | |
| EstimatedMileage |
Estimated vehicle mileage by the date of the appointment. | 0..1 | Field | sqdt:LengthMeasureType | |
| EstimatedEngineHours |
Estimated engine hours by the date of the appointment. | 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.104. Appointment
<Appointment>
<AppointmentDateTime>......</AppointmentDateTime> [0..1]
<AppointmentLocation>......</AppointmentLocation> [0..1]
<AppointmentNotes>......</AppointmentNotes> [0..1]
<RequestedConsultantName>......</RequestedConsultantName> [0..1]
<DayOfWeekCode>......</DayOfWeekCode> [0..1]
<LeadSourceCode>......</LeadSourceCode> [0..1]
<AppointmentConfirmationRequestIndicator>......</AppointmentConfirmationRequestIndicator> [0..1]
<AppointmentConfirmationCode>......</AppointmentConfirmationCode> [0..1]
<AppointmentStatus>......</AppointmentStatus> [0..1]
<AlternateTransportation>......</AlternateTransportation> [0..1]
<AppointmentMethod>......</AppointmentMethod> [0..1]
<EndAppointmentDateTime>......</EndAppointmentDateTime> [0..1]
<AlternateAppointmentDateTime>......</AlternateAppointmentDateTime> [0..1]
<DesiredPickupDateTime>......</DesiredPickupDateTime> [0..1]
<DropOffDateTime>......</DropOffDateTime> [0..1]
<OpenAppointmentDateTime>......</OpenAppointmentDateTime> [0..*]
<NumberOfDaysNumeric>......</NumberOfDaysNumeric> [0..1]
<EstimatedRepairAmount>......</EstimatedRepairAmount> [0..1]
<EstimatedLaborHoursNumeric>......</EstimatedLaborHoursNumeric> [0..1]
<EstimatedPartsAmount>......</EstimatedPartsAmount> [0..1]
<RequestedService>......</RequestedService> [0..*]
<ServiceAdvisorParty>......</ServiceAdvisorParty> [0..1]
<RequestedAppointmentPeriod>......</RequestedAppointmentPeriod> [0..*]
<AppointmentType>......</AppointmentType> [0..1]
<LeadID>......</LeadID> [0..1]
<EstimatedMileage>......</EstimatedMileage> [0..1]
<EstimatedEngineHours>......</EstimatedEngineHours> [0..1]
</Appointment>