Filter Sample

Filters are used to specify only the information that you want to display in the response. Construct filters to match the response from XML Select and exclude the information that you do not want to receive. Note: Ensure that you do not filter error information.

This sample includes the following:

• XML hotel availability request.

• Complete response (no filter).

• Filtered response for property list.

• Filtered response for the property's chain code, RoomMaster ID, property name, address, and BIC code.

XML Request

<HotelAvailability_8_0>

  <HotelAvailabilityMods>

    <ReqType>C</ReqType>

    <StartDt>20001201</StartDt>

    <EndDt>20001210</EndDt>

    <NumNights>09</NumNights>

    <NumPersons>2</NumPersons>

    <City>CHI  </City>

    <RefPt></RefPt>

    <PropNum1>00000</PropNum1>

    <PropNum2>00000</PropNum2>

    <PropNum3>00000</PropNum3>

    <PropNum4>00000</PropNum4>

    <DesiredAltCurrency></DesiredAltCurrency>

    <NoRelaxInd>Y</NoRelaxInd>

    <MoreInd>N</MoreInd>

    <MoreIndYNQual>

      <SlotAry>

        <Slot>

          <ID>D </ID>

          <Priority>01</Priority>

          <Data><![CDATA[005M  Y000]]></Data>

         </Slot>

         <Slot>

           <ID>C </ID>

           <Priority>02</Priority>

           <Data>R</Data>

         </Slot>

      </SlotAry>

    </MoreIndYNQual>

  </HotelAvailabilityMods>

</HotelAvailability_8_0>

Empty Filter

When you use an empty filter in the request, all information about the request is returned.

Empty Filter Request

<_ xmlns=""/>

Empty Filter Response

Note:  The TotItemCn states that 14 properties were returned for the above request. However, for space purposes, this response lists only two properties.

<HotelAvailability_8_0 xmlns="">

 <HotelAvailability>

  <Type>P</Type>

  <TypePQual>

   <ResponseCat>C</ResponseCat>

   <StartDt>20001201</StartDt>

   <EndDt>20001210</EndDt>

   <NumNights>9</NumNights>

   <City>CHI</City>

   <RefPtPostal>CHICAGO</RefPtPostal>

   <RefPtPostalInd>R</RefPtPostalInd>

   <State>IL</State>

   <MileKiloSwitch>M</MileKiloSwitch>

   <NumPersons>2</NumPersons>

   <NumPropReturned>14</NumPropReturned>

   <PrefPropCnt>0</PrefPropCnt>

   <NumBrochureLines>0</NumBrochureLines>

   <ChainSearchStatusAry>

    <ChainSearchStatus />

    <ChainSearchStatus />

    <ChainSearchStatus />

    <ChainSearchStatus />

    <ChainSearchStatus />

    <ChainSearchStatus />

   </ChainSearchStatusAry>

   <PropSearchStatusAry>

    <PropSearchStatus />

    <PropSearchStatus />

    <PropSearchStatus />

    <PropSearchStatus />

   </PropSearchStatusAry>

   <NeutralAvailInd />

   <Spares />

   <MoreInd>Y</MoreInd>

   <TotNumPropsReturned>14</TotNumPropsReturned>

   <StartDBKey>384023</StartDBKey>

   <EndDBKey>384020</EndDBKey>

   <RefPtDBKey>239873817</RefPtDBKey>

   <BitMap>111111111111111</BitMap>

   <Rsvd />

   <CityCodeRefMatch>Y</CityCodeRefMatch>

  </TypePQual>

 </HotelAvailability>

 <HotelAvailabilityPropList>

  <TotItemCnt>14</TotItemCnt>

  <ChainCodeAry>

   <ChainCode>

    <Chain>WR</Chain>

    <RoomMasterID>43415</RoomMasterID>

    <PropName>CITY SUITES HOTEL</PropName>

    <ShortAddr>933 WEST BELMONT AVE</ShortAddr>

    <PrimaryCity>CHI</PrimaryCity>

    <Dist>5</Dist>

    <Dir>N</Dir>

    <Locn>C</Locn>

    <Transportation>O</Transportation>

    <RateGuarInd>Y</RateGuarInd>

    <AltRateGuarInd />

    <DepSwitch>G</DepSwitch>

    <InsideLinkInd>I</InsideLinkInd>

    <RsvdAAARating>3</RsvdAAARating>

    <Advertiser>N</Advertiser>

    <GeoCodeInd>N</GeoCodeInd>

    <DefCurrency>USD</DefCurrency>

    <AltCurrency />

    <DefCurrencyDecPos>2</DefCurrencyDecPos>

    <AltCurrencyDecPos>0</AltCurrencyDecPos>

    <AdditionalRatesInd>N</AdditionalRatesInd>

    <BICAry>

     <BICInfo>

      <BIC>B1QRAC</BIC>

      <MoreRatesInd>Y</MoreRatesInd>

      <AvailNeedInd>S</AvailNeedInd>

      <RateChgInd>Y</RateChgInd>

      <RateCat>R</RateCat>

      <DispRate>STD</DispRate>

      <VStoredRateAmt>15900</VStoredRateAmt>

     </BICInfo>

    </BICAry>

   </ChainCode>

   <ChainCode>

    <Chain>BW</Chain>

    <RoomMasterID>94227</RoomMasterID>

    <PropName>HAWTHORNE TERRACE</PropName>

    <ShortAddr>3434 N. BROADWAY</ShortAddr>

    <PrimaryCity>CHI</PrimaryCity>

    <Dist>5</Dist>

    <Dir>N</Dir>

    <Locn>C</Locn>

    <Transportation>P</Transportation>

    <RateGuarInd>Y</RateGuarInd>

    <AltRateGuarInd />

    <DepSwitch>G</DepSwitch>

    <InsideLinkInd>I</InsideLinkInd>

    <RsvdAAARating>3</RsvdAAARating>

    <Advertiser>N</Advertiser>

    <GeoCodeInd>N</GeoCodeInd>

    <DefCurrency>USD</DefCurrency>

    <AltCurrency />

    <DefCurrencyDecPos>2</DefCurrencyDecPos>

    <AltCurrencyDecPos>0</AltCurrencyDecPos>

    <AdditionalRatesInd>N</AdditionalRatesInd>

    <BICAry>

     <BICInfo>

      <BIC>A1QRAC</BIC>

      <MoreRatesInd>Y</MoreRatesInd>

      <AvailNeedInd>S</AvailNeedInd>

      <RateChgInd>N</RateChgInd>

      <RateCat>R</RateCat>

      <DispRate>STD</DispRate>

      <VStoredRateAmt>12900</VStoredRateAmt>

     </BICInfo>

    </BICAry>

   </ChainCode>

  </ChainCodeAry>

 </HotelAvailabilityPropList>

 <HeadLineAd>

  <Type>A</Type>

  <EndPt>CHI</EndPt>

  <StartPt />

  <AdItemsCnt>3</AdItemsCnt>

  <TotAdItemsCnt>3</TotAdItemsCnt>

  <TypeAQual>

   <Vnd>GX</Vnd>

   <Num>14</Num>

   <VType>H</VType>

   <POSParameter1 />

   <POSParameter2 />

   <TextAvail>Y</TextAvail>

   <Ad>MIDLAND HOTEL -82316- DOWNTOWN*SPL 99USD * WKEND 159USD</Ad>

  </TypeAQual>

 </HeadLineAd>

