PerfectXML Web Service

PerfectXML

Click here for a complete list of operations.

HotelRoomAvailability

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 /perfectxml.asmx HTTP/1.1
Host: webservices.perfectibe.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://webservices.perfectibe.com/HotelRoomAvailability"

<?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>
    <HotelRoomAvailability xmlns="http://webservices.perfectibe.com/">
      <HotelRoomAvailabilityRQ>
        <Authentication>
          <UserName>string</UserName>
          <Password>string</Password>
          <WebSiteID>string</WebSiteID>
          <APIKey>string</APIKey>
          <APIRev>string</APIRev>
          <UserID>string</UserID>
          <UserHostAddress>string</UserHostAddress>
          <UserAgent>string</UserAgent>
          <UserHostName>string</UserHostName>
        </Authentication>
        <HotelID>string</HotelID>
        <HotelKey>string</HotelKey>
        <CheckInDate>dateTime</CheckInDate>
        <CheckOutDate>dateTime</CheckOutDate>
        <RoomGroupAry>
          <RoomGroup>
            <NumberOfAdults>int</NumberOfAdults>
            <NumberOfChildren>int</NumberOfChildren>
            <ChildrenAges>string</ChildrenAges>
          </RoomGroup>
          <RoomGroup>
            <NumberOfAdults>int</NumberOfAdults>
            <NumberOfChildren>int</NumberOfChildren>
            <ChildrenAges>string</ChildrenAges>
          </RoomGroup>
        </RoomGroupAry>
      </HotelRoomAvailabilityRQ>
    </HotelRoomAvailability>
  </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>
    <HotelRoomAvailabilityResponse xmlns="http://webservices.perfectibe.com/">
      <HotelRoomAvailabilityResult>
        <Errors>
          <Code>string</Code>
          <Description>string</Description>
        </Errors>
        <HotelID>string</HotelID>
        <HotelKey>string</HotelKey>
        <HotelName>string</HotelName>
        <HotelAddress>string</HotelAddress>
        <HotelCity>string</HotelCity>
        <HotelState>string</HotelState>
        <HotelCountry>string</HotelCountry>
        <HotelCurrency>string</HotelCurrency>
        <HotelNoOfRooms>int</HotelNoOfRooms>
        <HotelNoOfFloors>int</HotelNoOfFloors>
        <HotelCheckInTime>string</HotelCheckInTime>
        <HotelCheckOutTime>string</HotelCheckOutTime>
        <HotelPropInformation>string</HotelPropInformation>
        <HotelPropDescription>string</HotelPropDescription>
        <HotelAreaInformation>string</HotelAreaInformation>
        <HotelDrivingDirections>string</HotelDrivingDirections>
        <BestTransportation>string</BestTransportation>
        <FireSafetyCompliant>boolean</FireSafetyCompliant>
        <CheckInInStructions>string</CheckInInStructions>
        <SpecialCheckInInStructions>string</SpecialCheckInInStructions>
        <PerformCheckRate>string</PerformCheckRate>
        <HotelImages>
          <string>string</string>
          <string>string</string>
        </HotelImages>
        <HotelImagesCaptionAry>
          <HotelImagesCaption>
            <HotelImageURL>string</HotelImageURL>
            <HotelImageCaption>string</HotelImageCaption>
          </HotelImagesCaption>
          <HotelImagesCaption>
            <HotelImageURL>string</HotelImageURL>
            <HotelImageCaption>string</HotelImageCaption>
          </HotelImagesCaption>
        </HotelImagesCaptionAry>
        <HotelAmenities>
          <string>string</string>
          <string>string</string>
        </HotelAmenities>
        <HotelAttributesAry>
          <HotelAttributes>
            <Category>string</Category>
            <HotelAttribute>string</HotelAttribute>
          </HotelAttributes>
          <HotelAttributes>
            <Category>string</Category>
            <HotelAttribute>string</HotelAttribute>
          </HotelAttributes>
        </HotelAttributesAry>
        <RoomInfoAry>
          <RoomInfo>
            <RoomSupplierID>string</RoomSupplierID>
            <RoomSupplierName>string</RoomSupplierName>
            <RoomType>string</RoomType>
            <RoomTypeDescription>string</RoomTypeDescription>
            <RoomViewCode>string</RoomViewCode>
            <RoomViewDescription>string</RoomViewDescription>
            <RoomShortDescription>string</RoomShortDescription>
            <RoomLongDescription>string</RoomLongDescription>
            <RoomRateAmount>decimal</RoomRateAmount>
            <RoomBaseAmount>decimal</RoomBaseAmount>
            <RoomTaxAmount>decimal</RoomTaxAmount>
            <RoomROECurrency>string</RoomROECurrency>
            <RoomROE>string</RoomROE>
            <RoomStrikethroughBaseAmount>string</RoomStrikethroughBaseAmount>
            <RoomSurchargesAry xsi:nil="true" />
            <RoomExtraFeesAry xsi:nil="true" />
            <RoomNightlyAmount xsi:nil="true" />
            <RoomNightlyBaseAmount xsi:nil="true" />
            <RateCode>string</RateCode>
            <RateKey>string</RateKey>
            <RateDescripton>string</RateDescripton>
            <SmokingPreference>string</SmokingPreference>
            <MaxOccupancy>int</MaxOccupancy>
            <DepositRequired>boolean</DepositRequired>
            <GuaranteeRequired>boolean</GuaranteeRequired>
            <NonRefundable>boolean</NonRefundable>
            <CancellationPolicy>string</CancellationPolicy>
            <MealIncluded>string</MealIncluded>
            <Meals xsi:nil="true" />
            <RoomImages xsi:nil="true" />
            <RoomAmenities xsi:nil="true" />
            <BedTypesAry xsi:nil="true" />
          </RoomInfo>
          <RoomInfo>
            <RoomSupplierID>string</RoomSupplierID>
            <RoomSupplierName>string</RoomSupplierName>
            <RoomType>string</RoomType>
            <RoomTypeDescription>string</RoomTypeDescription>
            <RoomViewCode>string</RoomViewCode>
            <RoomViewDescription>string</RoomViewDescription>
            <RoomShortDescription>string</RoomShortDescription>
            <RoomLongDescription>string</RoomLongDescription>
            <RoomRateAmount>decimal</RoomRateAmount>
            <RoomBaseAmount>decimal</RoomBaseAmount>
            <RoomTaxAmount>decimal</RoomTaxAmount>
            <RoomROECurrency>string</RoomROECurrency>
            <RoomROE>string</RoomROE>
            <RoomStrikethroughBaseAmount>string</RoomStrikethroughBaseAmount>
            <RoomSurchargesAry xsi:nil="true" />
            <RoomExtraFeesAry xsi:nil="true" />
            <RoomNightlyAmount xsi:nil="true" />
            <RoomNightlyBaseAmount xsi:nil="true" />
            <RateCode>string</RateCode>
            <RateKey>string</RateKey>
            <RateDescripton>string</RateDescripton>
            <SmokingPreference>string</SmokingPreference>
            <MaxOccupancy>int</MaxOccupancy>
            <DepositRequired>boolean</DepositRequired>
            <GuaranteeRequired>boolean</GuaranteeRequired>
            <NonRefundable>boolean</NonRefundable>
            <CancellationPolicy>string</CancellationPolicy>
            <MealIncluded>string</MealIncluded>
            <Meals xsi:nil="true" />
            <RoomImages xsi:nil="true" />
            <RoomAmenities xsi:nil="true" />
            <BedTypesAry xsi:nil="true" />
          </RoomInfo>
        </RoomInfoAry>
      </HotelRoomAvailabilityResult>
    </HotelRoomAvailabilityResponse>
  </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 /perfectxml.asmx HTTP/1.1
