Block Room
BlockRoom method is used to get the updated prices and cancellation policies for the selected rooms before proceeding with the hotel booking. Block Room will also get the norms, if any.
1.This method should preferably be called before taking guest details from the client, so that in case of any price change a proper intimation can be provided.
2.In case of Price change or Cancellation Policy change, you will get new price and/or new cancellation policy in the BlockRoom response with IsPriceChanged node and/or IsCancellationPolicyChanged node set as ‘true’
3. The price comparison is to be made at the client’s end, and BlockRoom request needs to be sent again with the updated price and/ or updated cancellation policy.
Service URL (REST) to be used:
Block Room Request
Level | Element | Format | Comments | Mandatory |
---|---|---|---|---|
1 | ResultIndex | Integer | ResultIndex (Index of the hotel for which details are to be fetched) |
Mandatory |
2 | HotelCode | String | Unique hotel code | Mandatory |
3 | HotelName | String | Unique hotel name | Mandatory |
4 | GuestNationality | String | ISO Country Code (Ex. India = IN, Great Britain = GB) | Mandatory |
5 | NoOfRooms | Integer | Requested number of rooms | Mandatory |
6 | ClientReferenceNo | String | Client Reference No (Currently not in use, passs as 0) |
Optional |
7 | IsVoucherBooking | Boolean | This represents whether the request is to Hold the booking or to voucher it directly (Set true if you want to voucher the booking. Set false, if you want to hold the booking and voucher it later) |
Mandatory |
8 | HotelRoomsDetails[] | Array | Array of hotel room details | Mandatory |
8.1 | ChildCount | Integer | Child Count | Mandatory |
8.2 | RequireAllPaxDetails | Boolean | Represents if passenger detail is required all guests or only for lead guest. If true, then details would be required for all guests | Mandatory |
8.3 | RoomId | Integer | Room Id | Mandatory |
8.4 | RoomStatus | String | Room Status | Mandatory |
8.5 | RoomIndex | Integer | Room Index | Mandatory |
8.6 | RoomTypeCode | Integer | Room Type Code | Mandatory |
8.7 | RoomTypeName | String | Room Type Name | Mandatory |
8.8 | RatePlan | String | Rate Plan | Mandatory |
8.9 | RatePlanCode | String | Rate Plan Code associated with room | Mandatory |
8.10 | InfoSource | String | Info Source | Mandatory |
8.11 | SequenceNo | String | Sequence No | Optional |
8.12 | DayRates[] | Array | Day Rate | Mandatory |
8.12.1 | Amount | Decimal | Amount | Mandatory |
8.12.2 | Date | DATE TIME | Date | Mandatory |
8.13 | SupplierPrice | Decimal | Supplier Price | Mandatory |
8.14 | Price[] | Array | Price detail of the room | Mandatory |
8.14.1 | CurrencyCode | String | Currency in which minimum hotel price is returned | Mandatory |
8.14.2 | RoomPrice | Decimal | Price of the room | Mandatory |
8.14.3 | Tax | Decimal | Tax applicable for the room | Mandatory |
8.14.4 | ExtraGuestCharge | Decimal | Extra Guest Charges applicable for the room | Mandatory |
8.14.5 | ChildCharge | Decimal | Child Charges applicable for the room | Mandatory |
8.14.6 | OtherCharges | Decimal | Other Charges applicable for the room | Mandatory |
8.14.7 | Discount | Decimal | Discount applicable for the room | Mandatory |
8.14.8 | PublishedPrice | Decimal | Published Price of the room (This price would be different only if Room Price is on PUBLISHED. In case of NET, Published Price would be same as Offered Price) |
Mandatory |
8.14.9 | PublishedPriceRoundedOff | Integer | Published Price (rounded off) of the room (This price is for display purpose only) |
Mandatory |
8.14.10 | OfferedPrice | Decimal | Offered Price of the room | Mandatory |
8.14.11 | OfferedPriceRoundedOff | Integer | Offered Price (rounded off) of the room | Mandatory |
8.14.12 | AgentCommission | Decimal | Commission applicable on the Room Price (srdv will part this amount if Room Price is on Published) |
Mandatory |
8.14.13 | AgentMarkUp | Decimal | Agent Mark Up applicable on the Room Price (Agent will earn this amount if Hotel mark up is set from backend) |
Mandatory |
8.14.14 | ServiceTax | Decimal | Service tax applicable for the room | Mandatory |
8.14.15 | TDS | Decimal | TDS applicable on Commission Earned (This would be deducted only when commission is parted to the agent) |
Mandatory |
8.14.16 | ServiceCharge | Decimal | Service Charge | Mandatory |
8.14.17 | TotalGSTAmount | Decimal | Total GST Amount | Mandatory |
8.14.18 | GST[] | Array | Array of GST | Mandatory |
8.14.18.1 | CGSTAmount | Decimal | CGST Amount | Mandatory |
8.14.18.2 | CGSTRate | Decimal | CGST Rate | Mandatory |
8.14.18.3 | CessAmount | Decimal | Cess Amount | Mandatory |
8.14.18.4 | CessRate | Decimal | Cess Rate | Mandatory |
8.14.18.5 | IGSTAmount | Decimal | IGST Amount | Mandatory |
8.14.18.6 | IGSTRate | Decimal | IGST Rate | Mandatory |
8.14.18.7 | SGSTAmount | Decimal | SGST Amount | Mandatory |
8.14.18.8 | SGSTRate | Decimal | SGST Rate | Mandatory |
8.14.18.9 | TaxableAmount | Decimal | TaxableAmount | Mandatory |
8.15 | RoomPromotion | String | Room Promotion | Mandatory |
8.16 | Amenities[] | Array | List of room amenities | Mandatory |
8.17 | SmokingPreference* | Enumeration | Smoking Preference associated with room (Mandatory - SmokingPreference NoPreference = 0, Smoking = 1, NonSmoking = 2, Either = 3) | Mandatory |
8.18 | BedTypes[] | Array | Array of bed types | Mandatory |
8.19 | HotelSupplements[] | Array | Hotel Supplements | Mandatory |
8.20 | LastCancellationDate | Date | Last Cancellation Date (No cancellation charge will be applied up to this date. If the date is less than book date then cancellation charge will be applicable as per policy) |
Mandatory |
8.21 | CancellationPolicies[] | Array | Array of cancellation policies | Mandatory |
8.21.1 | Charge | Decimal | Cancellation charge (Contains amount in case of Amount, Percentage value in case of Percentage, No of nights in case of Night) |
Mandatory |
8.21.2 | ChargeType | Enumeration | Cancellation charge type- CancellationPolicies - ChargeType Amount = 1, Percentage = 2, Nights = 3 |
Mandatory |
8.21.3 | Currency | String | Currency | Mandatory |
8.21.4 | FromDate | Date | Date from which charges will apply Format:(dd/mm/yyyy) |
Mandatory |
8.21.5 | ToDate | Date | Date up to which charges will apply Format:(dd/mm/yyyy) |
Mandatory |
8.22 | CancellationPolicy | String | Cancellation policy in text format (Format: Text) |
Mandatory |
8.23 | Inclusion[] | Array | Inclusion | Mandatory |
8.24 | BedTypeCode | Integer | Bed Type Code | Mandatory |
8.25 | Supplements | String | Supplements | Mandatory |
9 | SrdvType | String | Simple result data version Type | Mandatory |
10 | SrdvIndex | String | Simple result data | Mandatory |
11 | TraceId | String | Trace ID | Mandatory |
12 | EndUserIp | String | IP Address of the end user | Mandatory |
13 | ClientId | String | Client ID provided to the agency at registration | Mandatory |
14 | UserName | String | Client ID provided to the agency at registration | Mandatory |
15 | Password | String | Client ID provided to the agency at registration | Mandatory |
Level | Element | Format | Comments | Mandatory |
---|---|---|---|---|
1 | Error[] | Array | Error | Mandatory |
1.1 | ErrorCode | String | Error Code | Mandatory |
1.2 | ErrorMessage | String | Error Message | Mandatory |
2 | AvailabilityType | String | Availability
Type If the
value is
available, we
may book, it
means that. (Possible Values can be 'Available' or 'Confirm'. If 'available', the user may either choose not to book the property and go for an alternate property or book the inventory but get it reconfirmed from agent/ srdv Backoffice as there is a possibility of the property being sold out. If 'confirm', the user may proceed to book the property without requiring to reconfirm from agent/ SRDV BACK OFFICE Backoffice.) |
Mandatory |
3 | ResponseStatus | Enumeration | Response Status (NotSet = 0, Successfull = 1, Failed = 2, InValidRequest = 3, InValidSession = 4, InValidCredenti als = 5) |
Mandatory |
4 | TraceId | String | Trace ID | Mandatory |
5 | GSTAllowed | Boolean | GSTAllowed | Mandatory |
6 | IsPriceChanged | Boolean | Represent if
price is changed
or not (Would be set true, if there is a price change. Would be set as false, if no price change) |
Mandatory |
7 | IsCancellationPolicyChanged | Boolean | Represent if
cancellation
policy is
changed or not (Would be set true, if there is a change in cancellation policy. Would be set as false, if no change in cancellation policy) |
Mandatory |
8 | IsHotelPolicyChanged | Boolean | Represent if hotel policy is changed or not | Mandatory |
9 | HotelNorms | String | Hotel Norms | Optional |
10 | HotelName | String | Unique hotel Name | Mandatory |
11 | AddressLine1 | String | Address Line 1 | Optional |
12 | AddressLine2 | String | Address Line 2 | Optional |
13 | StarRating | String | StarRating | Mandatory |
14 | HotelPolicyDetail | String | Hotel Policy Detail | Optional |
15 | Latitude | String | Latitude | Optional |
16 | Longitude | String | Longitude | Optional |
17 | BookingAllowedForRoamer | Boolean | Booking Allowed For Roamer | Optional |
18 | HotelRoomsDetails[] | Array | Array of hotel room details | Mandatory |
18.1 | ChildCount | Integer | Child Count | Mandatory |
18.2 | RequireAllPaxDetails | Boolean | Represents if passenger detail is required all guests or only for lead guest. If true, then details would be required for all guests | Mandatory |
18.3 | RoomId | Integer | Room Id | Mandatory |
18.4 | RoomStatus | String | Room Status | Mandatory |
18.5 | RoomIndex | Integer | Index of the room (referenced in OptionsForBooking) | Mandatory |
18.6 | RoomTypeCode | SInteger | Room Type Code | Mandatory |
18.7 | RoomTypeName | String | Room Type Name | Mandatory |
18.8 | RatePlanCode | String | Rate Plan Code associated with room | Mandatory |
18.9 | RatePlan | String | Rate Plan | Mandatory |
18.10 | InfoSource | String | Info Source | Mandatory |
18.11 | SequenceNo | String | Sequence Number of the Room | Optional |
18.12 | DayRates[] | Array | Per day rate breakup of the room | Mandatory |
18.12.1 | Amount | Decimal | Per day price of the room | Mandatory |
18.12.2 | Date | Date | Date for which day rate is applicable | Mandatory |
18.13 | SupplierPrice | Decimal | Supplier Price | Mandatory |
18.14 | Price[] | Array | Price detail of the room | Mandatory |
18.14.1 | CurrencyCode | String | Currency in which minimum hotel price is returned | Mandatory |
18.14.2 | RoomPrice | Decimal | Price of the room | Mandatory |
18.14.3 | Tax | Decimal | Tax applicable for the room | Mandatory |
18.14.4 | ExtraGuestCharge | Decimal | Extra Guest Charges applicable for the room | Mandatory |
18.14.5 | ChildCharge | Decimal | Child Charges applicable for the room | Mandatory |
18.14.6 | OtherCharges | Decimal | Other Charges applicable for the room | Mandatory |
18.14.7 | Discount | Decimal | Discount applicable for the room | Mandatory |
18.14.8 | PublishedPrice | Decimal | Published Price of the room (This price would be different only if Room Price is on PUBLISHED. In case of NET, Published Price would be same as Offered Price) |
Mandatory |
18.14.9 | PublishedPriceRoundedOff | Integer | Published Price (rounded off) of the room (This price is for display purpose only) | Mandatory> |
18.14.10 | OfferedPrice | Decimal | Offered Price of the room | Mandatory |
18.14.11 | OfferedPriceRoundedOff | Integer | Offered Price (rounded off) of the room | Mandatory |
18.14.12 | AgentCommission | Decimal | Commission applicable on the Room Price (srdv will part this amount if Room Price is on Published) |
Mandatory |
18.14.13 | AgentMarkUp | Decimal | Agent Mark Up applicable on the Room Price (Agent will earn this amount if Hotel mark up is set from backend) |
Mandatory |
18.14.14 | ServiceTax | Decimal | TDS applicable on Commission Earned (This would be deducted only when commission is parted to the agent) |
Mandatory |
18.14.15 | TDS | Decimal | TDS applicable on Commission Earned (This would be deducted only when commission is parted to the agent) |
Mandatory |
18.14.16 | ServiceCharge | Decimal | Service Charge | Mandatory |
18.14.17 | TotalGSTAmount | Decimal | Total GST Amount | Mandatory |
18.14.18 | GST[] | Array | Array of GST | Mandatory |
18.14.18.1 | CGSTAmount | Decimal | CGST Amount | Mandatory |
18.14.18.2 | CGSTRate | Decimal | CGST Rate | Mandatory |
18.14.18.3 | CessAmount | Decimal | Cess Amount | Mandatory |
18.14.18.4 | CessRate | Decimal | Cess Rate | Mandatory |
18.14.18.5 | IGSTAmount | Decimal | IGST Amount | Mandatory |
18.14.18.6 | IGSTRate | Decimal | IGST Rate | Mandatory |
18.14.18.7 | SGSTAmount | Decimal | SGST Amount | Mandatory |
18.14.18.8 | SGSTRate | Decimal | SGST Rate | Mandatory |
18.14.18.9 | TaxableAmount | Decimal | TaxableAmount | Mandatory |
18.15 | RoomPromotion | String | Room Promotion applicable for the room | Optional |
18.16 | Amenities[] | Array | List of room amenities | Optional |
18.17 | Amenity[] | Array | Amenity | Optional |
18.18 | SmokingPreference | Enumeration | Smoking Preference SmokingPrefere nce NoPreference = 0, Smoking = 1, NonSmoking = 2, Either = 3 |
Mandatory |
18.19 | BedTypes[] | Array | Array of bed types | Optional |
18.20 | HotelSupplements[] | Array | Hotel Supplements | Optional |
18.21 | LastCancellationDate | Date | Last Cancellation Date (No cancellation charge will be applied up to this date. If the date is less than book date then cancellation charge will be applicable as per policy) |
Mandatory |
18.22 | CancellationPolicies[] | Array | Array of cancellation policies | Mandatory |
18.22.1 | Charge | Decimal | Cancellation charge (Contains amount in case of Amount, Percentage value in case of Percentage, No of nights in case of Night) |
Mandatory |
18.22.2 | ChargeType | Enumeration | Cancellation charge type- CancellationPolicies - ChargeType Amount = 1, Percentage = 2, Nights = 3 |
Mandatory |
18.22.3 | Currency | String | Currency | Mandatory |
18.22.4 | FromDate | Date | Date from which charges will apply Format:(dd/mm/yyyy) |
Mandatory |
18.22.5 | ToDate | Date | Date up to which charges will apply Format:(dd/mm/yyyy) |
Mandatory |
18.23 | CancellationPolicy | String | Cancellation policy in text format (Format: Text) |
Mandatory |
19.24 | Inclusion[] | Array | Inclusion | Optional |