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

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 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.

✔ PriceSearch

Description: PriceSearch is a new function designed to optimize the response time. It works in tandem with ProductInfo, which handles everything that should be cached in the client side.

Together PriceSearch and 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 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 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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:PriceSearch soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
         <CityCode xsi:type="xsd:string">NYC</CityCode>
         <ProductCode xsi:type="xsd:string"></ProductCode>
         <Type xsi:type="xsd:string">Hotel</Type>
         <Occupancy xsi:type="xsd:string"></Occupancy>
         <ArrivalDate xsi:type="xsd:string">2013-02-20</ArrivalDate>
         <NumberOfNights xsi:type="xsd:int">2</NumberOfNights>
         <NumberOfRooms xsi:type="xsd:int">1</NumberOfRooms>
         <DisplayClosedOut xsi:type="xsd:string"></DisplayClosedOut>
         <DisplayOnRequest xsi:type="xsd:string"></DisplayOnRequest>
         <VendorIDs xsi:type="xsd1:DR_VendorIDs" xmlns:xsd1="http://www.wso2.org/php/xsd">
            <!--1 or more repetitions:-->
            <VendorID xsi:type="xsd:int"></VendorID>
         </VendorIDs>
      </php:PriceSearch>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:PriceSearchResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:ProductCode>BKLHALOFTD</ns2:ProductCode>
               <ns2:TeamVendorID>5174</ns2:TeamVendorID>
               <ns2:ProductDate>2013-02-20</ns2:ProductDate>
               <ns2:NightlyInfo>
                  <ns2:Dates>2013-02-20</ns2:Dates>
                  <ns2:Status>Available</ns2:Status>
                  <ns2:PromoMessage/>
                  <ns2:MinStay>0</ns2:MinStay>
                  <ns2:MaxStay>0</ns2:MaxStay>
                  <ns2:ArrivalRestriction>Allowed</ns2:ArrivalRestriction>
                  <ns2:Prices>
                     <ns2:Occupancy>Single</ns2:Occupancy>
                     <ns2:AdultPrice>166</ns2:AdultPrice>
                  </ns2:Prices>
               </ns2:NightlyInfo>
               <ns2:AverageRate>
                  <ns2:Occupancy>Single</ns2:Occupancy>
                  <ns2:AverageNightlyRate>166</ns2:AverageNightlyRate>
               </ns2:AverageRate>
            </ns2:body> 
                .  .  .  .
            </ns2:body>
         </return>
      </ns1:PriceSearchResponse>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:PriceSearchExtv2 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
         <CityCode xsi:type="xsd:string">NYC</CityCode>
         <ProductCode xsi:type="xsd:string"></ProductCode>
         <Type xsi:type="xsd:string">Hotel</Type>
         <Occupancy xsi:type="xsd:string"></Occupancy>
         <ArrivalDate xsi:type="xsd:string">2013-02-20</ArrivalDate>
         <NumberOfNights xsi:type="xsd:int">2</NumberOfNights>
         <NumberOfRooms xsi:type="xsd:int">1</NumberOfRooms>
         <DisplayClosedOut xsi:type="xsd:string"></DisplayClosedOut>
         <DisplayOnRequest xsi:type="xsd:string"></DisplayOnRequest>
         <VendorIDs xsi:type="xsd1:DR_VendorIDs" xmlns:xsd1="http://www.wso2.org/php/xsd">
            <!--1 or more repetitions:-->
            <VendorID xsi:type="xsd:int"></VendorID>
         </VendorIDs>
      </php:PriceSearch>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:PriceSearchResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:ProductCode>BKLHALOFTD</ns2:ProductCode>
               <ns2:ProductType>Hotel</ns2:ProductType>
               <ns2:TeamVendorID>5174</ns2:TeamVendorID>
               <ns2:ProductDate>2013-02-20</ns2:ProductDate>
               <ns2:MealPlan>CP-CONTINENTAL BREAKFAST</ns2:MealPlan>
               <ns2:RoomType>STANDARD</ns2:RoomType>
               <ns2:ChildAge>12</ns2:ChildAge>
               <ns2:FamilyPlan>Y</ns2:FamilyPlan>
               <ns2:NonRefundable>0</ns2:NonRefundable>
               <ns2:MaxOccupancy>4</ns2:MaxOccupancy>
               <ns2:NightlyInfo>
                  <ns2:Dates>2013-02-20</ns2:Dates>
                  <ns2:Status>Available</ns2:Status>
                  <ns2:PromoMessage/>
                  <ns2:MinStay>0</ns2:MinStay>
                  <ns2:MaxStay>0</ns2:MaxStay>
                  <ns2:ArrivalRestriction>Allowed</ns2:ArrivalRestriction>
                  <ns2:Prices>
                     <ns2:Occupancy>Single</ns2:Occupancy>
                     <ns2:AdultPrice>166</ns2:AdultPrice>
                  </ns2:Prices>
               </ns2:NightlyInfo>
               <ns2:AverageRate>
                  <ns2:Occupancy>Single</ns2:Occupancy>
                  <ns2:AverageNightlyRate>166</ns2:AverageNightlyRate>
               </ns2:AverageRate>
               <ns2:WebPriority>3</ns2:WebPriority>
            </ns2:body> 
                .  .  .  .
            </ns2:body>
         </return>
      </ns1:PriceSearchResponse>
   </soapenv:Body>
</soapenv:Envelope>

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 PriceSearch for dynamic updated Prices)

ProductInfo Replace the following functions: ListVendorFull, ProductDetails, ProductVendorInfo, PropertyImages.

