You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Subnational1Code List and Search Web Service API

URL

description

notes

data/subnational2/list?locale=<locale to use for names>

Return entire list of "state" names

 

data/subnational2/list?countryCode=<2-letter ISO country code>&locale=<locale to use for names>

Return list of "state" names found in the given country

 

data/subnational2/find?match=<string to match>&locale=<locale used in match string>

Return list of "state" names that match

Can wildcards be used in the match string?

parameter

required

default

value options

description

match

yes, for /find

n/a

 

String to match against "county" names. What kind of wildcards can be used?

locale

no

en_US

Java standard locale codes

locale in which to perform matching, and in which to provide names in response (when possible)

countryCode

no

n/a


2-letter ISO country code

format

no

csv

  • csv
  • xml

format to use for response

CSV Result Format

<country code>, <subnational1 code>, <name associated with subnational1 code>
<country code>, <subnational1 code>, <name associated with subnational1 code
<country code>, <subnational1 code>, <name associated with subnational1 code>

XML Result Format
<response>
  <header>
    <locale country="US" language="en"/>
    <timestamp>2008-02-21T12:37:32.546-05:00</timestamp>
    <criteria>
      <property name="match" value="seomthing"/>
      <property name="countryCode" value="seomthing"/>
    </criteria>
    <comment>
    </comment>
  </header>
  <result>
    <location countryCode="" subnational1Code="">name of the subnational1 region </location>
    <location countryCode="" subnational1Code="">name of the subnational1 region </location>
    <location countryCode="" subnational1Code="">name of the subnational1 region </location>
    <location countryCode="" subnational1Code="">name of the subnational1 region </location>
  </result>
</response>
  • No labels