OHHService

Click here for a complete list of operations.

search

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /OpenHotelHub.asmx HTTP/1.1
Host: ashburnconcur.roomit.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.opentravel.org/OTA/2003/05/search"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <authentication xmlns="http://www.concur.com/webservice/auth">
      <userid>string</userid>
      <password>string</password>
    </authentication>
  </soap:Header>
  <soap:Body>
    <OTA_HotelSearchRQ EchoToken="string" Version="decimal" PrimaryLangID="string" AltLangID="string" MaxResponses="positiveInteger" xmlns="http://www.opentravel.org/OTA/2003/05">
      <POS>
        <Source ISOCountry="string" ISOCurrency="string" AirportCode="string">
          <RequestorID Type="string" ID="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <BookingChannel>
            <CompanyName xsi:nil="true" />
          </BookingChannel>
        </Source>
        <Source ISOCountry="string" ISOCurrency="string" AirportCode="string">
          <RequestorID Type="string" ID="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <BookingChannel>
            <CompanyName xsi:nil="true" />
          </BookingChannel>
        </Source>
      </POS>
      <Criteria>
        <Criterion>
          <Position Latitude="string" Longitude="string" />
          <Address SameCountryInd="boolean" />
          <RefPoint StateProv="string" CountryCode="string" URI="anyURI" RefPointType="string" Name="string" CityName="string" />
          <RefPoint StateProv="string" CountryCode="string" URI="anyURI" RefPointType="string" Name="string" CityName="string" />
          <HotelRef ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" SegmentCategoryCode="string" PropertyClassCode="string" ArchitecturalStyleCode="string" SupplierIntegrationLevel="nonNegativeInteger" LocationCategoryCode="string" ExtendedCitySearchIndicator="boolean" />
          <HotelRef ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" SegmentCategoryCode="string" PropertyClassCode="string" ArchitecturalStyleCode="string" SupplierIntegrationLevel="nonNegativeInteger" LocationCategoryCode="string" ExtendedCitySearchIndicator="boolean" />
          <Radius Distance="string" DistanceMeasure="string" Direction="string" DistanceMax="string" UnitOfMeasureCode="string" />
          <StayDateRange Start="string" Duration="string" End="string" />
        </Criterion>
        <Criterion>
          <Position Latitude="string" Longitude="string" />
          <Address SameCountryInd="boolean" />
          <RefPoint StateProv="string" CountryCode="string" URI="anyURI" RefPointType="string" Name="string" CityName="string" />
          <RefPoint StateProv="string" CountryCode="string" URI="anyURI" RefPointType="string" Name="string" CityName="string" />
          <HotelRef ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" SegmentCategoryCode="string" PropertyClassCode="string" ArchitecturalStyleCode="string" SupplierIntegrationLevel="nonNegativeInteger" LocationCategoryCode="string" ExtendedCitySearchIndicator="boolean" />
          <HotelRef ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" SegmentCategoryCode="string" PropertyClassCode="string" ArchitecturalStyleCode="string" SupplierIntegrationLevel="nonNegativeInteger" LocationCategoryCode="string" ExtendedCitySearchIndicator="boolean" />
          <Radius Distance="string" DistanceMeasure="string" Direction="string" DistanceMax="string" UnitOfMeasureCode="string" />
          <StayDateRange Start="string" Duration="string" End="string" />
        </Criterion>
      </Criteria>
    </OTA_HotelSearchRQ>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <OTA_HotelSearchRS Version="decimal" EchoToken="string" PrimaryLangID="string" xmlns="http://www.opentravel.org/OTA/2003/05">
      <POS>
        <Source ISOCountry="string" ISOCurrency="string" AirportCode="string">
          <RequestorID Type="string" ID="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <BookingChannel>
            <CompanyName xsi:nil="true" />
          </BookingChannel>
        </Source>
        <Source ISOCountry="string" ISOCurrency="string" AirportCode="string">
          <RequestorID Type="string" ID="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <BookingChannel>
            <CompanyName xsi:nil="true" />
          </BookingChannel>
        </Source>
      </POS>
      <Errors>
        <Error Type="string" ShortText="string" Code="string" DocURL="anyURI" Status="string" Tag="string" RecordID="string" />
        <Error Type="string" ShortText="string" Code="string" DocURL="anyURI" Status="string" Tag="string" RecordID="string" />
      </Errors>
      <Success />
      <Items>
        <anyType />
        <anyType />
      </Items>
      <Properties>
        <Property ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" HotelSegmentCategoryCode="string" SupplierIntegrationLevel="nonNegativeInteger">
          <VendorMessages InfoType="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <Address DefaultInd="boolean" UseType="string" RPH="string" />
          <ContactNumbers>
            <ContactNumber xsi:nil="true" />
            <ContactNumber xsi:nil="true" />
          </ContactNumbers>
          <Award Provider="string" Rating="string" />
          <Award Provider="string" Rating="string" />
          <RelativePosition Direction="string" Distance="string" DistanceUnitName="Mile or Km or Block" UnitOfMeasureCode="string" Nearest="boolean" IndexPointCode="string" Name="string" PrimaryIndicator="boolean" ToFrom="" ApproximateDistanceInd="boolean" />
          <HotelAmenity Code="string" />
          <HotelAmenity Code="string" />
          <Recreation Code="string" />
          <Recreation Code="string" />
          <Service BusinessServiceCode="string" />
          <Service BusinessServiceCode="string" />
          <Policy CheckInTime="time" CheckOutTime="time" />
          <TPA_Extensions>
            <HotelPreference>string</HotelPreference>
            <TPA_HotelPreviewImageURI xsi:nil="true" />
            <TPA_PropertyReferenceInfo xsi:nil="true" />
            <SearchSessionToken>string</SearchSessionToken>
          </TPA_Extensions>
        </Property>
        <Property ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" HotelSegmentCategoryCode="string" SupplierIntegrationLevel="nonNegativeInteger">
          <VendorMessages InfoType="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <Address DefaultInd="boolean" UseType="string" RPH="string" />
          <ContactNumbers>
            <ContactNumber xsi:nil="true" />
            <ContactNumber xsi:nil="true" />
          </ContactNumbers>
          <Award Provider="string" Rating="string" />
          <Award Provider="string" Rating="string" />
          <RelativePosition Direction="string" Distance="string" DistanceUnitName="Mile or Km or Block" UnitOfMeasureCode="string" Nearest="boolean" IndexPointCode="string" Name="string" PrimaryIndicator="boolean" ToFrom="" ApproximateDistanceInd="boolean" />
          <HotelAmenity Code="string" />
          <HotelAmenity Code="string" />
          <Recreation Code="string" />
          <Recreation Code="string" />
          <Service BusinessServiceCode="string" />
          <Service BusinessServiceCode="string" />
          <Policy CheckInTime="time" CheckOutTime="time" />
          <TPA_Extensions>
            <HotelPreference>string</HotelPreference>
            <TPA_HotelPreviewImageURI xsi:nil="true" />
            <TPA_PropertyReferenceInfo xsi:nil="true" />
            <SearchSessionToken>string</SearchSessionToken>
          </TPA_Extensions>
        </Property>
      </Properties>
      <TPA_Extensions>
        <HotelPreference>string</HotelPreference>
        <TPA_HotelPreviewImageURI UnitOfMeasureCode="string" Width="string" Height="string">
          <URL>string</URL>
          <GDS_Info MasterChainCode="string">
            <GDS_Codes xsi:nil="true" />
          </GDS_Info>
        </TPA_HotelPreviewImageURI>
        <TPA_PropertyReferenceInfo>
          <PropertyReference ReferenceCatalogCode="string" ReferenceCatalogName="string" />
        </TPA_PropertyReferenceInfo>
        <SearchSessionToken>string</SearchSessionToken>
      </TPA_Extensions>
    </OTA_HotelSearchRS>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /OpenHotelHub.asmx HTTP/1.1
