Você está na página 1de 11

Web Services API

AbhiBus Services India Pvt. Ltd

AbhiBus Services India Pvt. Ltd


1st Floor, Lakshmi towers-B, Nagarjuna hills,
Punjagutta,Hyderabad 500082, India.

Document Information

Table of Contents
Specifications ................................................................................................................................ 3
0.1. Operations ........................................................................................................................ 3
0.1.1. GetStations .......................................................................................................... 3
0.1.2. GetDestinations ................................................................................................... 4
0.1.3. GetBoardingPoints............................................................................................... 4
0.1.4. GetDroppingPoints .............................................................................................. 5
0.1.5. GetCancellationPolicy.......................................................................................... 6
0.1.6. GetAvailableServices........................................................................................... 6
0.1.7. GetServiceSeatingLayout .................................................................................... 8
0.1.8. BlockTickets ......................................................................................................... 9
0.1.9. ConfirmationSeatBooking ................................................................................. 10
0.1.10. CancelTicket .................................................................................................... 10
0.1.11. GetOparators ................................................................................................... 11

Specifications
Following operations are offered under Abhibus Web Services Program

1.1.

GetStations

GetDestinations

GetBoardingPoints

GetDropingPoints

GetCancellationPolicy

GetAvailableServices

GetServiceSeatingLayout

BlockTickets

ConfirmationSeatBooking

CancelTicket

GetOparators

Operations
Following is the brief description about each of the above operations
Note: The username and password information should be communicated from Aggregator to the
Web service API. The required parameters should be username and password. These values
are mandatory and should be provided for every function call.
* Journey dates should be in yyyy-mm-dd format only.

1.1.1.

GetStations

This function is used for fetch all source stations info.


Input parameters

username (String)

password (String)

Output parameters

status (String) success or fail

Source_ID (int)

Station_Name (string)

Example - Output: it will return Json string


[{"Source_ID":"7","Station_Name":"Bangalore"},
{"Source_ID":"6","Station_Name":"Chennai"},

{"Source_ID":"344","Station_Name":"Delhi"}]

1.1.2.

GetDestinations

This function is used for fetch destination stations info of selected source station.
Input parameters

username (String)

password (String)

sourceStationId (int)

Output parameters

status (String) success or fail

Destination_ID (int)

Station_Name (string)

Example - Output: it will return Json string