</HotelAvailability_8_0>

Filter Property List

To display only the property list for the request, use the following filter:

<HotelAvailability_8_0>

  <HotelAvailabilityPropList>

    <_ xmlns=""/>

  </HotelAvailabilityPropList>

</HotelAvailability_8_0>

Response with Property List Filter

In the following response, the <HotelAvailability> section is not displayed because it was not included in the filter.

Note:  The TotItemCn states that 14 properties were returned for the above request. However, for space purposes, this response lists only two properties.

<HotelAvailability_8_0 xmlns="">

 <HotelAvailabilityPropList>

  <TotItemCnt>14</TotItemCnt>

  <ChainCodeAry>

   <ChainCode>

    <Chain>WR</Chain>

    <RoomMasterID>43415</RoomMasterID>

    <PropName>CITY SUITES HOTEL</PropName>

    <ShortAddr>933 WEST BELMONT AVE</ShortAddr>

    <PrimaryCity>CHI</PrimaryCity>

    <Dist>5</Dist>

    <Dir>N</Dir>

    <Locn>C</Locn>

    <Transportation>O</Transportation>

    <RateGuarInd>Y</RateGuarInd>

    <AltRateGuarInd />

    <DepSwitch>G</DepSwitch>

    <InsideLinkInd>I</InsideLinkInd>

    <RsvdAAARating>3</RsvdAAARating>

    <Advertiser>N</Advertiser>

    <GeoCodeInd>N</GeoCodeInd>

    <DefCurrency>USD</DefCurrency>

    <AltCurrency />

    <DefCurrencyDecPos>2</DefCurrencyDecPos>

    <AltCurrencyDecPos>0</AltCurrencyDecPos>

    <AdditionalRatesInd>N</AdditionalRatesInd>

    <BICAry>

     <BICInfo>

      <BIC>B1QRAC</BIC>

      <MoreRatesInd>Y</MoreRatesInd>

      <AvailNeedInd>S</AvailNeedInd>

      <RateChgInd>Y</RateChgInd>

      <RateCat>R</RateCat>

      <DispRate>STD</DispRate>

      <VStoredRateAmt>15900</VStoredRateAmt>

     </BICInfo>

    </BICAry>

   </ChainCode>

   <ChainCode>

    <Chain>BW</Chain>

    <RoomMasterID>94227</RoomMasterID>

    <PropName>HAWTHORNE TERRACE</PropName>

    <ShortAddr>3434 N. BROADWAY</ShortAddr>

    <PrimaryCity>CHI</PrimaryCity>

    <Dist>5</Dist>

    <Dir>N</Dir>

    <Locn>C</Locn>

    <Transportation>P</Transportation>

    <RateGuarInd>Y</RateGuarInd>

    <AltRateGuarInd />

    <DepSwitch>G</DepSwitch>

    <InsideLinkInd>I</InsideLinkInd>

    <RsvdAAARating>3</RsvdAAARating>

    <Advertiser>N</Advertiser>

    <GeoCodeInd>N</GeoCodeInd>

    <DefCurrency>USD</DefCurrency>

    <AltCurrency />

    <DefCurrencyDecPos>2</DefCurrencyDecPos>

    <AltCurrencyDecPos>0</AltCurrencyDecPos>

    <AdditionalRatesInd>N</AdditionalRatesInd>

    <BICAry>

     <BICInfo>

      <BIC>A1QRAC</BIC>

      <MoreRatesInd>Y</MoreRatesInd>

      <AvailNeedInd>S</AvailNeedInd>

      <RateChgInd>N</RateChgInd>

      <RateCat>R</RateCat>

      <DispRate>STD</DispRate>

      <VStoredRateAmt>12900</VStoredRateAmt>

     </BICInfo>

    </BICAry>

   </ChainCode>

  </ChainCodeAry>

 </HotelAvailabilityPropList>

