Search
This method provides availability information with the cheapest fare option available. The request includes single query. When properly submitted, the Search Response returns the available option.
Once the requested query is parsed and validated, the booking engine start searching for the best option. If the search is successful it will return Result object.
Service URL (REST) to be used:
Search Request
Level | Element | Format | Comments | Mandatory |
---|---|---|---|---|
1 | ClientId | String | Client ID provided to the agency at registration | Mandatory |
2 | UserName | String | User name provided to the agency at registration | Mandatory |
3 | Password | String | Password provided to the agency at registration | Mandatory |
4 | source_city | String | Source city name | Mandatory |
5 | Source_code | Integer | City ID of Source/Origin City Ex: 501 (City ID for Bhubaneshwar) | Mandatory |
6 | destination_city | String | Destination city name | Mandatory |
7 | destination_code | Integer | City ID of Destination City Ex: 2566 (City ID for Baripada) | Mandatory |
8 | depart_date | Date Time | Preferred date time Format: YYYY-MM-DD [2020-02-31] | Mandatory |
Search Response
Level | Element | Format | Comments | Mandatory |
---|---|---|---|---|
1 | Error[] | Array | 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 | Result[] | Array | Contain the details of transaction | Mandatory |
2.1 | TraceId | String | Unique identifier for identifying every unique search Required for audit purpose. |
Mandatory |
2.2 | BusResults[] | Array | Contain bus result | Mandatory |
2.2.1 | ResultIndex | Integer | Define the result number | Mandatory |
2.2.2 | ArrivalTime | Date Time | Preferred date time Format: yyyyMMddTH H:mm:ss (Approx. arrival time at the destination.) |
Mandatory |
2.2.3 | AvailableSeats | Integer | Number of seats Available. (e.g.: 41) | Mandatory |
2.2.4 | DepartureTime | Date Time | Preferred date time Format: yyyyMMddTH H:mm:ss (Define the bus departure date time.) |
Mandatory |
2.2.5 | RouteId | String | RouteID of the trip (E.g., 2001600200000006267). |
Mandatory |
2.2.6 | BusType | String | Define bus type (e.g. Leyland A/C Seater/Sleeper Executive Luxury (2+2),etc. | Mandatory |
2.2.7 | ServiceName | String | Service name | Mandatory |
2.2.8 | TravelName | String | Transporter Name | Mandatory |
2.2.9 | IdProofRequired | Boolean | Define ID proof is mandatory or not for boarding the bus. In case of True, client has to pass the IDProof in book request. | Mandatory |
2.2.10 | IsDropPointMandatory | Boolean | Define
whether
dropping point
mandatory or
not. In case of
True, client has to pass the dropping point in book request. |
Mandatory |
2.2.11 | LiveTrackingAvailable | Boolean | Define Live tracking available in bus or not. Possible values are true or false. | Mandatory |
2.2.12 | MTicketEnabled | Boolean | Possible values are true or false. | Mandatory |
2.2.13 | MaxSeatsPerTicket | Integer | Define maximum number of seats can be booked in single ticket. | Mandatory |
2.2.14 | OperatorId | String | Mandatory | |
2.2.15 | PartialCancellationAllowed | Boolean | Define Bus
allowed partial
cancellation of ticket or not.
Possible values are true or false. |
Mandatory |
2.2.16 | BoardingPoints[] | Array | Array of boarding point detail like boarding point name and time. | Mandatory |
2.2.16.1 | CityPointIndex | Integer | Index of the boarding point (e.g. 43289). | Mandatory |
2.2.16.2 | CityPointLocation | String | Name of the boarding point location at Source (e.g. Baramunda Bus Terminus). | Mandatory |
2.2.16.3 | CityPointName | String | Name of the bording point (e.g., Baramunda Bus Terminus). | Mandatory |
2.2.16.4 | CityPointTime | Date Time | Preferred date time Format: yyyyMMddTH H:mm:ss | Mandatory |
2.2.17 | DroppingPoints[] | Array | Array of dropping point detail like dropping point name and time. | Mandatory |
2.2.17.1 | CityPointIndex | Integer | Index of the dropping point (e.g. 43289). | Mandatory |
2.2.17.2 | CityPointLocation | String | Name of the boarding point location at Source (e.g. Baramunda Bus Terminus). | Mandatory |
2.2.17.3 | CityPointName | String | Name of the bording point (e.g., Baramunda Bus Terminus). | Mandatory |
2.2.17.4 | CityPointTime | Date and Time | Preferred date time Format: yyyyMMddTH H:mm:ss | Mandatory |
2.2.18 | Price[] | Array | Price breakup of the selected bus. | Mandatory |
2.2.18.1 | CurrencyCode | String | Mandatory | |
2.2.18.2 | BasePrice | Decimal | Base price of bus | Mandatory |
2.2.18.3 | Tax | Decimal | Tax applicable on bus price. | Mandatory |
2.2.18.4 | OtherCharges | Decimal | Other charges applicable on bus price. | Mandatory |
2.2.18.5 | Discount | Decimal | Discount applicable on bus price. | Mandatory |
2.2.18.6 | PublishedPrice | Decimal | This price would be different only if Bus Price is on PUBLISHED. In case of NET, Published Price would be same as Offered Price). | Mandatory |
2.2.18.7 | PublishedPriceRoundedOff | Decimal | This price is for display purpose only | Mandatory |
2.2.18.8 | OfferedPrice | Decimal | Offered Price of the Bus. | Mandatory |
2.2.18.9 | OfferedPriceRoundedOff | Decimal | Offered Price (rounded off) of the Bus | Mandatory |
2.2.18.10 | AgentCommission | Decimal | SRDV will part this amount if bus price is on Published | Mandatory |
2.2.18.11 | AgentMarkUp | Decimal | Agent will earn this amount if Bus markup is set from backend | Mandatory |
2.2.18.12 | TDS | Decimal | TDS applicable on Commission Earned. This would be deducted only when commission is parted to the agent. | Mandatory |
2.2.18.13 | GST[] | Array | Define the CGST and IGST rate and amount applicable on the bus price | Mandatory |
2.2.18.13.1 | CGSTAmount | Decimal | CGST amount | Mandatory |
2.2.18.13.2 | CGSTRate | Decimal | Rate of CGST | Mandatory |
2.2.18.13.3 | CessAmount | Decimal | Cess amount | Mandatory |
2.2.18.13.4 | CessRate | Decimal | Rate of Cess | Mandatory |
2.2.18.13.5 | IGSTAmount | Decimal | IGST amount | Mandatory |
2.2.18.13.6 | IGSTRate | Decimal | Rate of IGST | Mandatory |
2.2.18.13.7 | SGSTAmount | Decimal | SGST amount | Mandatory |
2.2.18.13.8 | SGSTRate | Decimal | Rate of SGST | Mandatory |
2.2.18.13.9 | TaxableAmount | Decimal | Total taxable amount | Mandatory |
2.2.19 | CancellationPolicies[] | Array | Array of cancellation policies. | Mandatory |
2.2.19.1 | CancellationCharge | Decimal | Cancellation charges. | Mandatory |
2.2.19.2 | CancellationChargeType | Enumeration | Tells whether CancellationCharge in Amount or Percentage possible values NotSet = 0, Amount = 1, Percentage = 2 |
Mandatory |
2.2.19.3 | PolicyString | String | Contains the policy. | Mandatory |
2.2.19.4 | TimeBeforeDept | String | Mandatory | |
2.2.19.5 | FromDate | Date Time | Preferred date time Format: yyyyMMddTH H:mm:ss | Mandatory |
2.2.19.6 | ToDate | Date Time | Preferred date time Format: yyyyMMddTH H:mm:ss | Mandatory |