OHHService Web Service

OHHService

Click here for a complete list of operations.

availability

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/availability"

<?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_HotelAvailRQ AltLangID="string" EchoToken="string" OnRequestInd="string" PrimaryLangID="string" RateDetailsInd="string" Version="decimal" xmlns="http://www.opentravel.org/OTA/2003/05">
      <AvailRequestSegments>
        <AvailRequestSegment>
          <HotelSearchCriteria>
            <Criterion xsi:nil="true" />
            <Criterion xsi:nil="true" />
          </HotelSearchCriteria>
          <RoomStayCandidates>
            <RoomStayCandidate xsi:nil="true" />
            <RoomStayCandidate xsi:nil="true" />
          </RoomStayCandidates>
          <StayDateRange Start="date" End="date" />
          <TPA_Extensions>
            <HotelPreference>string</HotelPreference>
            <TPA_HotelPreviewImageURI xsi:nil="true" />
            <TPA_PropertyReferenceInfo xsi:nil="true" />
            <SearchSessionToken>string</SearchSessionToken>
          </TPA_Extensions>
        </AvailRequestSegment>
      </AvailRequestSegments>
      <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>
    </OTA_HotelAvailRQ>
  </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_HotelAvailRS Version="decimal" PrimaryLangID="string" AltLangID="string" EchoToken="string" xmlns="http://www.opentravel.org/OTA/2003/05">
      <Warnings>
        <Warning Type="string" ShortText="string" Code="string" Status="string" Tag="string" />
        <Warning Type="string" ShortText="string" Code="string" Status="string" Tag="string" />
      </Warnings>
      <Success>string</Success>
      <RoomStays>
        <RoomStay>
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
          <RoomTypes>
            <RoomType xsi:nil="true" />
            <RoomType xsi:nil="true" />
          </RoomTypes>
          <RatePlans>
            <RatePlan xsi:nil="true" />
            <RatePlan xsi:nil="true" />
          </RatePlans>
          <RoomRates>
            <RoomRate xsi:nil="true" />
            <RoomRate xsi:nil="true" />
          </RoomRates>
          <GuestCounts>
            <GuestCount xsi:nil="true" />
          </GuestCounts>
          <TimeSpan End="string" Start="string" />
          <BasicPropertyInfo ChainCode="string" HotelCode="string" />
        </RoomStay>
        <RoomStay>
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
          <RoomTypes>
            <RoomType xsi:nil="true" />
            <RoomType xsi:nil="true" />
          </RoomTypes>
          <RatePlans>
            <RatePlan xsi:nil="true" />
            <RatePlan xsi:nil="true" />
          </RatePlans>
          <RoomRates>
            <RoomRate xsi:nil="true" />
            <RoomRate xsi:nil="true" />
          </RoomRates>
          <GuestCounts>
            <GuestCount xsi:nil="true" />
          </GuestCounts>
          <TimeSpan End="string" Start="string" />
          <BasicPropertyInfo ChainCode="string" HotelCode="string" />
        </RoomStay>
      </RoomStays>
      <RoomStays>
        <RoomStay>
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
          <RoomTypes>
            <RoomType xsi:nil="true" />
            <RoomType xsi:nil="true" />
          </RoomTypes>
          <RatePlans>
            <RatePlan xsi:nil="true" />
            <RatePlan xsi:nil="true" />
          </RatePlans>
          <RoomRates>
            <RoomRate xsi:nil="true" />
            <RoomRate xsi:nil="true" />
          </RoomRates>
          <GuestCounts>
            <GuestCount xsi:nil="true" />
          </GuestCounts>
          <TimeSpan End="string" Start="string" />
          <BasicPropertyInfo ChainCode="string" HotelCode="string" />
        </RoomStay>
        <RoomStay>
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
          <RoomTypes>
            <RoomType xsi:nil="true" />
            <RoomType xsi:nil="true" />
          </RoomTypes>
          <RatePlans>
            <RatePlan xsi:nil="true" />
            <RatePlan xsi:nil="true" />
          </RatePlans>
          <RoomRates>
            <RoomRate xsi:nil="true" />
            <RoomRate xsi:nil="true" />
          </RoomRates>
          <GuestCounts>
            <GuestCount xsi:nil="true" />
          </GuestCounts>
          <TimeSpan End="string" Start="string" />
          <BasicPropertyInfo ChainCode="string" HotelCode="string" />
        </RoomStay>
      </RoomStays>
      <TPA_Extensions RateDetailsInd="string">
        <DBIFields>
          <DBIField Name="string" Value="string" />
          <DBIField Name="string" Value="string" />
        </DBIFields>
      </TPA_Extensions>
      <SessionID>string</SessionID>
      <StayDetails>
        <Start>date</Start>
        <End>date</End>
        <Rooms>integer</Rooms>
        <GuestCount>integer</GuestCount>
      </StayDetails>
      <Error ErrorCode="string" Severity="string" ErrorMessage="string" ShortText="string" />
      <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>
    </OTA_HotelAvailRS>
  </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_HotelAvailRQ AltLangID="string" EchoToken="string" OnRequestInd="string" PrimaryLangID="string" RateDetailsInd="string" Version="decimal" xmlns="http://www.opentravel.org/OTA/2003/05">
      <AvailRequestSegments>
        <AvailRequestSegment>
          <HotelSearchCriteria>
            <Criterion xsi:nil="true" />
            <Criterion xsi:nil="true" />
          </HotelSearchCriteria>
          <RoomStayCandidates>
            <RoomStayCandidate xsi:nil="true" />
            <RoomStayCandidate xsi:nil="true" />
          </RoomStayCandidates>
          <StayDateRange Start="date" End="date" />
          <TPA_Extensions>
            <HotelPreference>string</HotelPreference>
            <TPA_HotelPreviewImageURI xsi:nil="true" />
            <TPA_PropertyReferenceInfo xsi:nil="true" />
            <SearchSessionToken>string</SearchSessionToken>
          </TPA_Extensions>
        </AvailRequestSegment>
      </AvailRequestSegments>
      <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>
    </OTA_HotelAvailRQ>
  </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_HotelAvailRS Version="decimal" PrimaryLangID="string" AltLangID="string" EchoToken="string" xmlns="http://www.opentravel.org/OTA/2003/05">
      <Warnings>
        <Warning Type="string" ShortText="string" Code="string" Status="string" Tag="string" />
        <Warning Type="string" ShortText="string" Code="string" Status="string" Tag="string" />
      </Warnings>
      <Success>string</Success>
      <RoomStays>
        <RoomStay>
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
          <RoomTypes>
            <RoomType xsi:nil="true" />
            <RoomType xsi:nil="true" />
          </RoomTypes>
          <RatePlans>
            <RatePlan xsi:nil="true" />
            <RatePlan xsi:nil="true" />
          </RatePlans>
          <RoomRates>
            <RoomRate xsi:nil="true" />
            <RoomRate xsi:nil="true" />
          </RoomRates>
          <GuestCounts>
            <GuestCount xsi:nil="true" />
          </GuestCounts>
          <TimeSpan End="string" Start="string" />
          <BasicPropertyInfo ChainCode="string" HotelCode="string" />
        </RoomStay>
        <RoomStay>
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
          <RoomTypes>
            <RoomType xsi:nil="true" />
            <RoomType xsi:nil="true" />
          </RoomTypes>
          <RatePlans>
            <RatePlan xsi:nil="true" />
            <RatePlan xsi:nil="true" />
          </RatePlans>
          <RoomRates>
            <RoomRate xsi:nil="true" />
            <RoomRate xsi:nil="true" />
          </RoomRates>
          <GuestCounts>
            <GuestCount xsi:nil="true" />
          </GuestCounts>
          <TimeSpan End="string" Start="string" />
          <BasicPropertyInfo ChainCode="string" HotelCode="string" />
        </RoomStay>
      </RoomStays>
      <RoomStays>
        <RoomStay>
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
          <RoomTypes>
            <RoomType xsi:nil="true" />
            <RoomType xsi:nil="true" />
          </RoomTypes>
          <RatePlans>
            <RatePlan xsi:nil="true" />
            <RatePlan xsi:nil="true" />
          </RatePlans>
          <RoomRates>
            <RoomRate xsi:nil="true" />
            <RoomRate xsi:nil="true" />
          </RoomRates>
          <GuestCounts>
            <GuestCount xsi:nil="true" />
          </GuestCounts>
          <TimeSpan End="string" Start="string" />
          <BasicPropertyInfo ChainCode="string" HotelCode="string" />
        </RoomStay>
        <RoomStay>
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
          <RoomTypes>
            <RoomType xsi:nil="true" />
            <RoomType xsi:nil="true" />
          </RoomTypes>
          <RatePlans>
            <RatePlan xsi:nil="true" />
            <RatePlan xsi:nil="true" />
          </RatePlans>
          <RoomRates>
            <RoomRate xsi:nil="true" />
            <RoomRate xsi:nil="true" />
          </RoomRates>
          <GuestCounts>
            <GuestCount xsi:nil="true" />
          </GuestCounts>
          <TimeSpan End="string" Start="string" />
          <BasicPropertyInfo ChainCode="string" HotelCode="string" />
        </RoomStay>
      </RoomStays>
      <TPA_Extensions RateDetailsInd="string">
        <DBIFields>
          <DBIField Name="string" Value="string" />
          <DBIField Name="string" Value="string" />
        </DBIFields>
      </TPA_Extensions>
      <SessionID>string</SessionID>
      <StayDetails>
        <Start>date</Start>
        <End>date</End>
        <Rooms>integer</Rooms>
        <GuestCount>integer</GuestCount>
      </StayDetails>
      <Error ErrorCode="string" Severity="string" ErrorMessage="string" ShortText="string" />
      <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>
    </OTA_HotelAvailRS>
  </soap12:Body>
</soap12:Envelope>