Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.
| Node | Description | Values | Occurs | Example |
|---|---|---|---|---|
<EncodeRS> | Encode response root element | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. This code specifies the requested language for text content. Default value is 'en'. | 0..1 | ||
<InfoGroup> | Error and information group | 0..1 | ||
<ForInfo> | Information group | 0..N | ||
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@Code | A code to uniquely identify a specific type of ForInfo message. Currently not returned for most ForInfo messages. | 0..1 | I00001 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. | 0..1 | de | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</ForInfo> | ||||
<Error> | Error group | 0..N | ||
@ErrorType | Type of error. | 1 | Air | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
</Error> | ||||
<BackOffice> | Generic back office response container. Serves as a placeholder for any context specific content. | 0..1 | ||
</BackOffice> | ||||
</InfoGroup> | ||||
<CodeList> | Backend specific list of codes matching the requested string. Note: There can be CityCodes, POICodes, AddressCodes in one result. (CodeList now contains a sequence, no longer a choice) | 0..1 | ||
<CityCode> | Backend specific city code for requested city name. | 0..N | ||
@CityName | Corresponding city name - may differ from request string if backend system supports similar name search. | 1 | ||
@CountryCode | Country, where city is located as two letter code defined by ISO-3166-1 (ALPHA2). | 0..1 | DE, US. | |
@CountrySubdivisionCode | Subdivision, where city is located. Second part of the ISO3166-2 code. | 0..1 | NY ... state New York (US) BY ... Bavaria (DE) CRF ... Cardiff (GB) 37 ... Shandong (CN) | |
@Latitude | Degree of latitude. Values range from -90 to +90 Positive values refer to latitudes north, negative values to latitudes south of the equator. | [-90] to [90] | 0..1 | -49.9856 |
@Longitude | Degree of longitude. Values range from -180 to +180 Positive values refer to longitudes east, negative values to longitudes west of the zero (Greenwich) meridian. | [-180] to [180] | 0..1 | -123.87611 |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
</CityCode> | ||||
<POICode> | Backend specific point of interest code for requested point of interest name. | 0..N | ||
@POIName | Name of point of interest. | 1 | ||
@POIType | OTA REF code (Reference Point Category Code) or some ( deprecated ! ) string code. Deprecated values: AIR CULTURE GASTRONOMY PARK HOTEL SHOPPING PARKING PUBLICFACILITIY RENTALCAR SPORT TOURISM HOSTEL | 0..1 | 34 | |
@CityName | City name. | 0..1 | ||
@CountryCode | Country, where POI is located as two letter code defined by ISO-3166-1 (ALPHA2). | 0..1 | DE, US. | |
@Latitude | Degree of latitude. Values range from -90 to +90 Positive values refer to latitudes north, negative values to latitudes south of the equator. | [-90] to [90] | 0..1 | -49.9856 |
@Longitude | Degree of longitude. Values range from -180 to +180 Positive values refer to longitudes east, negative values to longitudes west of the zero (Greenwich) meridian. | [-180] to [180] | 0..1 | -123.87611 |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
</POICode> | ||||
<AddressCode> | Backend specific address code for requested address name. | 0..N | ||
@AddressName | Address name. | 1 | ||
@Latitude | Degree of latitude. Values range from -90 to +90 Positive values refer to latitudes north, negative values to latitudes south of the equator. | [-90] to [90] | 0..1 | -49.9856 |
@Longitude | Degree of longitude. Values range from -180 to +180 Positive values refer to longitudes east, negative values to longitudes west of the zero (Greenwich) meridian. | [-180] to [180] | 0..1 | -123.87611 |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
</AddressCode> | ||||
<Station> | A rail or other public transportation station returned in response to a StationCodeRequest. | 0..N | ||
@StationCode | The station code. | 1 | GBZEP | |
@StationName | The station name. | 1 | London Victoria | |
@StationType | The station type for this station. Values: - Station: Station code refers to a single station. - Area: Station code refers to all stations in a specific area. | [Station] [Area] | 1 | Station |
@CityName | The name of the city the station lies in. | 0..1 | London | |
@CountryCode | Country code of the country the station is located in as two letter code defined by ISO-3166-1 (ALPHA2). | 0..1 | GB | |
@CountrySubdivisionCode | Subdivision, where city is located. Second part of the ISO3166-2 code. | 0..1 | NY ... state New York (US) BY ... Bavaria (DE) CRF ... Cardiff (GB) 37 ... Shandong (CN) | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
<Vendor> | A specific vendor which serves this station. | 0..N | ||
@VendorCode | The vendor code of the vendor. | 1 | ATOC | |
</Vendor> | ||||
</Station> | ||||
</CodeList> | ||||
</EncodeRS> |
| Column | Description |
|---|---|
| Node | Name of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath. |
| Description | Description of meaning and usage of the node. |
| Values | List of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema. |
| Occurs | Minimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples: 0..3 Node is optional and may occur up to 3 times. 1..N Node must occur at least one (mandatory) and may occur any number of times. 2 Node must occur exactly twice. |
| Example | Example value for the node. |
XML Schema documentation generated with XX/1 server