This function should be used together with 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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:ProductInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">uuu</UserName>
         <Password xsi:type="xsd:string">pppp</Password>
         <ProductCode xsi:type="xsd:string">nychpcepr</ProductCode>
         <VendorName xsi:type="xsd:string"></VendorName>
      </php:ProductInfo>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:ProductInfoResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:ProductCode>NYCHPCEPR</ns2:ProductCode>
               <ns2:ProductType>Hotel</ns2:ProductType>
               <ns2:ProductName>NYCH PARK CENTRAL HOTEL  1 BED</ns2:ProductName>
               <ns2:VendorName>PARK CENTRAL HOTEL</ns2:VendorName>
               <ns2:TeamVendorID>131</ns2:TeamVendorID>
               <ns2:CityName>NYC-.New York, NY</ns2:CityName>
               <ns2:FamilyPlan>Y</ns2:FamilyPlan>
               <ns2:ChildAge>18</ns2:ChildAge>
               <ns2:MaximumOccupancy>2</ns2:MaximumOccupancy>
               <ns2:HotelRating>4</ns2:HotelRating>
               <ns2:Latitude>40.764696</ns2:Latitude>
               <ns2:Longitude>-73.981022</ns2:Longitude>
               <ns2:VendorImage>http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCHPCEPR</ns2:VendorImage>
               <ns2:VendorDescription>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.</ns2:VendorDescription>
               <ns2:VendorAddress1>870 7TH AVENUE /56TH ST</ns2:VendorAddress1>
               <ns2:VendorAddress2/>
               <ns2:VendorState>NY</ns2:VendorState>
               <ns2:VendorCity>NEW YORK</ns2:VendorCity>
               <ns2:Promotion/>
               <ns2:MealPlan>EP-NO MEALS</ns2:MealPlan>
               <ns2:RoomType>STANDARD ONE BED</ns2:RoomType>
               <ns2:NorthStarCode>135224</ns2:NorthStarCode>
               <ns2:PropertyImage>
                  <ns2:VendorID>131</ns2:VendorID>
                  <ns2:Caption>Cityhouse</ns2:Caption>
                  <ns2:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/711/189/cityhouse2_A.jpg</ns2:Thumbnail>
                  <ns2:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/711/189/cityhouse2_H.jpg</ns2:ActualSize>
               </ns2:PropertyImage>
               <ns2:PropertyImage>
                  <ns2:VendorID>131</ns2:VendorID>
                  <ns2:Caption>Lobby View</ns2:Caption>
                  <ns2:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/781/PROP1-20100430-020608-968_A.jpg</ns2:Thumbnail>
                  <ns2:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/781/PROP1-20100430-020608-968_H.jpg</ns2:ActualSize>
               </ns2:PropertyImage>
               <ns2:PropertyImage>
                  <ns2:VendorID>131</ns2:VendorID>
                  <ns2:Caption>Th Ave</ns2:Caption>
                  <ns2:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/710/655/7th_ave_A.jpg</ns2:Thumbnail>
                  <ns2:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/710/655/7th_ave_H.jpg</ns2:ActualSize>
               </ns2:PropertyImage>
               <ns2:PropertyImage>
                  <ns2:VendorID>131</ns2:VendorID>
                  <ns2:Caption>Park Central</ns2:Caption>
                  <ns2:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/20/106/554/1094424cdmssabrevfm_img_pho_000_nc__673709_Park_Central___A.jpg</ns2:Thumbnail>
                  <ns2:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/20/106/554/1094424cdmssabrevfm_img_pho_000_nc__673709_Park_Central___H.jpg</ns2:ActualSize>
               </ns2:PropertyImage>
               <ns2:PropertyImage>
                  <ns2:VendorID>131</ns2:VendorID>
                  <ns2:Caption>Bar/Lounge</ns2:Caption>
                  <ns2:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/785/PROP2-20100430-020608-462_A.jpg</ns2:Thumbnail>
                  <ns2:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/785/PROP2-20100430-020608-462_H.jpg</ns2:ActualSize>
               </ns2:PropertyImage>
               <ns2:PropertyImage>
                  <ns2:VendorID>131</ns2:VendorID>
                  <ns2:Caption>Bar/Lounge</ns2:Caption>
                  <ns2:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/794/PROP4-20100430-020608-884_A.jpg</ns2:Thumbnail>
                  <ns2:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/39/959/794/PROP4-20100430-020608-884_H.jpg</ns2:ActualSize>
               </ns2:PropertyImage>
               <ns2:ProductDetails>NO SHOWS 100% PENALTY WILL APPLY. NON-SMOKING HOTEL. HTL UNDER RENOVATIONS (GUEST ROOMS &amp; LOBBY). JAN-AUG 2013. F &amp; B SERVICES FALL 2013.</ns2:ProductDetails>
               <ns2:PermRoomCode>1</ns2:PermRoomCode>
               <ns2:ResortFee>0</ns2:ResortFee>
               <ns2:ResortFeeType/>
               <ns2:NonRefundable>0</ns2:NonRefundable>
               <ns2:VendorCountryISO>USA</ns2:VendorCountryISO>
               <ns2:VendorZip>10019</ns2:VendorZip>
            </ns2:body>
         </return>
      </ns1:ProductInfoResponse>
   </soapenv:Body>
</soapenv:Envelope>

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 ListCities to get City Codes from all available Cities

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:ListVendor soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">UUU</UserName>
         <Password xsi:type="xsd:string">PPP</Password>
         <CityCode xsi:type="xsd:string">NYC</CityCode>
      </php:ListVendor>
   </soapenv:Body>
</soapenv:Envelope>

Response XML

Level	Name	Type	Occurs	Required
1	VendorID	INT	1	Unique Hotel ID
1	VendorName	string	1	Y
1	City	int	1	Y

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:ListVendorResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:VendorID>5132</ns2:VendorID>
               <ns2:VendorName>60 THOMPSON HOTEL</ns2:VendorName>
               <ns2:City>NEW YORK</ns2:City>
            </ns2:body>
            <ns2:body>
               <ns2:VendorID>556</ns2:VendorID>
               <ns2:VendorName>70 PARK AVENUE A KIMPTON HOTEL</ns2:VendorName>
               <ns2:City>NEW YORK</ns2:City>
            </ns2:body>
            <ns2:body>
               <ns2:VendorID>158</ns2:VendorID>
               <ns2:VendorName>ACADEMY BUS</ns2:VendorName>
               <ns2:City>HOBOKEN</ns2:City>
            </ns2:body>
            <ns2:body>
               <ns2:VendorID>717</ns2:VendorID>
               <ns2:VendorName>ACCENT ON DINING</ns2:VendorName>
               <ns2:City>VERONA</ns2:City>
            </ns2:body>
            <ns2:body>
               <ns2:VendorID>3554</ns2:VendorID>
               <ns2:VendorName>AFFINIA FIFTY HOTEL</ns2:VendorName>
               <ns2:City>NEW YORK</ns2:City>
            </ns2:body>
            <ns2:body>
               <ns2:VendorID>3553</ns2:VendorID>
               <ns2:VendorName>AFFINIA GARDENS</ns2:VendorName>
               <ns2:City>NEW YORK</ns2:City>
            </ns2:body>
            <ns2:body>
               <ns2:VendorID>1314</ns2:VendorID>
               <ns2:VendorName>AFFINIA MANHATTAN</ns2:VendorName>
               <ns2:City>NEW YORK</ns2:City>
            </ns2:body>
            </return>
      </ns1:ListVendorResponse>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Error - Login Invalid
Error - Invalid City Code Length

✔ ServiceSearch2

XML request