Host: ashburnconcur.roomit.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <authentication xmlns="http://www.concur.com/webservice/auth">
      <userid>string</userid>
      <password>string</password>
    </authentication>
  </soap12:Header>
  <soap12:Body>
    <OTA_HotelSearchRQ EchoToken="string" Version="decimal" PrimaryLangID="string" AltLangID="string" MaxResponses="positiveInteger" xmlns="http://www.opentravel.org/OTA/2003/05">
      <POS>
        <Source ISOCountry="string" ISOCurrency="string" AirportCode="string">
          <RequestorID Type="string" ID="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <BookingChannel>
            <CompanyName xsi:nil="true" />
          </BookingChannel>
        </Source>
        <Source ISOCountry="string" ISOCurrency="string" AirportCode="string">
          <RequestorID Type="string" ID="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <BookingChannel>
            <CompanyName xsi:nil="true" />
          </BookingChannel>
        </Source>
      </POS>
      <Criteria>
        <Criterion>
          <Position Latitude="string" Longitude="string" />
          <Address SameCountryInd="boolean" />
          <RefPoint StateProv="string" CountryCode="string" URI="anyURI" RefPointType="string" Name="string" CityName="string" />
          <RefPoint StateProv="string" CountryCode="string" URI="anyURI" RefPointType="string" Name="string" CityName="string" />
          <HotelRef ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" SegmentCategoryCode="string" PropertyClassCode="string" ArchitecturalStyleCode="string" SupplierIntegrationLevel="nonNegativeInteger" LocationCategoryCode="string" ExtendedCitySearchIndicator="boolean" />
          <HotelRef ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" SegmentCategoryCode="string" PropertyClassCode="string" ArchitecturalStyleCode="string" SupplierIntegrationLevel="nonNegativeInteger" LocationCategoryCode="string" ExtendedCitySearchIndicator="boolean" />
          <Radius Distance="string" DistanceMeasure="string" Direction="string" DistanceMax="string" UnitOfMeasureCode="string" />
          <StayDateRange Start="string" Duration="string" End="string" />
        </Criterion>
        <Criterion>
          <Position Latitude="string" Longitude="string" />
          <Address SameCountryInd="boolean" />
          <RefPoint StateProv="string" CountryCode="string" URI="anyURI" RefPointType="string" Name="string" CityName="string" />
          <RefPoint StateProv="string" CountryCode="string" URI="anyURI" RefPointType="string" Name="string" CityName="string" />
          <HotelRef ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" SegmentCategoryCode="string" PropertyClassCode="string" ArchitecturalStyleCode="string" SupplierIntegrationLevel="nonNegativeInteger" LocationCategoryCode="string" ExtendedCitySearchIndicator="boolean" />
          <HotelRef ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" SegmentCategoryCode="string" PropertyClassCode="string" ArchitecturalStyleCode="string" SupplierIntegrationLevel="nonNegativeInteger" LocationCategoryCode="string" ExtendedCitySearchIndicator="boolean" />
          <Radius Distance="string" DistanceMeasure="string" Direction="string" DistanceMax="string" UnitOfMeasureCode="string" />
          <StayDateRange Start="string" Duration="string" End="string" />
        </Criterion>
      </Criteria>
    </OTA_HotelSearchRQ>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <OTA_HotelSearchRS Version="decimal" EchoToken="string" PrimaryLangID="string" xmlns="http://www.opentravel.org/OTA/2003/05">
      <POS>
        <Source ISOCountry="string" ISOCurrency="string" AirportCode="string">
          <RequestorID Type="string" ID="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <BookingChannel>
            <CompanyName xsi:nil="true" />
          </BookingChannel>
        </Source>
        <Source ISOCountry="string" ISOCurrency="string" AirportCode="string">
          <RequestorID Type="string" ID="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <BookingChannel>
            <CompanyName xsi:nil="true" />
          </BookingChannel>
        </Source>
      </POS>
      <Errors>
        <Error Type="string" ShortText="string" Code="string" DocURL="anyURI" Status="string" Tag="string" RecordID="string" />
        <Error Type="string" ShortText="string" Code="string" DocURL="anyURI" Status="string" Tag="string" RecordID="string" />
      </Errors>
      <Success />
      <Items>
        <anyType />
        <anyType />
      </Items>
      <Properties>
        <Property ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" HotelSegmentCategoryCode="string" SupplierIntegrationLevel="nonNegativeInteger">
          <VendorMessages InfoType="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <Address DefaultInd="boolean" UseType="string" RPH="string" />
          <ContactNumbers>
            <ContactNumber xsi:nil="true" />
            <ContactNumber xsi:nil="true" />
          </ContactNumbers>
          <Award Provider="string" Rating="string" />
          <Award Provider="string" Rating="string" />
          <RelativePosition Direction="string" Distance="string" DistanceUnitName="Mile or Km or Block" UnitOfMeasureCode="string" Nearest="boolean" IndexPointCode="string" Name="string" PrimaryIndicator="boolean" ToFrom="" ApproximateDistanceInd="boolean" />
          <HotelAmenity Code="string" />
          <HotelAmenity Code="string" />
          <Recreation Code="string" />
          <Recreation Code="string" />
          <Service BusinessServiceCode="string" />
          <Service BusinessServiceCode="string" />
          <Policy CheckInTime="time" CheckOutTime="time" />
          <TPA_Extensions>
            <HotelPreference>string</HotelPreference>
            <TPA_HotelPreviewImageURI xsi:nil="true" />
            <TPA_PropertyReferenceInfo xsi:nil="true" />
            <SearchSessionToken>string</SearchSessionToken>
          </TPA_Extensions>
        </Property>
        <Property ChainCode="string" BrandCode="string" HotelCode="string" HotelCityCode="string" HotelName="string" HotelCodeContext="string" ChainName="string" BrandName="string" HotelSegmentCategoryCode="string" SupplierIntegrationLevel="nonNegativeInteger">
          <VendorMessages InfoType="string" />
          <Position Latitude="string" Longitude="string" Altitude="string" AltitudeUnitOfMeasureCode="string" />
          <Address DefaultInd="boolean" UseType="string" RPH="string" />
          <ContactNumbers>
            <ContactNumber xsi:nil="true" />
            <ContactNumber xsi:nil="true" />
          </ContactNumbers>
          <Award Provider="string" Rating="string" />
          <Award Provider="string" Rating="string" />
          <RelativePosition Direction="string" Distance="string" DistanceUnitName="Mile or Km or Block" UnitOfMeasureCode="string" Nearest="boolean" IndexPointCode="string" Name="string" PrimaryIndicator="boolean" ToFrom="" ApproximateDistanceInd="boolean" />
          <HotelAmenity Code="string" />
          <HotelAmenity Code="string" />
          <Recreation Code="string" />
          <Recreation Code="string" />
          <Service BusinessServiceCode="string" />
          <Service BusinessServiceCode="string" />
          <Policy CheckInTime="time" CheckOutTime="time" />
          <TPA_Extensions>
            <HotelPreference>string</HotelPreference>
            <TPA_HotelPreviewImageURI xsi:nil="true" />
            <TPA_PropertyReferenceInfo xsi:nil="true" />
            <SearchSessionToken>string</SearchSessionToken>
          </TPA_Extensions>
        </Property>
      </Properties>
      <TPA_Extensions>
        <HotelPreference>string</HotelPreference>
        <TPA_HotelPreviewImageURI UnitOfMeasureCode="string" Width="string" Height="string">
          <URL>string</URL>
          <GDS_Info MasterChainCode="string">
            <GDS_Codes xsi:nil="true" />
          </GDS_Info>
        </TPA_HotelPreviewImageURI>
        <TPA_PropertyReferenceInfo>
          <PropertyReference ReferenceCatalogCode="string" ReferenceCatalogName="string" />
        </TPA_PropertyReferenceInfo>
        <SearchSessionToken>string</SearchSessionToken>
      </TPA_Extensions>
    </OTA_HotelSearchRS>
  </soap12:Body>
</soap12:Envelope>