|
Whitebeam Template Reference Documentation
|
rb.city.searchFlags
Search for specific entries in the city database
Elements
The rb.city.searchFlags struct has 11 elements:
Name | Type/Value | Range/Length | Description | ID | number | | Optional. Return a speicific city record, identified by it's unique ID | country | string | | Optional. The country in which to search. This is case insensitive and wild-cards are allowed. | city | string | | Optional. Optional city, which can also include wild cards | longitude | number | | Optional. Longitude represented by this point. | latitude | number | | Optional. Latitude represented by this point. | originCountry | string | | Optional. If specified then the 'longitude' and 'latitude' parameters for distance calculations are taken from the location of the specified countries capital site. For example specifying this as 'GB' will calculate distances from London. | distance | number | | Optional. When longitude and latitude are specified this optional parameter restricts the search to a radius of "distance" miles from that location. | sortBy | string | | Optional, default = name Sort is by name. If a longitude/latitude pair are specified in the search request then sort by distance from that location. | maxRows | number | | Optional. Maximum number of rows the application expects to use | firstIndex | number | | Optional, default = 0 Index of the first row to return | allData | number | | Optional, default = 0 0: return country, city, division, longitude, latitude and distance; 1: also return countryName |
|
|
(loadtime : 117ms) |