VehicleCreateReservationReq (UniversalRecordReqRsp.xsd)

Name Type Enumeration Values R/O Default Description
VehicleCreateReservationReq element
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
ReturnAmenities boolean simple type Optional false When set to true, Amenities information will be returned in the response.
ReturnSponsoredFlight boolean simple type Optional When set to true, Sponsored flight information will be returned in the response.
SponsoredFltTrnxId string simple type Optional Identifier for Sponsored Flight transaction information.
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.
MandatoryRateMatch boolean simple type Optional false If true, vehicle will not be booked if there is a rate discrepancy. Default is false. Supported providers: 1P.
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
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.
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
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
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.
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
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.
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,Galileo
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 or other Axess users 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,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.
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
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
DropDistance double simple type Optional
DropLatitude double simple type Optional
DropLongitude double simple type Optional
DropUnit string simple type MI , KM Optional MI
Key string simple type Optional
PickUpDistance double simple type Optional
PickUpLatitude double simple type Optional
PickUpLongitude double simple type Optional
PickUpUnit string simple type MI , KM Optional MI
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 , Military , FixedBaseOperations 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 , Military , FixedBaseOperations Optional Defaults to Pickup Location. Same options as Pickup Location.
VendorLocation element Specific vendor rental locations. Applicable only for VehicleSearchAvailability.
AddressInfoRef string simple type Optional
Latitude double simple type Optional Latitude point of the city in PickUp or Drop
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 , Military , FixedBaseOperations Optional Rental counter location such as Terminal, CityCenterDowntown,
Longitude double simple type Optional Longitude point of the city in PickUp or Drop
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
BusinessHours string simple type Operational hours of the vendor.
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
BagCount string simple type Optional Indicates count of bags that a vehicle could hold.
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
MakeModel string simple type Optional Indicates the make/model of the vehicle.
PassengerCount string simple type Optional Indicates count of passenger that a vehicle could occupy.
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.
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
SpecialEquipment element
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.
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.
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
HotelRateDetailRef string simple type Optional Reference for the Hotel Rate Detail. Used for Hotel Booking only. The value is arbitrary.
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.
ReservationName element Container to represent reservation name as appears in GDS booking
HotelRateDetailRef string simple type Optional Reference for the Hotel Rate Detail. Used for Hotel Booking only. The value is arbitrary.
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
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.