======= TEAM AMERICA XML 3.0 =======
Dear valuable partner,
Welcome to the Teamamerica Hotels 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
live wsdl: [[http://xml26.teamamericany.com/team3.php?wsdl]] \\
live .NET compatible [[http://xml26.teamamericany.com/team3/doclit?wsdl]] \\
dev wsdl: [[http://devxml26.teamamericany.com/team3.php?wsdl]] \\
dev .NET compatible [[http://devxml26.teamamericany.com/team3/doclit?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 hotel 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// →
The hotel 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 hotel. The item can not be considered cancelled until the hotel 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:team3#pricesearch|PriceSearch]] function looking dynamically for prices within our system.
* [[documentation:team3#pricesearch|PriceSearch]] (v3)
* [[documentation:team3#itemproductinfo|ItemProductInfo]] (v3)
* [[documentation:team3#servicesearch|ServiceSearch]] (v3)
* [[documentation:team3#packagesearch|PackageSearch]] (v3)
* [[documentation:team3#getproductBreakfastOptions|GetProductBreakfastOptions]] (v3)
* [[documentation:team3#listmealplan|ListMealPlan]]
* [[documentation:team3#listroomtype|ListRoomType]]
* [[documentation:team3#listcities|ListCities]]
* [[documentation:team3#listcountry|ListCountry]]
* [[documentation:team3#listroomtype|ListRoomType]]
* [[documentation:team3#listpickuplocations|ListPickUpLocations]]
* [[documentation:team3#geodistance|GeoDistance]]
(v3)This newly designed Functions are the Core of the Version 3. We Guarantee Speed Increase if applied as specified.
----
=====✔ PriceSearch=====
**Description:**
PriceSearch is a new function designed to optimize the response time. It works in tandem with [[documentation:team3#productinfo|ProductInfo]], which handles everything that should be cached in the client side.
Together **PriceSearch** and [[documentation:team3#productinfo|ProductInfo]] replaces a lot of functions, making not just response faster but also integration easier.
Price Search replace the old HotelSearch function.
:!: //This function should be used together with [[documentation:team3#productinfo|ProductInfo]]//
** Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |PriceSearch | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |CityCode |string |1 |Y |Use [[documentation:team3#listcities|ListCities]] to get City Codes from all available Cities|
|1 |ProductCode |string |1 |Y |for all products in that city leave it blank|
|1 |Type |string |1 |Y | ‘Hotel’ as default for searching hotels|
|1 |Occupancy |string |1 |Y | Single, Double, Triple, Quad, SGL+1CH, DBL+1CH, DBL+2CH, TPL+1CH|
|1 |ArrivalDate |string |1 |Y |ISO YYYY-MM-DD|
|1 |NumberOfNights |int |1 |Y |Must be a value between 1 and 14. |
|1 |NumberOfRooms |int |1 |Y |1 to max 3 rooms |
|1 |DisplayCloseOut |string |1 |N | Y/N |
|1 |DisplayOnRequest |string |1 |N | Y/N |
|1 |VendorIDs | |1 |N |
|2 |VendorID |int |1 |N | in this block you may enter 1 or more specific vendor ID’s (Hotels), and narrow the search results to only your preferred hotels |
username
Password
NYC
Hotel
2013-02-20
2
1
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |PriceSearchResponse | |1 | |
|1 |ProductCode |string |1 |Y |
|1 |TeamVendorID |int |1 |Y |Unique Hotel ID|
|1 |ProductDate |string |1 |Y | Check In date|
|1 |NightlyInfo | | |N |
|2 |Dates |string |1 |Y |Specific night|
|2 |Status |string |1 |Y | Available/OnRequest/ClosedOut|
|2 |PromoMessage |string |1 |N | Text with promo offers, if exists |
|2 |MinStay |int |1 |Y |
|2 |MaxStay |int |1 |Y |
|2 |ArrivalRestriction |string |1 |N |
|2 |Prices | |1 |N | Per Room, Per night, divided by Occupancy|
|3 |Occupancy |int |1 |Y | Single/Double/Triple/Quad |
|3 |AdultPrice |float |1 |Y | Total price of the Room for the specific night|
|1 |AverageRate | |1 |N | Per Room, divided by Occupancy|
|2 |Occupancy |int |1 |Y | Single/Double/Triple/Quad|
|2 |AverageNightlyRate |float |1 |Y | Average nightly price of the occupancy|
BKLHALOFTD
5174
2013-02-20
2013-02-20
Available
0
0
Allowed
Single
166
Single
166
. . . .
**Errors**
*Error - Login Invalid
*Error - Invalid City Code Length
*Error - Invalid date
*Error - Number of Nights must be 1 to 12
*Error - Number of Rooms must be 1 to 3
*Error - Type `` is not supported at this time, please use Type `Hotel`
----
----
=====✔ PriceSearchExtv2=====
**Description:**
PriceSearchExtv2 is an extended version of [[documentation:team3#PriceSearch|PriceSearch]].
The request is exactly the same as in PriceSearch but it returns the following additional parameters:
* MealPlan
* RoomType
* ChildAge
* FamilyPlan
* NonRefundable
* MaxOccupancy
* WebPriority
:!: //Web Priority shows Team America Special Products, those with Exclusive Promotions like TeamPlayers //
** Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |PriceSearch | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |CityCode |string |1 |Y |Use [[documentation:team3#listcities|ListCities]] to get City Codes from all available Cities|
|1 |ProductCode |string |1 |Y |for all products in that city leave it blank|
|1 |Type |string |1 |Y | ‘Hotel’ as default for searching hotels|
|1 |Occupancy |string |1 |N | Single, Double, Triple, Quad, SGL+1CH, DBL+1CH, DBL+2CH, TPL+1CH|
|1 |ArrivalDate |string |1 |Y |ISO YYYY-MM-DD|
|1 |NumberOfNights |int |1 |Y |Must be a value between 1 and 14. |
|1 |NumberOfRooms |int |1 |Y |1 to max 3 rooms |
|1 |DisplayCloseOut |string |1 |N | Y/N |
|1 |DisplayOnRequest |string |1 |N | Y/N |
|1 |VendorIDs | |1 |N |
|2 |VendorID |int |1 |N | in this block you may enter 1 or more specific vendor ID’s (Hotels), and narrow the search results to only your preferred hotels |
username
Password
NYC
Hotel
2013-02-20
2
1
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |PriceSearchResponse | |1 | |
|1 |ProductCode |string |1 |Y |
|1 |TeamVendorID |int |1 |Y |Unique Hotel ID|
|1 |ProductDate |string |1 |Y | Check In date|
|1 |MealPlan |string |1 |Y | |
|1 |RoomType |string |1 |Y | |
|1 |ChildAge |int |1 |Y | |
|1 |FamilyPlan |string |1 |Y | Y if Family Plan Available, N if not|
|1 |NonRefundable |int |1 |Y | |
|1 |MaxOccupancy |int |1 |Y | |
|1 |NightlyInfo | | |N |
|2 |Dates |string |1 |Y |Specific night|
|2 |Status |string |1 |Y | Available/OnRequest/ClosedOut|
|2 |PromoMessage |string |1 |N | Text with promo offers, if exists |
|2 |MinStay |int |1 |Y |
|2 |MaxStay |int |1 |Y |
|2 |ArrivalRestriction |string |1 |N |
|2 |Prices | |1 |N | Per Room, Per night, divided by Occupancy|
|3 |Occupancy |int |1 |Y | Single/Double/Triple/Quad |
|3 |AdultPrice |float |1 |Y | Total price of the Room for the specific night|
|1 |AverageRate | |1 |N | Per Room, divided by Occupancy|
|2 |Occupancy |int |1 |Y | Single/Double/Triple/Quad|
|2 |AverageNightlyRate |float |1 |Y | Average nightly price of the occupancy|
|1 |WebPriority |int |1 |Y | Team America Preferred|
BKLHALOFTD
Hotel
5174
2013-02-20
CP-CONTINENTAL BREAKFAST
STANDARD
12
Y
0
4
2013-02-20
Available
0
0
Allowed
Single
166
Single
166
3
. . . .
**Errors**
*Error - Login Invalid
*Error - Invalid City Code Length
*Error - Invalid date
*Error - Number of Nights must be 1 to 12
*Error - Number of Rooms must be 1 to 3
*Error - Type `` is not supported at this time, please use Type `Hotel`
----
----
=====✔ ProductInfo=====
**Description:**
ProductInfo returns not-dynamic, not-sensitive, stable information that should be cached in the client side on a regular basis (ideally every day, but once a week is acceptable).This function should not be included everytime a new request for new prices is made. (See [[documentation:team3#pricesearch|PriceSearch]] for dynamic updated Prices)
ProductInfo Replace the following functions: ListVendorFull, ProductDetails, ProductVendorInfo, PropertyImages.
:!: //This function should be used together with [[documentation:team3#pricesearch|PriceSearch]]//
**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 is blank, Product code or part of it|
|1 |VendorName |string |1 |N | Mandatory if ProductCode is blank, Vendor (hotel) name or part of it |
uuu
pppp
nychpcepr
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ProductInfoResponse | |1 | | You may find several products for the same Vendor (Hotel)|
|1 |ProductCode |string |1 |Y |
|1 |ProductType |string |1 |N |
|1 |ProductName |string |1 |N |
|1 |VendorName |string |1 |N | The Hotel name |
|1 |TeamVendorID |int |1 |Y | Unique Hotel ID |
|1 |CityName |string |1 |Y |
|1 |FamilyPlan |string |1 |Y | Y/N
|1 |ChildAge |int |1 |Y | Max pax age that can be declared as a child |
|1 |MaximumOccupancy |int |1 |Y | Max pax per room (including children) |
|1 |HotelRating |int |1 |Y |
|1 |Latitude |string |1 |Y |
|1 |Longitude |string |1 |Y |
|1 |VendorImage |string |1 |Y | Main thumbnail |
|1 |VendorDescription |string |1 |Y |
|1 |VendorAddress1 |string |1 |Y |
|1 |VendorAddress2 |string |1 |Y |
|1 |VendorState |string |1 |Y |
|1 |Promotion |string |1 |Y | Here you will find promotion messages, if exist|
|1 |MealPlan |string |1 |Y | From our list of MealPlans |
|1 |RoomType |string |1 |Y | From our list of RoomTypes |
|1 |NorthStarCode |int |1 |Y |
|1 |ProductDetail |string |1 |Y |
|1 |PermRoomCode |string |1 |Y |
|1 |ResortFee |float |1 |Y |
|1 |ResortFeeType |string |1 |Y |
|1 |NonRefundable |int |1 |Y | “1” if this is a Non Refundable room, “0” if refundable |
|1 |VendorCountryISO |string |1 |Y | Hotel’s country code |
|1 |VendorZip |string |1 |Y |
NYCHPCEPR
Hotel
NYCH PARK CENTRAL HOTEL 1 BED
PARK CENTRAL HOTEL
131
NYC-.New York, NY
Y
18
2
4
40.764696
-73.981022
http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCHPCEPR
Full-service Midtown hotel close to Central Park,Broadway shows, Carnegie Hall,and chic shops are near-neighbors to this centrally located 25-story hotel. Spacious, refurbished rooms have high ceilings, soundproof walls, smart tan-and-black color schemes, dual-line speakerphones, and modernized bathrooms with marble sinks. Fresh from a $65-million renovation in 2000, the hotel includes a popular bar and cafe, and a fitness center. Convenient Internet access is available just off the lobby.
870 7TH AVENUE /56TH ST
NY
NEW YORK
EP-NO MEALS
STANDARD ONE BED
135224
131
Cityhouse
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/711/189/cityhouse2_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/711/189/cityhouse2_H.jpg
131
Lobby View
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/781/PROP1-20100430-020608-968_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/781/PROP1-20100430-020608-968_H.jpg
131
Th Ave
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/710/655/7th_ave_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/710/655/7th_ave_H.jpg
131
Park Central
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/20/106/554/1094424cdmssabrevfm_img_pho_000_nc__673709_Park_Central___A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/20/106/554/1094424cdmssabrevfm_img_pho_000_nc__673709_Park_Central___H.jpg
131
Bar/Lounge
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/785/PROP2-20100430-020608-462_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/785/PROP2-20100430-020608-462_H.jpg
131
Bar/Lounge
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/794/PROP4-20100430-020608-884_A.jpg
http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/794/PROP4-20100430-020608-884_H.jpg
NO SHOWS 100% PENALTY WILL APPLY. NON-SMOKING HOTEL. HTL UNDER RENOVATIONS (GUEST ROOMS & LOBBY). JAN-AUG 2013. F & B SERVICES FALL 2013.
1
0
0
USA
10019
**Errors**
*Error - Login Invalid
*Error - Invalid City Code Length
----
=====✔ 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:team3#listcities|ListCities]] to get City Codes from all available Cities|
UUU
PPP
NYC
**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 ||
5132
60 THOMPSON HOTEL
NEW YORK
556
70 PARK AVENUE A KIMPTON HOTEL
NEW YORK
158
ACADEMY BUS
HOBOKEN
717
ACCENT ON DINING
VERONA
3554
AFFINIA FIFTY HOTEL
NEW YORK
3553
AFFINIA GARDENS
NEW YORK
1314
AFFINIA MANHATTAN
NEW YORK
**Errors**
*Error - Login Invalid
*Error - Invalid City Code Length
----
----
===== ✔ ServiceSearch2=====
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ServiceSearch2 | |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |CityCode |string |1 |Y |
|1 |ProductCode |string |1 |Y |
|1 |ServiceDate |string |1 |Y |
|1 |ServiceType |string |1 |N |
|1 |DisplayClodeOut |string |1 |N |
|1 |DisplayOnRequest |string |1 |N |
username
Password
NYC
2013-01-01
Hotel
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
**Errors**
*Error - Login Invalid
*Error - Invalid length for City Code - Maximum of 4 allowed
*Error - Invalid date
**Description:**
=====✔ Escorted Tours Search =====
=== XML Request: ===
^Level^Name^Type^Occurs^Required^Comments^
|0 |EscortedToursSearch | |1 | | Search for escorted tours availability for specified dates |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |ProductCode |string |1 |N | Not mandatory but helpful if you know the exact code you are looking for |
|1 |CityCode |string |1 |Y | This is a 3 character code (e.g. 'NYC' for New York City) |
|1 |ArrivalDate|date|1 |Y | Format must be in YYYY-MM-DD (e.g. 2014-10-12) |
|1 |Occupancy |int |1 |Y | Only integer applicable, for Single => 1, Double => 2, Triple => 3, Quad => 4 |
username
password
NYC
2014-10-12
2
=== XML Response: ===
^Level^Name^Type^Occurs^Required^Comments^
|0 |EscortedToursSearchResponse||1 | | Shows available tours for given dates |
|1 |ProductCode|string |1 |Y | Unique Product Code |
|1 |ProductType|string |1 |N | EscortedTours |
|1 |ProductName|string |1 |Y | Product Name with little description |
|1 |VendorID|int|1 |Y | Unique Vendor ID |
|1 |CityName|string |1 |Y | Full City Name |
|1 |Status|string|1 |Y | Availability Status |
|1 |ProductDate|date|1 |Y | Service Date or Arrival Date of the service |
|1 |Price|float|1 |Y | Adult Price
|1 |ChildPrice|float|1 |N | If child price is not defined, it'd take adult price (conditional*) |
|1 |ChildAge|int|1 |N |
|1 |WebPriority|int|1 |N | Optional (to identify the hotel ratings, if there's any) |
|1 |NumPax|int |1 |Y | Number of passenger for each service |
|1 |PackageDetails||1 |Y | Array response with with package item details |
|2 |PullPriceFlag|int|1 |Y | Usually this flag is 0, unless any item has prices on |
|2 |DisplayNightsFlag|boolean|1 |N |
|2 |DefaultNights|int|1 |Y | Number of nights for the package item |
|2 |ProductCode|string|1 |Y | Package Item Code, could be hotel, service or another package |
|2 |Description|string|1 |Y | Brief description of the product |
|2 |PackageItemDate|date|1 |Y | Arrival Date for the package item |
|1 |AvailabilityDetails||1 | | Array response for next (3 months+) available services |
|2 |Date|date|1 |Y | Service or Arrival Date |
|2 |Availability|string |1 |N | Available Status |
|2 |Price|float|1 |Y | Adult Price |
|1 |Latitude|string |1 |Y | Vendor Location Map |
|1 |Longitude|string|1 |Y | Vendor Location Map |
|1 |VendorImage|string |1 |Y | Optional, if there's any image provided by vendor |
|1 |VendorName|string |1 |Y | Full vendor name |
|1 |VendorDescription|string |1 |N | Optional (if there's any description provided by Vendor) |
|1 |VendorAddress1|string |1 |Y | Vendor Address e.g. 33 WEST 46th St. 3rd Floor, NY-10036 |
|1 |VendorAddress2|string |1 |N |
NYCETDCA
EscortedTours
NYCE TEAM TOUR MINI WASHINGTON
1080
NYC-.New York, NY
AVAILABLE: 7+
2014-10-10
369
229
18
3
2
2014-08-08
AVAILABLE: 7+
369
2014-08-15
AVAILABLE: 7+
369
2014-08-22
AVAILABLE: 7+
369
2014-08-29
AVAILABLE: 7+
369
2014-09-05
AVAILABLE: 7+
369
2014-09-12
AVAILABLE: 7+
369
2014-09-26
AVAILABLE: 7+
369
2014-10-10
AVAILABLE: 7+
369
40.7566652
-73.9803778
http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCETDCA
TEAMAMERICA ESCORTED TOURS
33 WEST 46 STREET
NYCETDCAMP
EscortedTours
NYCE TEAMTOUR MINI WASHINGTON MULTIPLUS
1080
NYC-.New York, NY
AVAILABLE: 7+
2014-10-10
849
349
18
3
2
0
0
1
NYCTEIB
NYCE ESCORTED TOURS ONLY TIB
2014-10-05
0
0
2
NYCEHMILFP
NYCE ROW NYC PRE/POST NIGHTS
2014-10-05
0
0
1
NYCSS
NYCS CITY TOUR (REG) ITAL. OR SPANISH
2014-10-06
0
0
1
NYCETDCA
NYCE TEAM TOUR MINI WASHINGTON
2014-10-07
0
0
1
NYCEHMILFP
NYCE ROW NYC PRE/POST NIGHTS
2014-10-09
0
0
1
NYCTEOB
NYCE ESCORTED TOUR ONLY TOB
2014-10-10
2014-08-08
AVAILABLE: 7+
849
2014-08-15
AVAILABLE: 7+
849
2014-08-22
AVAILABLE: 7+
849
2014-08-29
AVAILABLE: 7+
849
2014-09-05
AVAILABLE: 7+
849
2014-09-12
AVAILABLE: 7+
849
2014-09-26
AVAILABLE: 7+
849
2014-10-10
AVAILABLE: 7+
849
40.7566652
-73.9803778
http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCETDCAMP
TEAMAMERICA ESCORTED TOURS
33 WEST 46 STREET
**Errors**
* Error - Login Invalid
* Error - Invalid length for City Code
* Error - Invalid Date
* Error - Invalid Occupancy
=====GetProductBreakfastOptions=====
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |GetProductBreakfastOptions | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |ProdCode |string |1 |Y |
username
Password
BKLHBWPP
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
**Errors**
*Error - Login Invalid
*Error - ProdCode is required
**Description**
----
----
=====ListMealPlan=====
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListMealPlan | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
username
Password
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListMealPlanResponse | |1 | |
|1 |MealPlanID |int |1 |Y |
|1 |MealPlan |string |1 |Y |
|1 |DeteUpdated |string |1 |Y |
|1 |Deleted |int |1 |Y |
6
AI-ALL INCLUSIVE
2011-03-03 16:01:59
0
. . . .
**Errors**
*Error - Login Invalid
**Description**
----
----
=====ListRoomType=====
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListRoomType | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
username
Password
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListRoomTypeResponse | |1 | |
|1 |RoomTypeID |int |1 |Y |
|1 |RoomType |string |1 |Y |
|1 |DateUpdated |string |1 |Y |
|1 |Deleted |int |1 |Y |
74
1 BDRM RESORT VILLA
2011-03-21 22:56:04
1
.
.
**Errors**
*Error - Login Invalid
**Description**
----
----
=====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 |
YBA
*Banff, AB,CANADA
Canada
.
.
ZIO
ZIO-Zion, UT
USA
Zion Area
**Errors**
*Error - Login Invalid
**Description:** Retrieve List of cities
----
----
=====ListPickUpLocations=====
**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:**
----
----
=====ListProduct=====
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListProducts | |1 | |
|1 |UserName |string 1 |Y |
|1 |Password |string 1 |Y |
|1 |CityCode |string 1 |N |
|1 |Type |string |1 |N |
|1 |Date |string |1 |Y |
|1 |VendorName |string |1 |N |
username
Password
NYC
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |ListProductsResponse | |1 | |
|1 |ProductCode |string |1 |Y |
|1 |ProductType |string |1 |Y |
|1 |ProductName |string |1 |Y |
|1 |TeamVendorID |string |1 |Y |
|1 |CityName |string |1 |Y |
|1 |ChildAge |int |1 |Y |
|1 |HotelAddress1 |string |1 |N |
|1 |HotelAddress2 |string |1 |N |
|1 |HotelCity |string |1 |N |
|1 |HotelState |string |1 |N |
|1 |HotelZip |string |1 |N |
|1 |HotelPhone |string |1 |N |
|1 |MealPlan |string |1 |N |
|1 |RoomType |string |1 |N |
BKLHALOFTD
Hotel
BKLH ALOFT NEW YORK BROOKLYN - DBL DBL
5174
NYC-Brooklyn, NY
17
218 DUFFIELD STREET
BROOKLYN
NY
11201
718 256 3833
EP-NO MEALS
STANDARD
.
.
**Errors**
*Error - Login Invalid
*Error - Invalid date
**Description:**
----
----
=====GeoDistance===
**Description: **
This function return the distance from any given point(Lat,Lon) to the Hotel
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |GeoDistance | |1 | |
|1 |Latitude |string |1 |Y
|1 |Longitude |string |1 |Y
|1 |ProductCode |string |1 |Y
|1 |Units |string |1 |N |KM for metric
BKLHMARRBB
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |GeoDistanceResponse | |1 | |
|1 |Distance |string |1 |Y
5380.5665
**Errors**
*Error - Login Invalid
*Error - Product Code Incorrect
----
----
======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.
* [[documentation:team3#newmultiitemreservation|NewMultiItemReservation]] (v3)
----
=====✔ NewMultiItemReservation=====
**Description**
This Function allows to book multiple items under the same reservation with just one call
//**Placing a new Reservation**//
After choosing the desired product/products you wish to book, we allow you to call just 1 function and place multiple items booked under the same reservation.
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 do you choose between them?**//
Now, first we will check if the hotel is supporting family plan.
* If = Y, and the pax children age is lower than value, then child is included in the price, so if there are 2 adults and 1 child under these conditions, you will put DBL+1CH in the occupancy and pay the Double room price. If the child age is higher than value, then the child will be considered as adult and you will have to put Triple in the occupancy
* If = N then every pax, regardless if adult or child, is considered as an adult, and the only values you can put in the occupancy are Single, Double, Triple, Quad
**Request XML**
^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. Every item can be a Hotel Room, a service, a transfer etc. |
|3 |ProductCode |string |1 |Y |
|3 |ProductDate |string |1 |Y | Check-in date |
|3 |Occupancy |string |1 |Y | Single, Double, Triple, Quad, SGL+1CH, DBL+1CH, DBL+2CH, TPL+1CH |
|3 |NumberOfNights |int |1 |Y | Must be a value between 1 and 14. It should always be 1 for services.|
|3 |Language |string |1 |N | Optional, ENG/ITA/GER/SPA/FRE/POR |
|3 |PickUpLocation |string |1 |N | Optional, for Transfers - You must use the ListPickUpLocations function for possible values |
|3 |PickUpTime |string |1 |N | Optional, for Transfers, in HH:MM format |
|3 |FlightInfo |string |1 |N | Optional, for Transfers. 10 Chars in AZ1234 format |
|3 |Quantity |int |1 |Y | Number of repetitions of the Room/Service. Between 1-3 for Hotel Rooms, 1-12 for Services |
|3 |ItemRemarks |string |1 |N | Free text, remarks for the Hotel|
|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 |N |
|4 |FamilyName |string |1 |Y |
|4 |FirstName |string |1 |Y |
|4 |PassengerType |string |1 |Y | AD /CH|
|4 |PassengerAge |string |1 |Y |
|3 |BelongsToPackage |int |1 |N |
|3 |PackageCode |string |1 |N |
|3 |RateExpected |float |1 |N | Optional, for future usage |
username
password
:!: 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:**
====✔ Book Escorted Tours using AddItem Method: ====
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |AddItem| |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |ReservationNumber|int|1 |Y | Mandatory
|1 |ProductCode |string |1 |Y | Must provide valid product code/package code
|1 |ProductDate |string |1 |Y | Check-in date |
|1 |Occupancy |string |1 |Y | Single, Double, Triple, Quad, SGL+1CH, DBL+1CH, DBL+2CH, TPL+1CH |
|1 |NumberOfNights |int |1 |Y | Must be a value between 1 and 14. It should always be 1 for services. [for escorted number of nights is always 1]|
|1 |Language |string |1 |N | Optional, ENG/ITA/GER/SPA/FRE/POR |
|1 |PickUpLocation |string |1 |N | Optional, for Transfers - You must use the ListPickUpLocations function for possible values |
|1 |PickUpTime |string |1 |N | Optional, for Transfers, in HH:MM format |
|1 |FlightInfo |string |1 |N | Optional, for Transfers. 10 Chars in AZ1234 format |
|1 |Quantity |int |1 |Y | Number of repetitions of the Room/Service. Between 1-3 for Hotel Rooms, 1-12 for Services, [for escorted tours Quantity is changeable according to occupancy, e.g. if Occupancy is set to Double, Quantity count as 2] |
|1 |ItemRemarks |string |1 |N | Free text, remarks for the Hotel|
|1 |PassengerID1|int|1 |Y | Mandatory [passenger id must be associated with corresponding item and occupancy, maximum number of passenger is 12] |
|1 |PassengerID2|int|1 | |
|1 |PassengerID3|int|1 | |
|1 |PassengerID4|int|1 | |
|1 |PassengerID5|int|1 | |
|1 |PassengerID6|int|1 | |
|1 |PassengerID7|int|1 | |
|1 |PassengerID8|int|1 | |
|1 |PassengerID9|int|1 | |
|1 |PassengerID10|int|1 | |
|1 |PassengerID11|int|1 | |
|1 |PassengerID12|int|1 | |
|1 |BelongsToPackage |int |1 |N | Optional [if ProductCode has Package Items it should be set to 1]|
|1 |PackageCode |string |1 |Y | This is mandatory for Package Items |
|1 |RateExpected |float |1 |N | Optional, for future usage |
username
password
387221
NYCETTEA
2012-10-22
Double
1
ENG
NCJFK
1900
AZ1234
1
NONE
993753
993754
1
NYCETTEA
0
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |AddItemResponse | |1 | |
|1 |ItemID|int |1 |Y |
|1 |ItemStatusCode |string |1 |Y |
916436
RQ
**Errors**
* Error - Login Invalid
* Error - Occupancy is not valid
* Error - Number of Nights must be 1 to 21
* Error - Quantity must be 1-12
* Error - Reservation not found
====✔ Book Escorted Tours using NewMultiItemReservation Method: ====
**Request XML**
username
password
agentcode
agentemail@somedomain.com
TA1234
NYCETTEA [**First NewItem should be start with PackageCode**]
2012-11-22
Double
1
ENG
NYCJFK
1800
AZ2314
1
TEST
Mr
TEST1
A
AD
32
Mr
TEST1
B
AD
30
0 [**Item itself is a PackageCode, BelongsToPackage must be set as 0**]
[**Item itself is a Package, PackageCode should be set as blank**]
[**Next each NewItem would be Package Item Code**]
NYCTEIB [**Package Item Code 1**]
2012-11-22
Double
1
ITA
NYCJFK
1900
AZ1234
1
NONE
Mr
TEST1
A
AD
32
Mr
TEST1
B
AD
30
1 [**this should be set as 1, since it is a package item**]
NYCETTEA [**it should be filled with PackageCode**]
NYCTEOB [**Package Item Code 2**]
2012-11-29
Double
1
GER
NYCJFK
1235
AA2034
1
TEST
Mr
TEST1
A
AD
32
Mr
TEST1
B
AD
30
1 [**this should be set as 1, since it is a package item**]
NYCETTEA [**it should be filled with PackageCode**]
**Response XML**
394247
TA1234
2012-11-08
OK
RW
6
*TEAMTEST
33 West 46th st 3rd floor
New York
NY
10036
ITALY
akter
926606
NYCETTEA
2013-04-15
NYCE Teampak East Tour
Double
1
AZ2314
1849.00
3698
2
CF
TEST
1
Tour is only in Italian.General conditions apply 8 days / 7 nights. Arrival Monday/Depart Wed from Marriott Marquis o Westin Grand Central at 08:30am Advise flt info for r/t trsfs included.
3698.00
926607
NYCTEIB
2013-04-15
NYCE ESCORTED TOURS ONLY TIB
Single
1
19:00:00
AZ1234
0.00
0
2
CF
NONE
0
1011900
TEST1
A
AD
32
1011901
TEST1
B
AD
30
FLIGHTS BETWEEN 10PM & 6AM MUST BE BOOKED AS PRIVATE TRFS. MIN. 2 PAX
0.00
926608
NYCTEOB
2013-04-22
NYCE ESCORTED TOUR ONLY TOB
Single
1
12:35:00
AA2034
0.00
0
2
CF
TEST
0
1011900
TEST1
A
AD
32
1011901
TEST1
B
AD
30
ANY PICK UP SCHEDULED BETWEEN 10:00PM & 4:00 AM MUST BE BOOKED AS PRIVATE TRFS. MIN. 2 PAX
0.00
1011900
TEST1
A
AD
32
1011901
TEST1
B
AD
30
3698
3698
0
3698
6.00
221.88
3476.12
0
221.88
**Errors**
* Error - Login Invalid
* Error - Occupancy is not valid
* Error - Invalid date
* Error - Number of Nights must be 1 to 21
* Error - Quantity must be 1-12
* Error - Language is not valid
* Error - Pick up location not found
* Error - Time must be 4 digits
* Error - Passenger type must be ADULT or CHILD
----
----
======3. RETRIEVE======
**RETRIEVE FUNCTIONS:** This functions allows to get information regarding any existing reservation.
* [[documentation:team3#RetrieveReservation|RetrieveReservation]]
* [[documentation:team3#RetrieveResByReference|RetrieveResByReference]]
* [[documentation:team3#RetrieveResByDate|RetrieveResByDate]]
* [[documentation:team3#RetrieveResByDateRange|RetrieveResByDateRange]]
* [[documentation:team3#RetrieveResByLastName|RetrieveResByLastName]]
* [[documentation:team3#CheckItemStatus|CheckItemStatus]]
* [[documentation:team3#GetItemBreakfast|GetItemBreakfast]]
----
=====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 |
UUU
PPP
123456
**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 | | | |
123456
0000000
2013-02-20
OK
RW
00
AGENCY NAME
CITY
COUNTRY
AGENTUSERNAME
0000
PRODUCTCODE
2013-03-07
ITEM DESCRIPTION
Single
3
0000
0000
1
0000
BK
0
0000
FAMILYNAME
FIRSTNAME
AD
30
0000
EP-NO MEALS
STANDARD
0000
FAMILYNAME
FIRSTNAME
AD
30
0000
0000
0000
00
000
000
-0
0
0000
0000
0
0
0000
**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 |
|1 |ShowCX |int |1 |Y | Show Ref, Max 14 |
username
Password
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 | |
286065
RICCI
RICCARDO
2013-03-01
OK
NYCSS
**Errors**
*Error - Login Invalid
*Error – Invalid length for Client Reference – Maximum of 14 allowed
**Description**
----
----
=====RetrieveResByLastName=====
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |RetrieveResByLastName | |1 | |
|1 |UserName |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |LastName |string |1 |Y |
|1 |NumToShow |int |1 |N |
|1 |ShowFrom |int |1 |N |
username
Password
TEST
3
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
**Errors**
*Error - Login Invalid
*Error - No Reservation found
**Description:**
----
----
=====CheckItemStatus=====
**XML request**
^Level^Name^Type^Occurs^Required^Comments^
|0 |CheckItemStatus | |1 | |
|1 |UserName |string |1 |Y|
|1 |Password |string |1 |Y|
|1 |ItemID |int |1 |Y |
username
Password
23
**XML response**
^Level^Name^Type^Occurs^Required^Comments^
|0 |CheckItemStatusResponse | |1 | |
|1 |ItemStatus |string |1 |Y |e.g RQ - requested
RQ
**Errors**
*Error - Login Invalid
*Error - Item Not Found
**Description:**
----
----
===== GetItemBreakfast =====
**Request XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |GetItemBreakfast | |1 | |
|1 |Username |string |1 |Y |
|1 |Password |string |1 |Y |
|1 |ItemID |int |1 |Y | Require **"ItemID"** from an existing Reservation. To generate a reservation use //**[[documentation:team3&#newmultiitemreservation|NewMultiItemReservation]]**// function first. |
username
Password
**Response XML**
^Level^Name^Type^Occurs^Required^Comments^
|0 |GetItemBreakfastResponse | |1 | |
|1 |ItemID |int |1 |Y |
|1 |BreakFastOptions |string |1 |N |
|1 |BreakFastPrice |float |1 |N |
|1 |BreakFastQuantity |int |1 |N |
123456
0
0
**Errors**
*Error - Login Invalid
*Error - Reservation was not found/you don't have access to edit the reservation
*Error - No Item found
**Description**
----
----
======4. CANCEL======
**CANCEL FUNCTIONS:** Cancel existing reservations and show Cancellation Policies.
* [[documentation:team3#cancellationpolicy|CancellationPolicy]] (Just Show Information)
* [[documentation:team3#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
BKLHHIEBK
2013-01-20
**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 |
3
Nights
1.00
**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 | |
xxx
xxx
423188
**XML response EXAMPLE 1** (when cancelling 7 days before, you pay 1 night cxl fee.)
OK
123456
NYCH WESTIN GRAND CENTRAL 1B NOT REFUNDA
CX
1202
2013-09-01
**Errors**
*Error - Login Invalid
*Error - Reservation not found
**Description:**
----
----