OTA_HotelStatsNotifRQ

The Open Travel Alliance specification for OTA_HotelStatsNotifRQ is used for submitting statistical hotel data, aggregated at a daily level.

The SOAP action for the OTA_HotelStatsNotifRQ message is http://api.str.com/datasubmission/v1_0/OTA_HotelStatsNotifRQ_SubmitRequest

Message XML Element Structure

  • POS
    • Source
      • RequestorID
      • BookingChannel
  • Statistics
    • Statistic
      • StatisticApplicationSets
        • StatisticCodes
          • StatisticCode
      • RevenueCategorySummaries
        • RevenueCategorySummary
      • CountCategorySummaries
        • CountCategorySummary

OTA_HotelStatsNotifRQ Message Structure

Copy 
<OTA_HotelStatsNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:htng="http://htng.org/2014B" EchoToken="" TimeStamp="" CorrelationID="">
  <POS>
    <Source>
      <RequestorID Type="" ID_Context="" ID=""/>
      <BookingChannel Type="" Primary=""/>
    </Source>
  </POS>
  <Statistics>
    <Statistic ChainCode="" HotelCode="" HotelName="" FiscalDate="" ReportCode="">
      <StatisticApplicationSets>
        <StatisticApplicationSet Start=""End="">
          <StatisticCodes>
            <StatisticCode/>
          </StatisticCodes>
          <RevenueCategorySummaries>
            <RevenueCategorySummary RevenueCategoryCode="" Amount="" CurrencyCode=""/>
          </RevenueCategorySummaries>
          <CountCategorySummaries>
            <CountCategorySummary SummaryCount="" CountCategoryCode=""/>
          </CountCategorySummaries>
        </StatisticApplicationSet>
      </StatisticApplicationSets>
    </Statistic>
  </Statistics>
</OTA_HotelStatsNotifRQ>

Message Dictionary

Element Name Required Type Description
POS No Root Element Root Element. Point of Sale. Used to describe the source of the request.
,,Source No Element Contains the details of the requestor.
,,,,Requestor ID No Element Identifier of the requestor.
,,,,,,@Type No String OpenTravel code that specifies the type for the UniqueID element.
,,,,,,@ID_Context No String The source of the identifier.
,,,,,,@ID No String Unique ID of the requestor.
,,,,BookingChannel No Element Contains the details of the booking channel.
,,,,,,@Type No String Type of booking channel.
,,,,,,@Primary No String Indicates if the channel is the primary source.
 
Statistics Yes Root Element Collection of 1..N Statistic elements.
,,Statistic Yes Element Collection of 1..N StatisticApplicationSets elements.
,,,,@ChainCode Yes String Unique identifier for the Hotel Chain.
,,,,@HotelCode Yes String Unique identifier for the Hotel.
,,,,@HotelName No String The name of the hotel.
,,,,@FiscalDate No String The date that the set of hotel statistics was obtained.
,,,,@ReportCode Yes String

One of two values should be used for submitting data to STR:

  • HTNG_PastDailyPropertyStatistics_v1 (historical data)

  • HTNG_CurrentDailyPropertyStatistics_v1 (forward-looking data)
,,StatisticApplicationSets Yes Element Contains 1..N of StatisticApplicationSet elements.
,,,,StatisticApplicationSet Yes Element Container element for the RevenueCategorySummaries and CountCategorySummaries element.
,,,,,,@Start Yes String Date value in the format yyyy-mm-dd. The start of the date range for the set of statistics. STR only accepts statistics aggregated as a daily value. The Start and End dates should match.
,,,,,,@End Yes String Date value in the format yyyy-mm-dd. The end of the date range for the set of statistics. STR only accepts statistics aggregated as a daily value. The Start and End dates shoudl match.
,,RevenueCategorySummaries Yes Element Contains 1..N RevenueCategorySummary elements. Collection of the revenues that are submitted in the statistic set.
,,,,RevenueCategorySummary Yes Element Contains a revenue value.
,,,,,,@RevenueCategoryCode Yes Integer

