15.3. COMMON DATA DESCRIPTION
- Yana Brilevskaya
Here you can find a description of elements and attributes which can appear in several messages to avoid duplication.
Element | Attribute | Type | Description | Min…Max occurs |
|---|---|---|---|---|
| AmountAfterTax | decimal | The price after taxes, if any has been applied. |
|
CurrencyCode | 3-character ISO currency code | The code of currency in which discount is nominated. |
| |
AmountBeforeTax | decimal | The price before taxes, if any has been applied; |
| |
Language | string (2 - 8) | Code of language used in the description. |
| |
PrimaryLangID | 2-character ISO language code | If supplier supports this language, human readable information will be returned on this language. If supplier does not support that language, the response will use default language. |
| |
RequestedCurrency | 3-character ISO currency code | Indicates desired currency to return prices in, if supported by supplier. It is not guaranteed, however, that prices will be returned in this currency, as this may depend on technical limitations of supplier and/or on commercial agreements with you and/or hotels. |
| |
SpecialServiceType | string ("Meal", "EarlyCheckIn", "LateCheckOut", "Supplement", "Bedding") | Specifies what service type client requires. |
| |
AgeQualifyingCode | integer (7 - infant, 8 - child, 10 - adult) | Specifies tourist age group. GP Travel HUB uses standard age qualifying OTA codes. |
| |
TimeSpan* |
|
| Specifies the period of stay. | 1...1 |
Start* | yyyy-mm-dd | Defines start day of stay. | 1...1 | |
End* | yyyy-mm-dd | Defines end day of stay. | 1...1 | |
Success |
|
| Identifies that the request was processed successfully. | 0…1 |
Warnings/Warning |
|
| Indicates a problem(s) occured during the request. Contains several elements. See more in ERROR HANDLING. | 0…1 |
ResGuests/ResGuest:
Element | Attribute | Type | Description | Min…Max occurs |
|---|---|---|---|---|
| AgeQualifyingCode* | integer (7, 8, 10) | Specifies tourist age group. GP Travel HUB uses standard age qualifying OTA codes. | 1...1 |
| ResGuestRPH* | integer | Shows in which room this guest should be allocated. This parameter should correspond to InvBlockCode in RoomRate. | 1...1 |
Profiles/ProfileInfo/UniqueID |
|
| A guest identifier. |
|
| ID | integer (default - 1) | Must start with 1 and must be unique within booking. Guest with ID="1" is marked as tour lead. | 0...1 |
| Type | integer (1) | The required attribute with fixed value "1". | 0...1 |
|
| Contains basic information about the customer. | 0...1 |
ResGuests/ResGuest/Profiles/ProfileInfo/Profile/Customer:
Element | Attribute | Type | Description | Min…Max occurs |
|---|---|---|---|---|
| BirthDate | yyyy-mm-dd | Mandatory for children and infants. | 0...1 |
PersonName/NamePrefix* |
| string ("Mr", "Ms", "Mrs") | Name prefix of the guest. | 1...1 |
PersonName/GivenName* |
| string (1-64) | Name of the guest, mandatory for TourLead, but could be optional for other guests if supplier allow that. | 1...1 |
PersonName/Surname* |
| string (1-64) | Surname of the guest, mandatory for TourLead, but could be optional for other guests if supplier allow that. | 1...1 |