WebRES API Documentation

Availability


Request Body Example

                                    
Request Body parameters
ELEMENT ATTRIBUTE Description TYPE
AvailUpdateRQ Root element. Object
Authentication Information used to validate and grant access to the API interface. String
key ASI will be provide later. String
Hotel Information about the property. Object
id Specifies the unique id of the property. Int
guid Specifies the unique id of the property. String
DateRange This element specifies dates on which availability information provided in this message apply Object
from Specifies the starting date of a date range.

Note : Date format is YYYY-MM-DD.
Datetime
to Specifies the ending date of a date range.

Note : Date format is YYYY-MM-DD.
Datetime
RoomType Specifies the basic room type information. Object
id Room type ID. Int
closed Specifies whether the room is closed (not bookable) on the specified date, for the specified rate. Bool
closedToArrival Specifies if the room is unavailable to book if the guest checks in on the specified date. Bool
closedToDeparture Specifies if the room is unavailable to book if the guest checks out on the specified date. Bool
minNights The minimum number of days a guest must book the specified room, for the specified rate,
if the stay includes the specified date.
Int
maxNights The maximum number of days a guest may book the specified room, for the specified rate,
if the stay includes the specified date.
Int
Inventory Number of rooms being made available for sale on booking engine. Object
Allocation The total number of rooms made available via booking engine for this room type. Int



Response Body Success Example

                                    
Response Body Error Example

                                    
Response Body parameters
ELEMENT ATTRIBUTE Description TYPE
AvailUpdateRS Contains the response data. Object
Success Indicates the success of the request. Object
Error Contains potential errors. These can help you understand what went wrong with your request. Object
Code Error codes. Int


Rates


Request Body Example

                                    
Request Body parameters
ELEMENT ATTRIBUTE Description TYPE
RateUpdateRQ Root element. Object
Authentication Information used to validate and grant access to the API interface. String
key ASI will be provide later. String
Hotel Information about the property. Object
id Specifies the unique id of the property. Integer
guid Specifies the unique id of the property. String
DateRange This element specifies dates on which availability information provided in this message apply Object
from Specifies the starting date of a date range. DateTime
to Specifies the ending date of a date range. DateTime
RoomType Information about Room Type. Object
id Specifies Room Type Id. Integer
RatePlan Information about Rate Plan. Object
id Specifies RatePlan Id. String
currency Specifies Currency Code like USD, INR, EUR etc. String
BaseRate Information about Room Base Rate. Object
rate Specifies Room Rate Float
ExtraAdultRate Information about Extra Adult Rate. Object
rate Specifies Adult Rate Float
ExtraChildRate Information about Extra Child Rate. Object
rate Specifies Child Rate Float



Response Success Example

                                    
Response Error Example

                                    
Response parameters
ELEMENT ATTRIBUTE Description TYPE
AvailUpdateRS Contains the response data. Object
Success Indicates the success of the request. Object
Error Contains potential errors. These can help you understand what went wrong with your request. Object
Code Error codes. Int

Booking


Request for Booking Create API Example

                                    
Request for Booking Update API Example

                                    
Request for Booking Cancel API Example

                                    
Request Body parameters
ELEMENT ATTRIBUTE Description TYPE
BookingRetrievalRS Root element. Object
Bookings Information used to validate and grant access to the API interface. Object
id Integer
bookingmasterid Indicate unique booking IS Integer
type Its indicate to create booking [Book]/ Modify Booking [Modify]
/ Cancel Booking [Cancel]
String
createdatetime Indicate to Create Booking Date and Time.