Level	Name	Type	Occurs	Required
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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:ServiceSearch2 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
         <CityCode xsi:type="xsd:string">NYC</CityCode>
         <ServiceDate xsi:type="xsd:string">2013-01-01</ServiceDate>
         <ServiceType xsi:type="xsd:string">Hotel</ServiceType>
         <DisplayClosedOut xsi:type="xsd:string"></DisplayClosedOut>
         <DisplayOnRequest xsi:type="xsd:string"></DisplayOnRequest>
      </php:ServiceSearch2>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:EscortedToursSearch soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">password</Password>
         <ProductCode xsi:type="xsd:string"></ProductCode>
         <CityCode xsi:type="xsd:string">NYC</CityCode>
         <ArrivalDate xsi:type="xsd:string">2014-10-12</ArrivalDate>
         <Occupancy xsi:type="xsd:int">2</Occupancy>
      </php:EscortedToursSearch>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:EscortedToursSearchResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:ProductCode>NYCETDCA</ns2:ProductCode>
               <ns2:ProductType>EscortedTours</ns2:ProductType>
               <ns2:ProductName>NYCE TEAM TOUR MINI WASHINGTON</ns2:ProductName>
               <ns2:VendorID>1080</ns2:VendorID>
               <ns2:CityName>NYC-.New York, NY</ns2:CityName>
               <ns2:Status>AVAILABLE: 7+</ns2:Status>
               <ns2:ProductDate>2014-10-10</ns2:ProductDate>
               <ns2:Price>369</ns2:Price>
               <ns2:ChildPrice>229</ns2:ChildPrice>
               <ns2:ChildAge>18</ns2:ChildAge>
               <ns2:WebPriority>3</ns2:WebPriority>
               <ns2:NumPax>2</ns2:NumPax>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-08-08</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>369</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-08-15</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>369</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-08-22</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>369</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-08-29</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>369</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-09-05</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>369</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-09-12</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>369</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-09-26</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>369</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-10-10</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>369</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:Latitude>40.7566652</ns2:Latitude>
               <ns2:Longitude>-73.9803778</ns2:Longitude>
               <ns2:VendorImage>http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCETDCA</ns2:VendorImage>
               <ns2:VendorName>TEAMAMERICA ESCORTED TOURS</ns2:VendorName>
               <ns2:VendorDescription/>
               <ns2:VendorAddress1>33 WEST 46 STREET</ns2:VendorAddress1>
               <ns2:VendorAddress2/>
            </ns2:body>
            <ns2:body>
               <ns2:ProductCode>NYCETDCAMP</ns2:ProductCode>
               <ns2:ProductType>EscortedTours</ns2:ProductType>
               <ns2:ProductName>NYCE TEAMTOUR MINI WASHINGTON MULTIPLUS</ns2:ProductName>
               <ns2:VendorID>1080</ns2:VendorID>
               <ns2:CityName>NYC-.New York, NY</ns2:CityName>
               <ns2:Status>AVAILABLE: 7+</ns2:Status>
               <ns2:ProductDate>2014-10-10</ns2:ProductDate>
               <ns2:Price>849</ns2:Price>
               <ns2:ChildPrice>349</ns2:ChildPrice>
               <ns2:ChildAge>18</ns2:ChildAge>
               <ns2:WebPriority>3</ns2:WebPriority>
               <ns2:NumPax>2</ns2:NumPax>
               <ns2:PackageDetails>
                  <ns2:PullPriceFlag>0</ns2:PullPriceFlag>
                  <ns2:DisplayNightsFlag>0</ns2:DisplayNightsFlag>
                  <ns2:DefaultNights>1</ns2:DefaultNights>
                  <ns2:ProductCode>NYCTEIB</ns2:ProductCode>
                  <ns2:Description>NYCE  ESCORTED TOURS ONLY TIB</ns2:Description>
                  <ns2:PackageItemDate>2014-10-05</ns2:PackageItemDate>
               </ns2:PackageDetails>
               <ns2:PackageDetails>
                  <ns2:PullPriceFlag>0</ns2:PullPriceFlag>
                  <ns2:DisplayNightsFlag>0</ns2:DisplayNightsFlag>
                  <ns2:DefaultNights>2</ns2:DefaultNights>
                  <ns2:ProductCode>NYCEHMILFP</ns2:ProductCode>
                  <ns2:Description>NYCE ROW NYC PRE/POST NIGHTS</ns2:Description>
                  <ns2:PackageItemDate>2014-10-05</ns2:PackageItemDate>
               </ns2:PackageDetails>
               <ns2:PackageDetails>
                  <ns2:PullPriceFlag>0</ns2:PullPriceFlag>
                  <ns2:DisplayNightsFlag>0</ns2:DisplayNightsFlag>
                  <ns2:DefaultNights>1</ns2:DefaultNights>
                  <ns2:ProductCode>NYCSS</ns2:ProductCode>
                  <ns2:Description>NYCS CITY TOUR (REG) ITAL. OR SPANISH</ns2:Description>
                  <ns2:PackageItemDate>2014-10-06</ns2:PackageItemDate>
               </ns2:PackageDetails>
               <ns2:PackageDetails>
                  <ns2:PullPriceFlag>0</ns2:PullPriceFlag>
                  <ns2:DisplayNightsFlag>0</ns2:DisplayNightsFlag>
                  <ns2:DefaultNights>1</ns2:DefaultNights>
                  <ns2:ProductCode>NYCETDCA</ns2:ProductCode>
                  <ns2:Description>NYCE TEAM TOUR MINI WASHINGTON</ns2:Description>
                  <ns2:PackageItemDate>2014-10-07</ns2:PackageItemDate>
               </ns2:PackageDetails>
               <ns2:PackageDetails>
                  <ns2:PullPriceFlag>0</ns2:PullPriceFlag>
                  <ns2:DisplayNightsFlag>0</ns2:DisplayNightsFlag>
                  <ns2:DefaultNights>1</ns2:DefaultNights>
                  <ns2:ProductCode>NYCEHMILFP</ns2:ProductCode>
                  <ns2:Description>NYCE ROW NYC PRE/POST NIGHTS</ns2:Description>
                  <ns2:PackageItemDate>2014-10-09</ns2:PackageItemDate>
               </ns2:PackageDetails>
               <ns2:PackageDetails>
                  <ns2:PullPriceFlag>0</ns2:PullPriceFlag>
                  <ns2:DisplayNightsFlag>0</ns2:DisplayNightsFlag>
                  <ns2:DefaultNights>1</ns2:DefaultNights>
                  <ns2:ProductCode>NYCTEOB</ns2:ProductCode>
                  <ns2:Description>NYCE ESCORTED TOUR ONLY  TOB</ns2:Description>
                  <ns2:PackageItemDate>2014-10-10</ns2:PackageItemDate>
               </ns2:PackageDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-08-08</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>849</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-08-15</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>849</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-08-22</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>849</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-08-29</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>849</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-09-05</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>849</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-09-12</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>849</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-09-26</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>849</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:AvailabilityDetails>
                  <ns2:Date>2014-10-10</ns2:Date>
                  <ns2:Availability>AVAILABLE: 7+</ns2:Availability>
                  <ns2:Price>849</ns2:Price>
               </ns2:AvailabilityDetails>
               <ns2:Latitude>40.7566652</ns2:Latitude>
               <ns2:Longitude>-73.9803778</ns2:Longitude>
               <ns2:VendorImage>http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCETDCAMP</ns2:VendorImage>
               <ns2:VendorName>TEAMAMERICA ESCORTED TOURS</ns2:VendorName>
               <ns2:VendorDescription/>
               <ns2:VendorAddress1>33 WEST 46 STREET</ns2:VendorAddress1>
               <ns2:VendorAddress2/>
            </ns2:body>
         </return>
      </ns1:EscortedToursSearchResponse>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Error - Login Invalid
Error - Invalid length for City Code
Error - Invalid Date
Error - Invalid Occupancy

GetProductBreakfastOptions

Request XML

Level	Name	Type	Occurs	Required
0	GetProductBreakfastOptions		1
1	Username	string	1	Y
1	Password	string	1	Y
1	ProdCode	string	1	Y

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:GetProductBreakfastOptions soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
         <ProdCode xsi:type="xsd:string">BKLHBWPP</ProdCode>
      </php:GetProductBreakfastOptions>
   </soapenv:Body>
</soapenv:Envelope>

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
0	ListMealPlan		1
1	Username	string	1	Y
1	Password	string	1	Y

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:ListMealPlan soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
      </php:ListMealPlan>
   </soapenv:Body>
</soapenv:Envelope>

Response XML

Level	Name	Type	Occurs	Required
0	ListMealPlanResponse		1
1	MealPlanID	int	1	Y
1	MealPlan	string	1	Y
1	DeteUpdated	string	1	Y
1	Deleted	int	1	Y

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:ListMealPlanResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:MealPlanId>6</ns2:MealPlanId>
               <ns2:MealPlan>AI-ALL INCLUSIVE</ns2:MealPlan>
               <ns2:DateUpdated>2011-03-03 16:01:59</ns2:DateUpdated>
               <ns2:Deleted>0</ns2:Deleted>
            </ns2:body> 
              .  .  .  .
            </ns2:body>
         </return>
      </ns1:ListMealPlanResponse>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Error - Login Invalid

Description

ListRoomType

Request XML

Level	Name	Type	Occurs	Required
0	ListRoomType		1
1	Username	string	1	Y
1	Password	string	1	Y

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:ListRoomType soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
      </php:ListRoomType>
   </soapenv:Body>
</soapenv:Envelope>

Response XML

