Skip to content

Geography Data

Chris Moran edited this page Jun 29, 2016 · 4 revisions

Geography Data is the basis of all location information. A location is broken down as follows:

Country --> Region --> City (Locality) --> Address

Abstract Name Type Size Mandatory/Optional Notes
Country Code String 5 Mandatory ISO Specification
Country Name String 255 Mandatory Use UTF-8 Characters as required, but default data to English representation
Has Divisions Boolean N/A Mandatory Defaults to "false"
Division Name String 255 Optional Only required if Has Divisions is true
Region Name String 255 Optional Required if a Division is created
City Name String 255 Mandatory
Location Name String 255 Mandatory Gives the location a "friendly" name
Address 1 String 255 Mandatory Line 1 of Address Data
Address 2 String 255 Mandatory Line 2 of Address Data
Address 3 String 255 Mandatory Line 3 of Address Data
Address 4 String 255 Mandatory Line 4 of Address Data

Note that the API functions could return the Address n fields as a single delimited value. It is broken up internally to allow for targeted searching

Clone this wiki locally