Numeric codes used by STR:

3 - Food & Beverage (net)

9 - Room Revenue

17 - Total Revenue

126 - Other Revenue

99900 - Transient Revenue

99901 - Contract Revenue

99902 - Group Revenue

99903 - Other Room Revenue

99904 - Resort Fee Collected

99905 - Published Resort Fee
,,,,,,@Amount Yes Decimal The monetary revenue amount.
,,,,,,@CurrencyCode Yes String Three letter Currency ISO Code (USD, GBP, EUR, etc.)
,,CountCategorySummaries Yes Element Contains 1..N of CountCategorySummary elements.
,,,,CountCategorySummary Yes Element Contains a count value.
,,,,,,@SummaryCount Yes Integer Integer value of the count.
,,,,,,@CountCategoryCode Yes Integer

Numeric codes used by STR:

8 - Supply

11 - Demand *

22 - Comp Rooms

99900 - Transient Demand

99901 - Contract Demand

99902 - Group Demand

* Please note that STR deducts category code 11 with category code 22, so be sure to either transfer demand including complimentary and house rooms or else transfer demand excluding complimentary and house use rooms leaving category code 22 as blank or with "0".

Example SOAP Message

Copy 
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
  <soapenv:Header xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
    <htnga:CorrelationID xmlns:htnga="http://htng.org/PWSWG/2007/02/AsyncHeaders">e328c5eb-8dda-48ab-84e7-16ddc95e6e9e</htnga:CorrelationID>
  </soapenv:Header>
  <env:Body>
    <OTA_HotelStatsNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:htng="http://htng.org/2014B" EchoToken="BDCC732F-9FE2-45DC-A3E5-3E7A34493DA8" TimeStamp="2019-07-11T13:33:03Z" CorrelationID="BDCC732F-9FE2-45DC-A3E5-3E7A34493DA8">
      <POS>
        <Source>
          <RequestorID Type="10" ID_Context="SampleContextID" ID="9876"/>
          <BookingChannel Type="4" Primary="true"/>
        </Source>
      </POS>
      <Statistics>
        <Statistic ChainCode="ABC" HotelCode="12345" HotelName="MyHotel" FiscalDate="2019-07-09" ReportCode="HTNG_PastDailyPropertyStatistics_v1">
          <StatisticApplicationSets>
            <StatisticApplicationSet Start="2019-06-29" End="2019-06-29">
              <StatisticCodes>
                <StatisticCode/>
              </StatisticCodes>
              <RevenueCategorySummaries>
                <RevenueCategorySummary RevenueCategoryCode="3" Amount="1788.23" CurrencyCode="USD"/>
                <RevenueCategorySummary RevenueCategoryCode="9" Amount="14237.52" CurrencyCode="USD"/>
                <RevenueCategorySummary RevenueCategoryCode="17" Amount="16845.00" CurrencyCode="USD"/>
              </RevenueCategorySummaries>
              <CountCategorySummaries>
                <CountCategorySummary SummaryCount="90" CountCategoryCode="8"/>
                <CountCategorySummary SummaryCount="0" CountCategoryCode="9"/>
                <CountCategorySummary SummaryCount="0" CountCategoryCode="10"/>
                <CountCategorySummary SummaryCount="62" CountCategoryCode="11"/>
                <CountCategorySummary SummaryCount="47" CountCategoryCode="12"/>
                <CountCategorySummary SummaryCount="53" CountCategoryCode="13"/>
                <CountCategorySummary SummaryCount="4" CountCategoryCode="22"/>
                <CountCategorySummary SummaryCount="62" CountCategoryCode="19"/>
                <CountCategorySummary SummaryCount="15" CountCategoryCode="14"/>
                <CountCategorySummary SummaryCount="0" CountCategoryCode="15"/>
              </CountCategorySummaries>
            </StatisticApplicationSet>
          </StatisticApplicationSets>
        </Statistic>
      </Statistics>
    </OTA_HotelStatsNotifRQ>
  </env:Body>
</env:Envelope>

 

Next topic: Response Message