[{"Destination_ID":"242","Station_Name":"Ahmedabad"},{"Destination_ID":"7","Station_Name":"Ba
ngalore"}]

1.1.3.

GetBoardingPoints

This function is used for get boarding point information of selected Source station.
Input parameters

username (String)

password (String)

operatorId (int)

sourceStationId (int)

destinationStationId (int)

journeyDate (date)

Output parameters

status (String) success or fail

operatorId (int)

Service_key (int)

Service_Name (string)

Traveler_Agent_Name (string)

boarding_info (String) formate: name^time^id^landmark(csv stirng)

Example - Output: it will return Json string

[{"operatorId":"68","Service_key":"1002","Service_Name":"","Traveler_Agent_Name":"Reddy
Express","boarding_info":["Ashoknagar^08:30PM^28^At Bhaskar Kesineni Travels
9246820586","Chintal^08:30PM^110^Near Sha Theatre 9246820586","Chandanagar^08:40
PM^27^Opp: Hotel Kaveri, At Sree Kaleswari Travels 9246820586"]}]

1.1.4.

GetDroppingPoints

This function is used for get dropping point information of selected Source station and
Destination station.
Input parameters

username (String)

password (String)

operatorId (int)

serviceId (int)

sourceStationId (int)

destinationStationId (int)

journeyDate (date)

Output parameters

status (String) success or fail

operatorId (int)

Service_key (int)

Service_Name (string)

Traveler_Agent_Name (string)

dropping_info (String) - Formate: id^name^time)

Example - Output: it will return Json string


[{"operatorId":"113","Service_key":"6182","Service_Name":"","Traveler_Agent_Name":"KBR
Travels","dropping_info":["6182^Vijayawada^03:00 AM"]}]

1.1.5.

GetCancellationPolicy

This method is used for get Cancellation policy details of selected Service.
Input parameters

username (String)

password (String)

operatorId (int)

serviceId (int)

sourceStationId (int)

destinationStationId (int)

journeyDate (date)

Output Parameters

status (String) success or fail

operatorId (int)

Service_key (int)

Service_Name (string)

Traveler_Agent_Name (string)

Cancellationpy

(String)

Example - Output: it will return Json string


[{"operatorId":"143","Service_key":"6182","Service_Name":"","Traveler_Agent_Name":"KBR
Travels","Cancellationpy":"B\/W 1-2 hours of bus start time#*#*B\/W 2-3 hours of bus start
time#*#*Above 3 hours of bus start time--50%#*#*75%#*#*90%"}]
1.1.6.

GetAvailableServices

This function used for fetch all available services of selected route(from station to destination
station).
Input parameters

username (String)

password (String)

sourceStationId (int)

destinationStationId (int)

journeyDate (date)

Output Parameters

status (String) success or fail

operatorId (int)

Service_key (int)

Service_Name (string)

Service_Number (string)

Traveler_Agent_Name (string)

Bus_Type_Name (string)

Start_time (string)

Arr_Time (string)

TravelTime (string)

Source_ID (int)

Destination_ID (int)

Fare (string)

available_seats (int)

jdate (date) - journery date

BUS_START_DATE (string)

layout_id (int)

boarding_info (Array) formate: name^time^id^landmark)

Example - Output: it will return Json string


[{"operatorId":"125","Service_key":"5490","Service_Name":"","Service_Number":null,"Traveler_Ag
ent_Name":"Sai Anjana Travels","Bus_Type_Name":"AC SLEEPER","Start_time":"07:00
PM","Arr_Time":"02:00AM","TravelTime":"07:00","Source_ID":"3","Destination_ID":"5","Fare":"1,20
0","available_seats":23,"jdate":"2013-10-09","BUS_START_DATE":"2013-1009","layout_id":"60","boarding_info":["Ameerpet^07:45 PM^6","S.R
Nagar^07:30PM^2224","KUKATPALLY^07:10PM^2230","K.P.H.B^07:00PM^2238","Punjagutta^08:0
0PM^2241","Lakdi-ka-pool^08:15PM^2242","L.B nagar^09:00 PM^2247","Dilsukhnagar^08:40
PM^2280","Kothapet^08:50PM^2281"]},
"operatorId":"138","Service_key":"3165","Service_Name":"","Service_Number":null,"Traveler_Agen
t_Name":"Kaveri Travels","Bus_Type_Name":"Hi-Tech Non Ac","Start_time":"07:30
PM","Arr_Time":"03:00AM","TravelTime":"07:30","Source_ID":"3","Destination_ID":"5","Fare":"400",
"available_seats":37,"jdate":"2013-10-09","BUS_START_DATE":"2013-1009","layout_id":"19","boarding_info":["Ameerpet^09:15PM^6","K.P.H.B^08:15 PM^2238","Srinivasa
Colony^09:00 PM^2240","Punjagutta^09:30 PM^2241","Lakdi-kapool^09:40PM^2242","Miyapur^07:45PM^2243","L.Bnagar^10:30PM^2247","Vanasthalipuram^10:4
5PM^2248","Dilsukhnagar^10:15PM^2280","Kothapet^10:20PM^2281","Nampally^09:50PM^2321","
Afzalgunj^10:00PM^2323","Sanathnagar^08:45PM^2417","Chandanagar^07:45 PM^2439","Ashok
Nagar^07:30 PM^2655","Moosapet^08:30 PM^2781"]}]
1.1.7.

GetServiceSeatingLayout

This method used for get seatlayout details of selected service.


Input parameters

username (String)

password (String)

operatorId (int)

serviceId (int)

sourceStationId (int)

destinationStationId (int)

journeyDate (date)

layoutId (int)

seatFare (int)

Output parameters

status (String) success or fail

SourceStationID (int)

DestinationStationID (int)

Route (string)

journeyDate (date)

ServiceID (int)

SeatLayoutID (int)

upperTotalRows (int)

upperTotalColumns (int)

lowerTotalRows (int)

lowerTotalColumns (int)

lowerDividerRow (int)

upperDividerRow (int)

maxNumberOfSeats (int)

tentativeSeats (string)

TotalSeatList (Two Dimensional Array)

1- lowerdeck_seat_nos (Array) - Formate: Seat.No, RowNo, ColNo, SeatType(SS-single seat, LB- lower
berth), Availability, Gender, Fare.
2- upperdeck_seat_nos (Array) - Formate: Seat.No, RowNo, ColNo, SeatType(UB- upper berth),
Availability, Gender, Fare
Example - Output: it will return Json string
[{"SourceStationID":"3","DestinationStationID":"5","Route":"Hyderabad-Vijayawada","JourneyDate":"2013-1009","ServiceID":"6182","SeatLayoutID":"3","upperTotalRows":"3","upperTotalColumns":"12","lowerTotalRows"
:"3","lowerTotalColumns":"12","lowerDividerRow":"1","upperDividerRow":"1","maxNumberOfSeats":6,"tentati
veSeats":null,"TotalSeatList":
{"lowerdeck_seat_nos":["0, 1, 12, LB, N, M, 600.00","L1, 2, 1, LB, Y, M, 600.00","L3, 2, 3, LB, Y, M,
600.00","L5, 2, 5, LB, N, F, 600.00","L7, 2, 7, LB, Y, M, 600.00","L9, 2, 9, LB, Y, M, 600.00","L11, 2, 11, LB,
Y, M, 600.00","L2, 3, 1, LB, Y, M, 600.00","L4, 3, 3, LB, N, M, 600.00","L6, 3, 5, LB, Y, M, 600.00","L8, 3, 7,
LB, Y, M, 600.00","L10, 3, 9, LB, Y, M, 600.00","L12, 3, 11, LB, Y, M, 600.00"],
"upperdeck_seat_nos":["0, 1, 24, UB, N, M, 600.00","U1, 2, 13, UB, Y, M, 600.00","U3, 2, 15, UB, Y, M,
600.00","U5, 2, 17, UB, N, M, 600.00","U7, 2, 19, UB, Y, M, 600.00","U9, 2, 21, UB, N, F, 600.00","U11, 2,
23, UB, Y, M, 600.00","U2, 3, 13, UB, Y, M, 600.00","U4, 3, 15, UB, Y, M, 600.00","U6, 3, 17, UB, Y, M,
600.00","U8, 3, 19, UB, Y, M, 600.00","U10, 3, 21, UB, Y, M, 600.00","U12, 3, 23, UB, Y, M, 600.00"]}}]

1.1.8.

BlockTickets

This function is used to Block the seats by sending bellow parameters. Consequently, this
function returns relevant values: Blocked Ticket Number when Seat's blocking made success.
Input parameters

username (String)

password (String)

operatorId (int)

journeyDate (date)

serviceId (string)

layoutId (string)

sourceStationId (int)

destinationStationId (int)

boardingPointID (string)

droppingPointID (stirng)

address (string)

contactNumber (string)

emailId (string)

namesList (string) csv of names list

gendersList (string) csv of genders list

ageList (string) csv of age list

seatNumbersList (string) - csv of seat number list

seatFare (string) csv of Fares list

seatTypeIdsList (string) csv of seat type ids list

seatTypesList (string) csv of seat types list(i.e 'S'-seater,'B'-berth)

isAcSeat(boolen) true or false

Output parameters

status (string) success or fail

referenceNo (string)

Example - Output: it will return Json string


[{"status":"success","ReferenceNo":"O_891849"}]
1.1.9.

ConfirmationSeatBooking

This function is used to Booking confirmation the ticket by sending bellow parameters. this
function returns relevant values: Ticket number and PNRNumber when ticket booking made success.

Input parameters

username (String)

password (String)

operatorId (int)

journeyDate (date)

referenceNo (string)

Output parameters

status (String) success or fail

TicketNo (string)

Example - Output: it will return Json string


[{"status":"Success","TicketNo":"8888897100"}]
1.1.10. cancelTicket

This function is used to cancel the booked ticket, it will be used also partial cancellation.
Input parameters

username (String)

password (String)

operatorId (int)

phoneNum (string)

ticketNo (string)

cancelSeats (string) csv of seat numbers

partialCancellation (int) (1- Full cancellation, 0- partial cancellation)

Output parameters

status (String) success or fail

cancelstatus (String)

return_amount (it will come if set partialCancellation is '0')

NewPNR (it will come if set partialCancellation is '0')

message(string)

Example - Output: it will return Json string


[{"return_amount":430,"cancelstatus":"Y","message":"Your ticket is successfully cancelled."}]
1.1.11. GetOparators

This method used for get all opetators details.


Input parameters

username (String)

password (String)

Output parameters

status (String) success or fail

operator_id (int)

operater_name (string)

partialCancellation (int) (1- Full cancellation, 0- partial cancellation)

Example - Output: it will return Json string


[{"operator_id":"6","operater_name":"KamakshiTravels","partialCancellation":"0"},{"operator_id":
"7","operater_name":"Tharai Travels","partialCancellation":"0"}]

Você também pode gostar