UniversalRecordRetrieveRsp |
element |
|
|
|
Return a Universal Record |
CommandHistory |
string simple type |
|
Optional |
|
HTTP link to download command history and debugging information of the request that generated this response. Must be enabled on the system. |
ResponseTime |
decimal simple type |
|
Optional |
|
The time (in ms) the system spent processing this request, not including transmission times. |
TraceId |
string simple type |
|
Optional |
|
Unique identifier for this atomic transaction traced by the user. Use is optional. |
TransactionId |
string simple type |
|
Optional |
|
System generated unique identifier for this atomic transaction. |
Updated |
boolean simple type |
|
Optional |
false |
Returns true if the underlying
reservation has changed since it was
last accessed |
ResponseMessage |
element |
|
|
|
A simple textual fare note. Used within several other objects. |
Code |
decimal simple type |
|
Required |
|
|
Type |
string simple type |
Warning , Error , Info |
Optional |
|
Indicates the type of message (Warning, Error, Info) |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
UniversalRecord |
element |
|
|
|
Universal Record holds one or more provider reservations |
CreateDate |
dateTime simple type |
|
Optional |
|
The date and time that this reservation was created. |
LocatorCode |
string simple type |
|
Required |
|
Unique Identifier of a Universal Record. If this is ViewOnly UR then Locator Code is '999999'. |
LockReason |
string simple type |
|
Optional |
|
The reason for which the reservation is currently locked for modifications |
SavedTripLocatorCode |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Required |
|
|
Version |
integer simple type |
|
Optional |
|
|
LinkedUniversalRecord |
element |
|
|
|
|
Key |
string simple type |
|
Optional |
|
|
LocatorCode |
string simple type |
|
Required |
|
A Universal Record that need to be linked to the current Universal Record. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Group |
element |
|
|
|
Represents a traveler group for Group booking and
all their accompanying data. SUPPORTED PROVIDER: Worldspan. |
GroupSize |
nonNegativeInteger simple type |
|
Required |
|
Represents size of the group |
Key |
string simple type |
|
Optional |
|
|
TravelerType |
string simple type |
|
Optional |
|
Defines the type of traveler used for booking
which could be a non-defining type (Companion, Web-fare, etc), or a
standard type (Adult, Child, etc). |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Name |
element |
|
|
|
Name of the group in group booking. |
DeliveryInfo |
element |
|
|
|
Container to encapsulate all delivery related information |
SignatureRequired |
string simple type |
|
Optional |
|
Indicates whether a signature shoud be required in order to make the delivery. |
TrackingNumber |
string simple type |
|
Optional |
|
The tracking number of the shipping company making the delivery. |
Type |
string simple type |
|
Optional |
|
An arbitrary identifier to categorize this delivery info |
ShippingAddress |
element |
|
|
|
An arbitrary identifier to categorize this delivery info |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
Email |
element |
|
|
|
Container for an email address with a type specifier (max 128 chars) |
Comment |
string simple type |
|
Optional |
|
|
EmailID |
string simple type |
|
Required |
|
|
Key |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
GeneralRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
CreateDate |
dateTime simple type |
|
Optional |
|
The date and time that this GeneralRemark was created. |
Direction |
string simple type |
Incoming , Outgoing |
Optional |
|
Direction Incoming or Outgoing of the GeneralRemark. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
The type of product this reservation is relative to |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required, else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
SSRRef |
element |
|
|
|
Reference Element for SSR. |
Key |
string simple type |
|
Required |
|
|
Address |
typeStructuredAddress complex type |
|
|
|
|
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler. |
Key |
string simple type |
|
Required |
|
|
BookingTraveler |
element |
|
|
|
A traveler and all their accompanying data. |
NameNumber |
string simple type |
|
Optional |
|
Host Name Number |
Age |
decimal simple type |
|
Optional |
|
BookingTraveler age |
DOB |
date simple type |
|
Optional |
|
Traveler Date of Birth |
Gender |
string simple type |
|
Optional |
|
The BookingTraveler gender type |
Key |
string simple type |
|
Optional |
|
|
Nationality |
string simple type |
|
Optional |
|
Specify ISO country code for nationality of the Booking Traveler |
TravelerType |
string simple type |
|
Optional |
|
Defines the type of traveler used for booking which could be a non-defining type (Companion, Web-fare, etc), or a standard type (Adult, Child, etc). |
VIP |
boolean simple type |
|
Optional |
false |
When set to True indicates that the Booking Traveler is a VIP based on agency/customer criteria |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
BookingTravelerName |
element |
|
|
|
Complete name fields |
First |
string simple type |
|
Required |
|
First Name. |
Last |
string simple type |
|
Required |
|
Last Name. |
Middle |
string simple type |
|
Optional |
|
Midle name. |
Prefix |
string simple type |
|
Optional |
|
Name prefix. |
Suffix |
string simple type |
|
Optional |
|
Name suffix. |
DeliveryInfo |
element |
|
|
|
Container to encapsulate all delivery related information |
SignatureRequired |
string simple type |
|
Optional |
|
Indicates whether a signature shoud be required in order to make the delivery. |
TrackingNumber |
string simple type |
|
Optional |
|
The tracking number of the shipping company making the delivery. |
Type |
string simple type |
|
Optional |
|
An arbitrary identifier to categorize this delivery info |
ShippingAddress |
element |
|
|
|
An arbitrary identifier to categorize this delivery info |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
Email |
element |
|
|
|
Container for an email address with a type specifier (max 128 chars) |
Comment |
string simple type |
|
Optional |
|
|
EmailID |
string simple type |
|
Required |
|
|
Key |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
GeneralRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
CreateDate |
dateTime simple type |
|
Optional |
|
The date and time that this GeneralRemark was created. |
Direction |
string simple type |
Incoming , Outgoing |
Optional |
|
Direction Incoming or Outgoing of the GeneralRemark. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
The type of product this reservation is relative to |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required, else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
Email |
element |
|
|
|
Container for an email address with a type specifier (max 128 chars) |
Comment |
string simple type |
|
Optional |
|
|
EmailID |
string simple type |
|
Required |
|
|
Key |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
LoyaltyCard |
element |
|
|
|
Provider loyalty card information |
CardNumber |
string simple type |
|
Required |
|
|
FreeText |
string simple type |
|
Optional |
|
|
Level |
string simple type |
|
Optional |
|
|
MembershipStatus |
string simple type |
|
Optional |
|
|
PriorityCode |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Optional |
|
|
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
|
VendorLocationRef |
string simple type |
|
Optional |
|
|
AllianceLevel |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
MembershipProgram |
string simple type |
|
Optional |
|
Loyalty Program membership Id of the traveler specific to Amtrak(2V) Guest Rewards |
SupplierCode |
string simple type |
|
Required |
|
The code used to identify the Loyalty supplier, e.g. AA, ZE, MC |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationSpecificInfo |
typeProviderReservationSpecificInfo complex type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationLevel |
boolean simple type |
|
Optional |
|
If true means Loyalty card is applied at ProviderReservation level. |
ReservationLevel |
boolean simple type |
|
Optional |
|
If true means Loyalty card is applied at Universal Record Reservation level e.g. Hotel Reservation, Vehicle Reservation etc. |
OperatedBy |
element |
|
|
|
This is the carrier code to support Cross Accrual |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
DiscountCard |
element |
|
|
|
Rail Discount Card Information |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Number |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
SSR |
element |
|
|
|
Special serivces like wheel chair, or pet carrier. |
Carrier |
string simple type |
|
Optional |
|
|
CarrierSpecificText |
string simple type |
|
Optional |
|
Carrier specific information which are not captured in the FreeText field(not present in IATA's standard SSR DOCO format). An example is VISA Expiration Date. |
Description |
string simple type |
|
Optional |
|
|
FreeText |
string simple type |
|
Optional |
|
Certain SSR types will require a free text message. For example MAAS (Meet and assist). |
Key |
string simple type |
|
Optional |
|
|
PassiveSegmentRef |
string simple type |
|
Optional |
|
Reference to the passive segment. |
ProfileID |
string simple type |
|
Optional |
|
Key assigned for Secure Flight Document value from the specified profile |
ProfileSecureFlightDocKey |
string simple type |
|
Optional |
|
Unique ID of Booking Traveler's Profile that contains the Secure flight Detail |
ProviderDefinedType |
string simple type |
|
Optional |
|
Original Type as sent by the provider |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SSRRuleRef |
string simple type |
|
Optional |
|
UniqueID to associate a rule to the SSR |
SegmentRef |
string simple type |
|
Optional |
|
Reference to the air segment. May be required for some Types. |
Status |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Required |
|
Programmatic SSRs use codes recognized by the provider/supplier (example, VGML=vegetarian meal code). Manual SSRs do not have an associated programmatic code. |
URL |
anyURI simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
NameRemark |
element |
|
|
|
Text that support Name Remarks. |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
Key |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
AirSeatAssignment |
element |
|
|
|
Identifies the seat assignment for a passenger. |
FlightDetailsRef |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
RailCoachNumber |
string simple type |
|
Optional |
|
Coach number for which rail seatmap/coachmap is returned. |
Seat |
string simple type |
|
Required |
|
|
SeatTypeCode |
string simple type |
|
Optional |
|
The 4 letter SSR code like SMSW,NSSW,SMST etc. |
SegmentRef |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Required |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RailSeatAssignment |
element |
|
|
|
Identifies the seat assignment for a passenger on RailSegment. |
CoachNumber |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
RailSegmentRef |
string simple type |
|
Optional |
|
|
Seat |
string simple type |
|
Required |
|
|
Status |
string simple type |
|
Required |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Characteristic |
element |
|
|
|
Identifies the characteristics of the seat with seat type, value and description. |
SeatDescription |
string simple type |
|
Optional |
|
Description of the seat type. |
SeatType |
string simple type |
|
Optional |
|
Indicates codeset of values such as Seat Type like Place,Position, Smoking Choice, Place Arrangement, Place Direction, Compartment. |
SeatValue |
string simple type |
|
Optional |
|
Indicates the value specific to the selected type. |
SeatValueDescription |
string simple type |
|
Optional |
|
Description of the seat value. |
EmergencyInfo |
string simple type |
|
|
|
Description of the seat value. |
Address |
typeStructuredAddress complex type |
|
|
|
Description of the seat value. |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
DriversLicense |
element |
|
|
|
Details of drivers license |
Key |
string simple type |
|
Optional |
|
|
LicenseNumber |
string simple type |
|
Required |
|
The driving license number of the booking traveler. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AppliedProfile |
element |
|
|
|
A simple container to specify the profiles that were applied to a reservation. |
AccountID |
string simple type |
|
Optional |
|
The ID of the AccountProfile that was applied |
AccountName |
string simple type |
|
Optional |
|
The name from the AccountProfile that was applied |
ImmediateParentID |
string simple type |
|
Optional |
|
The ID of the immediate parent that was applied |
ImmediateParentName |
string simple type |
|
Optional |
|
The name of the immediate parent that was applied |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
TravelerID |
string simple type |
|
Optional |
|
The ID of the TravelerProfile that was applied |
TravelerName |
string simple type |
|
Optional |
|
The name from the TravelerProfile that was applied |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
CustomizedNameData |
element |
|
|
|
Customized Name Data is used to print customized name on the different documents. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
|
TravelComplianceData |
element |
|
|
|
Travel Compliance and Preferred Supplier information of the traveler specific to a segment. |
AirSegmentRef |
string simple type |
|
Optional |
|
Refers to Air Segment. Applicable only for Air. Ignored for others. |
Key |
string simple type |
|
Optional |
|
System generated key, returned back in the response. This can be used to modify or delete a saved TravelComplianceData. |
PassiveSegmentRef |
string simple type |
|
Optional |
|
Refers to Passive Segment. Applicable only for Passive. Ignored for others. |
RailSegmentRef |
string simple type |
|
Optional |
|
Refers to Rail Segment. Applicable only for Rail. Ignored for others. |
ReservationLocatorRef |
string simple type |
|
Optional |
|
This is returned in the response. Any input will be ignored for this attribute. This represents the association of Travel Compliance Data with the uAPI reservation locator code, mainly relevant to Hotel and Vehicle. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
PolicyCompliance |
element |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
InPolicy |
boolean simple type |
|
Required |
|
Policy Compliance Indicator. For In-Policy set to 'true', For Out-Of-Policy set to 'false''. |
PolicyToken |
string simple type |
|
Optional |
|
Optional text message to set the rule or token for which it's In Policy or Out Of Policy. |
ContractCompliance |
element |
|
|
|
Optional text message to set the rule or token for which it's In Policy or Out Of Policy. |
ContractToken |
string simple type |
|
Optional |
|
Optional text message to set the rule or token for which it's In Contract or Out Of Contract. |
InContract |
boolean simple type |
|
Required |
|
Contract Compliance Indicator. For In-Contract set to 'true', For Out-Of-Contract set to 'false'. |
PreferredSupplier |
element |
|
|
|
Contract Compliance Indicator. For In-Contract set to 'true', For Out-Of-Contract set to 'false'. |
Preferred |
boolean simple type |
|
Required |
|
Preferred Supplier - 'true', 'false'. |
ProfileType |
string simple type |
AgencyGroup , Agency , BranchGroup , Branch , Agent , Account , TravelerGroup , Traveler |
Required |
|
Indicate profile type. e.g. if Agency Preferred then pass Agency, if Traveler Preferred then pass Traveler. |
TravelInfo |
element |
|
|
|
Traveler information details like Travel Purpose and Trip Name |
TravelPurpose |
string simple type |
|
Optional |
|
Purpose of the trip |
TripName |
string simple type |
|
Optional |
|
Trip Name |
ServiceFeeInfo |
element |
|
|
|
Travel Agency Service Fees (TASF) are charged by the agency through BSP or Airline Reporting Corporation (ARC). |
BaseAmount |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes. |
BookingTravelerName |
string simple type |
|
Optional |
|
The name of the passenger. |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
Confirmation |
string simple type |
|
Optional |
|
The confirmation number of the service fee in the merchant host system. |
Description |
string simple type |
|
Optional |
|
The description of the service fee. |
Key |
string simple type |
|
Optional |
|
|
PassiveProviderReservationInfoRef |
string simple type |
|
Optional |
|
A reference to the passive provider reservation info to which the service is tied. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
A reference to the provider reservation info to which the service is tied. |
Status |
string simple type |
Issued , ReadyToIssue , IssueLater |
Optional |
|
Status of the service fee. Possible Values – Issued, ReadyToIssue, IssueLater. |
Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated Service Fee TaxInfo array for a breakdown of the individual taxes. |
TicketNumber |
string simple type |
|
Optional |
|
The ticket that this fee was issued in connection with. |
TotalAmount |
string simple type |
|
Optional |
|
The total amount for this Service Fee including base amount and all taxes. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
FormOfPayment |
element |
|
|
|
A Form of Payment used to purchase all or part of
a booking. |
AgentText |
string simple type |
|
Optional |
|
This is only relevent when IsAgentType is specified as true. Otherwise this will be ignored. |
ExternalReference |
string simple type |
|
Optional |
|
|
FulfillmentIDNumber |
string simple type |
|
Optional |
|
Identification number, e.g. card number, to define how the customer will identify himself when collecting the ticket |
FulfillmentIDType |
string simple type |
Bahn Card , Credit Card , Euro Cheque Card , Collection Reference |
Optional |
|
Identification type, e.g. credit card, to define how the customer will identify himself when collecting the ticket |
FulfillmentLocation |
string simple type |
|
Optional |
|
Information about the location of the printer. |
FulfillmentType |
string simple type |
|
Optional |
|
Defines how the client wishes to receive travel documents. Type does not define where or how payment is made. The supported values are "Ticket on Departure",
"Travel Agency",
"Courier",
"Standard Mail",
"Ticketless",
"Ticket Office",
"Express Mail",
"Corporate Kiosk",
"Train Station Service Desk",
"Direct Printing of Ticket",
"Ticket by Email",
"Digital Printing of Ticket at Home",
"Retrieve Ticket at Eurostar in London"
Collect booking ticket at a Kiosk, print in agency. |
IsAgentType |
boolean simple type |
|
Optional |
false |
If this is true then FormOfPayment mention in Type is anAgent type FormOfPayment. |
Key |
string simple type |
|
Optional |
|
|
ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
ProfileKey |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
Reusable |
boolean simple type |
|
Optional |
false |
Indicates whether the form of payment can be reused or not. Currently applicable for Credit and Debit form of payment |
ReuseFOP |
string simple type |
|
Optional |
|
Key of the FOP Key to be reused as this Form of Payment.Only Credit and Debit Card will be supported for FOP Reuse. |
Type |
string simple type |
|
Required |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
CreditCard |
element |
|
|
|
Container for all credit card information. |
AcceptanceOverride |
boolean simple type |
|
Optional |
|
Override airline restriction on the credit card. |
BankCountryCode |
string simple type |
|
Optional |
|
ISO Country code associated with the issuing bank |
BankName |
string simple type |
|
Optional |
|
Issuing bank name for this credit card |
BankStateCode |
string simple type |
|
Optional |
|
State code associated with the issuing bank. |
CustomerReference |
string simple type |
|
Optional |
|
Agencies use this to pass the traveler information to the credit card company. |
Enett |
boolean simple type |
|
Optional |
false |
Acceptable values are true or false. If set to true it will denote that the credit card used has been issued through Enett. For all other credit card payments this value will be set to false. |
ExtendedPayment |
string simple type |
|
Optional |
|
Used for American Express (AX) and other credit cards, e.g., Visa (VI) and Master card (CA), that allow Extended Payment, subject to the BSP market rule. |
ThirdPartyPayment |
boolean simple type |
|
Optional |
false |
If true, this indicates that the credit card holder is not one of the passengers. |
ApprovalCode |
string simple type |
|
Optional |
|
This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions. |
CVV |
string simple type |
|
Optional |
|
Card Verification Code |
ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
Name |
string simple type |
|
Optional |
|
The name as it appears on the card. |
Number |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type. |
Key |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
BillingAddress |
typeStructuredAddress complex type |
|
|
|
The address to where the billing statements
for this card are sent. Used for address verification purposes. |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
DebitCard |
element |
|
|
|
Container for all debit card information. |
ApprovalCode |
string simple type |
|
Optional |
|
This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions. |
CVV |
string simple type |
|
Optional |
|
Card Verification Code |
ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
Name |
string simple type |
|
Optional |
|
The name as it appears on the card. |
Number |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type. |
IssueNumber |
string simple type |
|
Optional |
|
Verification number for Debit Cards |
Key |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
BillingAddress |
typeStructuredAddress complex type |
|
|
|
The address to where the billing statements
for this card are sent. Used for address verification purposes. |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
EnettVan |
element |
|
|
|
Container for all eNett Van information. |
ExpiryDays |
duration simple type |
|
Optional |
|
The number of days from the VAN generation date that the VAN will be active for, after which the VAN cannot be used. |
MaxPercentage |
nonNegativeInteger simple type |
|
Optional |
|
The maximum percentage that will be applied on the Total price and sent to enett, which will denote the maximum authorized amount as approved by eNett. This value will be ignored and not used for Multi-Use VAN’s. |
MinPercentage |
nonNegativeInteger simple type |
|
Optional |
|
The minimum percentage that will be applied on the Total price and sent to enett,which will denote the minimum authorized amount approved by eNett.uApi will default this to zero for multi-use Van's. |
MultiUse |
boolean simple type |
|
Optional |
true |
Acceptable values are true or false. If set to true it will denote that the VAN being requested is multi-use else it will indicate a single -use VAN.A Single use VAN can only be debited once while the multiple use VAN's can be debited multiple times subjected to the maximum value it has been authorized for. The default value will be TRUE to indicate a multi-use VAN is being issued. |
Certificate |
element |
|
|
|
Certificate Form of Payment |
Amount |
string simple type |
|
Optional |
|
The monetary value of the certificate. |
DiscountAmount |
string simple type |
|
Optional |
|
The monetary discount amount of this certificate. |
DiscountPercentage |
decimal simple type |
|
Optional |
|
The percentage discount value of this certificate. |
NotValidAfter |
date simple type |
|
Optional |
|
The date that this certificate expires. |
NotValidBefore |
date simple type |
|
Optional |
|
The date that this certificate becomes valid. |
Number |
string simple type |
|
Required |
|
The Certificate number |
TicketNumber |
StringLength1to13 simple type |
|
|
|
The identifying number for the actual ticket |
Check |
element |
|
|
|
Check Form of Payment |
AccountNumber |
string simple type |
|
Optional |
|
The account number of the check |
CheckNumber |
string simple type |
|
Optional |
|
The sequential check number of the check. |
MICRNumber |
string simple type |
|
Optional |
|
Magnetic Ink Character Reader Number of check. |
RoutingNumber |
string simple type |
|
Optional |
|
The bank routing number of the check. |
Requisition |
element |
|
|
|
Requisition Form of Payment |
Category |
string simple type |
Government , Other |
Optional |
|
Classification Category for the requisition payment |
Number |
string simple type |
|
Optional |
|
Requisition number used for accounting |
Type |
string simple type |
Cash , Credit |
Optional |
|
Type can be Cash or Credit for category as Government |
MiscFormOfPayment |
element |
|
|
|
Miscellaneous Form of Payments |
AcceptanceOverride |
boolean simple type |
|
Optional |
|
Override airline restriction on the credit card. |
Category |
string simple type |
|
Required |
|
Indicates what Category the Miscellaneous Form Of Payment is being used for payment - The category may vary by GDS.Allowable values are
"Text"
"Credit"
"CreditCard"
"FreeFormCreditCard"
"Invoice"
"NonRefundable"
"MultipleReceivables"
"Exchange"
"Cash" |
CreditCardNumber |
string simple type |
|
Optional |
|
|
CreditCardType |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type or code which may not have been issued using the standard bank card types - i.e. an airline issued card |
ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
Text |
string simple type |
|
Optional |
|
Any free form text which may be associated with the Miscellaneous Form of Payment. This text may be provider or GDS specific |
AgencyPayment |
typeAgencyPayment complex type |
|
|
|
Container for Agency Payment |
AgencyBillingIdentifier |
string simple type |
|
Required |
|
Value of the billing id |
AgencyBillingNumber |
string simple type |
|
Optional |
|
Value of billing number |
AgencyBillingPassword |
string simple type |
|
Optional |
|
Value of billing password |
UnitedNations |
element |
|
|
|
United Nations Form of Payments |
Number |
string simple type |
|
Required |
|
|
DirectPayment |
element |
|
|
|
Direct Payment Form of Payments |
Text |
string simple type |
|
Optional |
|
|
AgentVoucher |
element |
|
|
|
Agent Voucher Form of Payments |
Number |
string simple type |
|
Required |
|
|
PaymentAdvice |
element |
|
|
|
Contains other form of payment for Cruise
Reservations |
DocumentNumber |
string simple type |
|
Required |
|
Payment Document Number Examples: 1234567890,
R7777 |
IssueCity |
string simple type |
|
Required |
|
City code of document issuance |
IssueDate |
date simple type |
|
Required |
|
Document Issuance date |
OriginalFOP |
string simple type |
|
Optional |
|
Original form of payment Examples: CHECK 3500 |
Type |
string simple type |
|
Required |
|
Other Payment Yype. Possible Values: AGC - Agency
Check, AGG - Agency Guarantee, AWC - Award Check, CSH - Cash
Equivalent, DBC - Denied Boarding Compensation, MCO -
Miscellaneous Charge Order, TOO - Tour Order, TOV - Tour Voucher |
ProviderReservationInfoRef |
typeFormOfPaymentPNRReference complex type |
|
|
|
Other Payment Yype. Possible Values: AGC - Agency
Check, AGG - Agency Guarantee, AWC - Award Check, CSH - Cash
Equivalent, DBC - Denied Boarding Compensation, MCO -
Miscellaneous Charge Order, TOO - Tour Order, TOV - Tour Voucher |
Key |
string simple type |
|
Optional |
|
Unique ID to identify a ProviderReservationInfo |
ProviderReservationLevel |
boolean simple type |
|
Optional |
true |
It means that the form of payment is applied at ProviderReservation level. |
SegmentRef |
typeGeneralReference complex type |
|
|
|
It means that the form of payment is applied at ProviderReservation level. |
Key |
string simple type |
|
Required |
|
|
BSPPayment |
element |
|
|
|
BSP form of payment.ACH Only |
BSPIdentifier |
string simple type |
|
Required |
|
Value of the BSP Direct Bill id |
BSPPassword |
string simple type |
|
Optional |
|
Value of the BSP Direct Bill id password |
ARCPayment |
element |
|
|
|
ARC form of payment.ACH Only |
ARCIdentifier |
string simple type |
|
Required |
|
Value of the ARC Direct Bill id |
ARCPassword |
string simple type |
|
Optional |
|
Value of the ARC Direct Bill id password |
ServiceFeeTaxInfo |
element |
|
|
|
The taxes associated to a particular Service Fee. |
Amount |
string simple type |
|
Required |
|
|
Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax code. |
CreditCardAuth |
element |
|
|
|
The result of a Credit Auth Request. Will contain all the authorization info and result codes. |
AVSResultCode |
string simple type |
|
Optional |
|
The address verification result code (if AVS was requested) |
Amount |
string simple type |
|
Required |
|
The amount that was authorized. |
AuthCode |
string simple type |
|
Optional |
|
The authorization code to confirm card acceptance |
AuthResultCode |
string simple type |
|
Required |
|
The result code of the authorization command. |
FormOfPaymentRef |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Message |
string simple type |
|
Optional |
|
The message explains the result of the authorization command. |
Number |
string simple type |
|
Optional |
|
|
PaymentRef |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
|
TransId |
string simple type |
|
Optional |
|
The transaction id from the credit processing system |
Payment |
element |
|
|
|
Payment information - must be used in conjunction with credit card info |
Amount |
string simple type |
|
Required |
|
|
AmountType |
string simple type |
|
Optional |
|
This field displays type of payment amount when it is non-monetary. Presently available/supported value is "Flight Pass Credits". |
ApproximateAmount |
string simple type |
|
Optional |
|
It stores the converted payment amount in agency's default currency |
BookingTravelerRef |
string simple type |
|
Optional |
|
If the type represents a per traveler payment, then this will reference the traveler this payment refers to. |
FormOfPaymentRef |
string simple type |
|
Required |
|
The credit card that is will be used to make this payment. |
Key |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Optional |
|
Status to indicate the business association of the payment element. |
Type |
string simple type |
AirlineFee , DeliveryFee , Itinerary , Passenger , ServiceFee , OptionalService , TicketFee |
Required |
|
Identifies the type of payment. This can be for an itinerary, a traveler, or a service fee for example. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
OSI |
element |
|
|
|
Other Service information sent to the carriers during air bookings |
Carrier |
string simple type |
|
Required |
|
|
Code |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this OSI is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
Text |
string simple type |
|
Required |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ActionStatus |
element |
|
|
|
Status of the action that will happen or has happened to the air reservation. One Action status for each provider reservation |
AccountCode |
string simple type |
|
Optional |
|
Used with TAW. Used to specify a corporate or in house account code to the PNR as part of ticketing arrangement field. |
AirportCode |
string simple type |
|
Optional |
|
Used with Time Limit to specify the airport location where the ticket is to be issued. |
Key |
string simple type |
|
Optional |
|
Identifies when the action type will happen, or
has happened according to the type. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
PseudoCityCode |
string simple type |
|
Optional |
|
The Branch PCC in the host system where PNR can be queued for ticketing. When used with TAU it will auto queue to Q10. When used with TAW agent performs manual move to Q. |
QueueCategory |
string simple type |
|
Optional |
|
Add Category placement to ticketing queue (required in 1P - default is 00) |
TicketDate |
string simple type |
|
Optional |
|
Identifies when the action type will happen, or
has happened according to the type. |
Type |
string simple type |
TAW , TTL , TLCXL , ACTIVE , CXL , TAU , TRH |
Required |
|
Identifies the type of action (if any) to take on this air reservation. Only TTL, TAU, TAX and TAW can be set by the user. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
Remark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfo |
element |
|
|
|
Provider Reservation informations |
CreateDate |
dateTime simple type |
|
Required |
|
The date and time that this reservation was
created. |
GroupRef |
string simple type |
|
Optional |
|
Represents a traveler group for Group booking and all their accompanying data. SUPPORTED PROVIDER: Worldspan. |
HostCreateDate |
date simple type |
|
Optional |
|
The date that this reservation was
created in the host system. |
HostCreateTime |
time simple type |
|
Optional |
|
The Time that this reservation was created in the host system for 1P. |
Imported |
boolean simple type |
|
Optional |
|
Identifies a reservation that was originally created elsewhere and imported into a Universal Record. |
InQueueMode |
boolean simple type |
|
Optional |
|
Identifies whether the gds pnr is being processed from the GDS queue. |
Key |
string simple type |
|
Required |
|
Key value of the provider reservation |
LocatorCode |
string simple type |
|
Required |
|
Contains the Locator Code of the actual
reservation in the event this is a passive
reservation. |
ModifiedDate |
dateTime simple type |
|
Required |
|
The date and time that this reservation was last
modified for any reason. |
OwningPCC |
string simple type |
|
Optional |
|
Indentifies the owning PCC of the PNR. PROVIDER SUPPORTED: Worldspan,Galileo and Apollo |
ProviderCode |
string simple type |
|
Required |
|
Contains the Provider Code of the entity housing
the actual reservation in the event this is a
passive one. |
TicketingModifiersRef |
string simple type |
|
Optional |
|
Reference to a Ticketing Modifers which is attached to this PNR. Ticketing Modifers referred by this Key is a Primary Ticketing
Modifers. Worldspan Primary DI line will be supported using this feature. |
AgentOverride |
string simple type |
|
Optional |
|
AgentSine value that was used during PNR creation or End Transact. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationDetails |
element |
|
|
|
Indicates the type of content in PNR,to retrieve the display only content use ProviderReservationDisplayDetailsReq |
Cruise |
boolean simple type |
|
Optional |
|
Cruise data exists. |
CustomCheck |
boolean simple type |
|
Optional |
|
Custom check data exists. |
DivideDetails |
boolean simple type |
|
Optional |
|
Divide Details data exists. |
EnhancedItinModifiers |
boolean simple type |
|
Optional |
|
Enhanced itinerary modifiers data exists |
IntegratedContent |
boolean simple type |
|
Optional |
|
Integrated content data exists |
ProviderProfile |
boolean simple type |
|
Optional |
|
Provider Profile data exists. |
ProviderReservationDetail |
boolean simple type |
|
Optional |
|
Provider Reservation data exists. |
RailSegment |
boolean simple type |
|
Optional |
|
Rail Segment data exists. |
ProviderReservationDisplayDetailsList |
element |
|
|
|
Response to display the addtional details of provider reservation information . |
DisplayDetails |
element |
|
|
|
The container to display the contents of PNR in GDS format. |
Cruise |
boolean simple type |
|
Optional |
|
Cruise data exists. |
CustomCheck |
boolean simple type |
|
Optional |
|
Custom check data exists. |
DivideDetails |
boolean simple type |
|
Optional |
|
Divide Details data exists. |
EnhancedItinModifiers |
boolean simple type |
|
Optional |
|
Enhanced itinerary modifiers data exists |
IntegratedContent |
boolean simple type |
|
Optional |
|
Integrated content data exists |
ProviderProfile |
boolean simple type |
|
Optional |
|
Provider Profile data exists. |
ProviderReservationDetail |
boolean simple type |
|
Optional |
|
Provider Reservation data exists. |
RailSegment |
boolean simple type |
|
Optional |
|
Rail Segment data exists. |
DisplayDetail |
element |
|
|
|
Display the contents for requested MCO,Cruise etc. details |
Name |
string simple type |
OwningAgencyPCC , CreatingAgentSignOn , CreatingAgentDuty , CreatingAgencyIATA , PrepaidTicketAdviceIndicator , BFBorrowed , GlobalPNR , ReadOnlyPNR , PastDateQuickRetrievedPNR , SuperPNR , PNRPurgeDate , OriginalReceivedFieldValue , DivPsgrName , TruncInd , DivTypeInd , RLoc , DivDt , DivTm , TravelOrder , SegmentStatus , StartDate , DayChange , Vendor , StartTime , EndTime , BookingCode , TrainNumber , NumberOfSeats , SellType , TariffType , ConfirmationNumber , BoardingInformation , ArrivalInformation , Text |
Required |
|
|
Value |
string simple type |
|
Required |
|
|
DisplayContents |
string simple type |
|
|
|
Display the contents in GDS format |
CreateDate |
string simple type |
|
Required |
|
The date and time that this reservation was created. |
CustomerNumber |
string simple type |
|
Optional |
|
|
LocatorCode |
string simple type |
|
Required |
|
The unique identifier for this reservation. If this is this View Only UR LocatorCode is '999999'. |
ModifiedDate |
string simple type |
|
Required |
|
The date and time that this reservation was last modified for any reason. |
CreateDate |
string simple type |
|
Required |
|
The date and time that this reservation was created. |
CustomerNumber |
string simple type |
|
Optional |
|
|
LocatorCode |
string simple type |
|
Required |
|
The unique identifier for this reservation. If this is this View Only UR LocatorCode is '999999'. |
ModifiedDate |
string simple type |
|
Required |
|
The date and time that this reservation was last modified for any reason. |
ModifiedDate |
string simple type |
|
|
|
The date and time that this reservation was last modified for any reason. |
CreateDate |
string simple type |
|
Required |
|
The date and time that this reservation was created. |
CustomerNumber |
string simple type |
|
Optional |
|
|
LocatorCode |
string simple type |
|
Required |
|
The unique identifier for this reservation. If this is this View Only UR LocatorCode is '999999'. |
ModifiedDate |
string simple type |
|
Required |
|
The date and time that this reservation was last modified for any reason. |
AccountingRemark |
element |
|
|
|
An accounting remark container to hold any
printable text. |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various
remarks. This is not required, but it is recommended. |
Key |
string simple type |
|
Optional |
|
|
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider
for which this accounting remark is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required,
else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
GeneralRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
CreateDate |
dateTime simple type |
|
Optional |
|
The date and time that this GeneralRemark was created. |
Direction |
string simple type |
Incoming , Outgoing |
Optional |
|
Direction Incoming or Outgoing of the GeneralRemark. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
The type of product this reservation is relative to |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required, else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
Restriction |
element |
|
|
|
Which activities are supported for a particular element |
Operation |
string simple type |
|
Required |
|
The operation that is restricted |
Reason |
string simple type |
|
Optional |
|
The reason it is restricted |
PassiveInfo |
element |
|
|
|
Used by CreateReservationReq for passing in elements normally found post-booking |
ProviderCode |
string simple type |
|
Optional |
|
|
ProviderLocatorCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
SupplierLocatorCode |
string simple type |
|
Optional |
|
|
TicketNumber |
string simple type |
|
|
|
|
ConfirmationNumber |
string simple type |
|
|
|
|
Commission |
element |
|
|
|
Identifies the agency commission |
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan |
Key |
string simple type |
|
Optional |
|
|
Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
OptionalServices |
element |
|
|
|
A wrapper for all the information regarding each
of the Optional services |
OptionalServicesTotal |
element |
|
|
|
The total fares, fees and taxes associated
with the Optional Services |
ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
TaxInfo |
typeTaxInfo complex type |
|
|
|
The tax information for a |
CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
FeeInfo |
typeFeeInfo complex type |
|
|
|
A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets |
Amount |
string simple type |
|
Required |
|
|
BaseAmount |
string simple type |
|
Optional |
|
|
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
FeeToken |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
|
PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
SubCode |
string simple type |
|
Optional |
|
|
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
Key |
string simple type |
|
Required |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
OptionalService |
element |
|
|
|
this attribute shows the amount included in the base fare for the specific fee or tax |
ApplicableFFLevel |
integer simple type |
|
Optional |
|
Numerical value of the loyalty card level for which this service is available. |
AssessIndicator |
string simple type |
MileageAndCurrency , MileageOrCurrency |
Optional |
|
Indicates whether price is assessed by mileage or currency or both |
Available |
boolean simple type |
|
Optional |
|
Boolean to describe whether the Service is
available for sale or not |
BaggageUnitPrice |
string simple type |
|
Optional |
|
The per unit price of baggage. Providers: 1G, 1V, 1P |
BookedQuantity |
string simple type |
|
Optional |
|
Indicates the Optional Service quantity already booked. Provider: 1G, 1V, 1P |
Chargeable |
string simple type |
|
Optional |
|
Indicates if the optional service is not offered, is available for a charge, or is included in the brand |
Confirmation |
string simple type |
|
Optional |
|
Confirmation number provided by the
supplier |
CreateDate |
dateTime simple type |
|
Optional |
|
Timestamp when this service/offer got
created. |
DisplayOrder |
integer simple type |
|
Optional |
|
Optional service group display order. |
DisplayText |
string simple type |
|
Optional |
|
Title of the Optional Service. Provider: ACH |
Entitled |
boolean simple type |
|
Optional |
|
Boolean to describe whether the passenger
is entitled for the service without charge or not |
ExcessWeightRate |
string simple type |
|
Optional |
|
The cost of the bag per unit weight. |
FirstPiece |
long simple type |
|
Optional |
|
Indicates the minimum occurrence of excess baggage.Provider: 1G, 1V, 1P. |
GeographySpecification |
string simple type |
|
Optional |
|
Sector, Portion, Journey. |
Group |
string simple type |
|
Optional |
|
Associates Optional Services with the same ServiceSub Code, Air Segment, Passenger, and EMD Associated Item. Provider:1G, 1V, 1P |
InclusiveOfTax |
boolean simple type |
|
Optional |
|
Identifies if the service was filed with a fee that is inclusive of tax. |
InterlineSettlementAllowed |
boolean simple type |
|
Optional |
|
Identifies if the interline settlement is allowed in service . |
IsPricingApproximate |
boolean simple type |
|
Optional |
|
When set to True indicates that the pricing returned is approximate. Supported providers are MCH/ACH |
IsRepriceRequired |
boolean simple type |
|
Optional |
false |
When set to “true”, the Optional Service must be re-priced. Provider: 1G, 1V, 1P |
IssuanceReason |
string simple type |
|
Optional |
|
A one-letter code specifying the reason for
issuance of the OptionalService |
Key |
string simple type |
|
Optional |
|
|
LastPiece |
long simple type |
|
Optional |
|
Indicates the maximum occurrence of excess baggage. Provider: 1G, 1V, 1P. |
Mileage |
decimal simple type |
|
Optional |
|
Indicates mileage fee/amount |
OptionalServicesRuleRef |
string simple type |
|
Optional |
|
UniqueID to associate a rule to the
Optional Service |
PaymentRef |
string simple type |
|
Optional |
|
Reference to a payment for merchandising
services. |
PerTraveler |
boolean simple type |
|
Optional |
true |
Boolean to describe whether the Amount on
the Service is charged per traveler. |
Priority |
decimal simple type |
|
Optional |
|
Numeric value that represents the priority
order of the Service |
Private |
boolean simple type |
|
Optional |
|
Describes if service is private or not. |
ProviderDefinedType |
string simple type |
|
Optional |
|
Original Type as sent by the provider |
PseudoCityCode |
string simple type |
|
Optional |
|
The PCC or SID that booked the Optional Service. |
PurchaseWindow |
string simple type |
BookingOnly , TicketingOnly , CheckInOnly , Anytime , PostTicketing |
Optional |
|
Describes when the Service is available
for confirmation or purchase (e.g. Booking Only, Check-in Only,
Anytime, etc.) |
Quantity |
decimal simple type |
|
Optional |
|
The number of units availed for each optional
service (e.g. 2 baggage availed will be specified as 2 in quantity
for optional service BAGGAGE) |
Restricted |
boolean simple type |
|
Optional |
false |
When set to “true”, the Optional Service is restricted by an embargo. Provider: 1G, 1V, 1P |
SSRCode |
string simple type |
|
Optional |
|
The SSR Code associated with the
OptionalService |
SSRFreeText |
string simple type |
|
Optional |
|
Certain SSR types sent in OptionalService SSRCode require a free text message. For example, PETC Pet in Cabin. |
SecondaryType |
string simple type |
|
Optional |
|
The secondary option code type required for
certain options |
SequenceNumber |
decimal simple type |
|
Optional |
|
The sequence number associated with the
OptionalService |
ServiceStatus |
string simple type |
|
Optional |
|
Specify the service status (e.g. active,
canceled, etc.) |
ServiceSubCode |
string simple type |
|
Optional |
|
The service subcode associated with the
OptionalService |
Source |
string simple type |
|
Optional |
|
The Source of the optional service. The source can be ACH, MCE, or MCH. |
Tag |
string simple type |
|
Optional |
|
Optional service group name. |
TotalWeight |
string simple type |
|
Optional |
|
The total weight of a bag. Providers: 1G, 1V, 1P |
Type |
string simple type |
|
Required |
|
Specify the type of service offered (e.g.
seats, baggage, etc.) |
ViewableOnly |
boolean simple type |
|
Optional |
|
Describes if the OptionalService is viewable only or not.
If viewable only then the service cannot be sold. |
WeightInExcess |
string simple type |
|
Optional |
|
The excess weight of a bag. Providers: 1G, 1V, 1P |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
ServiceData |
element |
|
|
|
The total price for this entity including base price and all taxes. |
AirSegmentRef |
string simple type |
|
Optional |
|
Reference to a segment if the merchandising offering only pertains to that segment. If no segment reference is present this means this offering is for the whole itinerary. |
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a passenger if the merchandising offering only pertains to that passenger. If no passenger reference is present this means this offering is for all passengers. |
Data |
string simple type |
|
Optional |
|
Data that specifies the details of the merchandising offering (e.g. seat number for seat service) |
EMDCouponRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD coupon issued. Supported providers are 1G/1V/1P |
EMDSummaryRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD issued. Supported providers are 1G/1V/1P |
StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
TravelerType |
string simple type |
|
Optional |
|
Passenger Type Code. |
SeatAttributes |
element |
|
|
|
Identifies the seat attribute of the service. |
SeatAttribute |
element |
|
|
|
Identifies the seat attribute of the service. |
Value |
string simple type |
|
Required |
|
|
CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
Type |
string simple type |
|
Required |
|
|
SSRRef |
typeKeyBasedReference complex type |
|
|
|
References to the related SSRs. At present, only reference to ASVC SSR is supported. Supported providers are 1G/1V/1P |
Key |
string simple type |
|
Required |
|
|
ServiceInfo |
element |
|
|
|
|
Description |
string simple type |
|
|
|
Description of the Service. Usually used in tandem with one or more media items. |
MediaItem |
element |
|
|
|
Photos and other media urls for the property referenced above. |
caption |
string simple type |
|
Optional |
|
|
height |
integer simple type |
|
Optional |
|
|
icon |
anyURI simple type |
|
Optional |
|
|
sizeCode |
string simple type |
|
Optional |
|
|
type |
string simple type |
|
Optional |
|
|
url |
anyURI simple type |
|
Optional |
|
|
width |
integer simple type |
|
Optional |
|
|
Remark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Key |
string simple type |
|
Optional |
|
|
TaxInfo |
typeTaxInfo complex type |
|
|
|
The tax information for a |
CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
FeeInfo |
typeFeeInfo complex type |
|
|
|
A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets |
Amount |
string simple type |
|
Required |
|
|
BaseAmount |
string simple type |
|
Optional |
|
|
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
FeeToken |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
|
PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
SubCode |
string simple type |
|
Optional |
|
|
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
Key |
string simple type |
|
Required |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
EMD |
element |
|
|
|
this attribute shows the amount included in the base fare for the specific fee or tax |
AssociatedItem |
string simple type |
|
Optional |
|
The type of Optional Service. The choices are Flight, Ticket, Merchandising, Rule Buster, Allowance, Chargeable Baggage, Carry On Baggage Allowance, Prepaid Baggage. Provider: 1G, 1V, 1P |
AvailabilityChargeIndicator |
string simple type |
X , E , F , G , H |
Optional |
|
A one-letter code specifying whether the service
is available or if there is a charge associated with it.
X = Service not available
F = No charge for service (free) and an EMD is not issued to
reflect free service
E = No charge for service (free) and an EMD is issued to reflect
the free service.
G = No charge for service (free), booking is not required and an
EMD is not issued to reflect free service
H = No charge for service (free), booking is not required, and an
EMD is issued to reflect the free service.
Blank = No application. Charges apply according to the data in the
Service Fee fields. |
Booking |
typeBooking simple type |
|
Optional |
|
Holds the booking description for the service, e.g., SSR. |
Commissionable |
boolean simple type |
|
Optional |
|
True/False value to whether or not the
service is comissionable. |
Date |
dateTime simple type |
|
Optional |
|
The date at which the service will be used. |
DisplayCategory |
typeDisplayCategory simple type |
|
Optional |
|
Describes when the service should be displayed. |
FulfillmentType |
integer simple type |
|
Optional |
|
A one digit code specifying how the service must be fulfilled.
See FulfillmentTypeDescription for the description of this value. |
FulfillmentTypeDescription |
string simple type |
|
Optional |
|
EMD description. |
Location |
typeIATACode simple type |
|
Optional |
|
3 letter location code where the service will be availed. |
MileageIndicator |
boolean simple type |
|
Optional |
|
True/False value to whether or not the
service has miles. |
RefundReissueIndicator |
string simple type |
Refundable , NonRefundable , Reuse |
Optional |
|
An attribute specifying whether the service is
refundable or reissuable. |
Reusable |
boolean simple type |
|
Optional |
|
Identifies if the service can be re-used towards a future purchase. |
BundledServices |
element |
|
|
|
Identifies if the service can be re-used towards a future purchase. |
BundledService |
element |
|
|
|
Displays the services bundled together |
Booking |
typeBooking simple type |
|
Optional |
|
Booking method for the bundled service, e..g SSR. |
Carrier |
string simple type |
|
Optional |
|
Carrier the service is applicable. |
CarrierSubCode |
boolean simple type |
|
Optional |
|
Carrier sub code. True means the carrier used their own sub code. False means the carrier used an ATPCO sub code |
Name |
string simple type |
|
Optional |
|
Name of the bundled service. |
Occurrence |
nonNegativeInteger simple type |
|
Optional |
|
How many of the service are included in the bundled service. |
ServiceSubCode |
string simple type |
|
Optional |
|
The sub code of the service, e.g. OAA for Pre paid baggage |
ServiceType |
string simple type |
|
Optional |
|
The type of service or what the service is used for, e.g. F type is flight type, meaning the service is used on a flight |
AdditionalInfo |
element |
|
|
|
The type of service or what the service is used for, e.g. F type is flight type, meaning the service is used on a flight |
Category |
string simple type |
|
Required |
|
The category code is the code the AdditionalInfo text came from, e.g. S5 or S7. |
FeeApplication |
element |
|
|
|
The category code is the code the AdditionalInfo text came from, e.g. S5 or S7. |
Code |
string simple type |
|
Optional |
|
The code associated to the fee application. The choices are: 1, 2, 3, 4, 5, K, F |
Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
PriceRange |
element |
|
|
|
|
DefaultCurrency |
boolean simple type |
|
Optional |
|
Indicates if the currency code of StartPrice / EndPrice is the default currency code |
EndPrice |
string simple type |
|
Optional |
|
Price range end value |
StartPrice |
string simple type |
|
Optional |
|
Price range start value |
TourCode |
element |
|
|
|
Tour Code Fare Basis |
Value |
string simple type |
|
Required |
|
|
BrandingInfo |
element |
|
|
|
Branding information for the Ancillary Service. Returned in Seat Map only. Providers: 1G, 1V, 1P, ACH |
Chargeable |
string simple type |
|
Optional |
|
Indicates if the optional service is not offered, is available for a charge, or is included in the brand. Providers: 1G, 1V, 1P, ACH |
CommercialName |
string simple type |
|
Required |
|
The commercial name of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
ExternalServiceName |
string simple type |
|
Optional |
|
The external name of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
Key |
string simple type |
|
Optional |
|
|
ServiceSubCode |
string simple type |
|
Optional |
|
The Service Sub Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
ServiceType |
string simple type |
|
Optional |
|
The type of Ancillary Service. Providers: 1G, 1V, 1P, ACH |
PriceRange |
element |
|
|
|
The type of Ancillary Service. Providers: 1G, 1V, 1P, ACH |
DefaultCurrency |
boolean simple type |
|
Optional |
|
Indicates if the currency code of StartPrice / EndPrice is the default currency code |
EndPrice |
string simple type |
|
Optional |
|
Price range end value |
StartPrice |
string simple type |
|
Optional |
|
Price range start value |
Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
Title |
typeTextElement complex type |
|
|
|
The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
ImageLocation |
element |
|
|
|
|
ImageHeight |
integer simple type |
|
Required |
|
The height of the image |
ImageWidth |
integer simple type |
|
Required |
|
The width of the image |
Type |
string simple type |
|
Required |
|
Type of Image Location. E.g., "Agent", "Consumer". |
ServiceGroup |
element |
|
|
|
The Service Group of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
Code |
string simple type |
|
Required |
|
The Service Group Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
ServiceSubGroup |
element |
|
|
|
The Service Sub Group of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
Code |
string simple type |
|
Optional |
|
The Service Sub Group Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
AirSegmentRef |
typeSegmentRef complex type |
|
|
|
Specifies the AirSegment the branding information is for. Providers: ACH, 1G, 1V, 1P |
Key |
string simple type |
|
Required |
|
|
Title |
typeTextElement complex type |
|
|
|
The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
GroupedOptionInfo |
element |
|
|
|
|
GroupedOption |
element |
|
|
|
|
OptionalServiceRef |
string simple type |
|
Required |
|
Reference to a optionalService which is paired with other optional services in the parent PairedOptions element. |
OptionalServiceRules |
ServiceRuleType complex type |
|
|
|
Holds the rules for selecting the optional
service in the itinerary |
Key |
string simple type |
|
Required |
|
Unique ID to identify an optional service rule |
ApplicationRules |
element |
|
|
|
The rules to apply the rule to the itinerary |
RequiredForAllSegments |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all segments in the itinerary if selected |
RequiredForAllSegmentsInOD |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all segments in a origin / destination (connection flights) if selected for one segment in the OD |
RequiredForAllTravelers |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all travelers in the itinerary if selected |
SecondaryOptionCodeRequired |
boolean simple type |
|
Optional |
|
If set to true, the secondary option code is required for this option |
UnselectedOptionRequired |
boolean simple type |
|
Optional |
|
If an UnselectedOption is present in the option, then the Unselected option needs to be selected even if the option is not selected when this flag is set to true |
ApplicationLevel |
element |
|
|
|
Lists the levels where the option is applied in the itinerary. Some options are applied for the entire itinerary, some for entire segments, etc. |
ApplicableLevels |
anonymous simple type |
|
Optional |
|
Indicates the level in the itinerary when the option is applied. |
ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
ApplicationLimits |
element |
|
|
|
Adds the limits on the number of options that can be selected for a particular type |
ApplicationLimit |
OptionalServiceApplicationLimitType complex type |
|
|
|
The application limits for a particular level |
ApplicableLevel |
string simple type |
Itinerary , Passenger , Segment , PassengerSegment , PassengerOD , Other |
Required |
|
Indicates the applicable level for the option |
MaximumQuantity |
nonNegativeInteger simple type |
|
Required |
|
The maximum quantity allowed for the type |
MinimumQuantity |
nonNegativeInteger simple type |
|
Optional |
|
Indicates the minimum number of the option that can be selected. |
ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
ServiceData |
element |
|
|
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
AirSegmentRef |
string simple type |
|
Optional |
|
Reference to a segment if the merchandising offering only pertains to that segment. If no segment reference is present this means this offering is for the whole itinerary. |
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a passenger if the merchandising offering only pertains to that passenger. If no passenger reference is present this means this offering is for all passengers. |
Data |
string simple type |
|
Optional |
|
Data that specifies the details of the merchandising offering (e.g. seat number for seat service) |
EMDCouponRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD coupon issued. Supported providers are 1G/1V/1P |
EMDSummaryRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD issued. Supported providers are 1G/1V/1P |
StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
TravelerType |
string simple type |
|
Optional |
|
Passenger Type Code. |
SeatAttributes |
element |
|
|
|
Identifies the seat attribute of the service. |
SeatAttribute |
element |
|
|
|
Identifies the seat attribute of the service. |
Value |
string simple type |
|
Required |
|
|
CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
Type |
string simple type |
|
Required |
|
|
SSRRef |
typeKeyBasedReference complex type |
|
|
|
References to the related SSRs. At present, only reference to ASVC SSR is supported. Supported providers are 1G/1V/1P |
Key |
string simple type |
|
Required |
|
|
ModifyRules |
element |
|
|
|
Groups the modification rules for the Option |
ProviderDefinedModificationType |
string simple type |
|
Optional |
|
Indicates the actual provider defined modification type which is mapped to Other |
SupportedModifications |
anonymous simple type |
|
Optional |
|
Lists the supported modifications for the itinerary. |
ModifyRule |
element |
|
|
|
Indicates modification rules for the particular modification type. |
AutomaticallyAppliedOnAdd |
boolean simple type |
|
Optional |
false |
Indicates if the option will be automatically added to new segments / passengers in the itinerary. |
CanAdd |
boolean simple type |
|
Optional |
|
Indicates if the option can be added to the itinerary without segment or passenger modification |
CanDelete |
boolean simple type |
|
Optional |
|
Indicates if the option can be deleted from the itinerary without segment or passenger modifications |
Modification |
NMTOKEN simple type |
AddSegment , RemoveSegment , ReplaceSegment , AddPassenger , RemovePassenger , OptionsOnly , Other |
Required |
|
The modificaiton for which this rule group applies. |
ProviderDefinedModificationType |
string simple type |
|
Optional |
|
Indicates the actual provider defined modification type which is mapped to Other |
Refundable |
boolean simple type |
|
Optional |
|
Indicates if the price of the option is refundable. |
SecondaryTypeRules |
element |
|
|
|
Lists the supported Secondary Codes for the optional / additional service. |
SecondaryTypeRule |
element |
|
|
|
Lists a single secondary code for the optional / additional service. |
SecondaryType |
string simple type |
|
Required |
|
The unique type to associate a secondary type in an optional service |
ApplicationLimit |
OptionalServiceApplicationLimitType complex type |
|
|
|
The unique type to associate a secondary type in an optional service |
ApplicableLevel |
string simple type |
Itinerary , Passenger , Segment , PassengerSegment , PassengerOD , Other |
Required |
|
Indicates the applicable level for the option |
MaximumQuantity |
nonNegativeInteger simple type |
|
Required |
|
The maximum quantity allowed for the type |
MinimumQuantity |
nonNegativeInteger simple type |
|
Optional |
|
Indicates the minimum number of the option that can be selected. |
ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
Remarks |
FormattedTextTextType complex type |
|
|
|
Adds text remarks / rules for the optional / additional service |
Formatted |
boolean simple type |
|
Optional |
|
Textual information, which may be formatted as a line of information, or unformatted, as a paragraph of text. |
TextFormat |
NMTOKEN simple type |
PlainText , HTML |
Optional |
|
Indicates the format of text used in the description e.g. unformatted or html. |
Language |
token simple type |
|
Optional |
|
Language identification. |
SupplierLocator |
element |
|
|
|
Locator code on the host carrier system |
CreateDateTime |
dateTime simple type |
|
Optional |
|
The Date and Time which the reservation is received from the Vendor as a SupplierLocator creation Date. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider Reservation reference |
SupplierCode |
string simple type |
|
Required |
|
Carrier Code |
SupplierLocatorCode |
string simple type |
|
Required |
|
Carrier reservation locator code |
SegmentRef |
typeGeneralReference complex type |
|
|
|
Air/Passive Segment Reference |
Key |
string simple type |
|
Required |
|
|
ThirdPartyInformation |
element |
|
|
|
Third party supplier locator information. Specifically applicable for SDK booking. |
Key |
string simple type |
|
Optional |
|
Unique identifier of the third party supplier. Key can be used to modify or delete saved third party information. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider Reservation reference |
ThirdPartyCode |
string simple type |
|
Optional |
|
Third party supplier code. |
ThirdPartyLocatorCode |
string simple type |
|
Optional |
|
Confirmation number for third party supplier. |
ThirdPartyName |
string simple type |
|
Optional |
|
Third party supplier name. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
SegmentRef |
typeGeneralReference complex type |
|
|
|
Air/Passive Segment Reference |
Key |
string simple type |
|
Required |
|
|
DocumentInfo |
element |
|
|
|
Container for the document information
summary line. |
TicketInfo |
element |
|
|
|
Container for the document information
summary line. |
AirPricingInfoRef |
string simple type |
|
Optional |
|
A reference to a AirPricing.Applicable Providers 1G and 1V. |
BookingTravelerRef |
string simple type |
|
Required |
|
A reference to a passenger. |
BulkTicket |
boolean simple type |
|
Optional |
|
Whether the ticket was issued as bulk. |
CountryCode |
string simple type |
|
Optional |
|
Contains Ticketed PCC’s Country code. |
IATANumber |
string simple type |
|
Optional |
|
|
Number |
string simple type |
|
Required |
|
|
Status |
string simple type |
U , T , V , R , X , Z , N , S |
Required |
|
|
TicketIssueDate |
dateTime simple type |
|
Optional |
|
|
TicketingAgentSignOn |
string simple type |
|
Optional |
|
|
Name |
element |
|
|
|
Complete name fields |
First |
string simple type |
|
Required |
|
First Name. Size can be up to 256 characters |
Last |
string simple type |
|
Required |
|
Last Name. Size can be up to 256 characters |
Middle |
string simple type |
|
Optional |
|
Midle name. Size can be up to 256 characters |
Prefix |
string simple type |
|
Optional |
|
Name prefix. Size can be up to 20 characters |
Suffix |
string simple type |
|
Optional |
|
Name suffix. Size can be up to 256 characters |
TravelerProfileId |
integer simple type |
|
Optional |
|
Traveler Applied Profile ID. |
ConjunctedTicketInfo |
element |
|
|
|
Traveler Applied Profile ID. |
CountryCode |
string simple type |
|
Optional |
|
Contains Ticketed PCC’s Country code. |
IATANumber |
string simple type |
|
Optional |
|
|
Number |
string simple type |
|
Required |
|
|
Status |
string simple type |
U , T , V , R , X , Z , N , S |
Required |
|
|
TicketIssueDate |
dateTime simple type |
|
Optional |
|
|
TicketingAgentSignOn |
string simple type |
|
Optional |
|
|
ExchangedTicketInfo |
element |
|
|
|
Contains Exchanged/Reissued Ticket Information |
Number |
string simple type |
|
Required |
|
Original Ticket that was Exchange/Reissued |
MCOInfo |
MCOInformation complex type |
|
|
|
Original Ticket that was Exchange/Reissued |
MCONumber |
string simple type |
|
Optional |
|
The unique MCO number |
MCOType |
string simple type |
|
Optional |
|
The Type of MCO. Once of Agency Fee, Airline Service Fee, or Residual value from an Exchange. |
Status |
string simple type |
|
Optional |
|
Current status of the MCO |
PassengerInfo |
element |
|
|
|
Booking Traveler information tied to invoice |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger related to a ticket. |
PassengerType |
string simple type |
|
Optional |
|
Passenger Type Code. |
Name |
element |
|
|
|
Complete name fields |
First |
string simple type |
|
Required |
|
First Name. Size can be up to 256 characters |
Last |
string simple type |
|
Required |
|
Last Name. Size can be up to 256 characters |
Middle |
string simple type |
|
Optional |
|
Midle name. Size can be up to 256 characters |
Prefix |
string simple type |
|
Optional |
|
Name prefix. Size can be up to 20 characters |
Suffix |
string simple type |
|
Optional |
|
Name suffix. Size can be up to 256 characters |
TravelerProfileId |
integer simple type |
|
Optional |
|
Traveler Applied Profile ID. |
TCRInfo |
element |
|
|
|
Traveler Applied Profile ID. |
Date |
dateTime simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Required |
|
Provider reservation reference key. |
Status |
string simple type |
Unknown , Confirmed , Refunded , Exchanged , Cancelled , Pending |
Required |
|
|
TCRNumber |
string simple type |
|
Required |
|
The identifying number for a Ticketless Air
Reservation. |
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
AirSegment |
typeBaseAirSegment complex type |
|
|
|
An Air marketable travel segment. |
Key |
string simple type |
|
Required |
|
|
Passive |
boolean simple type |
|
Optional |
|
|
ProviderSegmentOrder |
integer simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations in the provider reservation. |
Status |
string simple type |
|
Optional |
|
Status of this segment. |
TravelOrder |
decimal simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel segments/reservations based on travel dates. This ordering is applicable across the UR not provider or traveler specific |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
APISRequirementsRef |
string simple type |
|
Optional |
|
Reference to the APIS Requirements for
this AirSegment. |
AvailabilitySource |
string simple type |
|
Optional |
|
Indicates Availability source of
AirSegment. |
BlackListed |
boolean simple type |
|
Optional |
|
Indicates blacklisted carriers which are banned from servicing points to, from and within the European Community. |
BookingDate |
date simple type |
|
Optional |
|
Used for rapid reprice. The date the booking was made.
Providers: 1G/1V/1P/1S/1A |
BrandIndicator |
string simple type |
|
Optional |
|
Value “B” specifies that the carrier supports Rich Content and Branding. The Brand Indicator is only returned in the availability search response. Provider: 1G, 1V, 1P, ACH |
CabinClass |
string simple type |
|
Optional |
|
Specifies Cabin class for a group of
class of services. Cabin class is not identified if it is not
present. |
Carrier |
string simple type |
|
Optional |
|
The carrier that is marketing this segment |
ChangeOfPlane |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
planes between flights. |
ClassOfService |
string simple type |
|
Optional |
|
|
ETicketability |
string simple type |
Yes , No , Required , Ticketless |
Optional |
|
Identifies if this particular segment
is E-Ticketable |
Equipment |
string simple type |
|
Optional |
|
Identifies the equipment that this
segment is operating under. |
FlightNumber |
string simple type |
|
Optional |
|
The flight number under which the marketing
carrier is marketing this flight |
FlownSegment |
boolean simple type |
|
Optional |
false |
Used for rapid reprice. Tells whether or not the air segment has been flown.
Providers: 1G/1V/1P/1S/1A |
Group |
long simple type |
|
Required |
|
The Origin Destination Grouping of this
segment. |
GuaranteedPaymentCarrier |
string simple type |
|
Optional |
|
Identifies that this segment has
Guaranteed Payment Carrier. |
HostTokenRef |
string simple type |
|
Optional |
|
Identifies that this segment has
Guaranteed Payment Carrier. |
MarriageGroup |
long simple type |
|
Optional |
|
Identifies this segment as being a
married segment. It is paired with other segments of the same
value. |
NumberInParty |
positiveInteger simple type |
|
Optional |
|
Number of person traveling in this air segment excluding the number of infants on lap. |
NumberOfStops |
long simple type |
|
Optional |
|
Identifies the number of stops for
each within the segment. |
OpenSegment |
boolean simple type |
|
Optional |
|
Indicates OpenSegment when True |
OperationalStatus |
string simple type |
|
Optional |
|
Refers to the flight operational status for the segment.
This attribute will only be returned in the AvailabilitySearchRsp and not used/returned in any other request/responses.
If this attribute is not returned back in the response, it means the flight is operational and not past scheduled departure. |
OptionalServicesIndicator |
boolean simple type |
|
Optional |
|
Indicates true if flight provides
optional services. |
PassiveProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
RailCoachNumber |
string simple type |
|
Optional |
|
Coach number for which rail seatmap/coachmap is returned. |
ScheduleChange |
boolean simple type |
|
Optional |
false |
Used for rapid reprice. Tells whether or not the air segment had a
schedule change by the carrier. This tells rapid reprice that the change in the air
segment was involuntary and because of a schedule change, not because the user is
changing the segment. Providers: 1G/1V/1P/1S/1A |
Seamless |
boolean simple type |
|
Optional |
|
Identifies that this segment was sold
via a direct access channel to the marketing carrier. |
AvailabilityDisplayType |
string simple type |
|
Optional |
|
The type of availability from which the segment is sold.Possible Values (List):
G - General
S - Flight Specific
L - Carrier Specific/Direct Access
M - Manual Sell
F - Fare Shop/Optimal Shop
Q - Fare Specific Fare Quote unbooked
R - Redemption Availability used to complete the sell. Supported Providers: 1G,1V. |
LinkAvailability |
boolean simple type |
|
Optional |
|
Indicates if carrier has link (carrier
specific) display option. |
ParticipantLevel |
string simple type |
|
Optional |
|
Type of sell agreement between host and link
carrier. |
PolledAvailabilityOption |
string simple type |
|
Optional |
|
Indicates if carrier has Inside
(polled)Availability option. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ArrivalTime |
string simple type |
|
Optional |
|
The date and time at which this entity arrives at the destination. Date and time are represented as Airport Local Time at the place of arrival. The correct time zone offset is also included. |
DepartureTime |
string simple type |
|
Optional |
|
The date and time at which this entity departs. Date and time are represented as Airport Local Time at the place of departure. The correct time zone offset is also included. |
Destination |
string simple type |
|
Required |
|
The IATA location code for this destination of this entity. |
Origin |
string simple type |
|
Required |
|
The IATA location code for this origination of this entity. |
Distance |
decimal simple type |
|
Optional |
|
The distance traveled. Units are specified in the parent response element. |
FlightTime |
decimal simple type |
|
Optional |
|
Time spent (minutes) traveling in flight, including airport taxi time. |
TravelTime |
decimal simple type |
|
Optional |
|
Total time spent (minutes) traveling including flight time and ground time. |
SegmentRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Key |
string simple type |
|
Required |
|
|
SponsoredFltInfo |
element |
|
|
|
This describes whether the segment is determined to be a sponsored flight. The SponsoredFltInfo node will only come back for Travelport UIs and not for other customers. |
FltKey |
string simple type |
|
Required |
|
The unique identifying key for the sponsored flight. |
NeutralLNB |
integer simple type |
|
Required |
|
The neutral line number for the flight item. |
SponsoredLNB |
integer simple type |
|
Required |
|
The line number of the sponsored flight item |
CodeshareInfo |
element |
|
|
|
Describes the codeshare disclosure (simple
text string) or the specific operating flight information (as
attributes). |
OperatingCarrier |
string simple type |
|
Optional |
|
The actual carrier that is operating the
flight. |
OperatingFlightNumber |
string simple type |
|
Optional |
|
The actual flight number of the carrier that
is operating the flight. |
AirAvailInfo |
element |
|
|
|
Matches class of service information with
availability counts. Only provided on search results. |
HostTokenRef |
string simple type |
|
Optional |
|
|
ProviderCode |
string simple type |
|
Optional |
|
|
BookingCodeInfo |
element |
|
|
|
Details Cabin class info and class of
service information with availability counts. Only provided on
search results and grouped by Cabin class |
BookingCounts |
string simple type |
|
Optional |
|
Lists class of service and their counts for
specific cabin class |
CabinClass |
string simple type |
|
Optional |
|
Specifies Cabin class for a group of
class of services. Cabin class is not identified if it is not
present. |
FareTokenInfo |
element |
|
|
|
Associates Fare with HostToken |
FareInfoRef |
string simple type |
|
Required |
|
|
HostTokenRef |
string simple type |
|
Required |
|
|
FlightDetails |
element |
|
|
|
Specific details within a flight segment. |
AutomatedCheckin |
boolean simple type |
|
Optional |
false |
“True” indicates that the flight allows automated check-in. The default is “False”. |
DestinationTerminal |
string simple type |
|
Optional |
|
|
Equipment |
string simple type |
|
Optional |
|
|
GroundTime |
decimal simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
OnTimePerformance |
decimal simple type |
|
Optional |
|
Represents flight on time performance
as a percentage from 0 to 100 |
OriginTerminal |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Distance |
decimal simple type |
|
Optional |
|
The distance traveled. Units are specified in the parent response element. |
FlightTime |
decimal simple type |
|
Optional |
|
Time spent (minutes) traveling in flight, including airport taxi time. |
TravelTime |
decimal simple type |
|
Optional |
|
Total time spent (minutes) traveling including flight time and ground time. |
ArrivalTime |
string simple type |
|
Optional |
|
The date and time at which this entity arrives at the destination. Date and time are represented as Airport Local Time at the place of arrival. The correct time zone offset is also included. |
DepartureTime |
string simple type |
|
Optional |
|
The date and time at which this entity departs. Date and time are represented as Airport Local Time at the place of departure. The correct time zone offset is also included. |
Destination |
string simple type |
|
Required |
|
The IATA location code for this destination of this entity. |
Origin |
string simple type |
|
Required |
|
The IATA location code for this origination of this entity. |
Connection |
element |
|
|
|
Flight Connection Information |
ChangeOfAirport |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
airports between flights. |
ChangeOfPlane |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
planes between flights. |
ChangeOfTerminal |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
terminals between flights. |
Duration |
long simple type |
|
Optional |
|
The actual duration (in minutes) between
flights. |
FlightDetailsIndex |
long simple type |
|
Optional |
|
The sequential FlightDetails number that this
connection information applies to. |
IncludeStopOverToFareQuote |
string simple type |
NoStopOver , StopOver , IgnoreSegment |
Optional |
|
The field determines to quote fares with or
without stop overs,the values can be NoStopOver,StopOver and
IgnoreSegment. |
MinConnectionTime |
long simple type |
|
Optional |
|
The minimum time needed to connect between the
two different destinations. |
SegmentIndex |
long simple type |
|
Optional |
|
The sequential AirSegment number that this
connection information applies to. |
StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
FareNote |
element |
|
|
|
A simple textual fare note. Used within several
other objects. |
FareInfoMessageRef |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
NoteName |
string simple type |
|
Optional |
|
|
Precedence |
decimal simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Meals |
typeMealService simple type |
|
|
|
Available Meal Service. |
InFlightServices |
string simple type |
|
|
|
Available InFlight Services. They are: 'Movie', 'Telephone', 'Telex', 'AudioProgramming', 'Television' ,'ResvBookingService' ,'DutyFreeSales' ,'Smoking' ,'NonSmoking' ,'ShortFeatureVideo' ,'NoDutyFree' ,'InSeatPowerSource' ,'InternetAccess' ,'Email' ,'Library' ,'LieFlatSeat' ,'Additional service(s) exists' ,'WiFi' ,'Lie-Flat seat first' ,'Lie-Flat seat business' ,'Lie-Flat seat premium economy' ,'Amenities subject to change' etc.. These follow the IATA standard. Please see the IATA standards for a more complete list. |
FlightDetailsRef |
element |
|
|
|
Reference to a complete FlightDetails from
a shared list |
Key |
string simple type |
|
Required |
|
|
AlternateLocationDistanceRef |
element |
|
|
|
Reference to a AlternateLocationDistance |
Key |
string simple type |
|
Required |
|
|
Connection |
element |
|
|
|
Flight Connection Information |
ChangeOfAirport |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
airports between flights. |
ChangeOfPlane |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
planes between flights. |
ChangeOfTerminal |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
terminals between flights. |
Duration |
long simple type |
|
Optional |
|
The actual duration (in minutes) between
flights. |
FlightDetailsIndex |
long simple type |
|
Optional |
|
The sequential FlightDetails number that this
connection information applies to. |
IncludeStopOverToFareQuote |
string simple type |
NoStopOver , StopOver , IgnoreSegment |
Optional |
|
The field determines to quote fares with or
without stop overs,the values can be NoStopOver,StopOver and
IgnoreSegment. |
MinConnectionTime |
long simple type |
|
Optional |
|
The minimum time needed to connect between the
two different destinations. |
SegmentIndex |
long simple type |
|
Optional |
|
The sequential AirSegment number that this
connection information applies to. |
StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
FareNote |
element |
|
|
|
A simple textual fare note. Used within several
other objects. |
FareInfoMessageRef |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
NoteName |
string simple type |
|
Optional |
|
|
Precedence |
decimal simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
SellMessage |
string simple type |
|
|
|
Sell Message from Vendor. This is applicable in response messages only, any input in request message will be ignored. |
RailCoachDetails |
element |
|
|
|
Sell Message from Vendor. This is applicable in response messages only, any input in request message will be ignored. |
AvailableRailSeats |
string simple type |
|
Optional |
|
Number of available seats present in this rail coach. |
RailCoachNumber |
string simple type |
|
Optional |
|
Rail coach number for the returned coach details. |
RailSeatMapAvailability |
boolean simple type |
|
Optional |
|
Indicates if seats are available in this rail coach which can be mapped. |
SvcSegment |
element |
|
|
|
Service segment added to collect additional fee. 1P only |
BookingTravelerRef |
string simple type |
|
Optional |
|
|
Carrier |
string simple type |
|
Optional |
|
The platting carrier |
Destination |
string simple type |
|
Optional |
|
Destination location - Airport code. 1P only. |
EMDNumber |
string simple type |
|
Optional |
|
Generated EMD number, if EMD is issued on the SVC |
Fee |
string simple type |
|
Optional |
|
The fee to be collected using SVC segment |
Key |
string simple type |
|
Required |
|
The Key of SVC Segment. |
NumberOfItems |
decimal simple type |
|
Optional |
|
|
Origin |
string simple type |
|
Optional |
|
Origin location - Airport code. 1P only. |
RFIC |
string simple type |
|
Optional |
|
1P - Reason for issuance |
RFISC |
string simple type |
|
Optional |
|
1P - Resaon for issuance sub-code |
StartDate |
date simple type |
|
Optional |
|
Start date of the segment. Generally it is the
next date after the last air segment. 1P only |
Status |
string simple type |
|
Optional |
|
|
SvcDescription |
string simple type |
|
Optional |
|
1P - SVC fee description |
TravelOrder |
decimal simple type |
|
Optional |
|
To identify the appropriate travel sequence for
Air/Car/Hotel/Passive segments/reservations based on travel dates.
This ordering is applicable across the UR not provider or traveler
specific |
AirPricingInfo |
element |
|
|
|
Per traveler type pricing breakdown. This will
reflect the pricing for all travelers of the specified type. |
AirPricingInfoGroup |
long simple type |
|
Optional |
|
This attribute is added to support multiple
store fare in Host. All AirPricingInfo with same group number will
be stored together. |
AmountType |
string simple type |
|
Optional |
|
This field displays type of payment amount when it is non-monetary. Presently available/supported value is "Flight Pass Credits". |
Cat35Indicator |
boolean simple type |
|
Optional |
|
A true value indicates that the fare has a Cat35 rule.
A false valud indicates that the fare does not have a Cat35 rule |
Checksum |
string simple type |
|
Optional |
|
A security value used to guarantee that the
pricing data sent in matches the pricing data previously returned |
CommandKey |
string simple type |
|
Optional |
|
The command identifier used when this is in
response to an AirPricingCommand. Not used in any request
processing. |
Destination |
string simple type |
|
Optional |
|
The IATA location code for this destination of this entity. |
ETicketability |
string simple type |
Yes , No , Required , Ticketless |
Optional |
|
The E-Ticketability of this AirPricing |
ExchangeAmount |
string simple type |
|
Optional |
|
The amount to pay to cover the exchange of the
fare (includes penalties). |
Exchangeable |
boolean simple type |
|
Optional |
|
Indicates whether the fare is
exchangeable |
FareCalculationInd |
string simple type |
|
Optional |
|
Fare calculation that was used to price the itinerary. |
ForfeitAmount |
string simple type |
|
Optional |
|
The amount forfeited when the fare is
exchanged. |
IncludesVAT |
boolean simple type |
|
Optional |
|
Indicates whether the Base Price
includes VAT. |
Key |
string simple type |
|
Required |
|
|
LatestTicketingTime |
string simple type |
|
Optional |
|
The latest date/time at which this pricing
information is valid |
Origin |
string simple type |
|
Optional |
|
The IATA location code for this origination of this entity. |
PlatingCarrier |
string simple type |
|
Optional |
|
The Plating Carrier for this journey |
PricingMethod |
string simple type |
Auto , Manual , ManualFare , Guaranteed , Invalid , Restored , Ticketed , Unticketable , Reprice , Expired , AutoUsingPrivateFare , GuaranteedUsingAirlinePrivateFare , Airline , AgentAssisted , VerifyPrice , AltSegmentRemovedReprice , AuxiliarySegmentRemovedReprice , DuplicateSegmentRemovedReprice , Unknown , GuaranteedUsingAgencyPrivateFare , AutoRapidReprice |
Required |
|
|
PricingType |
string simple type |
|
Optional |
|
Indicates the Pricing Type used.
The possible values are TicketRecord, StoredFare, PricingInstruction. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
Refundable |
boolean simple type |
|
Optional |
|
Indicates whether the fare is refundable |
Ticketed |
boolean simple type |
|
Optional |
|
Indicates if the associated stored fare
is ticketed or not. |
TotalNetPrice |
string simple type |
|
Optional |
|
The total price of a negotiated fare. |
TrueLastDateToTicket |
string simple type |
|
Optional |
|
This date indicates the true last date/time to ticket for the fare. This date comes from the filed fare . There is no guarantee the fare will still be available on that date or that the fare amount may change.
It is merely the last date to purchase a ticket based on the carriers fare rules at the time the itinerary was quoted and stored |
InPolicy |
boolean simple type |
|
Optional |
|
This attribute will be used to indicate if a fare or rate has been determined to be ‘in policy’ based on the associated policy settings. |
PreferredOption |
boolean simple type |
|
Optional |
|
This attribute is used to indicate if the vendors responsible for the fare or rate being returned have been determined to be ‘preferred’ based on the associated policy settings. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
FareInfo |
element |
|
|
|
Information about this fare component |
Amount |
string simple type |
|
Optional |
|
|
BulkTicket |
boolean simple type |
|
Optional |
|
Whether the ticket can be issued as bulk for this
fare. Providers supported: Worldspan |
CarCode |
string simple type |
|
Optional |
|
|
DepartureDate |
date simple type |
|
Optional |
|
Returns the departure date of the first
segment of the journey. |
Destination |
string simple type |
|
Required |
|
Returns the airport or city code that
defines the destination market for this fare. |
EffectiveDate |
string simple type |
|
Required |
|
Returns the date on which this fare was
quoted |
FareBasis |
string simple type |
|
Required |
|
The fare basis code for this fare |
FareFamily |
string simple type |
|
Optional |
|
An alpha-numeric string which denotes fare
family. Some carriers may return this in lieu of or in addition to
the CabinClass. |
InclusiveTour |
boolean simple type |
|
Optional |
|
Whether the ticket can be issued as part of
included package for this fare. Providers supported: Worldspan |
Key |
string simple type |
|
Required |
|
|
NegotiatedFare |
boolean simple type |
|
Optional |
|
Identifies the fare as a Negotiated
Fare. |
NotValidAfter |
date simple type |
|
Optional |
|
Fare not valid after this date. |
NotValidBefore |
date simple type |
|
Optional |
|
Fare not valid before this date. |
Origin |
string simple type |
|
Required |
|
Returns the airport or city code that
defines the origin market for this fare. |
PassengerTypeCode |
string simple type |
|
Required |
|
The PTC that is associated with this fare. |
PrivateFare |
string simple type |
UnknownType , PrivateFare , AgencyPrivateFare , AirlinePrivateFare |
Optional |
|
|
PromotionalFare |
boolean simple type |
|
Optional |
|
Boolean to describe whether the Fare is Promotional fare or not. |
PseudoCityCode |
string simple type |
|
Optional |
|
Provider PseudoCityCode associated with
private fare. |
SupplierCode |
string simple type |
|
Optional |
|
Code of the provider returning this fare info |
TaxAmount |
string simple type |
|
Optional |
|
Currency code and value for the approximate tax amount for this fare component. |
TourCode |
string simple type |
|
Optional |
|
|
TravelDate |
date simple type |
|
Optional |
|
Returns the departure date of the first
segment that uses this fare. |
Value |
string simple type |
|
Optional |
|
Used in rapid reprice |
ValueCode |
string simple type |
|
Optional |
|
|
WaiverCode |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
FareTicketDesignator |
element |
|
|
|
Ticket Designator used to further qualify a
Fare |
Value |
string simple type |
|
Optional |
|
|
TicketingCode |
element |
|
|
|
Ticketing Code used to apply commissions. |
Value |
string simple type |
|
Optional |
|
|
FareSurcharge |
element |
|
|
|
Surcharges for a fare component |
Amount |
string simple type |
|
Required |
|
|
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that surcharge is relative
(if applicable) |
Key |
string simple type |
|
Optional |
|
|
SegmentRef |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Required |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AccountCode |
element |
|
|
|
Account Code is used to get Private Fares.If ProviderCode or SupplierCode is not specified,it will be considered a default AccounCode to be sent to all the Providers or Suppliers. |
Code |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
An identifier to categorize this account code. For example, FlightPass for AC Flight Pass or RFB for AC corporate Rewards for Business. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ContractCode |
element |
|
|
|
Some private fares (non-ATPCO) are secured to a
contract code. |
Code |
string simple type |
|
Required |
|
The 1-64 character string which uniquely
identifies a Contract. |
CompanyName |
string simple type |
|
Optional |
|
Providers supported : ACH |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
Endorsement |
element |
|
|
|
Restrictions or instructions about the fare or ticket |
Value |
string simple type |
|
Required |
|
|
BaggageAllowance |
element |
|
|
|
Free Baggage Allowance |
NumberOfPieces |
integer simple type |
|
|
|
Free Baggage Allowance |
MaxWeight |
typeWeight complex type |
|
|
|
Free Baggage Allowance |
Unit |
string simple type |
Kilograms , Pounds |
Optional |
|
|
Value |
decimal simple type |
|
Optional |
|
|
FareRuleKey |
element |
|
|
|
The Fare Rule requested using a Key. The key is
typically a provider specific string which is required to make a
following Air Fare Rule Request. This Key is returned in Low Fare
Shop or Air Price Response |
FareInfoRef |
string simple type |
|
Required |
|
The Fare Component to which this Rule Key
applies |
ProviderCode |
string simple type |
|
Required |
|
|
FareRuleFailureInfo |
element |
|
|
|
Returns fare rule failure reason codes when
fare basis code is forced. |
Reason |
typeFareRuleFailureInfoReason simple type |
|
|
|
Returns fare rule failure reason codes when
fare basis code is forced. |
FareRemarkRef |
element |
|
|
|
Returns fare rule failure reason codes when
fare basis code is forced. |
Key |
string simple type |
|
Required |
|
|
Brand |
element |
|
|
|
Commercially recognized product offered by an airline |
AirItineraryDetailsRef |
string simple type |
|
Optional |
|
AirItinerary associated with this brand |
BrandFound |
boolean simple type |
|
Optional |
|
Indicates whether brand for the fare was found for carrier or not |
BrandID |
string simple type |
|
Optional |
|
The unique identifier of the brand |
BrandMaintained |
string simple type |
|
Optional |
|
Indicates whether the brand was maintained from the original ticket. |
BrandTier |
string simple type |
|
Optional |
|
Modifier to price by specific brand tier number. |
BrandedDetailsAvailable |
boolean simple type |
|
Optional |
|
Indicates if full details of the brand is available |
Carrier |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
Brand Key |
Name |
string simple type |
|
Optional |
|
The Title of the brand |
UpSellBrandFound |
boolean simple type |
|
Optional |
|
Indicates whether upsell brand for the fare was found for carrier or not |
UpSellBrandID |
string simple type |
|
Optional |
|
|
Title |
typeTextElement complex type |
|
|
|
The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
ImageLocation |
element |
|
|
|
|
ImageHeight |
integer simple type |
|
Required |
|
The height of the image |
ImageWidth |
integer simple type |
|
Required |
|
The width of the image |
Type |
string simple type |
|
Required |
|
Type of Image Location. E.g., "Agent", "Consumer". |
OptionalServices |
element |
|
|
|
A wrapper for all the information regarding each
of the Optional services |
OptionalServicesTotal |
element |
|
|
|
The total fares, fees and taxes associated
with the Optional Services |
ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
TaxInfo |
typeTaxInfo complex type |
|
|
|
The tax information for a |
CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
FeeInfo |
typeFeeInfo complex type |
|
|
|
A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets |
Amount |
string simple type |
|
Required |
|
|
BaseAmount |
string simple type |
|
Optional |
|
|
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
FeeToken |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
|
PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
SubCode |
string simple type |
|
Optional |
|
|
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
Key |
string simple type |
|
Required |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
OptionalService |
element |
|
|
|
this attribute shows the amount included in the base fare for the specific fee or tax |
ApplicableFFLevel |
integer simple type |
|
Optional |
|
Numerical value of the loyalty card level for which this service is available. |
AssessIndicator |
string simple type |
MileageAndCurrency , MileageOrCurrency |
Optional |
|
Indicates whether price is assessed by mileage or currency or both |
Available |
boolean simple type |
|
Optional |
|
Boolean to describe whether the Service is
available for sale or not |
BaggageUnitPrice |
string simple type |
|
Optional |
|
The per unit price of baggage. Providers: 1G, 1V, 1P |
BookedQuantity |
string simple type |
|
Optional |
|
Indicates the Optional Service quantity already booked. Provider: 1G, 1V, 1P |
Chargeable |
string simple type |
|
Optional |
|
Indicates if the optional service is not offered, is available for a charge, or is included in the brand |
Confirmation |
string simple type |
|
Optional |
|
Confirmation number provided by the
supplier |
CreateDate |
dateTime simple type |
|
Optional |
|
Timestamp when this service/offer got
created. |
DisplayOrder |
integer simple type |
|
Optional |
|
Optional service group display order. |
DisplayText |
string simple type |
|
Optional |
|
Title of the Optional Service. Provider: ACH |
Entitled |
boolean simple type |
|
Optional |
|
Boolean to describe whether the passenger
is entitled for the service without charge or not |
ExcessWeightRate |
string simple type |
|
Optional |
|
The cost of the bag per unit weight. |
FirstPiece |
long simple type |
|
Optional |
|
Indicates the minimum occurrence of excess baggage.Provider: 1G, 1V, 1P. |
GeographySpecification |
string simple type |
|
Optional |
|
Sector, Portion, Journey. |
Group |
string simple type |
|
Optional |
|
Associates Optional Services with the same ServiceSub Code, Air Segment, Passenger, and EMD Associated Item. Provider:1G, 1V, 1P |
InclusiveOfTax |
boolean simple type |
|
Optional |
|
Identifies if the service was filed with a fee that is inclusive of tax. |
InterlineSettlementAllowed |
boolean simple type |
|
Optional |
|
Identifies if the interline settlement is allowed in service . |
IsPricingApproximate |
boolean simple type |
|
Optional |
|
When set to True indicates that the pricing returned is approximate. Supported providers are MCH/ACH |
IsRepriceRequired |
boolean simple type |
|
Optional |
false |
When set to “true”, the Optional Service must be re-priced. Provider: 1G, 1V, 1P |
IssuanceReason |
string simple type |
|
Optional |
|
A one-letter code specifying the reason for
issuance of the OptionalService |
Key |
string simple type |
|
Optional |
|
|
LastPiece |
long simple type |
|
Optional |
|
Indicates the maximum occurrence of excess baggage. Provider: 1G, 1V, 1P. |
Mileage |
decimal simple type |
|
Optional |
|
Indicates mileage fee/amount |
OptionalServicesRuleRef |
string simple type |
|
Optional |
|
UniqueID to associate a rule to the
Optional Service |
PaymentRef |
string simple type |
|
Optional |
|
Reference to a payment for merchandising
services. |
PerTraveler |
boolean simple type |
|
Optional |
true |
Boolean to describe whether the Amount on
the Service is charged per traveler. |
Priority |
decimal simple type |
|
Optional |
|
Numeric value that represents the priority
order of the Service |
Private |
boolean simple type |
|
Optional |
|
Describes if service is private or not. |
ProviderDefinedType |
string simple type |
|
Optional |
|
Original Type as sent by the provider |
PseudoCityCode |
string simple type |
|
Optional |
|
The PCC or SID that booked the Optional Service. |
PurchaseWindow |
string simple type |
BookingOnly , TicketingOnly , CheckInOnly , Anytime , PostTicketing |
Optional |
|
Describes when the Service is available
for confirmation or purchase (e.g. Booking Only, Check-in Only,
Anytime, etc.) |
Quantity |
decimal simple type |
|
Optional |
|
The number of units availed for each optional
service (e.g. 2 baggage availed will be specified as 2 in quantity
for optional service BAGGAGE) |
Restricted |
boolean simple type |
|
Optional |
false |
When set to “true”, the Optional Service is restricted by an embargo. Provider: 1G, 1V, 1P |
SSRCode |
string simple type |
|
Optional |
|
The SSR Code associated with the
OptionalService |
SSRFreeText |
string simple type |
|
Optional |
|
Certain SSR types sent in OptionalService SSRCode require a free text message. For example, PETC Pet in Cabin. |
SecondaryType |
string simple type |
|
Optional |
|
The secondary option code type required for
certain options |
SequenceNumber |
decimal simple type |
|
Optional |
|
The sequence number associated with the
OptionalService |
ServiceStatus |
string simple type |
|
Optional |
|
Specify the service status (e.g. active,
canceled, etc.) |
ServiceSubCode |
string simple type |
|
Optional |
|
The service subcode associated with the
OptionalService |
Source |
string simple type |
|
Optional |
|
The Source of the optional service. The source can be ACH, MCE, or MCH. |
Tag |
string simple type |
|
Optional |
|
Optional service group name. |
TotalWeight |
string simple type |
|
Optional |
|
The total weight of a bag. Providers: 1G, 1V, 1P |
Type |
string simple type |
|
Required |
|
Specify the type of service offered (e.g.
seats, baggage, etc.) |
ViewableOnly |
boolean simple type |
|
Optional |
|
Describes if the OptionalService is viewable only or not.
If viewable only then the service cannot be sold. |
WeightInExcess |
string simple type |
|
Optional |
|
The excess weight of a bag. Providers: 1G, 1V, 1P |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
ServiceData |
element |
|
|
|
The total price for this entity including base price and all taxes. |
AirSegmentRef |
string simple type |
|
Optional |
|
Reference to a segment if the merchandising offering only pertains to that segment. If no segment reference is present this means this offering is for the whole itinerary. |
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a passenger if the merchandising offering only pertains to that passenger. If no passenger reference is present this means this offering is for all passengers. |
Data |
string simple type |
|
Optional |
|
Data that specifies the details of the merchandising offering (e.g. seat number for seat service) |
EMDCouponRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD coupon issued. Supported providers are 1G/1V/1P |
EMDSummaryRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD issued. Supported providers are 1G/1V/1P |
StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
TravelerType |
string simple type |
|
Optional |
|
Passenger Type Code. |
SeatAttributes |
element |
|
|
|
Identifies the seat attribute of the service. |
SeatAttribute |
element |
|
|
|
Identifies the seat attribute of the service. |
Value |
string simple type |
|
Required |
|
|
CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
Type |
string simple type |
|
Required |
|
|
SSRRef |
typeKeyBasedReference complex type |
|
|
|
References to the related SSRs. At present, only reference to ASVC SSR is supported. Supported providers are 1G/1V/1P |
Key |
string simple type |
|
Required |
|
|
ServiceInfo |
element |
|
|
|
|
Description |
string simple type |
|
|
|
Description of the Service. Usually used in tandem with one or more media items. |
MediaItem |
element |
|
|
|
Photos and other media urls for the property referenced above. |
caption |
string simple type |
|
Optional |
|
|
height |
integer simple type |
|
Optional |
|
|
icon |
anyURI simple type |
|
Optional |
|
|
sizeCode |
string simple type |
|
Optional |
|
|
type |
string simple type |
|
Optional |
|
|
url |
anyURI simple type |
|
Optional |
|
|
width |
integer simple type |
|
Optional |
|
|
Remark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Key |
string simple type |
|
Optional |
|
|
TaxInfo |
typeTaxInfo complex type |
|
|
|
The tax information for a |
CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
FeeInfo |
typeFeeInfo complex type |
|
|
|
A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets |
Amount |
string simple type |
|
Required |
|
|
BaseAmount |
string simple type |
|
Optional |
|
|
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
FeeToken |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
|
PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
SubCode |
string simple type |
|
Optional |
|
|
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
Key |
string simple type |
|
Required |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
EMD |
element |
|
|
|
this attribute shows the amount included in the base fare for the specific fee or tax |
AssociatedItem |
string simple type |
|
Optional |
|
The type of Optional Service. The choices are Flight, Ticket, Merchandising, Rule Buster, Allowance, Chargeable Baggage, Carry On Baggage Allowance, Prepaid Baggage. Provider: 1G, 1V, 1P |
AvailabilityChargeIndicator |
string simple type |
X , E , F , G , H |
Optional |
|
A one-letter code specifying whether the service
is available or if there is a charge associated with it.
X = Service not available
F = No charge for service (free) and an EMD is not issued to
reflect free service
E = No charge for service (free) and an EMD is issued to reflect
the free service.
G = No charge for service (free), booking is not required and an
EMD is not issued to reflect free service
H = No charge for service (free), booking is not required, and an
EMD is issued to reflect the free service.
Blank = No application. Charges apply according to the data in the
Service Fee fields. |
Booking |
typeBooking simple type |
|
Optional |
|
Holds the booking description for the service, e.g., SSR. |
Commissionable |
boolean simple type |
|
Optional |
|
True/False value to whether or not the
service is comissionable. |
Date |
dateTime simple type |
|
Optional |
|
The date at which the service will be used. |
DisplayCategory |
typeDisplayCategory simple type |
|
Optional |
|
Describes when the service should be displayed. |
FulfillmentType |
integer simple type |
|
Optional |
|
A one digit code specifying how the service must be fulfilled.
See FulfillmentTypeDescription for the description of this value. |
FulfillmentTypeDescription |
string simple type |
|
Optional |
|
EMD description. |
Location |
typeIATACode simple type |
|
Optional |
|
3 letter location code where the service will be availed. |
MileageIndicator |
boolean simple type |
|
Optional |
|
True/False value to whether or not the
service has miles. |
RefundReissueIndicator |
string simple type |
Refundable , NonRefundable , Reuse |
Optional |
|
An attribute specifying whether the service is
refundable or reissuable. |
Reusable |
boolean simple type |
|
Optional |
|
Identifies if the service can be re-used towards a future purchase. |
BundledServices |
element |
|
|
|
Identifies if the service can be re-used towards a future purchase. |
BundledService |
element |
|
|
|
Displays the services bundled together |
Booking |
typeBooking simple type |
|
Optional |
|
Booking method for the bundled service, e..g SSR. |
Carrier |
string simple type |
|
Optional |
|
Carrier the service is applicable. |
CarrierSubCode |
boolean simple type |
|
Optional |
|
Carrier sub code. True means the carrier used their own sub code. False means the carrier used an ATPCO sub code |
Name |
string simple type |
|
Optional |
|
Name of the bundled service. |
Occurrence |
nonNegativeInteger simple type |
|
Optional |
|
How many of the service are included in the bundled service. |
ServiceSubCode |
string simple type |
|
Optional |
|
The sub code of the service, e.g. OAA for Pre paid baggage |
ServiceType |
string simple type |
|
Optional |
|
The type of service or what the service is used for, e.g. F type is flight type, meaning the service is used on a flight |
AdditionalInfo |
element |
|
|
|
The type of service or what the service is used for, e.g. F type is flight type, meaning the service is used on a flight |
Category |
string simple type |
|
Required |
|
The category code is the code the AdditionalInfo text came from, e.g. S5 or S7. |
FeeApplication |
element |
|
|
|
The category code is the code the AdditionalInfo text came from, e.g. S5 or S7. |
Code |
string simple type |
|
Optional |
|
The code associated to the fee application. The choices are: 1, 2, 3, 4, 5, K, F |
Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
PriceRange |
element |
|
|
|
|
DefaultCurrency |
boolean simple type |
|
Optional |
|
Indicates if the currency code of StartPrice / EndPrice is the default currency code |
EndPrice |
string simple type |
|
Optional |
|
Price range end value |
StartPrice |
string simple type |
|
Optional |
|
Price range start value |
TourCode |
element |
|
|
|
Tour Code Fare Basis |
Value |
string simple type |
|
Required |
|
|
BrandingInfo |
element |
|
|
|
Branding information for the Ancillary Service. Returned in Seat Map only. Providers: 1G, 1V, 1P, ACH |
Chargeable |
string simple type |
|
Optional |
|
Indicates if the optional service is not offered, is available for a charge, or is included in the brand. Providers: 1G, 1V, 1P, ACH |
CommercialName |
string simple type |
|
Required |
|
The commercial name of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
ExternalServiceName |
string simple type |
|
Optional |
|
The external name of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
Key |
string simple type |
|
Optional |
|
|
ServiceSubCode |
string simple type |
|
Optional |
|
The Service Sub Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
ServiceType |
string simple type |
|
Optional |
|
The type of Ancillary Service. Providers: 1G, 1V, 1P, ACH |
PriceRange |
element |
|
|
|
The type of Ancillary Service. Providers: 1G, 1V, 1P, ACH |
DefaultCurrency |
boolean simple type |
|
Optional |
|
Indicates if the currency code of StartPrice / EndPrice is the default currency code |
EndPrice |
string simple type |
|
Optional |
|
Price range end value |
StartPrice |
string simple type |
|
Optional |
|
Price range start value |
Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
Title |
typeTextElement complex type |
|
|
|
The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
ImageLocation |
element |
|
|
|
|
ImageHeight |
integer simple type |
|
Required |
|
The height of the image |
ImageWidth |
integer simple type |
|
Required |
|
The width of the image |
Type |
string simple type |
|
Required |
|
Type of Image Location. E.g., "Agent", "Consumer". |
ServiceGroup |
element |
|
|
|
The Service Group of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
Code |
string simple type |
|
Required |
|
The Service Group Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
ServiceSubGroup |
element |
|
|
|
The Service Sub Group of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
Code |
string simple type |
|
Optional |
|
The Service Sub Group Code of the Ancillary Service. Providers: 1G, 1V, 1P, ACH |
AirSegmentRef |
typeSegmentRef complex type |
|
|
|
Specifies the AirSegment the branding information is for. Providers: ACH, 1G, 1V, 1P |
Key |
string simple type |
|
Required |
|
|
Title |
typeTextElement complex type |
|
|
|
The additional titles associated to the brand or optional service. Providers: ACH, RCH, 1G, 1V, 1P. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
GroupedOptionInfo |
element |
|
|
|
|
GroupedOption |
element |
|
|
|
|
OptionalServiceRef |
string simple type |
|
Required |
|
Reference to a optionalService which is paired with other optional services in the parent PairedOptions element. |
OptionalServiceRules |
ServiceRuleType complex type |
|
|
|
Holds the rules for selecting the optional
service in the itinerary |
Key |
string simple type |
|
Required |
|
Unique ID to identify an optional service rule |
ApplicationRules |
element |
|
|
|
The rules to apply the rule to the itinerary |
RequiredForAllSegments |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all segments in the itinerary if selected |
RequiredForAllSegmentsInOD |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all segments in a origin / destination (connection flights) if selected for one segment in the OD |
RequiredForAllTravelers |
boolean simple type |
|
Optional |
|
Indicates if the option needs to be applied to all travelers in the itinerary if selected |
SecondaryOptionCodeRequired |
boolean simple type |
|
Optional |
|
If set to true, the secondary option code is required for this option |
UnselectedOptionRequired |
boolean simple type |
|
Optional |
|
If an UnselectedOption is present in the option, then the Unselected option needs to be selected even if the option is not selected when this flag is set to true |
ApplicationLevel |
element |
|
|
|
Lists the levels where the option is applied in the itinerary. Some options are applied for the entire itinerary, some for entire segments, etc. |
ApplicableLevels |
anonymous simple type |
|
Optional |
|
Indicates the level in the itinerary when the option is applied. |
ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
ApplicationLimits |
element |
|
|
|
Adds the limits on the number of options that can be selected for a particular type |
ApplicationLimit |
OptionalServiceApplicationLimitType complex type |
|
|
|
The application limits for a particular level |
ApplicableLevel |
string simple type |
Itinerary , Passenger , Segment , PassengerSegment , PassengerOD , Other |
Required |
|
Indicates the applicable level for the option |
MaximumQuantity |
nonNegativeInteger simple type |
|
Required |
|
The maximum quantity allowed for the type |
MinimumQuantity |
nonNegativeInteger simple type |
|
Optional |
|
Indicates the minimum number of the option that can be selected. |
ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
ServiceData |
element |
|
|
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
AirSegmentRef |
string simple type |
|
Optional |
|
Reference to a segment if the merchandising offering only pertains to that segment. If no segment reference is present this means this offering is for the whole itinerary. |
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a passenger if the merchandising offering only pertains to that passenger. If no passenger reference is present this means this offering is for all passengers. |
Data |
string simple type |
|
Optional |
|
Data that specifies the details of the merchandising offering (e.g. seat number for seat service) |
EMDCouponRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD coupon issued. Supported providers are 1G/1V/1P |
EMDSummaryRef |
string simple type |
|
Optional |
|
Reference to the corresponding EMD issued. Supported providers are 1G/1V/1P |
StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
TravelerType |
string simple type |
|
Optional |
|
Passenger Type Code. |
SeatAttributes |
element |
|
|
|
Identifies the seat attribute of the service. |
SeatAttribute |
element |
|
|
|
Identifies the seat attribute of the service. |
Value |
string simple type |
|
Required |
|
|
CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
Type |
string simple type |
|
Required |
|
|
SSRRef |
typeKeyBasedReference complex type |
|
|
|
References to the related SSRs. At present, only reference to ASVC SSR is supported. Supported providers are 1G/1V/1P |
Key |
string simple type |
|
Required |
|
|
ModifyRules |
element |
|
|
|
Groups the modification rules for the Option |
ProviderDefinedModificationType |
string simple type |
|
Optional |
|
Indicates the actual provider defined modification type which is mapped to Other |
SupportedModifications |
anonymous simple type |
|
Optional |
|
Lists the supported modifications for the itinerary. |
ModifyRule |
element |
|
|
|
Indicates modification rules for the particular modification type. |
AutomaticallyAppliedOnAdd |
boolean simple type |
|
Optional |
false |
Indicates if the option will be automatically added to new segments / passengers in the itinerary. |
CanAdd |
boolean simple type |
|
Optional |
|
Indicates if the option can be added to the itinerary without segment or passenger modification |
CanDelete |
boolean simple type |
|
Optional |
|
Indicates if the option can be deleted from the itinerary without segment or passenger modifications |
Modification |
NMTOKEN simple type |
AddSegment , RemoveSegment , ReplaceSegment , AddPassenger , RemovePassenger , OptionsOnly , Other |
Required |
|
The modificaiton for which this rule group applies. |
ProviderDefinedModificationType |
string simple type |
|
Optional |
|
Indicates the actual provider defined modification type which is mapped to Other |
Refundable |
boolean simple type |
|
Optional |
|
Indicates if the price of the option is refundable. |
SecondaryTypeRules |
element |
|
|
|
Lists the supported Secondary Codes for the optional / additional service. |
SecondaryTypeRule |
element |
|
|
|
Lists a single secondary code for the optional / additional service. |
SecondaryType |
string simple type |
|
Required |
|
The unique type to associate a secondary type in an optional service |
ApplicationLimit |
OptionalServiceApplicationLimitType complex type |
|
|
|
The unique type to associate a secondary type in an optional service |
ApplicableLevel |
string simple type |
Itinerary , Passenger , Segment , PassengerSegment , PassengerOD , Other |
Required |
|
Indicates the applicable level for the option |
MaximumQuantity |
nonNegativeInteger simple type |
|
Required |
|
The maximum quantity allowed for the type |
MinimumQuantity |
nonNegativeInteger simple type |
|
Optional |
|
Indicates the minimum number of the option that can be selected. |
ProviderDefinedApplicableLevels |
string simple type |
|
Optional |
|
Indicates the actual provider defined ApplicableLevels which is mapped to Other |
Remarks |
FormattedTextTextType complex type |
|
|
|
Adds text remarks / rules for the optional / additional service |
Formatted |
boolean simple type |
|
Optional |
|
Textual information, which may be formatted as a line of information, or unformatted, as a paragraph of text. |
TextFormat |
NMTOKEN simple type |
PlainText , HTML |
Optional |
|
Indicates the format of text used in the description e.g. unformatted or html. |
Language |
token simple type |
|
Optional |
|
Language identification. |
Rules |
element |
|
|
|
Language identification. |
RulesText |
string simple type |
|
|
|
Rules text |
ServiceAssociations |
element |
|
|
|
Rules text |
ApplicableSegment |
element |
|
|
|
Applicable air segment associated with this brand. |
Key |
string simple type |
|
Optional |
|
Applicable air segment key |
ResponseMessage |
element |
|
|
|
A simple textual fare note. Used within several other objects. |
Code |
decimal simple type |
|
Required |
|
|
Type |
string simple type |
Warning , Error , Info |
Optional |
|
Indicates the type of message (Warning, Error, Info) |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
OptionalServiceRef |
typeRef simple type |
|
|
|
Reference to optional service |
UpsellBrand |
element |
|
|
|
Upsell brand reference |
FareBasis |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
ApplicableSegment |
typeApplicableSegment complex type |
|
|
|
|
AirItineraryDetailsRef |
string simple type |
|
Optional |
|
|
BookingCounts |
string simple type |
|
Optional |
|
Classes of service and their counts. |
Key |
string simple type |
|
Required |
|
|
DefaultBrandDetail |
typeDefaultBrandDetail complex type |
|
|
|
Applicable air segment. |
BrandID |
string simple type |
|
Optional |
|
The unique identifier of the brand |
Text |
typeTextElement complex type |
|
|
|
Type of Text, Eg-'Upsell','Marketing Agent','Marketing Consumer','Strapline','Rule'. |
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
Type |
string simple type |
|
Required |
|
|
ImageLocation |
element |
|
|
|
|
ImageHeight |
integer simple type |
|
Required |
|
The height of the image |
ImageWidth |
integer simple type |
|
Required |
|
The width of the image |
Type |
string simple type |
|
Required |
|
Type of Image Location. E.g., "Agent", "Consumer". |
ApplicableSegment |
typeApplicableSegment complex type |
|
|
|
Applicable air segment. |
AirItineraryDetailsRef |
string simple type |
|
Optional |
|
|
BookingCounts |
string simple type |
|
Optional |
|
Classes of service and their counts. |
Key |
string simple type |
|
Required |
|
|
Commission |
element |
|
|
|
Identifies the agency commission |
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan |
Key |
string simple type |
|
Optional |
|
|
Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
FareAttributes |
string simple type |
|
|
|
Returns all fare attributes separated by pipe ‘|’. Attribute information is returned by comma separated values for each attribute. These information include attribute number, chargeable indicator and supplementary info. Attribute numbers: 1 - Checked Bag, 2 - Carry On, 3 - Rebooking, 4 - Refund, 5 - Seats, 6 - Meals, 7 - WiFi. Chargeable Indicator: Y - Chargeable, N - Not Chargeable. Supplementary Information that will be returned is : For 1 and 2 - Baggage weights. For 3 – Changeable Info. For 4 – Refundable Info. For 5 - Seat description. For 6 – Meal description. For 7 – WiFi description. Example: 1,Y,23|1,N,50|2,N,8|3,N,CHANGEABLE|4,Y,REFUNDABLE|5,N,SEATING|5,N,MIDDLE|6,Y,SOFT DRINK|6,N,ALCOHOLIC DRINK|6,Y,SNACK|7,X,WIFI |
ChangePenalty |
typeFarePenalty complex type |
|
|
|
The penalty (if any) to change the itinerary |
NoShow |
boolean simple type |
|
Optional |
|
The No Show penalty (if any) to change/cancel the fare. |
PenaltyApplies |
string simple type |
Anytime , Before Departure , After Departure |
Optional |
|
|
Amount |
typeMoney simple type |
|
|
|
The penalty (if any) - expressed as the actual
amount of money. Both Amount and Percentage can be present. |
Percentage |
typePercentageWithDecimal simple type |
|
|
|
The penalty (if any) - expressed in
percentage. Both Amount and Percentage can be present. |
CancelPenalty |
typeFarePenalty complex type |
|
|
|
The penalty (if any) to cancel the fare |
NoShow |
boolean simple type |
|
Optional |
|
The No Show penalty (if any) to change/cancel the fare. |
PenaltyApplies |
string simple type |
Anytime , Before Departure , After Departure |
Optional |
|
|
Amount |
typeMoney simple type |
|
|
|
The penalty (if any) - expressed as the actual
amount of money. Both Amount and Percentage can be present. |
Percentage |
typePercentageWithDecimal simple type |
|
|
|
The penalty (if any) - expressed in
percentage. Both Amount and Percentage can be present. |
FareRulesFilter |
element |
|
|
|
Fare Rules Filter about this fare component. Applicable Providers are 1P,1G,1V. |
Refundability |
element |
|
|
|
Refundability/Penalty Fare Rules about this fare component. |
Value |
string simple type |
|
Required |
|
Currently returned: FullyRefundable (1G,1V), RefundableWithPenalty (1G,1V), Refundable (1P), NonRefundable (1G,1V,1P).Refundable. |
LatestTicketingTime |
dateTime simple type |
|
|
|
For Future Use |
CHG |
CHGType complex type |
|
|
|
For Penalties |
PenFee |
PenFeeType complex type |
|
|
|
For Penalties |
AirVFee |
boolean simple type |
|
Optional |
|
Carrier fee. True if carrier fee is assessed should passenger for complete all conditions for travel at fare. False if it does not exist. |
Amt |
decimal simple type |
|
Optional |
|
Amount of penalty. If XXX.XX then it is an amount. If it is XX then is is a percenatge. Eg 100.00 or 000100. |
Applicable |
boolean simple type |
|
Optional |
|
Applicable. True if amount specified is applicable. Flase if amount specified is not applicable. |
ApplicableTo |
boolean simple type |
|
Optional |
|
Applicable to penalty or deposit. True if amount specified applies to penalty. False if amount specified applies to deposit. |
Cancellation |
boolean simple type |
|
Optional |
|
Cancellation. True if subject to penalty. False if no penalty. |
Currency |
string simple type |
|
Optional |
|
Currency code of penalty (e.g. USD). |
DepNonRef |
boolean simple type |
|
Optional |
|
Deposit non-refundable. True is non-refundanbe. False is refundable. |
DepRequired |
boolean simple type |
|
Optional |
|
Deposit required. True if require. False if not required. |
FailConfirmSpace |
boolean simple type |
|
Optional |
|
Failure to confirm space. True if subject to penalty if seats are not confirmed. False if subject to penalty if seats are confirmed. |
ItinChg |
boolean simple type |
|
Optional |
|
Subject to penalty if Itinerary is changed requiring reissue of ticket. True if subject to penalty. False if no penalty if reissue required. |
ReplaceTk |
boolean simple type |
|
Optional |
|
Replace ticket. True if subject to penalty, if replacement of lost ticket / exchange order. False if no penalty, if replacement of lost ticket or exchange order. |
TkNonRef |
boolean simple type |
|
Optional |
|
Ticket non-refundable. True if non-refundanbe. False if refundable. |
Type |
string simple type |
|
Optional |
|
Type of penalty. If it is D then dollar. If it is P then percentage. |
MIN |
MINType complex type |
|
|
|
For Minimum Stay |
DaysMin |
boolean simple type |
|
Optional |
|
Minimum days. True if unit of time is days. False if unit of time is not days. |
FareComponent |
decimal simple type |
|
Optional |
|
Fare component number of the most restrictive fare. |
HoursMin |
boolean simple type |
|
Optional |
|
Minimum hours. True if unit of time is hours. False if unit of time is not hours. |
MonthsMin |
boolean simple type |
|
Optional |
|
Minimum months. True if unit of time is months. False if unit of time is not months. |
NumOccurMin |
decimal simple type |
|
Optional |
|
Number of min occurances. This field is used in conjunction with the Day of Week. |
OccurIndMin |
boolean simple type |
|
Optional |
|
Minimum occurance indicator. True if day of the week is used. False if day of the week is not used. |
SameDayMin |
boolean simple type |
|
Optional |
|
Same day minimum. True if Stay is same day. False if Stay is not same day. |
TmDOWMin |
decimal simple type |
|
Optional |
|
If a min unit of time is true then number corrolates to day of the week starting with 1 for Sunday. |
MAX |
MAXType complex type |
|
|
|
For Maximum Stay |
CompletionInd |
boolean simple type |
|
Optional |
|
Completion indicator. True if Completion C Indicator. False if not Completion C Indicator. |
DaysMax |
boolean simple type |
|
Optional |
|
Maximum days. True if unit of time is days. False if unit of time is not days. |
HoursMax |
boolean simple type |
|
Optional |
|
Maximum hours. True if unit of time is hours. False if unit of time is not hours. |
MonthsMax |
boolean simple type |
|
Optional |
|
Maximum months. True if unit of time is months. False if unit of time is not months. |
NumOccurMax |
decimal simple type |
|
Optional |
|
Number of maximum occurances. |
OccurIndMax |
boolean simple type |
|
Optional |
|
Maximum cccurance indicator. True if day of the week is used. False if day of the week is not used. |
SameDayMax |
boolean simple type |
|
Optional |
|
Same day maximum. True if Stay is same day. False if Stay is not same day. |
StartIndMax |
boolean simple type |
|
Optional |
|
Start indicator. True if start indicator. False if not a start indicator. |
TmDOWMax |
decimal simple type |
|
Optional |
|
If a max unit of time is true then number corrolates to day of the week starting with 1 for Sunday. |
ADV |
ADVType complex type |
|
|
|
For Advance Res/Tkt |
AdvRsvnAnyTm |
boolean simple type |
|
Optional |
|
Reservation anytime. True if advanced reservatiosn anytime. False if advanced reservations for a limited time. |
AdvRsvnDataExists |
boolean simple type |
|
Optional |
|
Reservation data exists. True if advanced reservation data exists. False if advanced reservation data does not exist. |
AdvRsvnDays |
boolean simple type |
|
Optional |
|
Reservation days. True if advanced reservation time in days. False if advanced reservation time not in days. |
AdvRsvnEarliestTm |
boolean simple type |
|
Optional |
|
Earliest reservation time. True if advanced reservations time is earliest permitted. False is advanced reservation time not earliest permitted time. |
AdvRsvnEndItem |
boolean simple type |
|
Optional |
|
Reservation end item. True if advanced reservation end item and more values. False if it does not exist. |
AdvRsvnHrs |
boolean simple type |
|
Optional |
|
Reservation hours. True if advanced reservation time in hours. False if advanced reservation time not in hours. |
AdvRsvnLatestTm |
boolean simple type |
|
Optional |
|
Latest reservation time. True if advanced reservations time is latest permitted. False is advanced reservation time not latest permitted time. |
AdvRsvnMonths |
boolean simple type |
|
Optional |
|
Reservation months. True if advanced reservation time in months. False if advanced reservation time not in months. |
AdvRsvnOnlyIfTk |
boolean simple type |
|
Optional |
|
Reservation only if ticketed. True is advanced reservations only if tickets. False is no advanced reservations |
AdvRsvnTm |
decimal simple type |
|
Optional |
|
Advanced reservation time. |
AdvRsvnWaived |
boolean simple type |
|
Optional |
|
Reservation Waived. True if advanced reservation waived. False if advanced reservation not waived. |
AdvTkAnyTm |
boolean simple type |
|
Optional |
|
Ticketing anytime. True if anytime. False if limited time. |
AdvTkEarliestTm |
boolean simple type |
|
Optional |
|
Earliest ticketing time. True if earliest permitted. False if not earliest permitted. |
AdvTkEndItem |
boolean simple type |
|
Optional |
|
Ticketing end item. True if advanced ticketing item and more values. False if end item does not exist. |
AdvTkLatestTm |
boolean simple type |
|
Optional |
|
Latest ticketing time. True if time is latest permitted. False if time is not latest permitted. |
AdvTkRsvnDays |
boolean simple type |
|
Optional |
|
Ticketing reservation days. True if in days. False if not in days. |
AdvTkRsvnHrs |
boolean simple type |
|
Optional |
|
Ticketing reservation hours. True if in hours. False if not in hours. |
AdvTkRsvnMonths |
boolean simple type |
|
Optional |
|
Ticketing reservation months. True if in months. False if not in months. |
AdvTkRsvnTm |
decimal simple type |
|
Optional |
|
Advanced ticketing reservation time. |
AdvTkStartDays |
boolean simple type |
|
Optional |
|
Ticketing departure days. True if in days. False if not in days. |
AdvTkStartHrs |
boolean simple type |
|
Optional |
|
Latest ticketing departure. True if time is latest permitted. False if time is not latest permitted. |
AdvTkStartMonths |
boolean simple type |
|
Optional |
|
Ticketing reservation months. True if in months. False if not in months. |
AdvTkStartTm |
decimal simple type |
|
Optional |
|
Advanced ticketing departure time. |
AdvTkWaived |
boolean simple type |
|
Optional |
|
Ticketing waived. True if waived. False if not waived. |
EarliestRsvnDt |
date simple type |
|
Optional |
|
Earliest reservation date. |
EarliestRsvnDtPresent |
boolean simple type |
|
Optional |
|
Earliest reservation date. True if date is present. False if date is not present. |
EarliestTkDt |
date simple type |
|
Optional |
|
Earliest ticketing date. |
EarliestTkDtPresent |
boolean simple type |
|
Optional |
|
Earliest ticketing date. True if date is present. False if date is not present. |
LatestRsvnDt |
date simple type |
|
Optional |
|
Latest reservation date. |
LatestRsvnDtPresent |
boolean simple type |
|
Optional |
|
Latest reservation date. True if date is present. False if date is not present. |
LatestTkDt |
date simple type |
|
Optional |
|
Latest ticketing date. |
LatestTkDtPresent |
boolean simple type |
|
Optional |
|
Latest ticketing date. True if date is present. False if date is not present. |
OTH |
OTHType complex type |
|
|
|
Other |
Cat0 |
boolean simple type |
|
Optional |
|
Category 0 rules. True if category applies. False if rules do not apply. |
Cat1 |
boolean simple type |
|
Optional |
|
Category 1 rules. True if category applies. False if rules do not apply. |
Cat10 |
boolean simple type |
|
Optional |
|
Category 10 rules. True if category applies. False if rules do not apply. |
Cat11 |
boolean simple type |
|
Optional |
|
Category 11 rules. True if category applies. False if rules do not apply. |
Cat12 |
boolean simple type |
|
Optional |
|
Category 12 rules. True if category applies. False if rules do not apply. |
Cat13 |
boolean simple type |
|
Optional |
|
Category 13 rules. True if category applies. False if rules do not apply. |
Cat14 |
boolean simple type |
|
Optional |
|
Category 14 rules. True if category applies. False if rules do not apply. |
Cat15 |
boolean simple type |
|
Optional |
|
Category 15 rules. True if category applies. False if rules do not apply. |
Cat16 |
boolean simple type |
|
Optional |
|
Category 16 rules. True if category applies. False if rules do not apply. |
Cat17 |
boolean simple type |
|
Optional |
|
Category 17 rules. True if category applies. False if rules do not apply. |
Cat18 |
boolean simple type |
|
Optional |
|
Category 18 rules. True if category applies. False if rules do not apply. |
Cat19 |
boolean simple type |
|
Optional |
|
Category 19 rules. True if category applies. False if rules do not apply. |
Cat2 |
boolean simple type |
|
Optional |
|
Category 2 rules. True if category applies. False if rules do not apply. |
Cat20 |
boolean simple type |
|
Optional |
|
Category 20 rules. True if category applies. False if rules do not apply. |
Cat21 |
boolean simple type |
|
Optional |
|
Category 21 rules. True if category applies. False if rules do not apply. |
Cat22 |
boolean simple type |
|
Optional |
|
Category 22 rules. True if category applies. False if rules do not apply. |
Cat23 |
boolean simple type |
|
Optional |
|
Category 23 rules. True if category applies. False if rules do not apply. |
Cat24 |
boolean simple type |
|
Optional |
|
Category 24 rules. True if category applies. False if rules do not apply. |
Cat25 |
boolean simple type |
|
Optional |
|
Category 25 rules. True if category applies. False if rules do not apply. |
Cat26 |
boolean simple type |
|
Optional |
|
Category 26 rules. True if category applies. False if rules do not apply. |
Cat27 |
boolean simple type |
|
Optional |
|
Category 27 rules. True if category applies. False if rules do not apply. |
Cat28 |
boolean simple type |
|
Optional |
|
Category 28 rules. True if category applies. False if rules do not apply. |
Cat29 |
boolean simple type |
|
Optional |
|
Category 29 rules. True if category applies. False if rules do not apply. |
Cat3 |
boolean simple type |
|
Optional |
|
Category 3 rules. True if category applies. False if rules do not apply. |
Cat30 |
boolean simple type |
|
Optional |
|
Category 30 rules. True if category applies. False if rules do not apply. |
Cat31 |
boolean simple type |
|
Optional |
|
Category 31 rules. True if category applies. False if rules do not apply. |
Cat4 |
boolean simple type |
|
Optional |
|
Category 4 rules. True if category applies. False if rules do not apply. |
Cat5 |
boolean simple type |
|
Optional |
|
Category 5 rules. True if category applies. False if rules do not apply. |
Cat6 |
boolean simple type |
|
Optional |
|
Category 6 rules. True if category applies. False if rules do not apply. |
Cat7 |
boolean simple type |
|
Optional |
|
Category 7 rules. True if category applies. False if rules do not apply. |
Cat8 |
boolean simple type |
|
Optional |
|
Category 8 rules. True if category applies. False if rules do not apply. |
Cat9 |
boolean simple type |
|
Optional |
|
Category 9 rules. True if category applies. False if rules do not apply. |
MissingRules |
boolean simple type |
|
Optional |
|
Missing rules. True if rules are missing. False if rules are not missing. |
NotUSACity |
boolean simple type |
|
Optional |
|
Not USA city. True if Origin or final destination not a continental U.S. City. False if Origin or final destination a continental U.S. City. |
RestrictiveDt |
date simple type |
|
Optional |
|
Most restrictive ticketing date. |
SurchargeAmt |
decimal simple type |
|
Optional |
|
Surcharge amount |
FareStatus |
element |
|
|
|
Denotes the status of a particular fare. |
Code |
string simple type |
ReadyToTicket , UnableToTicket , Reprice , Ticketed , Unable , Unknown |
Required |
|
The status of the fare. |
FareStatusFailureInfo |
element |
|
|
|
Denotes the failure reason of a particular fare. |
Code |
string simple type |
|
Required |
|
The failure code of the fare. |
Reason |
string simple type |
|
Optional |
|
The reason for the failure. |
FareInfoRef |
element |
|
|
|
Reference to a complete FareInfo from a
shared list |
Key |
string simple type |
|
Required |
|
|
BookingInfo |
element |
|
|
|
Links segments and fares together |
AirItinerarySolutionRef |
string simple type |
|
Optional |
|
Reference to an Air Itinerary Solution |
BookingCode |
string simple type |
|
Required |
|
|
BookingCount |
string simple type |
|
Optional |
|
Seat availability of the BookingCode |
CabinClass |
string simple type |
|
Optional |
|
|
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that booking is relative
(if applicable) |
FareInfoRef |
string simple type |
|
Required |
|
|
HostTokenRef |
string simple type |
|
Optional |
|
HostToken Reference for this segment and fare combination. |
SegmentRef |
string simple type |
|
Optional |
|
|
TaxInfoRef |
string simple type |
|
Optional |
|
TaxInfo Reference for booking info and tax info combination. |
TaxInfo |
typeTaxInfo complex type |
|
|
|
The tax information for a |
CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
FareCalc |
string simple type |
|
|
|
The complete fare calculation line. |
PassengerType |
element |
|
|
|
The passenger type details associated to a fare. |
AccompaniedPassenger |
boolean simple type |
|
Optional |
false |
Container to identify accompanied passenger. Set true means this passenger is accompanied |
Age |
decimal simple type |
|
Optional |
|
|
BookingTravelerRef |
string simple type |
|
Optional |
|
This value should be set for Multiple Passengers in the request. |
Code |
string simple type |
|
Required |
|
The 3-char IATA passenger type code |
DOB |
date simple type |
|
Optional |
|
Passenger Date of Birth |
Gender |
string simple type |
|
Optional |
|
The passenger gender type |
PricePTCOnly |
boolean simple type |
|
Optional |
|
|
ResidencyType |
string simple type |
Employee , National , Resident |
Optional |
|
The passenger residence type. |
Name |
element |
|
|
|
Complete name fields |
First |
string simple type |
|
Required |
|
First Name. Size can be up to 256 characters |
Last |
string simple type |
|
Required |
|
Last Name. Size can be up to 256 characters |
Middle |
string simple type |
|
Optional |
|
Midle name. Size can be up to 256 characters |
Prefix |
string simple type |
|
Optional |
|
Name prefix. Size can be up to 20 characters |
Suffix |
string simple type |
|
Optional |
|
Name suffix. Size can be up to 256 characters |
TravelerProfileId |
integer simple type |
|
Optional |
|
Traveler Applied Profile ID. |
LoyaltyCard |
element |
|
|
|
Provider loyalty card information |
CardNumber |
string simple type |
|
Required |
|
|
FreeText |
string simple type |
|
Optional |
|
|
Level |
string simple type |
|
Optional |
|
|
MembershipStatus |
string simple type |
|
Optional |
|
|
PriorityCode |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Optional |
|
|
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
|
VendorLocationRef |
string simple type |
|
Optional |
|
|
AllianceLevel |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
MembershipProgram |
string simple type |
|
Optional |
|
Loyalty Program membership Id of the traveler specific to Amtrak(2V) Guest Rewards |
SupplierCode |
string simple type |
|
Required |
|
The code used to identify the Loyalty supplier, e.g. AA, ZE, MC |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationSpecificInfo |
typeProviderReservationSpecificInfo complex type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationLevel |
boolean simple type |
|
Optional |
|
If true means Loyalty card is applied at ProviderReservation level. |
ReservationLevel |
boolean simple type |
|
Optional |
|
If true means Loyalty card is applied at Universal Record Reservation level e.g. Hotel Reservation, Vehicle Reservation etc. |
OperatedBy |
element |
|
|
|
This is the carrier code to support Cross Accrual |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
DiscountCard |
element |
|
|
|
Rail Discount Card Information |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Number |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
PersonalGeography |
element |
|
|
|
Personal geography details of the associated passenger. |
CountryCode |
typeCountry simple type |
|
|
|
Passenger country code. |
StateProvinceCode |
typeState simple type |
|
|
|
Passenger state/province code. |
CityCode |
typeCity simple type |
|
|
|
Passenger city code. |
FareGuaranteeInfo |
element |
|
|
|
The information related to fare guarantee details. |
GuaranteeDate |
date simple type |
|
Optional |
|
The date till which the fare is guaranteed. |
GuaranteeType |
string simple type |
Auto , Manual , ManualFare , Guaranteed , Invalid , Restored , Ticketed , Unticketable , Reprice , Expired , AutoUsingPrivateFare , GuaranteedUsingAirlinePrivateFare , Airline , GuaranteeExpired , AgencyPrivateFareNoOverride , Unknown |
Required |
|
Determines the status of a fare for a passenger. |
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
WaiverCode |
element |
|
|
|
Waiver code to override fare validations |
Endorsement |
string simple type |
|
Optional |
|
Endorsement. Size can be up to 100
characters |
TicketDesignator |
string simple type |
|
Optional |
|
|
TourCode |
string simple type |
|
Optional |
|
|
PaymentRef |
element |
|
|
|
Reference to one of the air reservation
payments |
Key |
string simple type |
|
Required |
|
|
ChangePenalty |
typeFarePenalty complex type |
|
|
|
The penalty (if any) to change the itinerary |
NoShow |
boolean simple type |
|
Optional |
|
The No Show penalty (if any) to change/cancel the fare. |
PenaltyApplies |
string simple type |
Anytime , Before Departure , After Departure |
Optional |
|
|
Amount |
typeMoney simple type |
|
|
|
The penalty (if any) - expressed as the actual
amount of money. Both Amount and Percentage can be present. |
Percentage |
typePercentageWithDecimal simple type |
|
|
|
The penalty (if any) - expressed in
percentage. Both Amount and Percentage can be present. |
CancelPenalty |
typeFarePenalty complex type |
|
|
|
The penalty (if any) to cancel the fare |
NoShow |
boolean simple type |
|
Optional |
|
The No Show penalty (if any) to change/cancel the fare. |
PenaltyApplies |
string simple type |
Anytime , Before Departure , After Departure |
Optional |
|
|
Amount |
typeMoney simple type |
|
|
|
The penalty (if any) - expressed as the actual
amount of money. Both Amount and Percentage can be present. |
Percentage |
typePercentageWithDecimal simple type |
|
|
|
The penalty (if any) - expressed in
percentage. Both Amount and Percentage can be present. |
NoShowPenalty |
typeFarePenalty complex type |
|
|
|
The NoShow penalty (if any) |
NoShow |
boolean simple type |
|
Optional |
|
The No Show penalty (if any) to change/cancel the fare. |
PenaltyApplies |
string simple type |
Anytime , Before Departure , After Departure |
Optional |
|
|
Amount |
typeMoney simple type |
|
|
|
The penalty (if any) - expressed as the actual
amount of money. Both Amount and Percentage can be present. |
Percentage |
typePercentageWithDecimal simple type |
|
|
|
The penalty (if any) - expressed in
percentage. Both Amount and Percentage can be present. |
MostRestrictivePenalties |
typeMostRestrictivePenalties complex type |
|
|
|
Contain CAT16 Most Restrictive Penalties. |
RestrictionType |
typeRestrictionData complex type |
|
|
|
Contain the type of restriction applicable |
Name |
anySimpleType simple type |
|
Optional |
|
Possible value for restriction name "Non-Refundable","Non-Changeable","Cancellation","Changes",
"Non-Refundable marked with No Show","No Show","Non-Changeable marked with No Show" |
Value |
anySimpleType simple type |
|
Optional |
|
Possible value for restriction value "After Departure","Anytime" and "Before Departure" |
Amount |
typeMoney simple type |
|
|
|
Implies a flat amount to be adjusted.
Negative value implies a discount. |
Percentage |
typePercentageWithDecimal simple type |
|
|
|
Implies an adjustment to be made on
original price. Negative value implies a discount. |
FeeInfo |
typeFeeInfo complex type |
|
|
|
A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets |
Amount |
string simple type |
|
Required |
|
|
BaseAmount |
string simple type |
|
Optional |
|
|
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
FeeToken |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
|
PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
SubCode |
string simple type |
|
Optional |
|
|
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
Key |
string simple type |
|
Required |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
Adjustment |
element |
|
|
|
An indentifier which indentifies adjustment made
on original pricing. It can a flat amount or percentage of original
price. The value of Amount/Percent can be negetive. Negative value
implies a discount. |
AdjustedTotalPrice |
string simple type |
|
Required |
|
The adjusted price after applying adjustment
on Total price |
ApproximateAdjustedTotalPrice |
string simple type |
|
Optional |
|
The Converted adjusted total price in Default
Currency for this entity. |
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a booking traveler for which adjustment is applied. |
Amount |
typeMoney simple type |
|
|
|
Implies a flat amount to be adjusted.
Negetive value implies a discount. |
Percent |
float simple type |
|
|
|
Implies an adjustment to be made on
original price. Negetive value implies a discount. |
Yield |
element |
|
|
|
An identifier which identifies yield made
on original pricing. It can be a flat amount of original
price. The value of Amount can be negative. Negative value
implies a discount. |
Amount |
string simple type |
|
Optional |
|
Yield per passenger level in Default
Currency for this entity. |
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a booking traveler for which Yield is applied. |
AirPricingModifiers |
element |
|
|
|
Controls and switches for a Air Search
request that contains Pricing Information |
AccountCodeFaresOnly |
boolean simple type |
|
Optional |
|
Indicates whether or not the private
fares returned should be restricted to only those specific to the
input account code and contract code. |
ChannelId |
string simple type |
|
Optional |
|
A Channel ID is 2 to 4 alpha-numeric characters used to activate the Search Control Console filter for a specific group of travelers being served by the agency credential. |
CurrencyType |
string simple type |
|
Optional |
|
|
ETicketability |
string simple type |
Yes , No , Required , Ticketless |
Optional |
|
Request a search based on whether only
E-ticketable fares are required. |
FaresIndicator |
string simple type |
PublicFaresOnly , PrivateFaresOnly , AgencyPrivateFaresOnly , AirlinePrivateFaresOnly , PublicAndPrivateFares , NetFaresOnly , AllFares |
Optional |
|
Indicates whether only public fares
should be returned or specific type of private fares |
FiledCurrency |
string simple type |
|
Optional |
|
Currency in which Fares/Prices will be filed if supported by the supplier else approximated to. |
ForceSegmentSelect |
boolean simple type |
|
Optional |
false |
This indicator allows agent to force segment select option in host while selecting all air segments to store price on a PNR. This is relevent only when agent selects all air segmnets to price. if agent selects specific segments to price then this attribute will be ignored by the system. This is currently used by Worldspan only. |
InventoryRequestType |
string simple type |
Seamless , DirectAccess , Basic |
Optional |
|
This allows user to make request for a particular source of inventory for pricing modifier purposes. |
Key |
string simple type |
|
Optional |
|
|
OneWayShop |
boolean simple type |
|
Optional |
false |
Via this attribute one way shop can be requested. Applicable provider is 1G |
OverrideCarrier |
string simple type |
|
Optional |
|
The Plating Carrier for this journey. |
PlatingCarrier |
string simple type |
|
Optional |
|
The Plating Carrier for this journey. |
ProhibitAdvancePurchaseFares |
boolean simple type |
|
Optional |
false |
|
ProhibitMaxStayFares |
boolean simple type |
|
Optional |
false |
|
ProhibitMinStayFares |
boolean simple type |
|
Optional |
false |
|
ProhibitNonExchangeableFares |
boolean simple type |
|
Optional |
false |
|
ProhibitNonRefundableFares |
boolean simple type |
|
Optional |
false |
|
ProhibitRestrictedFares |
boolean simple type |
|
Optional |
false |
|
ProhibitUnbundledFareTypes |
boolean simple type |
|
Optional |
|
A "True" value wiill remove fares with EOU and ERU fare types from consideration. A "False" value is the same as no value. Default is no value. Applicable providers: 1P/1G/1V |
ReturnFailedSegments |
boolean simple type |
|
Optional |
false |
If "true", returns failed segments information. |
ReturnFareAttributes |
boolean simple type |
|
Optional |
false |
Returns attributes that are associated to a fare |
ReturnServices |
boolean simple type |
|
Optional |
false |
When set to false, ATPCO filed Optional Services will not be returned. Default is false. Provider: 1G, 1V, 1P |
SellCheck |
boolean simple type |
|
Optional |
false |
Checks if the segment is bookable before pricing |
SellCity |
string simple type |
|
Optional |
|
City Code identifying where the ticket is to be sold. |
TicketingCity |
string simple type |
|
Optional |
|
City Code identifying where the ticket will be issued. |
ProhibitedRuleCategories |
element |
|
|
|
City Code identifying where the ticket will be issued. |
FareRuleCategory |
element |
|
|
|
Rule Categories to filter on. |
Category |
integer simple type |
|
Required |
|
|
AccountCodes |
element |
|
|
|
|
AccountCode |
element |
|
|
|
Account Code is used to get Private Fares.If ProviderCode or SupplierCode is not specified,it will be considered a default AccounCode to be sent to all the Providers or Suppliers. |
Code |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
An identifier to categorize this account code. For example, FlightPass for AC Flight Pass or RFB for AC corporate Rewards for Business. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
PermittedCabins |
element |
|
|
|
|
CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
Type |
string simple type |
|
Required |
|
|
ContractCodes |
element |
|
|
|
|
ContractCode |
element |
|
|
|
Some private fares (non-ATPCO) are secured to a
contract code. |
Code |
string simple type |
|
Required |
|
The 1-64 character string which uniquely
identifies a Contract. |
CompanyName |
string simple type |
|
Optional |
|
Providers supported : ACH |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ExemptTaxes |
element |
|
|
|
Request tax exemption for specific tax
category and/or all taxes of a specific country |
AllTaxes |
boolean simple type |
|
Optional |
|
Request exemption of all taxes. |
CompanyName |
string simple type |
|
Optional |
|
The federal government body name must be provided in this element. This field is required by AC |
TaxTerritory |
string simple type |
|
Optional |
|
exemption is achieved by sending in the TaxTerritory in the tax exempt price request. |
CountryCode |
typeCountry simple type |
|
|
|
Specify ISO country code for which tax
exemption is requested. |
TaxCategory |
string simple type |
|
|
|
Specify tax category for which tax
exemption is requested. |
PenaltyFareInformation |
element |
|
|
|
Specify tax category for which tax
exemption is requested. |
ProhibitPenaltyFares |
boolean simple type |
|
Required |
|
Indicates whether user wants penalty
fares to be returned. |
PenaltyInfo |
typeFarePenalty complex type |
|
|
|
Penalty Limit if requested. |
NoShow |
boolean simple type |
|
Optional |
|
The No Show penalty (if any) to change/cancel the fare. |
PenaltyApplies |
string simple type |
Anytime , Before Departure , After Departure |
Optional |
|
|
Amount |
typeMoney simple type |
|
|
|
The penalty (if any) - expressed as the actual
amount of money. Both Amount and Percentage can be present. |
Percentage |
typePercentageWithDecimal simple type |
|
|
|
The penalty (if any) - expressed in
percentage. Both Amount and Percentage can be present. |
DiscountCard |
element |
|
|
|
Rail Discount Card Information |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Number |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
PromoCodes |
element |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
PromoCode |
element |
|
|
|
A container to specify Promotional code with Provider code and Supplier code. |
Code |
string simple type |
|
Required |
|
To be used to specify Promotional Code. |
ProviderCode |
string simple type |
|
Required |
|
To be used to specify Provider Code. |
SupplierCode |
string simple type |
|
Required |
|
To be used to specify Supplier Code. |
ManualFareAdjustment |
element |
|
|
|
To be used to specify Supplier Code. |
AdjustmentType |
string simple type |
Amount , Percentage |
Required |
|
Represents process used for applying manual discount/increment. Presently supported values are Flat, Percentage. |
AppliedOn |
string simple type |
Base , Total , Other |
Required |
|
Represents pricing component upon which manual increment/discount to be applied. Presently supported values are Base and Total. Other is present as a future place holder but presently no request processing logic is available for value Other |
FareType |
string simple type |
|
Optional |
|
Providers: 1p |
PassengerRef |
string simple type |
|
Optional |
|
Represents passenger association. |
TicketDesignator |
string simple type |
|
Optional |
|
Providers: 1p |
Value |
decimal simple type |
|
Required |
|
Represents value of increment/discount applied. Negative value is considered as discount whereas positive value represents increment |
PointOfSale |
element |
|
|
|
User can use this node to send a specific PCC to access fares allowed only for that PCC. This node gives the capability for fare redistribution at UR level. For fare redistribution at the stored fare level see AirPricingSolution/AirPricingInfo/AirPricingModifiers/PointOfSale. |
IATA |
string simple type |
|
Optional |
|
Used for rapid reprice. This field is the IATA associated to this Point of Sale PCC. Providers: 1G/1V |
Key |
string simple type |
|
Optional |
|
|
ProviderCode |
string simple type |
|
Required |
|
The provider in which the PCC is defined. |
PseudoCityCode |
string simple type |
|
Required |
|
The PCC in the host system. |
BrandModifiers |
element |
|
|
|
Used to specify the level of branding requested. |
FareFamilyDisplay |
element |
|
|
|
Used to request a fare family display. |
ModifierType |
string simple type |
|
Required |
|
"FareFamily" returns the lowest branded fares in a fare family.
"MaintainBookingCode" attempts to return the lowest branded fare in a fare family display based on the permitted booking code. Any brand that does not have a fare for the permitted booking code will then have the lowest fare returned.
"LowestFareInBrand" returns the lowest fare within each branded fare in a fare family display. |
BasicDetailsOnly |
element |
|
|
|
Used to request basic details of the brand. |
ReturnBasicDetails |
boolean simple type |
|
Required |
|
|
MultiGDSSearchIndicator |
element |
|
|
|
Indicates whether public fares and/or private fares should be returned. |
DefaultProvider |
boolean simple type |
|
Optional |
|
Use the value “true” if the provider is the default (primary) provider. Use the value “false” if the provider is the alternate (secondary). Use of this attribute requires specifically provisioned credentials. |
PrivateFareCode |
string simple type |
|
Optional |
|
The code of the corporate private fare. This is the same as an account code. Use of this attribute requires specifically provisioned credentials. |
PrivateFareCodeOnly |
boolean simple type |
|
Optional |
|
: Indicates whether or not the private fares returned should be restricted to only those specific to the PrivateFareCode in the previous attribute. This has the same validation as the AccountCodeFaresOnly attribute. Use of this attribute requires specifically provisioned credentials. |
ProviderCode |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
Indicates whether only public fares or both public and private fares should be returned or a specific type of private fares. Examples of valid values are PublicFaresOnly, PrivateFaresOnly, AirlinePrivateFaresOnly, AgencyPrivateFaresOnly, PublicandPrivateFares, and NetFaresOnly. |
PreferredCabins |
element |
|
|
|
Indicates whether only public fares or both public and private fares should be returned or a specific type of private fares. Examples of valid values are PublicFaresOnly, PrivateFaresOnly, AirlinePrivateFaresOnly, AgencyPrivateFaresOnly, PublicandPrivateFares, and NetFaresOnly. |
CabinClass |
element |
|
|
|
Requests cabin class (First, Business and Economy, etc.) as supported by the provider or supplier. |
Type |
string simple type |
|
Required |
|
|
TicketingModifiersRef |
element |
|
|
|
Reference to a shared list of Ticketing
Modifers |
Key |
string simple type |
|
Required |
|
|
AirSegmentPricingModifiers |
element |
|
|
|
Specifies modifiers that a particular
segment should be priced in. If this is used, then there must be one
for each AirSegment in the AirItinerary. |
AccountCode |
string simple type |
|
Optional |
|
|
AirSegmentRef |
string simple type |
|
Optional |
|
|
BrandTier |
string simple type |
|
Optional |
|
Modifier to price by specific brand tier number. |
CabinClass |
string simple type |
|
Optional |
|
|
ConnectionIndicator |
string simple type |
AvailabilityAndPricing , TurnAround , Stopover |
Optional |
|
ConnectionIndicator attribute will be used to map connection indicators
AvailabilityAndPricing, TurnAround and Stopover. This attribute is for Wordspan/1P only. |
FareBasisCode |
string simple type |
|
Optional |
|
The fare basis code to be used for pricing. |
FareBreak |
string simple type |
MustBreak , MustOnlyBreak , MustNotBreak |
Optional |
|
Fare break point modifier to instruct Fares
where it should or should not break the fare. |
ProhibitAdvancePurchaseFares |
boolean simple type |
|
Optional |
false |
|
ProhibitNonRefundableFares |
boolean simple type |
|
Optional |
false |
|
ProhibitPenaltyFares |
boolean simple type |
|
Optional |
false |
|
PermittedBookingCodes |
element |
|
|
|
|
BookingCode |
element |
|
|
|
The Booking Code (Class of Service) for a
segment |
Code |
string simple type |
|
Required |
|
|
FlightOptionsList |
element |
|
|
|
List of Flight Options for the itinerary. |
FlightOption |
element |
|
|
|
List of Options available for any search air leg. |
Destination |
string simple type |
|
Required |
|
The IATA location code for this destination of this entity. |
LegRef |
string simple type |
|
Optional |
|
Identifies the Leg Reference for this Flight Option. |
Origin |
string simple type |
|
Required |
|
The IATA location code for this origination of this entity. |
Option |
element |
|
|
|
List of segment and fare available for the search air leg. |
Key |
string simple type |
|
Required |
|
|
TravelTime |
duration simple type |
|
Optional |
|
Total traveling time that is difference between the departure time of the first segment and the arrival time of the last segments for that particular entire set of connection. |
BookingInfo |
element |
|
|
|
Links segments and fares together |
AirItinerarySolutionRef |
string simple type |
|
Optional |
|
Reference to an Air Itinerary Solution |
BookingCode |
string simple type |
|
Required |
|
|
BookingCount |
string simple type |
|
Optional |
|
Seat availability of the BookingCode |
CabinClass |
string simple type |
|
Optional |
|
|
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that booking is relative
(if applicable) |
FareInfoRef |
string simple type |
|
Required |
|
|
HostTokenRef |
string simple type |
|
Optional |
|
HostToken Reference for this segment and fare combination. |
SegmentRef |
string simple type |
|
Optional |
|
|
TaxInfoRef |
string simple type |
|
Optional |
|
TaxInfo Reference for booking info and tax info combination. |
Connection |
element |
|
|
|
Flight Connection Information |
ChangeOfAirport |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
airports between flights. |
ChangeOfPlane |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
planes between flights. |
ChangeOfTerminal |
boolean simple type |
|
Optional |
false |
Indicates the traveler must change
terminals between flights. |
Duration |
long simple type |
|
Optional |
|
The actual duration (in minutes) between
flights. |
FlightDetailsIndex |
long simple type |
|
Optional |
|
The sequential FlightDetails number that this
connection information applies to. |
IncludeStopOverToFareQuote |
string simple type |
NoStopOver , StopOver , IgnoreSegment |
Optional |
|
The field determines to quote fares with or
without stop overs,the values can be NoStopOver,StopOver and
IgnoreSegment. |
MinConnectionTime |
long simple type |
|
Optional |
|
The minimum time needed to connect between the
two different destinations. |
SegmentIndex |
long simple type |
|
Optional |
|
The sequential AirSegment number that this
connection information applies to. |
StopOver |
boolean simple type |
|
Optional |
false |
Indicates that there is a significant
delay between flights (usually 12 hours or more) |
FareNote |
element |
|
|
|
A simple textual fare note. Used within several
other objects. |
FareInfoMessageRef |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
NoteName |
string simple type |
|
Optional |
|
|
Precedence |
decimal simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
BaggageAllowances |
element |
|
|
|
Details of Baggage allowance |
BaggageAllowanceInfo |
element |
|
|
|
Information related to Baggage allowance like URL,Height,Weight etc. |
Carrier |
string simple type |
|
Optional |
|
|
Destination |
string simple type |
|
Optional |
|
|
Origin |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
TravelerType |
string simple type |
|
Optional |
|
|
URLInfo |
element |
|
|
|
Contains the text and URL of baggage as published by carrier. |
Text |
typeGeneralText simple type |
|
|
|
Contains the text and URL of baggage as published by carrier. |
URL |
anyURI simple type |
|
|
|
Contains the text and URL of baggage as published by carrier. |
TextInfo |
element |
|
|
|
Information on baggage as published by carrier. |
Title |
string simple type |
|
Optional |
|
|
Text |
typeGeneralText simple type |
|
|
|
|
BagDetails |
element |
|
|
|
Information related to Bag details . |
ApplicableBags |
string simple type |
|
Required |
|
Applicable baggage like Carry-On,1st Check-in,2nd Check -in etc. |
ApproximateBasePrice |
string simple type |
|
Optional |
|
|
ApproximateTotalPrice |
string simple type |
|
Optional |
|
|
BasePrice |
string simple type |
|
Optional |
|
|
Taxes |
string simple type |
|
Optional |
|
|
TotalPrice |
string simple type |
|
Optional |
|
|
BaggageRestriction |
element |
|
|
|
Information related to Baggage restriction rules . |
Dimension |
element |
|
|
|
Information related to Length,Height,Width of a baggage. |
Unit |
string simple type |
|
Optional |
|
Unit values would be lb,Lb,kg etc. |
Value |
float simple type |
|
Optional |
|
|
type |
string simple type |
|
Optional |
|
Type denotes Length,Height,Width of a baggage. |
MaxWeight |
typeUnitOfMeasure complex type |
|
|
|
Type denotes Length,Height,Width of a baggage. |
Unit |
string simple type |
|
Optional |
|
Unit values would be lb,Lb,kg etc. |
Value |
float simple type |
|
Optional |
|
|
TextInfo |
element |
|
|
|
Information on baggage as published by carrier. |
Title |
string simple type |
|
Optional |
|
|
Text |
typeGeneralText simple type |
|
|
|
|
AvailableDiscount |
element |
|
|
|
|
Amount |
string simple type |
|
Optional |
|
|
Description |
string simple type |
|
Optional |
|
|
DiscountQualifier |
string simple type |
|
Optional |
|
|
Percent |
string simple type |
|
Optional |
|
|
LoyaltyProgram |
element |
|
|
|
|
Level |
anySimpleType simple type |
|
Optional |
|
|
AllianceLevel |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
MembershipProgram |
string simple type |
|
Optional |
|
Loyalty Program membership Id of the traveler specific to Amtrak(2V) Guest Rewards |
SupplierCode |
string simple type |
|
Required |
|
The code used to identify the Loyalty supplier, e.g. AA, ZE, MC |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
CarryOnAllowanceInfo |
element |
|
|
|
Information related to Carry-On allowance like URL, pricing etc |
Carrier |
string simple type |
|
Optional |
|
|
Destination |
string simple type |
|
Optional |
|
|
Origin |
string simple type |
|
Optional |
|
|
URLInfo |
element |
|
|
|
Contains the text and URL of baggage as published by carrier. |
Text |
typeGeneralText simple type |
|
|
|
Contains the text and URL of baggage as published by carrier. |
URL |
anyURI simple type |
|
|
|
Contains the text and URL of baggage as published by carrier. |
TextInfo |
element |
|
|
|
Information on baggage as published by carrier. |
Title |
string simple type |
|
Optional |
|
|
Text |
typeGeneralText simple type |
|
|
|
|
CarryOnDetails |
element |
|
|
|
Information related to Carry-On Bag details . |
ApplicableCarryOnBags |
string simple type |
|
Optional |
|
Applicable Carry-On baggage "First", "Second", "Third" etc |
ApproximateBasePrice |
string simple type |
|
Optional |
|
|
ApproximateTotalPrice |
string simple type |
|
Optional |
|
|
BasePrice |
string simple type |
|
Optional |
|
|
Taxes |
string simple type |
|
Optional |
|
|
TotalPrice |
string simple type |
|
Optional |
|
|
BaggageRestriction |
element |
|
|
|
Information related to Baggage restriction rules . |
Dimension |
element |
|
|
|
Information related to Length,Height,Width of a baggage. |
Unit |
string simple type |
|
Optional |
|
Unit values would be lb,Lb,kg etc. |
Value |
float simple type |
|
Optional |
|
|
type |
string simple type |
|
Optional |
|
Type denotes Length,Height,Width of a baggage. |
MaxWeight |
typeUnitOfMeasure complex type |
|
|
|
Type denotes Length,Height,Width of a baggage. |
Unit |
string simple type |
|
Optional |
|
Unit values would be lb,Lb,kg etc. |
Value |
float simple type |
|
Optional |
|
|
TextInfo |
element |
|
|
|
Information on baggage as published by carrier. |
Title |
string simple type |
|
Optional |
|
|
Text |
typeGeneralText simple type |
|
|
|
|
EmbargoInfo |
BaseBaggageAllowanceInfo complex type |
|
|
|
Information related to Embargo |
Carrier |
string simple type |
|
Optional |
|
|
Destination |
string simple type |
|
Optional |
|
|
Origin |
string simple type |
|
Optional |
|
|
URLInfo |
element |
|
|
|
Contains the text and URL of baggage as published by carrier. |
Text |
typeGeneralText simple type |
|
|
|
Contains the text and URL of baggage as published by carrier. |
URL |
anyURI simple type |
|
|
|
Contains the text and URL of baggage as published by carrier. |
TextInfo |
element |
|
|
|
Information on baggage as published by carrier. |
Title |
string simple type |
|
Optional |
|
|
Text |
typeGeneralText simple type |
|
|
|
|
FareRulesFilter |
element |
|
|
|
Fare Rules Filter about this fare component. Applicable Providers are 1P,1G,1V. |
Refundability |
element |
|
|
|
Refundability/Penalty Fare Rules about this fare component. |
Value |
string simple type |
|
Required |
|
Currently returned: FullyRefundable (1G,1V), RefundableWithPenalty (1G,1V), Refundable (1P), NonRefundable (1G,1V,1P).Refundable. |
LatestTicketingTime |
dateTime simple type |
|
|
|
For Future Use |
CHG |
CHGType complex type |
|
|
|
For Penalties |
PenFee |
PenFeeType complex type |
|
|
|
For Penalties |
AirVFee |
boolean simple type |
|
Optional |
|
Carrier fee. True if carrier fee is assessed should passenger for complete all conditions for travel at fare. False if it does not exist. |
Amt |
decimal simple type |
|
Optional |
|
Amount of penalty. If XXX.XX then it is an amount. If it is XX then is is a percenatge. Eg 100.00 or 000100. |
Applicable |
boolean simple type |
|
Optional |
|
Applicable. True if amount specified is applicable. Flase if amount specified is not applicable. |
ApplicableTo |
boolean simple type |
|
Optional |
|
Applicable to penalty or deposit. True if amount specified applies to penalty. False if amount specified applies to deposit. |
Cancellation |
boolean simple type |
|
Optional |
|
Cancellation. True if subject to penalty. False if no penalty. |
Currency |
string simple type |
|
Optional |
|
Currency code of penalty (e.g. USD). |
DepNonRef |
boolean simple type |
|
Optional |
|
Deposit non-refundable. True is non-refundanbe. False is refundable. |
DepRequired |
boolean simple type |
|
Optional |
|
Deposit required. True if require. False if not required. |
FailConfirmSpace |
boolean simple type |
|
Optional |
|
Failure to confirm space. True if subject to penalty if seats are not confirmed. False if subject to penalty if seats are confirmed. |
ItinChg |
boolean simple type |
|
Optional |
|
Subject to penalty if Itinerary is changed requiring reissue of ticket. True if subject to penalty. False if no penalty if reissue required. |
ReplaceTk |
boolean simple type |
|
Optional |
|
Replace ticket. True if subject to penalty, if replacement of lost ticket / exchange order. False if no penalty, if replacement of lost ticket or exchange order. |
TkNonRef |
boolean simple type |
|
Optional |
|
Ticket non-refundable. True if non-refundanbe. False if refundable. |
Type |
string simple type |
|
Optional |
|
Type of penalty. If it is D then dollar. If it is P then percentage. |
MIN |
MINType complex type |
|
|
|
For Minimum Stay |
DaysMin |
boolean simple type |
|
Optional |
|
Minimum days. True if unit of time is days. False if unit of time is not days. |
FareComponent |
decimal simple type |
|
Optional |
|
Fare component number of the most restrictive fare. |
HoursMin |
boolean simple type |
|
Optional |
|
Minimum hours. True if unit of time is hours. False if unit of time is not hours. |
MonthsMin |
boolean simple type |
|
Optional |
|
Minimum months. True if unit of time is months. False if unit of time is not months. |
NumOccurMin |
decimal simple type |
|
Optional |
|
Number of min occurances. This field is used in conjunction with the Day of Week. |
OccurIndMin |
boolean simple type |
|
Optional |
|
Minimum occurance indicator. True if day of the week is used. False if day of the week is not used. |
SameDayMin |
boolean simple type |
|
Optional |
|
Same day minimum. True if Stay is same day. False if Stay is not same day. |
TmDOWMin |
decimal simple type |
|
Optional |
|
If a min unit of time is true then number corrolates to day of the week starting with 1 for Sunday. |
MAX |
MAXType complex type |
|
|
|
For Maximum Stay |
CompletionInd |
boolean simple type |
|
Optional |
|
Completion indicator. True if Completion C Indicator. False if not Completion C Indicator. |
DaysMax |
boolean simple type |
|
Optional |
|
Maximum days. True if unit of time is days. False if unit of time is not days. |
HoursMax |
boolean simple type |
|
Optional |
|
Maximum hours. True if unit of time is hours. False if unit of time is not hours. |
MonthsMax |
boolean simple type |
|
Optional |
|
Maximum months. True if unit of time is months. False if unit of time is not months. |
NumOccurMax |
decimal simple type |
|
Optional |
|
Number of maximum occurances. |
OccurIndMax |
boolean simple type |
|
Optional |
|
Maximum cccurance indicator. True if day of the week is used. False if day of the week is not used. |
SameDayMax |
boolean simple type |
|
Optional |
|
Same day maximum. True if Stay is same day. False if Stay is not same day. |
StartIndMax |
boolean simple type |
|
Optional |
|
Start indicator. True if start indicator. False if not a start indicator. |
TmDOWMax |
decimal simple type |
|
Optional |
|
If a max unit of time is true then number corrolates to day of the week starting with 1 for Sunday. |
ADV |
ADVType complex type |
|
|
|
For Advance Res/Tkt |
AdvRsvnAnyTm |
boolean simple type |
|
Optional |
|
Reservation anytime. True if advanced reservatiosn anytime. False if advanced reservations for a limited time. |
AdvRsvnDataExists |
boolean simple type |
|
Optional |
|
Reservation data exists. True if advanced reservation data exists. False if advanced reservation data does not exist. |
AdvRsvnDays |
boolean simple type |
|
Optional |
|
Reservation days. True if advanced reservation time in days. False if advanced reservation time not in days. |
AdvRsvnEarliestTm |
boolean simple type |
|
Optional |
|
Earliest reservation time. True if advanced reservations time is earliest permitted. False is advanced reservation time not earliest permitted time. |
AdvRsvnEndItem |
boolean simple type |
|
Optional |
|
Reservation end item. True if advanced reservation end item and more values. False if it does not exist. |
AdvRsvnHrs |
boolean simple type |
|
Optional |
|
Reservation hours. True if advanced reservation time in hours. False if advanced reservation time not in hours. |
AdvRsvnLatestTm |
boolean simple type |
|
Optional |
|
Latest reservation time. True if advanced reservations time is latest permitted. False is advanced reservation time not latest permitted time. |
AdvRsvnMonths |
boolean simple type |
|
Optional |
|
Reservation months. True if advanced reservation time in months. False if advanced reservation time not in months. |
AdvRsvnOnlyIfTk |
boolean simple type |
|
Optional |
|
Reservation only if ticketed. True is advanced reservations only if tickets. False is no advanced reservations |
AdvRsvnTm |
decimal simple type |
|
Optional |
|
Advanced reservation time. |
AdvRsvnWaived |
boolean simple type |
|
Optional |
|
Reservation Waived. True if advanced reservation waived. False if advanced reservation not waived. |
AdvTkAnyTm |
boolean simple type |
|
Optional |
|
Ticketing anytime. True if anytime. False if limited time. |
AdvTkEarliestTm |
boolean simple type |
|
Optional |
|
Earliest ticketing time. True if earliest permitted. False if not earliest permitted. |
AdvTkEndItem |
boolean simple type |
|
Optional |
|
Ticketing end item. True if advanced ticketing item and more values. False if end item does not exist. |
AdvTkLatestTm |
boolean simple type |
|
Optional |
|
Latest ticketing time. True if time is latest permitted. False if time is not latest permitted. |
AdvTkRsvnDays |
boolean simple type |
|
Optional |
|
Ticketing reservation days. True if in days. False if not in days. |
AdvTkRsvnHrs |
boolean simple type |
|
Optional |
|
Ticketing reservation hours. True if in hours. False if not in hours. |
AdvTkRsvnMonths |
boolean simple type |
|
Optional |
|
Ticketing reservation months. True if in months. False if not in months. |
AdvTkRsvnTm |
decimal simple type |
|
Optional |
|
Advanced ticketing reservation time. |
AdvTkStartDays |
boolean simple type |
|
Optional |
|
Ticketing departure days. True if in days. False if not in days. |
AdvTkStartHrs |
boolean simple type |
|
Optional |
|
Latest ticketing departure. True if time is latest permitted. False if time is not latest permitted. |
AdvTkStartMonths |
boolean simple type |
|
Optional |
|
Ticketing reservation months. True if in months. False if not in months. |
AdvTkStartTm |
decimal simple type |
|
Optional |
|
Advanced ticketing departure time. |
AdvTkWaived |
boolean simple type |
|
Optional |
|
Ticketing waived. True if waived. False if not waived. |
EarliestRsvnDt |
date simple type |
|
Optional |
|
Earliest reservation date. |
EarliestRsvnDtPresent |
boolean simple type |
|
Optional |
|
Earliest reservation date. True if date is present. False if date is not present. |
EarliestTkDt |
date simple type |
|
Optional |
|
Earliest ticketing date. |
EarliestTkDtPresent |
boolean simple type |
|
Optional |
|
Earliest ticketing date. True if date is present. False if date is not present. |
LatestRsvnDt |
date simple type |
|
Optional |
|
Latest reservation date. |
LatestRsvnDtPresent |
boolean simple type |
|
Optional |
|
Latest reservation date. True if date is present. False if date is not present. |
LatestTkDt |
date simple type |
|
Optional |
|
Latest ticketing date. |
LatestTkDtPresent |
boolean simple type |
|
Optional |
|
Latest ticketing date. True if date is present. False if date is not present. |
OTH |
OTHType complex type |
|
|
|
Other |
Cat0 |
boolean simple type |
|
Optional |
|
Category 0 rules. True if category applies. False if rules do not apply. |
Cat1 |
boolean simple type |
|
Optional |
|
Category 1 rules. True if category applies. False if rules do not apply. |
Cat10 |
boolean simple type |
|
Optional |
|
Category 10 rules. True if category applies. False if rules do not apply. |
Cat11 |
boolean simple type |
|
Optional |
|
Category 11 rules. True if category applies. False if rules do not apply. |
Cat12 |
boolean simple type |
|
Optional |
|
Category 12 rules. True if category applies. False if rules do not apply. |
Cat13 |
boolean simple type |
|
Optional |
|
Category 13 rules. True if category applies. False if rules do not apply. |
Cat14 |
boolean simple type |
|
Optional |
|
Category 14 rules. True if category applies. False if rules do not apply. |
Cat15 |
boolean simple type |
|
Optional |
|
Category 15 rules. True if category applies. False if rules do not apply. |
Cat16 |
boolean simple type |
|
Optional |
|
Category 16 rules. True if category applies. False if rules do not apply. |
Cat17 |
boolean simple type |
|
Optional |
|
Category 17 rules. True if category applies. False if rules do not apply. |
Cat18 |
boolean simple type |
|
Optional |
|
Category 18 rules. True if category applies. False if rules do not apply. |
Cat19 |
boolean simple type |
|
Optional |
|
Category 19 rules. True if category applies. False if rules do not apply. |
Cat2 |
boolean simple type |
|
Optional |
|
Category 2 rules. True if category applies. False if rules do not apply. |
Cat20 |
boolean simple type |
|
Optional |
|
Category 20 rules. True if category applies. False if rules do not apply. |
Cat21 |
boolean simple type |
|
Optional |
|
Category 21 rules. True if category applies. False if rules do not apply. |
Cat22 |
boolean simple type |
|
Optional |
|
Category 22 rules. True if category applies. False if rules do not apply. |
Cat23 |
boolean simple type |
|
Optional |
|
Category 23 rules. True if category applies. False if rules do not apply. |
Cat24 |
boolean simple type |
|
Optional |
|
Category 24 rules. True if category applies. False if rules do not apply. |
Cat25 |
boolean simple type |
|
Optional |
|
Category 25 rules. True if category applies. False if rules do not apply. |
Cat26 |
boolean simple type |
|
Optional |
|
Category 26 rules. True if category applies. False if rules do not apply. |
Cat27 |
boolean simple type |
|
Optional |
|
Category 27 rules. True if category applies. False if rules do not apply. |
Cat28 |
boolean simple type |
|
Optional |
|
Category 28 rules. True if category applies. False if rules do not apply. |
Cat29 |
boolean simple type |
|
Optional |
|
Category 29 rules. True if category applies. False if rules do not apply. |
Cat3 |
boolean simple type |
|
Optional |
|
Category 3 rules. True if category applies. False if rules do not apply. |
Cat30 |
boolean simple type |
|
Optional |
|
Category 30 rules. True if category applies. False if rules do not apply. |
Cat31 |
boolean simple type |
|
Optional |
|
Category 31 rules. True if category applies. False if rules do not apply. |
Cat4 |
boolean simple type |
|
Optional |
|
Category 4 rules. True if category applies. False if rules do not apply. |
Cat5 |
boolean simple type |
|
Optional |
|
Category 5 rules. True if category applies. False if rules do not apply. |
Cat6 |
boolean simple type |
|
Optional |
|
Category 6 rules. True if category applies. False if rules do not apply. |
Cat7 |
boolean simple type |
|
Optional |
|
Category 7 rules. True if category applies. False if rules do not apply. |
Cat8 |
boolean simple type |
|
Optional |
|
Category 8 rules. True if category applies. False if rules do not apply. |
Cat9 |
boolean simple type |
|
Optional |
|
Category 9 rules. True if category applies. False if rules do not apply. |
MissingRules |
boolean simple type |
|
Optional |
|
Missing rules. True if rules are missing. False if rules are not missing. |
NotUSACity |
boolean simple type |
|
Optional |
|
Not USA city. True if Origin or final destination not a continental U.S. City. False if Origin or final destination a continental U.S. City. |
RestrictiveDt |
date simple type |
|
Optional |
|
Most restrictive ticketing date. |
SurchargeAmt |
decimal simple type |
|
Optional |
|
Surcharge amount |
PolicyCodesList |
element |
|
|
|
Surcharge amount |
PolicyCode |
typePolicyCode simple type |
|
|
|
A code that indicates why an item was determined to be ‘out of policy’. |
PriceChange |
PriceChangeType complex type |
|
|
|
Indicates a price change is found in Fare Control Manager |
Amount |
string simple type |
|
Required |
|
Contains the currency and amount information.
Assume the amount is added unless a hyphen is present to indicate subtraction. |
Carrier |
string simple type |
|
Optional |
|
Contains carrier code information |
SegmentRef |
string simple type |
|
Optional |
|
Contains segment reference information |
ActionDetails |
element |
|
|
|
Information related to the storing of the fare: Agent, Date and Action for Provider: 1P |
AgentSine |
string simple type |
|
Optional |
|
The sign in of the user who stored the fare for Provider: 1P |
EventDate |
date simple type |
|
Optional |
|
Date at which the fare was stored for Provider: 1P |
EventTime |
time simple type |
|
Optional |
|
Time at which the fare was stored for Provider: 1P |
PseudoCityCode |
string simple type |
|
Optional |
|
PCC in the host of the agent who stored the fare for Provider: 1P |
Text |
string simple type |
|
Optional |
|
The type of action the agent performed for Provider: 1P |
Commission |
element |
|
|
|
Identifies the agency commission |
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan |
Key |
string simple type |
|
Optional |
|
|
Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
Payment |
element |
|
|
|
Payment information - must be used in conjunction with credit card info |
Amount |
string simple type |
|
Required |
|
|
AmountType |
string simple type |
|
Optional |
|
This field displays type of payment amount when it is non-monetary. Presently available/supported value is "Flight Pass Credits". |
ApproximateAmount |
string simple type |
|
Optional |
|
It stores the converted payment amount in agency's default currency |
BookingTravelerRef |
string simple type |
|
Optional |
|
If the type represents a per traveler payment, then this will reference the traveler this payment refers to. |
FormOfPaymentRef |
string simple type |
|
Required |
|
The credit card that is will be used to make this payment. |
Key |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Optional |
|
Status to indicate the business association of the payment element. |
Type |
string simple type |
AirlineFee , DeliveryFee , Itinerary , Passenger , ServiceFee , OptionalService , TicketFee |
Required |
|
Identifies the type of payment. This can be for an itinerary, a traveler, or a service fee for example. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
CreditCardAuth |
element |
|
|
|
The result of a Credit Auth Request. Will contain all the authorization info and result codes. |
AVSResultCode |
string simple type |
|
Optional |
|
The address verification result code (if AVS was requested) |
Amount |
string simple type |
|
Required |
|
The amount that was authorized. |
AuthCode |
string simple type |
|
Optional |
|
The authorization code to confirm card acceptance |
AuthResultCode |
string simple type |
|
Required |
|
The result code of the authorization command. |
FormOfPaymentRef |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Message |
string simple type |
|
Optional |
|
The message explains the result of the authorization command. |
Number |
string simple type |
|
Optional |
|
|
PaymentRef |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
|
TransId |
string simple type |
|
Optional |
|
The transaction id from the credit processing system |
FareNote |
element |
|
|
|
A simple textual fare note. Used within several
other objects. |
FareInfoMessageRef |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
NoteName |
string simple type |
|
Optional |
|
|
Precedence |
decimal simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
FeeInfo |
typeFeeInfo complex type |
|
|
|
A generic type of fee for those charges which are incurred by the passenger, but not necessarily shown on tickets |
Amount |
string simple type |
|
Required |
|
|
BaseAmount |
string simple type |
|
Optional |
|
|
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
FeeToken |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
|
PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
SubCode |
string simple type |
|
Optional |
|
|
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
Key |
string simple type |
|
Required |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
TaxInfo |
typeTaxInfoWithPaymentRef complex type |
|
|
|
Itinerary level taxes |
CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
PaymentRef |
element |
|
|
|
Reference to one of the air reservation
payments |
Key |
string simple type |
|
Required |
|
|
TicketingModifiers |
element |
|
|
|
A container to identify individual ticketing
modifiers. |
CurrencyOverrideCode |
string simple type |
|
Optional |
|
This modifier allows an agency to specify the currency like L for Local, E for Euro, U for USD, C for CAD (Canadian dollars). |
DocumentInstructionNumber |
string simple type |
|
Optional |
|
The Document Instruction line number. 1P only |
ExemptVAT |
boolean simple type |
|
Optional |
|
Allows an agency to update if VAT is
Exemtped on the fare. |
FreeText |
string simple type |
|
Optional |
|
DI line information shown as free text as in Host. 1P only |
FreeTicket |
boolean simple type |
|
Optional |
|
Indicates free ticket. |
IsPrimaryDI |
boolean simple type |
|
Optional |
false |
Indicates if the DI is Primary DI. 1P only |
Key |
string simple type |
|
Optional |
|
|
NameNumber |
string simple type |
|
Optional |
|
Host Name Number |
NetRemitApplied |
boolean simple type |
|
Optional |
|
Indicator to the BSP net remittance
scheme applies to ticketed fare. |
PlatingCarrier |
string simple type |
|
Optional |
|
Allows an agency to specify the Plating
Carrier for ticketing |
Reference |
string simple type |
|
Optional |
|
Identifies if TicketingModifiers contains DI line information. 1P only. |
Status |
string simple type |
|
Optional |
|
DI line status - ex:Ticketed |
TicketRecord |
string simple type |
|
Optional |
|
Ticket Record Number |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to a booking traveler for which ticketing modifier is applied. |
NetRemit |
typeTicketModifierAmountType complex type |
|
|
|
Allows an agency to override the net
remittance amount - varies by BSP agreement |
Amount |
string simple type |
|
Required |
|
Amount associated with a ticketing modifier |
NetFare |
typeTicketModifierAmountType complex type |
|
|
|
Net Fare amount for a ticketed fare |
Amount |
string simple type |
|
Required |
|
Amount associated with a ticketing modifier |
ActualSellingFare |
typeTicketModifierAmountType complex type |
|
|
|
Allows an agency to report an Actual
Selling Fare as part of the net remittance BSP agreement |
Amount |
string simple type |
|
Required |
|
Amount associated with a ticketing modifier |
InvoiceFare |
typeTicketModifierAccountingType complex type |
|
|
|
Allows an agency to report an Invoice Fare
as part of the net remittance BSP agreement |
Value |
string simple type |
|
|
|
Allows an agency to report an Invoice Fare
as part of the net remittance BSP agreement |
CorporateDiscount |
typeTicketModifierAccountingType complex type |
|
|
|
Allows an agency to add a corporate
discount to the itinerary to be ticketed |
Value |
string simple type |
|
|
|
Allows an agency to add a corporate
discount to the itinerary to be ticketed |
AccountingInfo |
typeTicketModifierAccountingType complex type |
|
|
|
Allows an agency to report Accounting
Information as part of the net remittance BSP agreement |
Value |
string simple type |
|
|
|
Allows an agency to report Accounting
Information as part of the net remittance BSP agreement |
BulkTicket |
element |
|
|
|
Allows an agency to update the fare as a
Bulk ticket - Optional SuppressOnFareCalc attribute will control
how fare calculation is printed on the ticket |
SuppressOnFareCalc |
boolean simple type |
|
Optional |
|
Optional attribute to allow a modifier
impact such as Bulk Ticketing to have information suppressed on the
Fare Calc when generating supporting documents Check the specific
host system which may or may not support this function |
NonRefundable |
boolean simple type |
|
Optional |
|
Indicates bulk ticket being
non-refundable |
GroupTour |
typeBulkTicketModifierType complex type |
|
|
|
Allows an agency to update the fare as a
Group Tour (inclusive tour) ticket - Optional SuppressOnFareCalc
attribute will control how fare calculation is printed on the
ticket |
SuppressOnFareCalc |
boolean simple type |
|
Optional |
|
Optional attribute to allow a modifier
impact such as Bulk Ticketing to have information suppressed on the
Fare Calc when generating supporting documents Check the specific
host system which may or may not support this function |
Commission |
element |
|
|
|
Identifies the agency commission |
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan |
Key |
string simple type |
|
Optional |
|
|
Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
TourCode |
element |
|
|
|
Tour Code Fare Basis |
Value |
string simple type |
|
Required |
|
|
TicketEndorsement |
element |
|
|
|
|
Value |
string simple type |
|
Required |
|
|
ValueModifier |
typeTicketModifierValueType complex type |
|
|
|
Allows an agency to modify value or
commission of the ticket. The modifier is generic and depends on
the specific GDS and BSP implementation |
NetFareValue |
boolean simple type |
|
Optional |
|
Treat the value as net fare discount
information |
Value |
string simple type |
|
|
|
Treat the value as net fare discount
information |
DocumentSelect |
element |
|
|
|
Allows an agency to select the documents to
produce for the itinerary. |
FaxIndicator |
boolean simple type |
|
Optional |
|
Set to true for providing fax details. |
IssueElectronicTicket |
boolean simple type |
|
Optional |
|
Set to true for electronic tickets. |
IssueTicketOnly |
boolean simple type |
|
Optional |
|
Set to true to alter system default of
itinerary,ticket and back office. |
BackOfficeHandOff |
element |
|
|
|
Allows an agency to select the back office
documents and also route to different host to produce for the
itinerary. |
Location |
string simple type |
|
Optional |
|
This is required for NonAccountingRemote,Dual
and Global type back office. |
PseudoCityCode |
string simple type |
|
Optional |
|
The PCC of the host system where it would be
routed. |
Type |
string simple type |
Accounting , Global , NonAccounting , NonAccountingRemote , Dual |
Required |
|
The type of back office document,valid options
are Accounting,Global,NonAccounting,NonAccountingRemote,Dual. |
Itinerary |
element |
|
|
|
Allows an agency to select the itinenary
option for ticket. |
Option |
string simple type |
NoFare , NoAmount , SequenceNumber |
Optional |
|
Specifies the itinerary option like
NoFare,NoAmount. |
SeparateIndicator |
boolean simple type |
|
Optional |
|
Set to true if one itinerary to be printed per
passenger. |
Type |
string simple type |
Invoice , Pocket |
Optional |
|
Specifies the type of itinenary option
for ticket like Invoice type or Pocket itinenary. |
DocumentOptions |
element |
|
|
|
Allows an agency to set different document
options for the itinerary. |
GenerateItinNumbers |
boolean simple type |
|
Optional |
|
True when itinerary numbers are system
generated. |
SuppressItineraryRemarks |
boolean simple type |
|
Optional |
|
True when itinerary remarks are suppressed. |
PassengerReceiptOverride |
element |
|
|
|
It is required when a passenger receipt is
required immediately ,GDS overrides the default value |
OverrideOption |
typeOverrideOption simple type |
|
|
|
Allows an agency to override print options for documents during document generation. |
SegmentSelect |
element |
|
|
|
To be used to pass the selected segment. |
AllConfirmedAir |
boolean simple type |
|
Optional |
|
Set to true to consider all Confirmed segments including active and passive and set to false to discard confirmed segments |
AllHotel |
boolean simple type |
|
Optional |
|
Set to true to consider all Hotel reservations as Auxiliary segment and false to discard all Hotel reservations |
AllPassive |
boolean simple type |
|
Optional |
|
Set to true to consider all Passive segments as Auxiliary segment and false to discard passive segments |
AllVehicle |
boolean simple type |
|
Optional |
|
Set to true to consider all Vehicle reservations as Auxiliary segment and false to discard all Vehicle reservations |
AllWaitlistedAir |
boolean simple type |
|
Optional |
|
Set to true to consider all Waitlisted segments and false to discard all waitlisted segments |
AirSegmentRef |
typeSegmentRef complex type |
|
|
|
Reference to AirSegment from an Air Reservation. |
Key |
string simple type |
|
Required |
|
|
HotelReservationRef |
typeNonAirReservationRef complex type |
|
|
|
Specify the locator code of Hotel reservation if it needs to be considered as Auxiliary segment |
LocatorCode |
string simple type |
|
Required |
|
|
VehicleReservationRef |
typeNonAirReservationRef complex type |
|
|
|
Specify the locator code of Vehicle reservation if it needs to be considered as Auxiliary segment |
LocatorCode |
string simple type |
|
Required |
|
|
PassiveSegmentRef |
typeSegmentRef complex type |
|
|
|
Reference to PassiveSegment from a Passive Reservation.Specify the passive segment if it needs to be considered as Auxiliary segment |
Key |
string simple type |
|
Required |
|
|
SegmentModifiers |
element |
|
|
|
To be used to modify the ticket modifiers for air
segment |
AirSegmentRef |
element |
|
|
|
Reference to a complete AirSegment from a
shared list |
Key |
string simple type |
|
Required |
|
|
TicketValidity |
element |
|
|
|
To be used to pass the selected segment |
NotValidAfter |
date simple type |
|
Optional |
|
Fare not valid after this date. |
NotValidBefore |
date simple type |
|
Optional |
|
Fare not valid before this date. |
BaggageAllowance |
element |
|
|
|
Free Baggage Allowance |
NumberOfPieces |
integer simple type |
|
|
|
Free Baggage Allowance |
MaxWeight |
typeWeight complex type |
|
|
|
Free Baggage Allowance |
Unit |
string simple type |
Kilograms , Pounds |
Optional |
|
|
Value |
decimal simple type |
|
Optional |
|
|
TicketDesignator |
typeTicketDesignator simple type |
|
|
|
|
SupplierLocator |
element |
|
|
|
Locator code on the host carrier system |
CreateDateTime |
dateTime simple type |
|
Optional |
|
The Date and Time which the reservation is received from the Vendor as a SupplierLocator creation Date. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider Reservation reference |
SupplierCode |
string simple type |
|
Required |
|
Carrier Code |
SupplierLocatorCode |
string simple type |
|
Required |
|
Carrier reservation locator code |
SegmentRef |
typeGeneralReference complex type |
|
|
|
Air/Passive Segment Reference |
Key |
string simple type |
|
Required |
|
|
DestinationPurposeCode |
element |
|
|
|
This code is required to indicate destination
and purpose of Travel. It is applicable for Canada and Bermuda
agency
only. This is used by Worldspan. |
Destination |
string simple type |
MexicoCostRicaCentralAmerica , Caribbean , SouthAmerica , Europe , Africa , MiddleEastWesternAsia , Asia , AustraliaNewZealandPacificIslands , CanadaGreenland , USA |
Required |
|
|
Purpose |
string simple type |
Business , Pleasure , CharterService |
Required |
|
|
LanguageOption |
element |
|
|
|
Enables itineraries and invoices to print in different languages. |
Country |
string simple type |
|
Required |
|
2 Letter ISO Country code |
Language |
string simple type |
|
Required |
|
2 Letter ISO Language code |
LandCharges |
element |
|
|
|
Prints non-air charges on a document. |
Base |
string simple type |
|
Optional |
|
|
Deposit |
string simple type |
|
Optional |
|
|
Miscellaneous |
string simple type |
|
Optional |
|
|
PrePaid |
string simple type |
|
Optional |
|
|
Total |
string simple type |
|
Optional |
|
|
Tax |
element |
|
|
|
Taxes for Land Charges |
Amount |
string simple type |
|
Required |
|
|
Category |
string simple type |
|
Optional |
|
The tax category represents a valid IATA tax code. |
PrintBlankFormItinerary |
element |
|
|
|
Produce a customized itinerary/Invoice document in blank form format. |
IncludeDescription |
boolean simple type |
|
Required |
|
If it is true then document will be printed including descriptions. |
IncludeHeader |
boolean simple type |
|
Required |
|
If it is true then document will be printed including it's header. |
ExemptOBFee |
element |
|
|
|
Used to specify which OB fees are exempt; if none are listed, it means all should be exempt. |
SubCode |
typeSubCode simple type |
|
|
|
Used to specify which OB fees are exempt; if none are listed, it means all should be exempt. |
AssociatedRemark |
element |
|
|
|
Used to specify which OB fees are exempt; if none are listed, it means all should be exempt. |
SegmentRef |
string simple type |
|
Optional |
|
Reference to an Air/Passive Segment |
Key |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this element is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
PocketItineraryRemark |
element |
|
|
|
Reference to Booking Traveler. |
SegmentRef |
string simple type |
|
Optional |
|
Reference to an Air/Passive Segment |
Key |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this element is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
AirExchangeBundleTotal |
element |
|
|
|
Total exchange and penalty information for one ticket number |
AirExchangeInfo |
element |
|
|
|
Provides results of a exchange quote |
AddCollection |
string simple type |
|
Optional |
|
|
BaseFare |
string simple type |
|
Optional |
|
|
BulkTicketAdvisory |
boolean simple type |
|
Optional |
|
|
ChangeFee |
string simple type |
|
Optional |
|
|
EquivalentBaseFare |
string simple type |
|
Optional |
|
|
EquivalentChangeFee |
string simple type |
|
Optional |
|
|
EquivalentExchangeAmount |
string simple type |
|
Optional |
|
|
ExchangeAmount |
string simple type |
|
Required |
|
|
Exchangeable |
boolean simple type |
|
Optional |
|
|
FarePull |
string simple type |
ReverseOfOriginDestination , SameAsOriginDestination |
Optional |
|
|
FirstClassUpgrade |
boolean simple type |
|
Optional |
|
|
FlownSegmentValue |
string simple type |
|
Optional |
|
|
ForfeitAmount |
string simple type |
|
Optional |
|
|
FormOfRefund |
string simple type |
MCO , FormOfPayment |
Optional |
|
How the refund will be issued. Values will be MCO or FormOfPayment |
OriginalFlightValue |
string simple type |
|
Optional |
|
|
PassengerCount |
decimal simple type |
|
Optional |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
|
PricingTag |
string simple type |
|
Optional |
|
|
Refund |
string simple type |
|
Optional |
|
Total refund amount. |
Refundable |
boolean simple type |
|
Optional |
|
|
ResidualValue |
string simple type |
|
Optional |
|
|
Taxes |
string simple type |
|
Optional |
|
|
TicketByDate |
string simple type |
|
Optional |
|
|
TotalResidualValue |
string simple type |
|
Optional |
|
|
TotalPenaltyTaxInfo |
element |
|
|
|
|
TotalPenaltyTax |
string simple type |
|
Optional |
|
|
PenaltyTaxInfo |
typeTax complex type |
|
|
|
|
Amount |
string simple type |
|
Optional |
|
|
Code |
string simple type |
|
Optional |
|
|
PaidTax |
typeTax complex type |
|
|
|
|
Amount |
string simple type |
|
Optional |
|
|
Code |
string simple type |
|
Optional |
|
|
TicketFeeInfo |
element |
|
|
|
Used for rapid reprice. Providers: 1G/1V/1P/1S/1A |
Base |
string simple type |
|
Optional |
|
|
Tax |
string simple type |
|
Optional |
|
|
Total |
string simple type |
|
Optional |
|
|
Reason |
string simple type |
|
|
|
Used for rapid reprice. The reason code or text is returned if the
PricingTag is not equal to A, and explains why A was not returned.
Providers: 1G/1V/1P/1S/1A |
FeeInfo |
typeFeeInfo complex type |
|
|
|
Used for rapid reprice. The reason code or text is returned if the
PricingTag is not equal to A, and explains why A was not returned.
Providers: 1G/1V/1P/1S/1A |
Amount |
string simple type |
|
Required |
|
|
BaseAmount |
string simple type |
|
Optional |
|
|
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
FeeToken |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
|
PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
SubCode |
string simple type |
|
Optional |
|
|
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
Key |
string simple type |
|
Required |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
TaxInfo |
typeTaxInfo complex type |
|
|
|
Itinerary level taxes |
CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
Penalty |
element |
|
|
|
Exchange penalty information |
CancelRefund |
boolean simple type |
|
Optional |
|
|
CancelationPenalty |
boolean simple type |
|
Optional |
|
|
ChargeApplicable |
boolean simple type |
|
Optional |
|
|
ChargePortion |
boolean simple type |
|
Optional |
|
|
NonExchangeable |
boolean simple type |
|
Optional |
|
|
NonRefundable |
boolean simple type |
|
Optional |
|
|
NonReissuePenalty |
boolean simple type |
|
Optional |
|
|
PenaltyAmount |
string simple type |
|
Optional |
|
|
ReissuePenalty |
boolean simple type |
|
Optional |
|
|
TicketRefundPenalty |
boolean simple type |
|
Optional |
|
|
AirExchangeBundle |
element |
|
|
|
Bundle exchange, pricing, and penalty
information for one ticket numberUsed both in request and response |
AirExchangeInfo |
element |
|
|
|
Provides results of a exchange quote |
AddCollection |
string simple type |
|
Optional |
|
|
BaseFare |
string simple type |
|
Optional |
|
|
BulkTicketAdvisory |
boolean simple type |
|
Optional |
|
|
ChangeFee |
string simple type |
|
Optional |
|
|
EquivalentBaseFare |
string simple type |
|
Optional |
|
|
EquivalentChangeFee |
string simple type |
|
Optional |
|
|
EquivalentExchangeAmount |
string simple type |
|
Optional |
|
|
ExchangeAmount |
string simple type |
|
Required |
|
|
Exchangeable |
boolean simple type |
|
Optional |
|
|
FarePull |
string simple type |
ReverseOfOriginDestination , SameAsOriginDestination |
Optional |
|
|
FirstClassUpgrade |
boolean simple type |
|
Optional |
|
|
FlownSegmentValue |
string simple type |
|
Optional |
|
|
ForfeitAmount |
string simple type |
|
Optional |
|
|
FormOfRefund |
string simple type |
MCO , FormOfPayment |
Optional |
|
How the refund will be issued. Values will be MCO or FormOfPayment |
OriginalFlightValue |
string simple type |
|
Optional |
|
|
PassengerCount |
decimal simple type |
|
Optional |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
|
PricingTag |
string simple type |
|
Optional |
|
|
Refund |
string simple type |
|
Optional |
|
Total refund amount. |
Refundable |
boolean simple type |
|
Optional |
|
|
ResidualValue |
string simple type |
|
Optional |
|
|
Taxes |
string simple type |
|
Optional |
|
|
TicketByDate |
string simple type |
|
Optional |
|
|
TotalResidualValue |
string simple type |
|
Optional |
|
|
TotalPenaltyTaxInfo |
element |
|
|
|
|
TotalPenaltyTax |
string simple type |
|
Optional |
|
|
PenaltyTaxInfo |
typeTax complex type |
|
|
|
|
Amount |
string simple type |
|
Optional |
|
|
Code |
string simple type |
|
Optional |
|
|
PaidTax |
typeTax complex type |
|
|
|
|
Amount |
string simple type |
|
Optional |
|
|
Code |
string simple type |
|
Optional |
|
|
TicketFeeInfo |
element |
|
|
|
Used for rapid reprice. Providers: 1G/1V/1P/1S/1A |
Base |
string simple type |
|
Optional |
|
|
Tax |
string simple type |
|
Optional |
|
|
Total |
string simple type |
|
Optional |
|
|
Reason |
string simple type |
|
|
|
Used for rapid reprice. The reason code or text is returned if the
PricingTag is not equal to A, and explains why A was not returned.
Providers: 1G/1V/1P/1S/1A |
FeeInfo |
typeFeeInfo complex type |
|
|
|
Used for rapid reprice. The reason code or text is returned if the
PricingTag is not equal to A, and explains why A was not returned.
Providers: 1G/1V/1P/1S/1A |
Amount |
string simple type |
|
Required |
|
|
BaseAmount |
string simple type |
|
Optional |
|
|
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to booking traveler |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
FeeToken |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
|
PaymentRef |
string simple type |
|
Optional |
|
The reference to the one of the air
reservation payments if fee included in charge |
SubCode |
string simple type |
|
Optional |
|
|
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
TaxInfoRef |
element |
|
|
|
This reference elements will associate relevant taxes to this fee |
Key |
string simple type |
|
Required |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
TaxInfo |
typeTaxInfo complex type |
|
|
|
Itinerary level taxes |
CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
AirPricingInfoRef |
element |
|
|
|
Reference to a AirPricing from a shared
list |
Key |
string simple type |
|
Required |
|
|
TaxInfo |
typeTaxInfo complex type |
|
|
|
The tax information for a |
CarrierDefinedCategory |
string simple type |
|
Optional |
|
Optional category, where a carrier has
used a non-standard IATA tax category. The tax category will be
set to "DU" |
Category |
string simple type |
|
Required |
|
The tax category represents a valid IATA tax
code. |
CouponRef |
string simple type |
|
Optional |
|
The coupon to which that tax is relative (if
applicable) |
FlightDetailsRef |
string simple type |
|
Optional |
|
The flight details that this tax is relative
to (if applicable) |
Key |
string simple type |
|
Optional |
|
The tax key represents a valid key of tax |
ProviderCode |
string simple type |
|
Optional |
|
Code of the provider returning this TaxInfo. |
SegmentRef |
string simple type |
|
Optional |
|
The segment to which that tax is relative (if
applicable) |
SupplierCode |
string simple type |
|
Optional |
|
Code of the supplier returning this TaxInfo. |
TaxExempted |
boolean simple type |
|
Optional |
|
This indicates whether the tax specified by
tax category is exempted. |
Text |
string simple type |
|
Optional |
|
Additional Information returned from Supplier.(ACH only) |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
TaxDetail |
element |
|
|
|
The tax idetail nformation for a fare quote tax. |
Amount |
string simple type |
|
Required |
|
|
CountryCode |
string simple type |
|
Optional |
|
|
DestinationAirport |
string simple type |
|
Optional |
|
|
FareInfoRef |
string simple type |
|
Optional |
|
|
OriginAirport |
string simple type |
|
Optional |
|
|
IncludedInBase |
element |
|
|
|
Shows the taxes and fees included in the base fare. (ACH only) |
Amount |
string simple type |
|
Optional |
|
this attribute shows the amount included in the base fare for the specific fee or tax |
Penalty |
element |
|
|
|
Exchange penalty information |
CancelRefund |
boolean simple type |
|
Optional |
|
|
CancelationPenalty |
boolean simple type |
|
Optional |
|
|
ChargeApplicable |
boolean simple type |
|
Optional |
|
|
ChargePortion |
boolean simple type |
|
Optional |
|
|
NonExchangeable |
boolean simple type |
|
Optional |
|
|
NonRefundable |
boolean simple type |
|
Optional |
|
|
NonReissuePenalty |
boolean simple type |
|
Optional |
|
|
PenaltyAmount |
string simple type |
|
Optional |
|
|
ReissuePenalty |
boolean simple type |
|
Optional |
|
|
TicketRefundPenalty |
boolean simple type |
|
Optional |
|
|
HotelReservation |
element |
|
|
|
The complete Hotel Reservation |
CreateDate |
string simple type |
|
Required |
|
The date and time that this reservation was created. |
CustomerNumber |
string simple type |
|
Optional |
|
|
LocatorCode |
string simple type |
|
Required |
|
The unique identifier for this reservation. If this is this View Only UR LocatorCode is '999999'. |
ModifiedDate |
string simple type |
|
Required |
|
The date and time that this reservation was last modified for any reason. |
BookingConfirmation |
string simple type |
|
Optional |
|
|
CancelConfirmation |
string simple type |
|
Optional |
|
|
PassiveProviderReservationInfoRef |
string simple type |
|
Optional |
|
Passive Provider reservation reference
key. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
ProviderSegmentOrder |
integer simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations in the provider reservation. |
Status |
string simple type |
|
Required |
|
Reservation IATA status code, 2 byte. |
TravelOrder |
decimal simple type |
|
Optional |
|
To identify the appropriate sequence for Air/Car/Hotel segments based on travel dates. |
AccountingRemark |
element |
|
|
|
An accounting remark container to hold any
printable text. |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various
remarks. This is not required, but it is recommended. |
Key |
string simple type |
|
Optional |
|
|
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider
for which this accounting remark is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required,
else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
GeneralRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
CreateDate |
dateTime simple type |
|
Optional |
|
The date and time that this GeneralRemark was created. |
Direction |
string simple type |
Incoming , Outgoing |
Optional |
|
Direction Incoming or Outgoing of the GeneralRemark. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
The type of product this reservation is relative to |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required, else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
Restriction |
element |
|
|
|
Which activities are supported for a particular element |
Operation |
string simple type |
|
Required |
|
The operation that is restricted |
Reason |
string simple type |
|
Optional |
|
The reason it is restricted |
PassiveInfo |
element |
|
|
|
Used by CreateReservationReq for passing in elements normally found post-booking |
ProviderCode |
string simple type |
|
Optional |
|
|
ProviderLocatorCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
SupplierLocatorCode |
string simple type |
|
Optional |
|
|
TicketNumber |
string simple type |
|
|
|
|
ConfirmationNumber |
string simple type |
|
|
|
|
Commission |
element |
|
|
|
Identifies the agency commission |
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan |
Key |
string simple type |
|
Optional |
|
|
Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
ReservationName |
element |
|
|
|
Container to represent reservation name as appears in GDS booking |
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
NameOverride |
element |
|
|
|
To be used if the name is different from booking travelers in the PNR |
Age |
decimal simple type |
|
Optional |
|
Age. |
First |
string simple type |
|
Required |
|
First Name. |
Last |
string simple type |
|
Required |
|
Last Name. |
ThirdPartyInformation |
element |
|
|
|
Third party supplier locator information. Specifically applicable for SDK booking. |
Key |
string simple type |
|
Optional |
|
Unique identifier of the third party supplier. Key can be used to modify or delete saved third party information. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider Reservation reference |
ThirdPartyCode |
string simple type |
|
Optional |
|
Third party supplier code. |
ThirdPartyLocatorCode |
string simple type |
|
Optional |
|
Confirmation number for third party supplier. |
ThirdPartyName |
string simple type |
|
Optional |
|
Third party supplier name. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
SegmentRef |
typeGeneralReference complex type |
|
|
|
Air/Passive Segment Reference |
Key |
string simple type |
|
Required |
|
|
Email |
element |
|
|
|
Container for an email address with a type specifier (max 128 chars) |
Comment |
string simple type |
|
Optional |
|
|
EmailID |
string simple type |
|
Required |
|
|
Key |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
HotelProperty |
element |
|
|
|
The hotel property |
Availability |
string simple type |
Available , NotAvailable , AvailableForOtherRates , OnRequest , Unknown |
Optional |
|
|
HotelChain |
string simple type |
|
Required |
|
|
HotelCode |
string simple type |
|
Required |
|
|
HotelLocation |
string simple type |
|
Optional |
|
The location code for this entity. IATA code. |
HotelTransportation |
positiveInteger simple type |
|
Optional |
|
OTA Transporation code. Transportation available to hotel. |
Key |
string simple type |
|
Optional |
|
|
MoreRates |
boolean simple type |
|
Optional |
|
When true, more rates are available for this hotel property.Applicable only for HotelDetails and HotelSuperShopper. Supported Providers: 1G, 1V. |
MoreRatesToken |
string simple type |
|
Optional |
|
HS3 Token to identify the Rates for a property. Supported Providers 1G,1V. |
Name |
string simple type |
|
Optional |
|
|
NetTransCommissionInd |
string simple type |
A , B , C , P , X |
Optional |
|
This attribute indicates whether hotel property is tracking through net trans commission indicator. |
NumOfRatePlans |
nonNegativeInteger simple type |
|
Optional |
|
The specific number of RatePlanTypes for each property responded on the message, integer 1 - 999. Supported provider: HotelSuperShopper message only. |
ParticipationLevel |
string simple type |
|
Optional |
|
2=Best Available Rate 1G, 1V, 4=Lowest Possible Rate 1G, 1V, 1P |
PreferredOption |
boolean simple type |
|
Optional |
|
This attribute is used to indicate if the vendors responsible for the fare or rate being returned have been determined to be ‘preferred’ based on the associated policy settings. |
ReserveRequirement |
string simple type |
Deposit , Guarantee , Prepayment , Other |
Optional |
|
|
VendorLocationKey |
string simple type |
|
Optional |
|
The VendorLocationKey for this HotelProperty. |
PropertyAddress |
typeUnstructuredAddress complex type |
|
|
|
The VendorLocationKey for this HotelProperty. |
Address |
anonymous simple type |
|
|
|
The VendorLocationKey for this HotelProperty. |
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
CoordinateLocation |
element |
|
|
|
Specific lat/long location, usually associated with a Distance |
latitude |
double simple type |
|
Required |
|
|
longitude |
double simple type |
|
Required |
|
|
Distance |
element |
|
|
|
Container to encapsulate the a distance value with its unit of measure. |
Direction |
string simple type |
|
Optional |
|
Directions: S, N, E, W, SE, NW, ... |
Units |
string simple type |
MI , KM |
Optional |
MI |
|
Value |
decimal simple type |
|
Required |
|
|
HotelRating |
element |
|
|
|
Hotel rating information |
RatingProvider |
string simple type |
|
Required |
|
Rating providers, ie AAA, NTM |
Rating |
typeSimpleHotelRating simple type |
|
|
|
Hotel rating value |
RatingRange |
element |
|
|
|
Hotel rating value |
MaximumRating |
integer simple type |
|
Optional |
|
|
MinimumRating |
integer simple type |
|
Optional |
|
|
Amenities |
element |
|
|
|
Amenity information |
Amenity |
element |
|
|
|
Amenity information |
AmenityType |
string simple type |
|
Optional |
|
Amenity type code. “HA” (Hotel Property Amenity) or “RA” (Room Amenity). Defaults to “HA” if no value is sent. |
Code |
positiveInteger simple type |
|
Required |
|
|
MarketingMessage |
element |
|
|
|
Marketing information provided by the supplier |
Text |
string simple type |
|
|
|
Marketing information provided by the supplier |
HotelRateDetail |
element |
|
|
|
Returns hotel rate details during the stay if rates are available for requested property. |
ApproximateBase |
string simple type |
|
Optional |
|
Hotel base rate expressed in another currency |
ApproximateRateGuaranteed |
boolean simple type |
|
Optional |
|
If true, approximate rate is guaranteed by vendor. Supported Providers: 1G,1V |
ApproximateSurcharge |
string simple type |
|
Optional |
|
Surcharge associated with the room expressed in another currency. |
ApproximateTax |
string simple type |
|
Optional |
|
Taxes expressed in another currency |
ApproximateTotal |
string simple type |
|
Optional |
|
Hotel total rate expressed in another currency. |
BookableQuantity |
nonNegativeInteger simple type |
|
Optional |
|
The number of rooms which can be booked on the rate returned in HotelRateDetails. When the aggregator responds ‘IsPackage’= true (pricing for all rooms together), the BookableQuantity value will be ‘1’. |
ExtraFeesIncluded |
string simple type |
true , false , unknown |
Optional |
|
When true, total amounts includes additional fees or charges." Enumerated values are true, false, and unknown |
InPolicy |
boolean simple type |
|
Optional |
|
This attribute will be used to indicate if a fare or rate has been determined to be ‘in policy’ based on the associated policy settings. |
Key |
string simple type |
|
Optional |
|
|
RateCategory |
positiveInteger simple type |
|
Optional |
|
An enumerated type that allows the query to specify a rate category type, and provides major categories for comparison across brands. Refer to OpenTravel Code List Rate Plan Type (RPT). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelRateCategory". |
RateChangeIndicator |
string simple type |
true , false , unknown |
Optional |
|
Determines if the rate changes during the length of stay. Enumerated values are true, false, and unknown. |
RateGuaranteed |
boolean simple type |
|
Optional |
|
|
RateOfferId |
string simple type |
|
Optional |
|
Offer Identifier. Maybe required for hotels provided by aggregators. |
RatePlanType |
string simple type |
|
Required |
|
|
RateSupplier |
string simple type |
|
Optional |
|
Indicates the source of the rate. |
Base |
string simple type |
|
Optional |
|
This attribute is used to describe the Hotel Supplier Base Rate |
Surcharge |
string simple type |
|
Optional |
|
This attribute used to describe Surcharge associated with the room |
Tax |
string simple type |
|
Optional |
|
This attribute used to describe Tax associated with the room |
Total |
string simple type |
|
Optional |
|
This attribute used to describe Hotel Supplier Total Rate |
PolicyCodesList |
typePolicyCodesList complex type |
|
|
|
A list of codes that indicate why an item was determined to be ‘out of policy’. |
PolicyCode |
anonymous simple type |
|
|
|
A code that indicates why an item was determined to be ‘out of policy’. |
MinPolicyCode |
anonymous simple type |
|
|
|
A code that indicates why the minimum fare or rate was determined to be ‘out of policy’. |
MaxPolicyCode |
anonymous simple type |
|
|
|
A code that indicates why the maximum fare or rate was determined to be ‘out of policy’. |
RoomRateDescription |
typeHotelRateDescription complex type |
|
|
|
A code that indicates why the maximum fare or rate was determined to be ‘out of policy’. |
Name |
string simple type |
|
Optional |
|
Optional context name of the text block being returned i.e. Room details |
Text |
anonymous simple type |
|
|
|
Optional context name of the text block being returned i.e. Room details |
HotelRateByDate |
element |
|
|
|
The daily rate details |
ApproximateBase |
string simple type |
|
Optional |
|
Hotel base rate expressed in another currency |
ApproximateTotal |
string simple type |
|
Optional |
|
Hotel total rate expressed in another currency. Supported Providers: 1P |
Contents |
string simple type |
|
Optional |
|
Contents will be representing all unformatted data returned by HOST, those are not uAPI supported. Support provider 1P. |
EffectiveDate |
string simple type |
|
Optional |
|
|
ExpireDate |
string simple type |
|
Optional |
|
|
Base |
string simple type |
|
Optional |
|
This attribute is used to describe the Hotel Supplier Base Rate |
Surcharge |
string simple type |
|
Optional |
|
This attribute used to describe Surcharge associated with the room |
Tax |
string simple type |
|
Optional |
|
This attribute used to describe Tax associated with the room |
Total |
string simple type |
|
Optional |
|
This attribute used to describe Hotel Supplier Total Rate |
CorporateDiscountID |
element |
|
|
|
These are zero or more negotiated rate codes |
NegotiatedRateCode |
boolean simple type |
|
Optional |
|
When set to true,
the data in the CorporateDiscountID is a negotiated rate code.
Otherwise, this data is a Corporate Discount ID rate. |
AcceptedPayment |
element |
|
|
|
When set to true,
the data in the CorporateDiscountID is a negotiated rate code.
Otherwise, this data is a Corporate Discount ID rate. |
PaymentCode |
string simple type |
|
Optional |
|
The issuer of the form of payment, such as the credit card bank. |
Commission |
element |
|
|
|
The issuer of the form of payment, such as the credit card bank. |
ApproxCommissionAmount |
string simple type |
|
Optional |
|
The approximate commission amount in the agency’s provisioned or requested currency. |
ApproxCommissionOnSurcharges |
string simple type |
|
Optional |
|
The approximate commission on surcharges in the agency’s provisioned or requested currency. |
CommissionAmount |
string simple type |
|
Optional |
|
The commission amount in the aggregator’s or supplier’s currency. |
CommissionOnSurcharges |
string simple type |
|
Optional |
|
Commission on surcharges in the aggregator’s or supplier’s currency. |
Indicator |
string simple type |
true , false , unknown |
Optional |
|
Indicates if the Rate Plan is commissionable.True: Rate is commissionable.False: Rate is not commissionable.Unknown: Commission indicator is not returned by the hotel supplier (chain or property). |
Percent |
string simple type |
|
Optional |
|
The percentage applied to the commissionable amount to determine the payable commission amount. |
RateMatchIndicator |
element |
|
|
|
"Match" Indicators for certain request parameters, e.g. Child Count, Extra Adults etc. |
Status |
string simple type |
Available , NotAvailable , SubstituteOffered , MaximumExceeded |
Required |
|
|
Type |
string simple type |
RateCategory , RoomCount , AdultCount , ChildCount , AdultRollaway , ChildRollaway , Crib |
Required |
|
|
Value |
string simple type |
|
Optional |
|
|
TaxDetails |
element |
|
|
|
|
Tax |
element |
|
|
|
|
Code |
positiveInteger simple type |
|
Required |
|
Code identifying fee (e.g. agency fee, bed tax etc.). Refer to OPEN Travel Code List for Fee Tax Type. Possible values are OTA Code against FTT. |
CollectionFreq |
string simple type |
|
Optional |
|
Indicates how often the tax is collected. Values can be Once or Daily |
EffectiveDate |
date simple type |
|
Optional |
|
|
ExpirationDate |
date simple type |
|
Optional |
|
|
Term |
string simple type |
|
Optional |
|
Indicates how the tax is applied. Values can be PerPerson, PerNight and PerStay |
Amount |
typeMoney simple type |
|
|
|
Indicates how the tax is applied. Values can be PerPerson, PerNight and PerStay |
Percentage |
float simple type |
|
|
|
Indicates how the tax is applied. Values can be PerPerson, PerNight and PerStay |
CancelInfo |
element |
|
|
|
Returns cancellation information for certain hotel returned in response. This information is available through GDS transactions |
CancelDeadline |
dateTime simple type |
|
Optional |
|
Last date/time the reservation can be canceled without penalty. |
CancelPenaltyAmount |
string simple type |
|
Optional |
|
This will contain the cancellation penalty amount. |
CancelPenaltyPercent |
float simple type |
|
Optional |
|
This will contain the cancellation penalty expressed as a percentage. |
CancelPenaltyPercentAppliesTo |
string simple type |
|
Optional |
|
This will contain the cost qualifier that explains what the percentage is applied to in order to calculate the cancel penalty. |
FeeInclusive |
boolean simple type |
|
Optional |
|
Indicates whether or not the Penalty amount includes fees. |
Method |
string simple type |
|
Optional |
|
Cancellation method, either "API", "URL", "INFO", or "NONE". |
NonRefundableStayIndicator |
string simple type |
true , false , unknown |
Optional |
|
True if Deposit or Payment is non-refundable |
NumberOfNights |
integer simple type |
|
Optional |
|
This will contain the number of nights that will be assessed as the cancelation penalty. |
Supported |
boolean simple type |
|
Optional |
|
If true, the booking can be canceled. If false, the booking cannot be canceled. |
TaxInclusive |
boolean simple type |
|
Optional |
|
Indicates whether or not the Penalty amount includes taxes. |
URL |
string simple type |
|
Optional |
|
The URL provided by the supplier to cancel the booking, if @Method="URL". For all other values of @Method, @URL is not returned. |
OffsetDropTime |
string simple type |
|
Optional |
|
An enumerated type indicating when the deadline drop time goes into effect. Enumerated values are “AfterBooking” and “BeforeArrival”. |
OffsetTimeUnit |
string simple type |
|
Optional |
|
The units of time, e.g: days, hours, etc that apply to the deadline. Enumerated values are “Year”, “Month”, “Day”, and “Hour”. |
OffsetUnitMultiplier |
integer simple type |
|
Optional |
|
The number of units of DeadlineTimeUnit. |
CancellationPolicy |
string simple type |
|
|
|
Return cancellation policy text by the aggregator. |
Text |
string simple type |
|
|
|
The informational text provided by the supplier to cancel the booking, if @Method="INFO". For all other values of @Method, Text is not returned. |
GuaranteeInfo |
element |
|
|
|
The informational text provided by the supplier to cancel the booking, if @Method="INFO". For all other values of @Method, Text is not returned. |
AbsoluteDeadline |
dateTime simple type |
|
Optional |
|
Latest date/time when deposit/payment/guarantee is required. |
CredentialsRequired |
boolean simple type |
|
Optional |
|
Identification required at booking/checkin. Not supported by 1P. |
GuaranteeType |
string simple type |
Deposit , Guarantee , Prepayment |
Optional |
|
Deposit, Guarantee, or Prepayment required to hold/book the room. Applicable only for HotelSupershopper, Hotel Details and Hotel rules. |
HoldTime |
string simple type |
|
Optional |
|
Expiration time for room reservation held without deposit/guarantee. |
OffsetDropTime |
string simple type |
|
Optional |
|
An enumerated type indicating when the deadline drop time goes into effect. Enumerated values are “AfterBooking” and “BeforeArrival”. |
OffsetTimeUnit |
string simple type |
|
Optional |
|
The units of time, e.g: days, hours, etc that apply to the deadline. Enumerated values are “Year”, “Month”, “Day”, and “Hour”. |
OffsetUnitMultiplier |
integer simple type |
|
Optional |
|
The number of units of DeadlineTimeUnit. |
DepositAmount |
element |
|
|
|
Amount required for deposit/prepayment |
Amount |
string simple type |
|
Optional |
|
Supplier deposit amount required for
deposit/prepayment.Supported by all Providers when supported by
supplier |
ApproximateAmount |
string simple type |
|
Optional |
|
Approximate deposit amount required for
deposit/prepayment. |
DepositNights |
integer simple type |
|
|
|
Number of Nights required for deposit/prepayment |
DepositPercent |
integer simple type |
|
|
|
Percentage of stay required for deposit/prepayment |
GuaranteePaymentType |
element |
|
|
|
Accepted payment types. Applicable only for HotelSupershopper, Hotel Details and Hotel rules. |
Description |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Required |
|
Accepted payment types: CreditCard, AgencyIATA/ARC, FrequentGuest, SpecialIndustry, CDNumber, HomeAddress, CompanyAddress, Override, Other, or None |
SupplementalRateInfo |
string simple type |
|
|
|
Supplemental rate information provided by the aggregator. |
RoomCapacity |
element |
|
|
|
The maximum number of guests for a room or for each room in a package. |
IsPackage |
boolean simple type |
|
Optional |
|
If true, the rooms are offered as a package by the aggregator. |
Capacity |
positiveInteger simple type |
|
|
|
The maximum number of guests per room. |
ExtraCharges |
element |
|
|
|
Additional charges applied to the hotel rate. |
AdultRollawayCharge |
string simple type |
|
Optional |
|
Additional charge for an extra rollaway bed provided for an adult guest. |
ChildRollawayCharge |
string simple type |
|
Optional |
|
Additional charge for an extra rollaway bed provided for a child guest. |
CribAmount |
string simple type |
|
Optional |
|
Additional charge for a crib. |
ExtraAdultAmount |
string simple type |
|
Optional |
|
Additional charge for an extra guest. |
ExtraChildAmount |
string simple type |
|
Optional |
|
dditional charge for an extra child guest. |
Inclusions |
element |
|
|
|
Additional items included in the hotel rate plan. |
SmokingRoomIndicator |
string simple type |
true , false , unknown |
Optional |
|
Indicates if the room is designated as nonsmoking or smoking.
true = Smoking
false = NonSmoking
unknown = Information is not returned by the hotel supplier (chain or property). |
BedTypes |
element |
|
|
|
Bed types in the rate plan. |
Code |
positiveInteger simple type |
|
Optional |
|
Bed Type Code. Uses Open Travel Code List Room Amenity Type (RMA). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelAmenities”. |
Quantity |
integer simple type |
|
Optional |
|
Bed Quantity. |
MealPlans |
element |
|
|
|
Meal options available for the rate plan. |
Breakfast |
string simple type |
true , false , unknown |
Optional |
|
Indicates whether a daily breakfast is included in the meal plan.
true = Breakfast is included
false = Breakfast is not included
unknown = Information is not returned by the hotel supplier (chain or property). |
Dinner |
string simple type |
true , false , unknown |
Optional |
|
Indicates whether a daily dinner is included in the meal plan.
true = Dinner is included
false = Dinner is not included
unknown = Information is not returned by the hotel supplier (chain or property). |
Lunch |
string simple type |
true , false , unknown |
Optional |
|
Indicates whether a daily lunch is included in the meal plan.
true = Lunch is included
false = Lunch is not included
unknown = Information is not returned by the hotel supplier (chain or property). |
MealPlan |
element |
|
|
|
Meal plan. |
Code |
positiveInteger simple type |
|
Optional |
|
Meal plan code. Uses Open Travel Code List Meal Plan Type (MPT). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelMealPlans”. |
RoomView |
element |
|
|
|
Meal plan code. Uses Open Travel Code List Meal Plan Type (MPT). Encode/decode data in Util ReferenceDataRetrieveReq TypeCode=“HotelMealPlans”. |
Code |
positiveInteger simple type |
|
Optional |
|
OTA code represents different hotel room views. |
HotelStay |
element |
|
|
|
Arrival and Departure dates |
Key |
string simple type |
|
Optional |
|
|
CheckinDate |
typeDate simple type |
|
|
|
|
CheckoutDate |
typeDate simple type |
|
|
|
|
HotelSpecialRequest |
typeGeneralText simple type |
|
|
|
|
Guarantee |
element |
|
|
|
Payment GuaranteeGuarantee, Deposit or PrePayment |
ExternalReference |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
Reusable |
boolean simple type |
|
Optional |
false |
Indicates whether the form of payment can be reused or not. Currently applicable for Credit and Debit form of payment |
ReuseFOP |
string simple type |
|
Optional |
|
Key of the FOP Key to be reused as this Form of Payment.Only Credit and Debit Card will be supported for FOP Reuse. |
Type |
string simple type |
|
Required |
|
Guarantee, Deposit for 1G/1V/1P and PrePayment for 1P only |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
CreditCard |
element |
|
|
|
Container for all credit card information. |
AcceptanceOverride |
boolean simple type |
|
Optional |
|
Override airline restriction on the credit card. |
BankCountryCode |
string simple type |
|
Optional |
|
ISO Country code associated with the issuing bank |
BankName |
string simple type |
|
Optional |
|
Issuing bank name for this credit card |
BankStateCode |
string simple type |
|
Optional |
|
State code associated with the issuing bank. |
CustomerReference |
string simple type |
|
Optional |
|
Agencies use this to pass the traveler information to the credit card company. |
Enett |
boolean simple type |
|
Optional |
false |
Acceptable values are true or false. If set to true it will denote that the credit card used has been issued through Enett. For all other credit card payments this value will be set to false. |
ExtendedPayment |
string simple type |
|
Optional |
|
Used for American Express (AX) and other credit cards, e.g., Visa (VI) and Master card (CA), that allow Extended Payment, subject to the BSP market rule. |
ThirdPartyPayment |
boolean simple type |
|
Optional |
false |
If true, this indicates that the credit card holder is not one of the passengers. |
ApprovalCode |
string simple type |
|
Optional |
|
This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions. |
CVV |
string simple type |
|
Optional |
|
Card Verification Code |
ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
Name |
string simple type |
|
Optional |
|
The name as it appears on the card. |
Number |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type. |
Key |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
BillingAddress |
typeStructuredAddress complex type |
|
|
|
The address to where the billing statements
for this card are sent. Used for address verification purposes. |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
OtherGuaranteeInfo |
element |
|
|
|
|
Type |
string simple type |
IATA/ARC Number , Agency Address , Deposit Taken , Others |
Required |
|
1) IATA/ARC Number
2) Agency Address
2) Deposit Taken
3) Others |
PromotionCode |
element |
|
|
|
1) IATA/ARC Number
2) Agency Address
2) Deposit Taken
3) Others |
Key |
string simple type |
|
Optional |
|
|
BookingSource |
element |
|
|
|
|
Code |
string simple type |
|
Required |
|
Alternate booking source code or number. |
Type |
string simple type |
PseudoCityCode , ArcNumber , IataNumber , CustomerId , BookingSourceOverride |
Required |
|
Type of booking source sent in the Code attribute. Possible values are “PseudoCityCode”,” ArcNumber”,” IataNumber”, “CustomerId” and “BookingSourceOverrride”. “BookingSourceOverrride” is only applicable in VehicleCreateReservationReq. 1P. |
HotelBedding |
element |
|
|
|
Specify desired bedding |
Amount |
string simple type |
|
Optional |
|
Fee for bed type. Providers: 1g/1v/1p |
Content |
string simple type |
|
Optional |
|
Additional information Providers: 1p |
NumberOfBeds |
long simple type |
|
Optional |
|
Number of beds of desired Type in room. Use '0' to delete the hotel Optional Beds ( Only RA RC CR ) |
Type |
string simple type |
|
Required |
|
Queen, King, double, etc |
GuestInformation |
element |
|
|
|
The information like number of rooms ,number of adults,children to be provided while booking the hotel |
NumberOfRooms |
long simple type |
|
Optional |
|
|
NumberOfAdults |
element |
|
|
|
Number of Adults |
Amount |
string simple type |
|
Optional |
|
Fee for extra adults. Providers: 1g/1v/1p |
Content |
string simple type |
|
Optional |
|
Additional information. Providers 1p |
ExtraAdults |
long simple type |
|
Optional |
|
The number of extra adults in the room ,use '0' to delete the extra adults |
NumberOfChildren |
element |
|
|
|
Number of Children |
Amount |
string simple type |
|
Optional |
|
Fee per child. Providers: 1g/1v |
Count |
long simple type |
|
Required |
|
The total number of children in the booking. Supported Providers 1P. |
Age |
int simple type |
|
|
|
The Ages of the Children. . The defined age of a Child traveler may vary by supplier, but is typically 1 to 17 years. Supported Providers 1G/1V. |
ExtraChild |
element |
|
|
|
Providers: 1p |
Content |
string simple type |
|
Optional |
|
Additional information |
Count |
long simple type |
|
Optional |
|
The number of extra children in the room |
AssociatedRemark |
element |
|
|
|
The number of extra children in the room |
Key |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this element is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
SellMessage |
string simple type |
|
|
|
Sell Message from Vendor. This is applicable in response messages only, any input in request message will be ignored. |
HotelCommission |
string simple type |
|
|
|
Indicates the commission during Hotel reservation. Provider supoorted 1P. |
CancelInfo |
element |
|
|
|
Returns cancellation information for certain hotel returned in response. This information is available through GDS transactions |
CancelDeadline |
dateTime simple type |
|
Optional |
|
Last date/time the reservation can be canceled without penalty. |
CancelPenaltyAmount |
string simple type |
|
Optional |
|
This will contain the cancellation penalty amount. |
CancelPenaltyPercent |
float simple type |
|
Optional |
|
This will contain the cancellation penalty expressed as a percentage. |
CancelPenaltyPercentAppliesTo |
string simple type |
|
Optional |
|
This will contain the cost qualifier that explains what the percentage is applied to in order to calculate the cancel penalty. |
FeeInclusive |
boolean simple type |
|
Optional |
|
Indicates whether or not the Penalty amount includes fees. |
Method |
string simple type |
|
Optional |
|
Cancellation method, either "API", "URL", "INFO", or "NONE". |
NonRefundableStayIndicator |
string simple type |
true , false , unknown |
Optional |
|
True if Deposit or Payment is non-refundable |
NumberOfNights |
integer simple type |
|
Optional |
|
This will contain the number of nights that will be assessed as the cancelation penalty. |
Supported |
boolean simple type |
|
Optional |
|
If true, the booking can be canceled. If false, the booking cannot be canceled. |
TaxInclusive |
boolean simple type |
|
Optional |
|
Indicates whether or not the Penalty amount includes taxes. |
URL |
string simple type |
|
Optional |
|
The URL provided by the supplier to cancel the booking, if @Method="URL". For all other values of @Method, @URL is not returned. |
OffsetDropTime |
string simple type |
|
Optional |
|
An enumerated type indicating when the deadline drop time goes into effect. Enumerated values are “AfterBooking” and “BeforeArrival”. |
OffsetTimeUnit |
string simple type |
|
Optional |
|
The units of time, e.g: days, hours, etc that apply to the deadline. Enumerated values are “Year”, “Month”, “Day”, and “Hour”. |
OffsetUnitMultiplier |
integer simple type |
|
Optional |
|
The number of units of DeadlineTimeUnit. |
CancellationPolicy |
string simple type |
|
|
|
Return cancellation policy text by the aggregator. |
Text |
string simple type |
|
|
|
The informational text provided by the supplier to cancel the booking, if @Method="INFO". For all other values of @Method, Text is not returned. |
TotalReservationPrice |
element |
|
|
|
The total price for the entire stay, including fees, for all rooms in the booking. |
ApproxTotalPrice |
string simple type |
|
Optional |
|
The approximate amount of the total hotel price, including fees, in another currency. |
TotalPrice |
string simple type |
|
Optional |
|
The amount of the total price, including fees for all rooms in the booking. |
RoomRateDescription |
typeHotelRateDescription complex type |
|
|
|
The amount of the total price, including fees for all rooms in the booking. |
Name |
string simple type |
|
Optional |
|
Optional context name of the text block being returned i.e. Room details |
Text |
anonymous simple type |
|
|
|
Optional context name of the text block being returned i.e. Room details |
HotelDetailItem |
element |
|
|
|
Textual information about the hotel |
Name |
string simple type |
|
Required |
|
|
Text |
string simple type |
|
|
|
|
AdaptedRoomGuestAllocation |
element |
|
|
|
This element defines how the aggregators or hotel property have allocated the guests to the rooms. Only displayed when Requested guest allocation is different from the Adapted room guest allocation. |
Room |
typeAdaptedRoomGuestAllocation complex type |
|
|
|
Individual room. Multiple occurrences if there are multiple rooms in the request. Maximum number of rooms may vary by supplier or aggregator. |
NumberOfAdults |
nonNegativeInteger simple type |
|
Optional |
|
The number of adult guests per room. Maximum number of adults may vary by supplier or aggregator. |
Child |
typeGuestChildInformation complex type |
|
|
|
Information about a child guest. |
Age |
integer simple type |
|
Optional |
|
Age of the Child. |
VehicleReservation |
element |
|
|
|
Age of the Child. |
CreateDate |
string simple type |
|
Required |
|
The date and time that this reservation was created. |
CustomerNumber |
string simple type |
|
Optional |
|
|
LocatorCode |
string simple type |
|
Required |
|
The unique identifier for this reservation. If this is this View Only UR LocatorCode is '999999'. |
ModifiedDate |
string simple type |
|
Required |
|
The date and time that this reservation was last modified for any reason. |
BookingConfirmation |
string simple type |
|
Optional |
|
|
PassiveProviderReservationInfoRef |
string simple type |
|
Optional |
|
Passive Provider reservation reference key. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
ProviderSegmentOrder |
integer simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations in the provider reservation. |
Status |
string simple type |
|
Required |
|
|
SupplierCode |
string simple type |
|
Required |
|
|
TravelOrder |
decimal simple type |
|
Optional |
|
To identify the appropriate sequence for Air/Car/Hotel segments based on travel dates. |
AccountingRemark |
element |
|
|
|
An accounting remark container to hold any
printable text. |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various
remarks. This is not required, but it is recommended. |
Key |
string simple type |
|
Optional |
|
|
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider
for which this accounting remark is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required,
else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
GeneralRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
CreateDate |
dateTime simple type |
|
Optional |
|
The date and time that this GeneralRemark was created. |
Direction |
string simple type |
Incoming , Outgoing |
Optional |
|
Direction Incoming or Outgoing of the GeneralRemark. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
The type of product this reservation is relative to |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required, else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
Restriction |
element |
|
|
|
Which activities are supported for a particular element |
Operation |
string simple type |
|
Required |
|
The operation that is restricted |
Reason |
string simple type |
|
Optional |
|
The reason it is restricted |
PassiveInfo |
element |
|
|
|
Used by CreateReservationReq for passing in elements normally found post-booking |
ProviderCode |
string simple type |
|
Optional |
|
|
ProviderLocatorCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
SupplierLocatorCode |
string simple type |
|
Optional |
|
|
TicketNumber |
string simple type |
|
|
|
|
ConfirmationNumber |
string simple type |
|
|
|
|
Commission |
element |
|
|
|
Identifies the agency commission |
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan |
Key |
string simple type |
|
Optional |
|
|
Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
ReservationName |
element |
|
|
|
Container to represent reservation name as appears in GDS booking |
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
NameOverride |
element |
|
|
|
To be used if the name is different from booking travelers in the PNR |
Age |
decimal simple type |
|
Optional |
|
Age. |
First |
string simple type |
|
Required |
|
First Name. |
Last |
string simple type |
|
Required |
|
Last Name. |
Email |
element |
|
|
|
Container for an email address with a type specifier (max 128 chars) |
Comment |
string simple type |
|
Optional |
|
|
EmailID |
string simple type |
|
Required |
|
|
Key |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
VehicleDateLocation |
element |
|
|
|
|
Key |
string simple type |
|
Optional |
|
|
PickupDateTime |
string simple type |
|
Required |
|
|
PickupLocation |
string simple type |
|
Optional |
|
PickUpLocation is optional if Reference point is specified |
PickupLocationNumber |
string simple type |
|
Optional |
|
The value of this attribute should be the same as the value of VendorLocationID returned as part of VendorLocation@VendorLocationID in a VehicleLocationRsp. |
PickupLocationType |
string simple type |
Terminal , ShuttleOnAirport , ShuttleOffAirport , RailwayStation , Hotel , CarDealer , CityCenterDowntown , EastOfCityCenter , SouthOfCityCenter , WestOfCityCenter , NorthOfCityCenter , PortOrFerry , NearResort , Airport , Unknown |
Optional |
|
Required if use VendorLocationID. Ex: Terminal, ShuttleOnAirport, ShuttleOffAirport, RailwayStation, Hotel, CarDealer, CityCenterDowntown, EastOfCityCenter, SouthOfCityCenter, WestOfCityCenter, NorthOfCityCenter, PortOrFerry, NearResort, Airport, Unknown |
ReturnDateTime |
string simple type |
|
Required |
|
|
ReturnLocation |
string simple type |
|
Optional |
|
If not specified, the PickupLocation will be assumed |
ReturnLocationNumber |
string simple type |
|
Optional |
|
|
ReturnLocationType |
string simple type |
Terminal , ShuttleOnAirport , ShuttleOffAirport , RailwayStation , Hotel , CarDealer , CityCenterDowntown , EastOfCityCenter , SouthOfCityCenter , WestOfCityCenter , NorthOfCityCenter , PortOrFerry , NearResort , Airport , Unknown |
Optional |
|
Defaults to Pickup Location. Same options as Pickup Location. |
VendorLocation |
element |
|
|
|
Specific vendor rental locations. Applicable only for VehicleSearchAvailability. |
LocationCode |
string simple type |
|
Optional |
|
Airport or City Code |
LocationType |
string simple type |
Terminal , ShuttleOnAirport , ShuttleOffAirport , RailwayStation , Hotel , CarDealer , CityCenterDowntown , EastOfCityCenter , SouthOfCityCenter , WestOfCityCenter , NorthOfCityCenter , PortOrFerry , NearResort , Airport , Unknown |
Optional |
|
Rental counter location such as Terminal, CityCenterDowntown, |
Type |
string simple type |
Pickup , Return |
Optional |
|
Pickup or Return |
Key |
string simple type |
|
Optional |
|
Key which maps vendor location with vehicles |
MoreRatesToken |
string simple type |
|
Optional |
|
Enter the Token when provided by hotel property, more rates exist. HADS/HSS support only. |
PreferredOption |
boolean simple type |
|
Optional |
|
Preferred Option marker for Location. |
ProviderCode |
string simple type |
|
Required |
|
The code of the provider (e.g. 1G, 1S) |
VendorCode |
string simple type |
|
Required |
|
The code of the vendor (e.g. HZ, etc.) |
VendorLocationID |
string simple type |
|
Optional |
|
Location identifier |
Distance |
element |
|
|
|
Container to encapsulate the a distance value with its unit of measure. |
Direction |
string simple type |
|
Optional |
|
Directions: S, N, E, W, SE, NW, ... |
Units |
string simple type |
MI , KM |
Optional |
MI |
|
Value |
decimal simple type |
|
Required |
|
|
Vehicle |
element |
|
|
|
Information related to single vehicle |
AcrissVehicleCode |
string simple type |
|
Optional |
|
The Association of Car Rental Industry System Standards (ACRISS), develops standards to avoid misleading information when making a car rental booking online or via any electronic means. ACRISS provides an industry standard vehicle matrix to define car models ensuring a like to like comparison of vehicle. Each ACRISS code defining a car model consists of four characters as defined. 1st character denotes the vehicle category – based on size, cost, power and luxury factor.2nd character defines the vehicle type – chassis type (van, SUV, wagon, convertible).3rd character defines the transmission and drive – automatic / manual and 2WD / 4WD / AWD.
4th character defines the fuel type (petrol / diesel / hybrid…) and whether air conditioned.Examples are ICAR,ECAR,etc. |
AirConditioning |
boolean simple type |
|
Required |
|
True or False. |
AlternateVendor |
string simple type |
|
Optional |
|
A vendor renting the vehicle on behalf of another company |
Category |
string simple type |
Car , Van , SUV , Convertible , Truck , StationWagon , Pickup , AllTerrain , Recreational , Sport , Special , ExtendedCabPickup , RegularCabPickup , SpecialOffer , Coupe , Monospace , Roadster , Crossover , Motorcycle , Limo , Motorhome , TwoWheelVehicle , CommercialVanOrTruck |
Required |
|
Category of vehicle. Each supplier decides how these categories map to a vehicle class. |
CounterLocationCode |
string simple type |
|
Optional |
|
Four character Code to identify the Location of the Rental Counter, e.g. OMSO, PHON. |
Description |
string simple type |
|
Optional |
|
Car type Description such as 'CHRYSLER SEBRING OR SIMILAR' |
DoorCount |
string simple type |
TwoToThreeDoors , TwoToFourDoors , FourToFiveDoors |
Optional |
|
The number of doors on vehicle. Ex: TwoToThreeDoors, TwoToFourDoors, FourToFiveDoors |
FuelType |
string simple type |
Petrol , Diesel , Hybrid , Electric , LPGCNG , Hydrogen , MultiFuel , Ethanol |
Optional |
|
The fuel type of vehicle |
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
Location of the Vehicle or Counter |
ReturnAtPickup |
boolean simple type |
|
Optional |
|
Indicates whether vehicle can be returned at any location or pickup point only. If ReturnAtPickup = false then vehicle can be returned at any location else if ReturnAtPickup = true, vehicle should be returned in Pickup point only. Supported Providers : 1G/1V |
TransmissionType |
string simple type |
Automatic , Automatic4WD , AutomaticAWD , Manual , Manual4WD , ManualAWD |
Required |
|
Automatic, Manual |
VehicleClass |
string simple type |
Mini , Economy , Compact , Intermediate , Standard , Fullsize , Luxury , Premium , Special , MiniElite , EconomyElite , CompactElite , IntermediateElite , StandardElite , FullsizeElite , PremiumElite , LuxuryElite , Oversize , Subcompact , Minivan , TwelvePassengerVan , MovingVan , FifteenPassengerVan , CargoVan , TwelveFootTruck , TwentyFootTruck , TwentyfourFootTruck , TwentysixFootTruck , Moped , Stretch , Regular , Unique , Exotic , SmallOrMediumTruck , LargeTruck , SmallSUV , MediumSUV , LargeSUV , ExoticSUV , FourWheelDrive |
Required |
|
Class of vehicle |
VendorCode |
string simple type |
|
Required |
|
|
VendorLocationKey |
string simple type |
|
Optional |
|
Identifies the specific vendor location |
VendorName |
string simple type |
|
Optional |
|
The vendor's name |
InPolicy |
boolean simple type |
|
Optional |
|
This attribute will be used to indicate if a fare or rate has been determined to be ‘in policy’ based on the associated policy settings. |
PolicyCode |
int simple type |
|
Optional |
|
This attribute is used to provide a code that can be used to determine why an item was determined to be ‘out of policy’. |
PreferredOption |
boolean simple type |
|
Optional |
|
This attribute is used to indicate if the vendors responsible for the fare or rate being returned have been determined to be ‘preferred’ based on the associated policy settings. |
PolicyCodesList |
typePolicyCodesList complex type |
|
|
|
A list of codes that indicate why an item was determined to be ‘out of policy’. |
PolicyCode |
anonymous simple type |
|
|
|
A code that indicates why an item was determined to be ‘out of policy’. |
MinPolicyCode |
anonymous simple type |
|
|
|
A code that indicates why the minimum fare or rate was determined to be ‘out of policy’. |
MaxPolicyCode |
anonymous simple type |
|
|
|
A code that indicates why the maximum fare or rate was determined to be ‘out of policy’. |
VehicleRate |
element |
|
|
|
Rate summary |
AdvancedBooking |
string simple type |
|
Optional |
|
Indicates the number of Hours or Days a rate must be booked in advance. Values are for Days = number followed by “D” e.g., "002D" and Hours = number followed by “H” e.g., 002H” 1P/1G/1V only. |
CardNumber |
string simple type |
|
Optional |
|
Vehicle Loyalty Card Number. Supported Provider 1P. |
CardNumberApplied |
string simple type |
true , false , unknown |
Optional |
|
Loyalty Card Number has been applied to the Rate. Values: "true", "false", "unknown". Supported Providers 1P. |
CorporateRate |
boolean simple type |
|
Optional |
|
If "true" a Corporate Discount has been applied to the rate. Applicable to 1P |
DiscountNumber |
string simple type |
|
Optional |
|
Corporate Discount number used to request a specified discount. Supported Providers Requests: 1P,1G,1V, Responses only 1P. |
DiscountNumberApplied |
string simple type |
true , false , unknown |
Optional |
|
Discount Number has been applied to the Rate. Valid values: "true", "false", "unknown". Supported Providers 1P. |
DropOffChargesIncluded |
boolean simple type |
|
Optional |
|
If true: Drop off charges are included. If false, not included. If not specified, additional drop off charges MAY apply (but this has not been confirmed by vendor) |
FlightRestriction |
boolean simple type |
|
Optional |
|
Flight restriction indicator is true if flight information is required at booking. 1P/1G/1V only. |
MileageAllowance |
long simple type |
|
Optional |
|
Only set if UnlimitedMileage is false. Number of miles allowed for rate |
NumberOfPeriods |
long simple type |
|
Optional |
|
Define how many periods (e.g. number of days or weeks) |
PromotionalCode |
string simple type |
|
Optional |
|
Specific coupon or promotion code. Providers 1P,1V,1G. |
PromotionalCodeApplied |
string simple type |
true , false , unknown |
Optional |
|
Promotional/Coupon Number has been applied to the Rate. Valid values: "true", "false", "unknown". Supported Providers 1P. |
RateAvailability |
string simple type |
Available , Call , Closed |
Optional |
|
Rate is available to sell, Need to Call or Closed |
RateCategory |
string simple type |
Association , Business , Corporate , Government , Industry , Package , Inclusive , Promotional , Credential , Standard , Consortium , Convention , Negotiated , Prepay |
Optional |
|
The category of this rate (Best, etc) |
RateCode |
string simple type |
|
Optional |
|
Rate Code of the vehicle. Supported Providers 1P,1G,1V. |
RateCodePeriod |
string simple type |
|
Optional |
|
RateCodePeriod |
RateGuaranteeType |
string simple type |
Rate Guaranteed , Rate Quoted , Agent Entered |
Optional |
|
To identify whether rate is already guaranteed or rate quoted or agent entered |
RateGuaranteed |
boolean simple type |
|
Optional |
false |
Guarantee indicator for vehicle rate. |
RatePeriod |
string simple type |
Hourly , Daily , Weekly , Monthly , WeekendDay , Other , Package , Bundle , Total |
Optional |
|
The period for the rate (daily, weekly, etc) |
RateQualifierInd |
nonNegativeInteger simple type |
|
Optional |
|
Indicates whether rates comply with CD, ID, or Drop Off requested. 1 is fully qualified, 2 is partly qualified, and 3 is other rates. 1G, 1V only. |
RateSource |
string simple type |
|
Optional |
|
The rate source indicator for GWS |
RentalRestriction |
boolean simple type |
|
Optional |
|
RentalRestriction attribute value is true if vehicle rate has rental restrictions. Rental restrictions can be obtained from the Vehicle Rules. 1P only. |
RequestedRateCodeApplied |
string simple type |
true , false , unknown |
Optional |
|
The requested Rate Code applied to the Rate. Valid values: "true", "false", "unknown". Supported Providers 1P. |
RequiredCharges |
string simple type |
|
Optional |
|
|
RequiredPayment |
string simple type |
Guarantee , Deposit , PrePayment |
Optional |
|
Returns Payment information required by vendor at the time og booking. |
TourCode |
string simple type |
|
Optional |
|
Tour Number for the Vehicle Booking |
TourCodeApplied |
string simple type |
true , false , unknown |
Optional |
|
Tour Code Number has been applied to the Rate. Valid values: "true", "false", "unknown". Supported Providers 1P. |
Units |
string simple type |
MI , KM |
Optional |
|
Describes distance units for MileageAllowance or ExtraMileageCharge |
UnlimitedMileage |
boolean simple type |
|
Optional |
|
True if unlimited miles for rate |
VendorCode |
string simple type |
|
Optional |
|
|
SupplierRate |
element |
|
|
|
|
BaseRate |
string simple type |
|
Optional |
|
Rate for the entire rent without the required charges |
DropOffCharge |
string simple type |
|
Optional |
|
The additional fee for dropping off a vehicle at a different location. |
EstimatedTotalAmount |
string simple type |
|
Optional |
|
The estimated total amount |
ExtraMileageCharge |
string simple type |
|
Optional |
|
Cost per mile over allowance for rate |
FuelSurcharge |
string simple type |
|
Optional |
|
The additional amount charged for fuel |
PayLater |
string simple type |
|
Optional |
|
Pay later is added for Future Functionality |
PayNow |
string simple type |
|
Optional |
|
Pay Now is added for Future Functionality |
RateForPeriod |
string simple type |
|
Optional |
|
The rate for the period |
SeniorDriverCharge |
string simple type |
|
Optional |
|
The additional amount charged for senior drivers |
YoungDriverCharge |
string simple type |
|
Optional |
|
The additional amount charged for young drivers |
ApproximateTotal |
string simple type |
|
Optional |
|
The total sum of all mandatory, optional and conditional charges |
DiscountAmount |
string simple type |
|
Optional |
|
Discount Amount 1P only |
MandatoryChargeTotal |
string simple type |
|
Optional |
|
Total Mandatory Charges, which may include taxes, surcharges, and fees. 1P only. |
RateVariance |
typeRateVariance complex type |
|
|
|
Used on VehicleCreateReservationReq ONLY. @MandatoryRateMatch ='true' is required for this element to be applied. 1P. |
Apply |
string simple type |
|
Required |
|
Variance to response amount; 'high', 'low' or 'both. 1P. |
Type |
string simple type |
|
Required |
|
Supported values are 'percentage.1P. Future release 'amopunt'. |
Value |
decimal simple type |
|
Required |
|
Represents value of user permitted variance for sell success. eg. "5.00" = 5% variance on the supplier estimated total amount response will be successful. 1P. |
ApproximateRate |
typeVehicleRates complex type |
|
|
|
Monetary amounts expressed in another currency |
BaseRate |
string simple type |
|
Optional |
|
Rate for the entire rent without the required charges |
DropOffCharge |
string simple type |
|
Optional |
|
The additional fee for dropping off a vehicle at a different location. |
EstimatedTotalAmount |
string simple type |
|
Optional |
|
The estimated total amount |
ExtraMileageCharge |
string simple type |
|
Optional |
|
Cost per mile over allowance for rate |
FuelSurcharge |
string simple type |
|
Optional |
|
The additional amount charged for fuel |
PayLater |
string simple type |
|
Optional |
|
Pay later is added for Future Functionality |
PayNow |
string simple type |
|
Optional |
|
Pay Now is added for Future Functionality |
RateForPeriod |
string simple type |
|
Optional |
|
The rate for the period |
SeniorDriverCharge |
string simple type |
|
Optional |
|
The additional amount charged for senior drivers |
YoungDriverCharge |
string simple type |
|
Optional |
|
The additional amount charged for young drivers |
VehicleCharge |
typeVehicleCharge complex type |
|
|
|
Charges associated with the vehicle rental. |
Category |
string simple type |
|
Required |
|
The type of charge information for the vehicle rental. |
Description |
string simple type |
|
Optional |
|
Special Equipment Charge description text of the rental charge. 1P only. |
IncludedInRate |
string simple type |
NotIncluded , IncludedInBase , IncludedInTotal |
Optional |
|
Specifies whether the charge is included in the rate and if it is, if it is in the base or total rate. |
Name |
string simple type |
|
Optional |
|
Identifies the type of charge information for the category. For 1P , when category is “Special”, Name attribute will have Special Equipment code enumeration, which can be used in booking vehicle on 1P host. |
Type |
string simple type |
NoCharge , Percent , Rental , PerContract , PerHour , PerDay , PerWeek , PerMonth |
Optional |
|
Used to specify how a charge is applied, such as per rental, per day, etc. |
Amount |
typeMoney simple type |
|
|
|
The amount of the charge. |
Percentage |
typePercentageWithDecimal simple type |
|
|
|
The amount of the charge in percentage. |
VehicleRateDescription |
typeVehicleRateDescription complex type |
|
|
|
The amount of the charge in percentage. |
Name |
string simple type |
|
Optional |
|
Optional context name of the text block being returned i.e. Room details |
Text |
anonymous simple type |
|
|
|
Optional context name of the text block being returned i.e. Room details |
RateHostIndicator |
typeRateHostIndicator complex type |
|
|
|
Optional context name of the text block being returned i.e. Room details |
InventoryToken |
string simple type |
|
Optional |
|
Vendor info about rate to adjust pricing as needed |
RateToken |
string simple type |
|
Optional |
|
Assocates shop response to sell request |
HourlyLateCharge |
typeRateInfo complex type |
|
|
|
Assocates shop response to sell request |
ExtraMileageCharge |
string simple type |
|
Optional |
|
Cost per mile or kilometer over allowance for rate |
MileageAllowance |
long simple type |
|
Optional |
|
Number of miles or kilometers allowed for rate if not unlimited |
NumberOfPeriods |
long simple type |
|
Optional |
|
Define how many periods (e.g. number of days or weeks) |
RateForPeriod |
string simple type |
|
Optional |
|
The rate for the period |
Units |
string simple type |
MI , KM |
Optional |
|
Describes distance units for MileageAllowance or ExtraMileageCharge |
UnlimitedMileage |
boolean simple type |
|
Optional |
|
True if unlimited miles allowed. Not set if unknown |
DailyLateCharge |
typeRateInfo complex type |
|
|
|
True if unlimited miles allowed. Not set if unknown |
ExtraMileageCharge |
string simple type |
|
Optional |
|
Cost per mile or kilometer over allowance for rate |
MileageAllowance |
long simple type |
|
Optional |
|
Number of miles or kilometers allowed for rate if not unlimited |
NumberOfPeriods |
long simple type |
|
Optional |
|
Define how many periods (e.g. number of days or weeks) |
RateForPeriod |
string simple type |
|
Optional |
|
The rate for the period |
Units |
string simple type |
MI , KM |
Optional |
|
Describes distance units for MileageAllowance or ExtraMileageCharge |
UnlimitedMileage |
boolean simple type |
|
Optional |
|
True if unlimited miles allowed. Not set if unknown |
PricedEquip |
element |
|
|
|
Special Equipment detail and charge for rental |
Equipment |
element |
|
|
|
Requested Special Equipment Information |
Description |
string simple type |
|
Required |
|
Special Equipment description |
Quantity |
decimal simple type |
|
Optional |
|
Special Equipment quantity |
Status |
string simple type |
|
Optional |
|
Status of the request returned by the supplier. Valid Values KK (Confirmed), UC (Unable to Confirm and NN (On request) |
Type |
string simple type |
|
Required |
|
The Type of Special Equipment requested |
Charge |
element |
|
|
|
Charge information associated to Special Equipment |
Amount |
string simple type |
|
Required |
|
Special Equipment Charge Amount. |
IncludedInEstTotalInd |
boolean simple type |
|
Required |
|
Special Equipment Amount is included in the Estimated Total Amount |
RatePeriod |
string simple type |
|
Required |
|
Rate Period associated to the Special Equipment Charge Amount.e.g. Daily, Weekly, Rental |
RateInclusions |
element |
|
|
|
Provides the list of additional charges included in Rate. e.g Tax, Airport Surcharge, CDW etc |
IncludedItem |
element |
|
|
|
Provides details of included item. |
Code |
string simple type |
|
Required |
|
Code for included item. |
Description |
string simple type |
|
Required |
|
Description of included item. |
WeeklyLateCharge |
typeRateInfo complex type |
|
|
|
Extra Week Charges information. Supported providers:1P only |
ExtraMileageCharge |
string simple type |
|
Optional |
|
Cost per mile or kilometer over allowance for rate |
MileageAllowance |
long simple type |
|
Optional |
|
Number of miles or kilometers allowed for rate if not unlimited |
NumberOfPeriods |
long simple type |
|
Optional |
|
Define how many periods (e.g. number of days or weeks) |
RateForPeriod |
string simple type |
|
Optional |
|
The rate for the period |
Units |
string simple type |
MI , KM |
Optional |
|
Describes distance units for MileageAllowance or ExtraMileageCharge |
UnlimitedMileage |
boolean simple type |
|
Optional |
|
True if unlimited miles allowed. Not set if unknown |
PrintText |
string simple type |
|
|
|
Informational text provided by the supplier that may be related to the reservation. This is applicable in response messages only, 1p only. |
SpecialEquipment |
element |
|
|
|
Informational text provided by the supplier that may be related to the reservation. This is applicable in response messages only, 1p only. |
Key |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Required |
|
Special equipment associated with a specific vehicle |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
VehicleSpecialRequest |
element |
|
|
|
Make a textual request to the Vehicle supplier. |
Key |
string simple type |
|
Optional |
|
|
PaymentInformation |
element |
|
|
|
The payment information for a vehicle reservation. |
BillingNumber |
string simple type |
|
Optional |
|
A Billing Number that may be associated to the Voucher. |
BillingReferenceNumber |
string simple type |
|
Optional |
|
A Number Assigned for Billing reconciliation processes that may also include a Corporate Account ID |
PrePayment |
string simple type |
|
Optional |
|
Amount paid in advance for vehicle reservation. Can contain other non Money information to the vehicle supplier. |
Key |
string simple type |
|
Optional |
|
|
Voucher |
typeVoucherInformation complex type |
|
|
|
|
AccountName |
string simple type |
|
Optional |
|
Associated account name for the voucher |
Amount |
string simple type |
|
Optional |
|
Amount associated with the Voucher. |
ConfirmationNumber |
string simple type |
|
Optional |
|
Confirmation from the vendor for the voucher |
Number |
string simple type |
|
Optional |
|
To advise car associates of the voucher number and store in the car segment. It is required when VoucherType selected as "RegularVoucher" for 1P only. |
VoucherType |
string simple type |
FullCredit , GroupOrDay , SpecificValue , RegularVoucher |
Required |
|
Specifies if the Voucher is for Full Credit or a Group/Day or a Monetary Amount or RegularVoucher. |
DeliveryAddress |
element |
|
|
|
An address to which a rental car should be delivered and a phone number associated with the address. |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
CollectionAddress |
element |
|
|
|
An address from which a rental car should be picked up at the end of a rental period and a phone number associated with the address. |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
FlightArrivalInformation |
element |
|
|
|
The flight arrival information
(airline code and flight number) for the
airport/city at which the rental car will
be picked up |
Carrier |
string simple type |
|
Required |
|
The carrier that is marketing this segment |
FlightNumber |
string simple type |
|
Optional |
|
The flight number under which the marketing
carrier is marketing this flight |
Key |
string simple type |
|
Optional |
|
|
Guarantee |
element |
|
|
|
Payment GuaranteeGuarantee, Deposit or PrePayment |
ExternalReference |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
Reusable |
boolean simple type |
|
Optional |
false |
Indicates whether the form of payment can be reused or not. Currently applicable for Credit and Debit form of payment |
ReuseFOP |
string simple type |
|
Optional |
|
Key of the FOP Key to be reused as this Form of Payment.Only Credit and Debit Card will be supported for FOP Reuse. |
Type |
string simple type |
|
Required |
|
Guarantee, Deposit for 1G/1V/1P and PrePayment for 1P only |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
CreditCard |
element |
|
|
|
Container for all credit card information. |
AcceptanceOverride |
boolean simple type |
|
Optional |
|
Override airline restriction on the credit card. |
BankCountryCode |
string simple type |
|
Optional |
|
ISO Country code associated with the issuing bank |
BankName |
string simple type |
|
Optional |
|
Issuing bank name for this credit card |
BankStateCode |
string simple type |
|
Optional |
|
State code associated with the issuing bank. |
CustomerReference |
string simple type |
|
Optional |
|
Agencies use this to pass the traveler information to the credit card company. |
Enett |
boolean simple type |
|
Optional |
false |
Acceptable values are true or false. If set to true it will denote that the credit card used has been issued through Enett. For all other credit card payments this value will be set to false. |
ExtendedPayment |
string simple type |
|
Optional |
|
Used for American Express (AX) and other credit cards, e.g., Visa (VI) and Master card (CA), that allow Extended Payment, subject to the BSP market rule. |
ThirdPartyPayment |
boolean simple type |
|
Optional |
false |
If true, this indicates that the credit card holder is not one of the passengers. |
ApprovalCode |
string simple type |
|
Optional |
|
This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions. |
CVV |
string simple type |
|
Optional |
|
Card Verification Code |
ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
Name |
string simple type |
|
Optional |
|
The name as it appears on the card. |
Number |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type. |
Key |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
BillingAddress |
typeStructuredAddress complex type |
|
|
|
The address to where the billing statements
for this card are sent. Used for address verification purposes. |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
OtherGuaranteeInfo |
element |
|
|
|
|
Type |
string simple type |
IATA/ARC Number , Agency Address , Deposit Taken , Others |
Required |
|
1) IATA/ARC Number
2) Agency Address
2) Deposit Taken
3) Others |
AssociatedRemark |
element |
|
|
|
1) IATA/ARC Number
2) Agency Address
2) Deposit Taken
3) Others |
Key |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this element is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
BookingSource |
element |
|
|
|
Reference to Booking Traveler. |
Code |
string simple type |
|
Required |
|
Alternate booking source code or number. |
Type |
string simple type |
PseudoCityCode , ArcNumber , IataNumber , CustomerId , BookingSourceOverride |
Required |
|
Type of booking source sent in the Code attribute. Possible values are “PseudoCityCode”,” ArcNumber”,” IataNumber”, “CustomerId” and “BookingSourceOverrride”. “BookingSourceOverrride” is only applicable in VehicleCreateReservationReq. 1P. |
ThirdPartyInformation |
element |
|
|
|
Third party supplier locator information. Specifically applicable for SDK booking. |
Key |
string simple type |
|
Optional |
|
Unique identifier of the third party supplier. Key can be used to modify or delete saved third party information. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider Reservation reference |
ThirdPartyCode |
string simple type |
|
Optional |
|
Third party supplier code. |
ThirdPartyLocatorCode |
string simple type |
|
Optional |
|
Confirmation number for third party supplier. |
ThirdPartyName |
string simple type |
|
Optional |
|
Third party supplier name. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
SegmentRef |
typeGeneralReference complex type |
|
|
|
Air/Passive Segment Reference |
Key |
string simple type |
|
Required |
|
|
SellMessage |
string simple type |
|
|
|
Sell Message from Vendor. This is applicable in response messages only, any input in request message will be ignored. |
PassiveReservation |
element |
|
|
|
The parent container for all passive booking data |
CreateDate |
string simple type |
|
Required |
|
The date and time that this reservation was created. |
CustomerNumber |
string simple type |
|
Optional |
|
|
LocatorCode |
string simple type |
|
Required |
|
The unique identifier for this reservation. If this is this View Only UR LocatorCode is '999999'. |
ModifiedDate |
string simple type |
|
Required |
|
The date and time that this reservation was last modified for any reason. |
ProviderReservationInfoRef |
string simple type |
|
Required |
|
Provider Reservation reference key. |
AccountingRemark |
element |
|
|
|
An accounting remark container to hold any
printable text. |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various
remarks. This is not required, but it is recommended. |
Key |
string simple type |
|
Optional |
|
|
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider
for which this accounting remark is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required,
else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
GeneralRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
CreateDate |
dateTime simple type |
|
Optional |
|
The date and time that this GeneralRemark was created. |
Direction |
string simple type |
Incoming , Outgoing |
Optional |
|
Direction Incoming or Outgoing of the GeneralRemark. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
The type of product this reservation is relative to |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required, else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
Restriction |
element |
|
|
|
Which activities are supported for a particular element |
Operation |
string simple type |
|
Required |
|
The operation that is restricted |
Reason |
string simple type |
|
Optional |
|
The reason it is restricted |
PassiveInfo |
element |
|
|
|
Used by CreateReservationReq for passing in elements normally found post-booking |
ProviderCode |
string simple type |
|
Optional |
|
|
ProviderLocatorCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
SupplierLocatorCode |
string simple type |
|
Optional |
|
|
TicketNumber |
string simple type |
|
|
|
|
ConfirmationNumber |
string simple type |
|
|
|
|
Commission |
element |
|
|
|
Identifies the agency commission |
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan |
Key |
string simple type |
|
Optional |
|
|
Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
SupplierLocator |
element |
|
|
|
Locator code on the host carrier system |
CreateDateTime |
dateTime simple type |
|
Optional |
|
The Date and Time which the reservation is received from the Vendor as a SupplierLocator creation Date. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider Reservation reference |
SupplierCode |
string simple type |
|
Required |
|
Carrier Code |
SupplierLocatorCode |
string simple type |
|
Required |
|
Carrier reservation locator code |
SegmentRef |
typeGeneralReference complex type |
|
|
|
Air/Passive Segment Reference |
Key |
string simple type |
|
Required |
|
|
ThirdPartyInformation |
element |
|
|
|
Third party supplier locator information. Specifically applicable for SDK booking. |
Key |
string simple type |
|
Optional |
|
Unique identifier of the third party supplier. Key can be used to modify or delete saved third party information. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider Reservation reference |
ThirdPartyCode |
string simple type |
|
Optional |
|
Third party supplier code. |
ThirdPartyLocatorCode |
string simple type |
|
Optional |
|
Confirmation number for third party supplier. |
ThirdPartyName |
string simple type |
|
Optional |
|
Third party supplier name. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
SegmentRef |
typeGeneralReference complex type |
|
|
|
Air/Passive Segment Reference |
Key |
string simple type |
|
Required |
|
|
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PassiveSegment |
element |
|
|
|
|
AvailabilityDisplayType |
string simple type |
|
Optional |
|
The type of availability from which the segment is sold. E.g., General, Carrier Specific/Direct Access, Fare Shop/Optimal Shop, etc. |
AvailabilitySource |
string simple type |
|
Optional |
|
Indicates Availability source of AirSegment. |
ClassOfService |
string simple type |
|
Optional |
|
|
Destination |
string simple type |
|
Optional |
|
This optional, except when Type is Air, then it is required. |
EndDate |
string simple type |
|
Optional |
|
|
FlightNumber |
string simple type |
|
Optional |
|
|
Group |
decimal simple type |
|
Optional |
|
Unique Identifier used for grouping together identical segments. |
Key |
string simple type |
|
Optional |
|
The Key of Passive Segment. |
NumberOfItems |
decimal simple type |
|
Optional |
|
|
Origin |
string simple type |
|
Optional |
|
Origin for Air, but City for all other Types. |
PassiveGroup |
string simple type |
|
Optional |
|
Used for grouping 2 sets of identical passive segments with different remark information. |
PassiveProviderReservationInfoRef |
string simple type |
|
Optional |
|
Passive Provider Reservation reference
key. |
PolledAvailabilityOption |
string simple type |
|
Optional |
|
Indicates if carrier has inside(polled) availability option. |
ProviderSegmentOrder |
integer simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations in the provider reservation. |
SegmentType |
string simple type |
|
Required |
|
The Type of Passive segment being entered (
Car,Hotel,Tour,Air,Surface,Bus,Rail,Cruise,Helicopter,Limousine,Transfers,Miscellaneous,ProcessingFee,Insurance,
AirTaxi,Currency,Fees,Forms,Group,Include,Leisure,Land,Other,Package,RailRoad,SeaPlane,Software,Supply,Service,
Theater,Ticket,Transfer,Taxi,Charter,CorporatePlane,UnitedPassive,AccountingInfo,BookingFee,ServiceCharge,ServiceFee,TicketFees
,TelexCharge) |
StartDate |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
Vendor Code. This could have values outside what is defined as a carrier. (eg:ZZ as in case for vendor in case of Due paid) |
TravelOrder |
decimal simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel/Passive segments/reservations based on travel dates. This ordering is applicable across the UR not provider or traveler specific |
VehicleType |
string simple type |
|
Optional |
|
The Type of Vehicle in Passive Segment. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Amount |
element |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AmountDuePaid |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Due , Paid , Text |
Optional |
|
|
PassiveRemark |
element |
|
|
|
|
PassiveSegmentRef |
string simple type |
|
Required |
|
The Passive Segment key that this remark refers to. |
Text |
string simple type |
|
|
|
The Passive Segment key that this remark refers to. |
Type |
string simple type |
|
|
|
The Passive Segment key that this remark refers to. |
AssociatedRemark |
element |
|
|
|
The Passive Segment key that this remark refers to. |
SegmentRef |
string simple type |
|
Optional |
|
Reference to an Air/Passive Segment |
Key |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this element is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
RailReservation |
element |
|
|
|
The parent container for all Rail booking data |
CreateDate |
string simple type |
|
Required |
|
The date and time that this reservation was created. |
CustomerNumber |
string simple type |
|
Optional |
|
|
LocatorCode |
string simple type |
|
Required |
|
The unique identifier for this reservation. If this is this View Only UR LocatorCode is '999999'. |
ModifiedDate |
string simple type |
|
Required |
|
The date and time that this reservation was last modified for any reason. |
BookingStatus |
string simple type |
|
Required |
|
The Current Status of the rail booking. |
AccountingRemark |
element |
|
|
|
An accounting remark container to hold any
printable text. |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various
remarks. This is not required, but it is recommended. |
Key |
string simple type |
|
Optional |
|
|
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider
for which this accounting remark is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required,
else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
GeneralRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
CreateDate |
dateTime simple type |
|
Optional |
|
The date and time that this GeneralRemark was created. |
Direction |
string simple type |
Incoming , Outgoing |
Optional |
|
Direction Incoming or Outgoing of the GeneralRemark. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
The type of product this reservation is relative to |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required, else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
Restriction |
element |
|
|
|
Which activities are supported for a particular element |
Operation |
string simple type |
|
Required |
|
The operation that is restricted |
Reason |
string simple type |
|
Optional |
|
The reason it is restricted |
PassiveInfo |
element |
|
|
|
Used by CreateReservationReq for passing in elements normally found post-booking |
ProviderCode |
string simple type |
|
Optional |
|
|
ProviderLocatorCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
SupplierLocatorCode |
string simple type |
|
Optional |
|
|
TicketNumber |
string simple type |
|
|
|
|
ConfirmationNumber |
string simple type |
|
|
|
|
Commission |
element |
|
|
|
Identifies the agency commission |
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan |
Key |
string simple type |
|
Optional |
|
|
Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
RailJourney |
element |
|
|
|
Captures all journey-related data |
JourneyDirection |
string simple type |
Outward , Return |
Optional |
|
The direction of the Journey (Outward or Return). |
JourneyDuration |
decimal simple type |
|
Optional |
|
The duration of the entire Journey in minutes |
Key |
string simple type |
|
Required |
|
|
Operation |
string simple type |
|
Optional |
|
"Type of exchange. Add - Add new Journey. Update - Modify existing Journey. Delete - Remove existing Journey" |
PassiveProviderReservationInfoRef |
string simple type |
|
Optional |
|
Passive provider reservation reference key. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
RouteDescription |
string simple type |
|
Optional |
|
The description of the route. |
RouteReference |
string simple type |
|
Optional |
|
RouteReference is required in seat assignment purpose |
Status |
string simple type |
|
Optional |
|
Status of this Journey. |
TravelOrder |
decimal simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations/Journeys based on travel dates. This ordering is applicable across the UR not provider or traveler specific |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
ArrivalTime |
string simple type |
|
Optional |
|
The date and time at which this entity arrives at the destination. This does not include time zone information since it can be derived from the origin location. |
DepartureTime |
string simple type |
|
Required |
|
The date and time at which this entity departs. This does not include time zone information since it can be derived from the origin location. |
Destination |
string simple type |
|
Optional |
|
The IATA location code for this destination of this entity. |
DestinationStationName |
string simple type |
|
Optional |
|
The destination station name for the Journey. |
Origin |
string simple type |
|
Optional |
|
The IATA location code for this origination of this entity. |
OriginStationName |
string simple type |
|
Optional |
|
The origin station name for the Journey. |
RailLocDestination |
string simple type |
|
Optional |
|
RCH specific destination code (a.k.a UCodes) which uniquely identifies a train station. |
RailLocOrigin |
string simple type |
|
Optional |
|
RCH specific origin code (a.k.a UCodes) which uniquely identifies a train station. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RailSegment |
element |
|
|
|
Rail Segment |
Key |
string simple type |
|
Required |
|
|
Passive |
boolean simple type |
|
Optional |
|
|
ProviderSegmentOrder |
integer simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations in the provider reservation. |
Status |
string simple type |
|
Optional |
|
Status of this segment. |
TravelOrder |
decimal simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel segments/reservations based on travel dates. This ordering is applicable across the UR not provider or traveler specific |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
CabinClass |
string simple type |
|
Optional |
|
Rail Cabin class specification. The valid values are Economy, Business, First and Other |
ClassCode |
string simple type |
|
Optional |
|
A booking code or fare basis code or fare class. |
HostTokenRef |
string simple type |
|
Optional |
|
The reference key for the host token. From the HostTokenList Providers RCH. |
ReservationRequired |
boolean simple type |
|
Optional |
|
Set to true if a reservation is required for booking. |
SeatAssignable |
boolean simple type |
|
Optional |
|
Set to true if there exists seats to be booked |
TrainNumber |
string simple type |
|
Optional |
|
|
TrainType |
string simple type |
|
Optional |
|
Type of train used. Same as TrainServiceType. |
TrainTypeCode |
string simple type |
|
Optional |
|
Code for type of train used. Same as TrainServiceType. |
TransportCode |
string simple type |
|
Optional |
|
Supplier specific train code |
TransportMode |
string simple type |
Bicycle , Boat , Bus , Cable Car , Car , Carriage , Courtesy car , Helicopter , Limousine , Metro , Monorail , Motorbike , Pack Animal , Plane , Rental Car , Rickshaw , Shuttle , Subway , Sedan Chair , Taxi , Train , Trolley , Tube , Walk , Water Taxi , Other , Car/Rush hour , Taxi/Rush hour , No Transportation , Express Train , Public , Ship/Ferry , Underground , Tram/light rail , Shared Taxi |
Optional |
|
Type of Transport Mode used. |
TravelTime |
decimal simple type |
|
Optional |
|
Total time spent (minutes) traveling |
ArrivalTime |
string simple type |
|
Optional |
|
The date and time at which this entity arrives at the destination. This does not include time zone information since it can be derived from the origin location. |
DepartureTime |
string simple type |
|
Required |
|
The date and time at which this entity departs. This does not include time zone information since it can be derived from the origin location. |
Destination |
string simple type |
|
Optional |
|
The IATA location code for this destination of this entity. |
DestinationStationName |
string simple type |
|
Optional |
|
The destination station name for the Journey. |
Origin |
string simple type |
|
Optional |
|
The IATA location code for this origination of this entity. |
OriginStationName |
string simple type |
|
Optional |
|
The origin station name for the Journey. |
RailLocDestination |
string simple type |
|
Optional |
|
RCH specific destination code (a.k.a UCodes) which uniquely identifies a train station. |
RailLocOrigin |
string simple type |
|
Optional |
|
RCH specific origin code (a.k.a UCodes) which uniquely identifies a train station. |
SegmentRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Key |
string simple type |
|
Required |
|
|
RailSegmentInfo |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars)Holds the ExtraSegmentInfo and VendorMessages from RCH response. |
Category |
string simple type |
|
Optional |
|
Supplier specific category. |
Type |
string simple type |
Extra , Vendor , Services |
Required |
|
Either Extra for ExtraSegmentInfo or Vendor for VendorMessages. |
OperatingCompany |
element |
|
|
|
A textual remark identifying the OperatingCompany/Train Service other than BN orTL |
Code |
string simple type |
|
Optional |
|
Company Short Text |
Name |
string simple type |
|
Required |
|
Name Identifying the Train Service other than BN orTL |
RailAvailInfo |
element |
|
|
|
Name Identifying the Train Service other than BN orTL |
CabinClass |
string simple type |
|
Optional |
|
The fare basis code or fare class for this fare. |
ClassCode |
string simple type |
|
Optional |
|
A booking code or fare basis code or fare class. |
Quantity |
decimal simple type |
|
Optional |
|
Available fare basis code or fare class quantity. |
FulFillmentType |
anonymous simple type |
|
|
|
Fulfillment options for this segment. the options will be one of "Ticket on Departure", "Ticketless", "Ticket By Email", "Travel Agency" |
RailSegmentRef |
element |
|
|
|
Reference to a RaiLSegment |
Key |
string simple type |
|
Required |
|
|
JourneyRemark |
element |
|
|
|
A Remark for a Journey. |
Category |
string simple type |
|
Optional |
|
|
HostToken |
element |
|
|
|
This is a host token. It contains some kind of payload we got from a hostthat must be passed in on successive calls they know who you are as our systemdoes not maintain state. The format of this string isn't important as long as itis not altered in any way between calls. Since a host token is only valid onthe host it is assocated with, there is also an attribute called Host so we knowhow to route the command(s). You can have multiple active sessions betweenone or more hosts |
Host |
string simple type |
|
Optional |
|
The host associated with this token |
Key |
anySimpleType simple type |
|
Optional |
|
Unique identifier for this token - use this key when a single HostToken is shared by multiple elements. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RailPricingInfo |
element |
|
|
|
Per traveler type pricing breakdown. |
ApproximateExchangeAmount |
string simple type |
|
Optional |
|
|
ExchangeAmount |
string simple type |
|
Optional |
|
The amount to pay to cover the exchange of the fare (includes penalties). |
Key |
string simple type |
|
Required |
|
|
ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RailFare |
element |
|
|
|
Information about this fare component |
Amount |
string simple type |
|
Optional |
|
|
CabinClass |
string simple type |
|
Required |
|
The fare basis code or fare class for this fare |
CrossCityFare |
boolean simple type |
|
Optional |
false |
Set to 'true' if the fare is valid across a Metropolitan Area, eg. Cross-London travel via the London Underground. |
Destination |
string simple type |
|
Optional |
|
Returns the airport or city code that defines the destination market for this fare. |
DestinationStationName |
string simple type |
|
Optional |
|
The destination station name for the Rail Fare. |
EffectiveDate |
string simple type |
|
Required |
|
Returns the date on which this fare was quoted. Set as current date |
FareBasis |
string simple type |
|
Optional |
|
The fare basis code or fare description for this fare |
FareReference |
string simple type |
|
Optional |
|
Unique reference for the fare that is required in RailExchangeQuote request. |
JourneyDirection |
string simple type |
Outward , Return |
Optional |
|
The direction of the Journey (Outward or Return) associated with the Rail fare. |
Key |
string simple type |
|
Required |
|
|
Origin |
string simple type |
|
Optional |
|
Returns the airport or city code that defines the origin market for this fare. |
OriginStationName |
string simple type |
|
Optional |
|
The origin station name for the Rail Fare. |
PassengerTypeCode |
string simple type |
|
Optional |
|
The PTC that is associated with this fare. Default to ADT |
RailLocDestination |
string simple type |
|
Optional |
|
RCH specific destination code (a.k.a UCodes) which uniquely identifies a train station. |
RailLocOrigin |
string simple type |
|
Optional |
|
RCH specific origin code (a.k.a UCodes) which uniquely identifies a train station. |
ReservationRequired |
boolean simple type |
|
Optional |
|
Set to true if a seat reservation is required while booking. |
RouteDescription |
string simple type |
|
Optional |
|
Describes the route of the train fare. |
TicketTypeCode |
string simple type |
|
Optional |
|
Describes the main identifier code of the fare. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RailFareNoteRef |
element |
|
|
|
A reference to a fare note from a shared list. Used to minimize xml results. |
Key |
string simple type |
|
Required |
|
|
RailFareID |
element |
|
|
|
|
Category |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Required |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RailFareIDRef |
element |
|
|
|
Reference to a complete FareID from a shared list |
Key |
string simple type |
|
Required |
|
|
FareValidity |
element |
|
|
|
Associates fare validity dates with journeys. |
NotValidAfter |
date simple type |
|
Optional |
|
Fare not valid after this date. |
NotValidBefore |
date simple type |
|
Optional |
|
Fare not valid before this date. |
RailJourneyRef |
string simple type |
|
Required |
|
Reference to a journey to which this fare validity refers. |
HostToken |
element |
|
|
|
This is a host token. It contains some kind of payload we got from a hostthat must be passed in on successive calls they know who you are as our systemdoes not maintain state. The format of this string isn't important as long as itis not altered in any way between calls. Since a host token is only valid onthe host it is assocated with, there is also an attribute called Host so we knowhow to route the command(s). You can have multiple active sessions betweenone or more hosts |
Host |
string simple type |
|
Optional |
|
The host associated with this token |
Key |
anySimpleType simple type |
|
Optional |
|
Unique identifier for this token - use this key when a single HostToken is shared by multiple elements. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
FulFillmentType |
anonymous simple type |
|
|
|
Fulfillment options for this segment. the options will be one of "Ticket on Departure", "Ticketless", "Ticket By Email", "Travel Agency" |
RailFareComponent |
element |
|
|
|
Contains fare and discount information for each passenger type |
Age |
decimal simple type |
|
Optional |
|
|
Amount |
string simple type |
|
Optional |
|
FareComponent amount |
Key |
string simple type |
|
Required |
|
|
PassengerTypeCode |
string simple type |
|
Optional |
|
The three character passenger code |
Quantity |
decimal simple type |
|
Optional |
|
|
SupplierPassengerType |
string simple type |
|
Optional |
|
Supplier passenger type code |
Discount |
element |
|
|
|
Discount information specific to the fare component |
Key |
string simple type |
|
Optional |
|
|
DiscountCard |
element |
|
|
|
Rail Discount Card Information |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Number |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RailFareRef |
element |
|
|
|
Reference to a complete FareInfo from a shared list |
Key |
string simple type |
|
Required |
|
|
RailBookingInfo |
element |
|
|
|
Links journeys and fares together |
OptionalService |
boolean simple type |
|
Optional |
false |
Indicate the OfferFareItem elements will be Optional or not. |
RailFareRef |
string simple type |
|
Required |
|
Reference to a fare that applies to the journey below. |
RailJourneyRef |
string simple type |
|
Required |
|
Reference to a journeys on which the above fare applies. |
PassengerType |
typePassengerType complex type |
|
|
|
Reference to a journeys on which the above fare applies. |
AccompaniedPassenger |
boolean simple type |
|
Optional |
false |
Container to identify accompanied passenger. Set true means this passenger is accompanied |
Age |
decimal simple type |
|
Optional |
|
|
BookingTravelerRef |
string simple type |
|
Optional |
|
This value should be set for Multiple Passengers in the request. |
Code |
string simple type |
|
Required |
|
The 3-char IATA passenger type code |
DOB |
date simple type |
|
Optional |
|
Passenger Date of Birth |
Gender |
string simple type |
|
Optional |
|
The passenger gender type |
PricePTCOnly |
boolean simple type |
|
Optional |
|
|
ResidencyType |
string simple type |
Employee , National , Resident |
Optional |
|
The passenger residence type. |
Name |
element |
|
|
|
Complete name fields |
First |
string simple type |
|
Required |
|
First Name. Size can be up to 256 characters |
Last |
string simple type |
|
Required |
|
Last Name. Size can be up to 256 characters |
Middle |
string simple type |
|
Optional |
|
Midle name. Size can be up to 256 characters |
Prefix |
string simple type |
|
Optional |
|
Name prefix. Size can be up to 20 characters |
Suffix |
string simple type |
|
Optional |
|
Name suffix. Size can be up to 256 characters |
TravelerProfileId |
integer simple type |
|
Optional |
|
Traveler Applied Profile ID. |
LoyaltyCard |
element |
|
|
|
Provider loyalty card information |
CardNumber |
string simple type |
|
Required |
|
|
FreeText |
string simple type |
|
Optional |
|
|
Level |
string simple type |
|
Optional |
|
|
MembershipStatus |
string simple type |
|
Optional |
|
|
PriorityCode |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Optional |
|
|
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
|
VendorLocationRef |
string simple type |
|
Optional |
|
|
AllianceLevel |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
MembershipProgram |
string simple type |
|
Optional |
|
Loyalty Program membership Id of the traveler specific to Amtrak(2V) Guest Rewards |
SupplierCode |
string simple type |
|
Required |
|
The code used to identify the Loyalty supplier, e.g. AA, ZE, MC |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationSpecificInfo |
typeProviderReservationSpecificInfo complex type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationLevel |
boolean simple type |
|
Optional |
|
If true means Loyalty card is applied at ProviderReservation level. |
ReservationLevel |
boolean simple type |
|
Optional |
|
If true means Loyalty card is applied at Universal Record Reservation level e.g. Hotel Reservation, Vehicle Reservation etc. |
OperatedBy |
element |
|
|
|
This is the carrier code to support Cross Accrual |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
DiscountCard |
element |
|
|
|
Rail Discount Card Information |
Code |
string simple type |
|
Required |
|
|
Description |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Number |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
PersonalGeography |
element |
|
|
|
Personal geography details of the associated passenger. |
CountryCode |
typeCountry simple type |
|
|
|
Passenger country code. |
StateProvinceCode |
typeState simple type |
|
|
|
Passenger state/province code. |
CityCode |
typeCity simple type |
|
|
|
Passenger city code. |
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
Payment |
element |
|
|
|
Payment information - must be used in conjunction with credit card info |
Amount |
string simple type |
|
Required |
|
|
AmountType |
string simple type |
|
Optional |
|
This field displays type of payment amount when it is non-monetary. Presently available/supported value is "Flight Pass Credits". |
ApproximateAmount |
string simple type |
|
Optional |
|
It stores the converted payment amount in agency's default currency |
BookingTravelerRef |
string simple type |
|
Optional |
|
If the type represents a per traveler payment, then this will reference the traveler this payment refers to. |
FormOfPaymentRef |
string simple type |
|
Required |
|
The credit card that is will be used to make this payment. |
Key |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Optional |
|
Status to indicate the business association of the payment element. |
Type |
string simple type |
AirlineFee , DeliveryFee , Itinerary , Passenger , ServiceFee , OptionalService , TicketFee |
Required |
|
Identifies the type of payment. This can be for an itinerary, a traveler, or a service fee for example. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RailTicketInfo |
element |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
BookingTravelerRef |
string simple type |
|
Optional |
|
Reference to a BookingTraveler. |
IssueLocation |
string simple type |
|
Optional |
|
Issue location is internal distributor code associated with the PCC. |
IssuedDate |
dateTime simple type |
|
Optional |
|
Ticket issue date. |
Number |
string simple type |
|
Required |
|
Ticket number. |
TicketFormType |
string simple type |
|
Optional |
|
FormType of Ticket. |
TicketStatus |
string simple type |
|
Optional |
|
Status of Ticket. |
TicketType |
string simple type |
|
Optional |
|
Type of ticket. Paper, eTicket etc. |
TrafficType |
string simple type |
|
Optional |
|
Type of traffic. |
RailJourneyRef |
element |
|
|
|
Reference to a RailJourney |
Key |
string simple type |
|
Required |
|
|
TicketAdvisory |
element |
|
|
|
Additional ticket information. |
Key |
string simple type |
|
Optional |
|
|
LanguageCode |
token simple type |
|
Optional |
|
ISO 639 two-character language codes are used to retrieve specific information in the requested language. For Rich Content and Branding, language codes ZH-HANT (Chinese Traditional), ZH-HANS (Chinese Simplified), FR-CA (French Canadian) and PT-BR (Portuguese Brazil) can also be used. For RCH, language codes ENGB, ENUS, DEDE, DECH can also be used. Only certain services support this attribute. Providers: ACH, RCH, 1G, 1V, 1P. |
RailFareNoteList |
element |
|
|
|
The shared object list of Notes |
RailFareNote |
element |
|
|
|
A simple textual fare note. Used within several other objects. |
Key |
string simple type |
|
Required |
|
|
NoteName |
string simple type |
|
Required |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
SupplierLocator |
element |
|
|
|
Locator code on the host carrier system |
CreateDateTime |
dateTime simple type |
|
Optional |
|
The Date and Time which the reservation is received from the Vendor as a SupplierLocator creation Date. |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider Reservation reference |
SupplierCode |
string simple type |
|
Required |
|
Carrier Code |
SupplierLocatorCode |
string simple type |
|
Required |
|
Carrier reservation locator code |
SegmentRef |
typeGeneralReference complex type |
|
|
|
Air/Passive Segment Reference |
Key |
string simple type |
|
Required |
|
|
CruiseReservation |
element |
|
|
|
The parent container for all cruise booking data. |
CreateDate |
string simple type |
|
Required |
|
The date and time that this reservation was created. |
CustomerNumber |
string simple type |
|
Optional |
|
|
LocatorCode |
string simple type |
|
Required |
|
The unique identifier for this reservation. If this is this View Only UR LocatorCode is '999999'. |
ModifiedDate |
string simple type |
|
Required |
|
The date and time that this reservation was last modified for any reason. |
AccountingRemark |
element |
|
|
|
An accounting remark container to hold any
printable text. |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various
remarks. This is not required, but it is recommended. |
Key |
string simple type |
|
Optional |
|
|
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider
for which this accounting remark is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required,
else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
GeneralRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
CreateDate |
dateTime simple type |
|
Optional |
|
The date and time that this GeneralRemark was created. |
Direction |
string simple type |
Incoming , Outgoing |
Optional |
|
Direction Incoming or Outgoing of the GeneralRemark. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
The type of product this reservation is relative to |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required, else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
Restriction |
element |
|
|
|
Which activities are supported for a particular element |
Operation |
string simple type |
|
Required |
|
The operation that is restricted |
Reason |
string simple type |
|
Optional |
|
The reason it is restricted |
PassiveInfo |
element |
|
|
|
Used by CreateReservationReq for passing in elements normally found post-booking |
ProviderCode |
string simple type |
|
Optional |
|
|
ProviderLocatorCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
SupplierLocatorCode |
string simple type |
|
Optional |
|
|
TicketNumber |
string simple type |
|
|
|
|
ConfirmationNumber |
string simple type |
|
|
|
|
Commission |
element |
|
|
|
Identifies the agency commission |
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger. |
CommissionOverride |
boolean simple type |
|
Optional |
false |
This is enabled to override CAT-35 commission error during air ticketing. PROVIDER SUPPORTED:Worldspan |
Key |
string simple type |
|
Optional |
|
|
Level |
string simple type |
Recalled , Fare , Penalty |
Required |
|
The commission percentage level. |
Modifier |
string simple type |
FarePercent , FareAmount , CommissionAmount , LessStandardCommission , StandardPlusSupplementaryPercent , SupplementaryPercent , SupplementaryAmount |
Optional |
|
Optional commission modifier. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
Type |
string simple type |
Flat , PercentBase , PercentTotal |
Required |
|
The commission type. |
Value |
string simple type |
|
Optional |
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
CruiseSegment |
element |
|
|
|
An Cruise marketable travel segment. |
Key |
string simple type |
|
Required |
|
|
Passive |
boolean simple type |
|
Optional |
|
|
ProviderSegmentOrder |
integer simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations in the provider reservation. |
Status |
string simple type |
|
Optional |
|
Status of this segment. |
TravelOrder |
decimal simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel segments/reservations based on travel dates. This ordering is applicable across the UR not provider or traveler specific |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ArrivalTime |
string simple type |
|
Optional |
|
The date and time at which this cruise segment arrives at the destination. |
DepartureTime |
string simple type |
|
Optional |
|
The date and time at which this cruise segment departs from the origin. |
Destination |
string simple type |
|
Required |
|
The location code for the destination of cruise segment. |
Origin |
string simple type |
|
Required |
|
The location code for the origin of cruise segment. |
Vendor |
string simple type |
|
Optional |
|
Cruise Vendor Code. |
VendorName |
string simple type |
|
Optional |
|
Cruise Vendor Name. |
SegmentRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Key |
string simple type |
|
Required |
|
|
CruiseStay |
element |
|
|
|
Provides Cruise information. |
BookingAgent |
string simple type |
|
Optional |
|
Name of the travel agent booking itinerary. |
BookingCredit |
string simple type |
|
Optional |
|
Credit Paid at the time of booking |
BookingDate |
date simple type |
|
Optional |
|
Date when cruise was booked |
CancellationDate |
date simple type |
|
Optional |
|
The date at which the booking was
cancelled. |
CancellationNumber |
string simple type |
|
Optional |
|
Cancellation Number of Cruise Segment. |
CancellationTime |
time simple type |
|
Optional |
|
The time at which the booking was
cancelled. |
ConfirmationNumber |
string simple type |
|
Optional |
|
Confirmation number of cruise segment. |
DurationOfStay |
decimal simple type |
|
Optional |
|
Length of stay |
LinkedConfNumber |
string simple type |
|
Optional |
|
Linked Cruise Confirmation Number. |
OtherPartyConfNbr |
decimal simple type |
|
Optional |
|
Confirm number of the other parties travelling
with this party. |
PassengerOrigin |
string simple type |
|
Optional |
|
Origination city for passenger (not necessarily
the city from which the cruise embarks). |
ShipName |
string simple type |
|
Optional |
|
Ship name |
UnitOfStay |
string simple type |
|
Optional |
|
Unit of duration of stay in Days or Night(Value -
Day/Night) |
Package |
element |
|
|
|
Cruise package Details |
Identifier |
string simple type |
|
Optional |
|
Vendor Package/Tour identifier |
Name |
string simple type |
|
Optional |
|
Cruise package Name |
PackageIdentifier |
string simple type |
|
Optional |
|
Vendor Package/Tour Identifier |
PassengerCount |
decimal simple type |
|
Optional |
|
Number in party |
CabinInfo |
element |
|
|
|
Cruise Cabin Details |
BedConfiguration |
string simple type |
|
Optional |
|
Description of the cabin bed configuration e.g.
TWIN BEDS |
Category |
string simple type |
|
Optional |
|
Vendor defined Cabin category |
DeckName |
string simple type |
|
Optional |
|
Ship's deck on which cabin resides. |
Location |
string simple type |
|
Optional |
|
Cabin Category , can be of the following values :
''I' - Inside Cabins, 'O' - Outside Cabins, 'M' - Inside and
Outside Cabins (mixed) |
Number |
string simple type |
|
Optional |
|
Vendor defined cabin designator Or Cabin Number |
RelativeLocation |
string simple type |
|
Optional |
|
Position of the cabin relative to the layout of
the ship, e.g. OUT,AFT,PORT |
SmokingIndicator |
boolean simple type |
|
Optional |
|
Whether user has specified his smoking
preference.Can be of the following values : true' - Smoking' 'false' -
Non-smoking |
DiningInfo |
element |
|
|
|
Cruise Dining Details |
Seating |
string simple type |
|
Optional |
|
Seating Arrangement. Can be of the following
values : '1' - First seating, '2' - Second seating |
Status |
string simple type |
|
Optional |
|
Status of this dining |
TableSize |
decimal simple type |
|
Optional |
|
Size of the table in number of persons |
CruiseItinerary |
element |
|
|
|
Contains one day's journey Record. |
ArrivalDate |
date simple type |
|
Optional |
|
The date at which this entity arrives at
the destination. |
ArrivalTime |
time simple type |
|
Optional |
|
The time at which this entity arrives at
the destination. |
BoardingDate |
date simple type |
|
Optional |
|
The date at which this passenger boards
the entity. |
BoardingTime |
time simple type |
|
Optional |
|
The time at which this passenger boards
the entity. |
DepartureDate |
date simple type |
|
Optional |
|
The date at which this entity departs. |
DepartureTime |
time simple type |
|
Optional |
|
The time at which this entity departs. |
PortIndicator |
string simple type |
|
Optional |
|
Port of call type. Can be of the following values
: P - Port of Cal, S - At Sea, E - Embarkation Port, D -
Disembarkation Port |
PortName |
string simple type |
|
Optional |
|
Port of call name |
Status |
string simple type |
|
Optional |
|
Port of call status .Possible Values (List): SS -
New item, LL - Waitlisted item, NN - Item is no need/need status,
IX - Canceled item, HK - Booked item, HL - Booked item, HN -
Booked item, UC - Unconfirmed item |
CruisePricingInfo |
element |
|
|
|
Cruise pricing Information. Contains all related
pricing data for travelers. |
NetFare |
string simple type |
|
Optional |
|
Net Fare amount (Base price plus miscellaneouscharges less discounts) |
ReceivedAmount |
string simple type |
|
Optional |
|
Amount of money Recieved |
ApproximateBasePrice |
string simple type |
|
Optional |
|
The Converted base price in Default Currency for this entity. This does not include any taxes or surcharges. |
ApproximateFees |
string simple type |
|
Optional |
|
The Converted fee amount in Default Currency. |
ApproximateTaxes |
string simple type |
|
Optional |
|
The Converted tax amount in Default Currency. |
ApproximateTotalPrice |
string simple type |
|
Optional |
|
The Converted total price in Default Currency for this entity including base price and all taxes. |
BasePrice |
string simple type |
|
Optional |
|
Represents the base price for this entity. This does not include any taxes or surcharges. |
EquivalentBasePrice |
string simple type |
|
Optional |
|
Represents the base price in the related currency for this entity. This does not include any taxes or surcharges. |
Fees |
string simple type |
|
Optional |
|
The aggregated amount of all the fees that are associated with this entity. See the associated FeeInfo array for a breakdown of the individual fees. |
Services |
string simple type |
|
Optional |
|
The total cost for all optional services. |
Taxes |
string simple type |
|
Optional |
|
The aggregated amount of all the taxes that are associated with this entity. See the associated TaxInfo array for a breakdown of the individual taxes. |
TotalPrice |
string simple type |
|
Optional |
|
The total price for this entity including base price and all taxes. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
Fare |
element |
|
|
|
Cruise Fare info. |
FareSpecific |
boolean simple type |
|
Optional |
|
Category is fare specific or not |
MultipleFareIndicator |
boolean simple type |
|
Optional |
|
Multiple fare are used or not |
RateCode |
string simple type |
|
Optional |
|
Vendor defined rate code |
Charges |
element |
|
|
|
Container for various Charges assocaited with the
Cruise Booking |
AirCharge |
string simple type |
|
Optional |
|
Total Amount of Air Charges associated with
Cruise |
OptionalCharge |
string simple type |
|
Optional |
|
Total Amount of Optional Charges associated with
Cruise |
PenaltyCharge |
string simple type |
|
Optional |
|
Amount of penalty charged with Cruise |
PortCharge |
string simple type |
|
Optional |
|
Amount of Port tax associated with Cruise |
PortChargeDescription |
string simple type |
|
Optional |
|
Text explaining Port charges |
WaiverCharge |
string simple type |
|
Optional |
|
Total Waiver/Insurance charges associated with
Cruise |
WaiverChargeType |
string simple type |
|
Optional |
|
Use to determine if the amount is Waiver Charges
or Insurance Charges.(Values - Waiver/Insurance) |
Discount |
element |
|
|
|
Cruise Discount Amount. |
Amount |
string simple type |
|
Required |
|
Amount of Discount |
Description |
string simple type |
|
Optional |
|
Text explaining discount amount |
Deposit |
element |
|
|
|
Indicates Deposit dates. |
Amount |
string simple type |
|
Optional |
|
Amount of Deposit |
DueDate |
date simple type |
|
Optional |
|
Date when deposit or balance is due. |
ReceivedDate |
date simple type |
|
Optional |
|
Date when deposit or balance is received, if
received. |
Balance |
element |
|
|
|
Indicates balance dates. |
CheckDueAmount |
string simple type |
|
Optional |
|
Balance due via personal check |
CreditCardDueAmount |
string simple type |
|
Optional |
|
Balance due via credit card payment |
DueDate |
date simple type |
|
Optional |
|
Date when deposit or balance is due. |
ReceivedDate |
date simple type |
|
Optional |
|
Date when deposit or balance is received, if
received. |
Commission |
element |
|
|
|
Cruise Commission. |
Amount |
string simple type |
|
Optional |
|
Total amount of commission associated with cruise |
MiscellaneousAmount |
string simple type |
|
Optional |
|
Total amount of other Commission associated with
cruise |
MiscellaneousDescription |
string simple type |
|
Optional |
|
Text explaining other Commission amount |
CruiseFees |
element |
|
|
|
Cruise Fees amount. |
Amount |
string simple type |
|
Required |
|
Total amount of fees associated for cruise |
Description |
string simple type |
|
Optional |
|
Text explaining fee amount |
CruiseBookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty
cards |
Key |
string simple type |
|
Optional |
|
|
WaiverIndicator |
boolean simple type |
|
Optional |
|
Indicates Passenger accepts/rejects waiver or
insurance from vendor. |
LoyaltyCardRef |
element |
|
|
|
Indicates Passenger accepts/rejects waiver or
insurance from vendor. |
Key |
string simple type |
|
Required |
|
|
OptionalService |
element |
|
|
|
Featues/Optionals supported with the cruise booked. |
AirCityIndicator |
boolean simple type |
|
Optional |
|
Feature/option is air or city dependent. |
BookingDate |
date simple type |
|
Optional |
|
Date Cruise Booked |
Description |
string simple type |
|
Optional |
|
Descriptive Name of Feature or Option |
EndDate |
date simple type |
|
Optional |
|
Feature/Option End Date |
FeatureType |
string simple type |
|
Required |
|
Type of Optional Service. F: Feature, O: Option |
ProviderDefinedType |
string simple type |
|
Optional |
|
Unique ID on vendors system |
PurchaseIndicator |
boolean simple type |
|
Optional |
|
Option purchased by someone other than the
passenger |
Quantity |
nonNegativeInteger simple type |
|
Optional |
|
Number of Features/Options Requested. |
SetIdentifier |
string simple type |
|
Optional |
|
Feature/Option Unique ID Examples: B2NOXFR |
SetName |
string simple type |
|
Optional |
|
Feature/Option Set Name Examples: PRE-CRUISE |
StartDate |
date simple type |
|
Optional |
|
Feature/Option Begin Date |
Status |
string simple type |
|
Optional |
|
Status of of the Optional Service |
TotalPrice |
string simple type |
|
Optional |
|
Feature/Option Price |
TransportIndicator |
boolean simple type |
|
Optional |
|
Whether Features/ Options Affects
TransportationIndicator. True - This Feature or Option group affects
transportation
False - This Feature or Option group does not affect transportation. |
OptionJourneyDetails |
element |
|
|
|
Contains PickUp Return Details for that Cruise
Feature/Option Service. |
PickUpCarrier |
string simple type |
|
Optional |
|
The carrier that is marketing this segment. |
PickUpDescription |
string simple type |
|
Optional |
|
PickUp Location Description |
PickUpFlightNumber |
string simple type |
|
Optional |
|
The flight number under which the marketing
carrier is marketing carrier is marketing this flight |
PickUpLocation |
string simple type |
|
Optional |
|
IATA/Non-IATA Location Code for Pickup.
Examples:YVR |
PickUpTime |
time simple type |
|
Optional |
|
PickUp Time |
ReturnCarrier |
string simple type |
|
Optional |
|
The carrier that is marketing this segment. |
ReturnDescription |
string simple type |
|
Optional |
|
Return Location Description |
ReturnFlightNumber |
string simple type |
|
Optional |
|
The flight number under which the marketing
carrier is marketing carrier is marketing this flight |
ReturnLocation |
string simple type |
|
Optional |
|
IATA/Non-IATA Location Code for Drop Off.
Examples:YVR |
ReturnTime |
time simple type |
|
Optional |
|
Return time |
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler and Loyalty cards |
Key |
string simple type |
|
Optional |
|
|
LoyaltyCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DriversLicenseRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
DiscountCardRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
PaymentRef |
element |
|
|
|
|
Key |
string simple type |
|
Required |
|
|
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
Payment |
element |
|
|
|
Payment information - must be used in conjunction with credit card info |
Amount |
string simple type |
|
Required |
|
|
AmountType |
string simple type |
|
Optional |
|
This field displays type of payment amount when it is non-monetary. Presently available/supported value is "Flight Pass Credits". |
ApproximateAmount |
string simple type |
|
Optional |
|
It stores the converted payment amount in agency's default currency |
BookingTravelerRef |
string simple type |
|
Optional |
|
If the type represents a per traveler payment, then this will reference the traveler this payment refers to. |
FormOfPaymentRef |
string simple type |
|
Required |
|
The credit card that is will be used to make this payment. |
Key |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Optional |
|
Status to indicate the business association of the payment element. |
Type |
string simple type |
AirlineFee , DeliveryFee , Itinerary , Passenger , ServiceFee , OptionalService , TicketFee |
Required |
|
Identifies the type of payment. This can be for an itinerary, a traveler, or a service fee for example. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
EMDSummaryInfo |
element |
|
|
|
Container for EMD summary information. Supported providers are 1G/1V/1P |
Key |
string simple type |
|
Optional |
|
System generated Key |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
A reference to the provider reservation with which the document is associated.Displayed when shown as part of UR.Not displayed in EMDRetrieveRsp |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
EMDSummary |
element |
|
|
|
EMD summary information. Supported providers are 1G/1V/1P |
Key |
string simple type |
|
Optional |
|
System generated Key |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AssociatedTicketNumber |
string simple type |
|
Optional |
|
This number indicates the e-Ticket number associated with this EMD |
InConjunctionWith |
string simple type |
|
Optional |
|
Returns the number of the Primary EMD, if this EMD is a conjunctive EMD |
IssueDate |
dateTime simple type |
|
Optional |
|
Issue Date for this EMD |
Number |
string simple type |
|
Required |
|
EMD Number |
PlatingCarrier |
string simple type |
|
Optional |
|
Plating carrier code for which this EMD is issued |
PrimaryDocumentIndicator |
boolean simple type |
|
Optional |
|
Indicates whether the EMD is a primary EMD. |
EMDCoupon |
element |
|
|
|
The coupon information for the EMD issued. Supported providers are 1G/1V/1P |
ConsumedAtIssuanceInd |
boolean simple type |
|
Optional |
|
Indicates if the EMD coupon has been considered used as soon as issued. |
Destination |
string simple type |
|
Optional |
|
Destination Airport Code for the flight with which the Coupon is associated |
FlightNumber |
string simple type |
|
Optional |
|
Flight Number of the flight with which the coupon is associated. |
Key |
string simple type |
|
Optional |
|
System generated Key |
MarketingCarrier |
string simple type |
|
Optional |
|
Marketing carrier associated with the coupon |
NonRefundableInd |
boolean simple type |
|
Optional |
|
Indicates whether the coupon is non-refundable |
Number |
decimal simple type |
|
Required |
|
Number of the EMD coupon |
Origin |
string simple type |
|
Optional |
|
Departure Airport Code for the flight with which the Coupon is associated |
PresentAt |
string simple type |
|
Optional |
|
Location of service provider where this coupon should be presented at |
PresentTo |
string simple type |
|
Optional |
|
Service provider to present the coupon to |
RFIC |
string simple type |
|
Required |
|
Reason For Issuance Code for the EMD coupon |
RFIDescription |
string simple type |
|
Optional |
|
Reason for Issueance Description for the EMD coupon |
RFISC |
string simple type |
|
Optional |
|
Reason For Issueance Sub code for the EMD coupon |
Status |
string simple type |
|
Required |
|
Status of the coupon. Possible values Open, Void, Refunded, Exchanged, Irregular Operations,Airport Control, Checked In, Flown/Used, Boarded/Lifted, Suspended, Unknown |
SvcDescription |
string simple type |
|
Optional |
|
Description of the service related to the EMD Coupon |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
EMDTravelerInfo |
element |
|
|
|
EMD traveler information. Supported providers are 1G/1V/1P |
Age |
decimal simple type |
|
Optional |
|
Age of the traveler |
TravelerType |
string simple type |
|
Optional |
|
Defines the type of traveler used for booking which could be a non-defining type (Companion, Web-fare, etc), or a standard type (Adult, Child, etc). |
NameInfo |
element |
|
|
|
Name information of the EMD traveler. |
First |
string simple type |
|
Required |
|
First Name. |
Last |
string simple type |
|
Required |
|
Last Name. |
Middle |
string simple type |
|
Optional |
|
Midle name. |
Prefix |
string simple type |
|
Optional |
|
Name prefix. |
Suffix |
string simple type |
|
Optional |
|
Name suffix. |
Payment |
element |
|
|
|
Payment information - must be used in conjunction with credit card info |
Amount |
string simple type |
|
Required |
|
|
AmountType |
string simple type |
|
Optional |
|
This field displays type of payment amount when it is non-monetary. Presently available/supported value is "Flight Pass Credits". |
ApproximateAmount |
string simple type |
|
Optional |
|
It stores the converted payment amount in agency's default currency |
BookingTravelerRef |
string simple type |
|
Optional |
|
If the type represents a per traveler payment, then this will reference the traveler this payment refers to. |
FormOfPaymentRef |
string simple type |
|
Required |
|
The credit card that is will be used to make this payment. |
Key |
string simple type |
|
Optional |
|
|
Status |
string simple type |
|
Optional |
|
Status to indicate the business association of the payment element. |
Type |
string simple type |
AirlineFee , DeliveryFee , Itinerary , Passenger , ServiceFee , OptionalService , TicketFee |
Required |
|
Identifies the type of payment. This can be for an itinerary, a traveler, or a service fee for example. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderARNKSegment |
element |
|
|
|
Represents host ARNK segments. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
ProviderSegmentOrder |
integer simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations in the provider reservation. |
PreviousSegment |
element |
|
|
|
To identify the appropriate travel sequence for Air/Car/Hotel/Rail segments/reservations in the provider reservation. |
AirSegmentRef |
typeSegmentRef complex type |
|
|
|
Reference to AirSegment from an Air
Reservation. |
Key |
string simple type |
|
Required |
|
|
HotelReservationRef |
typeNonAirReservationRef complex type |
|
|
|
Specify the locator code of Hotel reservation. |
LocatorCode |
string simple type |
|
Required |
|
|
VehicleReservationRef |
typeNonAirReservationRef complex type |
|
|
|
Specify the locator code of Vehicle
reservation. |
LocatorCode |
string simple type |
|
Required |
|
|
PassiveSegmentRef |
typeSegmentRef complex type |
|
|
|
Reference to PassiveSegment from a Passive
Reservation. |
Key |
string simple type |
|
Required |
|
|
NextSegment |
element |
|
|
|
|
AirSegmentRef |
typeSegmentRef complex type |
|
|
|
Reference to AirSegment from an Air
Reservation. |
Key |
string simple type |
|
Required |
|
|
HotelReservationRef |
typeNonAirReservationRef complex type |
|
|
|
Specify the locator code of Hotel reservation. |
LocatorCode |
string simple type |
|
Required |
|
|
VehicleReservationRef |
typeNonAirReservationRef complex type |
|
|
|
Specify the locator code of Vehicle
reservation. |
LocatorCode |
string simple type |
|
Required |
|
|
PassiveSegmentRef |
typeSegmentRef complex type |
|
|
|
Reference to PassiveSegment from a Passive
Reservation. |
Key |
string simple type |
|
Required |
|
|
SegmentContinuityInfo |
element |
|
|
|
This container holds Arnks and segment continuity remarks |
ArrivalUnknownSegmentCount |
decimal simple type |
|
Optional |
|
|
ArvlUnknSegment |
element |
|
|
|
An ARNK segment that identifies a missing travel information |
Destination |
string simple type |
|
Optional |
|
The IATA CITY code for this destination of this entity. |
Key |
string simple type |
|
Required |
|
|
Origin |
string simple type |
|
Optional |
|
The IATA CITY code for this origination of this entity. |
TravelOrder |
decimal simple type |
|
Optional |
|
To identify the appropriate travel sequence for Air/Car/Hotel segments/reservations based on travel dates. This ordering is applicable across the UR not provider or traveler specific |
BookingTravelerRef |
element |
|
|
|
Reference Element for Booking Traveler |
Key |
string simple type |
|
Required |
|
|
ContinuityOverrideRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Category |
string simple type |
|
Optional |
MCT |
This is remark category is always MCT. 'Minimum Connect Time' |
XMLRemark |
element |
|
|
|
A remark container to hold an XML document. (max 1024 chars) This will be encoded with xml encoding. |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
Key |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
GeneralRemark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various remarks. This is not required, but it is recommended. |
CreateDate |
dateTime simple type |
|
Optional |
|
The date and time that this GeneralRemark was created. |
Direction |
string simple type |
Incoming , Outgoing |
Optional |
|
Direction Incoming or Outgoing of the GeneralRemark. |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SupplierType |
string simple type |
Air , Vehicle , Hotel , Rail , Cruise , Other |
Optional |
|
The type of product this reservation is relative to |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required, else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
|
SupplierCode |
string simple type |
|
Optional |
|
|
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
AccountingRemark |
element |
|
|
|
An accounting remark container to hold any
printable text. |
Category |
string simple type |
|
Optional |
|
A category to group and organize the various
remarks. This is not required, but it is recommended. |
Key |
string simple type |
|
Optional |
|
|
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider
for which this accounting remark is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
TypeInGds |
string simple type |
|
Optional |
|
|
UseProviderNativeMode |
boolean simple type |
|
Optional |
false |
Will be true when terminal process required,
else false |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
UnassociatedRemark |
element |
|
|
|
A textual remark container to hold non-associated itinerary remarks |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this element is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
Key |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
Postscript |
element |
|
|
|
Postscript Notes |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this element is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
Key |
string simple type |
|
Optional |
|
|
AgencyInfo |
element |
|
|
|
Tracks the various agent/agency information |
AgentAction |
element |
|
|
|
Depending on context, this will represent
information about which agent perform different actions. |
ActionType |
string simple type |
Created , Modified , Ticketed |
Required |
|
The type of action the agent performed. |
AgencyCode |
string simple type |
|
Required |
|
The AgencyCode of the agent who performed the action. |
AgentCode |
string simple type |
|
Required |
|
The AgenctCode who performed the action. |
AgentSine |
string simple type |
|
Optional |
|
The sign in user name of the agent logged into the terminal. PROVIDER SUPPORTED: ACH |
BranchCode |
string simple type |
|
Required |
|
The BranchCode of the branch (working branch, branchcode used for the request. If nothing specified, branchcode for the agent) who performed the action. |
EventTime |
dateTime simple type |
|
Required |
|
Date and time at which this event took place. |
AgentOverride |
string simple type |
|
Optional |
|
AgentSine value that was used during PNR creation or End Transact. |
AppliedProfile |
element |
|
|
|
A simple container to specify the profiles that were applied to a reservation. |
AccountID |
string simple type |
|
Optional |
|
The ID of the AccountProfile that was applied |
AccountName |
string simple type |
|
Optional |
|
The name from the AccountProfile that was applied |
ImmediateParentID |
string simple type |
|
Optional |
|
The ID of the immediate parent that was applied |
ImmediateParentName |
string simple type |
|
Optional |
|
The name of the immediate parent that was applied |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
TravelerID |
string simple type |
|
Optional |
|
The ID of the TravelerProfile that was applied |
TravelerName |
string simple type |
|
Optional |
|
The name from the TravelerProfile that was applied |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AgencyContactInfo |
element |
|
|
|
Generic agency contact information container. It must contain at least one phone number to be used by an agency |
Key |
string simple type |
|
Optional |
|
|
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
CustomerID |
element |
|
|
|
A provider reservation field used to store customer information. It may be used to identify reservations which will/will not be available for access. |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this element is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
Key |
string simple type |
|
Optional |
|
|
CommissionRemark |
element |
|
|
|
Identifies the agency commision remarks.
Specifically used for Worldspan. |
Key |
string simple type |
|
Optional |
|
Key to be used for internal processing. |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider
for which this accounting remark is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationLevel |
element |
|
|
|
Specify commission which is applicable to
PNR level. |
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
CommissionCap |
string simple type |
|
Optional |
|
Commission cap for the Airline. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
PassengerTypeLevel |
element |
|
|
|
Specify commission which is applicable to
per PTC level. |
TravelerType |
string simple type |
|
Required |
|
|
Amount |
string simple type |
|
Optional |
|
The monetary amount of the commission. |
CommissionCap |
string simple type |
|
Optional |
|
Commission cap for the Airline. |
Percentage |
string simple type |
|
Optional |
|
The percent of the commission. |
ConsolidatorRemark |
element |
|
|
|
Authorization remark for Consolidator access to a PNR . Contains PCC information created by retail agent to allow a consolidator to service their PNR. PROVIDER SUPPORTED: Worldspan. |
Key |
string simple type |
|
Optional |
|
Key to be used for internal processing. |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this element is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
PseudoCityCode |
element |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
InvoiceRemark |
element |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Key |
string simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderCode |
string simple type |
|
Optional |
|
Contains the Provider Code of the provider for which this element is used |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
RemarkData |
string simple type |
|
|
|
Actual remarks data. |
BookingTravelerRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler. |
AirSegmentRef |
typeSegmentRef complex type |
|
|
|
Reference to AirSegment from an Air Reservation. |
Key |
string simple type |
|
Required |
|
|
HotelReservationRef |
typeNonAirReservationRef complex type |
|
|
|
Specify the locator code of Hotel reservation. |
LocatorCode |
string simple type |
|
Required |
|
|
VehicleReservationRef |
typeNonAirReservationRef complex type |
|
|
|
Specify the locator code of Vehicle reservation. |
LocatorCode |
string simple type |
|
Required |
|
|
PassiveSegmentRef |
typeSegmentRef complex type |
|
|
|
Reference to PassiveSegment from a Passive Reservation. |
Key |
string simple type |
|
Required |
|
|
ReviewBooking |
element |
|
|
|
Review Booking or Queue Minders is to add the reminders in the Provider Reservation along with the date time and Queue details. On the date time defined in reminders, the message along with the PNR goes to the desired Queue. |
DateTime |
dateTime simple type |
|
Required |
|
Date and Time to place message on designated Queue, Should be prior to the last segment date in the PNR. |
Key |
string simple type |
|
Optional |
|
Returned in response. Use it for update of saved review booking. |
ProviderCode |
string simple type |
|
Optional |
|
The code of the Provider (e.g 1G,1V). |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider Reservation reference. Returned in the response. Use it for update of saved Review Booking. |
PseudoCityCode |
string simple type |
|
Optional |
|
Input PCC optional value for placing the PNR into Queue. If not passed, will add as default PNR's Pseudo. |
Queue |
integer simple type |
|
Required |
|
Queue number, Must be numeric and less than 100. |
QueueCategory |
string simple type |
|
Optional |
|
Queue Category, 2 Character Alpha or Numeric. |
Remarks |
string simple type |
|
Required |
|
Remark or reminder message. It can be truncated depending on the provider. |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
SSR |
element |
|
|
|
Special serivces like wheel chair, or pet carrier. |
Carrier |
string simple type |
|
Optional |
|
|
CarrierSpecificText |
string simple type |
|
Optional |
|
Carrier specific information which are not captured in the FreeText field(not present in IATA's standard SSR DOCO format). An example is VISA Expiration Date. |
Description |
string simple type |
|
Optional |
|
|
FreeText |
string simple type |
|
Optional |
|
Certain SSR types will require a free text message. For example MAAS (Meet and assist). |
Key |
string simple type |
|
Optional |
|
|
PassiveSegmentRef |
string simple type |
|
Optional |
|
Reference to the passive segment. |
ProfileID |
string simple type |
|
Optional |
|
Key assigned for Secure Flight Document value from the specified profile |
ProfileSecureFlightDocKey |
string simple type |
|
Optional |
|
Unique ID of Booking Traveler's Profile that contains the Secure flight Detail |
ProviderDefinedType |
string simple type |
|
Optional |
|
Original Type as sent by the provider |
ProviderReservationInfoRef |
string simple type |
|
Optional |
|
Provider reservation reference key. |
SSRRuleRef |
string simple type |
|
Optional |
|
UniqueID to associate a rule to the SSR |
SegmentRef |
string simple type |
|
Optional |
|
Reference to the air segment. May be required for some Types. |
Status |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Required |
|
Programmatic SSRs use codes recognized by the provider/supplier (example, VGML=vegetarian meal code). Manual SSRs do not have an associated programmatic code. |
URL |
anyURI simple type |
|
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
InvoiceData |
element |
|
|
|
List of invoices only for 1G/1V |
InvoiceNumber |
string simple type |
|
Required |
|
Invoice number |
IssueDate |
dateTime simple type |
|
Optional |
|
Invoice issue date |
Key |
string simple type |
|
Optional |
|
|
ProviderReservationInfoRef |
string simple type |
|
Required |
|
Provider reservation reference key. |
BookingTravelerInformation |
element |
|
|
|
Booking Traveler information tied to invoice |
BookingTravelerRef |
string simple type |
|
Optional |
|
A reference to a passenger related to a ticket. |
Name |
element |
|
|
|
Complete name fields |
First |
string simple type |
|
Required |
|
First Name. Size can be up to 256 characters |
Last |
string simple type |
|
Required |
|
Last Name. Size can be up to 256 characters |
Middle |
string simple type |
|
Optional |
|
Midle name. Size can be up to 256 characters |
Prefix |
string simple type |
|
Optional |
|
Name prefix. Size can be up to 20 characters |
Suffix |
string simple type |
|
Optional |
|
Name suffix. Size can be up to 256 characters |
TravelerProfileId |
integer simple type |
|
Optional |
|
Traveler Applied Profile ID. |
FormOfPayment |
element |
|
|
|
A Form of Payment used to purchase all or part of
a booking. |
AgentText |
string simple type |
|
Optional |
|
This is only relevent when IsAgentType is specified as true. Otherwise this will be ignored. |
ExternalReference |
string simple type |
|
Optional |
|
|
FulfillmentIDNumber |
string simple type |
|
Optional |
|
Identification number, e.g. card number, to define how the customer will identify himself when collecting the ticket |
FulfillmentIDType |
string simple type |
Bahn Card , Credit Card , Euro Cheque Card , Collection Reference |
Optional |
|
Identification type, e.g. credit card, to define how the customer will identify himself when collecting the ticket |
FulfillmentLocation |
string simple type |
|
Optional |
|
Information about the location of the printer. |
FulfillmentType |
string simple type |
|
Optional |
|
Defines how the client wishes to receive travel documents. Type does not define where or how payment is made. The supported values are "Ticket on Departure",
"Travel Agency",
"Courier",
"Standard Mail",
"Ticketless",
"Ticket Office",
"Express Mail",
"Corporate Kiosk",
"Train Station Service Desk",
"Direct Printing of Ticket",
"Ticket by Email",
"Digital Printing of Ticket at Home",
"Retrieve Ticket at Eurostar in London"
Collect booking ticket at a Kiosk, print in agency. |
IsAgentType |
boolean simple type |
|
Optional |
false |
If this is true then FormOfPayment mention in Type is anAgent type FormOfPayment. |
Key |
string simple type |
|
Optional |
|
|
ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
ProfileKey |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
Reusable |
boolean simple type |
|
Optional |
false |
Indicates whether the form of payment can be reused or not. Currently applicable for Credit and Debit form of payment |
ReuseFOP |
string simple type |
|
Optional |
|
Key of the FOP Key to be reused as this Form of Payment.Only Credit and Debit Card will be supported for FOP Reuse. |
Type |
string simple type |
|
Required |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
CreditCard |
element |
|
|
|
Container for all credit card information. |
AcceptanceOverride |
boolean simple type |
|
Optional |
|
Override airline restriction on the credit card. |
BankCountryCode |
string simple type |
|
Optional |
|
ISO Country code associated with the issuing bank |
BankName |
string simple type |
|
Optional |
|
Issuing bank name for this credit card |
BankStateCode |
string simple type |
|
Optional |
|
State code associated with the issuing bank. |
CustomerReference |
string simple type |
|
Optional |
|
Agencies use this to pass the traveler information to the credit card company. |
Enett |
boolean simple type |
|
Optional |
false |
Acceptable values are true or false. If set to true it will denote that the credit card used has been issued through Enett. For all other credit card payments this value will be set to false. |
ExtendedPayment |
string simple type |
|
Optional |
|
Used for American Express (AX) and other credit cards, e.g., Visa (VI) and Master card (CA), that allow Extended Payment, subject to the BSP market rule. |
ThirdPartyPayment |
boolean simple type |
|
Optional |
false |
If true, this indicates that the credit card holder is not one of the passengers. |
ApprovalCode |
string simple type |
|
Optional |
|
This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions. |
CVV |
string simple type |
|
Optional |
|
Card Verification Code |
ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
Name |
string simple type |
|
Optional |
|
The name as it appears on the card. |
Number |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type. |
Key |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
BillingAddress |
typeStructuredAddress complex type |
|
|
|
The address to where the billing statements
for this card are sent. Used for address verification purposes. |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
DebitCard |
element |
|
|
|
Container for all debit card information. |
ApprovalCode |
string simple type |
|
Optional |
|
This code is required for an authorization process from the Credit Card company directly,required for some of the CCH carriers.This attribute is also used for EMD retrieve and issuance transactions. |
CVV |
string simple type |
|
Optional |
|
Card Verification Code |
ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
Name |
string simple type |
|
Optional |
|
The name as it appears on the card. |
Number |
string simple type |
|
Optional |
|
|
Type |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type. |
IssueNumber |
string simple type |
|
Optional |
|
Verification number for Debit Cards |
Key |
string simple type |
|
Optional |
|
The Key assigned to the payment details value from the specified profile. |
ProfileID |
string simple type |
|
Optional |
|
The unique ID of the profile that contains the payment details to use. |
PhoneNumber |
element |
|
|
|
Consists of type (office, home, fax), location (city code), the country code, the number, and an extension. |
AreaCode |
string simple type |
|
Optional |
|
|
CountryCode |
string simple type |
|
Optional |
|
Hosts/providers will expect this to be international dialing digits |
Extension |
string simple type |
|
Optional |
|
|
Key |
string simple type |
|
Optional |
|
|
Location |
string simple type |
|
Optional |
|
IATA code for airport or city |
Number |
string simple type |
|
Required |
|
The local phone number |
Text |
string simple type |
|
Optional |
|
|
Type |
string simple type |
Agency , Business , Mobile , Home , Fax , Hotel , Other , None , Email , Reservations |
Optional |
|
|
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
BillingAddress |
typeStructuredAddress complex type |
|
|
|
The address to where the billing statements
for this card are sent. Used for address verification purposes. |
Key |
string simple type |
|
Optional |
|
Key for update/delete of the element |
ElStat |
string simple type |
A , M , C |
Optional |
|
This attribute is used to show the action results of an element.
Possible values are "A" (when elements have been added to the UR) and "M" (when existing elements have been modified). Response only. |
KeyOverride |
boolean simple type |
|
Optional |
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
AddressName |
anonymous simple type |
|
|
|
If a duplicate key is found where we are adding elements in some cases like URAdd, then instead of erroring out set this attribute to true. |
Street |
anonymous simple type |
|
|
|
The Address street and number, e.g. 105 Main St. |
City |
anonymous simple type |
|
|
|
The city name for the requested address, e.g. Atlanta. |
State |
element |
|
|
|
Container to house the state code for an address |
PostalCode |
anonymous simple type |
|
|
|
The 5-15 alphanumeric postal Code for the requested address, e.g. 90210. |
Country |
anonymous simple type |
|
|
|
The Full country name or two letter ISO country code e.g. US, France. A two letter country code is required for a Postal Code Searches. |
ProviderReservationInfoRef |
element |
|
|
|
Container for Provider reservation reference key. |
Key |
string simple type |
|
Required |
|
|
EnettVan |
element |
|
|
|
Container for all eNett Van information. |
ExpiryDays |
duration simple type |
|
Optional |
|
The number of days from the VAN generation date that the VAN will be active for, after which the VAN cannot be used. |
MaxPercentage |
nonNegativeInteger simple type |
|
Optional |
|
The maximum percentage that will be applied on the Total price and sent to enett, which will denote the maximum authorized amount as approved by eNett. This value will be ignored and not used for Multi-Use VAN’s. |
MinPercentage |
nonNegativeInteger simple type |
|
Optional |
|
The minimum percentage that will be applied on the Total price and sent to enett,which will denote the minimum authorized amount approved by eNett.uApi will default this to zero for multi-use Van's. |
MultiUse |
boolean simple type |
|
Optional |
true |
Acceptable values are true or false. If set to true it will denote that the VAN being requested is multi-use else it will indicate a single -use VAN.A Single use VAN can only be debited once while the multiple use VAN's can be debited multiple times subjected to the maximum value it has been authorized for. The default value will be TRUE to indicate a multi-use VAN is being issued. |
Certificate |
element |
|
|
|
Certificate Form of Payment |
Amount |
string simple type |
|
Optional |
|
The monetary value of the certificate. |
DiscountAmount |
string simple type |
|
Optional |
|
The monetary discount amount of this certificate. |
DiscountPercentage |
decimal simple type |
|
Optional |
|
The percentage discount value of this certificate. |
NotValidAfter |
date simple type |
|
Optional |
|
The date that this certificate expires. |
NotValidBefore |
date simple type |
|
Optional |
|
The date that this certificate becomes valid. |
Number |
string simple type |
|
Required |
|
The Certificate number |
TicketNumber |
StringLength1to13 simple type |
|
|
|
The identifying number for the actual ticket |
Check |
element |
|
|
|
Check Form of Payment |
AccountNumber |
string simple type |
|
Optional |
|
The account number of the check |
CheckNumber |
string simple type |
|
Optional |
|
The sequential check number of the check. |
MICRNumber |
string simple type |
|
Optional |
|
Magnetic Ink Character Reader Number of check. |
RoutingNumber |
string simple type |
|
Optional |
|
The bank routing number of the check. |
Requisition |
element |
|
|
|
Requisition Form of Payment |
Category |
string simple type |
Government , Other |
Optional |
|
Classification Category for the requisition payment |
Number |
string simple type |
|
Optional |
|
Requisition number used for accounting |
Type |
string simple type |
Cash , Credit |
Optional |
|
Type can be Cash or Credit for category as Government |
MiscFormOfPayment |
element |
|
|
|
Miscellaneous Form of Payments |
AcceptanceOverride |
boolean simple type |
|
Optional |
|
Override airline restriction on the credit card. |
Category |
string simple type |
|
Required |
|
Indicates what Category the Miscellaneous Form Of Payment is being used for payment - The category may vary by GDS.Allowable values are
"Text"
"Credit"
"CreditCard"
"FreeFormCreditCard"
"Invoice"
"NonRefundable"
"MultipleReceivables"
"Exchange"
"Cash" |
CreditCardNumber |
string simple type |
|
Optional |
|
|
CreditCardType |
string simple type |
|
Optional |
|
The 2 letter credit/ debit card type or code which may not have been issued using the standard bank card types - i.e. an airline issued card |
ExpDate |
gYearMonth simple type |
|
Optional |
|
The Expiration date of this card in YYYY-MM format. |
Text |
string simple type |
|
Optional |
|
Any free form text which may be associated with the Miscellaneous Form of Payment. This text may be provider or GDS specific |
AgencyPayment |
typeAgencyPayment complex type |
|
|
|
Container for Agency Payment |
AgencyBillingIdentifier |
string simple type |
|
Required |
|
Value of the billing id |
AgencyBillingNumber |
string simple type |
|
Optional |
|
Value of billing number |
AgencyBillingPassword |
string simple type |
|
Optional |
|
Value of billing password |
UnitedNations |
element |
|
|
|
United Nations Form of Payments |
Number |
string simple type |
|
Required |
|
|
DirectPayment |
element |
|
|
|
Direct Payment Form of Payments |
Text |
string simple type |
|
Optional |
|
|
AgentVoucher |
element |
|
|
|
Agent Voucher Form of Payments |
Number |
string simple type |
|
Required |
|
|
PaymentAdvice |
element |
|
|
|
Contains other form of payment for Cruise
Reservations |
DocumentNumber |
string simple type |
|
Required |
|
Payment Document Number Examples: 1234567890,
R7777 |
IssueCity |
string simple type |
|
Required |
|
City code of document issuance |
IssueDate |
date simple type |
|
Required |
|
Document Issuance date |
OriginalFOP |
string simple type |
|
Optional |
|
Original form of payment Examples: CHECK 3500 |
Type |
string simple type |
|
Required |
|
Other Payment Yype. Possible Values: AGC - Agency
Check, AGG - Agency Guarantee, AWC - Award Check, CSH - Cash
Equivalent, DBC - Denied Boarding Compensation, MCO -
Miscellaneous Charge Order, TOO - Tour Order, TOV - Tour Voucher |
ProviderReservationInfoRef |
typeFormOfPaymentPNRReference complex type |
|
|
|
Other Payment Yype. Possible Values: AGC - Agency
Check, AGG - Agency Guarantee, AWC - Award Check, CSH - Cash
Equivalent, DBC - Denied Boarding Compensation, MCO -
Miscellaneous Charge Order, TOO - Tour Order, TOV - Tour Voucher |
Key |
string simple type |
|
Optional |
|
Unique ID to identify a ProviderReservationInfo |
ProviderReservationLevel |
boolean simple type |
|
Optional |
true |
It means that the form of payment is applied at ProviderReservation level. |
SegmentRef |
typeGeneralReference complex type |
|
|
|
It means that the form of payment is applied at ProviderReservation level. |
Key |
string simple type |
|
Required |
|
|
BSPPayment |
element |
|
|
|
BSP form of payment.ACH Only |
BSPIdentifier |
string simple type |
|
Required |
|
Value of the BSP Direct Bill id |
BSPPassword |
string simple type |
|
Optional |
|
Value of the BSP Direct Bill id password |
ARCPayment |
element |
|
|
|
ARC form of payment.ACH Only |
ARCIdentifier |
string simple type |
|
Required |
|
Value of the ARC Direct Bill id |
ARCPassword |
string simple type |
|
Optional |
|
Value of the ARC Direct Bill id password |