Services XML Sample

The Service structure is used for passing on information about charges for extras and services. Services can be provided at the HotelReservation level (no ServiceRPH) or on a RoomStay or RoomRate level.

The ServiceRPH serves only to link a charge to a room or a rate.

All Service totals provided should be considered full amounts added to the base reservation charge. In other words, the charges are not per person or per day but full charges. The total amounts provided for the RoomStay and Reservation should be considered as inclusive of extras.

For a list of possible service types see Service and Extra Charge Reference Table

1 Reservation Services
2 RoomStay Services
3 RoomRate Services

Reservation Services

Example of a reservation with an unspecified service for the reservation.

Service cost is included in the ResGlobalInfo Total.

Service cost is not included in the RoomRate Base, RoomRate Total and RoomStay Total.

<OTA_ResRetrieveRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2005-08-01T09:32:47+08:00" EchoToken="echo-abc123">
  <Success/>
  <ReservationsList>
    <HotelReservation CreateDateTime="2007-12-09T08:51:45.000+0000" ResStatus="Book">
      <POS>
        <Source>
          <RequestorID Type="22" ID="SITEMINDER"/>
          <BookingChannel Primary="true" Type="7">
            <CompanyName Code="WTF">Wotif</CompanyName>
          </BookingChannel>
        </Source>
      </POS>
      <UniqueID Type="14" ID="WTF-001"/>
      <UniqueID Type="16" ID="1243132" ID_Context="MESSAGE_UNIQUE_ID"/>
      <RoomStays>
        <RoomStay>
          <RoomRates>
            <RoomRate RoomTypeCode="DR" RatePlanCode="RAC" NumberOfUnits="1">
              <Rates>
                <Rate UnitMultiplier="3" RateTimeUnit="Day" EffectiveDate="2013-03-12" ExpireDate="2013-03-15">
                  <Base AmountAfterTax="30.00" CurrencyCode="USD"/>
                </Rate>
              </Rates>
            </RoomRate>
          </RoomRates>
          <GuestCounts>
            <GuestCount AgeQualifyingCode="10" Count="2"/>
          </GuestCounts>
          <TimeSpan Start="2013-03-12" End="2013-03-15"/>
          <Total AmountAfterTax="90.00" CurrencyCode="USD"/>
          <BasicPropertyInfo HotelCode="10107"/>
        </RoomStay>
      </RoomStays>
      <Services>
        <Service ServiceInventoryCode="OTHER" Inclusive="true" Quantity="1" ID="12345" ID_Context="CHANNEL" Type="18">
          <Price>
            <Total AmountAfterTax="80.00" CurrencyCode="USD"/>
          </Price>
        </Service>
      </Services>
      <ResGuests>
        <ResGuest ArrivalTime="10:30:00">
          <Profiles>
            <ProfileInfo>
              <UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
              <Profile ProfileType="1">
                <Customer>
                  <PersonName>
                    <GivenName>James</GivenName>
                    <MiddleName>Herbert</MiddleName>
                  </PersonName>
                  <Telephone PhoneNumber="555-1234"/>
                  <Email>james.bond@mi5.co.uk</Email>
                  <Address>
                    <AddressLine>Claretta House</AddressLine>
                    <CityName>London</CityName>
                    <PostalCode>EC1 2PG</PostalCode>
                    <StateProv>Middlesex</StateProv>
                    <CountryName>United Kingdom</CountryName>
                  </Address>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <ResGlobalInfo>
        <Total AmountAfterTax="170.00" CurrencyCode="USD"/>
        <HotelReservationIDs>
          <HotelReservationID ResID_Type="14" ResID_Value="RES_3243525"/>
        </HotelReservationIDs>
      </ResGlobalInfo>
    </HotelReservation>
  </ReservationsList>
</OTA_ResRetrieveRS>

RoomStay Services

Example of a reservation with two services linked to the RoomStay.

