Hotel Policy Read
Supply the universal profile ID of the account the hotel policy exists in and the policyId of the Hotel Policy you wish to retrieve.
Sample Hotel Policy Read request data
Non-location-specific read request – retrieves all property / chain configurations:
xmlns:v1="http://www.travelport.com/schema/policy/admin/ hotel /v1"
<v1:performCRUDRQ>
<v1:BasePolicyRequestHeader accountId="749538" requestCategory="Read" requestorId="DAVES" source="Web"/>
<v1:HotelPolicyRequestProfile policyId="100617"/>
</v1:performCRUDRQ>
Location-specific read request – retrieves only the property / chain configuration applicable to the specified location:
<v1:performCRUDRQ>
<v1:BasePolicyRequestHeader accountId="749538" requestCategory="Read" requestorId="DAVES" source="Web"/>
<v1:HotelPolicyRequestProfile policyId="100617">
<v1:ReadAddOns>
<v1:Param option="LOCTN">
<v1:Values>CHI</v1:Values>
</v1:Param>
</v1:ReadAddOns>
</v1:HotelPolicyRequestProfile>
</v1:performCRUDRQ>
The following elements are supplied in a Read request:
performCRUDRQ / BasePolicyRequestHeader (requestCategory = Read)
HotelPolicyRequestProfile – wrapper element a single set of Hotel Policy data
attribute: policyId – id within the Policy DB of this particular policy.
ReadAddOns – wrapper element for additional retrieval options
Param – wrapper element for individual retrieval option
attribute: option – LOCTN is the only valid value at this time
Values – individual location values – currently only supports city codes for the LOCTN option – item can be repeated to include additional city data.
Sample Hotel Policy Read response data
xmlns:ns5=http://www.travelport.com/schema/policy/admin/hotel/v1
xmlns:ns2=http://www.travelport.com/schema/policy/admin/common/v1
<ns5:performCRUDRS>
<ns5:BasePolicyResponseHeader accountId="749538" requestorId="DAVES"/>
<ns2:AdditionalMessage iD="100617" status="Processed"/>
<ns5:HotelPolicyResponseProfile policyId="100617" pptySource="RM">
<ns5:PropertyCriteria>
<ns5:PreferredProperties>
<ns5:PropertiesPreferred location="CHI" propertyNumber="C0913">
<ns5:PropertyChainBase code="HI" id="105281">
<ns5:BookingDates endDate="2099-12-31" startDate="2016-01-25"/>
<ns5:CheckinDates endDate="2099-12-31" startDate="2016-01-25"/>
</ns5:PropertyChainBase>
<ns5:Discount cdNumber="CD1234" rateCode="MLRC1"/>
<ns5:Stay maxNights="99" minNights="1"/>
<ns2:Rate currency="USD" rate="100.0"/>
<ns5:AmenitiesOffered>
<ns5:Amenity>AIRPORTSHUTTLE</ns5:Amenity>
<ns5:Amenity>BREAKFAST</ns5:Amenity>
<ns5:Amenity>MEETINGFACILITY</ns5:Amenity>
</ns5:AmenitiesOffered>
</ns5:PropertiesPreferred>
</ns5:PreferredProperties>
<ns5:DisplayOnlyProperties>
<ns5:PropertiesDisplayOnly location="DEN" preferredAllowedInd="false" propertyNumber="21793">
****** Additional Data Removed For Readability *******
****** PropertyChainBase / Discount / Stay / Rate / AmenitiesOffered elements repeat for each property configuration *******
</ns5:PropertiesDisplayOnly>
</ns5:DisplayOnlyProperties>
<ns5:ExcludedProperties>
<ns5:Properties location="CHI" propertyNumber="19628">
<ns5:PropertyChainBase code="AA" id="105285">
<ns5:BookingDates endDate="2099-12-31" startDate="2016-01-25"/>
<ns5:CheckinDates endDate="2099-12-31" startDate="2016-01-25"/>
</ns5:PropertyChainBase>
</ns5:Properties>
</ns5:ExcludedProperties>
</ns5:PropertyCriteria>
<ns5:ChainCriteria>
<ns5:DisplayOnlyChains>
<ns5:ChainsDisplayOnlyChains preferredAllowedInd="false">
<ns5:PropertyChainBase code="BW" id="105347">
<ns5:BookingDates endDate="2016-12-31" startDate="2016-01-25"/>
<ns5:CheckinDates endDate="2016-12-31" startDate="2016-01-25"/>
</ns5:PropertyChainBase>
<ns5:Location>
<ns2:StateLocation country="US" state="CO"/>
</ns5:Location>
</ns5:ChainsDisplayOnlyChains>
<ns5:ChainsDisplayOnlyChains preferredAllowedInd="true">
<ns5:PropertyChainBase code="CY" id="105348">
****** Additional Data Removed For Readability *******
</ns5:ChainsDisplayOnlyChains>
</ns5:DisplayOnlyChains>
<ns5:ExcludedChains>
<ns5:Chains>
<ns5:PropertyChainBase code="RL" id="105295">
****** Additional Data Removed For Readability *******
</ns5:Chains>
</ns5:ExcludedChains>
<ns5:PreferredChains>
<ns5:ChainsPreferredChains>
****** Additional Data Removed For Readability *******
<ns5:Discount cdNumber="CD5678" rateCode="MLRC2"/>
</ns5:ChainsPreferredChains>
</ns5:PreferredChains>
</ns5:ChainCriteria>
<ns5:PolicyOptions>
<ns5:PreferredProperties>MARK_ALL_IN_POLICY</ns5:PreferredProperties>
<ns5:PreferredChains>MARK_ALL_IN_POLICY</ns5:PreferredChains>
<ns5:NonPrefPropsChains>
<ns5:NegotiateRateOption markInPolicyInd="true" value="MARK_OUT_POLICY_GT_MOST_EXP_NEG_RATE"/>
</ns5:NonPrefPropsChains>
<ns5:ExclusionOptions displayOnlyInPolicyOption="true"/>
</ns5:PolicyOptions>
<ns5:RateCapMax>
<ns2:RateCap>
<ns2:CapMaxBase>
<ns2:EffectiveDates endDate="2099-12-31" startDate="2016-01-25"/>
<ns2:Location>
<ns2:Worldwide>WORLDW</ns2:Worldwide>
</ns2:Location>
</ns2:CapMaxBase>
<ns2:Rate currency="USD" rate="150.0"/>
</ns2:RateCap>
<ns2:RateCap>
****** Additional Data Removed For Readability *******
</ns2:RateCap>
<ns5:RateMax>
<ns2:CapMaxBase>
<ns2:EffectiveDates endDate="2016-12-31" startDate="2016-01-25"/>
<ns2:Location>
<ns2:CountryLocation>US</ns2:CountryLocation>
</ns2:Location>
</ns2:CapMaxBase>
<ns2:Rate currency="USD" rate="200.0"/>
</ns5:RateMax>
<ns5:RateMax>
****** Additional Data Removed For Readability *******
</ns5:RateMax>
</ns5:RateCapMax>
<ns2:ProfileResponse>
<ns2:Profile>
<ns2:Name>SB Hotel Policy1</ns2:Name>
<ns2:Summary>Test Hotel Policy for Sandbox documentation</ns2:Summary>
</ns2:Profile>
<ns2:AttachedTo id="100372" name="SandboxPG1"/>
</ns2:ProfileResponse>
<ns5:PolicyCompliance>
<ns2:Message id="301" weightage="10"/>
****** Additional Data Removed For Readability *******
****** Message elements repeat for each message associated with the policy *******
</ns5:PolicyCompliance>
<ns5:RateCriteria>
<ns5:RateOptions deposit="OOP" prePayment="HIDE"/>
</ns5:RateCriteria>
<ns5:RateFilters>
<ns5:Filter category="HRDESC">
<ns5:FilterText>Government</ns5:FilterText>
</ns5:Filter>
<ns5:Filter category="HRCTGY">
<ns5:FilterText>GOV</ns5:FilterText>
</ns5:Filter>
<ns5:Filter category="HRCODE">
<ns5:FilterText>GOVT</ns5:FilterText>
</ns5:Filter>
</ns5:RateFilters>
</ns5:PolicyHotelPolicyResponseProfile>
</ns5:performCRUDRS>
The following elements are found in a Read response:
performCRUDRS / BasePolicyResponseHeader
AdditionalMessage – overall status of the response
attribute: iD – id within the Policy DB of this particular policy
attribute: status – will be either “Processed” or “Failure”.
HotelPolicyResponseProfile – wrapper element a single set of Hotel Policy data
attribute: policyId - id within the Policy DB of this particular policy
attribute: pptySource – source for hotel property numbers (RM = RoomMaster / WSP = Worldspan) – this value is used to determine which DB tables validation will be performed against.
PropertyCriteria – wrapper element for Policy property criteria data
PreferredProperties - wrapper element for all preferred property data
PropertiesPreferred - wrapper element for individual preferred property data
attribute: location – city code with which this property is associated
attribute: propertyNumber – property number used to identify this property in the appropriate DB table.
DisplayOnlyProperties - wrapper element for all display only property data
PropertiesDisplayOnly - wrapper element for individual display only property data
attribute: location – city code with which this property is associated
attribute: propertyNumber – property number used to identify this property in the appropriate DB table
attribute: preferredAllowedInd – used to decide if the display only property should be shown as preferred or not
ExcludedProperties - wrapper element for all excluded property data
Properties - wrapper element for individual excluded property data
attribute: location – city code with which this property is associated
attribute: propertyNumber – property number used to identify this property in the appropriate DB table.
PropertyChainBase – wrapper element for common property / chain data – used by PropertiesPreferred / PropertiesDisplayOnly / Properties / ChainsDisplayOnlyChains / Chains / ChainsPreferredChains
attribute: code – vendor code for this property
attribute: id - id within the Policy DB of this particular vendor criteria
BookingDates
attribute: endDate – date before which booking must take place for this configuration to apply
attribute: startDate – date after which booking must take place for this configuration to apply
CheckinDates
attribute: endDate – date before which check in must take place for this configuration to apply
attribute: startDate – date after which check in must take place for this configuration to apply
Discount – wrapper for discount information - used by PropertiesPreferred / PropertiesDisplayOnly / ChainsPreferredChains / ChainsDisplayOnlyChains
attribute: cdNumber – corporate discount number used to get corporate rate
attribute: rateCode – rate code used to get corporate rate
Stay – wrapper for stay information - used by PropertiesPreferred / PropertiesDisplayOnly
attribute: maxNights – maximum number of nights stay for this configuration to apply
attribute: minNights – minimum number of nights stay for this configuration to apply
Rate - wrapper for rate information - used by PropertiesPreferred / PropertiesDisplayOnly / RateCap / RateMax
attribute: currency – currency code associated with this rate
attribute: rate – nightly rate for this property
AmenitiesOffered – wrapper for list of individual amenities included in the preferred rate at this property - used by PropertiesPreferred / PropertiesDisplayOnly / ChainsPreferredChains / ChainsDisplayOnlyChains
Amenity – individual amenities for this property (values can be AIRPORTSHUTTLE / BREAKFAST / BUSINESSCENTER / LAUNDRY / FITNESSCENTER / MEETINGFACILITY / PARKING / SPA / WIFI)
ChainCriteria - wrapper element for Policy chain criteria data
DisplayOnlyChains - wrapper element for all display only chain data
ChainsDisplayOnlyChains - wrapper element for individual display only chain data
attribute: preferredAllowedInd – used to decide if the display only chain should be shown as preferred or not.
ExcludedChains - wrapper element for all excluded chain data
Chains - wrapper element for individual excluded chain data
PreferredChains - wrapper element for all preferred chain data
ChainsPreferredChains - wrapper element for individual preferred chain data
Location - wrapper element for the specific location geography to be applied (used by ChainsDisplayOnlyChains / Chains / ChainsPreferredChains / CapMaxBase) – child elements of this tag can be Continent / Region / CountryLocation / StateLocation / CityAirportLocation depending on the chosen geographical configuration
Worldwide – WORLDW if this location item applies anywhere in the world
Region - the 6 character region code to which this location item applies (see table xyz)
CountryLocation - the 2 character country code to which this location item applies
StateLocation - location to which this configuration applies
attribute: country - 2 character country code to which this location item applies
attribute: state - 2 character state code to which this location item applies
CityAirportLocation - 3 character airport or city location to which this location item applies
PolicyOptions – wrapper for Policy Option data
PreferredProperties – selected option for preferred properties (MARK_ALL_IN_POLICY / MARK_OUT_POLICY_GT_NEG_RATE / MARK_OUT_POLICY_GT_AREA_RATE_CAP)
PreferredChains - selected option for preferred properties (MARK_ALL_IN_POLICY / MARK_OUT_POLICY_GT_AREA_RATE_CAP / MARK_OUT_POLICY_GT_MOST_EXP_NEG_RATE / MARK_OUT_POLICY_GT_LEAST_EXP_NEG_RATE)
NonPrefPropsChains – wrapper element for selected non-preferred properties and chains policy options
OtherOption - selected option for non-preferred properties and chains for non-negotiated rates (MARK_ALL_OUT_POLICY / MARK_ALL_IN_POLICY / MARK_OUT_POLICY_GT_AREA_RATE_CAP)
NegotiateRateOption - wrapper element for selected non-preferred properties and chains policy options for negotiated rates
attribute: markInPolicyInd – Boolean - mark as in policy if no preferred properties or chains are found in area
attribute: value - selected option for non-preferred properties and chains for negotiated rates (MARK_OUT_POLICY_GT_MOST_EXP_NEG_RATE / MARK_OUT_POLICY_GT_LEAST_EXP_NEG_RATE)
ExclusionOptions - used to indicate if options should be displayed to user or removed from response
attribute: displayOnlyInPolicyOption – indicator used to have out of policy items removed from the response during search evaluation
RateCapMax – wrapper element for all rate cap and rate maximum configurations
RateCap - wrapper element for individual rate cap configuration
CapMaxBase – common wrapper element for individual rate cap / rate maximum data – see above for location tags
EffectiveDates – date range to which rate cap / rate maximum applies
attribute: endDate – date before which booking must take place for this configuration to apply
attribute: startDate – date after which booking must take place for this configuration to apply
ProfileResponse – wrapper element for Policy profile / attachment data
Profile - wrapper element for Policy profile data
Name – name of this hotel policy
Summary – user defined summary describing the purpose / application of this hotel policy
AttachedTo – information about Policy Group to which Policy is attached (can repeat)
attribute: id – Policy DB id of the Policy Group to which Policy is attached
attribute: name – name of Policy Group to which Policy is attached
PolicyCompliance – wrapper element for policy compliance settings
Message – individual message id and value assigned to that id
attribute: id – compliance message ID (300-310 – see list for details)
attribute weightage – percentage overall compliance will be reduced by if itinerary fails to comply with this configuration.
RateCriteria – wrapper element for rate application criteria
RateOptions – configuration to be used for a particular type of rate
attribute: deposit – how to handle rates that require a deposit (OOP / HIDE)
attribute: prepayment - how to handle rates that require prepayment (OOP / HIDE)
OOP = mark as out of policy / HIDE = remove from response
RateFilters - wrapper element for rate filters
Filter – individual filter data
attribute: category – field against which filter should be applied (HRDESC = description / HRCTGY = category / HRCODE = code)
FilterText – value to be compared against – rate will be removed if filter text is found in appropriate field
Considerations for a Hotel Policy Read
The ChainsDisplayOnlyChains, Chains, and ChainsPreferredChains tags all use the Location element, which can have any of the following child elements depending on the chosen geographical configuration: Worldwide / Region / CountryLocation / StateLocation / CityAirportLocation.
These are examples of each of the child tags:
<ns2:Worldwide>WORLDW</ns2:Worldwide>
<ns5:Region>EUROPE</ns5:Region>
<ns5:CountryLocation>US</ns5:CountryLocation>
<ns2:StateLocation country="US" state="CO"/>
<ns5:CityAirportLocation>DEN</ns5:CityAirportLocation>
In addition to a normal Hotel Policy read to retrieve all the Hotel Policy data there is an option to specify a location in the request to restrict the property / chain data in the response to only those configurations that apply to the requested location. This can be used to get property / chain information to include in the search request.
Sample Request and Response
See the Downloads page to download a zip file containing the following XML files.
Sample request:
HotelPolicyReadRQ.xml
HotelPolicyReadLOCTNRQ.xml
Sample response:
HotelPolicyReadRS.xml
HotelPolicyReadLOCTNRS.xml