Level	Name	Type	Occurs	Required
0	ListRoomTypeResponse		1
1	RoomTypeID	int	1	Y
1	RoomType	string	1	Y
1	DateUpdated	string	1	Y
1	Deleted	int	1	Y

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:ListRoomTypeResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:RoomTypeId>74</ns2:RoomTypeId>
               <ns2:RoomType>1 BDRM RESORT VILLA</ns2:RoomType>
               <ns2:DateUpdated>2011-03-21 22:56:04</ns2:DateUpdated>
               <ns2:Deleted>1</ns2:Deleted>
            </ns2:body> 
               .
               .
            </ns2:body>
         </return>
      </ns1:ListRoomTypeResponse>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Error - Login Invalid

Description

ListCities

XML request

Level	Name	Type	Occurs	Required
0	ListCities		1
1	UserName	string	1	Y
1	Password	string	1	Y

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:ListCities soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">UserName</UserName>
         <Password xsi:type="xsd:string">Password</Password>
      </php:ListCities>
   </soapenv:Body>
</soapenv:Envelope>

XML response

Level	Name	Type	Occurs	Required
0	ListCitiesResponse		1
1	CityCode	string	1	Y
1	CityName	string	1	Y
1	Country	string	1	Y
1	DisplayGroup	string	1	N

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:ListCitiesResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:CityCode>YBA</ns2:CityCode>
               <ns2:CityName>*Banff, AB,CANADA</ns2:CityName>
               <ns2:Country>Canada</ns2:Country>
               <ns2:DisplayGroup/>
            </ns2:body>
               .
               . 
            <ns2:body>
               <ns2:CityCode>ZIO</ns2:CityCode>
               <ns2:CityName>ZIO-Zion, UT</ns2:CityName>
               <ns2:Country>USA</ns2:Country>
               <ns2:DisplayGroup>Zion Area</ns2:DisplayGroup>
            </ns2:body>
         </return>
      </ns1:ListCitiesResponse>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Error - Login Invalid

Description: Retrieve List of cities

ListPickUpLocations

XML request

Level	Name	Type	Occurs	Required
0	ListPickUpLocation		1
1	UserName	string	1	Y
1	Password	string	1	Y

XML response

Level	Name	Type	Occurs	Required
0	ListPickUpLocationResponse		1
1	PickUpLocation	string	1	Y
1	PickUpLocationDescription	string	1	Y

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:ListPickUpLocationsResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:PickUpLocation>NYCG</ns2:PickUpLocation>
               <ns2:PickUpLocationDescription>.NYC G E N E R I C   HOTEL</ns2:PickUpLocationDescription>
            </ns2:body>                .
               .
            </ns2:body>
         </return>
      </ns1:ListPickUpLocationsResponse>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Error - Login Invalid
Error - Invalid length for City Code - Maximum of 4 allowed

Description:

ListProduct

XML request

Level	Name	Type	Occurs	Required
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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:ListProducts soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
         <CityCode xsi:type="xsd:string">NYC</CityCode>
         <Type xsi:type="xsd:string"></Type>
         <Date xsi:type="xsd:string"></Date>
         <VendorName xsi:type="xsd:string"></VendorName>
      </php:ListProducts>
   </soapenv:Body>
</soapenv:Envelope>

XML response

Level	Name	Type	Occurs	Required
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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:ListProductsResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:ProductCode>BKLHALOFTD</ns2:ProductCode>
               <ns2:ProductType>Hotel</ns2:ProductType>
               <ns2:ProductName>BKLH ALOFT NEW YORK BROOKLYN - DBL DBL</ns2:ProductName>
               <ns2:TeamVendorID>5174</ns2:TeamVendorID>
               <ns2:CityName>NYC-Brooklyn, NY</ns2:CityName>
               <ns2:ChildAge>17</ns2:ChildAge>
               <ns2:HotelAddress1>218 DUFFIELD STREET</ns2:HotelAddress1>
               <ns2:HotelAddress2/>
               <ns2:HotelCity>BROOKLYN</ns2:HotelCity>
               <ns2:HotelState>NY</ns2:HotelState>
               <ns2:HotelZip>11201</ns2:HotelZip>
               <ns2:HotelPhone>718 256 3833</ns2:HotelPhone>
               <ns2:MealPlan>EP-NO MEALS</ns2:MealPlan>
               <ns2:RoomType>STANDARD</ns2:RoomType>
            </ns2:body>
                       .
                       .
            </ns2:body>
         </return>
      </ns1:ListProductsResponse>
   </soapenv:Body>
</soapenv:Envelope>

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
0	GeoDistance		1
1	Latitude	string	1
1	Longitude	string	1
1	ProductCode	string	1
1	Units	string	1	N

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:GeoDistance soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Latitude xsi:type="xsd:string"></Latitude>
         <Longitude xsi:type="xsd:string"></Longitude>
         <ProductCode xsi:type="xsd:string">BKLHMARRBB</ProductCode>
         <Units xsi:type="xsd:string"></Units>
      </php:GeoDistance>
   </soapenv:Body>
</soapenv:Envelope>

XML response

Level	Name	Type	Occurs	Required	Comments
0	GeoDistanceResponse		1
1	Distance	string	1

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:GeoDistanceResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:Distance>5380.5665</ns2:Distance>
         </return>
      </ns1:GeoDistanceResponse>
   </soapenv:Body>
</soapenv:Envelope>

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.

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 <FamilyPlan> = Y, and the pax children age is lower than <ChildAge> 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 <ChildAge> value, then the child will be considered as adult and you will have to put Triple in the occupancy

If <FamilyPlan> = 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 <NewItem> 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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:NewMultiItemReservation soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">password</Password>
         <AgentName xsi:type="xsd:string"></AgentName>
         <AgentEmail xsi:type="xsd:string"></AgentEmail>
         <ClientReference xsi:type="xsd:string"></ClientReference>
         <Items xsi:type="xsd1:DR_NewItems" xmlns:xsd1="http://www.wso2.org/php/xsd">
            <!--1 or more repetitions:-->
            <NewItem xsi:type="xsd1:DR_NewItemDetails">
               <ProductCode xsi:type="xsd:string"></ProductCode>
               <ProductDate xsi:type="xsd:string"></ProductDate>
               <Occupancy xsi:type="xsd:string"></Occupancy>
               <NumberOfNights xsi:type="xsd:int"></NumberOfNights>
               <Language xsi:type="xsd:string"></Language>
               <PickUpLocation xsi:type="xsd:string"></PickUpLocation>
               <PickUpTime xsi:type="xsd:string"></PickUpTime>
               <FlightInfo xsi:type="xsd:string"></FlightInfo>
               <Quantity xsi:type="xsd:int"></Quantity>
               <ItemRemarks xsi:type="xsd:string"></ItemRemarks>
               <Passengers xsi:type="xsd1:DR_NewItemPassengers">
                  <!--1 or more repetitions:-->
                  <NewPassenger xsi:type="xsd1:DR_NewItemPassengerDetails">
                     <Salutation xsi:type="xsd:string"></Salutation>
                     <FamilyName xsi:type="xsd:string"></FamilyName>
                     <FirstName xsi:type="xsd:string"></FirstName>
                     <PassengerType xsi:type="xsd:string"></PassengerType>
                     <PassengerAge xsi:type="xsd:int"></PassengerAge>
                  </NewPassenger>
               </Passengers>
               <BelongsToPackage xsi:type="xsd:int"></BelongsToPackage>
               <PackageCode xsi:type="xsd:string"></PackageCode>
               <RateExpected xsi:type="xsd:float"></RateExpected>
            </NewItem>
         </Items>
      </php:NewMultiItemReservation>
   </soapenv:Body>
