hotelSegment Data Type

A hotel segment is a period of time that a traveler stays in a hotel.

Namespace
(Default)
Schema
ns0.xsd
Properties
name data type type namespace min/max occurs constraints description
addCharge double element 0/1    
cancellationNumber string element 0/1 max size: 32, min size: 0 The cancellation number for the stay.
cancellationPolicy string element 0/1 max size: 256, min size: 0 The cancellation policy.
checkIn string element 0/1   The check in time for the guest.
checkOut string element 0/1   The check out time for the guest.
checkOutPenalty string element 0/1 max size: 128, min size: 0 The penalty incurred for an untimely check out.
commissionAmount double element 0/1    
corporateDiscountNumber string element 0/1 max size: 35, min size: 0 The discount number for the guest.
frequentGuestNumber string element 0/1 max size: 25, min size: 0 The frequent guest number of the guest.
guaranteeInformation string element 0/1 max size: 128, min size: 0 The information about the guarantee.
guaranteeRequirements string element 0/1 max size: 256, min size: 0 The requirements for a guarantee.
guestName string element 0/1 max size: 150, min size: 0 The name of the guest.
hotel hotelLocation element 0/1   The hotel property that the guest is staying at.
notes string element 0/1 max size: 150, min size: 0 Any notes about the segment.
numberOfChildren int element 0/1   The number of children staying in the room.
numberOfGuests int element 0/1   The number of occupants for the room.
numberOfRooms int element 0/1   The number of rooms rented.
rateDesc string element 0/1    
rateInfo string element 0/1    
roomDescription string element 0/1 max size: 256, min size: 0 The description of the room.
roomType string element 0/1 max size: 16, min size: 0 The type of room rented.
specialPrint string element 0/1 max size: 128, min size: 0  
taxCharge double element 0/1   This should not be confused with tax amount, tax rate, or tax percentage. This is a tax charge that is applied in addition to other applicable charges.
taxRate double element 0/1    
totalAmount double element 0/1    
utcCheckIn dateTime element 0/1    
utcCheckOut dateTime element 0/1    
Properties inherited from airportalSegment
confirmationNumber string element 0/1   The ordering number of the segment.
endDate string element 0/1   The end date of the segment
inGds boolean element 1/1   Whether or not the segment is stored in the GDS.
itinerary itinerary element 0/1   Get the itinerary that this segment is connected to.
number int element 0/1   The ordering number of the segment.
startDate string element 0/1   The start date of the segment.
status segmentStatus element 0/1   The status of the segment, like if it is confirmed or on wait list.
Properties inherited from baseHibernateEntity
id long element 0/1   The unique internal ID of the object.
version long element 0/1   For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from baseEntity
violations list of simpleViolation element 0/unbounded   A list of constraint violations, if any, that this object has.

Example

<hotelSegment>
  <frequentGuestNumber>...</frequentGuestNumber>
  <corporateDiscountNumber>...</corporateDiscountNumber>
  <guestName>...</guestName>
  <numberOfRooms>...</numberOfRooms>
  <notes>...</notes>
  <checkIn>...</checkIn>
  <checkOut>...</checkOut>
  <roomDescription>...</roomDescription>
  <roomType>...</roomType>
  <cancellationNumber>...</cancellationNumber>
  <cancellationPolicy>...</cancellationPolicy>
  <guaranteeRequirements>...</guaranteeRequirements>
  <guaranteeInformation>...</guaranteeInformation>
  <checkOutPenalty>...</checkOutPenalty>
  <numberOfGuests>...</numberOfGuests>
  <numberOfChildren>...</numberOfChildren>
  <hotel>
    <address1>...</address1>
    <address2>...</address2>
    <phone1>...</phone1>
    <phone2>...</phone2>
    <fax>...</fax>
    <zip>...</zip>
    <city>
      <code>...</code>
      <countryCode>...</countryCode>
      <latitude>...</latitude>
      <longitude>...</longitude>
      <name>...</name>
      <stateOrCountry>...</stateOrCountry>
      <airportName>...</airportName>
      <region/>
      <timeZone/>
      <retentionOnly>...</retentionOnly>
      <position>...</position>
      <unique>...</unique>
      <alias>...</alias>
    </city>
    <vendor>
      <longCode>...</longCode>
      <commissionRate>...</commissionRate>
      <family/>
      <position>...</position>
    </vendor>
    <latitude>...</latitude>
    <sertifiCode>...</sertifiCode>
    <longitude>...</longitude>
    <propertyName>...</propertyName>
    <propertyCodes>
      <gds/>
      <code>...</code>
    </propertyCodes>
    <id>...</id>
    <version>...</version>
  </hotel>
  <rateInfo>...</rateInfo>
  <rateDesc>...</rateDesc>
  <totalAmount>...</totalAmount>
  <taxRate>...</taxRate>
  <taxCharge>...</taxCharge>
  <addCharge>...</addCharge>
  <specialPrint>...</specialPrint>
  <commissionAmount>...</commissionAmount>
  <utcCheckIn>...</utcCheckIn>
  <utcCheckOut>...</utcCheckOut>
  <number>...</number>
  <confirmationNumber>...</confirmationNumber>
  <status>
    <code>...</code>
    <description>...</description>
    <accepted>...</accepted>
    <confirmed>...</confirmed>
    <virtual>...</virtual>
    <canceled>...</canceled>
  </status>
  <startDate>...</startDate>
  <endDate>...</endDate>
  <inGds>...</inGds>
  <itinerary>
    <recordLocator>...</recordLocator>
    <agentName>...</agentName>
    <client/>
    <office/>
    <departureDate>...</departureDate>
    <completionDate>...</completionDate>
    <importDate>...</importDate>
    <gds/>
    <hide>...</hide>
    <citySummary>...</citySummary>
    <departureCity/>
    <arrivalCity/>
    <arrivalDate>...</arrivalDate>
    <utcArrivalDate>...</utcArrivalDate>
    <startDate>...</startDate>
    <endDate>...</endDate>
    <purpose>...</purpose>
    <explanation>...</explanation>
    <authorizationCode>...</authorizationCode>
    <costCenterCode>...</costCenterCode>
    <departmentCode>...</departmentCode>
    <clientCode>...</clientCode>
    <regionCode>...</regionCode>
    <billable>...</billable>
    <travelerCode>...</travelerCode>
    <managerCode>...</managerCode>
    <projectCode>...</projectCode>
  </itinerary>
  <id>...</id>
  <version>...</version>
</hotelSegment>