XML Location Resolution Request Specification


XML FieldDependenciesDescription
CommandList The surrounding tag
-ResolveLocation The command name
--LoginId The login id. See the 'Logins' section within the XML integration guide.
--Name The textual name of the location to be resolved. This is designed to handle anything that a typical end user might enter.
--RequiredFieldList Defines which data is required to be returned for each location possibility. Contains 1 or more 'RequiredField' elements. Only data fields that are definitely needed should be requested, to reduce load and bandwidth usage. Under normal circumstances, only 'RecommendedDisplayText' and 'Id' are needed, but for more advanced purposes, any of the other data may be useful. For example coordinates would enable a custom map to be drawn displaying all the possible locations visually. The significance of each field is described in the LocationResolutionResponse specification.
---RequiredField Defines a data field that is required to be returned for each location possibility. Possible values:
  • RecommendedDisplayText
  • Id
  • Type
  • Code
  • Name
  • Admin2
  • Admin1
  • Country
  • Admin2ShouldBeDisplayed
  • Coordinate
  • AirportCity