</soapenv:Envelope>

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
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
1	ProductCode	string	1	Y
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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:AddItem soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">password</Password>
         <ReservationNumber xsi:type="xsd:int">387221</ReservationNumber>
         <ProductCode xsi:type="xsd:string">NYCETTEA</ProductCode>
         <ProductDate xsi:type="xsd:string">2012-10-22</ProductDate>
         <Occupancy xsi:type="xsd:string">Double</Occupancy>
         <NumberOfNights xsi:type="xsd:int">1</NumberOfNights>
         <Language xsi:type="xsd:string">ENG</Language>
         <PickUpLocation xsi:type="xsd:string">NCJFK</PickUpLocation>
         <PickUpTime xsi:type="xsd:string">1900</PickUpTime>
         <FlightInfo xsi:type="xsd:string">AZ1234</FlightInfo>
         <Quantity xsi:type="xsd:int">1</Quantity>
         <ItemRemarks xsi:type="xsd:string">NONE</ItemRemarks>
         <PassengerID1 xsi:type="xsd:int">993753</PassengerID1>
         <PassengerID2 xsi:type="xsd:int">993754</PassengerID2>
         <PassengerID3 xsi:type="xsd:int"></PassengerID3>
         <PassengerID4 xsi:type="xsd:int"></PassengerID4>
         <PassengerID5 xsi:type="xsd:int"></PassengerID5>
         <PassengerID6 xsi:type="xsd:int"></PassengerID6>
         <PassengerID7 xsi:type="xsd:int"></PassengerID7>
         <PassengerID8 xsi:type="xsd:int"></PassengerID8>
         <PassengerID9 xsi:type="xsd:int"></PassengerID9>
         <PassengerID10 xsi:type="xsd:int"></PassengerID10>
         <PassengerID11 xsi:type="xsd:int"></PassengerID11>
         <PassengerID12 xsi:type="xsd:int"></PassengerID12>
         <BelongsToPackage xsi:type="xsd:int">1</BelongsToPackage>
         <PackageCode xsi:type="xsd:string">NYCETTEA</PackageCode>
         <RateExpected xsi:type="xsd:float">0</RateExpected>
      </php:AddItem>
   </soapenv:Body>
</soapenv:Envelope>

Response XML

Level	Name	Type	Occurs	Required
0	AddItemResponse		1
1	ItemID	int	1	Y
1	ItemStatusCode	string	1	Y

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:AddItemResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:ItemID>916436</ns2:ItemID>
            <ns2:ItemStatusCode>RQ</ns2:ItemStatusCode>
         </return>
      </ns1:AddItemResponse>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:NewMultiItemReservation soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">password</Password>
         <AgentName xsi:type="xsd:string">agentcode</AgentName>
         <AgentEmail xsi:type="xsd:string">agentemail@somedomain.com</AgentEmail>
         <ClientReference xsi:type="xsd:string">TA1234</ClientReference>
         <Items xsi:type="xsd1:DR_NewItems" xmlns:xsd1="http://www.wso2.org/php/xsd">
            <!--1 or more repetitions:-->
            <NewItem xsi:type="xsd1:DR_NewItemDetails">
               <ProductCode xsi:type="xsd:string">NYCETTEA</ProductCode> [**First NewItem should be start with PackageCode**]
               <ProductDate xsi:type="xsd:string">2012-11-22</ProductDate>
               <Occupancy xsi:type="xsd:string">Double</Occupancy>
               <NumberOfNights xsi:type="xsd:int">1</NumberOfNights>
               <Language xsi:type="xsd:string">ENG</Language>
               <PickUpLocation xsi:type="xsd:string">NYCJFK</PickUpLocation>
               <PickUpTime xsi:type="xsd:string">1800</PickUpTime>
               <FlightInfo xsi:type="xsd:string">AZ2314</FlightInfo>
               <Quantity xsi:type="xsd:int">1</Quantity>
               <ItemRemarks xsi:type="xsd:string">TEST</ItemRemarks>
               <Passengers xsi:type="xsd1:DR_NewItemPassengers">
                  <!--1 or more repetitions:-->
                  <NewPassenger xsi:type="xsd1:DR_NewItemPassengerDetails">
                     <Salutation xsi:type="xsd:string">Mr</Salutation>
                     <FamilyName xsi:type="xsd:string">TEST1</FamilyName>
                     <FirstName xsi:type="xsd:string">A</FirstName>
                     <PassengerType xsi:type="xsd:string">AD</PassengerType>
                     <PassengerAge xsi:type="xsd:int">32</PassengerAge>
                  </NewPassenger>
                  <NewPassenger xsi:type="xsd1:DR_NewItemPassengerDetails">
                     <Salutation xsi:type="xsd:string">Mr</Salutation>
                     <FamilyName xsi:type="xsd:string">TEST1</FamilyName>
                     <FirstName xsi:type="xsd:string">B</FirstName>
                     <PassengerType xsi:type="xsd:string">AD</PassengerType>
                     <PassengerAge xsi:type="xsd:int">30</PassengerAge>
                  </NewPassenger>
               </Passengers>
               <BelongsToPackage xsi:type="xsd:int">0</BelongsToPackage> [**Item itself is a PackageCode, BelongsToPackage must be set as 0**]
               <PackageCode xsi:type="xsd:string"></PackageCode> [**Item itself is a Package, PackageCode should be set as blank**]
               <RateExpected xsi:type="xsd:float"></RateExpected>
            </NewItem>
            <NewItem xsi:type="xsd1:DR_NewItemDetails"> [**Next each NewItem would be Package Item Code**]
               <ProductCode xsi:type="xsd:string">NYCTEIB</ProductCode> [**Package Item Code 1**]
               <ProductDate xsi:type="xsd:string">2012-11-22</ProductDate>
               <Occupancy xsi:type="xsd:string">Double</Occupancy>
               <NumberOfNights xsi:type="xsd:int">1</NumberOfNights>
               <Language xsi:type="xsd:string">ITA</Language>
               <PickUpLocation xsi:type="xsd:string">NYCJFK</PickUpLocation>
               <PickUpTime xsi:type="xsd:string">1900</PickUpTime>
               <FlightInfo xsi:type="xsd:string">AZ1234</FlightInfo>
               <Quantity xsi:type="xsd:int">1</Quantity>
               <ItemRemarks xsi:type="xsd:string">NONE</ItemRemarks>
               <Passengers xsi:type="xsd1:DR_NewItemPassengers">
                  <!--1 or more repetitions:-->
                  <NewPassenger xsi:type="xsd1:DR_NewItemPassengerDetails">
                     <Salutation xsi:type="xsd:string">Mr</Salutation>
                     <FamilyName xsi:type="xsd:string">TEST1</FamilyName>
                     <FirstName xsi:type="xsd:string">A</FirstName>
                     <PassengerType xsi:type="xsd:string">AD</PassengerType>
                     <PassengerAge xsi:type="xsd:int">32</PassengerAge>
                  </NewPassenger>
                  <NewPassenger xsi:type="xsd1:DR_NewItemPassengerDetails">
                     <Salutation xsi:type="xsd:string">Mr</Salutation>
                     <FamilyName xsi:type="xsd:string">TEST1</FamilyName>
                     <FirstName xsi:type="xsd:string">B</FirstName>
                     <PassengerType xsi:type="xsd:string">AD</PassengerType>
                     <PassengerAge xsi:type="xsd:int">30</PassengerAge>
                  </NewPassenger>
               </Passengers>
               <BelongsToPackage xsi:type="xsd:int">1</BelongsToPackage> [**this should be set as 1, since it is a package item**]
               <PackageCode xsi:type="xsd:string">NYCETTEA</PackageCode> [**it should be filled with PackageCode**]
               <RateExpected xsi:type="xsd:float"></RateExpected>
            </NewItem>
            <NewItem xsi:type="xsd1:DR_NewItemDetails">
               <ProductCode xsi:type="xsd:string">NYCTEOB</ProductCode> [**Package Item Code 2**]
               <ProductDate xsi:type="xsd:string">2012-11-29</ProductDate>
               <Occupancy xsi:type="xsd:string">Double</Occupancy>
               <NumberOfNights xsi:type="xsd:int">1</NumberOfNights>
               <Language xsi:type="xsd:string">GER</Language>
               <PickUpLocation xsi:type="xsd:string">NYCJFK</PickUpLocation>
               <PickUpTime xsi:type="xsd:string">1235</PickUpTime>
               <FlightInfo xsi:type="xsd:string">AA2034</FlightInfo>
               <Quantity xsi:type="xsd:int">1</Quantity>
               <ItemRemarks xsi:type="xsd:string">TEST</ItemRemarks>
               <Passengers xsi:type="xsd1:DR_NewItemPassengers">
                  <!--1 or more repetitions:-->
                  <NewPassenger xsi:type="xsd1:DR_NewItemPassengerDetails">
                     <Salutation xsi:type="xsd:string">Mr</Salutation>
                     <FamilyName xsi:type="xsd:string">TEST1</FamilyName>
                     <FirstName xsi:type="xsd:string">A</FirstName>
                     <PassengerType xsi:type="xsd:string">AD</PassengerType>
                     <PassengerAge xsi:type="xsd:int">32</PassengerAge>
                  </NewPassenger>
                  <NewPassenger xsi:type="xsd1:DR_NewItemPassengerDetails">
                     <Salutation xsi:type="xsd:string">Mr</Salutation>
                     <FamilyName xsi:type="xsd:string">TEST1</FamilyName>
                     <FirstName xsi:type="xsd:string">B</FirstName>
                     <PassengerType xsi:type="xsd:string">AD</PassengerType>
                     <PassengerAge xsi:type="xsd:int">30</PassengerAge>
                  </NewPassenger>
               </Passengers>
               <BelongsToPackage xsi:type="xsd:int">1</BelongsToPackage> [**this should be set as 1, since it is a package item**]
               <PackageCode xsi:type="xsd:string">NYCETTEA</PackageCode> [**it should be filled with PackageCode**]
               <RateExpected xsi:type="xsd:float"></RateExpected>
            </NewItem>
         </Items>
      </php:NewMultiItemReservation>
   </soapenv:Body>
