OTA_HotelAvailRS

The OTA_HotelAvailRS is the response Agoda will return for every OTA_HotelAvailRQ. There are 2 types of response which are Success and Failure. The error codes and their descriptions are available in API Validation section.

Example Success Response

<OTA_HotelAvailRS PrimaryLangID="en" TimeStamp="2017-10-02T19:56:15+00:00" xmlns="http://www.opentravel.org/OTA/2003/05">
    <Success/>
    <RoomStays>
        <RoomStay>
            <RoomTypes>
                <RoomType RoomTypeCode="A1K" NumberOfUnits="99">
                    <RoomDescription Name="Deluxe King Room">
                        <Text>Deluxe King Room default long desc</Text>
                        <Image/>
                    </RoomDescription>
                </RoomType>
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanCode="RAC" RatePlanName="Standard Rate">
                    <RatePlanDescription Name="Standard Rate">
                        <Text>Standard Rate default Long Desc</Text>
                    </RatePlanDescription>
                    <Commission>
                        <Percent>8</Percent>
                    </Commission>
                </RatePlan>
            </RatePlans>
            <RoomRates>
                <RoomRate RoomTypeCode="A1K" RatePlanCode="RAC">
                    <Rates>
                        <Rate>
                            <Base AmountBeforeTax="108.18" AmountAfterTax="124.95" CurrencyCode="USD"/>
                            <Fees>
                                <Fee Amount="80.00" CurrencyCode="USD"/>
                            </Fees>
                            <Total AmountBeforeTax="540.90" AmountAfterTax="704.75" CurrencyCode="USD">
                                <Taxes Amount="163.85">
                                    <Tax Amount="10.82" Code="3" EffectiveDate="2017-11-25" ExpireDate="2017-11-29" ChargeFrequency="1">
                                        <TaxDescription Name="Name">
                                            <Text>City Tax</Text>
                                        </TaxDescription>
                                        <TaxDescription Name="Description">
                                            <Text>10pct City Tax per night Inclusive</Text>
                                        </TaxDescription>
                                    </Tax>
                                    <Tax Amount="5.95" Code="10" EffectiveDate="2017-11-25" ExpireDate="2017-11-29" ChargeFrequency="1">
                                        <TaxDescription Name="Name">
                                            <Text>Occupancy Tax</Text>
                                        </TaxDescription>
                                        <TaxDescription Name="Description">
                                            <Text>5 pct Occupancy Tax per night EXCLUDED</Text>
                                        </TaxDescription>
                                    </Tax>
                                    <Tax Amount="80.00" Code="12" EffectiveDate="2017-11-25" ExpireDate="2017-11-29" ChargeFrequency="12">
                                        <TaxDescription Name="Name">
                                            <Text>Resort Fee</Text>
                                        </TaxDescription>
                                        <TaxDescription Name="Description">
                                            <Text>80 USD Resort Fee per stay EXCLUSIVE</Text>
                                        </TaxDescription>
                                    </Tax>
                                </Taxes>
                            </Total>
                        </Rate>
                    </Rates>
                </RoomRate>
            </RoomRates>
            <BasicPropertyInfo HotelCode="61027" HotelName="Jymnson Hotel 001"/>
        </RoomStay>
    </RoomStays>
    <Criteria>
        <Criterion>
            <HotelRef HotelCode="61027" HotelName="Jymnson Hotel 001"/>
        </Criterion>
    </Criteria>
</OTA_HotelAvailRS>

Example Failure Response

<OTA_HotelAvailRS PrimaryLangID="en" TimeStamp="2017-09-05T12:24:50+00:00" xmlns="http://www.opentravel.org/OTA/2003/05">
<Errors>
<Error Type="1" ShortText="Error checking availability." Code="197" />
</Errors>
</OTA_HotelAvailRS>

Elements and Attributes

Element

Number



Type


Description










OTA_HotelAvailRS

1





Root node
















Primary language preference for the message.


@PrimaryLangID

0..1



String


The human language is identified by ISO 639








codes.










@TimeStamp

1



DateTime


Time of the transaction










OTA_HotelAvailRS /






Only present if it was a successful response. The


0..1





Errors node will not be present if the Success


Success











node is present.

















OTA_HotelAvailRS /








RoomStays
















RoomStays /








RoomStay
















RoomStay /








RoomTypes
















RoomTypes /








RoomType
















@RoomTypeCode

1



String


Identifies the room type










@NumberOfUnits

1



Integer


Available units of this room type which matches





the availability request

















RoomType /








RoomDescription
















@Name

1



String


Language specific room type name










RoomDescription /

1



String


Language specific short description for this


Text




room type