Teamamerica XML Documentation

User Tools

Site Tools

Trace:
team5j

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision		Previous revision
team5j [2023/04/19 11:29] – created - external edit 127.0.0.1team5j [2026/05/13 17:26] (current) – [✔ PriceSearch] Administrator
Line 98: Line 98:
  
 :!: //**Default time zone for Cancellation Policy is EST / EDT** // :!: //**Default time zone for Cancellation Policy is EST / EDT** //
 +
 +
 +**Resort Fee Types:** Find all available resort fee types and it's corresponding Ids from here:[[https://developers.teamamericany.com/resortfeetypes.html|Resort Fee Link]]
 +
  
  
Line 107: Line 111:
 |1  |Password  |string  |1  |Y  |  |1  |Password  |string  |1  |Y  | 
 |1  |CityCode  |string  |1  |Y  |Use [[start#listcities|ListCities]] to get City Codes from all available Cities|  |1  |CityCode  |string  |1  |Y  |Use [[start#listcities|ListCities]] to get City Codes from all available Cities| 
-|1  |ProductCode  |string  |1  |Y  |For all products in that city leave it blank| +|1  |ProductCode  |string  |1  |N  |For all products in that city leave it blank| 
 |1  |Type  |string  |1  |Y  | ‘Hotel’ as default for searching hotels| |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. In addition XML5+ supports an another occupancy convention with child age **<occupancy type>+<number of children>CH-<first child age>-<second child age>**. For example, DBL+1CH-10 [given child age is 10], DBL+2CH-7-10 [1st child age is 7, 2nd child age is 10]| |1  |Occupancy  |string  |1  |Y  |Accepts only 1 occupancy type per request. Single, Double, Triple, Quad, SGL+1CH, DBL+1CH, DBL+2CH, TPL+1CH. In addition XML5+ supports an another occupancy convention with child age **<occupancy type>+<number of children>CH-<first child age>-<second child age>**. For example, DBL+1CH-10 [given child age is 10], DBL+2CH-7-10 [1st child age is 7, 2nd child age is 10]|
Line 185: Line 189:
 | 3 |PenaltyDeadline| string  | 1 |N/A| Penalty will be added from this Date. Format will look like "YYYY-MM-DD T00:00:00.000 -04:00". **THIS IS AVAILABLE ONLY ON XML VERSION 5.1**| | 3 |PenaltyDeadline| string  | 1 |N/A| Penalty will be added from this Date. Format will look like "YYYY-MM-DD T00:00:00.000 -04:00". **THIS IS AVAILABLE ONLY ON XML VERSION 5.1**|
  
- 
-**Resort Fee Values** 
- 
-^ID^Type of Resort Fee^ 
-|1|Paid Locally Per Person| 
-|2|Paid Locally Per Room| 
-|3|Paid Locally Per Day| 
-|4|Paid Locally Plus Tax Per Person| 
-|5|Paid Locally Plus Tax Per Room| 
-|6|Paid Locally Plus Tax Per Day| 
-|7|Waived For TeamAmerica| 
-|8|Included In Rate| 
-|9|Optional Resort Fee to be Paid Locally Plus Tax Per Day| 
-|10|Paid Locally Per Room Per Day| 
-|11|Paid Locally Plus Tax Per Person Per Day| 
-|15|Plus Tax Per Room Per Day Included In Rate| 
-|16|Plus Tax Paid Locally By Guests Per Room Per Day| 
-|17|Paid Locally By Guests Per Room Per Day| 
-|18|PER ROOM PER DAY WAIVED FOR PROMO (PERKS NOT RECEIVED)| 
  
 <code> <code>
Line 290: Line 275:
 |1  |ProductCode  |string  |1  |Y  | Mandatory if VendorName is blank, Product code or part of it| |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  |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 |+|1  |VendorID  |INT  |1  |N  | 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 |
  
  
Line 571: Line 556:
 |2  |Description|string|1  |Y  | Brief description of the product | |2  |Description|string|1  |Y  | Brief description of the product |
 |2  |PackageItemDate|date|1  |Y  | Arrival Date for the package item | |2  |PackageItemDate|date|1  |Y  | Arrival Date for the package item |
-| 2 |CancellationPolicies|   | 1 | N |  
-| 3 |CancellationPolicy|   | 1..3 | N |  
-| 4 |NumberDaysPrior| int  | 1 | Y | Number of days prior to the travel date after which the cancellation policy applies | 
-| 4 |PenaltyType| string  | 1 | Y  | There are 3 types of penalty types: Nights, Percent and Dollars | 
-| 4 |PenaltyAmount| float  | 1 | Y | Depending on the PenaltyType, it may return either a number of nights, a percentage or a cancellation fee in dollars | 
-| 4 |PenaltyDeadline| string  | 1 | N/A |Penalty will be added from this Date. Format will look like "YYYY-MM-DD T00:00:00.000 -04:00". **THIS IS AVAILABLE ONLY ON XML VERSION 5.1**| 
 |1  |AvailabilityDetails|1  | | Array response for next (3 months+) available services | |1  |AvailabilityDetails|1  | | Array response for next (3 months+) available services |
 |2  |Date|date|1  |Y  | Service or Arrival Date | |2  |Date|date|1  |Y  | Service or Arrival Date |
Line 636: Line 615:
                   <xsd:Description>NYCE  ESCORTED TOURS ONLY TIB</xsd:Description>                   <xsd:Description>NYCE  ESCORTED TOURS ONLY TIB</xsd:Description>
                   <xsd:PackageItemDate>2020-08-22</xsd:PackageItemDate>                   <xsd:PackageItemDate>2020-08-22</xsd:PackageItemDate>
-                  <xsd:CancellationPolicies> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>34</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>20.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-07-19 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>21</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>50.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-01 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>14</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>100.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-08 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                  </xsd:CancellationPolicies> 
                </xsd:PackageDetails>                </xsd:PackageDetails>
                <xsd:PackageDetails>                <xsd:PackageDetails>
Line 664: Line 623:
                   <xsd:Description>NYCE RIU PLAZA TIMES SQUARE - THE NEW YORKER ONLY</xsd:Description>                   <xsd:Description>NYCE RIU PLAZA TIMES SQUARE - THE NEW YORKER ONLY</xsd:Description>
                   <xsd:PackageItemDate>2020-08-22</xsd:PackageItemDate>                   <xsd:PackageItemDate>2020-08-22</xsd:PackageItemDate>
-                  <xsd:CancellationPolicies> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>34</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>20.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-07-19 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>21</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>50.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-01 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>14</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>100.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-08 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                  </xsd:CancellationPolicies> 
                </xsd:PackageDetails>                </xsd:PackageDetails>
                <xsd:PackageDetails>                <xsd:PackageDetails>
Line 692: Line 631:
                   <xsd:Description>NYCE CITY TOUR + BRUNCH (THE NEWYORKER ONLY)</xsd:Description>                   <xsd:Description>NYCE CITY TOUR + BRUNCH (THE NEWYORKER ONLY)</xsd:Description>
                   <xsd:PackageItemDate>2020-08-23</xsd:PackageItemDate>                   <xsd:PackageItemDate>2020-08-23</xsd:PackageItemDate>
-                  <xsd:CancellationPolicies> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>34</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>20.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-07-19 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>21</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>50.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-01 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>14</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>100.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-08 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                  </xsd:CancellationPolicies> 
                </xsd:PackageDetails>                </xsd:PackageDetails>
                <xsd:PackageDetails>                <xsd:PackageDetails>
Line 720: Line 639:
                   <xsd:Description>NYCE WALKING TOUR AND THE VESSEL*</xsd:Description>                   <xsd:Description>NYCE WALKING TOUR AND THE VESSEL*</xsd:Description>
                   <xsd:PackageItemDate>2020-08-24</xsd:PackageItemDate>                   <xsd:PackageItemDate>2020-08-24</xsd:PackageItemDate>
-                  <xsd:CancellationPolicies> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>34</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>20.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-07-19 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>21</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>50.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-01 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>14</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>100.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-08 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                  </xsd:CancellationPolicies> 
                </xsd:PackageDetails>                </xsd:PackageDetails>
                <xsd:PackageDetails>                <xsd:PackageDetails>
Line 748: Line 647:
                   <xsd:Description>NYCE MOMA OR EQUIVALENT ATTRACTION</xsd:Description>                   <xsd:Description>NYCE MOMA OR EQUIVALENT ATTRACTION</xsd:Description>
                   <xsd:PackageItemDate>2020-08-25</xsd:PackageItemDate>                   <xsd:PackageItemDate>2020-08-25</xsd:PackageItemDate>
-                  <xsd:CancellationPolicies> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>34</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>20.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-07-19 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>21</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>50.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-01 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>14</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>100.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-08 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                  </xsd:CancellationPolicies> 
                </xsd:PackageDetails>                </xsd:PackageDetails>
                <xsd:PackageDetails>                <xsd:PackageDetails>
Line 776: Line 655:
                   <xsd:Description>NYCE ESCORTED TOUR ONLY  TOB</xsd:Description>                   <xsd:Description>NYCE ESCORTED TOUR ONLY  TOB</xsd:Description>
                   <xsd:PackageItemDate>2020-08-27</xsd:PackageItemDate>                   <xsd:PackageItemDate>2020-08-27</xsd:PackageItemDate>
-                  <xsd:CancellationPolicies> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>34</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>20.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-07-19 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>21</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>50.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-01 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                     <xsd:CancellationPolicy> 
-                        <xsd:NumberDaysPrior>14</xsd:NumberDaysPrior> 
-                        <xsd:PenaltyType>Percent</xsd:PenaltyType> 
-                        <xsd:PenaltyAmount>100.0</xsd:PenaltyAmount> 
-                        <xsd:PenaltyDeadline>2020-08-08 T00:00:00.000 -04:00</xsd:PenaltyDeadline> 
-                     </xsd:CancellationPolicy> 
-                  </xsd:CancellationPolicies> 
                </xsd:PackageDetails>                </xsd:PackageDetails>
                <xsd:AvailabilityDetails>                <xsd:AvailabilityDetails>
Line 1365: Line 1224:
 |3  |ProductDate  |string  |1  |Y  | Check-in date | |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  |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  |NumberOfNights  |int  |1  |Y  | Must be a value between 1 and 21. It should always be 1 for services.|
 |3  |Language  |string  |1  |N  | Optional, ENG/ITA/GER/SPA/FRE/POR | |3  |Language  |string  |1  |N  | Optional, ENG/ITA/GER/SPA/FRE/POR |
 |3  |PickUpLocation  |string  |1  |N  | Optional, for Transfers - You must use the ListVendor function for possible values | |3  |PickUpLocation  |string  |1  |N  | Optional, for Transfers - You must use the ListVendor function for possible values |
Line 1801: Line 1660:
  
  
-=====✔ Book Escorted Tours using NewMultiItemReservation Method=====+=====✔ Book Packages or Escorted Tours using NewMultiItemReservation Method=====
  
  
team5j.1681918161.txt.gz · Last modified: 2023/04/19 11:29 by 127.0.0.1