ReferenceDataRetrieveReq |
element |
|
|
|
Request to retrieve code, name and description for a specific reference data type. |
| 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. |
| TypeCode |
string simple type |
|
Required |
|
The code of the reference data type. Valid values are 'PaymentType', 'PaymentFormatType', 'MerchandisingOfferType', 'HotelTaxType', 'HotelAmenities','Airport','City','Country','CityAirport','BusinessType','Currency','PosChannel','StateProvince','SupplierType','RoleCategoryType','ResourceCategoryType','PaymentType','EmailType','HotelRateCategory','FulfillmentType','HotelRoomViewType', 'HotelMealPlans' , 'GeoPoliticalAreaType', 'AirAndRailMiscType', 'AirAndRailSupplierType', 'HotelMiscType' , 'HotelSupplierType' , 'VehicleMiscType' , 'VehicleSupplierType' , 'AccountingReferenceType' , 'TRMLocation' , 'Title' , 'PassengerTypeCode' , 'Gender' , 'PostalAddressType' , 'AccountingRemarkType' , 'VehicleSpecialEquipment', 'ReferencePointSearch', 'RailStationLocation', 'RailAccommodation', and 'RailDiscountLoyalty'. |
| 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. |
| ReferenceDataSearchModifiers |
element |
|
|
|
Modifiers to narrow the reference data search results. |
| MaxResults |
integer simple type |
|
Optional |
20 |
Used to limit the number of results returned. |
| ProviderCode |
string simple type |
|
Optional |
|
Provider Specific restriction(e.g. 1G, 1P etc) . |
| StartFromResult |
integer simple type |
|
Optional |
0 |
Used to browse beyond the maximum number of
results specified with the MaxResults parameter.
Acts as an offset to skip the specified number
of items from the begining of the result set. |
| RailStationLocationModifiers |
element |
|
|
|
Request object used to request specific rail station
locations. |
| Active |
boolean simple type |
|
Optional |
true |
The value “false” will return stations that are no
longer active but remain on the table because existing bookings may
reference them. The default is “true” which returns only active
locations. |
| CountryCode |
string simple type |
|
Optional |
|
2 character country code such as FR. |
| Description |
string simple type |
|
Optional |
|
A city name or station name such as Paris or Paris
Nord. |
| Distributor |
string simple type |
|
Optional |
|
2 character Rail distributor code such as TL or
2C. |
| RailLocation |
element |
|
|
|
RCH specific location code (a.k.a UCodes) which uniquely identifies a train station. |
| Code |
string simple type |
|
Required |
|
|
| RequestReferenceDataItem |
element |
|
|
|
Limits the responses to the requested subcategories for a specific Reference Data Type, Currently supported only for @TypeCode="HotelAmenities". |
| RequestAmenity |
element |
|
|
|
Requested decoded values only for the specified Hotel Amenity codes. |
| Type |
string simple type |
|
Required |
|
Limits to the response to the requested amenity type. Can be a general type: “HA” (Hotel Property Amenity) or “RA” (Room Amenity). Or, a specific type, for example: “TR” (Transportation) or “BT” (Bed Type). If no type is specified, all amenity types are returned. |