Table of Contents
TEAM AMERICA XML 3.0 J
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:
it@teamamericany.com
TLS Secured Development Doclit WSDL https://javatest.teamamericany.com:8443/TADoclit/services/TADoclit?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 version price search .
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
Our PriceSearch functions are built to return prices as quickly as possible, but may lack important information and restrictions which is visible in a ProductInfoV2 request.
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 | Accepts only 1 Occupancy type per request. 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 23. |
| 1 | NumberOfRooms | int | 1 | Y | 1 to max 3 rooms |
| 1 | NationalityCode | string | 1 | N | 2 Character ISO standard Country Code |
| 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:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:PriceSearch>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:CityCode>NYC</xsd:CityCode>
<xsd:ProductCode></xsd:ProductCode>
<xsd:Type>Hotel</xsd:Type>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:ArrivalDate>2017-12-12</xsd:ArrivalDate>
<xsd:NumberOfNights>2</xsd:NumberOfNights>
<xsd:NumberOfRooms>1</xsd:NumberOfRooms>
<xsd:NationalityCode>US</xsd:NationalityCode>
<xsd:DisplayClosedOut>N</xsd:DisplayClosedOut>
<xsd:DisplayOnRequest>N</xsd:DisplayOnRequest>
<!--1 or more repetitions:-->
<xsd:VendorIDs>
<!--1 or more repetitions:-->
<xsd:VendorID></xsd:VendorID>
</xsd:VendorIDs>
</xsd: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, use this value for RateExpected when booking |
| 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`
Doclit Request XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:PriceSearch>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:CityCode>NYC</xsd:CityCode>
<xsd:ProductCode></xsd:ProductCode>
<xsd:Type>Hotel</xsd:Type>
<xsd:Occupancy>Double</xsd:Occupancy>
<xsd:ArrivalDate>2017-10-31</xsd:ArrivalDate>
<xsd:NumberOfNights>2</xsd:NumberOfNights>
<xsd:NumberOfRooms>1</xsd:NumberOfRooms>
<xsd:DisplayClosedOut>N</xsd:DisplayClosedOut>
<xsd:DisplayOnRequest>N</xsd:DisplayOnRequest>
<!--1 or more repetitions:-->
<xsd:VendorIDs>
<!--1 or more repetitions:-->
<xsd:VendorID></xsd:VendorID>
</xsd:VendorIDs>
</xsd:PriceSearch>
</soapenv:Body>
</soapenv:Envelope>
* Doclit response *
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:PriceSearchResponse xmlns:ns1="http://www.wso2.org/php/xsd">
<ns1:hotelSearchResponse>
<ns1:body>
<ns1:ProductCode>NYCHROY</ns1:ProductCode>
<ns1:ProductType>Hotel</ns1:ProductType>
<ns1:TeamVendorID>107</ns1:TeamVendorID>
<ns1:ProductDate>2014-10-31</ns1:ProductDate>
<ns1:MealPlan>EP-NO MEALS</ns1:MealPlan>
<ns1:RoomType>STANDARD</ns1:RoomType>
<ns1:ChildAge>17</ns1:ChildAge>
<ns1:FamilyPlan>Y</ns1:FamilyPlan>
<ns1:NonRefundable>0</ns1:NonRefundable>
<ns1:MaxOccupancy>2</ns1:MaxOccupancy>
<ns1:NightlyInfo>
<ns1:Dates>2014-10-31</ns1:Dates>
<ns1:Status>Available</ns1:Status>
<ns1:PromoMessage/>
<ns1:MinStay>0</ns1:MinStay>
<ns1:MaxStay>0</ns1:MaxStay>
<ns1:ArrivalRestriction>Allowed</ns1:ArrivalRestriction>
<ns1:Prices>
<ns1:Occupancy>Double</ns1:Occupancy>
<ns1:AdultPrice>423</ns1:AdultPrice>
</ns1:Prices>
</ns1:NightlyInfo>
<ns1:NightlyInfo>
<ns1:Dates>2014-11-01</ns1:Dates>
<ns1:Status>Available</ns1:Status>
<ns1:PromoMessage/>
<ns1:MinStay>0</ns1:MinStay>
<ns1:MaxStay>0</ns1:MaxStay>
<ns1:ArrivalRestriction>Allowed</ns1:ArrivalRestriction>
<ns1:Prices>
<ns1:Occupancy>Double</ns1:Occupancy>
<ns1:AdultPrice>423</ns1:AdultPrice>
</ns1:Prices>
</ns1:NightlyInfo>
<ns1:AverageRate>
<ns1:Occupancy>Double</ns1:Occupancy>
<ns1:AverageNightlyRate>423</ns1:AverageNightlyRate>
</ns1:AverageRate>
<ns1:WebPriority>3</ns1:WebPriority>
</ns1:body>
</ns1:hotelSearchResponse>
</ns1:PriceSearchResponse>
</soapenv:Body>
</soapenv:Envelope>
✔ ProductInfoV2
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)
ProductInfoV2 Replace the following functions: ListVendorFull, ProductDetails, ProductVendorInfo, PropertyImages.
This function should be used together with PriceSearch
It is your responsibility to call ProductInfoV2 before booking a product! TeamAmerica reserves the right to NOT amend bookings without your copy of this function's response.
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 |
| 1 | VendorID | INT | 1 | Y | Mandatory if ProductCode is blank, Vendor (hotel) name or part of it. If you do not have a Vendor ID , use 0 as a value |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:ProductInfov2>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:ProductCode>NYCHPCEPR</xsd:ProductCode>
<xsd:VendorName></xsd:VendorName>
<xsd:VendorID>0</xsd:VendorID>
</xsd:ProductInfov2>
</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 | 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: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 & LOBBY). JAN-AUG 2013. F & 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
Doclit Request XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:ProductInfov2>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<!--Optional:-->
<xsd:ProductCode></xsd:ProductCode>
<!--Optional:-->
<xsd:VendorName></xsd:VendorName>
<!--Optional:-->
<xsd:VendorID>131</xsd:VendorID>
</xsd:ProductInfov2>
</soapenv:Body>
</soapenv:Envelope>
Doclit Response XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:ProductInfov2Response xmlns:ns1="http://www.wso2.org/php/xsd">
<ns1:response>
<ns1:body>
<ns1:ProductCode>NYCHROY</ns1:ProductCode>
<ns1:ProductType>Hotel</ns1:ProductType>
<ns1:ProductName>NYCH ROYALTON -STANDARD ROOM</ns1:ProductName>
<ns1:VendorName>ROYALTON HOTEL</ns1:VendorName>
<ns1:TeamVendorID>107</ns1:TeamVendorID>
<ns1:CityName>NYC-.New York, NY</ns1:CityName>
<ns1:FamilyPlan>Y</ns1:FamilyPlan>
<ns1:ChildAge>17</ns1:ChildAge>
<ns1:MaximumOccupancy>2</ns1:MaximumOccupancy>
<ns1:HotelRating>4</ns1:HotelRating>
<ns1:Latitude>40.754892</ns1:Latitude>
<ns1:Longitude>-73.980521</ns1:Longitude>
<ns1:VendorImage>http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCHROY</ns1:VendorImage>
<ns1:VendorDescription>Sleek, Midtown trendsetter hotel. Fifth Avenue is just a half-block away, Broadway 2 blocks, and Grand Central 4 blocks from this hip, centrally located, 16-story hotel.The 205 trim rooms have all-white fabrics, wood accents, built-in shelves and window seats, VCRs, and stereo cassette decks. Guests enjoy 24-hour concierge service, room service, a fitness room, and a trendy bar and restaurant.</ns1:VendorDescription>
<ns1:VendorAddress1>44 WEST 44 STREET</ns1:VendorAddress1>
<ns1:VendorAddress2/>
<ns1:VendorState>NY</ns1:VendorState>
<ns1:VendorCity>NEW YORK</ns1:VendorCity>
<ns1:WebPriority>3</ns1:WebPriority>
<ns1:MealPlan>EP-NO MEALS</ns1:MealPlan>
<ns1:RoomType>STANDARD</ns1:RoomType>
<ns1:NorthStarCode>C02082</ns1:NorthStarCode>
<ns1:PropertyImage>
<ns1:VendorID>107</ns1:VendorID>
<ns1:Caption>44</ns1:Caption>
<ns1:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/440/ROY.44A_A.jpg</ns1:Thumbnail>
<ns1:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/440/ROY.44A_H.jpg</ns1:ActualSize>
</ns1:PropertyImage>
<ns1:PropertyImage>
<ns1:VendorID>107</ns1:VendorID>
<ns1:Caption>PENTHOUSE</ns1:Caption>
<ns1:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/360/215/ROY.PENTHOUSE_A.jpg</ns1:Thumbnail>
<ns1:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/360/215/ROY.PENTHOUSE_H.jpg</ns1:ActualSize>
</ns1:PropertyImage>
<ns1:PropertyImage>
<ns1:VendorID>107</ns1:VendorID>
<ns1:Caption>Interior</ns1:Caption>
<ns1:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/360/59/ROY.LOBBY5_A.jpg</ns1:Thumbnail>
<ns1:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/360/59/ROY.LOBBY5_H.jpg</ns1:ActualSize>
</ns1:PropertyImage>
<ns1:PropertyImage>
<ns1:VendorID>107</ns1:VendorID>
<ns1:Caption>Bathroom</ns1:Caption>
<ns1:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/827/ROY.BATHROOM_A.jpg</ns1:Thumbnail>
<ns1:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/827/ROY.BATHROOM_H.jpg</ns1:ActualSize>
</ns1:PropertyImage>
<ns1:PropertyImage>
<ns1:VendorID>107</ns1:VendorID>
<ns1:Caption>Guest Room</ns1:Caption>
<ns1:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/811/ROY.GUESTROOM1_A.jpg</ns1:Thumbnail>
<ns1:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/811/ROY.GUESTROOM1_H.jpg</ns1:ActualSize>
</ns1:PropertyImage>
<ns1:PropertyImage>
<ns1:VendorID>107</ns1:VendorID>
<ns1:Caption>Guest Room</ns1:Caption>
<ns1:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/795/ROY.GUESTROOM_A.jpg</ns1:Thumbnail>
<ns1:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/795/ROY.GUESTROOM_H.jpg</ns1:ActualSize>
</ns1:PropertyImage>
<ns1:PropertyImage>
<ns1:VendorID>107</ns1:VendorID>
<ns1:Caption>Interior</ns1:Caption>
<ns1:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/723/ROY.LOBBY3_A.jpg</ns1:Thumbnail>
<ns1:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/723/ROY.LOBBY3_H.jpg</ns1:ActualSize>
</ns1:PropertyImage>
<ns1:PropertyImage>
<ns1:VendorID>107</ns1:VendorID>
<ns1:Caption>Bar/Lounge</ns1:Caption>
<ns1:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/492/ROY.BAR44.1_A.jpg</ns1:Thumbnail>
<ns1:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/492/ROY.BAR44.1_H.jpg</ns1:ActualSize>
</ns1:PropertyImage>
<ns1:PropertyImage>
<ns1:VendorID>107</ns1:VendorID>
<ns1:Caption>FACADE</ns1:Caption>
<ns1:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/464/ROY.FACADE_A.jpg</ns1:Thumbnail>
<ns1:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/4/0/55/359/464/ROY.FACADE_H.jpg</ns1:ActualSize>
</ns1:PropertyImage>
<ns1:ProductDetails>STANDARD ROOM. ROOMS HAVE 1 BED. EARLY DEPARTURE FEE $50.00.</ns1:ProductDetails>
<ns1:ResortFee>0</ns1:ResortFee>
<ns1:ResortFeeType/>
<ns1:NonRefundable>0</ns1:NonRefundable>
<ns1:VendorCountryISO>USA</ns1:VendorCountryISO>
<ns1:VendorZip>10036</ns1:VendorZip>
</ns1:body>
</ns1:response>
</ns1:ProductInfov2Response>
</soapenv:Body>
</soapenv:Envelope>
✔ ServiceSearch
Description: Search for services for a particular date. Services are Sightseeing, Restaurant , Transfer, Tranfer /Tours .
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ServiceSearch | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | CityCode | string | 1 | Y | Use City Codes from ListCities |
| 1 | ServiceDate | string | 1 | Y | |
| 1 | ServiceType | string | 1 | Y | S = Sightseeing / Tour, R = Restaurant, T = Transfer, P = Packages |
| 1 | DisplayClodeOut | string | 1 | Y | |
| 1 | DisplayOnRequest | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:ServiceSearch>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:CityCode>NYC</xsd:CityCode>
<xsd:ServiceDate>2017-10-17</xsd:ServiceDate>
<xsd:ServiceType>T</xsd:ServiceType>
<xsd:DisplayClosedOut>Y</xsd:DisplayClosedOut>
<xsd:DisplayOnRequest>Y</xsd:DisplayOnRequest>
</xsd:ServiceSearch>
</soapenv:Body>
</soapenv:Envelope>
XML response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:ServiceSearchResponse xmlns:ns1="http://www.wso2.org/php/xsd">
<ns1:serviceSearchResponse>
<ns1:body>
<ns1:ProductCode>NYCRBHD</ns1:ProductCode>
<ns1:ProductType>Service</ns1:ProductType>
<ns1:TransferType>NOT SET</ns1:TransferType>
<ns1:ProductName>NYCR BENIHANA STEAK&CHICKEN DINNER</ns1:ProductName>
<ns1:CityName>NYC-.New York, NY</ns1:CityName>
<ns1:ProductDate>2015-07-15</ns1:ProductDate>
<ns1:ChildAge>0</ns1:ChildAge>
<ns1:AdultPrice>44</ns1:AdultPrice>
<ns1:ChildPrice>25</ns1:ChildPrice>
<ns1:Status>Available</ns1:Status>
</ns1:body>
<ns1:body>
<ns1:ProductCode>NYCRPLA</ns1:ProductCode>
<ns1:ProductType>Service</ns1:ProductType>
<ns1:TransferType>NOT SET</ns1:TransferType>
<ns1:ProductName>NYCR PLANET HOLLYWOOD-LUNCH OR DINNER-</ns1:ProductName>
<ns1:CityName>NYC-.New York, NY</ns1:CityName>
<ns1:ProductDate>2015-07-15</ns1:ProductDate>
<ns1:ChildAge>0</ns1:ChildAge>
<ns1:AdultPrice>29</ns1:AdultPrice>
<ns1:ChildPrice>29</ns1:ChildPrice>
<ns1:Status>Available</ns1:Status>
</ns1:body>
<ns1:body>
<ns1:ProductCode>NYCRVIE</ns1:ProductCode>
<ns1:ProductType>Service</ns1:ProductType>
<ns1:TransferType>NOT SET</ns1:TransferType>
<ns1:ProductName>NYCR THE VIEW RESTAURANT DINNER</ns1:ProductName>
<ns1:CityName>NYC-.New York, NY</ns1:CityName>
<ns1:ProductDate>2015-07-15</ns1:ProductDate>
<ns1:ChildAge>0</ns1:ChildAge>
<ns1:AdultPrice>93</ns1:AdultPrice>
<ns1:ChildPrice>12</ns1:ChildPrice>
<ns1:Status>OnRequest</ns1:Status>
</ns1:body>
...
</ns1:serviceSearchResponse>
</ns1:ServiceSearchResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Invalid length for City Code - Use LiStCities City Code
- Error - Invalid date
✔ 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. 2018-10-15) |
| 1 | Occupancy | int | 1 | Y | Only integer applicable, for Single ⇒ 1, Double ⇒ 2, Triple ⇒ 3, Quad ⇒ 4 |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:EscortedToursSearch>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:ProductCode></xsd:ProductCode>
<xsd:CityCode>NYC</xsd:CityCode>
<xsd:ArrivalDate>2018-10-15</xsd:ArrivalDate>
<xsd:Occupancy>3</xsd:Occupancy>
</xsd: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>
<xsd:EscortedToursSearchResponse xmlns:xsd="http://www.wso2.org/php/xsd">
<xsd:escortedToursSearchResponse>
<xsd:body>
<xsd:ProductCode>NYCETMPLUS</xsd:ProductCode>
<xsd:ProductType>EscortedTours</xsd:ProductType>
<xsd:ProductName>NYCE MULTIPLUS PACKAGE - Riu Plaza Times Square</xsd:ProductName>
<xsd:VendorID>1080</xsd:VendorID>
<xsd:CityName>NYC-.New York, NY</xsd:CityName>
<xsd:Status>ON REQUEST</xsd:Status>
<xsd:ProductDate>2018-10-15</xsd:ProductDate>
<xsd:Price>309.0</xsd:Price>
<xsd:ChildPrice>129.0</xsd:ChildPrice>
<xsd:ChildAge>12</xsd:ChildAge>
<xsd:WebPriority>1</xsd:WebPriority>
<xsd:NumPax>3</xsd:NumPax>
<xsd:PackageDetails>
<xsd:PullPriceFlag>0</xsd:PullPriceFlag>
<xsd:DisplayNightsFlag>0</xsd:DisplayNightsFlag>
<xsd:DefaultNights>1</xsd:DefaultNights>
<xsd:ProductCode>NYCTEIB</xsd:ProductCode>
<xsd:Description>NYCE ESCORTED TOURS ONLY TIB</xsd:Description>
<xsd:PackageItemDate>2018-10-15</xsd:PackageItemDate>
</xsd:PackageDetails>
<xsd:PackageDetails>
<xsd:PullPriceFlag>0</xsd:PullPriceFlag>
<xsd:DisplayNightsFlag>0</xsd:DisplayNightsFlag>
<xsd:DefaultNights>2</xsd:DefaultNights>
<xsd:ProductCode>NYCEHRIU</xsd:ProductCode>
<xsd:Description>NYCE RIU PLAZA TIMES SQUARE PRE NIGHTS ONLY</xsd:Description>
<xsd:PackageItemDate>2018-10-15</xsd:PackageItemDate>
</xsd:PackageDetails>
<xsd:PackageDetails>
<xsd:PullPriceFlag>0</xsd:PullPriceFlag>
<xsd:DisplayNightsFlag>0</xsd:DisplayNightsFlag>
<xsd:DefaultNights>1</xsd:DefaultNights>
<xsd:ProductCode>NYCSS</xsd:ProductCode>
<xsd:Description>NYCS CITY TOUR (REG) ITAL. OR SPANISH</xsd:Description>
<xsd:PackageItemDate>2018-10-16</xsd:PackageItemDate>
</xsd:PackageDetails>
<xsd:PackageDetails>
<xsd:PullPriceFlag>0</xsd:PullPriceFlag>
<xsd:DisplayNightsFlag>0</xsd:DisplayNightsFlag>
<xsd:DefaultNights>1</xsd:DefaultNights>
<xsd:ProductCode>NYCTEOB</xsd:ProductCode>
<xsd:Description>NYCE ESCORTED TOUR ONLY TOB</xsd:Description>
<xsd:PackageItemDate>2018-10-22</xsd:PackageItemDate>
</xsd:PackageDetails>
<xsd:AvailabilityDetails>
<xsd:Date>2018-09-03</xsd:Date>
<xsd:Availability>AVAILABLE: 3</xsd:Availability>
<xsd:Price>309.0</xsd:Price>
</xsd:AvailabilityDetails>
<xsd:AvailabilityDetails>
<xsd:Date>2018-09-10</xsd:Date>
<xsd:Availability>AVAILABLE: 1</xsd:Availability>
<xsd:Price>309.0</xsd:Price>
</xsd:AvailabilityDetails>
<xsd:AvailabilityDetails>
<xsd:Date>2018-09-17</xsd:Date>
<xsd:Availability>ON REQUEST</xsd:Availability>
<xsd:Price>309.0</xsd:Price>
</xsd:AvailabilityDetails>
<xsd:AvailabilityDetails>
<xsd:Date>2018-09-24</xsd:Date>
<xsd:Availability>AVAILABLE: 3</xsd:Availability>
<xsd:Price>309.0</xsd:Price>
</xsd:AvailabilityDetails>
<xsd:AvailabilityDetails>
<xsd:Date>2018-10-01</xsd:Date>
<xsd:Availability>ON REQUEST</xsd:Availability>
<xsd:Price>309.0</xsd:Price>
</xsd:AvailabilityDetails>
<xsd:AvailabilityDetails>
<xsd:Date>2018-10-08</xsd:Date>
<xsd:Availability>ON REQUEST</xsd:Availability>
<xsd:Price>309.0</xsd:Price>
</xsd:AvailabilityDetails>
<xsd:AvailabilityDetails>
<xsd:Date>2018-10-15</xsd:Date>
<xsd:Availability>ON REQUEST</xsd:Availability>
<xsd:Price>309.0</xsd:Price>
</xsd:AvailabilityDetails>
<xsd:Latitude>40.7566652</xsd:Latitude>
<xsd:Longitude>-73.9803778</xsd:Longitude>
<xsd:VendorImage>http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCETMPLUS</xsd:VendorImage>
<xsd:VendorName>TEAMAMERICA ET</xsd:VendorName>
<xsd:VendorDescription/>
<xsd:VendorAddress1>33 WEST 46 STREET</xsd:VendorAddress1>
<xsd:VendorAddress2/>
</xsd:body>
</xsd:escortedToursSearchResponse>
</xsd:EscortedToursSearchResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Invalid City Code Length
- Error - Invalid date
- Invalid Occupancy - must be between 1-4
✔ ListMealPlan
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListMealPlan | 1 | |||
| 1 | Username | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
XML Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:ListMealPlan>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
</xsd:ListMealPlan>
</soapenv:Body>
</soapenv:Envelope>
XML Response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListMealPlanResponse | 1 | |||
| 1 | MealPlanID | string | 1 | Y | |
| 1 | MealPlan | string | 1 | Y | |
| 1 | DateUpdated | string | 1 | Y | |
| 1 | Deleted | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<xsd:ListMealPlanResponse xmlns:xsd="http://www.wso2.org/php/xsd">
<xsd:mealPlanResponse>
<xsd:body>
<xsd:MealPlanId>16</xsd:MealPlanId>
<xsd:MealPlan>A LA CARTE BREAKFAST</xsd:MealPlan>
<xsd:DateUpdated>2012-09-18 16:29:00</xsd:DateUpdated>
<xsd:Deleted>0</xsd:Deleted>
</xsd:body>
<xsd:body>
<xsd:MealPlanId>9</xsd:MealPlanId>
<xsd:MealPlan>ABB-FULL AMERICAN BUFFET BREAKFAST</xsd:MealPlan>
<xsd:DateUpdated>2012-07-25 13:05:15</xsd:DateUpdated>
<xsd:Deleted>0</xsd:Deleted>
</xsd:body>
....
</xsd:mealPlanResponse>
</xsd:ListMealPlanResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
✔ ListRoomType
Request XML
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListRoomType | 1 | |||
| 1 | Username | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:ListRoomType>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
</xsd:ListRoomType>
</soapenv:Body>
</soapenv:Envelope>
Response XML
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListRoomTypeResponse | 1 | |||
| 1 | RoomTypeID | int | 1 | Y | |
| 1 | RoomType | string | 1 | Y | |
| 1 | DateUpdated | string | 1 | Y | |
| 1 | Deleted | int | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<xsd:ListRoomTypeResponse xmlns:xsd="http://www.wso2.org/php/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<xsd:roomTypeResponse>
<xsd:body>
<xsd:RoomTypeId>1</xsd:RoomTypeId>
<xsd:RoomType>STANDARD</xsd:RoomType>
<xsd:DateUpdated>2011-03-15 14:42:59.0</xsd:DateUpdated>
<xsd:Deleted>0</xsd:Deleted>
</xsd:body>
<xsd:body>
<xsd:RoomTypeId>2</xsd:RoomTypeId>
<xsd:RoomType>SUPERIOR</xsd:RoomType>
<xsd:DateUpdated>2011-03-15 14:43:00.0</xsd:DateUpdated>
<xsd:Deleted>0</xsd:Deleted>
</xsd:body>
.
.
</xsd:roomTypeResponse>
</xsd:ListRoomTypeResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description This function list all the room types for all the products.
✔ ListCities
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListCities | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:ListCities>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
</xsd:ListCities>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListCitiesResponse | 1 | |||
| 1 | CityCode | string | 1 | Y | |
| 1 | CityName | string | 1 | Y | |
| 1 | Country | string | 1 | Y | |
| 1 | DisplayGroup | string | 1 | N |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<xsd:ListCitiesResponse xmlns:xsd="http://www.wso2.org/php/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<xsd:cityResp>
<xsd:body>
<xsd:CityCode>ABB</xsd:CityCode>
<xsd:CityName>*Abbotsford, BC, CANADA</xsd:CityName>
<xsd:Country>CANADA</xsd:Country>
<xsd:DisplayGroup xsi:nil="true"/>
</xsd:body>
.
.
<xsd:body>
<xsd:CityCode>ZXR</xsd:CityCode>
<xsd:CityName>Carmel Valley</xsd:CityName>
<xsd:Country>USA</xsd:Country>
<xsd:DisplayGroup xsi:nil="true"/>
</xsd:body>
</xsd:cityResp>
</xsd:ListCitiesResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description:
Retrieve List of cities. the list includes City code , country and Display Group
✔ ListPickUpLocations
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListPickUpLocation | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 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: List pick locations in a city.
✔ ListVendor
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 |
| 1 | Type | string | 1 | Y | Use 'Service' or 'Hotel' as parameters |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:ListVendor>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:CityCode>NYC</xsd:CityCode>
<xsd:Type>Service</xsd:Type>
</xsd:ListVendor>
</soapenv:Body>
</soapenv:Envelope>
Response XML
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 1 | VendorID | INT | 1 | Unique Hotel ID | |
| 1 | VendorName | string | 1 | Y | |
| 1 | City | int | 1 | Y | |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<xsd:ListVendorResponse xmlns:xsd="http://www.wso2.org/php/xsd">
<xsd:vendorResponse>
<xsd:body>
<xsd:VendorID>158</xsd:VendorID>
<xsd:VendorName>ACADEMY BUS</xsd:VendorName>
<xsd:City>HOBOKEN</xsd:City>
</xsd:body
.
.
.
<xsd:body>
<xsd:VendorID>1</xsd:VendorID>
<xsd:VendorName>VOLATOUR-NEW YORK</xsd:VendorName>
<xsd:City>NEW YORK</xsd:City>
</xsd:body>
</xsd:vendorResponse>
</xsd:ListVendorResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Invalid City Code Length
- Error - Invalid Type
✔ BookingReport
Request XML
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | BookingReport | 1 | |||
| 1 | Username | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | FromDate | string | 1 | Y | ISO YYYY-MM-DD |
| 1 | ToDate | string | 1 | Y | ISO YYYY-MM-DD |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:BookingReport>
<xsd:UserName></xsd:UserName>
<xsd:Password></xsd:Password>
<xsd:FromDate>2016-12-12</xsd:FromDate>
<xsd:ToDate>2017-12-13</xsd:ToDate>
</xsd:BookingReport>
</soapenv:Body>
</soapenv:Envelope>
Response XML
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | BookingReportResponse | 1 | |||
| 1 | FromDate | string | 1 | Y | ISO YYYY-MM-DD |
| 1 | ToDate | string | 1 | Y | ISO YYYY-MM-DD |
| 1 | AgentDetails | string | 1 | Y | |
| 2 | AgCode | string | 1 | Y | |
| 2 | AgentName | string | 1 | Y | |
| 2 | Address1 | string | 1 | Y | |
| 2 | Address2 | string | 1 | Y | |
| 2 | City | string | 1 | Y | |
| 2 | State | string | 1 | Y | |
| 2 | Zip | string | 1 | Y | |
| 2 | Country | string | 1 | Y | |
| 1 | Reservations | string | Y | ||
| 2 | ReservationNumber | int | 1 | Y | Unique Reservation Number |
| 2 | LastName | string | 1 | Y | |
| 2 | FirstName | string | 1 | Y | |
| 2 | ClientRef | string | 1 | Y | |
| 2 | DepDate | string | 1 | Y | ISO YYYY-MM-DD |
| 2 | Quantity | int | 1 | Y | |
| 2 | ProductCode | string | 1 | Y | |
| 2 | PickUpLocation | string | 1 | Y | |
| 2 | Misc1 | string | 1 | Y | |
| 2 | Misc2 | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<xsd:BookingReportResponse xmlns:xsd="http://www.wso2.org/php/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<xsd:bookingReportResponse>
<xsd:FromDate>2016-12-12</xsd:FromDate>
<xsd:ToDate>2017-12-13</xsd:ToDate>
<xsd:AgentDetails>
<xsd:AgCode>0TEAMTEST</xsd:AgCode>
<xsd:AgentName>*TEAMTEST</xsd:AgentName>
<xsd:Address1>33 West 46th st 3rd floor</xsd:Address1>
<xsd:Address2/>
<xsd:City>New York</xsd:City>
<xsd:State>NY</xsd:State>
<xsd:Zip>10036</xsd:Zip>
<xsd:Country>USA</xsd:Country>
</xsd:AgentDetails>
<xsd:Reservations>
<xsd:ReservationNumber>960572</xsd:ReservationNumber>
<xsd:LastName xsi:nil="true"/>
<xsd:FirstName xsi:nil="true"/>
<xsd:ClientRef/>
<xsd:DepDate xsi:nil="true"/>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ProductCode/>
<xsd:PickUpLocation xsi:nil="true"/>
<xsd:Misc1 xsi:nil="true"/>
<xsd:Misc2 xsi:nil="true"/>
</xsd:Reservations>
</xsd:bookingReportResponse>
</xsd:BookingReportResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Invalid Fromdate
- Error - Invalid Todate
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
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. Please choose 1 for Hotel Rooms |
| 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 | Y | |
| 4 | FamilyName | string | 1 | Y | |
| 4 | FirstName | string | 1 | Y | |
| 4 | PassengerType | string | 1 | Y | AD /CH |
| 4 | PassengerAge | string | 1 | Y | |
| 4 | PassengerNationality | string | 1 | Y | 2 Character ISO standard Country Code |
| 3 | BelongsToPackage | int | 1 | N | If it does not belong to package, use 0 |
| 3 | PackageCode | string | 1 | N | |
| 3 | RateExpected | float | 1 | Y | Mandatory, AverageNightlyRate as returned by PriceSearch . |
blank request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:NewMultiItemReservation>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:AgentName></xsd:AgentName>
<xsd:AgentEmail></xsd:AgentEmail>
<xsd:ClientReference></xsd:ClientReference>
<!--1 or more repetitions:-->
<xsd:Items>
<!--1 or more repetitions:-->
<xsd:NewItem>
<xsd:ProductCode></xsd:ProductCode>
<xsd:ProductDate>2017-12-12</xsd:ProductDate>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language>ENG</xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks></xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:PassengerType>ADULT</xsd:PassengerType>
<xsd:PassengerAge>29</xsd:PassengerAge>
<xsd:PassengerNationality>US</xsd:PassengerNationality>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>0</xsd:BelongsToPackage>
<xsd:PackageCode>0</xsd:PackageCode>
<xsd:RateExpected>0</xsd:RateExpected>
</xsd:NewItem>
</xsd:Items>
</xsd:NewMultiItemReservation>
</soapenv:Body>
</soapenv:Envelope>
Sample Request With Rate Expected
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:NewMultiItemReservation>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:AgentName></xsd:AgentName>
<xsd:AgentEmail></xsd:AgentEmail>
<xsd:ClientReference></xsd:ClientReference>
<!--1 or more repetitions:-->
<xsd:Items>
<!--1 or more repetitions:-->
<xsd:NewItem>
<xsd:ProductCode></xsd:ProductCode>
<xsd:ProductDate>2017-12-12</xsd:ProductDate>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>3</xsd:NumberOfNights>
<xsd:Language></xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks></xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:PassengerType>AD</xsd:PassengerType>
<xsd:PassengerAge>25</xsd:PassengerAge>
<xsd:PassengerNationality>US</xsd:PassengerNationality>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>0</xsd:BelongsToPackage>
<xsd:PackageCode></xsd:PackageCode>
<xsd:RateExpected>221.4</xsd:RateExpected>
</xsd:NewItem>
</xsd:Items>
</xsd:NewMultiItemReservation>
</soapenv:Body>
</soapenv:Envelope>
Sample Request Multiple rooms with same product code
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:NewMultiItemReservation>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:AgentName></xsd:AgentName>
<xsd:AgentEmail></xsd:AgentEmail>
<xsd:ClientReference></xsd:ClientReference>
<!--1 or more repetitions:-->
<xsd:Items>
<!--1 or more repetitions:-->
<xsd:NewItem>
<xsd:ProductCode></xsd:ProductCode>
<xsd:ProductDate>2017-12-12</xsd:ProductDate>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>3</xsd:NumberOfNights>
<xsd:Language></xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks></xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:PassengerType>AD</xsd:PassengerType>
<xsd:PassengerAge>25</xsd:PassengerAge>
<xsd:PassengerNationality>US</xsd:PassengerNationality>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>0</xsd:BelongsToPackage>
<xsd:PackageCode></xsd:PackageCode>
<xsd:RateExpected>221.4</xsd:RateExpected>
</xsd:NewItem>
<xsd:NewItem>
<xsd:ProductCode></xsd:ProductCode>
<xsd:ProductDate>2017-12-22</xsd:ProductDate>
<xsd:Occupancy>Double</xsd:Occupancy>
<xsd:NumberOfNights>3</xsd:NumberOfNights>
<xsd:Language></xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks></xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>A</xsd:FamilyName>
<xsd:FirstName>S</xsd:FirstName>
<xsd:PassengerType>AD</xsd:PassengerType>
<xsd:PassengerAge>38</xsd:PassengerAge>
<xsd:PassengerNationality>US</xsd:PassengerNationality>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>0</xsd:BelongsToPackage>
<xsd:PackageCode></xsd:PackageCode>
<xsd:RateExpected>221.4</xsd:RateExpected>
</xsd:NewItem>
</xsd:Items>
</xsd: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 | Comments |
|---|---|---|---|---|---|
| 0 | NewMultiItemReservationResponse | 1 | |||
| 1 | ReservationNumber | int | 1 | Y | |
| 1 | BookingAgentReferenceNumber | string | 1 | Y | |
| 1 | DateBooked | string | 1 | Y | |
| 1 | ReservationStatus | string | 1 | Y | |
| 1 | FaxStatus | string | 1 | Y | |
| 1 | ReservationStatusDescription | string | 1 | Y | |
| 1 | GeneralComments | string | 1 | Y | |
| 1 | AgencyCommissionAmount | float | 1 | Y |
Errors
Description:
Doclit Request XmL
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:NewMultiItemReservation>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:AgentName></xsd:AgentName>
<xsd:AgentEmail></xsd:AgentEmail>
<xsd:ClientReference></xsd:ClientReference>
<!--1 or more repetitions:-->
<xsd:Items>
<!--1 or more repetitions:-->
<xsd:NewItem>
<xsd:ProductCode></xsd:ProductCode>
<xsd:ProductDate>2017-12-12</xsd:ProductDate>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights></xsd:NumberOfNights>
<xsd:Language></xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks></xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:PassengerType>AD</xsd:PassengerType>
<xsd:PassengerAge>29</xsd:PassengerAge>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>0</xsd:BelongsToPackage>
<xsd:PackageCode>0</xsd:PackageCode>
<xsd:RateExpected>0</xsd:RateExpected>
</xsd:NewItem>
</xsd:Items>
</xsd:NewMultiItemReservation>
</soapenv:Body>
</soapenv:Envelope>
✔ Book Escorted Tours using NewMultiItemReservation Method:
Request XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:NewMultiItemReservation>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:AgentName>agentcode</xsd:AgentName>
<xsd:AgentEmail>agentemail@somedomain.com</xsd:AgentEmail>
<xsd:ClientReference></xsd:ClientReference>
<!--1 or more repetitions:-->
<xsd:Items>
<!--1 or more repetitions:-->
<xsd:NewItem>
<xsd:ProductCode>NYCETMPLUS</xsd:ProductCode>[**First NewItem should be start with PackageCode**]
<xsd:ProductDate>2018-10-15</xsd:ProductDate>
<xsd:Occupancy>TPL+1CH</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language>ENG</xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks></xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:PassengerType>ADULT</xsd:PassengerType>
<xsd:PassengerAge>29</xsd:PassengerAge>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>0</xsd:BelongsToPackage>> [**Item itself is a PackageCode, BelongsToPackage must be set as 0**]
<xsd:PackageCode></xsd:PackageCode>[**Item itself is a Package, PackageCode should be set as blank**]
<xsd:RateExpected>0</xsd:RateExpected>
</xsd:NewItem>
<xsd:NewItem>
<xsd:ProductCode>NYCTEIB</xsd:ProductCode>[**Package Item Code 1**]
<xsd:ProductDate>2018-10-15</xsd:ProductDate>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language>ENG</xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks></xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:PassengerType>ADULT</xsd:PassengerType>
<xsd:PassengerAge>29</xsd:PassengerAge>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>1</xsd:BelongsToPackage>[**this should be set as 1, since it is a package item**]
<xsd:PackageCode>NYCETMPLUS</xsd:PackageCode>[**it should be filled with PackageCode**]
<xsd:RateExpected>0</xsd:RateExpected>
</xsd:NewItem>
<xsd:NewItem>
<xsd:ProductCode>NYCEHRIU</xsd:ProductCode>[**Package Item Code 2**]
<xsd:ProductDate>2018-10-15</xsd:ProductDate>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language>ENG</xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks></xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:PassengerType>ADULT</xsd:PassengerType>
<xsd:PassengerAge>29</xsd:PassengerAge>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>1</xsd:BelongsToPackage>[**this should be set as 1, since it is a package item**]
<xsd:PackageCode>NYCETMPLUS</xsd:PackageCode>[**it should be filled with PackageCode**]
<xsd:RateExpected>0</xsd:RateExpected>
</xsd:NewItem>
<xsd:NewItem>
<xsd:ProductCode>NYCSS</xsd:ProductCode>[**Package Item Code 3**]
<xsd:ProductDate>2018-10-16</xsd:ProductDate>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language>ENG</xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks></xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:PassengerType>ADULT</xsd:PassengerType>
<xsd:PassengerAge>29</xsd:PassengerAge>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>1</xsd:BelongsToPackage>[**this should be set as 1, since it is a package item**]
<xsd:PackageCode>NYCETMPLUS</xsd:PackageCode>[**it should be filled with PackageCode**]
<xsd:RateExpected>0</xsd:RateExpected>
</xsd:NewItem>
<xsd:NewItem>
<xsd:ProductCode>NYCTEOB</xsd:ProductCode>[**Package Item Code 4**]
<xsd:ProductDate>2018-10-22</xsd:ProductDate>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language>ENG</xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks></xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:PassengerType>ADULT</xsd:PassengerType>
<xsd:PassengerAge>29</xsd:PassengerAge>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>1</xsd:BelongsToPackage>[**this should be set as 1, since it is a package item**]
<xsd:PackageCode>NYCETMPLUS</xsd:PackageCode>[**it should be filled with PackageCode**]
<xsd:RateExpected>0</xsd:RateExpected>
</xsd:NewItem>
</xsd:Items>
</xsd:NewMultiItemReservation>
</soapenv:Body>
</soapenv:Envelope>
Response XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<xsd:NewMultiItemReservationResponse xmlns:xsd="http://www.wso2.org/php/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<xsd:newMultiItemReservationResponse>
<xsd:ReservationInformation>
<xsd:ReservationNumber>1039722</xsd:ReservationNumber>
<xsd:BookingAgentReferenceNumber/>
<xsd:DateBooked>2018-08-09</xsd:DateBooked>
<xsd:ReservationStatus>OK</xsd:ReservationStatus>
<xsd:FaxStatus>RW</xsd:FaxStatus>
<xsd:ReservationStatusDescription/>
<xsd:GeneralComments xsi:nil="true"/>
<xsd:AgencyCommissionAmount>0.0</xsd:AgencyCommissionAmount>
<xsd:BookingAgentInfo>
<xsd:AgencyName>*TEAMTEST</xsd:AgencyName>
<xsd:Address1>33 West 46th st 3rd floor</xsd:Address1>
<xsd:Address2/>
<xsd:City>New York</xsd:City>
<xsd:State>NY</xsd:State>
<xsd:PostalCode>10036</xsd:PostalCode>
<xsd:Country>USA</xsd:Country>
<xsd:AgentUserName>sharifulteam</xsd:AgentUserName>
<xsd:AgentEmail/>
</xsd:BookingAgentInfo>
<xsd:Items>
<xsd:UniqueItemID>1850755</xsd:UniqueItemID>
<xsd:ProductCode>NYCETMPLUS</xsd:ProductCode>
<xsd:ItemDate>2018-10-15</xsd:ItemDate>
<xsd:Description>NYCE MULTIPLUS PACKAGE - Riu Plaza Times Square</xsd:Description>
<xsd:Occupancy>Triple + 1 Child</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language/>
<xsd:PickUpLocation/>
<xsd:PickUpTime/>
<xsd:FlightInfo/>
<xsd:AverageNetPricePerNight>309.0</xsd:AverageNetPricePerNight>
<xsd:TotalItemNetPrice>927.0</xsd:TotalItemNetPrice>
<xsd:Quantity>3</xsd:Quantity>
<xsd:ItemSupplierConfirmationNumber xsi:nil="true"/>
<xsd:ItemStatusCode>RQ</xsd:ItemStatusCode>
<xsd:ItemRemarks/>
<xsd:ItemInformation/>
<xsd:ItemCommissionable>1</xsd:ItemCommissionable>
<xsd:ItemComments>THIS CAN BE ADDED ONLY TO TEAMTOUR EAST + TEAMTOUR MINI NIAGARA. MULTIPLUS PCKG CONFIRMED ONLY IF TEAMTOUR IS CONFIRMED. BLACK OUT DATES APPLY. PRE NTS NEED TO BE CONSECUTIVE TO TOUR DATE.</xsd:ItemComments>
<xsd:SubTotal>927.0</xsd:SubTotal>
<xsd:MealPlan>BK-BREAKFAST</xsd:MealPlan>
<xsd:MealPlanID>31</xsd:MealPlanID>
<xsd:RoomType/>
</xsd:Items>
<xsd:Items>
<xsd:UniqueItemID>1850756</xsd:UniqueItemID>
<xsd:ProductCode>NYCETMPLUS</xsd:ProductCode>
<xsd:ItemDate>2018-10-15</xsd:ItemDate>
<xsd:Description>NYCE MULTIPLUS PACKAGE - Riu Plaza Times Square</xsd:Description>
<xsd:Occupancy>Triple + 1 Child</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language/>
<xsd:PickUpLocation/>
<xsd:PickUpTime/>
<xsd:FlightInfo/>
<xsd:AverageNetPricePerNight>129.0</xsd:AverageNetPricePerNight>
<xsd:TotalItemNetPrice>129.0</xsd:TotalItemNetPrice>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemSupplierConfirmationNumber xsi:nil="true"/>
<xsd:ItemStatusCode>RQ</xsd:ItemStatusCode>
<xsd:ItemRemarks/>
<xsd:ItemInformation/>
<xsd:ItemCommissionable>1</xsd:ItemCommissionable>
<xsd:ItemComments>THIS CAN BE ADDED ONLY TO TEAMTOUR EAST + TEAMTOUR MINI NIAGARA. MULTIPLUS PCKG CONFIRMED ONLY IF TEAMTOUR IS CONFIRMED. BLACK OUT DATES APPLY. PRE NTS NEED TO BE CONSECUTIVE TO TOUR DATE.</xsd:ItemComments>
<xsd:SubTotal>129.0</xsd:SubTotal>
<xsd:MealPlan>BK-BREAKFAST</xsd:MealPlan>
<xsd:MealPlanID>31</xsd:MealPlanID>
<xsd:RoomType/>
</xsd:Items>
<xsd:Items>
<xsd:UniqueItemID>1850757</xsd:UniqueItemID>
<xsd:ProductCode>NYCTEIB</xsd:ProductCode>
<xsd:ItemDate>2018-10-15</xsd:ItemDate>
<xsd:Description>NYCE ESCORTED TOURS ONLY TIB</xsd:Description>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language/>
<xsd:PickUpLocation/>
<xsd:PickUpTime/>
<xsd:FlightInfo/>
<xsd:AverageNetPricePerNight>0.0</xsd:AverageNetPricePerNight>
<xsd:TotalItemNetPrice>0.0</xsd:TotalItemNetPrice>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemSupplierConfirmationNumber xsi:nil="true"/>
<xsd:ItemStatusCode>RQ</xsd:ItemStatusCode>
<xsd:ItemRemarks/>
<xsd:ItemInformation/>
<xsd:ItemCommissionable>0</xsd:ItemCommissionable>
<xsd:ItemComments>MIN. 2 PAX. - seat-on-coach cfrmd only for tsfrs inbound for flights arriving between 6am and 10pm. Private service required for transfer in provided for flights scheduled to land btwn 10pm and 6am</xsd:ItemComments>
<xsd:SubTotal>0.0</xsd:SubTotal>
<xsd:MealPlan>EP-NO MEALS</xsd:MealPlan>
<xsd:MealPlanID>1</xsd:MealPlanID>
<xsd:RoomType/>
</xsd:Items>
<xsd:Items>
<xsd:UniqueItemID>1850758</xsd:UniqueItemID>
<xsd:ProductCode>NYCEHRIU</xsd:ProductCode>
<xsd:ItemDate>2018-10-15</xsd:ItemDate>
<xsd:Description>NYCE RIU PLAZA TIMES SQUARE PRE NIGHTS ONLY</xsd:Description>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language/>
<xsd:PickUpLocation/>
<xsd:PickUpTime/>
<xsd:FlightInfo/>
<xsd:AverageNetPricePerNight>0.0</xsd:AverageNetPricePerNight>
<xsd:TotalItemNetPrice>0.0</xsd:TotalItemNetPrice>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemSupplierConfirmationNumber xsi:nil="true"/>
<xsd:ItemStatusCode>RQ</xsd:ItemStatusCode>
<xsd:ItemRemarks/>
<xsd:ItemInformation/>
<xsd:ItemCommissionable>0</xsd:ItemCommissionable>
<xsd:ItemComments>PRE NIGHTS FOR TEAMTOUR MULTIPLUS ONLY CAN BE BOOKED AS PART OF THE MULTIPLUS ONLY BREAKFAST INCLUDED</xsd:ItemComments>
<xsd:SubTotal>0.0</xsd:SubTotal>
<xsd:MealPlan>EP-NO MEALS</xsd:MealPlan>
<xsd:MealPlanID>1</xsd:MealPlanID>
<xsd:RoomType/>
</xsd:Items>
<xsd:Items>
<xsd:UniqueItemID>1850759</xsd:UniqueItemID>
<xsd:ProductCode>NYCSS</xsd:ProductCode>
<xsd:ItemDate>2018-10-16</xsd:ItemDate>
<xsd:Description>NYCS CITY TOUR (REG) ITAL. OR SPANISH</xsd:Description>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language xsi:nil="true"/>
<xsd:PickUpLocation/>
<xsd:PickUpTime/>
<xsd:FlightInfo/>
<xsd:AverageNetPricePerNight>0.0</xsd:AverageNetPricePerNight>
<xsd:TotalItemNetPrice>0.0</xsd:TotalItemNetPrice>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemSupplierConfirmationNumber xsi:nil="true"/>
<xsd:ItemStatusCode>CF</xsd:ItemStatusCode>
<xsd:ItemRemarks/>
<xsd:ItemInformation/>
<xsd:ItemCommissionable>0</xsd:ItemCommissionable>
<xsd:ItemComments>4HRS.,DAILY MEET@ 8:30AM DEPART@ 8:45AM FROM THE VOLATOUR OFFICE 33 WEST 46TH STREET BTWN 5TH & 6TH AVES. BLACKOUT 12/25 & 1/01 CALL EMERGENCY #1877 865 2868 DAY PRIOR TO REFONF</xsd:ItemComments>
<xsd:SubTotal>0.0</xsd:SubTotal>
<xsd:MealPlan>EP-NO MEALS</xsd:MealPlan>
<xsd:MealPlanID>1</xsd:MealPlanID>
<xsd:RoomType/>
</xsd:Items>
<xsd:Items>
<xsd:UniqueItemID>1850760</xsd:UniqueItemID>
<xsd:ProductCode>NYCTEOB</xsd:ProductCode>
<xsd:ItemDate>2018-10-22</xsd:ItemDate>
<xsd:Description>NYCE ESCORTED TOUR ONLY TOB</xsd:Description>
<xsd:Occupancy>Single</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language/>
<xsd:PickUpLocation/>
<xsd:PickUpTime/>
<xsd:FlightInfo/>
<xsd:AverageNetPricePerNight>0.0</xsd:AverageNetPricePerNight>
<xsd:TotalItemNetPrice>0.0</xsd:TotalItemNetPrice>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemSupplierConfirmationNumber xsi:nil="true"/>
<xsd:ItemStatusCode>RQ</xsd:ItemStatusCode>
<xsd:ItemRemarks/>
<xsd:ItemInformation/>
<xsd:ItemCommissionable>0</xsd:ItemCommissionable>
<xsd:ItemComments>MIN. 2 PAX. - seat-on-coach cfrmd only for tsfrs out for flights departing between 7:30am and 11pm Private service required for transfer out provided flights scheduled to depart btwn 11pm and 7:30am</xsd:ItemComments>
<xsd:SubTotal>0.0</xsd:SubTotal>
<xsd:MealPlan>EP-NO MEALS</xsd:MealPlan>
<xsd:MealPlanID>1</xsd:MealPlanID>
<xsd:RoomType/>
</xsd:Items>
<xsd:Passengers>
<xsd:UniquePassengerID>12704936</xsd:UniquePassengerID>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:Type>ADULT</xsd:Type>
<xsd:Age>29</xsd:Age>
</xsd:Passengers>
<xsd:TotalResNetPrice>1056.0</xsd:TotalResNetPrice>
<xsd:gross_total>0.0</xsd:gross_total>
<xsd:paid>0.0</xsd:paid>
<xsd:gross_due>0.0</xsd:gross_due>
<xsd:ag_comm_level>0.0</xsd:ag_comm_level>
<xsd:ag_comm_amt>0.0</xsd:ag_comm_amt>
<xsd:net_due>1056.0</xsd:net_due>
<xsd:cc_fees>0.0</xsd:cc_fees>
<xsd:ttl_expenses>0.0</xsd:ttl_expenses>
<xsd:ttl_expenses_paid>0.0</xsd:ttl_expenses_paid>
<xsd:commission_amt>0.0</xsd:commission_amt>
<xsd:commission_rcvd>0.0</xsd:commission_rcvd>
<xsd:amt_comm_amt>0.0</xsd:amt_comm_amt>
</xsd:ReservationInformation>
</xsd:newMultiItemReservationResponse>
</xsd:NewMultiItemReservationResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Occupancy is not valid
- Error - Invalid date
- Error - Quantity must be 1-12
- Error - Passenger type must be ADULT or CHILD
✔ Book Services using NewMultiItemReservation Method:
Request XML
Description for the amount of people associated with this reservation please use Occupancy. Below how you match occupancy to number of people
Single = 1
Double = 2
Triple = 3
Quad = 4
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:NewMultiItemReservation>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:AgentName></xsd:AgentName>
<xsd:AgentEmail></xsd:AgentEmail>
<xsd:ClientReference></xsd:ClientReference>
<!--1 or more repetitions:-->
<xsd:Items>
<!--1 or more repetitions:-->
<xsd:NewItem>
<xsd:ProductCode></xsd:ProductCode>
<xsd:ProductDate>2017-10-31</xsd:ProductDate>
<xsd:Occupancy>Double</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language></xsd:Language>
<xsd:PickUpLocation></xsd:PickUpLocation>
<xsd:PickUpTime></xsd:PickUpTime>
<xsd:FlightInfo></xsd:FlightInfo>
<xsd:Quantity>1</xsd:Quantity>
<xsd:ItemRemarks>test</xsd:ItemRemarks>
<xsd:Passengers>
<!--1 or more repetitions:-->
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>S</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:PassengerType>AD</xsd:PassengerType>
<xsd:PassengerAge>29</xsd:PassengerAge>
</xsd:NewPassenger>
<xsd:NewPassenger>
<xsd:Salutation>Mr.</xsd:Salutation>
<xsd:FamilyName>A</xsd:FamilyName>
<xsd:FirstName>S</xsd:FirstName>
<xsd:PassengerType>AD</xsd:PassengerType>
<xsd:PassengerAge>30</xsd:PassengerAge>
</xsd:NewPassenger>
</xsd:Passengers>
<xsd:BelongsToPackage>0</xsd:BelongsToPackage>
<xsd:PackageCode>0</xsd:PackageCode>
<xsd:RateExpected>0</xsd:RateExpected>
</xsd:NewItem>
</xsd:Items>
</xsd:NewMultiItemReservation>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<xsd:NewMultiItemReservationResponse xmlns:xsd="http://www.wso2.org/php/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<xsd:newMultiItemReservationResponse>
<xsd:ReservationInformation>
<xsd:ReservationNumber>673840</xsd:ReservationNumber>
<xsd:BookingAgentReferenceNumber/>
<xsd:DateBooked>2015-07-23</xsd:DateBooked>
<xsd:ReservationStatus>OK</xsd:ReservationStatus>
<xsd:FaxStatus>RW</xsd:FaxStatus>
<xsd:ReservationStatusDescription/>
<xsd:GeneralComments xsi:nil="true"/>
<xsd:AgencyCommissionAmount>0.0</xsd:AgencyCommissionAmount>
<xsd:BookingAgentInfo>
<xsd:AgencyName>*TEAMTEST</xsd:AgencyName>
<xsd:Address1>33 West 46th st 3rd floor</xsd:Address1>
<xsd:Address2/>
<xsd:City>New York</xsd:City>
<xsd:State>NY</xsd:State>
<xsd:PostalCode>10036</xsd:PostalCode>
<xsd:Country>SPAIN</xsd:Country>
<xsd:AgentUserName>achan</xsd:AgentUserName>
<xsd:AgentEmail/>
</xsd:BookingAgentInfo>
<xsd:Items>
<xsd:UniqueItemID>1369062</xsd:UniqueItemID>
<xsd:ProductCode>NYCTIB</xsd:ProductCode>
<xsd:ItemDate>2015-08-17</xsd:ItemDate>
<xsd:Description>NYCT TRSFR IN-SEAT ON COACH MIN 2PAX</xsd:Description>
<xsd:Occupancy>Double</xsd:Occupancy>
<xsd:NumberOfNights>1</xsd:NumberOfNights>
<xsd:Language/>
<xsd:PickUpLocation/>
<xsd:PickUpTime/>
<xsd:FlightInfo/>
<xsd:AverageNetPricePerNight>39.96</xsd:AverageNetPricePerNight>
<xsd:TotalItemNetPrice>79.91</xsd:TotalItemNetPrice>
<xsd:Quantity>2</xsd:Quantity>
<xsd:ItemSupplierConfirmationNumber xsi:nil="true"/>
<xsd:ItemStatusCode>CF</xsd:ItemStatusCode>
<xsd:ItemRemarks>test</xsd:ItemRemarks>
<xsd:ItemInformation/>
<xsd:ItemCommissionable>1</xsd:ItemCommissionable>
<xsd:ItemComments>flights landing btwn 10:00 pm & 6:00 am must be BKD AS PVT TRFS. $110 FEE XTRF BFORE 9AM ON P/UP TIME /Flight # /M1 MIN. 2 PAX RATE $25 EACH 12/24; 12/25 & 1/1; 12/ 31 AFT 7P</xsd:ItemComments>
<xsd:SubTotal>79.91</xsd:SubTotal>
<xsd:MealPlan>EP-NO MEALS</xsd:MealPlan>
<xsd:MealPlanID>1</xsd:MealPlanID>
<xsd:RoomType/>
</xsd:Items>
<xsd:Passengers>
<xsd:UniquePassengerID>11838419</xsd:UniquePassengerID>
<xsd:FamilyName>TEST</xsd:FamilyName>
<xsd:FirstName>A</xsd:FirstName>
<xsd:Type>AD</xsd:Type>
<xsd:Age>30</xsd:Age>
</xsd:Passengers>
<xsd:Passengers>
<xsd:UniquePassengerID>11838420</xsd:UniquePassengerID>
<xsd:FamilyName>TEST</xsd:FamilyName>
<xsd:FirstName>B</xsd:FirstName>
<xsd:Type>AD</xsd:Type>
<xsd:Age>30</xsd:Age>
</xsd:Passengers>
<xsd:TotalResNetPrice>79.91</xsd:TotalResNetPrice>
<xsd:gross_total>0.0</xsd:gross_total>
<xsd:paid>0.0</xsd:paid>
<xsd:gross_due>0.0</xsd:gross_due>
<xsd:ag_comm_level>0.0</xsd:ag_comm_level>
<xsd:ag_comm_amt>0.0</xsd:ag_comm_amt>
<xsd:net_due>79.91</xsd:net_due>
<xsd:cc_fees>0.0</xsd:cc_fees>
<xsd:ttl_expenses>0.0</xsd:ttl_expenses>
<xsd:ttl_expenses_paid>0.0</xsd:ttl_expenses_paid>
<xsd:commission_amt>0.0</xsd:commission_amt>
<xsd:commission_rcvd>0.0</xsd:commission_rcvd>
<xsd:amt_comm_amt>0.0</xsd:amt_comm_amt>
</xsd:ReservationInformation>
</xsd:newMultiItemReservationResponse>
</xsd:NewMultiItemReservationResponse>
</soapenv:Body>
</soapenv:Envelope>
3. RETRIEVE
RETRIEVE FUNCTIONS: This functions allows to get information regarding any existing reservation.
RetrieveReservation
Request XML
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveReservation | 1 | |||
| 1 | Username | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ReservationNumber | INT | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveReservation>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:ReservationNumber>950606</xsd:ReservationNumber>
</xsd:RetrieveReservation>
</soapenv:Body>
</soapenv:Envelope>
Response XML
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveReservation | ||||
| 1 | ReservationInformation | ||||
| 2 | ReservationNumber | int | |||
| 2 | BookingAgentReferenceNumber | string | |||
| 2 | DateBooked | string | |||
| 2 | ReservationStatus | string | |||
| 2 | GeneralComments | string | |||
| 2 | AgencyCommissionAmount | float | |||
| 2 | BookingAgentInfo | ||||
| 3 | AgencyName | string | |||
| 3 | Address1 | string | |||
| 3 | Address2 | string | |||
| 3 | City | string | |||
| 3 | State | string | |||
| 3 | PostalCode | string | |||
| 3 | Country | string | |||
| 3 | AgentUserName | string | |||
| 3 | AgentEmail | string | |||
| 2 | Items | ||||
| 3 | UniqueItemID | int | |||
| 3 | ProductCode | string | |||
| 3 | ItemDate | string | |||
| 3 | Description | string | |||
| 3 | Occupancy | string | |||
| 3 | NumberOfNights | int | |||
| 3 | Language | string | |||
| 3 | PickUpLocation | string | |||
| 3 | PickUpTime | string | |||
| 3 | FlightInfo | string | |||
| 3 | AverageNetPricePerNight | float | |||
| 3 | TotalItemNetPrice | float | |||
| 3 | Quantity | int | |||
| 3 | ItemSupplierConfirmationNumber | string | |||
| 3 | ItemStatusCode | string | |||
| 3 | ItemStatusDescription | string | |||
| 3 | ItemRemarks | string | |||
| 3 | ItemInformation | string | |||
| 3 | ItemCommissionable | string | |||
| 3 | ItemPassengers | ||||
| 4 | UniquePassengerID | ||||
| 4 | FamilyName | string | |||
| 4 | FirstName | string | |||
| 4 | Type | string | |||
| 4 | Age | int | |||
| 3 | TotalResNetPrice | float | |||
| 3 | gross_total | float | |||
| 3 | paid | float | |||
| 3 | gross_due | float | |||
| 3 | ag_comm_level | float | |||
| 3 | ag_comm_amt | float | |||
| 3 | net_due | float | |||
| 3 | cc_fees | float | |||
| 3 | ttl_expenses | float | |||
| 3 | ttl_expenses_paid | float | |||
| 3 | commission_amt | float | |||
| 3 | commission_rcvd | float | |||
| 3 | amt_comm_amt | float |
<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 | Y | |
| 1 | ShowCX | int | 1 | Y | Show Ref, Max 14 |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:RetrieveResByReference>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:Reference>test</xsd:Reference>
<xsd:ShowCX>4</xsd:ShowCX>
</xsd:RetrieveResByReference>
</soapenv:Body>
</soapenv:Envelope>
Response XML
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveResByReferenceResponse | 1 | |||
| 1 | ReservationNumber | int | 1 | Y | |
| 1 | LastName | string | 1 | Y | |
| 1 | FirstName | string | 1 | Y | |
| 1 | DepDate | string | 1 | Y | |
| 1 | ReservationStatus | string | 1 | Y | |
| 1 | Product | string | 1 | Y |
<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 Retrieve Reservation Number and other Information based on your Client Reference Number.
4. CANCEL
CANCEL FUNCTIONS: Cancel existing reservations and show Cancellation Policies.
- CancellationPolicy (Just Show Information)
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 | Y | e.g. BKLHALOFTD |
| 1 | ArrivalDate | date | 1 | Y | ISO YYYY-MM-DD |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CancellationPolicy>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:ProductCode></xsd:ProductCode>
<xsd:ArrivalDate>2017-12-12</xsd:ArrivalDate>
</xsd: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 | Comments |
|---|---|---|---|---|---|
| 0 | CancelReservation | 1 | |||
| 1 | Username | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ReservationNumber | int | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:CancelReservation>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:ReservationNumber>950606</xsd:ReservationNumber>
</xsd:CancelReservation>
</soapenv:Body>
</soapenv:Envelope>
XML response EXAMPLE 1 (when cancelling 7 days before, you pay 1 night cxl fee.) *Please note that if your cancellation results in a cancellation fee, the reservation will remain open (Status OK) until cancellation fee (CXLFEE) has been paid*
<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:
DeleteItem
Delete item from a reservation
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | DeleteItem | 1 | |||
| 1 | Username | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ItemID | int | 1 | Y | |
| 1 | BKGSrc | int | 1 | N |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.wso2.org/php/xsd">
<soapenv:Header/>
<soapenv:Body>
<xsd:DeleteItem>
<xsd:UserName>username</xsd:UserName>
<xsd:Password>password</xsd:Password>
<xsd:ItemID>1199644</xsd:ItemID>
<xsd:BKGSrc></xsd:BKGSrc>
</xsd:DeleteItem>
</soapenv:Body>
</soapenv:Envelope>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<xsd:DeleteItemResponse xmlns:xsd="http://www.wso2.org/php/xsd">
<xsd:deleteItemResp>
<xsd:ItemStatusCode>CX</xsd:ItemStatusCode>
<xsd:Message>Item has been deleted</xsd:Message>
</xsd:deleteItemResp>
</xsd:DeleteItemResponse>
</soapenv:Body>
</soapenv:Envelope>
Description: Delete a Item from a Reservation . To retrieve item id in a reservation use retrieve reservation to get the item id.