Service cost is included in the RoomStay Total and ResGlobalInfo Total.

Service cost is not included in the RoomRate Base and RoomRate Total.

<OTA_ResRetrieveRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2005-08-01T09:32:47+08:00" EchoToken="echo-abc123">
  <Success/>
  <ReservationsList>
    <HotelReservation CreateDateTime="2007-12-09T08:51:45.000+0000" ResStatus="Book">
      <POS>
        <Source>
          <RequestorID Type="22" ID="SITEMINDER"/>
          <BookingChannel Primary="true" Type="7">
            <CompanyName Code="WTF">Wotif</CompanyName>
          </BookingChannel>
        </Source>
      </POS>
      <UniqueID Type="14" ID="WTF-001"/>
      <UniqueID Type="16" ID="1243132" ID_Context="MESSAGE_UNIQUE_ID"/>
      <RoomStays>
        <RoomStay>
          <RoomRates>
            <RoomRate RoomTypeCode="DR" RatePlanCode="RAC" NumberOfUnits="1">
              <Rates>
                <Rate UnitMultiplier="3" RateTimeUnit="Day" EffectiveDate="2013-03-12" ExpireDate="2013-03-15">
                  <Base AmountAfterTax="30.00" CurrencyCode="USD"/>
                </Rate>
              </Rates>
            </RoomRate>
          </RoomRates>
          <GuestCounts>
            <GuestCount AgeQualifyingCode="10" Count="2"/>
          </GuestCounts>
          <ServiceRPHs>
            <ServiceRPH RPH="1"/>
            <ServiceRPH RPH="2"/>
          </ServiceRPHs>
          <TimeSpan Start="2013-03-12" End="2013-03-15"/>
          <Total AmountAfterTax="160.00" CurrencyCode="USD"/>
          <BasicPropertyInfo HotelCode="10107"/>
        </RoomStay>
      </RoomStays>
      <Services>
        <Service ServiceInventoryCode="MEAL" Inclusive="true" ServiceRPH="1" Quantity="1" ID="12345" ID_Context="CHANNEL" Type="18">
          <Price>
            <Total AmountAfterTax="50.00" CurrencyCode="USD"/>
            <RateDescription>
              <Text>Breakfast buffet</Text>
            </RateDescription>
          </Price>
          <ServiceDetails>
            <TimeSpan End="2013-03-15" Start="2013-03-12"/>
          </ServiceDetails>
        </Service>
        <Service ServiceInventoryCode="MEAL" Inclusive="true" ServiceRPH="2" Quantity="1" ID="12345" ID_Context="CHANNEL" Type="18">
          <Price>
            <Total AmountAfterTax="20.00" CurrencyCode="USD"/>
            <RateDescription>
              <Text>WiFi</Text>
            </RateDescription>
          </Price>
          <ServiceDetails>
            <TimeSpan End="2013-03-15" Start="2013-03-12"/>
          </ServiceDetails>
        </Service>
      </Services>
      <ResGuests>
        <ResGuest ArrivalTime="10:30:00">
          <Profiles>
            <ProfileInfo>
              <UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
              <Profile ProfileType="1">
                <Customer>
                  <PersonName>
                    <GivenName>James</GivenName>
                    <MiddleName>Herbert</MiddleName>
                  </PersonName>
                  <Telephone PhoneNumber="555-1234"/>
                  <Email>james.bond@mi5.co.uk</Email>
                  <Address>
                    <AddressLine>Claretta House</AddressLine>
                    <CityName>London</CityName>
                    <PostalCode>EC1 2PG</PostalCode>
                    <StateProv>Middlesex</StateProv>
                    <CountryName>United Kingdom</CountryName>
                  </Address>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <ResGlobalInfo>
        <Total AmountAfterTax="160.00" CurrencyCode="USD"/>
        <HotelReservationIDs>
          <HotelReservationID ResID_Type="14" ResID_Value="RES_3243525"/>
        </HotelReservationIDs>
      </ResGlobalInfo>
    </HotelReservation>
  </ReservationsList>
