PassiveCreateReservationReq |
element |
|
|
|
Request to create a passive reservation |
| CustomerNumber |
string simple type |
|
Optional |
|
Optional client centric customer identifier |
| ProviderCode |
string simple type |
|
Optional |
|
To be used with ProviderLocatorCode, which host the reservation being added to belongs to. |
| ProviderLocatorCode |
string simple type |
|
Optional |
|
Which Provider reservation does this reservation get added to. |
| RuleName |
string simple type |
|
Optional |
|
This attribute is meant to attach a mandatory custom check rule name to a PNR. A non-mandatory custom check rule too can be attached to a PNR. |
| UniversalRecordLocatorCode |
string simple type |
|
Optional |
|
Which UniversalRecord should this new reservation be applied to. If blank, then a new one is created. |
| Version |
decimal simple type |
|
Optional |
|
|
| RetrieveProviderReservationDetails |
boolean simple type |
|
Optional |
false |
|
| AuthorizedBy |
string simple type |
|
Optional |
|
Used in showing who authorized the request. Use is 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. |
| OverrideLogging |
string simple type |
TRACE , DEBUG , INFO , WARN , ERROR , FATAL |
Optional |
|
Use to override the default logging level |
| TargetBranch |
string simple type |
|
Optional |
|
Used for Emulation - If authorised will execute the request as if the agent's parent branch is the TargetBranch specified. |
| TokenId |
string simple type |
|
Optional |
|
Authentication Token ID used when running in statefull operation. Obtained from the LoginRsp. Use is optional. |
| TraceId |
string simple type |
|
Optional |
|
Unique identifier for this atomic transaction traced by the user. Use is optional. |
| BillingPointOfSaleInfo |
element |
|
|
|
Point of Sale information for Billing |
| CIDBNumber |
integer simple type |
|
Optional |
|
A 10 Digit customer number generated by CIDB system. |
| OriginApplication |
string simple type |
|
Required |
|
Name of the Point of Sale application which initiated the Request.This information will be provided as part of the provisioning of the user. |
| AgentIDOverride |
element |
|
|
|
Vendor specific agent identifier overrides to be used to access vendor systems. |
| AgentID |
string simple type |
|
Required |
|
The Agent ID for the applicable supplier/vendor |
| ProviderCode |
string simple type |
|
Required |
|
Provider code to route the AgentId to proper provider. |
| SupplierCode |
string simple type |
|
Optional |
|
Supplier code to determine which vendor this AgentId belongs to. |
| TerminalSessionInfo |
string simple type |
|
|
|
Travelport use only. This element contains CDATA information representing existing GDS session data or ACH credentials information of the terminal user |
| OverridePCC |
element |
|
|
|
Used to emulate to another PCC or SID. Providers: 1G, 1V, 1P. |
| ProviderCode |
string simple type |
|
Required |
|
The code of the provider (e.g. 1G, 1S) |
| PseudoCityCode |
string simple type |
|
Required |
|
The PCC in the host system. |
| LinkedUniversalRecord |
element |
|
|
|
The PCC in the host system. |
| 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. |
| 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 |
| 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. |
| 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. |
| 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. |
| 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 |
|
|
| 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. |
| ContinuityCheckOverride |
element |
|
|
|
Contains alphanumeric or alpha characters intended as 1G Value Code as applicable by BSP of client. |
| Key |
string simple type |
|
Optional |
|
Will use key to map continuity remark to a particular segment |
| 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 |
|
|
| FileFinishingInfo |
element |
|
|
|
Misc Data required for File Finishing. This
data is transient and not saved in database. |
| ShopInformation |
element |
|
|
|
Shopping Information required for File
Finishing |
| CabinSelected |
string simple type |
|
Optional |
|
|
| CabinShopped |
string simple type |
|
Optional |
|
|
| LowestFareOffered |
string simple type |
|
Optional |
|
|
| SearchRequest |
element |
|
|
|
Search parameters that were used in LFS
request |
| ClassOfService |
string simple type |
|
Optional |
|
|
| DepartureTime |
string simple type |
|
Optional |
|
Date and Time at which this entity
departs. This does not include Time Zone information since it
can be derived from origin location |
| Destination |
string simple type |
|
Optional |
|
|
| Origin |
string simple type |
|
Optional |
|
|
| FlightsOffered |
element |
|
|
|
Flights with lowest logical airfare
returned as response to LFS request |
| Carrier |
string simple type |
|
Optional |
|
|
| ClassOfService |
string simple type |
|
Optional |
|
|
| Connection |
boolean simple type |
|
Optional |
false |
|
| DepartureTime |
string simple type |
|
Optional |
|
Date and Time at which this entity
departs. This does not include Time Zone information since it
can be derived from origin location |
| Destination |
string simple type |
|
Optional |
|
|
| FlightNumber |
string simple type |
|
Optional |
|
|
| Origin |
string simple type |
|
Optional |
|
|
| StopOver |
boolean simple type |
|
Optional |
false |
|
| TravelOrder |
long simple type |
|
Optional |
|
|
| PolicyInformation |
element |
|
|
|
Policy Information required for File
Finishing |
| Name |
anySimpleType simple type |
|
Optional |
|
Policy Name |
| OutOfPolicy |
boolean simple type |
|
Optional |
|
In Policy / Out of Policy Indicator |
| SegmentRef |
string simple type |
|
Optional |
|
|
| Type |
string simple type |
Air , Vehicle , Hotel , Rail , Ticketing |
Required |
|
Policy Type - Air, Hotel, Car, Rail,
Ticketing |
| ReasonCode |
element |
|
|
|
Reason Code |
| OutOfPolicy |
string simple type |
|
|
|
Reason Code - Out of Policy |
| PurposeOfTrip |
string simple type |
|
|
|
Reason Code -Purpose of Trip |
| Remark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
| Key |
string simple type |
|
Optional |
|
|
| AccountInformation |
element |
|
|
|
Account Information required for File
Finishing |
| AccountName |
string simple type |
|
Optional |
|
|
| 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 |
|
|
| 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 |
|
|
| AgencyInformation |
element |
|
|
|
Agency Information required for File
Finishing |
| Address |
typeStructuredAddress complex type |
|
|
|
Agency Information required for File
Finishing |
| 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 |
|
|
| 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 |
|
|
| TravelerInformation |
element |
|
|
|
Traveler Information required for File
Finishing |
| BookingTravelerRef |
string simple type |
|
Required |
|
A reference to a passenger. |
| HomeAirport |
string simple type |
|
Optional |
|
|
| VisaExpirationDate |
date simple type |
|
Optional |
|
|
| EmergencyContact |
element |
|
|
|
|
| Name |
anySimpleType simple type |
|
Optional |
|
Name of Emergency Contact Person |
| Relationship |
anySimpleType simple type |
|
Optional |
|
Relationship between Traveler and
Emergency Contact Person |
| 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 |
|
|
| CustomProfileInformation |
element |
|
|
|
Custom Profile Field Data required for File
Finishing |
| 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 |
|
|
| 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. |
| EmailNotification |
element |
|
|
|
Send Email Notification to the emails specified in Booking Traveler. Supported Provider : 1G/1V |
| Recipients |
string simple type |
All , Default , Specific |
Required |
|
Indicates the recipients of the mail addresses for which the user requires the system to send the itinerary.List of Possible Values:
All = Send Email to All addresses
Default = Send Email to Primary Booking Traveler
Specific = Send Email to specific address Referred in EmailRef. |
| EmailRef |
typeRef simple type |
|
|
|
Reference to Booking Traveler Email. |
| QueuePlace |
element |
|
|
|
Allow queue placement of a PNR at the time of booking to be used for Providers 1G,1V and 1P. |
| PseudoCityCode |
typePCC simple type |
|
|
|
Pseudo City Code |
| QueueSelector |
element |
|
|
|
Identifies the Queue with Queue Number , Category and Date Range. |
| Category |
string simple type |
|
Optional |
|
Queue Category Number. 2 Character Alpha or Numeric Number.Either Alpha or Numeric Number is allowed.If using for Sabre is mandatory and is Prefatory Instruction Code value of 0-999. |
| DateRange |
string simple type |
|
Optional |
|
Date range number where the PNR should be queued. Possible values are 1,2,1-4 etc. |
| Queue |
string simple type |
|
Optional |
|
Queue Number . Possible values are 01, AA , A1 etc. |
| 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 |
|
|
| 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. |
| 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. |
| 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. |
| Remark |
element |
|
|
|
A textual remark container to hold any printable text. (max 512 chars) |
| Key |
string simple type |
|
Optional |
|
|
| 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. |