Encode request message

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.

NodeDescriptionValuesOccursExample
<EncodeRQ>
Encode request root element1
@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
@NumberOfAlternates
Maximum number of options requested. The service will collect options until this number is reached or the provider returns no more options (whatever happens first). The resulting set of options will be returned to the client.
CAUTION: Depending on the value this can be a time consuming transaction!

Values are:
Either a positive integer value identifying the number of requested options or 'ALL' to retrieve all of them.

Default is 10.
0..1
@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.
<CityCodeRequest>
Request structure to encode city names to backend specific code(s). 1
@CityName
Name of the city to encode to backend specific city code. 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)
</CityCodeRequest>
<AddressRequest>
1
@Street
1
@CityName
1
</AddressRequest>
<POICodeRequest>
1
@POIName
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
@CountryCode
Country, where city is located as two letter code defined by ISO-3166-1 (ALPHA2).
0..1 DE, US.
</POICodeRequest>
</EncodeRQ>

Legend

ColumnDescription
NodeName 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.
DescriptionDescription of meaning and usage of the node.
ValuesList of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema.
OccursMinimum 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.
ExampleExample value for the node.

XML Schema documentation generated with XX/1 server