Differences

This shows you the differences between two versions of the page.

--- thinkgeo_cloud_geocoding [2019/07/17 05:42]
kevinwan [Geocode Address]
+++ thinkgeo_cloud_geocoding [2019/09/23 16:06] (current)
brianr
@@ Line 22: / Line 22: @@
   * <html><span class="api-parameter"><span class="api-parameter-name">locationType:</span> <em>Optional.</em> Specifies what types of locations will be considered a match. Possible values are Address, Street, State, City, County, Zipcode. Defaults to Default.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">fuzzyMatch:</span> <em>Optional.</em> Specifies whether to attempt approximate, as well as exact, matching when performing geocodes. Defaults to false.</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">countries:</span> <em>Optional.</em> Limit the results only within the countries specified here. It can be one or more “ISO Language Name” mentioned  ISO 639-1 language code.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">bbox:</span> <em>Optional.</em> Limits the results to only those contained within the supplied bounding box.  The valid format is "minX,minY,maxX,maxY". Defaults to null, as the global.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">maxResults:</span> <em>Optional.</em> The maximum number of possible matches to return, if multiple candidates are found. Defaults to 10.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">verboseResults:</span> <em>Optional.</em> Indicates whether the results should be verbose or not. When false, the results will have fewer properties. Defaults to false.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">autocomplete:</span> <em>Optional.</em> Specifies whether to return the autocomplete results or not. When autocomplete is enabled, all results will be started with the query string, rather than just the response includes it extractly. Defaults to false.</span></html>
-  * <html><span class="api-parameter"><span class="api-parameter-name">countries:</span> <em>Optional.</em> Specifies what language would like to be returned in the response. If no specified language, take English instead.  The possible values can be any “Language Code” mentioned at ISO 639-1 language code.</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">language:</span> <em>Optional.</em> Specifies what language would like to be returned in the response. If no specified language, take English instead.  The possible values can be any “Language Code” mentioned at ISO 639-1 language code.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">srid:</span> <em>Optional.</em> The SRID (coordinate system ID) in which to express the result. Mutually exclusive from the Proj4String parameter.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">proj4String:</span> <em>Optional.</em> The Proj4 projection string (coordinate system) in which to express the result. Mutually exclusive from the Srid parameter. Defaults to "+proj=longlat +datum=WGS84 +no_defs".</span></html>
@@ Line 47: / Line 48: @@
     "locationType": "string", // Optional. Specifies what types of locations will be considered a match. Possible values are Address, Street, State, City, County, Postcode, Zipcode. Defaults to all types.
     "fuzzyMatch": bool, // Optional. Specifies whether to attempt approximate, as well as exact, matching when performing geocodes. Defaults to false.
+    "countries": "string" // Optional. Limit the results only within the countries specified here. It can be one or more “ISO Language Name” mentioned ISO 639-1 language code.
+    "bbox": "string", // Optional. Limits the results to only those contained within the supplied bounding box. The valid format is "minX,minY,maxX,maxY". Defaults to null, as the global.
     "maxResults": int, // Optional. The maximum number of possible matches to return, if multiple candidates are found. Defaults to 20.
     "verboseResults": bool, // Optional. Indicates whether the results should be verbose or not. When false, the results will have fewer properties. Defaults to false.
+    "language": "string", // Optional. Specifies what language would like to be returned in the response. If no specified language, take English instead. The possible values can be any “Language Code” mentioned at ISO 639-1 language code.
     "srid": int, // Optional. The SRID (coordinate system ID) in which to express the result. Mutually exclusive from the Proj4String parameter.
     "proj4String": "string" // Optional. The Proj4 projection string (coordinate system) in which to express the result. Mutually exclusive from the Srid parameter. Defaults to "+proj=longlat +datum=WGS84 +no_defs".
@@ Line 56: / Line 60: @@
 Each item in the batch can locally override a parameter specified on the request URL.
+//**Example Request**//
+Here is an example geocode batch request containing three items.  For each item, we want verbose results and a maximum of one result, so we can place these options in the request URL so they apply to all items in the batch.  Notice that we can search for place names ("Cedar Point", a theme park in Ohio) as well as addresses.
+<code html>
+HTTP POST
+https://cloud.thinkgeo.com/api/v1/location/geocode/multi?maxResults=1&verboseResults=true
+</code>
+<code javascript>
+[
+  {
+    "searchText": "200 Epcot Center Drive, Bay Lake, FL"
+  },
+  {
+    "searchText": "1313 South Harbor Blvd, Anaheim, CA"
+  },
+  {
+    "searchText": "Cedar Point"
+  }
+]
+</code>
 //**URL Parameters**//
   * <html><span class="api-parameter"><span class="api-parameter-name">locationType:</span> <em>Optional.</em> Specifies what types of locations will be considered a match. Possible values are Address, Street, State, City, County, Zipcode. Defaults to Default.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">fuzzyMatch:</span> <em>Optional.</em> Specifies whether to attempt approximate, as well as exact, matching when performing geocodes. Defaults to false.</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">countries:</span> <em>Optional.</em> Limit the results only within the countries specified here. It can be one or more “ISO Language Name” mentioned ISO 639-1 language code.</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">bbox:</span> <em>Optional.</em> Limits the results to only those contained within the supplied bounding box. The valid format is "minX,minY,maxX,maxY". Defaults to null, as the global.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">maxResults:</span> <em>Optional.</em> The maximum number of possible matches to return, if multiple candidates are found. Defaults to 10.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">verboseResults:</span> <em>Optional.</em> Indicates whether the results should be verbose or not. When false, the results will have fewer properties. Defaults to false.</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">language:</span> <em>Optional.</em> Specifies what language would like to be returned in the response. If no specified language, take English instead. The possible values can be any “Language Code” mentioned at ISO 639-1 language code.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">srid:</span> <em>Optional.</em> The SRID (coordinate system ID) in which to express the result. Mutually exclusive from the Proj4String parameter.</span></html>
   * <html><span class="api-parameter"><span class="api-parameter-name">proj4String:</span> <em>Optional.</em> The Proj4 projection string (coordinate system) in which to express the result. Mutually exclusive from the Srid parameter. Defaults to "+proj=longlat +datum=WGS84 +no_defs".</span></html>
 Visit [[https://cloud.thinkgeo.com/help/#/Geocoding/GeocodeAddressesBatchV1|GeocodeAddressesBatch]] and click "Try It Out" to explore this API online.

User Tools

Site Tools

Differences

Page Tools