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 | EndUserIp | String | Public IP address of the end user initiating the hotel search request. Used for security, tracking, and compliance purposes. | Mandatory |
| 2 | ClientId | String | Unique client identifier assigned to the agency during API registration and onboarding. | Mandatory |
| 3 | UserName | String | Username provided to the agency at the time of registration registration | Mandatory |
| 4 | Password | String | Password provided to the agency at the time of registration | Mandatory |
| 5 | TraceId | Integer | Trace ID (Trace Id to be echoed back from search response. This can be used to trace particular search/ book at SRDV's end) | Mandatory |
| 6 | SrdvType | String | Response type identifier indicating the version or category of data returned by the SRDV system. | Mandatory |
| 7 | SrdvIndex | String | Unique identifier for the hotel search result record. | Mandatory |
| 8 | ResultIndex | String | ResultIndex (Index of the hotel for which details are to be fetched) | Mandatory |
| 9 | HotelCode | String | Unique hotel code | Mandatory |
| 10 | HotelName | String | Unique hotel code (Hotel Code for which details are to be fetched) | Mandatory |
| 11 | GuestNationality | String | ISO 3166-1 alpha-2 (2-letter code) Example: India → IN | Mandatory |
| 12 | NoOfRooms | String | Requested number of rooms | Mandatory |
| 13 | ClientReferenceNo | Integer | Client Reference No (Currently not in use, passs as 0) | Optional |
| 14 | 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 |
| 15 | HotelRoomsDetails[] | Array | Array of hotel room details | Mandatory |
| 15.1 | ChildCount | Integer | Number of children accommodated in the room | Mandatory |
| 15.2 | RequireAllPaxDetails | Boolean | Indicates whether passenger details are required for all guests or only for the lead guest. If true, then details would be required for all guests | Mandatory |
| 15.3 | RoomId | String | Unique identifier assigned to the room | Mandatory |
| 15.4 | RoomStatus | String | Current availability status of the room | Mandatory |
| 15.5 | RoomIndex | String | Unique room index used for room selection and booking reference | Mandatory |
| 15.6 | RoomTypeCode | String | Unique code representing the room type | Mandatory |
| 15.7 | RoomTypeName | String | Name of the room type | Mandatory |
| 15.8 | RatePlan | String | Name of the Rate plan | Mandatory |
| 15.9 | RatePlanCode | String | Rate Plan Code associated with room | Mandatory |
| 15.10 | InfoSource | String | Shows the format to select possible multiple room combinations to book. (Possible values can be FixedCombination, Open Combination) | Mandatory |
| 15.11 | SequenceNo | String | Sequence Number of the Room (Not Applicable for API Customers) | Optional |
| 15.12 | DayRates[] | Array | Per day rate breakup of the room | Mandatory |
| 15.12.1 | Amount | Decimal | Per day price of the room | Mandatory |
| 15.12.2 | Date | DATE | Date for which day rate is applicableFormat: (YYYY-MM-DD) | Mandatory |
| 15.13 | SupplierPrice | Decimal | Price provided by the hotel supplier before any markup or adjustments | Mandatory |
| 15.14 | Price{} | Object | Contains the complete pricing breakdown and fare details applicable to the selected room. | Mandatory |
| 15.14.1 | CurrencyCode | String | Currency in which minimum hotel price is returned | Mandatory |
| 15.14.2 | RoomPrice | Decimal | Price of the room | Mandatory |
| 15.14.3 | Tax | Decimal | Tax applicable for the room | Mandatory |
| 15.14.4 | ExtraGuestCharge | Decimal | Extra Guest Charges applicable for the room | Mandatory |
| 15.14.5 | ChildCharge | Decimal | Child Charges applicable for the room | Mandatory |
| 15.14.6 | OtherCharges | Decimal | Other Charges applicable for the room | Mandatory |
| 15.14.7 | Discount | Decimal | Discount applicable for the room | Mandatory |
| 15.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 |
| 15.14.9 | PublishedPriceRoundedOff | Decimal | Published Price (rounded off) of the room (This price is for display purpose only) | Mandatory |
| 15.14.10 | OfferedPrice | Decimal | Offered Price of the room | Mandatory |
| 15.14.11 | OfferedPriceRoundedOff | Decimal | Offered Price (rounded off) of the room | Mandatory |
| 15.14.12 | AgentCommission | Decimal | Commission applicable on the Room Price (srdv will part this amount if Room Price is on Published) | Mandatory |
| 15.14.13 | AgentMarkUp | Decimal | Agent Markup applicable on the Room Price (Agent will earn this amount if Hotel mark up is set from backend) | Mandatory |
| 15.14.14 | ServiceTax | Decimal | Service tax applicable for the room | Mandatory |
| 15.14.15 | TDS | Decimal | TDS applicable on Commission Earned (This would be deducted only when commission is parted to the agent) | Mandatory |
| 15.14.16 | ServiceCharge | Decimal | Service Charge | Mandatory |
| 15.14.17 | TotalGSTAmount | Decimal | Total Goods and Services Tax (GST) amount applicable to the room booking. | Mandatory |
| 15.14.18 | GST{} | Object | Contains a detailed breakdown of all GST components applicable to the booking. | Mandatory |
| 15.14.18.1 | CGSTAmount | Decimal | Central Goods and Services Tax (CGST) amount applied to the booking. | Mandatory |
| 15.14.18.2 | CGSTRate | Decimal | Percentage rate of CGST applied to the taxable amount. | Mandatory |
| 15.14.18.3 | CessAmount | Decimal | Additional cess amount levied on the booking, where applicable. | Mandatory |
| 15.14.18.4 | CessRate | Decimal | Percentage rate used to calculate the cess amount. | Mandatory |
| 15.14.18.5 | IGSTAmount | Decimal | Integrated Goods and Services Tax (IGST) amount applicable to the booking. | Mandatory |
| 15.14.18.6 | IGSTRate | Decimal | Percentage rate of IGST applied to the taxable amount. | Mandatory |
| 15.14.18.7 | SGSTAmount | Decimal | State Goods and Services Tax (SGST) amount applicable to the booking. | Mandatory |
| 15.14.18.8 | SGSTRate | Decimal | Percentage rate of SGST applied to the taxable amount. | Mandatory |
| 15.14.18.9 | TaxableAmount | Decimal | Total amount on which applicable taxes and GST components are calculated. | Mandatory |
| 15.15 | RoomPromotion | String | Promotional offers, discounts, or special benefits associated with the selected room. | Mandatory |
| 15.16 | Amenities[] | Array | Collection of amenities and facilities available with the room. | Mandatory |
| 15.16.1 | Name | String | Name of the room amenity or facility. | Mandatory |
| 15.16.2 | FontAwesome | String | Font Awesome icon class corresponding to the amenity for UI representation. | Mandatory |
| 15.16.3 | IcoFont | String | IcoFont icon class corresponding to the amenity for UI representation. | Mandatory |
| 15.17 | SmokingPreference | String | Indicates the smoking policy associated with the room (e.g., Smoking, Non-Smoking). | Mandatory |
| 15.18 | BedTypes | String | Specifies the type and configuration of beds available in the room. | Mandatory |
| 15.19 | HotelSupplements | String | Additional hotel-provided services, facilities, or benefits associated with the room. | Mandatory |
| 15.20 | LastCancellationDate | Date | Last date and time before cancellation charges become applicable. | Mandatory |
| 15.21 | CancellationPolicies[] | Array | Collection of cancellation rules and penalties applicable to the booking. | Mandatory |
| 15.21.1 | Charge | Integer | Cancellation fee applicable under the specified cancellation policy. | Mandatory |
| 15.21.2 | ChargeType | Integer | Defines the calculation method for the cancellation charge (Amount, Percentage, or Number of Nights). | Mandatory |
| 15.21.3 | Currency | String | ISO currency code in which the cancellation charge is specified. | Mandatory |
| 15.21.4 | FromDate | Date Time | Effective start date and time from which the cancellation policy becomes applicable. | Mandatory |
| 15.21.5 | ToDate | Date Time | Effective end date and time until which the cancellation policy remains applicable. | Mandatory |
| 15.22 | BedTypeCode | String | Unique code representing the bed type configuration available in the room. | Mandatory |
| 15.23 | Supplements | String | Additional supplements, services, or benefits included with the room booking. | Mandatory |
Block Room Response
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | BlockRoomResult | Object | Includes all the Information related to the hotel | Mandatory |
| 1.1 | Error{} | Object | Contains error details returned by the API when the request cannot be processed successfully. | Mandatory |
| 1.1.1 | ErrorCode | Integer | Unique error code identifying the type of error encountered during request processing. | Mandatory |
| 1.1.2 | ErrorMessage | String | Human-readable description of the error returned by the API. | Mandatory |
| 1.2 | AvailabilityType | String | Indicates whether a property can be booked. Available → Booking possible but requires reconfirmation (may sell out). Confirm → Booking guaranteed, no reconfirmation needed. | Mandatory |
| 1.3 | TraceId | Integer | Unique identifier assigned to the API request for tracking, debugging, and support purposes. | Mandatory |
| 1.4 | ResponseStatus | Enumeration | Response Status (NotSet = 0, Successfull = 1, Failed = 2, InValidRequest = 3, InValidSession = 4, InValidCredentials = 5) | Mandatory |
| 1.5 | GSTAllowed | Boolean | Indicates whether GST details can be provided and applied during the booking process. | Mandatory |
| 1.6 | IsPackageDetailsMandatory | Boolean | IsPackageDetailsMandatory | Mandatory |
| 1.7 | IsPackageFare | Boolean | Specifies whether package-related details are required to complete the booking. | Mandatory |
| 1.8 | IsPriceChanged | Boolean | Indicates if the price has changed (true if changed, false if not) | Mandatory |
| 1.9 | IsCancellationPolicyChanged | Boolean | Indicates if the cancellation policy has changed(true if changed, false if not) | Mandatory |
| 1.10 | IsHotelPolicyChanged | Boolean | Represent if hotel policy is changed or not | Mandatory |
| 1.11 | HotelNorms | String | Additional hotel rules, restrictions, and guest guidelines applicable to the booking. | Optional |
| 1.12 | HotelName | String | Official name of the hotel. | Mandatory |
| 1.13 | AddressLine1 | String | Primary address line of the hotel property. | Optional |
| 1.14 | AddressLine2 | String | Secondary address line containing additional location details, if available. | Optional |
| 1.15 | City | String | City where the hotel is located. | Mandatory |
| 1.16 | State | String | State or province where the hotel is located. | Mandatory |
| 1.17 | Pincode | String | Postal or ZIP code of the hotel's location | Mandatory |
| 1.18 | CountryName | String | Country in which the hotel is located. | Mandatory |
| 1.19 | HotelContactNo | String | Primary contact number of the hotel. | Mandatory |
| 1.20 | StarRating | Integer | Official star rating assigned to the hotel. | Mandatory |
| 1.21 | HotelPolicyDetail | String | Detailed hotel policies, including check-in, check-out, and stay-related terms. | Optional |
| 1.22 | Latitude | String | Latitude coordinate of the hotel location. | Optional |
| 1.23 | Longitude | String | Longitude coordinate of the hotel location. | Optional |
| 1.24 | BookingAllowedForRoamer | Boolean | Indicates whether bookings are permitted for roaming or walk-in guests. | Optional |
| 1.25 | HotelRoomsDetails[] | Array | List of room details available for booking at the hotel. | Mandatory |
| 1.25.1 | ChildCount | Integer | Number of children accommodated in the room. | Mandatory |
| 1.25.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 |
| 1.25.3 | RoomId | String | Unique identifier assigned to the room. | Mandatory |
| 1.25.4 | RoomStatus | String | Current availability status of the room. | Mandatory |
| 1.25.5 | RoomIndex | String | Unique room index used for room selection and booking reference. | Mandatory |
| 1.25.6 | RoomTypeCode | Integer | Unique code representing the room type. | Mandatory |
| 1.25.7 | RoomTypeName | String | Name or description of the room category. | Mandatory |
| 1.25.8 | RatePlanCode | String | Rate Plan Code associated with room | Mandatory |
| 1.25.9 | RatePlan | String | Name of the rate plan applicable to the room booking. | Mandatory |
| 1.25.10 | InfoSource | String | Source from which the room and pricing information is obtained. | Mandatory |
| 1.25.11 | SequenceNo | String | Sequence number used to identify the room within a room combination or booking group. | Optional |
| 1.25.12 | DayRates[] | Array | Daily rate breakdown for the room throughout the stay period. | Mandatory |
| 1.25.12.1 | Date | Date | Date for which the corresponding room rate is applicable. Format: YYYY-MM-DD. | Mandatory |
| 1.25.12.2 | Amount | Decimal | Room rate applicable for the specified date. | Mandatory |
| 1.25.13 | SupplierPrice | Decimal | Net rate provided by the hotel supplier. | Mandatory |
| 1.25.14 | Price{} | Object | Contains the complete pricing breakdown for the room. | Mandatory |
| 1.25.14.1 | CurrencyCode | String | Currency in which minimum hotel price is returned | Mandatory |
| 1.25.14.2 | RoomPrice | Decimal | Price of the room | Mandatory |
| 1.25.14.3 | Tax | Decimal | Tax applicable for the room | Mandatory |
| 1.25.14.4 | ExtraGuestCharge | Decimal | Extra Guest Charges applicable for the room | Mandatory |
| 1.25.14.5 | ChildCharge | Decimal | Child Charges applicable for the room | Mandatory |
| 1.25.14.6 | OtherCharges | Decimal | Other Charges applicable for the room | Mandatory |
| 1.25.14.7 | Discount | Decimal | Discount applicable for the room | Mandatory |
| 1.25.14.8 | PublishedPrice | Decimal | Published Price of the room(This price would be different only if Room Price is on PUBLISHED. In caseof NET, Published Price would be same as Offered Price) | Mandatory |
| 1.25.14.9 | PublishedPriceRoundedOff | Decimal | Published Price (rounded off) of the room (This price is for display purpose only) | Mandatory> |
| 1.25.14.10 | OfferedPrice | Decimal | Final room price offered after discounts and adjustments. | Mandatory |
| 1.25.14.11 | OfferedPriceRoundedOff | Decimal | Offered Price (rounded off) of the room | Mandatory |
| 1.25.14.12 | AgentCommission | Decimal | Commission applicable on the Room Price (srdv will part this amount if Room Price is on Published) | Mandatory |
| 1.25.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 |
| 1.25.14.14 | ServiceTax | Decimal | TDS applicable on Commission Earned (This would be deducted only when commission is parted to the agent) | Mandatory |
| 1.25.14.15 | TDS | Decimal | TDS applicable on Commission Earned(This would be deducted only when commission is parted to the agent) | Mandatory |
| 1.25.14.16 | ServiceCharge | Decimal | Additional service fee charged for the booking. | Mandatory |
| 1.25.14.17 | TotalGSTAmount | Decimal | Total GST amount applicable to the booking. | Mandatory |
| 1.25.14.18 | GST{} | Object | Contains the GST tax breakdown details. | Mandatory |
| 1.25.14.18.1 | CGSTAmount | Decimal | Central GST amount applicable to the booking. | Mandatory |
| 1.25.14.18.2 | CGSTRate | Decimal | Central GST rate applied to the taxable amount. | Mandatory |
| 1.25.14.18.3 | CessAmount | Decimal | Cess amount applicable to the booking. | Mandatory |
| 1.25.14.18.4 | CessRate | Decimal | Cess rate applied to the taxable amount. | Mandatory |
| 1.25.14.18.5 | IGSTAmount | Decimal | Integrated GST amount applicable to the booking. | Mandatory |
| 1.25.14.18.6 | IGSTRate | Decimal | Integrated GST rate applied to the taxable amount. | Mandatory |
| 1.25.14.18.7 | SGSTAmount | Decimal | State GST amount applicable to the booking. | Mandatory |
| 1.25.14.18.8 | SGSTRate | Decimal | State GST rate applied to the taxable amount. | Mandatory |
| 1.25.14.18.9 | TaxableAmount | Decimal | Amount on which GST calculations are based. | Mandatory |
| 1.25.15 | RoomPromotion | String | Room Promotion applicable for the room | Optional |
| 1.25.16 | Amenities[] | Array | List of room amenities | Optional |
| 1.25.16.1 | Name | String | Name of the room amenity. | Optional |
| 1.25.16.2 | FontAwesome | String | Font Awesome icon identifier for the amenity. | Optional |
| 1.25.16.3 | IcoFont | String | IcoFont icon identifier for the amenity. | Optional |
| 1.25.17 | SmokingPreference | Enumeration | Smoking Preference ( NoPreference = 0, Smoking = 1, NonSmoking = 2, Either = 3) | Mandatory |
| 1.25.18 | BedTypes | String | Details of available bed configurations in the room. | Optional |
| 1.25.19 | HotelSupplements | String | Additional hotel services or supplements included with the room. | Optional |
| 1.25.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 |
| 1.25.21 | IsPassportMandatory | Boolean | Indicates whether passport details are required for booking. | Mandatory |
| 1.25.22 | IsPANMandatory | Boolean | Indicates whether PAN details are required for booking. | Mandatory |
| 1.25.23 | FullRefundAllowed | Boolean | Indicates whether a full refund is permitted upon cancellation. | Mandatory |
| 1.25.24 | CancellationPolicies[] | Array | List of applicable cancellation policy rules. | Mandatory |
| 1.25.24.1 | Charge | Decimal | Cancellation charge (Contains amount in case of Amount, Percentage value in case of Percentage, No of nights in caseof Night) | Mandatory |
| 1.25.24.2 | ChargeType | Enumeration | Cancellation charge type- CancellationPolicies - ChargeType Amount = 1, Percentage = 2, Nights = 3 | Mandatory |
| 1.25.24.3 | Currency | String | Currency in which cancellation charges are specified. | Mandatory |
| 1.25.24.4 | FromDate | Date | Date from which charges will apply (Format: dd/mm/yyyy) | Mandatory |
| 1.25.24.5 | ToDate | Date | Date up to which charges will apply (Format: dd/mm/yyyy) | Mandatory |
| 1.25.25 | CancellationPolicy | String | Cancellation policy in text format | Mandatory |
| 1.25.26 | Inclusion[] | Array | List of inclusions provided with the room booking. | Optional |