======= Volatour XML (Java) WebSercies =======
Dear valuable partner,
Welcome to the Volatour XML Interface Guide.
We hope you will have a smooth and successful integration to our system.
Should you have any question or need any assistance, please contact:
webservices@teamamericany.com
Development Doclit WSDL: http://devxml40.volateam.com:8081/volatour/services/volatour?wsdl
{{:documentation:xmlschema.gif?nolink|}}
* **STEP 1: SEARCH**
When you search for a product each one of the results might be either "Available" or "On Request".
When you book an "Available" the item will become CF (Confirmed)
When you book a "On Request" the item will become RQ
Cancellation is possible in this step. The system will cancel and disappear the item from the reservation. If there are Cancellation fees, the system will create a new item in the reservation with the total balance.
* **STEP 2: BOOKING**
//PROCESSING// →
During this step we send a message to the provider with the new Item
CF becomes PK during this process
RQ becomes PR during this process
Important: Cancellation during this step is not possible. If a cancellation request is sent to our system regarding an item which is in PK or PR, the function will return an Error Message
//CONFIRMATION// →
When the provider answers with their Confirmation Number
PK becomes BK
PR becomes BK if the request gets approved and UC if it is not approved
* **STEP 3: INFORMATION RETRIEVAL**
Retrieve any information of existing bookings.
* **STEP 4: CANCELLATION AFTER CONFIRMATION** (Just if needed)
When an item has been confirmed and it needs to be cancelled we send a request of cancellation to the provider. The item can not be considered cancelled until the provider confirms the cancellation
BK becomes XB when we receive your cancellation request
XB becomes PX when we send the cancellation request
PX becomes CX when the Hotel confirms the cancellation
If there are Cancellation fees, the system will create a new item in the reservation with the total balance.
----
======1.SEARCH======
**SEARCH FUNCTIONS:** Everything needed to search and build a result is under this set of Functions. to enhance the response time we recommend having everything cached on a regular basis and only the newly designed [[documentation:volajws#pricesearch|PriceSearch]] function looking dynamically for prices within our system.
(v3)This newly designed Functions are the Core of the Version 3. We Guarantee Speed Increase if applied as specified.
----
===== ✔ ServiceSearch=====
**Description:** Search for services for a particular date. Services are Sightseeing, Restaurant , Transfer, Tranfer /Tours .
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ServiceSearch | |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |CityCode |string |1 |Y | Use City Codes from ListCities |
|1 |ProductCode|string |1 |N |Optional, use to search a single product |
|1 |ServiceDate |string |1 |Y |
|1 |ServiceType |string |1 |N |S = Sightseeing / Tour, R = Restaurant, T = Transfer, P = Packages, A = All types |
|1 |DisplayClodeOut |string |1 |N | 'Y' - Show, 'N' - Do not display |
|1 |DisplayOnRequest |string |1 |N |'Y' - Show, 'N' - Do not display; it is HIGHLY recommended NOT to display unbookable products|
username
password
NYC
NYCSS
2015-12-15
S
N
N
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ServiceSearchResponse | |1 | |
|1 |ProductCode |string |1 |Y |
|1 |ProductType |string |1 |Y |
|1 |TransferType |string |1 |N/A|
|1 |MaximumOccupancy |string |1 | |
|1 |ProductName |string |1 |Y | **MUST** be shown to booking agent! Watch for Child specific ProductCodes |
|1 |ProductDescription |string |1 |Y |
|1 |VendorID |INT |1 |Y |
|1 |CityName |string |1 | |
|1 |Status | |1 |Y | 'OK' means Product will be immediately confirmed |
|1 |ProductDate | |1 |Y |
|1 |Price |Float |1 |Y |
|1 |ChildPrice | |1 |N/A |
|1 |ChildAge | |1 |N/A |
|1 |PromoMessage |string |1 | |
|1 |WebPriority | |1 |N/A |
|1 |NumPax | |1 |N/A |
|1 |PackageDetails | | 0/1 | |Will only be displayed on Package searches |
|2 |PullPriceFlag | |1 |N/A |
|2 |DisplayNightsFlag | |1 |N/A |
|2 |DefaultNights | |1 |N/A |
|2 |ProductCode | |1 |Y | Required to book packages |
|2 |Description | |1 |Y |
|1 |Latitude |Float |1 |N/A |
|1 |Longitude |Float |1 |N/A |
|1 |VendorImage |string |1 |N/A |
|1 |VendorName |string |1 |Y |
|1 |VendorDescription |string |1 | |
|1 |VendorAddress1 |string |1 |Y |
|1 |VendorAddress2 |string |1 |Y |
NYCSCONTR
TRANSFER
NOT SET
0
.TOUR OF CONTRAST ITALIAN 5 HRS
Tour of the BRONX, QUEENS & BROOKLYN....
228
New York, NY
OK
2015-12-15
52.0
0.0
0
1
0
0.0
0.0
http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCSCONTR
VOLATOUR NY TOURS
33 WEST 46 STREET
NYCSCONTSP
TRANSFER
NOT SET
0
.TOUR OF CONTRAST SPANISH 5HRS
Tour of Bronx, Queens and Brooklyn....
228
New York, NY
OK
2015-12-15
52.0
0.0
0
1
0
0.0
0.0
http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCSCONTSP
VOLATOUR NY TOURS
33 WEST 46 STREET
. . .
**Errors**
*Error - Login Invalid
*Error - Invalid length for City Code - Use LiStCities City Code
*Error - Invalid date
----
===== PriceSearch=====
This function is not supported by Volatour
----
=====✔ ProductInfoV2=====
**Description:**
ProductInfo returns not-dynamic, not-sensitive, stable information that should be cached in the client side on a regular basis (ideally every week, but once a month is acceptable).
:!: //This function should be used together with / after [[documentation:volajws#ServiceSearch|ServiceSearch]]//
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ProductInfo | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |ProductCode |string |1 |Y | Mandatory if VendorName or VendorID is blank, Product code or part of it, will return 1 result for specific product |
|1 |VendorID |INT |1 |Y | Mandatory if ProductCode is blank, if you do not have a Vendor ID, use [[documentation:volajws#list_vendor|ListVendor]] to find it. |
|1 |ProductDescription |attribute only |1 |N | Include to return a HTML formatted product description. Set attribute encoding="base64" or "CDATA" to specify how the description is returned. This tag is optional. |
Sample to return information on one product
username
password
NYCSS
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ProductInfoResponse | |1 | | You may find several products for the same Vendor |
|1 |ProductCode |string |1 |Y |
|1 |ProductType |string |1 |N |
|1 |ProductName |string |1 |N |
|1 |VendorName |string |1 |N | The Vendor's name |
|1 |TeamVendorID |int |1 |Y | Unique Hotel ID |
|1 |CityName |string |1 |Y |
|1 |ChildAge |int |1 |Y | |
|1 |Latitude |string |1 |Y |
|1 |Longitude |string |1 |Y |
|1 |VendorDescription |string |1 |Y |
|1 |VendorAddress1 |string |1 |Y |
|1 |VendorAddress2 |string |1 |Y |
|1 |VendorState |string |1 |Y |
|1 |VendorCity |string |1 |Y |
|1 |VendorCountryISO |string |1 |Y | Vendor's country code |
|1 |VendorZip |string |1 |Y |
|1 |VendorTel |string |1 |Y |
|1 |VendorFax |string |1 |Y |
|1 |VendorURL |string |1 |Y |
|1 |WebPriority |string |1 |Y | Internal Use Only |
|1 |Promotion |string |1 |Y | Here you will find promotion messages, if exist|
|1 |ProductDetail |string |1 |Y |
|1 |ProductDescription |string |0 |Y |
|1 |NonRefundable |int |1 |Y | “1” if this is a Non Refundable Product, “0” if refundable |
NYCSGOS
Service
.TOUR HARLEM & GOSPEL ITALIAN SUNDAY
VOLATOUR NY TOURS
228
New York, NY
0
0.0
0.0
All regular tours depart from VOLATOUR. Please check times and voucher instructions in the NEW YORK SERVICE DESCRIPTION.Additional charge on private tours between December 27 and January 2.
33 WEST 46 STREET
NY
NEW YORK
10036
212 557 1654
917 464 8489
1
PICK UP MUST BE CONFIRMED BY VOLATOUR. . .
PHA+PHN0cm9uZz5EZXBhcnR1cmUgU2NoZWR1bGUgaW4gU3VtbWVyIDIwMTkgc3RheXMgdGhlIHNhbWUgYXMgdGhlIHJlc3Qgb2YgdGhlIHllYXIuPC9zdHJvbmc+PC9wPg0KPHA+PHN0cm9uZz5EdXJhdGlvbjo8L3N0cm9uZz4gNCBob3Vycy4gTWVldGluZyBhdCA5OjQ1IGFtLCBkZXBhcnR1cmUgYXQgMTA6MDAgYW0gZnJvbSBWT0xBVE9VUiAzMyBXZXN0IDQ2PHN1cD50aDwvc3VwPiBTdHJlZXQsIGJldHdlZW4gNTxzdXA+dGg8L3N1cD4gYW5kIDY8c3VwPnRoPC9zdXA+IEF2ZW51ZS4gRHVyaW5nIFN1bW1lciBtb250aHMsIGRlcGFydHVyZSB0aW1lIG1pZ2h0IGNoYW5nZS48L3A+DQo8cD48c3Ryb25nPkJsYWNrIE91dCBEYXRlOjwvc3Ryb25nPiBFYXN0ZXIgU3VuZGF5LjwvcD4NCjxwPjxzdHJvbmc+RGVzY3JpcHRpb248L3N0cm9uZz46IE1lbW9yYWJsZSB2aXNpdCBvZiBIYXJsZW0gZHVyaW5nIHdoaWNoIHlvdSB3aWxsIGF0dGVuZCBhbiBhdXRoZW50aWMgcmVsaWdpb3VzIHNlcnZpY2UgaW4gYSBCYXB0aXN0IENodXJjaCwgYW5kIGxpc3RlbiB0byBncmVhdCBHb3NwZWwgbXVzaWMuIFlvdSB3aWxsIGRpc2NvdmVyIGFuIHVua25vd24gSGFybGVtLCBhIG5laWdoYm9yaG9vZCBvZiBncmVhdCBjb250cmFzdHMgdGhhdCBpcyBzdGlsbCB0aGUgY2FwaXRhbCBvZiB0aGUgQWZyby1BbWVyaWNhbiBjdWx0dXJlLjwvcD4NCjxwPjxzdHJvbmc+Vm91Y2hlciA8L3N0cm9uZz5tdXN0IGJlIGFkZHJlc3NlZCB0byBWT0xBVE9VUiBJbmMuIDMzIFdlc3QgNDY8c3VwPnRoPC9zdXA+IFN0cmVldCAmbmRhc2g7IE5ldyBZb3JrLCBOWSAxMDAzNi4gVm91Y2hlciBtdXN0IG1lbnRpb24gdGhhdCZuYnNwOyA8c3Ryb25nPjx1PnByb3BlciBhdHRpcmUgaXMgcmVxdWlyZWQ8L3U+PC9zdHJvbmc+PHU+ICg8c3Ryb25nPm5vIHNob3J0cyBvciB0YW5rIHRvcHMpIGFuZCB0aGF0IG5vIGNhbWVyYXMgYW5kIHJlY29yZGluZyBkZXZpY2VzIGFyZSBnb2luZyB0byBiZSBhZG1pdHRlZCBpbiB0aGUgY2h1cmNoPC9zdHJvbmc+PC91PjwvcD4NCjxwPlRoaXMgcHJvZHVjdCBpcyBhdmFpbGFibGUgaW4gPHN0cm9uZz5GUkVFIFNFTEwgPC9zdHJvbmc+ZXhjZXB0IEFwcmlsIDEyLCAyMDIwIChTUEVDSUFMIEhJR0hFUiBSQVRFKS48L3A+
0
**Errors**
*Error - Login Invalid
----
**Request XML**
Sample to see ALL products offered by 1 vendor (Volatour NYC tours)
username
password
228
----
===== ListMealPlan =====
This function is not supported by Volatour
----
=====✔ ListCities=====
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListCities | |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
username
password
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListCitiesResponse | |1 |
|1 |CityCode |string |1 |Y |
|1 |CityName |string |1 |Y |
|1 |Country |string |1 |Y |
|1 |DisplayGroup |string |1 |N |
ABB
*Abbotsford, BC, CANADA
CANADA
.
.
ZXR
Carmel Valley
USA
**Errors**
*Error - Login Invalid
**Description:**
Retrieve List of cities.
the list includes City code , country and Display Group
----
=====✔ ListPickUpLocations=====
Display a list of Pick Up (also Drop Off) Locations, for booking Transfers. On inbound transfers this is Drop Off location, usually the hotel of the passengers are staying. If the exact location is not listed use the next closest PULoc and note the actual location with the ItemRemarks tag.
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListPickUpLocation | |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
username
Password
NYC
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListPickUpLocationResponse | |1 | |
|1 |PickUpLocation |string |1 |Y |
|1 |PickUpLocationDescription |string |1 |Y |
NYCG
.NYC G E N E R I C HOTEL
.
.
**Errors**
*Error - Login Invalid
*Error - Invalid length for City Code - Maximum of 4 allowed
**Description:**
List pick locations in a city.
----
=====✔ List Vendor=====
**Description:**
List Vendor returns id and number of all Vendors
** Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListVendor | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |CityCode |string |1 |Y |Use [[documentation:volajws#listcities|ListCities]] to get City Codes from all available Cities|
|1 |Type |string |1 |Y |Use 'Service' or 'Hotel' as parameters |
username
password
NYC
Service
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|1 |VendorID | INT |1 | Unique Hotel ID |
|1 |VendorName |string |1 |Y |
|1 |City |int |1 |Y ||
158
ACADEMY BUS
HOBOKEN
1
VOLATOUR-NEW YORK
NEW YORK
**Errors**
*Error - Login Invalid
*Error - Invalid City Code Length
*Error - Invalid Type
----
======2. BOOK======
**BOOKING FUNCTION:** NewMultiItemReservation is our new and easy to integrate booking solution. Instead of different functions for adding passengers, adding different items and confirming the booking we simplify the process in this all in one comprehensible function.
----
===== ✔ Book Services using NewMultiItemReservation Method: =====
**Description** for the amount of people associated with this reservation please use Quantity; not Occupancy
^Level^Name^Type^Occurs^Required^Comments^
|0 |NewMultiItemReservation | |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |AgentName |string |1 |Y |
|1 |AgentEmail |string |1 |Y |
|1 |ClientReference |string |1 |Y |
|1 |Items | |1 |Y |
|2 |NewItem | |1 |Y | The element can be used for 1 or more repetitions You may book several different items under the same reservation. |
|3 |ProductCode |string |1 |Y |
|3 |ProductDate |string |1 |Y | Service date |
|3 |Occupancy |string |1 |Y | **ALWAYS SET 'Single'** Must be set for Number of Passengers: 1: 'Single' 2: 'Double' 3: 'Triple' 4: 'Quad' |
|3 |NumberOfNights |int |1 |Y | It must always be 1 for services.|
|3 |Language |string |1 |N | Required for Tours, ENG/ITA/GER/SPA/FRE/POR (Also used with transfers for New York Airport codes: JFK, EWR, LGA)|
|3 |PickUpLocation |string |1 |N | Required for Transfers - You must use the ListPickUpLocations function for possible values, otherwise Optional |
|3 |PickUpTime |string |1 |N | Required for Transfers, in HH:MM format |
|3 |FlightInfo |string |1 |N | Required for Transfers. 10 Chars max in AZ1234 format |
|3 |Quantity |int |1 |Y | Number people being booked for Service. **Used in place of ** |
|3 |ItemRemarks |string |1 |N | Free text, remarks for the Vendor |
|3 |Passengers |string |1 |Y |The < Passengers > element can be used for 1 or more repetitions. You may assign 1 or more pax per the specific item which you are currently booking|
|3 |NewPassenger |string |1 |Y |
|4 |Salutation |string |1 |Y |
|4 |FamilyName |string |1 |Y |
|4 |FirstName |string |1 |Y |
|4 |PassengerType |string |1 |Y | Always use 'AD', even for children |
|4 |PassengerAge |string |1 |Y |
|3 |BelongsToPackage |int |1 |Y | Use 0, unless a packaged item, then use 1 |
|3 |PackageCode |string |1 |N | For Packages, the Product Code of that package must be entered here |
|3 |RateExpected |float |1 |Y | Average Rate as Returned by Service Search, otherwise use 0 |
**Request XML**
username
password
alex
achan@teamamericany.com
NYCTIB
2015-08-17
Double
1
1
test
Mr
Test
A
AD
30
Mr
Test
B
AD
30
0
0
**Sample Response**
673840
2015-07-23
OK
RW
0.0
*TEAMTEST
33 West 46th st 3rd floor
New York
NY
10036
SPAIN
achan
1369062
NYCTIB
2015-08-17
NYCT TRSFR IN-SEAT ON COACH MIN 2PAX
Double
1
39.96
79.91
2
CF
test
1
flights landing btwn 10:00 pm & 6:00 am must be BKD AS PVT TRFS. $110 FEE XTRF BFORE 9AM ON P/UP TIME /Flight # /M1 MIN. 2 PAX RATE $25 EACH 12/24; 12/25 & 1/1; 12/ 31 AFT 7P
79.91
EP-NO MEALS
1
11838419
TEST
A
AD
30
11838420
TEST
B
AD
30
79.91
0.0
0.0
0.0
0.0
0.0
79.91
0.0
0.0
0.0
0.0
0.0
0.0
----
===== NewMultiItemReservation with Packages=====
**Description**
This Function also allows booking of Packages, with multiple items, under the same reservation with just one call
//**Placing a new Reservation**//
After choosing the desired Package you wish to book, we allow you to call just 1 function to book all the items of a package with this function.
The output of this call will be one reservation, with a unique reservation ID, and if you chose to place many items so each one of them will have a unique item ID.
Some explanations about the different occupancies you may use, when booking:
In PriceSearchExt () response, there are max 4 occupancies available for each product: Single/Double/Triple/Quad.
However, when adding items in NewMultiItemReservation(), you may put some more options.
The available Occupancies you may use in NewMultiItemReservation() request are as follow:
Single, Double, Triple, Quad , SGL+1CH, DBL+1CH, DBL+2CH, TPL+1CH
//**How to book them**//
All the items (Product Codes) of a package must be listed underneath the Package Code with:
* set to the package desired, and
* set to 1
**Request XML**
Sample request:
username
password
agentname@agency.com
Test_180910b
NYCPLEAST
2018-11-01
Single
1
ITA
2
Mr.
Tester
Test
AD
30
Mrs
Tester
Wife
AD
30
0
0
NYCTIB
2018-11-01
Single
1
ITA
NYCROO
1620
KL0643
2
Mr.
Tester
Test
AD
30
Mrs
Tester
Wife
AD
30
1
NYCPLEAST
0
NYCSS
2018-11-03
Single
1
ITA
NYCVOLA
2
Mr.
Tester
Test
AD
30
Mrs
Tester
Wife
AD
30
1
NYCPLEAST
0
NYCTOB
2018-11-07
Single
1
ITA
NYCROO
1820
KL0644
2
Mr.
Tester
Test
AD
30
Mrs
Tester
Wife
AD
30
1
NYCPLEAST
0
:!: If you would like to add new items to an existing reservation, you may do it using AddItem() method. However it is not possible to add new passengers, but use only existing ones. So, if you would like to add new items to an existing reservation with new passengers, you first have to call the AddPassenger() method, and only then take the new passengers ID’s into the AddItem() method.
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |NewMultiItemReservationResponse | |1 | |
|1 |ReservationNumber |int |1 |Y |
|1 |BookingAgentReferenceNumber |string |1 |Y |
|1 |DateBooked |string |1 |Y |
|1 |ReservationStatus |string |1 |Y |
|1 |FaxStatus |string |1 |Y |
|1 |ReservationStatusDescription |string |1 |Y |
|1 |GeneralComments |string |1 |Y |
|1 |AgencyCommissionAmount |float |1 |Y |
**Errors**
**Description:**
**Sample Response:**
388345
Test_180910b
2018-09-10
OK
RW
0.0
VOLATOUR
33 WEST 46 STREET
NEW YORK
NY
10036
USA
arie
1038033
NYCPLEAST
2018-11-01
PK PACKAGE AT LEAST IN+OUT+CITY TOUR ITA
Single
1
155.0
310.0
2
CF
0
310.0
0
1038034
NYCTIB
2018-11-01
TRNSF IN SEAT ON COACH ANY APT MIN 2 PAX
Single
1
ITA
ROOSVELT HTL - MADISON @ 45 ST -212 661 9600 (8)
16:20:00
KL0643
0.0
0.0
2
CF
1
0.0
0
1038035
NYCSS
2018-11-03
.TOUR CITY NEW YORK 4 HOURS ITALIAN
Single
1
ITA
NYC VOLATOUR OFFICE 33W 46ST, between 5 & 6 Avenue
0.0
0.0
2
CF
0
PICK UP TO BE CONFIRMED WITH VOLATOUR 24 HR PRIOR
0.0
0
1038036
NYCTOB
2018-11-07
TRNSF OUT SEAT ON COACH ANY APT MIN 2PAX
Single
1
ITA
ROOSVELT HTL - MADISON @ 45 ST -212 661 9600 (8)
18:20:00
KL0644
0.0
0.0
2
CF
1
PICK UP TIME MUST BE CONFIRMED IN ADVANCE WITH VOLATOUR
0.0
0
834801
TESTER
TEST
AD
30
834802
TESTER
WIFE
AD
30
310.0
310.0
0.0
310.0
0.0
0.0
310.0
0.0
0.0
0.0
0.0
0.0
0.0
----
======3. RETRIEVE======
**RETRIEVE FUNCTIONS:** This functions allows to get information regarding any existing reservation.
* [[documentation:volajws#RetrieveReservation|RetrieveReservation]]
* [[documentation:volajws#RetrieveResByReference|RetrieveResByReference]]
----
=====RetrieveReservation=====
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |RetrieveReservation | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |ReservationNumber |INT |1 |Y |
username
password
333333
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |RetrieveReservation | | | |
|1 |ReservationInformation | | | |
|2 |ReservationNumber | int | | |
|2 |BookingAgentReferenceNumber | string| | |
|2 |DateBooked | string | | |
|2 |ReservationStatus |string | | |
|2 |GeneralComments | string | | | |
|2 |AgencyCommissionAmount | float | | | |
|2 |BookingAgentInfo | | | | |
|3 |AgencyName | string | | | |
|3 |Address1 | string | | | |
|3 |Address2 | string | | | |
|3 |City | string | | | |
|3 |State | string | | | |
|3 |PostalCode | string | | | |
|3 |Country | string | | | |
|3 |AgentUserName | string | | | |
|3 |AgentEmail | string | | | |
|2 |Items | | | | |
|3 |UniqueItemID | int | | | |
|3 |ProductCode | string | | | |
|3 |ItemDate | string | | | |
|3 |Description | string | | | |
|3 |Occupancy | string | | | |
|3 |NumberOfNights | int | | | |
|3 |Language | string | | | |
|3 |PickUpLocation | string | | | |
|3 |PickUpTime | string | | | |
|3 |FlightInfo | string | | | |
|3 |AverageNetPricePerNight | float | | | |
|3 |TotalItemNetPrice | float | | | |
|3 |Quantity | int | | | |
|3 |ItemSupplierConfirmationNumber | string | | | |
|3 |ItemStatusCode | string | | | |
|3 |ItemStatusDescription | string | | | |
|3 |ItemRemarks | string | | | |
|3 |ItemInformation | string | | | |
|3 |ItemCommissionable | string | | | |
|3 |ItemPassengers | | | | |
|4 |UniquePassengerID | | | | |
|4 |FamilyName | string | | | |
|4 |FirstName | string | | | |
|4 |Type | string | | | |
|4 |Age | int | | | |
|3 |TotalResNetPrice | float | | | |
|3 |gross_total | float | | | |
|3 |paid | float | | | |
|3 |gross_due | float | | | |
|3 |ag_comm_level | float | | | |
|3 |ag_comm_amt | float | | | |
|3 |net_due | float | | | |
|3 |cc_fees | float | | | |
|3 |ttl_expenses | float | | | |
|3 |ttl_expenses_paid | float | | | |
|3 |commission_amt | float | | | |
|3 |commission_rcvd | float | | | |
|3 |amt_comm_amt | float | | | |
388344
TEST_180910a
2018-09-10
OK
RW
-
0.0
VOLATOUR
33 WEST 46 STREET
NEW YORK
NY
10036
USA
ARIE
1038032
NYCSGERMAG
2018-11-12
TOUR MANHATTAN MAGIC WALK GERMA MO/WE/SA
Single
1
Hyatt Place New York/Midtown-South 52 West 36th
00:00:00
65.0
130.0
2
CF
0
130.0
0
834799
TESTER
TEST
0
834800
TESTER
WIFE
0
130.0
130.0
0.0
130.0
0.0
0.0
130.0
0.0
0.0
0.0
0.0
0.0
0.0
**Errors**
*Error - Login Invalid
*Error – Invalid length for Client Reference – Maximum of 14 allowed
**Description**
----
=====RetrieveResByReference=====
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |RetrieveResByReference | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |Reference |string |1 |N | YOUR booking locator, Max 14 char |
|1 |ShowCX |int |1 |Y | Used to display a Cancelled Reservation |
username
password
TEST_180910a
1
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |RetrieveResByReferenceResponse | |1 | |
|1 |ReservationNumber |int |1 |Y |
|1 |LastName |string |1 |Y |
|1 |FirstName |string |1 |Y |
|1 |DepDate |string |1 |Y |
|1 |ReservationStatus |string |1 |Y |
|1 |Product |string |1 |Y | |
388344
TESTER
TEST
2018-11-12
OK
NYCSGERMAG
**Errors**
*Error - Login Invalid
*Error – Invalid length for Client Reference – Maximum of 14 allowed
**Description**
Retrieve Reservation Number and other Information based on your Client Reference Number.
----
======4. CANCEL======
**CANCEL FUNCTIONS:** Cancel existing reservations and show Cancellation Policies.
* [[documentation:volajws#cancellationpolicy|CancellationPolicy]] (Just Show Information)
* [[documentation:volajws#cancelreservation|CancelReservation]]
----
=====CancellationPolicy=====
**Description:**
This function returns the cancellation policy for a given product code and arrival date. Please always use this function and advise your users.
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |CancellationPolicy | | | | |
|1 |UserName |string |1 |Y | |
|1 |Password |string |1 |Y | |
|1 |ProductCode |string |1 |N |e.g. BKLHALOFTD|
|1 |ArrivalDate |date |1 |Y |ISO YYYY-MM-DD|
username
password
NYCSNIA
2018-09-25
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |CancellationPolicyResponse | |1 | |
|1 |NumberDaysPrior |int |1 |Y |Number of days prior to the travel date after which the cancellation policy applies |
|1 |PenaltyType |string |1 |Y |There are 3 types of penalty types: Nights, Percent and Dollars. |
|1 |PenaltyAmount |float |1 |Y |Depending on the PenaltyType, it may return either a number of nights, a percentage or a cancellation fee in dollars |
100
Dollars
100.0
30
Percent
100.0
**Errors**
*Error - Login Invalid
*Error - Invalid date
----
=====CancelReservation=====
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |CancelReservation | |1 | | |
|1 |Username |string |1 |Y | |
|1 |Password |string |1 |Y | |
|1 |ReservationNumber |int |1 |Y | |
username
password
388344
**XML response EXAMPLE 1** (when cancelling 7 days before, you pay 1 night cxl fee.)
*Please note that if your cancellation results in a cancellation fee, the reservation will remain open (Status OK) until cancellation fee (CXLFEE) has been paid*
CX
1038032
TOUR MANHATTAN MAGIC WALK GERMA MO/WE/SA
CX
0.0
2018-11-12
**Errors**
*Error - Login Invalid
*Error - Reservation not found
**Description:**
----
=====DeleteItem=====
Delete item from a reservation
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |DeleteItem | |1 | | |
|1 |Username |string |1 |Y | |
|1 |Password |string |1 |Y | |
|1 |ItemID |int |1 |Y | |
|1 |BKGSrc |int |1 |N | |
achan
yourpasswordhere
1199644
CX
Item has been deleted
**Description:**
Delete a Item from a Reservation . To retrieve item id in a reservation use retrieve reservation to get the item id.