</soapenv:Envelope>

Response XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:NewMultiItemReservationResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:ReservationInformation>
               <ns2:ReservationNumber>394247</ns2:ReservationNumber>
               <ns2:BookingAgentReferenceNumber>TA1234</ns2:BookingAgentReferenceNumber>
               <ns2:DateBooked>2012-11-08</ns2:DateBooked>
               <ns2:ReservationStatus>OK</ns2:ReservationStatus>
               <ns2:FaxStatus>RW</ns2:FaxStatus>
               <ns2:AgencyCommissionAmount>6</ns2:AgencyCommissionAmount>
               <ns2:BookingAgentInfo>
                  <ns2:AgencyName>*TEAMTEST</ns2:AgencyName>
                  <ns2:Address1>33 West 46th st 3rd floor</ns2:Address1>
                  <ns2:Address2/>
                  <ns2:City>New York</ns2:City>
                  <ns2:State>NY</ns2:State>
                  <ns2:PostalCode>10036</ns2:PostalCode>
                  <ns2:Country>ITALY</ns2:Country>
                  <ns2:AgentUserName>akter</ns2:AgentUserName>
                  <ns2:AgentEmail/>
               </ns2:BookingAgentInfo>
               <ns2:Items>
                  <ns2:UniqueItemID>926606</ns2:UniqueItemID>
                  <ns2:ProductCode>NYCETTEA</ns2:ProductCode>
                  <ns2:ItemDate>2013-04-15</ns2:ItemDate>
                  <ns2:Description>NYCE Teampak East Tour</ns2:Description>
                  <ns2:Occupancy>Double</ns2:Occupancy>
                  <ns2:NumberOfNights>1</ns2:NumberOfNights>
                  <ns2:Language/>
                  <ns2:PickUpLocation/>
                  <ns2:PickUpTime/>
                  <ns2:FlightInfo>AZ2314</ns2:FlightInfo>
                  <ns2:AverageNetPricePerNight>1849.00</ns2:AverageNetPricePerNight>
                  <ns2:TotalItemNetPrice>3698</ns2:TotalItemNetPrice>
                  <ns2:Quantity>2</ns2:Quantity>
                  <ns2:ItemStatusCode>CF</ns2:ItemStatusCode>
                  <ns2:ItemStatusDescription/>
                  <ns2:ItemRemarks>TEST</ns2:ItemRemarks>
                  <ns2:ItemInformation/>
                  <ns2:ItemCommissionable>1</ns2:ItemCommissionable>
                  <ns2:ItemComments>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.</ns2:ItemComments>
                  <ns2:SubTotal>3698.00</ns2:SubTotal>
               </ns2:Items>
               <ns2:Items>
                  <ns2:UniqueItemID>926607</ns2:UniqueItemID>
                  <ns2:ProductCode>NYCTEIB</ns2:ProductCode>
                  <ns2:ItemDate>2013-04-15</ns2:ItemDate>
                  <ns2:Description>NYCE  ESCORTED TOURS ONLY TIB</ns2:Description>
                  <ns2:Occupancy>Single</ns2:Occupancy>
                  <ns2:NumberOfNights>1</ns2:NumberOfNights>
                  <ns2:Language/>
                  <ns2:PickUpLocation/>
                  <ns2:PickUpTime>19:00:00</ns2:PickUpTime>
                  <ns2:FlightInfo>AZ1234</ns2:FlightInfo>
                  <ns2:AverageNetPricePerNight>0.00</ns2:AverageNetPricePerNight>
                  <ns2:TotalItemNetPrice>0</ns2:TotalItemNetPrice>
                  <ns2:Quantity>2</ns2:Quantity>
                  <ns2:ItemStatusCode>CF</ns2:ItemStatusCode>
                  <ns2:ItemStatusDescription/>
                  <ns2:ItemRemarks>NONE</ns2:ItemRemarks>
                  <ns2:ItemInformation/>
                  <ns2:ItemCommissionable>0</ns2:ItemCommissionable>
                  <ns2:ItemPassengers>
                     <ns2:UniquePassengerID>1011900</ns2:UniquePassengerID>
                     <ns2:FamilyName>TEST1</ns2:FamilyName>
                     <ns2:FirstName>A</ns2:FirstName>
                     <ns2:Type>AD</ns2:Type>
                     <ns2:Age>32</ns2:Age>
                  </ns2:ItemPassengers>
                  <ns2:ItemPassengers>
                     <ns2:UniquePassengerID>1011901</ns2:UniquePassengerID>
                     <ns2:FamilyName>TEST1</ns2:FamilyName>
                     <ns2:FirstName>B</ns2:FirstName>
                     <ns2:Type>AD</ns2:Type>
                     <ns2:Age>30</ns2:Age>
                  </ns2:ItemPassengers>
                  <ns2:ItemComments>FLIGHTS BETWEEN 10PM &amp; 6AM MUST BE BOOKED AS PRIVATE TRFS. MIN. 2 PAX</ns2:ItemComments>
                  <ns2:SubTotal>0.00</ns2:SubTotal>
               </ns2:Items>
               <ns2:Items>
                  <ns2:UniqueItemID>926608</ns2:UniqueItemID>
                  <ns2:ProductCode>NYCTEOB</ns2:ProductCode>
                  <ns2:ItemDate>2013-04-22</ns2:ItemDate>
                  <ns2:Description>NYCE ESCORTED TOUR ONLY  TOB</ns2:Description>
                  <ns2:Occupancy>Single</ns2:Occupancy>
                  <ns2:NumberOfNights>1</ns2:NumberOfNights>
                  <ns2:Language/>
                  <ns2:PickUpLocation/>
                  <ns2:PickUpTime>12:35:00</ns2:PickUpTime>
                  <ns2:FlightInfo>AA2034</ns2:FlightInfo>
                  <ns2:AverageNetPricePerNight>0.00</ns2:AverageNetPricePerNight>
                  <ns2:TotalItemNetPrice>0</ns2:TotalItemNetPrice>
                  <ns2:Quantity>2</ns2:Quantity>
                  <ns2:ItemStatusCode>CF</ns2:ItemStatusCode>
                  <ns2:ItemStatusDescription/>
                  <ns2:ItemRemarks>TEST</ns2:ItemRemarks>
                  <ns2:ItemInformation/>
                  <ns2:ItemCommissionable>0</ns2:ItemCommissionable>
                  <ns2:ItemPassengers>
                     <ns2:UniquePassengerID>1011900</ns2:UniquePassengerID>
                     <ns2:FamilyName>TEST1</ns2:FamilyName>
                     <ns2:FirstName>A</ns2:FirstName>
                     <ns2:Type>AD</ns2:Type>
                     <ns2:Age>32</ns2:Age>
                  </ns2:ItemPassengers>
                  <ns2:ItemPassengers>
                     <ns2:UniquePassengerID>1011901</ns2:UniquePassengerID>
                     <ns2:FamilyName>TEST1</ns2:FamilyName>
                     <ns2:FirstName>B</ns2:FirstName>
                     <ns2:Type>AD</ns2:Type>
                     <ns2:Age>30</ns2:Age>
                  </ns2:ItemPassengers>
                  <ns2:ItemComments>ANY PICK UP SCHEDULED BETWEEN 10:00PM &amp; 4:00 AM MUST BE BOOKED AS PRIVATE TRFS. MIN. 2 PAX</ns2:ItemComments>
                  <ns2:SubTotal>0.00</ns2:SubTotal>
               </ns2:Items>
               <ns2:Passengers>
                  <ns2:UniquePassengerID>1011900</ns2:UniquePassengerID>
                  <ns2:FamilyName>TEST1</ns2:FamilyName>
                  <ns2:FirstName>A</ns2:FirstName>
                  <ns2:Type>AD</ns2:Type>
                  <ns2:Age>32</ns2:Age>
               </ns2:Passengers>
               <ns2:Passengers>
                  <ns2:UniquePassengerID>1011901</ns2:UniquePassengerID>
                  <ns2:FamilyName>TEST1</ns2:FamilyName>
                  <ns2:FirstName>B</ns2:FirstName>
                  <ns2:Type>AD</ns2:Type>
                  <ns2:Age>30</ns2:Age>
               </ns2:Passengers>
               <ns2:TotalResNetPrice>3698</ns2:TotalResNetPrice>
               <ns2:gross_total>3698</ns2:gross_total>
               <ns2:paid>0</ns2:paid>
               <ns2:gross_due>3698</ns2:gross_due>
               <ns2:ag_comm_level>6.00</ns2:ag_comm_level>
               <ns2:ag_comm_amt>221.88</ns2:ag_comm_amt>
               <ns2:net_due>3476.12</ns2:net_due>
               <ns2:cc_fees>0</ns2:cc_fees>
               <ns2:amt_comm_amt>221.88</ns2:amt_comm_amt>
            </ns2:ReservationInformation>
         </return>
      </ns1:NewMultiItemReservationResponse>
   </soapenv:Body>
