Nuitee API Methods

In this section, we will cover the required methods to perform a hotel booking successfully.

This method is used to retrieve a list of hotels by location which have available rooms for a provided date range.

GetCityAvailabilityRequest
Name Type Required Description
RequestId String False A unique Id of the workflow
Login Login True
Login.userName String True
Login.password String True
Login.language String True
SessionID String false
Timeout String True Timeout in milliseconds (ms).
CheckInDate String True Format: yyyy-MM-dd
CheckOutDate String True Format: yyyy-MM-dd
CityCode Long True/False Destination city id from static data. Required if HotelCodes is not set.
Please set to 0 if you search by hotel codes.
HotelCodes List<Long> True/False Destination Hotel id from static data. Required if CityCode is not set.
You can set up to 20 hotelCode.
GuestNationality String True Guest Nationality ISO code.
Currency String True Currency ISO code.
RoomGuests RoomGuests True
RoomGuests.roomGuests List<RoomGuest> True
RoomGuests.roomGuests.adultCount Integer True
RoomGuests.roomGuests.childCount Integer True
RoomGuests.roomGuests.childAges Array of Integer False Required if childCount > 0.
GetCityAvailabilityResponse
Name Type Required Description
ResponseStatus Status True
ResponseStatus.statusCode String True
ResponseStatus.statusMessage String True
SessionID String False
City.cityCode Long True
City.cityName String True
City.countryName String True
CheckInDate String True Format: yyyy-MM-dd
CheckOutDate String True Format: yyyy-MM-dd
Currency String True Currency ISO code.
RoomGuests RoomGuests True
RoomGuests.roomGuests List<RoomGuest> True
RoomGuests.roomGuests.adultCount Integer True
RoomGuests.roomGuests.childCount Integer True
RoomGuests.roomGuests.childAges Array of Integer False Required if childCount > 0.
City City True
HotelResults HotelResults True
HotelResults.hotelResults List<HotelResult> True
HotelResults.hotelResults.minPrice Double True
HotelResults.hotelResults.hotelInfo HotelInfo True
HotelResults.hotelResults.hotelInfo.hotelCode Long True
HotelResults.hotelResults.hotelInfo.hotelName String True
HotelResults.hotelResults.hotelInfo.hotelAddress String True
HotelResults.hotelResults.hotelInfo.hotelPictureUrl String True
HotelResults.hotelResults.hotelInfo.hotelDescription String True
HotelResults.hotelResults.hotelInfo.longitude String True
HotelResults.hotelResults.hotelInfo.latitude String True
HotelResults.hotelResults.hotelInfo.starRating Integer True
HotelResults.hotelResults.RateDetails RateDetails True
HotelResults.hotelResults.RateDetails.minRate Double True
HotelResults.hotelResults.RateDetails.maxRate Double True
HotelResults.hotelResults.RateDetails.rateDetails List<RateDetail> True
HotelResults.hotelResults.RateDetails.rateDetails.CancelPoliciesInfos CancelPoliciesInfos True
HotelResults.hotelResults.RateDetails.rateDetails.CancelPoliciesInfos.defaultPolicy String True
HotelResults.hotelResults.RateDetails.rateDetails.CancelPoliciesInfos.hotelRemarks List<String> False
HotelResults.hotelResults.RateDetails.rateDetails.CancelPoliciesInfos.cancellationPolicies List<String> False
HotelResults.hotelResults.RateDetails.rateDetails.CancelPoliciesInfos.cancelPoliciesInfos List<CancelPolicyInfo> True
HotelResults.hotelResults.RateDetails.rateDetails.CancelPoliciesInfos.cancelPoliciesInfos.cancellationPolicy String True
HotelResults.hotelResults.RateDetails.rateDetails.CancelPoliciesInfos.cancelPoliciesInfos.cancelTime String True Format: yyyy-MM-dd HH:mm:ss
HotelResults.hotelResults.RateDetails.rateDetails.CancelPoliciesInfos.cancelPoliciesInfos.amount (*) Double True
HotelResults.hotelResults.RateDetails.rateDetails.CancelPoliciesInfos.cancelPoliciesInfos.type (*) String True Enum: amount, percentage.
HotelResults.hotelResults.RateDetails.rateDetails.CancelPoliciesInfos.refundableTag
RFN: refundable, NRFN: non-refundable, NS: not stated, PRFN: partially refundable.
String True Enum: RFN, NRFN, NS, PRFN
ConfirmPropertyCode String True
HotelResults.hotelResults.RateDetails.rateDetails.rateDetailCode String True
HotelResults.hotelResults.RateDetails.rateDetails.totalPrice Double True
HotelResults.hotelResults.RateDetails.rateDetails.remarks String False
HotelResults.hotelResults.RateDetails.rateDetails.rooms Rooms True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms List<Room> True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.roomCode String True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.adultCount Integer True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.childCount Integer True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.roomDescription String True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.includedBoard Board True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.includedBoard.boardId String True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.includedBoard.boardDescription String True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.includedBoard.price Double True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.boards Boards False
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.boards.boards List<Boards> True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.boards.boards.boardId String True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.boards.boards.boardDescription String True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.boards.boards.price Double True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.roomRate RoomRate True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.roomRate.initialPrice Double True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.roomRate.price Double True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.roomRate.initialPricePerNight Array Of Double True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.roomRate.pricePerNight Array Of Double True
HotelResults.hotelResults.RateDetails.rateDetails.rooms.rooms.roomRate.promoDescription String False
(*): When type is set to ‘amount’, the amount node contains cancellation amount in requested currency; when type is set to ‘percentage’, the amount node contains the cancellation amount in percentage of the total booking price.