Note: Format is yyyy-MM-dd hh:mm:ss
DateTime
source Indicate to the request comes on which platform String
marketcode ASI String
asifdbookingid Indicate to asifd Booking Id
Note: Only use when booking is Update or Cancel
String
canceldatetime Indicate to Cancel Booking Date & Time
Note: Only use when booking Cancel
DateTime
Hotel Information about the property. Object
id Specifies the unique id of the property. Integer
guid Specifies the unique id of the property. String
RoomStay Specifies details of promotion, stay, arrival and departure, Rates, Taxs etc. Object
promotioncode Specifies the any Promotion is there or not. String
nonrefundable Specifies the Booking is refundable or not. If cancel the booking,
it amount refundable or not.
It is indicate keywork is "Y" or "N".
Note: "Y" indicate booking is nonrefundable and "N" indicate
           booking is refundable.
String
noofrooms Specifies no of room for booking. guid
rateplanid Specifies rate planid. guid
roomtypeid Specifies room type id. guid
ratetype Specifies type of room. String
StayDate Information for Booking Arrivaldate and Departure. Object
arrival Specifies Booking Arrival Date.

Note: Format is YYYY-MM-DD.
DateTime
departure Specifies Booking Departure Date.

Note: Format is YYYY-MM-DD.
DateTime
PerDayRates Information about Rates Day by Day. Object
currency Specifies Payment Currency Name (US Dollar, IN Ruppe etc). String
PerDayRate Information about Rate Daywise.
extrachargepets Specifies Extra charges for Pets. Float
extraxhargechild Specifies Extra charges for Children. Float
extrachargeadult Specifies Extra charges for Adults. Float
baserate Specifies Room Base Rate. Float
staydate Specifies Stay Date..

Note: Format is YYYY-MM-DD.
DateTime
Total Information about Total Rates.
amountaftertaxes Specifies Amount after Taxes. Float
amountoftaxes Specifies Amount of Taxes. Float
specialrequestsamountaftertaxes Specifies Special Request Amount after Tax Float
specialrequestsamountoftaxes Specifies Special Request Amount of Tax Float
currency Specifies currency. String
PrimaryGuest Information about Guest. Object
Name Information about Guest. Object
firstname Indicate the Guest first name. String
lastname Indicate the Guest Last name. String
address Indicate Guest's Address. String
city Indicate Guest's City. String
stateprov Indicate Guest's State. String
country Indicate Guest's Country. String
postalcode Indicate Guest's Postalcode. String
phone Indicate Guest's Phone. String
fax Indicate Guest's fax. String
email Indicate Guest's Email. String
GuestComment Information about Guest's Comment. Object
SpecialRequests Information about Special Requests of Guest. Object
SpecialRequest Indicate Special Request Message. String
code String
amountaftertaxes Specifies Amount after Taxes Float
amountoftaxes Specifies Amount to Taxes Float
quantity Specifies Quantity Integer
requesttype Specifies Guest Request String
Payment Information about Payment Details. Object
type Indicate Payment Type String
PaymentCard Information about Payment Card Details. Object
cardcode Indicate card code (VISA CARD, MASTER CARD etc.) String
cardnumber Indicate Card Number String
expiredate Indicate Card' Expiry Date String
isdeposit Indicate Payment is Deposit or Not?(True/False) Bool
cvv2 Indicate Card CVV Number String
CardHolder Information about Card Holder Details. Object
name Indicate Card Holder Name String
address Indicate Card Holder Address String
city Indicate Card Holder City String
stateprov Indicate CardHolder State Bool
country Indicate Card Holder Country String
postalcode Indicate Card Holder Postalcode String



Response Success Example

                                    
Response parameters
ELEMENT ATTRIBUTE Description TYPE
BookingConfirmRQ Contains the Booking Confirmation response data. Object
Authentication Information used to validate and grant access to the API interface. String
key ASI will be provide later. String
Hotel Information about the property. Object
id Specifies the unique id of the property. Integer
guid Specifies the unique id of the property. String
BookingConfirmNumbers Indicates Booking Confirmation Details. Object
bookingID Indicate Booking Id. String
bookingType Indicate Booking Type String
confirmNumber Indicate Booking Confirmation Number. String
confirmTime Indicate Booking Confirmation Time. String