</soapenv:Envelope>

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.

RetrieveReservation

Request XML

Level	Name	Type	Occurs	Required
0	RetrieveReservation		1
1	Username	string	1	Y
1	Password	string	1	Y
1	ReservationNumber	INT	1	Y

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:RetrieveReservation soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">UUU</UserName>
         <Password xsi:type="xsd:string">PPP</Password>
         <ReservationNumber xsi:type="xsd:int">123456</ReservationNumber>
      </php:RetrieveReservation>
   </soapenv:Body>
</soapenv:Envelope>

Response XML

Level	Name	Type
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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:RetrieveReservationResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:ReservationInformation>
               <ns2:ReservationNumber>123456</ns2:ReservationNumber>
               <ns2:BookingAgentReferenceNumber>0000000</ns2:BookingAgentReferenceNumber>
               <ns2:DateBooked>2013-02-20</ns2:DateBooked>
               <ns2:ReservationStatus>OK</ns2:ReservationStatus>
               <ns2:FaxStatus>RW</ns2:FaxStatus>
               <ns2:ReservationStatusDescription/>
               <ns2:GeneralComments/>
               <ns2:AgencyCommissionAmount>00</ns2:AgencyCommissionAmount>
               <ns2:BookingAgentInfo>
                  <ns2:AgencyName>AGENCY NAME</ns2:AgencyName>
                  <ns2:Address1/>
                  <ns2:Address2/>
                  <ns2:City>CITY</ns2:City>
                  <ns2:State/>
                  <ns2:PostalCode/>
                  <ns2:Country>COUNTRY</ns2:Country>
                  <ns2:AgentUserName>AGENTUSERNAME</ns2:AgentUserName>
                  <ns2:AgentEmail/>
               </ns2:BookingAgentInfo>
               <ns2:Items>
                  <ns2:UniqueItemID>0000</ns2:UniqueItemID>
                  <ns2:ProductCode>PRODUCTCODE</ns2:ProductCode>
                  <ns2:ItemDate>2013-03-07</ns2:ItemDate>
                  <ns2:Description>ITEM DESCRIPTION</ns2:Description>
                  <ns2:Occupancy>Single</ns2:Occupancy>
                  <ns2:NumberOfNights>3</ns2:NumberOfNights>
                  <ns2:Language/>
                  <ns2:PickUpLocation/>
                  <ns2:PickUpTime/>
                  <ns2:FlightInfo/>
                  <ns2:AverageNetPricePerNight>0000</ns2:AverageNetPricePerNight>
                  <ns2:TotalItemNetPrice>0000</ns2:TotalItemNetPrice>
                  <ns2:Quantity>1</ns2:Quantity>
                  <ns2:ItemSupplierConfirmationNumber>0000</ns2:ItemSupplierConfirmationNumber>
                  <ns2:ItemStatusCode>BK</ns2:ItemStatusCode>
                  <ns2:ItemStatusDescription/>
                  <ns2:ItemRemarks/>
                  <ns2:ItemInformation/>
                  <ns2:ItemCommissionable>0</ns2:ItemCommissionable>
                  <ns2:ItemPassengers>
                     <ns2:UniquePassengerID>0000</ns2:UniquePassengerID>
                     <ns2:FamilyName>FAMILYNAME</ns2:FamilyName>
                     <ns2:FirstName>FIRSTNAME</ns2:FirstName>
                     <ns2:Type>AD</ns2:Type>
                     <ns2:Age>30</ns2:Age>
                  </ns2:ItemPassengers>
                  <ns2:ItemComments></ns2:ItemComments>
                  <ns2:SubTotal>0000</ns2:SubTotal>
                  <ns2:MealPlan>EP-NO MEALS</ns2:MealPlan>
                  <ns2:RoomType>STANDARD</ns2:RoomType>
               </ns2:Items>
               <ns2:Passengers>
                  <ns2:UniquePassengerID>0000</ns2:UniquePassengerID>
                  <ns2:FamilyName>FAMILYNAME</ns2:FamilyName>
                  <ns2:FirstName>FIRSTNAME</ns2:FirstName>
                  <ns2:Type>AD</ns2:Type>
                  <ns2:Age>30</ns2:Age>
               </ns2:Passengers>
               <ns2:TotalResNetPrice>0000</ns2:TotalResNetPrice>
               <ns2:gross_total>0000</ns2:gross_total>
               <ns2:paid>0000</ns2:paid>
               <ns2:gross_due>00</ns2:gross_due>
               <ns2:ag_comm_level>000</ns2:ag_comm_level>
               <ns2:ag_comm_amt>000</ns2:ag_comm_amt>
               <ns2:net_due>-0</ns2:net_due>
               <ns2:cc_fees>0</ns2:cc_fees>
               <ns2:ttl_expenses>0000</ns2:ttl_expenses>
               <ns2:ttl_expenses_paid>0000</ns2:ttl_expenses_paid>
               <ns2:commission_amt>0</ns2:commission_amt>
               <ns2:commission_rcvd>0</ns2:commission_rcvd>
               <ns2:amt_comm_amt>0000</ns2:amt_comm_amt>
            </ns2:ReservationInformation>
         </return>
      </ns1:RetrieveReservationResponse>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:RetrieveResByReference soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
         <Reference xsi:type="xsd:string"></Reference>
         <ShowCX xsi:type="xsd:int">1</ShowCX>
      </php:RetrieveResByReference>
   </soapenv:Body>