</OTA_ResRetrieveRS>

RoomRate Services

Example of a reservation with a service linked to the RoomRate.

Service cost is included in the RoomRate Total, RoomStay Total and ResGlobalInfo Total.

Service cost is not included in the RoomRate Base

<OTA_ResRetrieveRS xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0" TimeStamp="2005-08-01T09:32:47+08:00" EchoToken="echo-abc123">
  <Success/>
  <ReservationsList>
    <HotelReservation CreateDateTime="2007-12-09T08:51:45.000+0000" ResStatus="Book">
      <POS>
        <Source>
          <RequestorID Type="22" ID="SITEMINDER"/>
          <BookingChannel Primary="true" Type="7">
            <CompanyName Code="WTF">Wotif</CompanyName>
          </BookingChannel>
        </Source>
      </POS>
      <UniqueID Type="14" ID="WTF-001"/>
      <UniqueID Type="16" ID="1243132" ID_Context="MESSAGE_UNIQUE_ID"/>
      <RoomStays>
        <RoomStay>
          <RoomRates>
            <RoomRate RoomTypeCode="DR" RatePlanCode="RAC" NumberOfUnits="1">
              <Rates>
                <Rate UnitMultiplier="3" RateTimeUnit="Day" EffectiveDate="2013-03-12" ExpireDate="2013-03-15">
                  <Base AmountAfterTax="30.00" CurrencyCode="USD"/>
                </Rate>
              </Rates>
              <ServiceRPHs>
                <ServiceRPH RPH="1"/>
              </ServiceRPHs>
            </RoomRate>
          </RoomRates>
          <GuestCounts>
            <GuestCount AgeQualifyingCode="10" Count="3"/>
          </GuestCounts>
          <TimeSpan Start="2013-03-12" End="2013-03-15"/>
          <Total AmountAfterTax="120.00" CurrencyCode="USD"/>
          <BasicPropertyInfo HotelCode="10107"/>
        </RoomStay>
      </RoomStays>
      <Services>
        <Service ServiceInventoryCode="EXTRA_PERSON" Inclusive="true" ServiceRPH="1" Quantity="1" ID="12345" ID_Context="CHANNEL" Type="18">
          <Price>
            <Total AmountAfterTax="30.00" CurrencyCode="USD"/>
            <RateDescription>
              <Text>Extra person charge $10.00 per night</Text>
            </RateDescription>
          </Price>
          <ServiceDetails>
            <TimeSpan End="2013-03-15" Start="2013-03-12"/>
          </ServiceDetails>
        </Service>
      </Services>
      <ResGuests>
        <ResGuest ArrivalTime="10:30:00">
          <Profiles>
            <ProfileInfo>
              <UniqueID Type="16" ID="12345" ID_Context="CHANNEL"/>
              <Profile ProfileType="1">
                <Customer>
                  <PersonName>
                    <GivenName>James</GivenName>
                    <MiddleName>Herbert</MiddleName>
                  </PersonName>
                  <Telephone PhoneNumber="555-1234"/>
                  <Email>james.bond@mi5.co.uk</Email>
                  <Address>
                    <AddressLine>Claretta House</AddressLine>
                    <CityName>London</CityName>
                    <PostalCode>EC1 2PG</PostalCode>
                    <StateProv>Middlesex</StateProv>
                    <CountryName>United Kingdom</CountryName>
                  </Address>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <ResGlobalInfo>
        <Total AmountAfterTax="120.00" CurrencyCode="USD"/>
        <HotelReservationIDs>
          <HotelReservationID ResID_Type="14" ResID_Value="RES_3243525"/>
        </HotelReservationIDs>
      </ResGlobalInfo>
    </HotelReservation>
  </ReservationsList>
</OTA_ResRetrieveRS>