Table of Contents
TEAM 2.6
AddItem
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ServiceSearch2 | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ReservationNumber | int | 1 | Y | |
| 1 | ProductCode | string | 1 | Y | |
| 1 | ProductDate | string | 1 | Y | |
| 1 | Occupancy | string | 1 | Y | |
| 1 | NumberOfNights | int | 1 | Y | |
| 1 | Language | string | 1 | N | |
| 1 | PickUpLocation | string | 1 | N | |
| 1 | PickUpTime | string | 1 | N | |
| 1 | FlightInfo | string | 1 | N | |
| 1 | Quantity | int | 1 | N | |
| 1 | ItemRemarks | string | 1 | N | |
| 1 | PassengerID1 | int | 1 | N | |
| 1 | BelongsToPackage | int | 1 | N | |
| 1 | PackageCode | string | 1 | N | |
| 1 | RateExpected | float | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:AddItem soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<ReservationNumber xsi:type="xsd:int">23</ReservationNumber>
<ProductCode xsi:type="xsd:string"></ProductCode>
<ProductDate xsi:type="xsd:string">2013-01-01</ProductDate>
<Occupancy xsi:type="xsd:string">Single</Occupancy>
<NumberOfNights xsi:type="xsd:int">2</NumberOfNights>
<Language xsi:type="xsd:string"></Language>
<PickUpLocation xsi:type="xsd:string"></PickUpLocation>
<PickUpTime xsi:type="xsd:string"></PickUpTime>
<FlightInfo xsi:type="xsd:string"></FlightInfo>
<Quantity xsi:type="xsd:int">2</Quantity>
<ItemRemarks xsi:type="xsd:string"></ItemRemarks>
<PassengerID1 xsi:type="xsd:int"></PassengerID1>
. . . . . . . . .
<PassengerID12 xsi:type="xsd:int"></PassengerID12>
<BelongsToPackage xsi:type="xsd:int"></BelongsToPackage>
<PackageCode xsi:type="xsd:string"></PackageCode>
<RateExpected xsi:type="xsd:float"></RateExpected>
</php:AddItem>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | AddItemResponse | 1 | |||
| 1 | ItemID | int | 1 | Y | |
| 1 | ItemStatusCode | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:AddItemResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:ItemID>123456</ns2:ItemID>
<ns2:ItemStatusCode>CF</ns2:ItemStatusCode>
</return>
</ns1:AddItemResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Invalid date
- Error - Occupancy is not valid
- Error - Number of Nights must be 1 to 12
- Error - Quantity must be 1-12
- Error - Reservation not found
- Error - Reservation does not belong to Agency: TEST
- Error - Item can not be added, departure date is less than the current date
- Error - Pricing Error - Price Not Found. This error has been reported
Description:
___________________________________________________________________________________________
AddPassenger
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | AddPassenger | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ReservationNumber | int | 1 | Y | |
| 1 | Salutation | string | 1 | N | |
| 1 | FirstName | string | 1 | N | |
| 1 | FamilyName | string | 1 | N | |
| 1 | PassengerType | string | 1 | N | |
| 1 | PassengerAge | int | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:AddPassenger soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<ReservationNumber xsi:type="xsd:int">1</ReservationNumber>
<Salutation xsi:type="xsd:string"></Salutation>
<FirstName xsi:type="xsd:string">TEST</FirstName>
<FamilyName xsi:type="xsd:string">TEST</FamilyName>
<PassengerType xsi:type="xsd:string">ADULT</PassengerType>
<PassengerAge xsi:type="xsd:int"></PassengerAge>
</php:AddPassenger>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - Please enter First Name
- Error - Please enter Last Name
- Error - Passenger type must be ADULT or CHILD
- Error - Reservation not found
- Error - Reservation does not belong to Agency: TEST
Description:
___________________________________________________________________________________________
AttachRes
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | AttachRes | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | Res | string | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:AttachRes soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<Res xsi:type="xsd:string">333</Res>
</php:AttachRes>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | AttachResResponse | 1 | |||
| 1 | Res | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:AttachResResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:Res>333</ns2:Res>
</return>
</ns1:AttachResResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Please enter a valid Reservation Number
Description:
___________________________________________________________________________________________
BookingReport
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | BookingReport | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | FromDate | string | 1 | Y | |
| 1 | ToDate | string | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:BookingReport soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<FromDate xsi:type="xsd:string">2013-01-01</FromDate>
<ToDate xsi:type="xsd:string">2013-01-30</ToDate>
</php:BookingReport>
</soapenv:Body>
</soapenv:Envelope>
XML response
Flag 1
Errors
- Error - Login Invalid
- Error - Invalid From Date
- Error - Invalid To Date
Description:
___________________________________________________________________________________________
CancellationPolicy
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | CancellationPolicy | ||||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ProductCode | string | 1 | N | e.g. BKLHALOFTD |
| 1 | ArrivalDate | date | 1 | Y | ISO YYYY-MM-DD |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:CancellationPolicy soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<ProductCode xsi:type="xsd:string">BKLHHIEBK</ProductCode>
<ArrivalDate xsi:type="xsd:string">2013-01-20</ArrivalDate>
</php:CancellationPolicy>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | CancellationPolicyResponse | 1 | |||
| 1 | NumberDaysPrior | int | 1 | Y | |
| 1 | PenaltyType | string | 1 | Y | |
| 1 | PenaltyAmount | float | 1 | Y |
<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
Description:
___________________________________________________________________________________________
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:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:CancelReservation soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<ReservationNumber xsi:type="xsd:int"></ReservationNumber>
</php:CancelReservation>
</soapenv:Body>
</soapenv:Envelope>
<?code>
**XML response**
<code>
Errors
- Error - Login Invalid
- Error - Reservation not found
Description:
___________________________________________________________________________________________
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:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:CancelReservation soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">password</Password>
<ReservationNumber xsi:type="xsd:int">174</ReservationNumber>
</php:CancelReservation>
</soapenv:Body>
</soapenv:Envelope>
XML response
Errors
- Error - Login Invalid
- Error - Reservation not found
- Error - Reservation does not belong to Agency: TEST
Description:
___________________________________________________________________________________________
CheckItemStatus
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | CheckItemStatus | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ItemID | int | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:CheckItemStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<ItemID xsi:type="xsd:int">23</ItemID>
</php:CheckItemStatus>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | CheckItemStatusResponse | 1 | |||
| 1 | ItemStatus | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:CheckItemStatusResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:ItemStatus>RQ</ns2:ItemStatus>
</return>
</ns1:CheckItemStatusResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Item Not Found
Description:
___________________________________________________________________________________________
DisplayNews
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | DisplayNews | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:DisplayNews soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
</php:DisplayNews>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | DisplayNewsResponse | 1 | |||
| 1 | Message | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:DisplayNewsResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:Message>Wed Feb 6, 2013
===========
</ns2:Message>
</return>
</ns1:DisplayNewsResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description:
___________________________________________________________________________________________
GenerateSessionId
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | GenerateSessionId | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:GenerateSessionId soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
</php:GenerateSessionId>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | GenerateSessionIdResponse | 1 | |||
| 1 | SessionID | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:GenerateSessionIdResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:SessionID>test45954</ns2:SessionID>
</return>
</ns1:GenerateSessionIdResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description:
___________________________________________________________________________________________
GeoDistance
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | GeoDistance | 1 | |||
| 1 | Latitude | string | 1 | ||
| 1 | Longitude | string | 1 | ||
| 1 | ProductCode | string | 1 | ||
| 1 | Units | string | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:GeoDistance soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<Latitude xsi:type="xsd:string"></Latitude>
<Longitude xsi:type="xsd:string"></Longitude>
<ProductCode xsi:type="xsd:string">BKLHMARRBB</ProductCode>
<Units xsi:type="xsd:string"></Units>
</php:GeoDistance>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | GeoDistanceResponse | 1 | |||
| 1 | Distance | string | 1 |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:GeoDistanceResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:Distance>5380.5665</ns2:Distance>
</return>
</ns1:GeoDistanceResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Product Code Incorrect
Description:
___________________________________________________________________________________________
HotelSearch
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | HotelSearch | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | CityCode | string | 1 | Y | |
| 1 | ProductCode | string | 1 | N | |
| 1 | ArrivalDate | string | 1 | Y | |
| 1 | NumberOfNights | int | 1 | Y | |
| 1 | NumberOfRooms | int | 1 | Y | |
| 1 | DisplayCloseOut | string | 1 | N | |
| 1 | DisplayOnRequest | string | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:HotelSearch soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<CityCode xsi:type="xsd:string">nyc</CityCode>
<ProductCode xsi:type="xsd:string"></ProductCode>
<ArrivalDate xsi:type="xsd:string">2013-02-20</ArrivalDate>
<NumberOfNights xsi:type="xsd:int">2</NumberOfNights>
<NumberOfRooms xsi:type="xsd:int">2</NumberOfRooms>
<DisplayClosedOut xsi:type="xsd:string"></DisplayClosedOut>
<DisplayOnRequest xsi:type="xsd:string"></DisplayOnRequest>
</php:HotelSearch>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | HotelSearchResponse | 1 | |||
| 1 | ProductCode | string | 1 | Y | |
| 1 | ProductType | string | 1 | Y | |
| 1 | ProductName | string | 1 | N | |
| 1 | VendorName | string | 1 | N | |
| 1 | TeamVendorID | int | 1 | N | |
| 1 | CityName | string | 1 | Y | |
| 1 | DisplayGroup | string | 1 | N | |
| 1 | ProductDate | string | 1 | Y | |
| 1 | NumberOfNights | int | 1 | Y | |
| 1 | NumberOfRooms | int | 1 | Y | |
| 1 | FamilyPlan | string | 1 | N | |
| 1 | ChildAge | int | 1 | N | |
| 1 | MaximumOccupancy | int | 1 | N | |
| 1 | CxlPolicy | string | 1 | N | |
| 1 | HotelRating | int | 1 | N | |
| 1 | AverageRate | string | 1 | N | |
| 2 | Occupancy | string | 1 | N | |
| 2 | AverageNightlyRate | string | 1 | N | |
| 1 | PreNightlyInfo | string | 1 | N | |
| 2 | Dates | string | 1 | N | |
| 2 | Status | string | 1 | N | |
| 2 | PromoMessage | string | 1 | N | |
| 2 | MinStay | string | 1 | N | |
| 2 | MaxStay | string | 1 | N | |
| 2 | ArrivalRestriction | string | 1 | N | |
| 2 | Prices | string | 1 | N | |
| 3 | Occupancy | string | 1 | N | |
| 3 | AdultPrice | float | 1 | N | |
| 3 | ChildPrice | float | 1 | N | |
| 1 | NightlyInfo | string | 1 | N | |
| 2 | Dates | string | 1 | N | |
| 2 | Status | string | 1 | N | |
| 2 | PromoMessage | string | 1 | N | |
| 2 | MinStay | int | 1 | N | |
| 2 | MaxStay | int | 1 | N | |
| 2 | ArrivalRestriction | string | 1 | N | |
| 2 | Prices | int | 1 | N | |
| 3 | Occupancy | int | 1 | N | |
| 3 | AdultPrice | float | 1 | N | |
| 1 | PosNightlyInfo | string | 1 | N | |
| 2 | Dates | string | 1 | N | |
| 2 | Status | string | 1 | N | |
| 2 | PromoMessage | string | 1 | N | |
| 2 | MinStay | string | 1 | N | |
| 2 | MaxStay | string | 1 | N | |
| 2 | ArrivalRestriction | string | 1 | N | |
| 2 | Prices | string | 1 | N | |
| 3 | Occupancy | string | 1 | N | |
| 3 | AdultPrice | string | 1 | N | |
| 1 | Latitude | string | 1 | N | |
| 1 | Longitude | string | 1 | N | |
| 1 | VendorImage | string | 1 | N | |
| 1 | VendorDescription | string | 1 | N | |
| 1 | VendorAddr1 | string | 1 | N | |
| 1 | VendorAddr2 | string | 1 | N | |
| 1 | VendorState | string | 1 | N | |
| 1 | Promotion | string | 1 | N | |
| 1 | MealPlan | string | 1 | N | |
| 1 | RoomType | string | 1 | N | |
| 1 | HotelAddress1 | string | 1 | N | |
| 1 | LowestAverageNightlyRate | int | 1 | N | |
| 1 | HotelAddress2 | string | 1 | N | |
| 1 | HotelCity | string | 1 | N | |
| 1 | HotelState | string | 1 | N | |
| 1 | HotelZip | string | 1 | N | |
| 1 | HotelPhone | string | 1 | N | |
| 1 | PermRoomCode | int | 1 | N | |
| 1 | ProductDetails | string | 1 | N | |
| 1 | ResortFee | float | 1 | N | |
| 1 | ResortFeeType | string | 1 | N | |
| 1 | WebStartDate | string | 1 | N | |
| 1 | WebEndDate | string | 1 | N | |
| 1 | NonRefundable | int | 1 | N |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:HotelSearchResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:body>
<ns2:ProductCode>BKLHALOFTD</ns2:ProductCode>
<ns2:ProductType>Hotel</ns2:ProductType>
<ns2:ProductName>BKLH ALOFT NEW YORK BROOKLYN - DBL DBL</ns2:ProductName>
<ns2:VendorName>ALOFT NEW YORK BROOKLYN</ns2:VendorName>
<ns2:TeamVendorID>5174</ns2:TeamVendorID>
<ns2:CityName>NYC-Brooklyn, NY</ns2:CityName>
<ns2:DisplayGroup>New York Area</ns2:DisplayGroup>
<ns2:ProductDate>2013-02-20</ns2:ProductDate>
<ns2:NumberOfNights>2</ns2:NumberOfNights>
<ns2:FamilyPlan>Y</ns2:FamilyPlan>
<ns2:ChildAge>17</ns2:ChildAge>
<ns2:MaximumOccupancy>4</ns2:MaximumOccupancy>
<ns2:CxlPolicy>Submit Specific Request for Cancel Policy</ns2:CxlPolicy>
<ns2:HotelRating>4</ns2:HotelRating>
<ns2:AverageRate>
<ns2:Occupancy>Single</ns2:Occupancy>
<ns2:AverageNightlyRate>166</ns2:AverageNightlyRate>
</ns2:AverageRate>
<ns2:PreNightlyInfo>
<ns2:Dates>2013-02-19</ns2:Dates>
<ns2:Status>OnRequest</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:Prices>
<ns2:Occupancy>Double</ns2:Occupancy>
<ns2:AdultPrice>166</ns2:AdultPrice>
</ns2:Prices>
<ns2:Prices>
<ns2:Occupancy>Triple</ns2:Occupancy>
<ns2:AdultPrice>166</ns2:AdultPrice>
</ns2:Prices>
<ns2:Prices>
<ns2:Occupancy>Quad</ns2:Occupancy>
<ns2:AdultPrice>166</ns2:AdultPrice>
</ns2:Prices>
</ns2:PreNightlyInfo>
<ns2:NightlyInfo>
<ns2:Dates>2013-02-20</ns2:Dates>
<ns2:Status>OnRequest</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:Prices>
<ns2:Occupancy>Double</ns2:Occupancy>
<ns2:AdultPrice>166</ns2:AdultPrice>
</ns2:Prices>
<ns2:Prices>
<ns2:Occupancy>Triple</ns2:Occupancy>
<ns2:AdultPrice>166</ns2:AdultPrice>
</ns2:Prices>
<ns2:Prices>
<ns2:Occupancy>Quad</ns2:Occupancy>
<ns2:AdultPrice>166</ns2:AdultPrice>
</ns2:Prices>
</ns2:NightlyInfo>
<ns2:PosNightlyInfo>
<ns2:Dates>2013-02-22</ns2:Dates>
<ns2:Status>OnRequest</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:Prices>
<ns2:Occupancy>Double</ns2:Occupancy>
<ns2:AdultPrice>166</ns2:AdultPrice>
</ns2:Prices>
<ns2:Prices>
<ns2:Occupancy>Triple</ns2:Occupancy>
<ns2:AdultPrice>166</ns2:AdultPrice>
</ns2:Prices>
<ns2:Prices>
<ns2:Occupancy>Quad</ns2:Occupancy>
<ns2:AdultPrice>166</ns2:AdultPrice>
</ns2:Prices>
</ns2:PosNightlyInfo>
<ns2:Latitude/>
<ns2:Longitude/>
<ns2:VendorImage>http://dream.teamamericany.com/soap/vendorImage.php?prodcode=BKLHALOFTD</ns2:VendorImage>
<ns2:VendorDescription>Celebrate your style at Aloft New York Brooklyn, just minutes from the Brooklyn Academy of Music, Prospect Park and Brooklyn Botanic Garden. Scale the scenic Brooklyn Bridge for unforgettable views as you zip towards the hustle and bustle of downtown Manhattan.</ns2:VendorDescription>
<ns2:VendorAddr1>218 DUFFIELD STREET</ns2:VendorAddr1>
<ns2:VendorAddr2/>
<ns2:VendorState>NY</ns2:VendorState>
<ns2:Promotion>3</ns2:Promotion>
<ns2:MealPlan>EP-NO MEALS</ns2:MealPlan>
<ns2:RoomType>STANDARD</ns2:RoomType>
<ns2:HotelAddress1>218 DUFFIELD STREET</ns2:HotelAddress1>
<ns2:LowestAverageNightlyRate>166</ns2:LowestAverageNightlyRate>
<ns2:HotelAddress2/>
<ns2:HotelCity>BROOKLYN</ns2:HotelCity>
<ns2:HotelState>NY</ns2:HotelState>
<ns2:HotelZip>11201</ns2:HotelZip>
<ns2:HotelPhone>718 256 3833</ns2:HotelPhone>
<ns2:PermRoomCode>0</ns2:PermRoomCode>
<ns2:ProductDetails>TRADITIONAL DOUBLE DOUBLE ROOM; ; ; ;</ns2:ProductDetails>
<ns2:ResortFee>0</ns2:ResortFee>
<ns2:ResortFeeType/>
<ns2:WebStartDate/>
<ns2:WebEndDate/>
<ns2:NonRefundable>0</ns2:NonRefundable>
</ns2:body>
.
.
</ns2:body>
</return>
</ns1:HotelSearchResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Invalid date
- Error - Invalid City Code Length
- Error - Number of Nights must be 1 to 12
- Error - Number of Rooms must be 1 to 3
Description:
___________________________________________________________________________________________
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:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:ListCities soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">UserName</UserName>
<Password xsi:type="xsd:string">Password</Password>
</php:ListCities>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | 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>
<ns1:ListCitiesResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:body>
<ns2:CityCode>YBA</ns2:CityCode>
<ns2:CityName>*Banff, AB,CANADA</ns2:CityName>
<ns2:Country>Canada</ns2:Country>
<ns2:DisplayGroup/>
</ns2:body>
.
.
<ns2:body>
<ns2:CityCode>ZIO</ns2:CityCode>
<ns2:CityName>ZIO-Zion, UT</ns2:CityName>
<ns2:Country>USA</ns2:Country>
<ns2:DisplayGroup>Zion Area</ns2:DisplayGroup>
</ns2:body>
</return>
</ns1:ListCitiesResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description: Retrieve List of cities
___________________________________________________________________________________________
ListCountry
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListCountry | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:ListCountry soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">password</Password>
</php:ListCountry>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListCountryResponse | 1 | |||
| 1 | CountryID | int | 1 | Y | |
| 1 | CountryName | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:ListCountryResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:body>
<ns2:CountryID>97</ns2:CountryID>
<ns2:CountryName>ANGUILLA</ns2:CountryName>
</ns2:body>
<ns2:body>
<ns2:CountryID>122</ns2:CountryID>
<ns2:CountryName>ANTIGUA</ns2:CountryName>
</ns2:body>
.
.
<ns2:body>
<ns2:CountryID>83</ns2:CountryID>
<ns2:CountryName>VIETNAM</ns2:CountryName>
</ns2:body>
</return>
</ns1:ListCountryResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description: Retrieve List of Countries
___________________________________________________________________________________________
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:
___________________________________________________________________________________________
ListProduct
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListProducts | 1 | |||
| 1 | UserName | string 1 | Y | ||
| 1 | Password | string 1 | Y | ||
| 1 | CityCode | string 1 | N | ||
| 1 | Type | string | 1 | N | |
| 1 | Date | string | 1 | Y | |
| 1 | VendorName | string | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:ListProducts soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<CityCode xsi:type="xsd:string">NYC</CityCode>
<Type xsi:type="xsd:string"></Type>
<Date xsi:type="xsd:string"></Date>
<VendorName xsi:type="xsd:string"></VendorName>
</php:ListProducts>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListProductsResponse | 1 | |||
| 1 | ProductCode | string | 1 | Y | |
| 1 | ProductType | string | 1 | Y | |
| 1 | ProductName | string | 1 | Y | |
| 1 | TeamVendorID | string | 1 | Y | |
| 1 | CityName | string | 1 | Y | |
| 1 | ChildAge | int | 1 | Y | |
| 1 | HotelAddress1 | string | 1 | N | |
| 1 | HotelAddress2 | string | 1 | N | |
| 1 | HotelCity | string | 1 | N | |
| 1 | HotelState | string | 1 | N | |
| 1 | HotelZip | string | 1 | N | |
| 1 | HotelPhone | string | 1 | N | |
| 1 | MealPlan | string | 1 | N | |
| 1 | RoomType | string | 1 | N |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:ListProductsResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:body>
<ns2:ProductCode>BKLHALOFTD</ns2:ProductCode>
<ns2:ProductType>Hotel</ns2:ProductType>
<ns2:ProductName>BKLH ALOFT NEW YORK BROOKLYN - DBL DBL</ns2:ProductName>
<ns2:TeamVendorID>5174</ns2:TeamVendorID>
<ns2:CityName>NYC-Brooklyn, NY</ns2:CityName>
<ns2:ChildAge>17</ns2:ChildAge>
<ns2:HotelAddress1>218 DUFFIELD STREET</ns2:HotelAddress1>
<ns2:HotelAddress2/>
<ns2:HotelCity>BROOKLYN</ns2:HotelCity>
<ns2:HotelState>NY</ns2:HotelState>
<ns2:HotelZip>11201</ns2:HotelZip>
<ns2:HotelPhone>718 256 3833</ns2:HotelPhone>
<ns2:MealPlan>EP-NO MEALS</ns2:MealPlan>
<ns2:RoomType>STANDARD</ns2:RoomType>
</ns2:body>
.
.
</ns2:body>
</return>
</ns1:ListProductsResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Invalid date
Description:
___________________________________________________________________________________________
ListVendor
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListVendor | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:ListVendor soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
</php:ListVendor>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListVendorResponse | 1 | |||
| 1 | VendorID | string | 1 | Y | |
| 1 | VendorName | string | 1 | Y | |
| 1 | City | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:ListVendorResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:body>
<ns2:VendorID>680</ns2:VendorID>
<ns2:VendorName>* CLARION HOTEL/ AIRPORT-COLISEUM</ns2:VendorName>
<ns2:City>CHARLOTTE</ns2:City>
</ns2:body>
.
.
</ns2:body>
</return>
</ns1:ListVendorResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description:
___________________________________________________________________________________________
ListVendorFull
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListVendorFull | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:ListVendorFull soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
</php:ListVendorFull>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ListVendorFullResponse | 1 | |||
| 1 | VendorID | string | 1 | Y | |
| 1 | VendorName | string | 1 | Y | |
| 1 | VendorDescription | string | 1 | N | |
| 1 | ChildAge | int | 1 | N | |
| 1 | Address1 | string | 1 | N | |
| 1 | Address2 | string | 1 | N | |
| 1 | City | string | 1 | N | |
| 1 | State | string | 1 | N | |
| 1 | Zip | string | 1 | N | |
| 1 | Phone | string | 1 | N | |
| 1 | HotelRating | int | 1 | N | |
| 1 | Latitude | string | 1 | N | |
| 1 | Longitude | string | 1 | N | |
| 1 | NorthStarCode | string | 1 | N |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:ListVendorFullResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:body>
<ns2:VendorID>123</ns2:VendorID>
<ns2:VendorName>VENDOR NAME </ns2:VendorName>
<ns2:VendorDescription>< ns2:VendorDescription>
<ns2:ChildAge>17</ns2:ChildAge>
<ns2:Address1>321 street</ns2:Address1>
<ns2:Address2/>
<ns2:City>City</ns2:City>
<ns2:State>NY</ns2:State>
<ns2:Zip>12321</ns2:Zip>
<ns2:Phone>555 523 1400</ns2:Phone>
<ns2:HotelRating>3</ns2:HotelRating>
<ns2:Latitude>35.179684</ns2:Latitude>
<ns2:Longitude>35.179684</ns2:Longitude>
<ns2:NorthStarCode/>
</ns2:body> .
.
</ns2:body>
</return>
</ns1:ListVendorFullResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description:
___________________________________________________________________________________________
ModifyInvoiceItem
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ModifyInvoiceItem | 1 | |||
| 1 | Username | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ItemID | int | 1 | Y | |
| 1 | DepDate | string | 1 | Y | |
| 1 | Nights | int | 1 | Y | |
| 1 | Occupancy | string | 1 | Y | |
| 1 | PickUpLocation | string | 1 | N | |
| 1 | PickUpTime | string | 1 | N | |
| 1 | Misc1 | string | 1 | N | |
| 1 | Misc2 | string | 1 | N | |
| 1 | ItemRemarks | string | 1 | N |
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - Invalid date
- Error - Occupancy is not valid
- Error - Number of Nights must be 1 to 12
Description:
___________________________________________________________________________________________
ModifyItem
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ModifyItem | 1 | Y | ||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ItemID | int | 1 | Y | |
| 1 | DepDate | string | 1 | N | |
| 1 | PickUpLocation | string | 1 | N | |
| 1 | PickUpTime | string | 1 | N | |
| 1 | Language | string | 1 | N | |
| 1 | FlightInfo | string | 1 | N | |
| 1 | ItemRemarks | string | 1 | N | |
| 1 | PassengersToEraseCSV | string | 1 | N | |
| 1 | PassengersToAddCSV | string | 1 | N | |
| 1 | OverwriteBlanks | boolean | 1 | N |
XML request
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:ModifyItem soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string"></UserName>
<Password xsi:type="xsd:string"></Password>
<ItemID xsi:type="xsd:int"></ItemID>
<DepDate xsi:type="xsd:string"></DepDate>
<PickUpLocation xsi:type="xsd:string"></PickUpLocation>
<PickUpTime xsi:type="xsd:string"></PickUpTime>
<Language xsi:type="xsd:string"></Language>
<FlightInfo xsi:type="xsd:string"></FlightInfo>
<ItemRemarks xsi:type="xsd:string"></ItemRemarks>
<PassengersToEraseCSV xsi:type="xsd:string"></PassengersToEraseCSV>
<PassengersToAddCSV xsi:type="xsd:string"></PassengersToAddCSV>
<OverwriteBlanks xsi:type="xsd:boolean"></OverwriteBlanks>
</php:ModifyItem>
</soapenv:Body>
</soapenv:Envelope>
XML response
Errors
- Error - Login Invalid
- Error - Invalid Time
- Error - Language is not valid
Description:
___________________________________________________________________________________________
NewReservation
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | NewReservation | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | AgentName | string | 1 | N | |
| 1 | AgentEmail | string | 1 | N | |
| 1 | ClientReference | string | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:NewReservation soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<AgentName xsi:type="xsd:string"></AgentName>
<AgentEmail xsi:type="xsd:string"></AgentEmail>
<ClientReference xsi:type="xsd:string"></ClientReference>
</php:NewReservation>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | NewReservationResponse | 1 | |||
| 1 | ReservationNumber | int | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:NewReservationResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:ReservationNumber>286046</ns2:ReservationNumber>
</return>
</ns1:NewReservationResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description:
___________________________________________________________________________________________
NewSingleItemReservation
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | NewSingleItemReservation | 1 | |||
| 1 | Username | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | AgentName | string | 1 | Y | |
| 1 | AgentEmail | string | 1 | Y | |
| 1 | ProductCode | string | 1 | Y | |
| 1 | ProductDate | string | 1 | Y | |
| 1 | Occupancy | string | 1 | Y | |
| 1 | NumberOfNights | int | 1 | Y | |
| 1 | Language | string | 1 | N | |
| 1 | PickUpLocation | string | 1 | N | |
| 1 | PickUpTime | string | 1 | N | |
| 1 | FlightInfo | string | 1 | N | |
| 1 | Quantity | int | 1 | N | |
| 1 | RateExpected | string | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:NewSingleItemReservation soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<AgentName xsi:type="xsd:string"></AgentName>
<AgentEmail xsi:type="xsd:string"></AgentEmail>
<ProductCode xsi:type="xsd:string"></ProductCode>
<ProductDate xsi:type="xsd:string">2013-02-21</ProductDate>
<Occupancy xsi:type="xsd:string">Double</Occupancy>
<NumberOfNights xsi:type="xsd:int">2</NumberOfNights>
<Language xsi:type="xsd:string"></Language>
<PickUpLocation xsi:type="xsd:string"></PickUpLocation>
<PickUpTime xsi:type="xsd:string"></PickUpTime>
<FlightInfo xsi:type="xsd:string"></FlightInfo>
<Quantity xsi:type="xsd:int">2</Quantity>
<ItemRemarks xsi:type="xsd:string"></ItemRemarks>
<ClientReference xsi:type="xsd:string"></ClientReference>
<Passenger1_Salutation xsi:type="xsd:string"></Passenger1_Salutation>
<Passenger1_FamilyName xsi:type="xsd:string">Doe</Passenger1_FamilyName>
<Passenger1_FirstName xsi:type="xsd:string">John</Passenger1_FirstName>
<Passenger1_PassengerType xsi:type="xsd:string">CHILD</Passenger1_PassengerType>
<Passenger1_PassengerAge xsi:type="xsd:int">22</Passenger1_PassengerAge>
<RateExpected xsi:type="xsd:float"></RateExpected>
</php:NewSingleItemReservation>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - Invalid date
- Error - Occupancy is not valid
- Error - Number of Nights must be 1 to 12
- Error - Quantity must be 1-12
- Error - At least one non-blank passenger name required
- Error - Please enter Last Name
- Error - Passenger type must be ADULT or CHILD
- Error - Passenger Age must be between 1 and 99
- Error - Item can not be added, departure date is less than the current date
- Error - Pricing Error - Price Not Found. This error has been reported
Description:
___________________________________________________________________________________________
PackageSearch
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | PackageSearch | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | CityCode | string | 1 | Y | |
| 1 | ArrivalDate | string | 1 | Y | iso YYYY-MM-DD |
| 1 | Occupancy | int | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:PackageSearch soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<CityCode xsi:type="xsd:string">NYC</CityCode>
<ArrivalDate xsi:type="xsd:string">2013-01-21</ArrivalDate>
<Occupancy xsi:type="xsd:int">2</Occupancy>
</php:PackageSearch>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | PackageSearchResponse | 1 | |||
| 1 | ProductCode | int | 1 | Y | |
| 1 | ProductType | string | 1 | Y | |
| 1 | ProductName | string | 1 | Y | |
| 1 | VendorID | int | 1 | Y | |
| 1 | CityName | string | 1 | Y | |
| 1 | Status | string | 1 | Y | |
| 1 | ProductDate | string | 1 | Y | |
| 1 | Price | string | 1 | Y | |
| 1 | ChildPrice | int | 1 | N | |
| 1 | PromoMessage | string | 1 | N | |
| 1 | ChildAge | string | 1 | N | |
| 1 | WebPriority | int | 1 | N | |
| 1 | NumPax | int | 1 | N | |
| 1 | PackageDetails | string | 1 | N | |
| 2 | PullPriceFlag | int | 1 | N | |
| 2 | DisplayNightsFlag | int | 1 | N | |
| 2 | DefaultNights | int | 1 | N | |
| 2 | ProductCode | string | 1 | N | |
| 2 | Description | string | 1 | N | |
| 1 | Latitude | string | 1 | N | |
| 1 | Longitude | string | 1 | N | |
| 1 | VendorName | string | 1 | N | |
| 1 | VendorAddress1 | string | 1 | N | |
| 1 | VendorAddress2 | string | 1 | N |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:PackageSearchResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:body>
<ns2:ProductCode>NYCPBASIC</ns2:ProductCode>
<ns2:ProductType>Package</ns2:ProductType>
<ns2:ProductName>NYCP BASIC (TRF IN + CITY TOUR) ITA</ns2:ProductName>
<ns2:VendorID>1</ns2:VendorID>
<ns2:CityName>NYC-.New York, NY</ns2:CityName>
<ns2:Status>RQ</ns2:Status>
<ns2:ProductDate>2012-11-21</ns2:ProductDate>
<ns2:Price>513</ns2:Price>
<ns2:ChildPrice>0</ns2:ChildPrice>
<ns2:PromoMessage/>
<ns2:ChildAge>0</ns2:ChildAge>
<ns2:WebPriority>2</ns2:WebPriority>
<ns2:NumPax>2</ns2:NumPax>
<ns2:PackageDetails>
<ns2:PullPriceFlag>0</ns2:PullPriceFlag>
<ns2:DisplayNightsFlag>1</ns2:DisplayNightsFlag>
<ns2:DefaultNights>1</ns2:DefaultNights>
<ns2:ProductCode>NYCTIB</ns2:ProductCode>
<ns2:Description>NYCT TRANSFER IN-SEAT ON COACH Mn 2px</ns2:Description>
</ns2:PackageDetails>
<ns2:PackageDetails>
<ns2:PullPriceFlag>0</ns2:PullPriceFlag>
<ns2:DisplayNightsFlag>1</ns2:DisplayNightsFlag>
<ns2:DefaultNights>1</ns2:DefaultNights>
<ns2:ProductCode>NYCSS</ns2:ProductCode>
<ns2:Description>NYCS CITY TOUR (REG) ITAL. OR SPANISH</ns2:Description>
</ns2:PackageDetails>
<ns2:Latitude>41.7566652</ns2:Latitude>
<ns2:Longitude>-74.9803778</ns2:Longitude>
<ns2:VendorImage>http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCPBASIC</ns2:VendorImage>
<ns2:VendorName>TEST</ns2:VendorName>
<ns2:VendorAddress1>57 west 33 STREET</ns2:VendorAddress1>
<ns2:VendorAddress2>4th FLOOR</ns2:VendorAddress2>
</ns2:body>
</return>
</ns1:PackageSearchResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Invalid length for City Code - Maximum of 4 allowed
- Error - Invalid date
Description:
___________________________________________________________________________________________
PackageSearch2
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | PackageSearch2 | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ProductCode | string | 1 | Y | |
| 1 | CityCode | string | 1 | Y | |
| 1 | ArrivalDate | string | 1 | Y | |
| 1 | Occupancy | int | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:PackageSearch2 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<ProductCode xsi:type="xsd:string"></ProductCode>
<CityCode xsi:type="xsd:string">NYC</CityCode>
<ArrivalDate xsi:type="xsd:string">2013-01-20</ArrivalDate>
<Occupancy xsi:type="xsd:int">2</Occupancy>
</php:PackageSearch2>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | PackageSearch2Response | 1 | |||
| 1 | ProductCode | int | 1 | Y | |
| 1 | ProductType | string | 1 | Y | |
| 1 | ProductName | string | 1 | Y | |
| 1 | VendorID | int | 1 | Y | |
| 1 | CityName | string | 1 | Y | |
| 1 | Status | string | 1 | Y | |
| 1 | ProductDate | string | 1 | Y | |
| 1 | Price | string | 1 | Y | |
| 1 | ChildPrice | int | 1 | N | |
| 1 | PromoMessage | string | 1 | N | |
| 1 | ChildAge | string | 1 | N | |
| 1 | WebPriority | int | 1 | N | |
| 1 | NumPax | int | 1 | N | |
| 1 | PackageDetails | string | 1 | N | |
| 2 | PullPriceFlag | int | 1 | N | |
| 2 | DisplayNightsFlag | int | 1 | N | |
| 2 | DefaultNights | int | 1 | N | |
| 2 | ProductCode | string | 1 | N | |
| 2 | Description | string | 1 | N | |
| 2 | PromoMessage | string | 1 | N | |
| 1 | Latitude | string | 1 | N | |
| 1 | Longitude | string | 1 | N | |
| 1 | VendorName | string | 1 | N | |
| 1 | VendorAddress1 | string | 1 | N | |
| 1 | VendorAddress2 | string | 1 | N |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:PackageSearch2Response xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:body>
<ns2:ProductCode>NYCPBASIC</ns2:ProductCode>
<ns2:ProductType>Package</ns2:ProductType>
<ns2:ProductName>NYCP BASIC (TRF IN + CITY TOUR) ITA</ns2:ProductName>
<ns2:VendorID>1</ns2:VendorID>
<ns2:CityName>NYC-.New York, NY</ns2:CityName>
<ns2:Status>RQ</ns2:Status>
<ns2:ProductDate>2013-01-20</ns2:ProductDate>
<ns2:Price>513</ns2:Price>
<ns2:ChildPrice>0</ns2:ChildPrice>
<ns2:PromoMessage/>
<ns2:ChildAge>0</ns2:ChildAge>
<ns2:RateDisplay/>
<ns2:WebPriority>2</ns2:WebPriority>
<ns2:NumPax>2</ns2:NumPax>
<ns2:PackageDetails>
<ns2:PullPriceFlag>0</ns2:PullPriceFlag>
<ns2:DisplayNightsFlag>1</ns2:DisplayNightsFlag>
<ns2:DefaultNights>1</ns2:DefaultNights>
<ns2:ProductCode>NYCTIB</ns2:ProductCode>
<ns2:Description>NYCT TRANSFER IN-SEAT ON COACH Mn 2px</ns2:Description>
<ns2:PromoMessage/>
</ns2:PackageDetails>
<ns2:Latitude>42.7566652</ns2:Latitude>
<ns2:Longitude>-73.9803778</ns2:Longitude>
<ns2:VendorImage>http://dream.teamamericany.com/soap/vendorImage.php?prodcode=NYCPBASIC</ns2:VendorImage>
<ns2:VendorName>TEST</ns2:VendorName>
<ns2:VendorAddress1>47 WEST 33 STREET</ns2:VendorAddress1>
<ns2:VendorAddress2>4th FLOOR</ns2:VendorAddress2>
</ns2:body>
</return>
</ns1:PackageSearch2Response>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Invalid length for City Code - Maximum of 4 allowed
- Error - Invalid date
Description:
___________________________________________________________________________________________
ProductDetails
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ProductDetails | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | CityCode | string | 1 | Y | |
| 1 | ProductCode | string | 1 | N | |
| 1 | ProductType | string | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:ProductDetails soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<CityCode xsi:type="xsd:string">NYC</CityCode>
<ProductCode xsi:type="xsd:string">STIHCMFRT</ProductCode>
<ProductType xsi:type="xsd:string">Hotel</ProductType>
</php:ProductDetails>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ProductDetailsResponse | string | 1 | Y | |
| 1 | ProductCode | string | 1 | Y | |
| 1 | ProductType | string | 1 | Y | |
| 1 | ProductName | string | 1 | Y | |
| 1 | ProductDescription | string | 1 | Y | |
| 1 | TeamVendorID | string | 1 | Y | |
| 1 | CityName | string | 1 | Y | |
| 1 | ProductDetails | string | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:ProductDetailsResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:ProductCode>STIHWEFRT</ns2:ProductCode>
<ns2:ProductType>Hotel</ns2:ProductType>
<ns2:ProductName>STIH COMFORT INN STATEN ISLAND W/BKFST</ns2:ProductName>
<ns2:ProductDescription/>
<ns2:TeamVendorID>4161</ns2:TeamVendorID>
<ns2:CityName>NYC-Staten Island, NY</ns2:CityName>
<ns2:ProductDetails>INCLUDED COMPLIMENTARY CONTINENTAL BKFST. . .</ns2:ProductDetails>
</return>
</ns1:ProductDetailsResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Invalid length for City Code - Maximum of 4 allowed
Description:
___________________________________________________________________________________________
ProductVendorInfo
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ProductVendorInfo | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ProductCode | string | 1 | N | e.g. BKLHALOFTD |
| 1 | VendorName | string | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:ProductVendorInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">password</Password>
<ProductCode xsi:type="xsd:string"></ProductCode>
<VendorName xsi:type="xsd:string"></VendorName>
</php:ProductVendorInfo>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ProductVendorInfoResponse | 1 | |||
| 1 | VendorName | string | 1 | Y | |
| 1 | VendorID | int | 1 | Y | |
| 1 | VendorImage | string | 1 | N | |
| 1 | VendorDescription | string | 1 | N | |
| 1 | ChildAge | int | 1 | N | |
| 1 | Address1 | string | 1 | Y | |
| 1 | Address2 | string | 1 | N | |
| 1 | City | string | 1 | Y | |
| 1 | State | string | 1 | Y | |
| 1 | Zip | int | 1 | Y | |
| 1 | Phone | string | 1 | Y | |
| 1 | HotelRating | int | 1 | N | |
| 1 | Latitude | string | 1 | N | |
| 1 | Longitude | string | 1 | N | |
| 1 | NorthStarCode | string | 1 | N | |
| 1 | ProductDetails | string | 1 | N | |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:ProductVendorInfoXML responsens:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:VendorName>Vendor Name</ns2:VendorName>
<ns2:VendorID>1234</ns2:VendorID>
<ns2:VendorImage> http://dream.teamamericany.com/soap/vendorImage.php ?prodcode=PRODUCT_CODE</ns2:VendorImage>
<ns2:VendorDescription>description</ns2:VendorDescription>
<ns2:ChildAge>15</ns2:ChildAge>
<ns2:Address1>23 some street</ns2:Address1>
<ns2:Address2/>
<ns2:City>BROOKLYN</ns2:City>
<ns2:State>NY</ns2:State>
<ns2:Zip>11111</ns2:Zip>
<ns2:Phone>555 555 5555</ns2:Phone>
<ns2:HotelRating>5</ns2:HotelRating>
<ns2:Latitude/>
<ns2:Longitude/>
<ns2:NorthStarCode/>
<ns2:ProductDetails>TRADITIONAL DOUBLE DOUBLE ROOM.</ns2:ProductDetails>
</return>
</ns1:ProductVendorInfoResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Product Code Incorrect
Description:
___________________________________________________________________________________________
PropertyImages
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | PropertyImages | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ProductCode | string | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:PropertyImages soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">password</Password>
<ProductCode xsi:type="xsd:string">BKLHMARRBB</ProductCode>
</php:PropertyImages>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | PropertyImagesResponse | 1 | |||
| 1 | PropertyID | string | 1 | Y | |
| 1 | Category | string | 1 | Y | |
| 1 | Caption | string | 1 | Y | |
| 1 | Thumbnail | string | 1 | N | |
| 1 | ActualSize | string | 1 | N |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:PropertyImagesXML responsens:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:PropertyImage>
<ns2:PropertyID>12334</ns2:PropertyID>
<ns2:Category>phototour</ns2:Category>
<ns2:Caption>Wedding Reception</ns2:Caption>
<ns2:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/36/294/134/nycbk_phototour68_A.jpg</ns2:Thumbnail>
<ns2:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/3/0/36/294/134/nycbk_phototour68_H.jpg</ns2:ActualSize>
</ns2:PropertyImage>
.
.
<ns2:PropertyImage>
<ns2:PropertyID>R11123</ns2:PropertyID>
<ns2:Category>phototour2</ns2:Category>
<ns2:Caption>Exterior</ns2:Caption>
<ns2:Thumbnail>http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/968/196/nycbk_phototour26_A.jpg</ns2:Thumbnail>
<ns2:ActualSize>http://www.cfmedia.vfmleonardo.com/imageRepo/1/0/29/968/196/nycbk_phototour26_H.jpg</ns2:ActualSize>
</ns2:PropertyImage>
</return>
</ns1:PropertyImagesResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description
___________________________________________________________________________________________
RetrieveInvoiceInfo
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveInvoiceInfo | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:RetrieveInvoiceInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
</php:RetrieveInvoiceInfo>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - You don't have privileges to access this feature
Description:
___________________________________________________________________________________________
RetrieveInvoiceItem
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveInvoiceItem | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ItemID | int | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:RetrieveInvoiceItem soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<ItemID xsi:type="xsd:int">174</ItemID>
</php:RetrieveInvoiceItem>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveInvoiceItemResponse | 1 | |||
| 1 | ItemID | int | 1 | Y | |
| 1 | ProdCode | string | 1 | Y | |
| 1 | Description | string | 1 | N | |
| 1 | DepDate | string | 1 | N | |
| 1 | Quantity | int | 1 | Y | |
| 1 | Occupancy | int | 1 | N | |
| 1 | RoomType | string | 1 | N | |
| 1 | PickUpLocation | string | 1 | N | |
| 1 | PickUpTime | string | 1 | N | |
| 1 | Misc1 | string | 1 | N | |
| 1 | Misc2 | string | 1 | N | |
| 1 | ItemRemarks | string | 1 | N | |
| 1 | Status | string | 1 | N | |
| 1 | Nights | int | 1 | N | |
| 1 | NightFlag | string | 1 | N | |
| 1 | Price | float | 1 | Y | |
| 1 | SupplierRef | string | 1 | N | |
| 1 | ReportDate | string | 1 | N | |
| 1 | ItemChgFlag | string | 1 | N | |
| 1 | Passengers | 1 | N | ||
| 2 | UniquePassengerID | int | 1 | N | |
| 2 | FamilyName | string | 1 | N | |
| 2 | FirstName | string | 1 | N | |
| 2 | Type | string | 1 | N | |
| 2 | Age | int | 1 | N | |
| 2 | Comment | string | 1 | N | |
| 2 | DateProcessed | string | 1 | N | |
| 1 | SubTotal | float | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:RetrieveInvoiceItemResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:ItemID>174</ns2:ItemID>
<ns2:ProdCode>NFTCVORTE</ns2:ProdCode>
<ns2:Description> </ns2:Description>
<ns2:DepDate>2012-08-02</ns2:DepDate>
<ns2:Quantity>1</ns2:Quantity>
<ns2:Occupancy>1</ns2:Occupancy>
<ns2:RoomType>Single</ns2:RoomType>
<ns2:PickUpLocation/>
<ns2:PickUpTime>00:00:00</ns2:PickUpTime>
<ns2:Misc1/>
<ns2:Misc2/>
<ns2:ItemRemarks>save</ns2:ItemRemarks>
<ns2:Status>RQ</ns2:Status>
<ns2:Nights>4</ns2:Nights>
<ns2:NightFlag>0</ns2:NightFlag>
<ns2:Price>24.00</ns2:Price>
<ns2:SupplierRef/>
<ns2:ReportDate>2012-08-01</ns2:ReportDate>
<ns2:ItemChgFlag>1</ns2:ItemChgFlag>
<ns2:SubTotal>99.00</ns2:SubTotal>
</return>
</ns1:RetrieveInvoiceItemResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - No Item found
Description:
___________________________________________________________________________________________
RetrieveItem
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveItem | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ItemID | int | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:RetrieveItem soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<ItemID xsi:type="xsd:int">23</ItemID>
</php:RetrieveItem>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - No Item found
- Error - Reservation was not found/you don't have access to edit the reservation
Description:
___________________________________________________________________________________________
RetrieveItemsForReservation
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveItemsForReservation | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ReservationNumber | int | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:RetrieveItemsForReservation soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<ReservationNumber xsi:type="xsd:int">23</ReservationNumber>
</php:RetrieveItemsForReservation>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - Reservation was not found/you don't have access to edit this reservation
Description:
___________________________________________________________________________________________
RetrieveResByDate
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveResByDate | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | StartDate | string | 1 | Y | |
| 1 | EndDate | string | 1 | Y | |
| 1 | NumToShow | int | 1 | N | |
| 1 | ShowFrom | int | 1 | N | |
| 1 | ShowCX | int | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:RetrieveResByDate soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<StartDate xsi:type="xsd:string">2013-01-02</StartDate>
<EndDate xsi:type="xsd:string">2013-02-02</EndDate>
<NumToShow xsi:type="xsd:int"></NumToShow>
<ShowFrom xsi:type="xsd:int"></ShowFrom>
<ShowCX xsi:type="xsd:int"></ShowCX>
</php:RetrieveResByDate>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
Description:
___________________________________________________________________________________________
RetrieveResByDateRange
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveResByDateRange | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | StartDate | string | 1 | Y | |
| 1 | EndDate | string | 1 | Y | |
| 1 | NumToShow | int | 1 | N | |
| 1 | ShowFrom | int | 1 | N | |
| 1 | ShowCX | int | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:RetrieveResByDateRange soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<FromDate xsi:type="xsd:string">2012-01-01</FromDate>
<ToDate xsi:type="xsd:string">2013-02-01</ToDate>
<NumToShow xsi:type="xsd:int"></NumToShow>
<ShowFrom xsi:type="xsd:int"></ShowFrom>
<ShowCX xsi:type="xsd:int"></ShowCX>
</php:RetrieveResByDateRange>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - Invalid date
Description:
___________________________________________________________________________________________
RetrieveResByLastName
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveResByLastName | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | LastName | string | 1 | Y | |
| 1 | NumToShow | int | 1 | N | |
| 1 | ShowFrom | int | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:RetrieveResByLastName soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<LastName xsi:type="xsd:string">TEST</LastName>
<NumToShow xsi:type="xsd:int">3</NumToShow>
<ShowFrom xsi:type="xsd:int"></ShowFrom>
</php:RetrieveResByLastName>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - No Reservation found
Description:
___________________________________________________________________________________________
RetrieveResByThisAgency
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveResByThisAgency | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | NumToShow | int | 1 | N | |
| 1 | ShowFrom | int | 1 | N | |
| 1 | ShowCX | int | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:RetrieveResByThisAgency soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<NumToShow xsi:type="xsd:int"></NumToShow>
<ShowFrom xsi:type="xsd:int"></ShowFrom>
<ShowCX xsi:type="xsd:int"></ShowCX>
</php:RetrieveResByThisAgency>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
Description:
___________________________________________________________________________________________
RetrieveReservation
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveReservation | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | CityCode | string | 1 | Y | |
| 1 | ArrivalDate | string | 1 | Y | |
| 1 | Occupancy | int | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:PackageSearch soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<CityCode xsi:type="xsd:string">NYC</CityCode>
<ArrivalDate xsi:type="xsd:string">2013-01-21</ArrivalDate>
<Occupancy xsi:type="xsd:int">Single</Occupancy>
</php:PackageSearch>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - Reservation not found
- Error - Reservation does not belong to Agency: TEST
- Error - Invalid length for City Code - Maximum of 4 allowed
Description:
___________________________________________________________________________________________
RetrieveUserPref
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveUserPref | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:RetrieveUserPref soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
</php:RetrieveUserPref>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveUserPrefResponse | 1 | |||
| 1 | UserPreferenceInfo | 1 | |||
| 2 | AgencyName | string | 1 | Y | |
| 2 | UserName | string | 1 | Y | |
| 2 | FirstName | string | 1 | N | |
| 2 | LastName | string | 1 | N | |
| 2 | string | 1 | N | ||
| 2 | Language | string | 1 | N | |
| 2 | Hotels | string | 1 | N | |
| 2 | HotelImages | string | 1 | N | |
| 2 | RateDisplay | string | 1 | N | |
| 2 | DisplayPopup | string | 1 | N | |
| 2 | ExRate | float | 1 | N | |
| 2 | MarkupRate | float | 1 | N | |
| 2 | AllowBooking | int | 1 | Y | |
| 2 | LogoFileName | string | 1 | N | |
| 2 | Add1 | string | 1 | N | |
| 2 | Add2 | string | 1 | N | |
| 2 | City | string | 1 | N | |
| 2 | State | string | 1 | N | |
| 2 | Zip | string | 1 | N | |
| 2 | CountryName | string | 1 | N | |
| 2 | AgencyPhone | string | 1 | N | |
| 2 | AgencyFax | string | 1 | N |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:RetrieveUserPrefResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:UserPreferenceInfo>
<ns2:AgencyName/>
<ns2:UserName>TEST</ns2:UserName>
<ns2:FirstName>TEST</ns2:FirstName>
<ns2:LastName>TEAM-01</ns2:LastName>
<ns2:Email>test@example.com</ns2:Email>
<ns2:Language/>
<ns2:Hotels>N</ns2:Hotels>
<ns2:HotelImages>N</ns2:HotelImages>
<ns2:RateDisplay>A</ns2:RateDisplay>
<ns2:DisplayPopup>Y</ns2:DisplayPopup>
<ns2:ExRate>0</ns2:ExRate>
<ns2:MarkupRate>0</ns2:MarkupRate>
<ns2:AllowBooking>1</ns2:AllowBooking>
<ns2:LogoFileName>TEST.png</ns2:LogoFileName>
<ns2:Add1/>
<ns2:Add2/>
<ns2:City/>
<ns2:State/>
<ns2:Zip/>
<ns2:CountryName/>
<ns2:AgencyPhone/>
<ns2:AgencyFax/>
</ns2:UserPreferenceInfo>
</return>
</ns1:RetrieveUserPrefResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description:
___________________________________________________________________________________________
RetrieveVoucher
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | RetrieveVoucher | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | ReservationNumber | int | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:RetrieveVoucher soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<ReservationNumber xsi:type="xsd:int">23</ReservationNumber>
</php:RetrieveVoucher>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - Reservation not found
- Error - Reservation does not belong to Agency: TEST
Description:
___________________________________________________________________________________________
SaveRoomConfiguration
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | SaveRoomConfiguration | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | Resnum | string | 1 | Y | |
| 1 | Room1 | string | 1 | N | |
| 1 | Room2 | string | 1 | N | |
| 1 | Room3 | string | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:SaveRoomConfiguration soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<resnum xsi:type="xsd:string">23</resnum>
<room1 xsi:type="xsd:string"></room1>
<room2 xsi:type="xsd:string"></room2>
<room3 xsi:type="xsd:string"></room3>
</php:SaveRoomConfiguration>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | SaveRoomConfigurationResponse | 1 | |||
| 1 | Status | boolean | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:SaveRoomConfigurationResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:Status>true</ns2:Status>
</return>
</ns1:SaveRoomConfigurationResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
- Error - Please enter a valid Reservation Number
Description:
___________________________________________________________________________________________
SaveUserPref
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | SaveUserPref | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | FirstName | string | 1 | Y | |
| 1 | LastName | string | 1 | Y | |
| 1 | string | 1 | N | ||
| 1 | Language | string | 1 | N | |
| 1 | Hotel | string | 1 | N | |
| 1 | HotelImages | string | 1 | N | |
| 1 | RateDisplay | string | 1 | N | |
| 1 | DisplayPopup | string | 1 | N | |
| 1 | ExRate | float | 1 | N | |
| 1 | MarkupRate | float | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:SaveUserPref soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<FirstName xsi:type="xsd:string">TEST</FirstName>
<LastName xsi:type="xsd:string">TEST</LastName>
<Email xsi:type="xsd:string">test@example.com</Email>
<Language xsi:type="xsd:string">English</Language>
<Hotels xsi:type="xsd:string">N</Hotels>
<HotelImages xsi:type="xsd:string">TEST.png</HotelImages>
<RateDisplay xsi:type="xsd:string">A</RateDisplay>
<DisplayPopup xsi:type="xsd:string">A</DisplayPopup>
<ExRate xsi:type="xsd:float">0</ExRate>
<MarkupRate xsi:type="xsd:float">0</MarkupRate>
</php:SaveUserPref>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | SaveUserPrefResponse | 1 | |||
| 1 | Status | boolean | 1 | Y |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<ns1:SaveUserPrefResponse xmlns:ns1="http://www.wso2.org/php" xmlns:ns2="http://www.wso2.org/php/xsd">
<return>
<ns2:Status>true</ns2:Status>
</return>
</ns1:SaveUserPrefResponse>
</soapenv:Body>
</soapenv:Envelope>
Errors
- Error - Login Invalid
Description:
___________________________________________________________________________________________
ServiceSearch
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 | |
| 1 | ProductCode | string | 1 | Y | |
| 1 | ServiceDate | string | 1 | Y |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:ServiceSearch soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<CityCode xsi:type="xsd:string">NYC</CityCode>
<ProductCode xsi:type="xsd:string">NYCHPORTE</ProductCode>
<ServiceDate xsi:type="xsd:string">2013-01-01</ServiceDate>
</php:ServiceSearch>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - Invalid date
- Error - Invalid length for City Code - Maximum of 4 allowed
Description:
___________________________________________________________________________________________
ServiceSearch2
XML request
| Level | Name | Type | Occurs | Required | Comments |
|---|---|---|---|---|---|
| 0 | ServiceSearch2 | 1 | |||
| 1 | UserName | string | 1 | Y | |
| 1 | Password | string | 1 | Y | |
| 1 | CityCode | string | 1 | Y | |
| 1 | ProductCode | string | 1 | Y | |
| 1 | ServiceDate | string | 1 | Y | |
| 1 | ServiceType | string | 1 | N | |
| 1 | DisplayClodeOut | string | 1 | N | |
| 1 | DisplayOnRequest | string | 1 | N |
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:php="http://www.wso2.org/php">
<soapenv:Header/>
<soapenv:Body>
<php:ServiceSearch2 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<UserName xsi:type="xsd:string">username</UserName>
<Password xsi:type="xsd:string">Password</Password>
<CityCode xsi:type="xsd:string">NYC</CityCode>
<ServiceDate xsi:type="xsd:string">2013-01-01</ServiceDate>
<ServiceType xsi:type="xsd:string">Hotel</ServiceType>
<DisplayClosedOut xsi:type="xsd:string"></DisplayClosedOut>
<DisplayOnRequest xsi:type="xsd:string"></DisplayOnRequest>
</php:ServiceSearch2>
</soapenv:Body>
</soapenv:Envelope>
XML response
| Level | Name | Type | Occurs | Required | Comments |
|---|
Errors
- Error - Login Invalid
- Error - Invalid length for City Code - Maximum of 4 allowed
- Error - Invalid date
Description: