Bus Search Response

Bus Search Response

Format

Data Type

Meaning

Mandatory/Optional

Search_Token

String

Unique identifier for identifying every unique search Required for audit

purpose

Yes

Error

Object

Yes

ErrorCode

Integer

Code corresponding to the Error

Yes

ErrorMessage

String

Contain error description corresponding to ErrorCode. Error Message would be

blank in case ErrorCode=0

Yes

Result[]

Array

Array of results

Yes
  • ResultIndex
    		•

    Integer

    Define the result number

    Yes
  • ArrivalTime
    		•

    Date Time

    Approx. arrival time at the destination.

    Yes
  • AvailableSeats
    		•

    Integer

    Number of seats Available. (e.g.: 41)

    Yes
  • DepartureTime
    		•

    Date Time

    Define the bus departure date and time

    Yes
  • RouteId
    		•

    Long

    Route id of the trip (E.g., 2001600200000006267

    Yes
  • BusType
    		•

    String

    Define bus type

    (e.g. Leyland A/C Seater/Sleeper Executive Luxury (2+2), etc

    Yes
  • ServiceName
    		•

    String

    Transporter Name

    Yes
  • TravelName
    		•

    String

    Transporter Name

    Yes
  • 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

    Yes
  • IsDropPointMandatory
    		•

    Boolean

    Define whether dropping point mandatory or not. In case of True, client has to pass the dropping point in

    book request

    Yes
  • LiveTrackingAvailable
    		•

    Boolean

    Define Live tracking available in bus or not. Possible values are true or false

    Yes
  • MTicketEnabled
    		•

    Boolean

    Possible values are true or false

    Yes
  • MaxSeatsPerTicket
    		•

    Integer

    Define maximum number of seats can be booked in single ticket

    Yes
  • OperatorId
    		•

    _

    _

    _
  • PartialCancellationAllowed
    		•

    Boolean

    Define Bus allowed partial cancellation of ticket or not. Possible values are true or false

    Yes

    BoardingPointsDetails[]

    Array

    Array of boarding point detail like boarding point name and time

    Yes
  • CityPointIndex
    		•

    Integer

    Id of the boarding point (e.g. 43289)

    Yes
  • CityPointLocation
    		•

    String

    Name of the boarding point location at Source (e.g. Baramunda Bus Terminus)

    Yes
  • CityPointName
    		•

    String

    Name of the bording point (e.g., Baramunda Bus Terminus)

    Yes
  • CityPointTime
    		•

    Date Time

    Time of boarding point

    Yes

    DroppingPointsDetails []

    Array

    Array of dropping point details like place and time

    Yes
  • CityPointIndex
    		•

    Integer

    Id of the boarding point (e.g. 43289)

    Yes
  • CityPointLocation
    		•

    String

    Name of the boarding point location at Source (e.g. Baramunda Bus Terminus)

    Yes
  • CityPointName
    		•

    String

    Name of the bording point (e.g.,

    Baramunda Bus Terminus)

    Yes
  • CityPointTime
    		•

    Date Time

    Time at which bus reach to this boarding point

    Yes

    BusPrice

    Decimal

    Yes

    CurrencyCode

    Decimal

    Currency in which minimum bus price is returned

    Yes

    BasePrice

    Decimal

    Base price of bus

    Yes

    Tax

    Decimal

    Tax applicable on bus price

    Yes

    OtherCharges

    Decimal

    Other charges applicable on bus price

    Yes

    Discount

    Decimal

    Discount applicable on bus price

    Yes

    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)

    Yes

    PublishedPriceRoundedOff

    Decimal

    This price is for display purpose onl

    Yes

    OfferedPrice

    Decimal

    Offered Price of the Bus

    Yes

    OfferedPriceRoundedOff

    Decimal

    Offered Price (rounded off) of the Bus

    Yes

    AgentCommission

    Decimal

    TBO will part this amount if bus price is

    on Published

    Yes

    AgentMarkUp

    Decimal

    Agent will earn this amount if Bus markup is set from backend

    Yes

    TDS

    Decimal

    TDS applicable on Commission Earned.

    This would be deducted only when commission is parted to the agent

    Yes

    GST

    Decimal

    Define the CGST and IGST rate and amount applicable on the bus price

    Yes

    CGSTAmount

    Decimal

    CGST amount

    Yes

    CGSTRate

    Decimal

    Rate of CGST

    Yes

    CessAmount

    Decimal

    Cess amount

    Yes

    CessRate

    Decimal

    Rate of cess

    Yes

    IGSTAmount

    Decimal

    IGST amount

    Yes

    IGSTRate

    Decimal

    Rate of IGST

    Yes

    SGSTAmount

    Decimal

    SGST S amount

    Yes

    SGSTRate

    Decimal

    Rate of SGST

    Yes

    TaxableAmount

    Decimal

    Total taxable amount

    Yes

    CancellationPolicies[]

    Array of cancellation policies

    Yes
  • CancellationCharge
    		•

    Decimal

    Cancellation charge

    Yes
  • CancellationChargeType
    		•

    Enumeration

    CancellationPolicies - ChargeType Amount = 1, Percentage = 2,Nights = 3

    Yes
  • PolicyString
    		•

    Time

    Date from which charges will apply Format: (yyyy/mm/dd)

    Yes
  • FromDate
    		•

    Date Time

    Date from which charges will apply Format: (yyyy/mm/dd)

    Yes
  • ToDate
    		•

    Date Time

    Date up to which charges will apply

    Format: (yyyy/mm/dd)

    Yes