Transfer Availability Response is the message containing transfer availability and prices.
Transfer Availability response returns you only basic information about the transfer. To get full information about the transfer including text description, meeting point, images etc. you should send Transfer Descriptive Info Request to GP Travel HUB.
GP_TransferAvailRS*:
*mandatory
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
For more information see Common Data Description section in Glossary. | 0...1 | |||
0...99 | ||||
Represents one transfer from supplier. | 0...1 |
GP_TransferAvailRS/Transfers/Transfer:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
TransferCandidateRPH* | integer (1) | Identifies which <TransferCandidate> element from Availability request relates with the <Transfer> element in response. | 1..1 | |
Describes transfer rate. There could be several rates for the same transfer depending on vehicle type and other reasons. | 0..* | |||
Contains general information about the transfer. | 1..1 |
GP_TransferAvailRS/Transfers/Transfer/TransferRates/TransferRate:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
RateCode* | string (1 - 64) | Offer code as returned by supplier. | 1..1 | |
RateName* | string (1 - 255) | Offer name as returned by supplier. | 1..1 | |
PromotionCode | string(“DI”) | Indicates whether the offer comes from Dynamic Inventory. Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier. | 0..1 | |
AvailabilityStatus* | string ("AvailableForSale", "OnRequest") | Offer availability, whether it is immediately available (AvailableForSale) or on request (OnRequest). | 1...1 | |
BookingCode* | string | Contains unique ID of the offer. It is required for further reservation of this offer. | 1..1 | |
For more information see Common Data Description section in Glossary. | 1..1 | |||
Type* | string ("Group", "Individual", "UNKNOWN") | Identifies if the transfer is private (“Individual”) or public (“Group”) or undefined (“UNKNOWN”). | 1..1 | |
DriverLanguage |
|
| Language in which transfer is operated. | 0..1 |
Type* | string (“Undefined”,“Unescorted”,“Local”, “List”) | The next values are possible as Type options:
| 1...1 | |
DriverLanguage/LanguageList/Language |
|
|
| 0..* |
Code* | 2-character ISO language code | Language code in which transfer is operated. | 1..1 | |
Rates/Rate* | Specifies price breakdown per passenger type (adults, children, infants). | 1...* | ||
For more information see Common Data Description section in Glossary. | 1...1 | |||
RateSource* | string ("Calculated", "Provided") | Identifies whether this rate has been provided by supplier (“Provided”) or calculated by GP Hub (“Calculated”). | 1...1 | |
Rates/Rate/Total* | The total price of the offer per passenger type (after discount, if any has been applied). | 1...1 | ||
For more information see Common Data Description section in Glossary. | 1...1 | |||
1...1 | ||||
Rates/Rate/TotalRetail | The retail price of the offer per passenger type recommended by supplier (if applicable). | 0...1 | ||
For more information see Common Data Description section in Glossary. | 1...1 | |||
1...1 | ||||
|
| Additional services that can be booked with transfer. Note: Transfer Availability Response will return all services that can be booked. | 0..* | |
RateDescription | Rate name and description as returned by supplier. Can be empty. | 0...1 | ||
Name* | string | Name of the rate. | 1...1 | |
RateDescription/Text | string | Description of the rate. | 0...1 | |
For more information see Common Data Description section in Glossary. | 0..1 | |||
TransferDate* | Transfer start date or datetime. | 1..1 | ||
DateTime* | date or datetime | Can accept both DateTime and Date data values. Note: In most cases it is enough to provide transfer date to search for transfers. But some suppliers return more precise results if both date and time of transfer are specified. In that case set TransferDate/@DateTime value as DateTime (e.g. “2009-10-16T14:30:00”). In case departure point is Airport, the TransferDate/@DateTime value normally corresponds to flight’s arrival time. In case destination point is Airport, the TransferDate/@DateTime value normally corresponds to flight’s departure time. | 1..1 | |
Total* | Total offer price for all requested travelers. | 1...1 | ||
For more information see Common Data Description section in Glossary. | 1...1 | |||
1...1 | ||||
CommissionAmount | decimal | Contains supplier comission if supplier returns it. | 0…1 | |
CommissionPercent | decimal | Contains the commission percent. | 0…1 | |
Occupancy | Maximal available occupancy of this type of transfer. Includes number of passengers and luggage items. For example, for private car this will be 3 (excluding driver), for bigger cars and buses it could be up to 51 passenger. | 0..1 | ||
PaxQuantity | int (1 - 999) | Maximum number of passengers for chosen type of transfer. | 0..1 | |
BaggageQuantity | int (1 - 999) | Maximum number of luggage items for chosen type of transfer. | 0..1 | |
For more information see Transfer Charges section. Occurs only when @ShowCharges “true“ on Transfer Availability Request. | 0...* | |||
PersonName | Shows if it is enough to provide necessary information only for tour leader (Yes), or it is necessary to provide for all passengers (No), or both options are possible (Mixed). By default it is necessary to provide this information for all passenger (No). | 0...1 | ||
For more information see Common Data Description section in Glossary. | 1...1 | |||
CitizenCountryName | Identifies the rule, if it's necessary to provide country of domicile of each passenger, or only tour leader, or both variants are possible. Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier. | 0...1 | ||
For more information see Common Data Description section in Glossary. | 1...1 |
GP_TransferAvailRS/Transfers/Transfer/TransferRates/TransferRate/Services/Service:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
ServiceRPH | string (1 - 32) | Unique service identifier. | 0...1 | |
Inclusive | boolean (default - false) | Identifies whether the price for this service is included in the rate. | 0...1 | |
IsPerPerson | boolean (default - false) | Identifies if the service applied per transfer (false) or per person (true). | 0...1 | |
Quantity | integer (1 - 999) | Number of services available for booking. | 0...1 | |
Price |
|
| The price of the Service. | 0...99 |
MinAge | integer (0 - 999) | The minimum applicable age. | 0...1 | |
MaxAge | integer (0 - 999) | The maximum applicable age. | 0...1 | |
| For more information see Common Data Description section in Glossary. | 0...1 | ||
Price | Mandatory | boolean (default - false) | Identifies whether this service is mandatory for specified pax type (by AgeQualifyingCode or MinAge + MaxAge). | 0..1 |
Price/Base* |
|
| Contains the total amount charged for the service per person (if the IsPerPerson="true") or per transfer (if the IsPerPerson="false"). | 1...1 |
| For more information see Common Data Description section in Glossary. | 1...1 | ||
| 1...1 | |||
|
| Short name and description of the service. | 0...1 |
GP_TransferAvailRS/Transfers/Transfer/TransferRates/TransferRate/Services/Service/ServiceDetails:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
ShortName | string | Short name of the service. | 0...1 | |
ServiceDescription |
|
| Contains service description. | 0...1 |
| For more information see Common Data Description section in Glossary. | 0...1 | ||
ServiceDescription/Text |
| string | Contains service description text. | 0...1 |
GP_TransferAvailRS/Transfers/Transfer/BasicTransferInfo*:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
TransferCode* | string (1 - 32) | Transfer code as returned by supplier. | 1..1 | |
TransferName* | string (1 - 255) | Transfer name as returned by supplier. | 1..1 | |
TransferCodeContext* | string (1 - 32) | Supplier name who provides this transfer. | 1..1 | |
OperatedBy | string (1 - 255) | Indicates what exact company operates this transfer. | 0..1 | |
TransferDuration | double | Shows duration of transfer in hours. TransferDuration=”3.5” means that the transfer takes 3 hours and 30 minutes. | 0..1 | |
HotelCodeSupported* | boolean | Identifies if Hotel Code can be further submitted for transfer reservation. | 1..1 | |
AddressSupported* | boolean | Identifies if free Address can be further submitted for transfer reservation. | 1..1 | |
Categories/Category* |
|
| Contains transfer category as returned by supplier and mapped to the predefined list. None or several categories can be returned for one transfer. | 0...* |
| Code* | string | Contains the list of possible Transfer Categories. | 1...1 |
Categories/Category/Text* |
| string | Contains transfer category full text information provided by supplier. | 1...1 |
TransferDeparture* | Transfer’s departure point as it is provided as supplier’s offer. Attributes are the same as were specified in TransferDeparture element in Transfer Availability Request, but LocationCode is always in CodeContext of supplier. CodeContext is always supplier code as well. All attributes for this element are optional. | 1..1 | ||
TransferDeparture/Hotels/Hotel | Contains list of hotels which are actually departure points. Each hotel is represented by <Hotel> element. Attributes are the same as were specified in TransferDeparture/HotelRef element in Transfer Availability Request. Note: list of hotels only displayed when hotel code is required for transfer reservation, so this feature is supplier-specific. | 0..* | ||
TransferDestination* | Transfer’s destination point as it is provided as supplier’s offer. Attributes are the same as were specified in TransferDestination element in Transfer Availability Request. All attributes for this element are optional. | 1..1 | ||
TransferDestination/Hotels/Hotel | Contains list of hotels which are actually destination points. Each hotel is represented by <Hotel> element. Attributes are the same as were specified in TransferDeparture/HotelRef element in Transfer Availability Request. Note: list of hotels only displayed when hotel code is required for transfer reservation, so this feature is supplier-specific. | 0..* | ||
Text and visual description of the transfer. In Availability response only one <TextItem> (for short description) and one <ImageItem> (thumbnail image) elements will be presented. | 0...2 | |||
VendorMessages/VendorMessage | Important comments about transfer. | 0...99 | ||
Title | string | Refers to OTA Сode list Information Type “INF”’. | 0...1 | |
InfoType* | string | 1...1 | ||
VendorMessages/VendorMessage/SubSection/Paragraph* | Provides formatted textual information that a vendor wishes to make known. The type of information is indicated. | 1...1 | ||
0...1 | ||||
VendorMessages/VendorMessage/SubSection/Paragraph/Text | string | 0...1 |
GP_TransferAvailRS/Transfers/Transfer/BasicTransferInfo/MultimediaDescriptions/MultimediaDescription:
Element | Attribute | Type | Description | Min…Max occurs |
---|---|---|---|---|
ImageItems/ImageItem | A collection of image items. | 0...* | ||
ImageItems/ImageItem/ImageFormat/URL* | URI | Image URL. | 1...1 | |
ImageItems/ImageItem/Description | Short description of the image. | 0...1 | ||
Caption | string (1 - 128) | 0...1 | ||
TextItems/TextItem | A collection of text items. | 0...* | ||
Title | string (1 - 256) | The title of the multimedia object. | 0...1 | |
Category* | string | Refers to GP Travel HUB list "Text Category List". | 1...1 | |
TextItems/TextItem/Description* | Transfer description text. | 1...1 | ||
For more information see Common Data Description section in Glossary. | 0...1 |