Sunteți pe pagina 1din 35

INTRODUCTION

MAIN RULE:
To use web service URL for production server, you must have an airline code & Requester ID (RQID).
In order to get the airline code & RQID, please contact your airline and register your IP Address
into the system.

DEVELOPMENT:
Web service URL for development is: http://ws.demo.awan.sqiva.com
Web service URL for development (using SSL security) is: https://ws.demo.awan.sqiva.com
Do not need an airline code & RQID to use web service in development environment.

PRODUCTION:
Web service URL for production server is: http://ws.id.sqiva.com
An airline code & RQID are mandatory in production server.
To use web service URL in production server, your USER AGENT setting must be set as: WS-
AWAN (case sensitive)

- URL examples in this documentation are executable with internet browser.


- Booking code in these examples are just samples, so it cannot be used directly.
- Data result format : json (http://www.json.org)
- Date format : yyyymmdd. Example : 20110701 for July 1, 2011
- Time format : hhmm. Example : 1705 for 17:05
- Parameters used in this web service are case sensitive.

PRIMARY PARAMETERS
These are the primary parameters that have to be sent in every web service call :
Field Data Type Mandatory Description
rqid String YES Requester ID, given by Sqiva
app String YES Accessed module
action String YES Called action
airline_code String YES Airline code
CHANGE LOG
(December 1st, 2015)

Added result for GET_FARE_V2_NEW


TABLE OF CONTENTS
INTRODUCTION ........................................................................................................................................................................... 1
PRIMARY PARAMETERS .............................................................................................................................................................. 1
CHANGE LOG................................................................................................................................................................................ 2
TABLE OF CONTENTS ................................................................................................................................................................... 3
DATA MODULE :: GET_ORG ......................................................................................................................................................... 4
DATA MODULE :: GET_DES .......................................................................................................................................................... 5
DATA MODULE :: GET_ORG_DES................................................................................................................................................. 6
DATA MODULE :: GET_PAY_TYPE ................................................................................................................................................ 7
DATA MODULE :: GET_NATIONALITY .......................................................................................................................................... 8
INFORMATION MODULE :: GET_SCHEDULE_V2 ......................................................................................................................... 9
INFORMATION MODULE :: GET_FARE_V2_NEW ..................................................................................................................... 12
INFORMATION MODULE :: GET_BALANCE ............................................................................................................................... 15
INFORMATION MODULE :: GET_BOOK_INFO .......................................................................................................................... 16
INFORMATION MODULE :: GET_ALL_BOOK_INFO .................................................................................................................. 18
INFORMATION MODULE :: GET_BOOK_PRICE_INFO ............................................................................................................... 20
INFORMATION MODULE :: GET_BOOK_PRICE_DETAIL_INFO ................................................................................................. 21
INFORMATION MODULE :: GET_ALL_BOOK_PRICE_INFO ....................................................................................................... 22
INFORMATION MODULE :: GET_BOOK_CONTACT ................................................................................................................... 23
INFORMATION MODULE :: GET_AGENT_BALANCE ................................................................................................................. 24
TRANSACTION MODULE:: BOOKING_V2 .................................................................................................................................. 25
TRANSACTION MODULE :: PAYMENT ....................................................................................................................................... 30
TRANSACTION MODULE :: VOID_PAYMENT............................................................................................................................. 31
TRANSACTION MODULE :: CANCEL_BOOK............................................................................................................................... 32
TRANSACTION MODULE :: SEND_TICKET ................................................................................................................................. 33
ERROR CODE .............................................................................................................................................................................. 34
DATA MODULE :: GET_ORG
Get list of origin airport

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES data
action String YES get_org

OUT Parameter :
Field Data Type Description
origin Array2D [ [airport] ]
[airport] Array [ airport code, airport name ]

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=data&action=get_org

Result :
{
"err_code": 0,
"origin": [["CGK","SOEKARNO-HATTA"],["DPS","NGURAH RAI"],["ICN","INCHEON"]
["JOG","ADISUCIPTO"],["SIN","CHANGI"],["UPG","HASANUDIN"]]
}
DATA MODULE :: GET_DES
Get list of destination airport code

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES data
action String YES get_des

OUT Parameter :
Field Data Type Description
origin Array2D [ [airport] ]
[airport] Array [ airport code, airport name ]

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=data&action=get_des

Result :
{
"err_code": 0,
"destination": [["CGK","SOEKARNO-HATTA"],["DPS","NGURAH RAI"],["ICN","INCHEON"]
["JOG","ADISUCIPTO"],["SIN","CHANGI"],["UPG","HASANUDIN"]]
}
DATA MODULE :: GET_ORG_DES
Get list of origin airport with each of its destination airport

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES data
action String YES get_org_des

OUT Parameter :
Field Data Type Description
origin Array2D [ [airport] ]
[airport] Array2D [ origin airport code, [destination_list] ]
[destination_list] Array [ destination airport code ]

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=data&action=get_org_des

Result :
{
"err_code": 0,
"origin_destination":
[
["CGK",["AMQ","BDO","BIK","BKS","DPS","JOG","KTG","SIN","SRG","SUB","TIM"]],
["SIN",["BKK","CGK","MNL"]]
]
}
DATA MODULE :: GET_PAY_TYPE
Get list of pay type

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES data
action String YES get_pay_type

OUT Parameter :
Field Data Type Description
pay_type Array2D [ [pay_type_detail] ]
[pay_type_detail] Array [payment type, bank]

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=data&action=get_pay_type

Result :
{
"err_code": 0,
"pay_type":
[

["ATM","BCA"],["ATM","LIPPOBANK"],["CC","LIPPOBANK"],["DEBIT","BCA"],["DEBIT","LIPP
OBANK"],["IB","LIPPO"],["VOUCHER",""]
]
}
DATA MODULE :: GET_NATIONALITY
Get list of country

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES data
action String YES get_nationality

OUT Parameter :
Field Data Type Description
nationality Array2D [ [nationality_detail] ]
[nationality_detail] Array [country_id, country_name]

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=data&action=get_nationality

Result :
{
"err_code": "0",
"nationality": [
["AF","AFGANISTAN"],["AL","ALBANIA"],["AO","ANGOLA"],["AE","ARAB EMIRATE"]
]
}
INFORMATION MODULE :: GET_SCHEDULE_V2
Get direct and connecting schedule info

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES information
action String YES get_schedule_v2
org String YES Origin (Code)
des String YES Destination (Code)
flight_date String YES Flight date (format: yyyymmdd)
extra_days Number NO Extra days of schedule searching by flight date
return_flight Number NO Search for roundtrip. 0 for one way trip, 1 for roundtrip.
ret_flight_date String NO Return flight date. Mandatory if return_flight is 1 (format:
yyyymmdd)

OUT Parameter :
Field Data Type Description
org String Origin (Code)
des String Destination (Code)
flight_date String Flight Date (format: yyyymmdd)
schedule Array2D [ sch_direct , sch_connecting ]
[sch_direct] Array2D [flight number, org, des, departure date, arrival_date,
departure time, arrival time, duration, aircraft, transit,
[availability], route ]
[sch_connecting] Array2D [ schedule_per_segment ]
[schedule_per_segment] Array2D [flight number, org, des, departure date, arrival_date,
departure time, arrival time, duration, aircraft, transit,
[availability], route ]
[availability] Array2D [ availability_per_subclass]
[ availability_per_subclass] Array [ subclass, availability ]
ret_flight_date String Flight Date (format: yyyymmdd)
ret_schedule Array2D [ret_sch_direct , ret_sch_connecting ]
[ret_sch_direct] Array2D [flight number, org, des, departure date, arrival_date,
departure time, arrival time, duration, aircraft, transit,
[availability], route ]
[ret_sch_connecting] Array2D [ ret_schedule_per_segment ]
[ret_schedule_per_segment] Array2D [flight number, org, des, departure date, arrival_date,
departure time, arrival time, duration, aircraft, transit,
[availability], route ]
[availability] Array2D [ availability_per_subclass]
[ availability_per_subclass] Array [ subclass, availability ]

*availability value:
A : seat available
L : will be on wait list
C : closed, can not book
actual availability (number) : seat available, below
group limit

Example :
http://ws.demo.awan.sqiva.com/?&app=information&action=get_schedule_v2&org=CGK&des=UPG
&flight_date=20140404&return_flight=1&ret_flight_date=20140404

Result :
{
"err_code": "0",get
"org": "CGK",
"des": "UPG",
"flight_date": "20140404",
"extra_days": 0,
"schedule": [
[
["W2-213", "CGK", "UPG", "20140404", "20140404", "0600", "1000",
"03h00m", "MD-88", "1", [
["A", "9"],
["B", "9"],
["C", "9"],
["Y", "7"]
], "CGK-PKN-UPG"],
["W2-400", "CGK", "UPG", "20140404", "20140404", "1900", "2200",
"02h00m", "MD-88", "0", [
["A", "9"],
["B", "9"],
["C", "9"],
["Y", "9"]
], "CGK-UPG"]
],
[
[
["W2-2121", "CGK", "SUB", "20140404", "20140404", "0600", "0700",
"01h00m", "MD-88", "0", [
["A", "9"],
["B", "9"],
["C", "9"],
["D", "9"]
], "CGK-SUB"],
["W2-2131", "SUB", "UPG", "20140404", "20140404", "0800", "1000",
"01h00m", "MD-88", "0", [
["A", "9"],
["B", "9"],
["C", "9"],
["D", "9"]
], "SUB-UPG"]
],
[
["W2-303", "CGK", "SUB", "20140404", "20140404", "0100", "0200",
"01h00m", "MD-88", "0", [
["A", "9"],
["B", "8"],
["C", "9"],
["Y", "9"]
], "CGK-SUB"],
["W2-304", "SUB", "UPG", "20140404", "20140404", "0300", "0500",
"01h00m", "MD-88", "0", [
["A", "9"],
["B", "9"],
["C", "9"],
["Y", "9"]
], "SUB-UPG"]
]
]
],
"ret_flight_date": "20140404",
"ret_schedule": [
[
["W2-401", "UPG", "CGK", "20140404", "20140404", "2230", "2330",
"02h00m", "MD-88", "0", [
["A", "9"],
["B", "9"],
["C", "9"],
["Y", "9"]
], "UPG-CGK"]
],
[
[
["W2-307", "UPG", "SUB", "20140404", "20140404", "1600", "1630",
"01h30m", "MD-88", "0", [
["A", "9"],
["B", "9"],
["C", "9"],
["Y", "9"]
], "UPG-SUB"],
["W2-308", "SUB", "CGK", "20140404", "20140404", "1700", "1800",
"01h00m", "MD-88", "0", [
["A", "9"],
["B", "9"],
["C", "9"],
["Y", "9"]
], "SUB-CGK"]
]
]
]
}
INFORMATION MODULE :: GET_FARE_V2_NEW
Get fare detail from a flight number (direct & connecting)

IN Parameter:
Field Data Type Mandatory Description
rqid String YES
app String YES information
action String YES get_fare_v2
org String YES Origin (Code)
des String YES Destination (Code)
flight_date String YES Flight date (format: yyyymmdd)
flight_no String YES Flight number
Note : if the flight has 2 connecting flights, example (CGK-
UPG, UPG-TTE), you must send 2 flight number too.
example : '2121,2123' ( 2 connecting flights)
return_flight Number NO Search for roundtrip. 0 for one way trip, 1 for roundtrip.
ret_flight_date String NO Return flight date. Mandatory if return_flight is 1 (format:
yyyymmdd)
ret_flight_no String NO Return flight number. Mandatory if return_flight is 1
Note : if the flight has 2 connecting flights, example (CGK-
UPG, UPG-TTE), you must send 2 flight number too.
example : '2121,2123' ( 2 connecting flights)

OUT Parameter:
Field Data Type Description
org String Origin (Code). For multiple departure leg, the next org is org_2,
org_3, etc.
des String Destination (Code). For multiple departure leg, the next des is des_2,
des_3, etc.
flight_date String Flight Date (format: yyyymmdd)
flight_no String Flight Number
vat_percentage Number Vat percentage
fare_info Array2D [ [fare_detail] ]. For multiple departure leg, the next fare_info are
fare_info_2, fare_info_3, etc.
[fare_detail] Array [subclass/fare basis,
[adult total fare, adult basic fare, adult insurance, adult airport tax,
adult surcharge, adult_terminal_fee, booking_fee, vat],
[child total fare, child basic fare, child insurance, child airport tax,
child surcharge, child_terminal_fee, booking_fee, vat],
[infant total fare, infant basic fare, infant insurance, infant airport tax,
infant surcharge, infant_terminal_fee, booking_fee, vat],
[adult total fare, adult basic fare, adult insurance, adult airport tax,
adult surcharge, adult_terminal_fee, booking_fee, vat],
[child total fare, child basic fare, child insurance, child airport tax,
child surcharge, child_terminal_fee, booking_fee, vat],
[infant total fare, infant basic fare, infant insurance, infant airport tax,
infant surcharge, infant_terminal_fee, booking_fee, vat],
Note, is_ibook, min_stay, max_stay, ccy, agent_adult_fare,
agent_adult_return_fare, agent_child_fare, agent_child_return_fare,
incentive_adult, incentive_child, baggage_allowance]

italic text : fare for round trip


ret_flight_date String Return flight date (format: yyyymmdd)
ret_flight_no String Return flight number
ret_org String Return Origin (Code). For multiple departure leg, the next org is
ret_org_2, ret_org_3, etc.
ret_des String Return Destination (Code). For multiple departure leg, the next des is
ret_des_2, ret_des_3, etc.
ret_fare_info Array2D [ [fare_detail] ]. For multiple departure leg, the next ret_fare_info are
ret_fare_info_2, ret_fare_info_3, etc.
[fare_detail] Array [subclass/fare basis,
[adult total fare, adult basic fare, adult insurance, adult airport tax,
adult surcharge, adult terminal fee, booking fee, vat],
[child total fare, child basic fare, child insurance, child airport tax,
child surcharge, child terminal fee, booking fee, vat],
[infant total fare, infant basic fare, infant insurance, infant airport tax,
infant surcharge, infant terminal fee, booking fee, vat],
[adult total fare after disc, adult basic fare after disc, adult insurance
after disc, adult airport tax after disc, adult surcharge after disc,
infant terminal fee after disc, booking fee, vat],
[child total fare after disc, child basic fare after disc, child insurance
after disc, child airport tax after disc, child surcharge after disc, child
terminal fee after disc, booking fee, vat],
[infant total fare after disc, infant basic fare after disc, infant
insurance after disc, infant airport tax after disc, infant surcharge
after disc, infant terminal fee after disc, booking fee, vat],
Note, is_ibook, min_stay, max_stay, ccy, agent_adult_fare,
agent_adult_return_fare, agent_child_fare, agent_child_return_fare,
baggage_allowance]

italic text : fare for round trip

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=information&action=get_fare_v2_new&org=CGK&des=UP
G&flight_no=2121&flight_date=20140328&return_flight=1&ret_flight_date=20140330&ret_flight_no
=401

Result :
{
"err_code": "0",
"flight_date": "20141119",
"flight_no": "2121,2131",
"return_flight": 1,
"ret_flight_date": "20141121",
"ret_flight_no": "307,308",
"ret_org": "UPG",
"ret_des": "CGK",
"ret_fare_info": [
["A/F", [13650, 10000, 0, 1000, 1500, 0, 0, 1150],
[10900, 7500, 0, 1000, 1500, 0, 0, 900],
[3750, 1000, 0, 1000, 1500, 0, 0, 250],
[12000, 8500, 0, 1000, 1500, 0, 0, 1000],
[9250, 6000, 0, 1000, 1500, 0, 0, 750],
[2100, -500, 0, 1000, 1500, 0, 0, 100], "", "IBOOK", "", "", "USD",
12000, 10350, 12000, 10350, 0, 0, "10"
],
["B/0", [1050000, 900000, 5000, 0, 50000, 0, 0, 95000],
[1050000, 900000, 5000, 0, 50000, 0, 0, 95000],
[170000, 100000, 5000, 0, 50000, 0, 0, 15000],
[1050000, 900000, 5000, 0, 50000, 0, 0, 95000],
[1050000, 900000, 5000, 0, 50000, 0, 0, 95000],
[170000, 100000, 5000, 0, 50000, 0, 0, 15000], "", "", "", "", "",
1045000, 1045000, 1045000, 1045000, 0, 0, "10"
]
],
"org": "CGK",
"des": "SUB",
"fare_info": [
["B/0", [13650, 10000, 0, 1000, 1500, 0, 0, 1150],
[10900, 7500, 0, 1000, 1500, 0, 0, 900],
[3750, 1000, 0, 1000, 1500, 0, 0, 250],
[13650, 10000, 0, 1000, 1500, 0, 0, 1150],
[10900, 7500, 0, 1000, 1500, 0, 0, 900],
[3750, 1000, 0, 1000, 1500, 0, 0, 250], "", "IBOOK", "", "", "IDR",
12000, 10350, 9250, 7600, 0, 0, "10"
]
],
"org_2": "SUB",
"des_2": "UPG",
"fare_info_2": [
["B/0", [665000, 550000, 5000, 0, 50000, 0, 0, 60000],
[665000, 550000, 5000, 0, 50000, 0, 0, 60000],
[170000, 100000, 5000, 0, 50000, 0, 0, 15000],
[665000, 550000, 5000, 0, 50000, 0, 0, 60000],
[665000, 550000, 5000, 0, 50000, 0, 0, 60000],
[170000, 100000, 5000, 0, 50000, 0, 0, 15000], "", "IBOOK", "", "",
"USD", 660000, 660000, 660000, 660000, 0, 0, "10"
]
]
}
INFORMATION MODULE :: GET_BALANCE
Get balance/outstanding amount from a booking

IN Parameter:
Field Data Type Mandatory Description
rqid String YES
app String YES information
action String YES get_balance
book_code String YES Booking code

OUT Parameter:
Field Data Type Description
book_code String Booking code
num_code Number Numeric code
normal_sales Number Normal Selling Price
book_balance Number Balance/outstanding of booking

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=information&action=get_balance&book_code=A1B2C3&air
line_code=W2

Result :
{
"err_code": 0,
"book_code": "A1B2C3",
"num_code": 7512671582,
"normal_sales": 2292538,
"book_balance": 2292538
}
INFORMATION MODULE :: GET_BOOK_INFO
Get information from a booking of the agent only.

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES information
action String YES get_book_info
book_code String YES Booking code

OUT Parameter :
Field Data Type Description
book_code String Booking code
num_code Number Numeric code
caller String Someone who makes this reservation
normal_sales Number Normal Selling Price
book_balance Number Balance/outstanding of booking
[pax_list] Array2D [ [pax_detail] ]
[pax_detail Array [First name, last name, mobile, passport, nationality, passenger
type*,ticket_no, fare price]
*Passenger type : A=adult, C=child, I=infant
[route_info] Array2D [ [route_info_detail] ]
[route_info_detail] Array [origin (code), destination (code), departure date, arrival date,
departure time, arrival time, subclass, flight number, status]
pay_limit String Payment time limit
contact String Contact information
book_by String Booking made by
book_office_by String Office where the booking made
payment_history Array2D [[payment detail]]
[payment_detail] Array [pay_date, pay_type, pay_desc, amount]

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=information&action=get_book_info&book_code= DMPRJU

Result :
{
"err_code": "0",
"book_code": "DMPRJU",
"num_code": 5793396403722,
"caller": "JONIE",
"normal_sales": 13650,
"book_balance": 0,
"pax_list": [
["IVHAN", "FG", "0812345", "PASS1", "ID", "A", "000 0000210354", "", 13650]
],
"route_info": [
["CGK", "UPG", "14-JUN-14", "14-JUN-14", "1900", "2200", "A", "8B-400",
"RR"]
],
"book_ancillary_fee": [],
"pay_limit": " (UTC+9)",
"contact": "08989899",
"book_by": "sulin@cinta.com",
"book_office_by": "DJJ001 - PT Pacific Talk",
"payment_history": [
["12-JUN-14 16:19", "Agent", "Agent Book", 12150]
]
}
INFORMATION MODULE :: GET_ALL_BOOK_INFO
Get information from a booking of the airline.

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES information
action String YES get_all_book_info
book_code String YES Booking code

OUT Parameter :
Field Data Type Description
book_code String Booking code
num_code Number Numeric code
caller String Someone who makes this reservation
normal_sales Number Normal Selling Price
book_balance Number Balance/outstanding of booking
[pax_list] Array2D [ [pax_detail] ]
[pax_detail Array [First name, last name, mobile, passport, nationality, passenger
type*,ticket_no, fare price]
*Passenger type : A=adult, C=child, I=infant
[route_info] Array2D [ [route_info_detail] ]
[route_info_detail] Array [origin (code), destination (code), departure date, arrival date,
departure time, arrival time, subclass, flight number, status]
pay_limit String Payment time limit
contact String Contact information
book_by String Booking made by
book_office_by String Office where the booking made
payment_history Array2D [[payment detail]]
[payment_detail] Array [pay_date, pay_type, pay_desc, amount]
Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=information&action=get_all_book_info&book_code=
DMPRJU

Result :
{
"err_code": "0",
"book_code": "DMPRJU",
"num_code": 5793396403722,
"caller": "JONIE",
"normal_sales": 13650,
"book_balance": 0,
"pax_list": [
["IVHAN", "FG", "0812345", "PASS1", "ID", "A", "000 0000210354", "", 13650]
],
"route_info": [
["CGK", "UPG", "14-JUN-14", "14-JUN-14", "1900", "2200", "A", "8B-400",
"RR"]
],
"book_ancillary_fee": [],
"pay_limit": " (UTC+9)",
"contact": "08989899",
"book_by": "sulin@cinta.com",
"book_office_by": "DJJ001 - PT Pacific Talk",
"payment_history": [
["12-JUN-14 16:19", "Agent", "Agent Book", 12150]
]
}
INFORMATION MODULE :: GET_BOOK_PRICE_INFO
Get price info from a booking

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES information
action String YES get_book_price_info
book_code String YES Booking code

OUT Parameter :
Field Data Type Description
book_code String Booking code
total_price_adult Number Total price for adult passenger(s)
total_price_child Number Total price for child passenger(s)
total_price_infant Number Total price for infant passenger(s)
total_price Number Total price

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=information&action=get_book_price_info&book_code=A1B
2C3

Result :
{
"err_code": 0,
"book_code": "A1B2C3",
"total_price_adult": 257,
"total_price_child": 0,
"total_price_infant": 0,
"total_price": 257
}
INFORMATION MODULE :: GET_BOOK_PRICE_DETAIL_INFO
Get detail price info from a booking

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES information
action String YES get_book_price_detail_info
book_code String YES Booking code

OUT Parameter :
Field Data Type Description
book_code String Booking code
book_balance Number Outstanding of booking
normal_sales Number Normal Selling of booking
detail_price_adult Number [[detail_price]]
detail_price_child Number [[detail_price]]
detail_price_infan Number [[detail_price]]
t
[detail_price] Number [transaction_description, amount]

Example :
http://ws.demo.awan.sqiva.com/?rqid=abcdef&app=information&action=get_book_price_detail_info&
book_code=W9FCKJ
Result :
{
"err_code": "0",
"book_code": "W9FCKJ",
"book_balance": "815000",
"normal_sales": "815000",
"detail_price_adult": [
["Airport Tax", 35000],
["Basic Fare", 700000],
["Insurance Fee", 10000],
["Fare Vat", 70000]
],
"detail_price_child": [],
"detail_price_infant": []
}
INFORMATION MODULE :: GET_ALL_BOOK_PRICE_INFO
Get price info from a booking of the airline.

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES information
action String YES get_all_book_price_info
book_code String YES Booking code

OUT Parameter :
Field Data Type Description
book_code String Booking code
total_price_adult Number Total price for adult passenger(s)
total_price_child Number Total price for child passenger(s)
total_price_infant Number Total price for infant passenger(s)
total_price Number Total price

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=information&action=get_book_price_info&book_code=A1B
2C3

Result :
{
"err_code": 0,
"book_code": "A1B2C3",
"total_price_adult": 257,
"total_price_child": 0,
"total_price_infant": 0,
"total_price": 257
}
INFORMATION MODULE :: GET_BOOK_CONTACT
Get contact info for booking of a certain date and flight number.

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES information
action String YES get_all_book_price_info
fli_date Date YES Flight date
fli_no String YES Flight Number

OUT Parameter :
Field Data Type Description
fli_no String Flight Number
fli_date Date Flight Date
data Array2D [Contact Data]
contact data Array1D [book_code, org, des, dep_time, arv_time, email, passenger_name,
passenger_mobile, booking_contact]

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=Q1&app=information&action=get_book_contact&fli_date=20141205
&fli_no=8911

Result :
{
"err_code": "0",
"fli_no": "8911",
"fli_date": 20141205,
"data": [
["9F6XJU", "CGK", "SUB", 0600, 0700, "", "MR. JOHN DOE", "08111111111",
"JANE DOE,08222222222,JANE@TEST.COM"]
]
}
INFORMATION MODULE :: GET_AGENT_BALANCE
Get balance of agent

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES information
action String YES get_agent_balance

OUT Parameter :
Field Data Type Description
comp_code String Agents company code
comp_name String Agents company name
balance Number Agents balance

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=information&action=get_agent_balance

Result :
{
"err_code": "0",
"comp_code": "agentcinta",
"comp_name": "AgentCinta",
"balance": 59133743.73
}
TRANSACTION MODULE:: BOOKING_V2
Book a flight (direct & connecting)

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES transaction
action String YES booking_v2
org String YES Origin (Code)
des String YES Destination (Code)
round_trip Number YES Indicator whether you want to book a round-trip flight
or not.
Round_trip=1 indicates that you want to book a round-
trip flight.
Round_trip=0 indicates that you want to book a
one_way flight
dep_flight_no String YES Departure Flight Number
Note : if the flight has 2 connecting flights, example
(CGK-UPG, UPG-TTE), you must send 2 flight number
too.
example : '2121,2123' ( 2 connecting flights)
ret_flight_no String YES/NO* Return Flight Number
Note : if the flight has 2 connecting flights, example
(CGK-UPG, UPG-TTE), you must send 2 flight number
too.
example : '2121,2123' ( 2 connecting flights)
dep_date String YES Departure date (format: yyyymmdd)
ret_date String YES/NO* Return date (format: yyyymmdd)
subclass_dep String YES Chosen subclass/fare basis for departure.
Note : if the flight has 2 connecting flights, example
(CGK-UPG, UPG-TTE), you must send 2 subclass/fare
basis too.
example : 'A/A,B/B' or 'A/A,A/A' ( 2 connecting flights)
If you choose different subclass/fare basis for thru fare
route, the fare will be taken based on the most
expensive.
subclass_ret String YES/NO* Chosen subclass/fare basis for return.
Note : if the flight has 2 connecting flights, example
(CGK-UPG, UPG-TTE), you must send 2 subclass/fare
basis too.
example : 'A/A,B/B' or 'A/A,A/A' ( 2 connecting flights)
If you choose different subclass/fare basis for thru fare
route, the fare will be taken based on the most
expensive.
caller String(30) YES Someone who makes this reservation
contact_1 String(30) YES First contact name
contact_2 String(30) NO Second contact name
contact_3 String(30) NO Third contact name
num_pax_adult Number NO Number of adult passengers
num_pax_child Number NO Number of child passengers
num_pax_infant Number NO Number of infant passengers
a_first_name_{} String(50) YES Adult first name.
a_first_name_1 for first adult passenger first name,
a_first_name_2 for second adult passenger first name,
and so on.
a_last_name_{} String(50) NO Adult last name.
a_last_name_1 for first adult passenger last name,
a_last_name_2 for second adult passenger last name,
and so on.
a_salutation_{} String(1) YES Salutation for adult passenger (MR/MRS/MS).
a_salutation_1 for first adult passenger salutation,
a_salutation_2 for second adult passenger salutation,
and so on.
a_title_{} String(50) NO Adult title.
a_title_1 for first adult passenger title, a_title_2 for
second adult passenger title, and so on.
a_birthdate_{} Date NO Adult birthdate.
a_birthdate_1 for first adult passenger birhtdate,
a_birhtdate_2 for second adult passenger birthdate, and
so on.
a_mobile_{} String(50) YES Adult mobile.
a_mobile_1 for first adult passenger mobile, a_mobile_2
for second adult passenger mobile, and so on.
a_passport_{} String(50) NO Adult passport.
a_passport_1 for first adult passenger passport,
a_passport_2 for second adult passenger passport, and
so on.
a_passport_exp_{} Date NO Adult passport expired.
a_passport_exp_1 for first adult passenger passport
expired, a_passport_exp_2 for second adult passenger
passport expired, and so on.
a_nationality_{} String(50) NO Adult nationality.
a_nationality_1 for first adult passenger nationality,
a_nationality_2 for second adult passenger nationality,
and so on.
c_first_name_{} String(50) YES Child first name.
c_first_name_1 for first child passenger first name,
c_first_name_2 for second child passenger first name,
and so on.
c_last_name_{} String(50) NO Child last name.
c_last_name_1 for first child passenger last name,
c_last_name_2 for second child passenger last name,
and so on.
c_salutation_{} String(1) YES Salutation for child passenger (MSTR / MISS).
c_salutation_1 for first child passenger salutation,
c_salutation_2 for second child passenger salutation,
and so on.
c_title_{} String(50) NO Child title.
c_title_1 for first child passenger title, c_title_2 for
second child passenger title, and so on.
c_birthdate_{} Date YES Child birthdate.
c_birthdate_1 for first child passenger birhtdate,
c_birhtdate_2 for second child passenger birthdate, and
so on.
c_mobile_{} String(50) NO Child mobile.
c_mobile_1 for first child passenger mobile, c_mobile_2
for second child passenger mobile, and so on.
c_passport_{} String(50) NO Child passport.
c_passport_1 for first child passenger passport,
c_passport_2 for second child passenger passport, and
so on.
c_passport_exp_{} Date NO Child passport expired.
c_passport_exp_1 for first child passenger passport
expired, c_passport_exp_2 for second child passenger
passport expired, and so on.
c_nationality_{} String(50) NO Child nationality.
c_nationality_1 for first child passenger nationality,
c_nationality_2 for second child passenger nationality,
and so on.
i_first_name_{} String(50) YES Infant first name.
i_first_name_1 for first infant passenger first name,
i_first_name_2 for second infant passenger first name,
and so on.
i_last_name_{} String(50) NO Infant last name.
i_last_name_1 for first infant passenger last name,
i_last_name_2 for second infant passenger last name,
and so on.
i_parent_{} Number YES The parent of infant passenger / adult passenger who has
a responsibility for the infant passenger.
i_parent_1 for first infant passenger's parent, i_parent_2
for second infant passenger's parent, and so on.
Example :
i_parent_1=1 (it means that the parent of 1st infant
passenger is the 1st adult passenger)
i_parent_2=3 (it means that the parent of 2nd infant
passenger is the 3rd adult passenger)
i_salutation_{} String(1) YES Salutation for infant passenger (MSTR / MISS).
i_salutation_1 for first infant passenger salutation,
i_salutation_2 for second infant passenger salutation,
and so on.
i_title_{} String(50) NO Infant title.
i_title_1 for first infant passenger title, i_title_2 for
second infant passenger title, and so on.
i_birthdate_{} Date YES Infant birthdate.
i_birthdate_1 for first infant passenger birhtdate,
i_birhtdate_2 for second infant passenger birthdate, and
so on.
i_mobile_{} String(50) NO Infant mobile.
i_mobile_1 for first infant passenger mobile, i_mobile_2
for second infant passenger mobile, and so on.
i_passport_{} String(50) NO Infant passport.
i_passport_1 for first infant passenger passport,
i_passport_2 for second infant passenger passport, and
so on.
i_passport_exp_{} Date NO Infant passport expired.
i_passport_exp_1 for first infant passenger passport
expired, i_passport_exp_2 for second infant passenger
passport expired, and so on.
i_nationality_{} String(50) NO Infant nationality.
i_nationality_1 for first infant passenger nationality,
i_nationality_2 for second infant passenger nationality,
and so on.
*Input is mandatory if you book a round-trip flight (round_trip=1)
OUT Parameter :
Field Data Type Description
org String Origin (Code)
des String Destination (Code)
round_trip Number Indicator whether you want to book a round-trip flight or not.
Round_trip:1 indicates that you have booked a round-trip flight.
Round_trip:0 indicates that you have booked a one_way flight
connecting Number Indicator that you book a connecting flight.
book_code String Booking Code. Generated by system.
dep_date String Departure Date (format: yyyymmdd)
dep_flight_no String Flight Number for departure
ret_date String Departure Date (format: yyyymmdd)
ret_flight_no String Flight Number for departure
pax_num Array [Number of adult passengers, number of child passengers, number of
infant passengers]
pax_name Array List of passenger names (first name and last name)
normal_sales Number Normal cost of sales
book_balance Number Balance/outstanding for this booking
pay_limit String Payment time limit
status String Booking Status. For multiple departure leg, the next status are
status_2, status_3, etc.
ret_status String Return Status. For multiple return leg, the next status are ret_status_2,
ret_status_3, etc.

Example : http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=transaction&action=booking_v2&des=UPG&org=CGK&rou
nd_trip=1&ret_flight_no=213,214&dep_flight_no=600&dep_date=20130910&subclass_dep=A/A&su
bclass_ret=E/E,E/Y&caller=JONIE&caller_1=00898989&num_pax_adult=1&num_pax_child=0&num
_pax_infant=1&a_first_name_1=IVHAN&a_last_name_1=FG&a_salutation_1=MR&a_birthdate_1=1
9901010&a_mobile_1=0812345&a_passport_1=pass1&a_nationality_1=ID&a_passport_exp_1=2012
0303&i_first_name_1=LOUIS&i_birthdate_1=20120101&i_parent_1=1&i_salutation_1=MSTR&cont
act_1=08989899&ret_date=20130915

Result :
{
"err_code": "0",
"org": "CGK",
"des": "UPG",
"round_trip": 1,
"book_code": "PCRGPJ",
"dep_date": "20130910",
"dep_flight_no": "600",
"ret_date": "20130915",
"ret_flight_no": "213",
"pax_num": [1,0,1],
"pax_name": ["IVHAN FG","LOUIS "] ,
"normal_sales": 2952000,
"book_balance": 2952800,
"pay_limit":"15-AUG-2013 16:51 (UTC+9)",
"status":"HK",
"ret_status":"HK",
"ret_status_2":"HK"
}
TRANSACTION MODULE :: PAYMENT
Pay a booking

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES transaction
action String YES payment
book_code String YES Kode Booking
amount Number NO Payment amount. If not specified, counted as full payment.
pay_type String NO Payment type. If not specified, by default is Agent
pay_bank String NO Payment Bank. Mandatory if payment type has pay bank.

OUT Parameter :
Field Data Type Description
book_code String Booking code
book_balance Number Book balance after payment
ticket_unit Array 2D [ pax_name, ticket_no]

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=transaction&action=payment&book_code=P3C38A

Result :
{
"err_code": "0",
"book_code": "P3C38A",
"book_balance": 0,
"ticket_unit":[["IVHAN FG","000 0000206307"],["LOUIS ","000 0000206308"]]
}

Or :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=transaction&action=payment&book_code=2JWHS3&amoun
t=5000&pay_type=IB&pay_bank=LIPPO

Result :
{
"err_code": "0",
"book_code": "2JWHS3",
"book_balance": 1247400,
"ticket_unit": ""
}
TRANSACTION MODULE :: VOID_PAYMENT
Void a booking payment

Parameter IN :
Field Data Type Mandatory Description
rqid String YES
app String YES transaction
action String YES void_payment
book_code String YES Booking code

OUT Parameter :
Field Data Type Description
book_code String Kode Booking
normal_sales Number Biaya normal penjualan
book_balance Number Balance/outstanding for this booking, after void payment

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=transaction&action=void_payment&book_code=A1B2C3

Result :
{
"err_code": 0,
"book_code": "A1B2C3",
"normal_sales": 2292538,
"book_balance": 2292538
}
TRANSACTION MODULE :: CANCEL_BOOK
Cancel a booking

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES transaction
action String YES cancel_book
book_code String YES Booking code

OUT Parameter :
Field Data Type Description
book_code String Booking code
status String Booking code status. 'XX' indicates that this booking has been
canceled.
refund_amount Number Refund amount

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=W2&app=transaction&action=cancel_book&book_code=A1B2C3

Result :
{
"err_code": 0,
"book_code": "A1B2C3",
"status": "XX",
"refund_amount": 0
}
TRANSACTION MODULE :: SEND_TICKET
Send ticket to specified email address

IN Parameter :
Field Data Type Mandatory Description
rqid String YES
app String YES transaction
action String YES cancel_book
book_code String YES Booking code
Email String YES Destination email address

OUT Parameter :
Field Data Type Description
book_code String Booking code
status String Booking code status. 'XX' indicates that this booking has been
canceled.
email String Destination email address

Example :
http://ws.demo.awan.sqiva.com/?rqid=5EB9FE68-8915-11E0-BEA0-
C9892766ECF2&airline_code=Q1&app=transaction&action=send_ticket&book_code=J7THQZ&emai
l=test@mail.com

Result :
{
"err_code": "0",
"book_code": "J7THQZ",
"email": "test@mail.com"
}
ERROR CODE
List message error/validation

Error Code Error Message


000500 Request timed out
001001 Unknown error
001002 Validation error
001003 Book Code does not exist or already canceled
001004 Numeric Code does not exist or its Book Code already canceled
001006 You don't have privilege to do this action
002000 Invalid Request. IP Address and/or Requester ID are not registered
002001 Definition error, no application defined
002002 Definition error, no action defined
002003 Definition error, no RqId defined
002004 Application error, application does not exist
002005 Action error, action does not exist
002006 Request rejected. Please contact your administrator
002007 Invalid request. Airline code are not defined or not registered
500106 Validation error : [ dep_date ] outside the sales period for agent
510101 Route not found
510102 Max passenger per booking is 10
510103 Max passenger per booking is 10
510104 Parameter has invalid input format
510105 Duplicate parent. Each of adult passenger can carry only one infant
510106 Cannot do this action, departure date outside the sales period for agent
510107 Cannot do this action, booking with book code %s has not been paid
510108 Cannot do this action, subclass is hidden
510109 Cannot cancel book, you don\'t have privilege to do this action
510110 Wrong number of [num_pax_adult/child] for this book code
510111 Agent does not exist
510112 Cannot do this action, ticket with book_code has been printed
510113 Cannot do this action, booking with book code has been paid
510114 Seat has wrong subclass
510115 No connecting flight for this schedules
510301 Invalid payment type
510302 Book balance for book_code already 0
510401 No valid route for book_code
510402 No valid pax for book_code
510403 Number of pax does not match with number of seat
510404 Seat already taken
510405 Invalid seat
520001 Numeric code does not exist
520002 Payment type does not exist

S-ar putea să vă placă și