</soapenv:Envelope>

Response XML

Level	Name	Type	Occurs	Required
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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:RetrieveResByReferenceResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:ReservationInformation>
               <ns2:ReservationNumber>286065</ns2:ReservationNumber>
               <ns2:LastName>RICCI</ns2:LastName>
               <ns2:FirstName>RICCARDO</ns2:FirstName>
               <ns2:DepDate>2013-03-01</ns2:DepDate>
               <ns2:ReservationStatus>OK</ns2:ReservationStatus>
               <ns2:Product>NYCSS</ns2:Product>
            </ns2:ReservationInformation>
         </return>
      </ns1:RetrieveResByReferenceResponse>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Error - Login Invalid
Error – Invalid length for Client Reference – Maximum of 14 allowed

Description

RetrieveResByLastName

XML request

Level	Name	Type	Occurs	Required
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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:RetrieveResByLastName soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
         <LastName xsi:type="xsd:string">TEST</LastName>
         <NumToShow xsi:type="xsd:int">3</NumToShow>
         <ShowFrom xsi:type="xsd:int"></ShowFrom>
      </php:RetrieveResByLastName>
   </soapenv:Body>
</soapenv:Envelope>

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
0	CheckItemStatus		1
1	UserName	string	1	Y
1	Password	string	1	Y
1	ItemID	int	1	Y

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:CheckItemStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
         <ItemID xsi:type="xsd:int">23</ItemID>
      </php:CheckItemStatus>
   </soapenv:Body>
</soapenv:Envelope>

XML response

Level	Name	Type	Occurs	Required	Comments
0	CheckItemStatusResponse		1
1	ItemStatus	string	1	Y

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:CheckItemStatusResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:ItemStatus>RQ</ns2:ItemStatus>
         </return>
      </ns1:CheckItemStatusResponse>
   </soapenv:Body>
</soapenv:Envelope>

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 NewMultiItemReservation function first.

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:GetItemBreakfast soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
         <ItemID xsi:type="xsd:int"></ItemID>
      </php:GetItemBreakfast>
   </soapenv:Body>
</soapenv:Envelope>

Response XML

Level	Name	Type	Occurs	Required
0	GetItemBreakfastResponse		1
1	ItemID	int	1	Y
1	BreakFastOptions	string	1	N
1	BreakFastPrice	float	1	N
1	BreakFastQuantity	int	1	N

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:GetItemBreakfastResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:ItemID>123456</ns2:ItemID>
            <ns2:BreakfastOption/>
            <ns2:BreakfastPrice>0</ns2:BreakfastPrice>
            <ns2:BreakfastQuantity>0</ns2:BreakfastQuantity>
         </return>
      </ns1:GetItemBreakfastResponse>
   </soapenv:Body>
</soapenv:Envelope>

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.

CancellationPolicy (Just Show Information)
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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:CancellationPolicy soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string">username</UserName>
         <Password xsi:type="xsd:string">Password</Password>
         <ProductCode xsi:type="xsd:string">BKLHHIEBK</ProductCode>
         <ArrivalDate xsi:type="xsd:string">2013-01-20</ArrivalDate>
      </php:CancellationPolicy>
   </soapenv:Body>
</soapenv:Envelope>

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

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:CancellationPolicyResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:body>
               <ns2:NumberDaysPrior>3</ns2:NumberDaysPrior>
               <ns2:PenaltyType>Nights</ns2:PenaltyType>
               <ns2:PenaltyAmount>1.00</ns2:PenaltyAmount>
            </ns2:body>
         </return>
      </ns1:CancellationPolicyResponse>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Error - Login Invalid
Error - Invalid date

CancelReservation

XML request

Level	Name	Type	Occurs	Required
0	CancelReservation		1
1	Username	string	1	Y
1	Password	string	1	Y
1	ReservationNumber	int	1	Y

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
   <soapenv:Header/>
   <soapenv:Body>
      <php:CancelReservation soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <UserName xsi:type="xsd:string"> xxx</UserName>
         <Password xsi:type="xsd:string"> xxx</Password>
         <ReservationNumber xsi:type="xsd:int">423188</ReservationNumber>
      </php:CancelReservation>
   </soapenv:Body>
</soapenv:Envelope>

XML response EXAMPLE 1 (when cancelling 7 days before, you pay 1 night cxl fee.)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <ns1:CancelReservationResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
         <return>
            <ns2:ReservationStatusCode>OK</ns2:ReservationStatusCode>
            <ns2:Items>
               <ns2:ItemId>123456</ns2:ItemId>
               <ns2:Description>NYCH WESTIN GRAND CENTRAL 1B NOT REFUNDA</ns2:Description>
               <ns2:Status>CX</ns2:Status>
               <ns2:PenaltyAmount>1202</ns2:PenaltyAmount>
               <ns2:ItemDate>2013-09-01</ns2:ItemDate>
            </ns2:Items>
         </return>
      </ns1:CancelReservationResponse>
   </soapenv:Body>
</soapenv:Envelope>

Errors

Error - Login Invalid
Error - Reservation not found

Description:

Table of Contents

TEAM AMERICA XML 3.0

1.SEARCH

✔ PriceSearch

✔ PriceSearchExtv2

✔ ProductInfo

✔ List Vendor

✔ ServiceSearch2

✔ Escorted Tours Search

XML Request:

XML Response:

GetProductBreakfastOptions

ListMealPlan

ListRoomType

ListCities

ListPickUpLocations

ListProduct

GeoDistance

2. BOOK

✔ NewMultiItemReservation

✔ Book Escorted Tours using AddItem Method:

✔ Book Escorted Tours using NewMultiItemReservation Method:

3. RETRIEVE

RetrieveReservation

RetrieveResByReference

RetrieveResByLastName

CheckItemStatus

GetItemBreakfast

4. CANCEL

CancellationPolicy

CancelReservation