Host: webservices.perfectibe.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:Body>
    <HotelRoomAvailability xmlns="http://webservices.perfectibe.com/">
      <HotelRoomAvailabilityRQ>
        <Authentication>
          <UserName>string</UserName>
          <Password>string</Password>
          <WebSiteID>string</WebSiteID>
          <APIKey>string</APIKey>
          <APIRev>string</APIRev>
          <UserID>string</UserID>
          <UserHostAddress>string</UserHostAddress>
          <UserAgent>string</UserAgent>
          <UserHostName>string</UserHostName>
        </Authentication>
        <HotelID>string</HotelID>
        <HotelKey>string</HotelKey>
        <CheckInDate>dateTime</CheckInDate>
        <CheckOutDate>dateTime</CheckOutDate>
        <RoomGroupAry>
          <RoomGroup>
            <NumberOfAdults>int</NumberOfAdults>
            <NumberOfChildren>int</NumberOfChildren>
            <ChildrenAges>string</ChildrenAges>
          </RoomGroup>
          <RoomGroup>
            <NumberOfAdults>int</NumberOfAdults>
            <NumberOfChildren>int</NumberOfChildren>
            <ChildrenAges>string</ChildrenAges>
          </RoomGroup>
        </RoomGroupAry>
      </HotelRoomAvailabilityRQ>
    </HotelRoomAvailability>
  </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>
    <HotelRoomAvailabilityResponse xmlns="http://webservices.perfectibe.com/">
      <HotelRoomAvailabilityResult>
        <Errors>
          <Code>string</Code>
          <Description>string</Description>
        </Errors>
        <HotelID>string</HotelID>
        <HotelKey>string</HotelKey>
        <HotelName>string</HotelName>
        <HotelAddress>string</HotelAddress>
        <HotelCity>string</HotelCity>
        <HotelState>string</HotelState>
        <HotelCountry>string</HotelCountry>
        <HotelCurrency>string</HotelCurrency>
        <HotelNoOfRooms>int</HotelNoOfRooms>
        <HotelNoOfFloors>int</HotelNoOfFloors>
        <HotelCheckInTime>string</HotelCheckInTime>
        <HotelCheckOutTime>string</HotelCheckOutTime>
        <HotelPropInformation>string</HotelPropInformation>
        <HotelPropDescription>string</HotelPropDescription>
        <HotelAreaInformation>string</HotelAreaInformation>
        <HotelDrivingDirections>string</HotelDrivingDirections>
        <BestTransportation>string</BestTransportation>
        <FireSafetyCompliant>boolean</FireSafetyCompliant>
        <CheckInInStructions>string</CheckInInStructions>
        <SpecialCheckInInStructions>string</SpecialCheckInInStructions>
        <PerformCheckRate>string</PerformCheckRate>
        <HotelImages>
          <string>string</string>
          <string>string</string>
        </HotelImages>
        <HotelImagesCaptionAry>
          <HotelImagesCaption>
            <HotelImageURL>string</HotelImageURL>
            <HotelImageCaption>string</HotelImageCaption>
          </HotelImagesCaption>
          <HotelImagesCaption>
            <HotelImageURL>string</HotelImageURL>
            <HotelImageCaption>string</HotelImageCaption>
          </HotelImagesCaption>
        </HotelImagesCaptionAry>
        <HotelAmenities>
          <string>string</string>
          <string>string</string>
        </HotelAmenities>
        <HotelAttributesAry>
          <HotelAttributes>
            <Category>string</Category>
            <HotelAttribute>string</HotelAttribute>
          </HotelAttributes>
          <HotelAttributes>
            <Category>string</Category>
            <HotelAttribute>string</HotelAttribute>
          </HotelAttributes>
        </HotelAttributesAry>
        <RoomInfoAry>
          <RoomInfo>
            <RoomSupplierID>string</RoomSupplierID>
            <RoomSupplierName>string</RoomSupplierName>
            <RoomType>string</RoomType>
            <RoomTypeDescription>string</RoomTypeDescription>
            <RoomViewCode>string</RoomViewCode>
            <RoomViewDescription>string</RoomViewDescription>
            <RoomShortDescription>string</RoomShortDescription>
            <RoomLongDescription>string</RoomLongDescription>
            <RoomRateAmount>decimal</RoomRateAmount>
            <RoomBaseAmount>decimal</RoomBaseAmount>
            <RoomTaxAmount>decimal</RoomTaxAmount>
            <RoomROECurrency>string</RoomROECurrency>
            <RoomROE>string</RoomROE>
            <RoomStrikethroughBaseAmount>string</RoomStrikethroughBaseAmount>
            <RoomSurchargesAry xsi:nil="true" />
            <RoomExtraFeesAry xsi:nil="true" />
            <RoomNightlyAmount xsi:nil="true" />
            <RoomNightlyBaseAmount xsi:nil="true" />
            <RateCode>string</RateCode>
            <RateKey>string</RateKey>
            <RateDescripton>string</RateDescripton>
            <SmokingPreference>string</SmokingPreference>
            <MaxOccupancy>int</MaxOccupancy>
            <DepositRequired>boolean</DepositRequired>
            <GuaranteeRequired>boolean</GuaranteeRequired>
            <NonRefundable>boolean</NonRefundable>
            <CancellationPolicy>string</CancellationPolicy>
            <MealIncluded>string</MealIncluded>
            <Meals xsi:nil="true" />
            <RoomImages xsi:nil="true" />
            <RoomAmenities xsi:nil="true" />
            <BedTypesAry xsi:nil="true" />
          </RoomInfo>
          <RoomInfo>
            <RoomSupplierID>string</RoomSupplierID>
            <RoomSupplierName>string</RoomSupplierName>
            <RoomType>string</RoomType>
            <RoomTypeDescription>string</RoomTypeDescription>
            <RoomViewCode>string</RoomViewCode>
            <RoomViewDescription>string</RoomViewDescription>
            <RoomShortDescription>string</RoomShortDescription>
            <RoomLongDescription>string</RoomLongDescription>
            <RoomRateAmount>decimal</RoomRateAmount>
            <RoomBaseAmount>decimal</RoomBaseAmount>
            <RoomTaxAmount>decimal</RoomTaxAmount>
            <RoomROECurrency>string</RoomROECurrency>
            <RoomROE>string</RoomROE>
            <RoomStrikethroughBaseAmount>string</RoomStrikethroughBaseAmount>
            <RoomSurchargesAry xsi:nil="true" />
            <RoomExtraFeesAry xsi:nil="true" />
            <RoomNightlyAmount xsi:nil="true" />
            <RoomNightlyBaseAmount xsi:nil="true" />
            <RateCode>string</RateCode>
            <RateKey>string</RateKey>
            <RateDescripton>string</RateDescripton>
            <SmokingPreference>string</SmokingPreference>
            <MaxOccupancy>int</MaxOccupancy>
            <DepositRequired>boolean</DepositRequired>
            <GuaranteeRequired>boolean</GuaranteeRequired>
            <NonRefundable>boolean</NonRefundable>
            <CancellationPolicy>string</CancellationPolicy>
            <MealIncluded>string</MealIncluded>
            <Meals xsi:nil="true" />
            <RoomImages xsi:nil="true" />
            <RoomAmenities xsi:nil="true" />
            <BedTypesAry xsi:nil="true" />
          </RoomInfo>
        </RoomInfoAry>
      </HotelRoomAvailabilityResult>
    </HotelRoomAvailabilityResponse>
  </soap12:Body>
</soap12:Envelope>