</HotelAvailability_8_0>

Filter Chain Code, RoomMaster ID, Property Name, Address, and BIC Code

If you want to only display the property's chain code, RoomMaster ID, property name, address, and BIC code, use the following filter:

<HotelAvailability_8_0>

<HotelAvailabilityPropList>

<ChainCodeAry>

<ChainCode>

<Chain></Chain>

<RoomMasterID></RoomMasterID>

<PropName></PropName>

<ShortAddr></ShortAddr>

<BICAry>

<_ xmlns=""/>

</BICAry>

</ChainCode>

</ChainCodeAry>

</HotelAvailabilityPropList>

</HotelAvailability_8_0>

Response

The response displays only the chain code, RoomMaster ID, property name, address, and BIC code. The following information displayed in the Property List filter response but does not display in this response:  primary city, distance, location, transportation, rate and alternate rate guarantee indicator, DepSwitch, Inside Link indicator, AAA rating, advertiser, Geo code indicator, default and alternate currency information, and additional rates indicator.

Note:  The TotItemCn states that 14 properties were returned for the above request. However, for space purposes, this response lists only two properties.

<HotelAvailability_8_0 xmlns="">

 <HotelAvailabilityPropList>

  <ChainCodeAry>

   <ChainCode>

    <Chain>WR</Chain>

    <RoomMasterID>43415</RoomMasterID>

    <PropName>CITY SUITES HOTEL</PropName>

    <ShortAddr>933 WEST BELMONT AVE</ShortAddr>

    <BICAry>

     <BICInfo>

      <BIC>B1QRAC</BIC>

      <MoreRatesInd>Y</MoreRatesInd>

      <AvailNeedInd>S</AvailNeedInd>

      <RateChgInd>Y</RateChgInd>

      <RateCat>R</RateCat>

      <DispRate>STD</DispRate>

      <VStoredRateAmt>15900</VStoredRateAmt>

     </BICInfo>

    </BICAry>

   </ChainCode>

   <ChainCode>

    <Chain>BW</Chain>

    <RoomMasterID>94227</RoomMasterID>

    <PropName>HAWTHORNE TERRACE</PropName>

    <ShortAddr>3434 N. BROADWAY</ShortAddr>

    <BICAry>

     <BICInfo>

      <BIC>A1QRAC</BIC>

      <MoreRatesInd>Y</MoreRatesInd>

      <AvailNeedInd>S</AvailNeedInd>

      <RateChgInd>N</RateChgInd>

      <RateCat>R</RateCat>

      <DispRate>STD</DispRate>

      <VStoredRateAmt>12900</VStoredRateAmt>

     </BICInfo>

    </BICAry>

   </ChainCode>

  </ChainCodeAry>

 </HotelAvailabilityPropList>

</HotelAvailability_8_0>