Block
This method is used to tentatively book (block) a ticket. This tentative ticket will be blocked for a specified time and can be confirmed within specified time limit. Once user gives all the requested details along with the seat numbers and boarding point, client calls the blockmethod to book the seats tentatively. If the specified seats are still available from supplier side, then system blocks them tentatively. If there is no confirmation call (next step) from theclient before that time, the system will unblock the seats.
Key Points: Few points to remember before calling the block method
• In case of multiple passenger ticket all passenger details like Name, Email, Gender, Phone
no, Age, Address are mandatory.
• Address is mandatory only for lead guest.
• ID type is mandatory or not will be define by the ‘IsTypeRequired’ node of search response.
• If value of this node is true, then ID-type is mandatory and need to pass in book request.
• This method should be called after taking guest details from the client, so that in case of any
price change a proper intimation can be provided.
• In case of Price change, you will get new price in the BlockBus response with IsPriceChanged
node set as ‘true’.
Service URL (REST) to be used:
Seat Block Request
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | EndUserIp | String | IP address of the End User | Mandatory |
| 2 | ClientId | String | Client ID is provided to the agency at the time of registration. | Mandatory |
| 3 | UserName | String | User name is provided to the agency at the time of registration. | Mandatory |
| 4 | Password | String | Password is provided to the agency at the time of registration. | Mandatory |
| 5 | TraceId | String | Unique identifier for identifying every unique search Required for audit purpose from Search Response. | Mandatory |
| 6 | SrdvIndex | String | From the Search response. | Mandatory |
| 7 | ResultIndex | String | Define the result number. | Mandatory |
| 8 | BoardingPointId | String | Id of the boarding point selected (e.g. 43289). | Mandatory |
| 9 | DroppingPointId | String | Id of the dropping point selected (e.g. 43289). | Mandatory |
| 10 | RefId | String | Reference ID | Mandatory |
| 11 | Passengers[] | Array | Array of passenger details like name, email, Gender etc. | Mandatory |
| 11.1 | Title | String | Passenger’s title (e.g., Mr, Mrs, Miss). | Mandatory |
| 11.2 | FirstName | String | Passenger's first name. | Mandatory |
| 11.3 | LastName | String | Passenger's last name. | Mandatory |
| 11.4 | Gender | String | Gender of the passenger. (1 = Male, 2 = Female). | Mandatory |
| 11.5 | Age | String | Age of the passenger. | Mandatory |
| 11.6 | String | Email address of the lead passenger. | Mandatory for lead passenger | |
| 11.7 | PhoneNo | String | Mobile number of the lead passenger. | Mandatory for lead passenger |
| 11.8 | LeadPassenger | Boolean | Defines whether this passenger is the lead traveler (true/false). | Mandatory |
| 11.9 | IdNumber | String | Government-issued ID number of the passenger (e.g., Aadhaar, PAN). | Optional / As required |
| 11.10 | IdType | String | Type of ID provided (e.g., Aadhaar, Passport, Voter ID). | Optional / As required |
| 11.11 | Address | String | Residential address of the passenger. | Optional |
| 11.12 | SeatName | String | Allocated seat name or number for the passenger. | Mandatory |
Seat Block Response
| Level | Element | Format | Comments | Mandatory |
|---|---|---|---|---|
| 1 | Error{} | Object | Error | Mandatory |
| 1.1 | ErrorCode | Integer | Code corresponding to the Error | Mandatory |
| 1.2 | ErrorMessage | String | Contains error description corresponding to ErrorCode. Error Message would be blank in case ErrorCode=0. | Mandatory |
| 2 | TraceId | String | Unique identifier for identifying every unique search Required for audit purpose. | Mandatory |
| 3 | SrdvIndex | String | Unique API Index | Mandatory |
| 4 | ResultIndex | String | Define the result number | Mandatory |
| 5 | BlockKey | String | Encrypted key used to block and confirm the selected bus seat. | Mandatory |
| 6 | DepartureTime | Date Time | Scheduled departure time in ISO format (e.g., 2025-07-10T01:00:00). | Mandatory |
| 7 | ArrivalTime | Date Time | Scheduled arrival time in ISO format (e.g., 2025-07-10T05:00:00). | Mandatory |
| 8 | Duration | Time | Total journey duration in minutes. | Mandatory |
| 9 | IsArrivingNextDay | Boolean | Indicates whether the bus arrives on the next day. ("true" / "false") | Mandatory |
| 10 | BusType | String | Type of bus (e.g., “A/C Sleeper”, “Non A/C Seater”, etc.). | Mandatory |
| 11 | TravelsName | String | Name of the travel company operating the bus. | Mandatory |
| 12 | Price | Object | Contains fare-related details for the result. | Mandatory |
| 12.1 | BaseFare | Decimal | The base fare of the bus before taxes and additional charges. | Mandatory |
| 13 | BoardingPointdetails {} | Object | Details of the selected boarding point. | Mandatory |
| 13.1 | Id | String | Unique ID of the boarding point. | Mandatory |
| 13.2 | MasterId | String | Master reference ID assigned by the operator. | Mandatory |
| 13.3 | Name | String | Name or label of the boarding point. | Mandatory |
| 13.4 | Location | String | Area or locality of the boarding point. | Mandatory |
| 13.5 | Address | String | Full address of the boarding location. | Mandatory |
| 13.6 | Landmark | String | Nearby landmark to identify the location easily. | Mandatory |
| 13.7 | ContactNumber | String | Contact number available at the boarding point. | Mandatory |
| 13.8 | Time | Time | Scheduled boarding/reporting time in 24-hour format. | Mandatory |
| 14 | DroppingPointsDetails {} | Object | Details of the selected dropping point. | Mandatory |
| 14.1 | Id | String | Unique ID of the dropping point. | Mandatory |
| 14.2 | MasterId | String | Master reference ID assigned by the operator for this drop point. | Optional |
| 14.3 | Name | String | Name or title of the dropping point (e.g., "Domlur") . | Mandatory |
| 14.4 | Location | String | Area or locality where the dropping point is situated. | Mandatory |
| 14.5 | Address | String | Full address of the dropping point. | Mandatory |
| 14.6 | Landmark | String | Nearby landmark to easily identify the dropping location. | Mandatory |
| 14.7 | ContactNumber | String | Contact number for support at the dropping point. | Mandatory |
| 14.8 | Time | Time | Scheduled time of arrival at the dropping point (24-hour format). | Mandatory |
| 15 | CancellationPolicy[] | Array | List of cancellation rules applicable to the booking. | Mandatory |
| 15.1 | CancellationCharge | String | The cancellation fee value as per the policy. | Mandatory |
| 15.2 | CancellationChargeType | String | Type of the cancellation charge – e.g., "Percentage" or "Amount". | Mandatory |
| 15.3 | PolicyString | String | Readable text explaining the cancellation condition. | Mandatory |
| 15.4 | TimeBeforeDept | String | Number of hours before departure to which this policy applies. | Mandatory |
| 15.5 | FromDate | Date | The date from which this cancellation rule is valid. | Optional |
| 16 | Passengers [] | Array | List of passengers with their details and selected seat info. | Mandatory |
| 16.1 | LeadPassenger | Boolean | Defines whether the passenger is the lead traveler.("true"/"false") | Mandatory |
| 16.2 | Title | String | Passenger's title (e.g., Mr, Mrs, Miss). | Mandatory |
| 16.3 | FirstName | String | Passenger's first name. | Mandatory |
| 16.4 | Age | String | Age of the passenger. | Mandatory |
| 16.5 | Gender | String | Gender of the passenger (1 = Male, 2 = Female). | Mandatory |
| 16.6 | IdNumber | String | Government-issued ID number (e.g., Aadhaar, PAN). | Optional |
| 16.7 | IdType | String | Type of ID (e.g., Aadhaar, Passport). | Optional |
| 16.8 | PhoneNo | String | Mobile number of the passenger (usually for lead passenger). | Mandatory for LeadPassenger |
| 16.9 | Address | String | Address of the passenger. | Optional |
| 16.10 | Seat {} | Object | Contains details of the selected seat for the passenger. | Mandatory |
| 16.10.1 | ColumnNo | String | Seat column number. | Mandatory |
| 16.10.2 | RowNo | String | Seat row number. | Mandatory |
| 16.10.3 | IsLadiesSeat | Boolean | Indicates if the seat is reserved for ladies. | Optional |
| 16.10.4 | IsMalesSeat | Boolean | Indicates if the seat is reserved for males. | Optional |
| 16.10.5 | IsUpper | Boolean | Indicates whether the seat is in the upper berth. | Optional |
| 16.10.6 | SeatFare | String | Total fare for the selected seat. | Mandatory |
| 16.10.7 | SeatIndex | String | Unique index used to identify the selected seat. | Mandatory |
| 16.10.8 | SeatName | String | Name/Number of the seat (e.g., "1"). | Mandatory |
| 16.10.9 | SeatStatus | Boolean | Indicates if the seat is available or booked. | Mandatory |
| 16.10.10 | SeatType | String | Type of seat (e.g., Seater, Sleeper). | Mandatory |
| 16.10.11 | Width | String | Width unit of the seat block. | Optional |
| 16.10.12 | Price {} | Object | Contains fare breakdown for the selected seat. | Mandatory |
| 16.10.12.1 | CurrencyCode | String | Currency used (e.g., INR). | Mandatory |
| 16.10.12.2 | BaseFare | String | Base price of the seat. | Mandatory |
| 16.10.12.3 | Tax | String | Tax applied to the base fare. | Mandatory |
| 16.10.12.4 | PublishedFare | String | Total published fare (Base + Tax). | Mandatory |
| 16.10.12.5 | OfferedFare | String | Discounted or offered fare. | Mandatory |
| 16.10.12.6 | GstTaxableAmount | String | Fare amount on which GST is calculated. | Mandatory |
| 16.10.12.7 | GstRate | String | GST rate applied to the taxable amount. | Mandatory |
| 16.10.12.8 | GSTAmount | String | Total GST amount charged on the ticket. | Mandatory |