Differences

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

--- thinkgeo_cloud_geocoding [2019/03/08 06:00]
tgwikiupdate
+++ thinkgeo_cloud_geocoding [2019/09/23 16:06] (current)
brianr
@@ Line 6: / Line 6: @@
 * //**Try it Online**:// All the ThinkGeo Cloud RESTful APIs can be tested online following the instructions below:
   *  Get a ThinkGeo Cloud Client Key. Check out [[https://wiki.thinkgeo.com/wiki/thinkgeo_cloud_client_keys_guideline|ThinkGeo Cloud Client Keys Guideline]] see how to apply one. It's free for 60 days.
-  *  //** **// Authorize with the key at the top of [[https://cloud.thinkgeo.com/help/|ThinkGeo Cloud APIs]] and you are then free to play with all the APIs online.
+   * Visit our [[https://cloud.thinkgeo.com/help/|ThinkGeo Cloud API Explorer]], click the "Authorize" button at the top and enter your client credentials. You are then free to play with all the APIs online.
 //**ThinkGeo Cloud Geocoding provides the following 2 Restful APIs**://
@@ Line 17: / Line 17: @@
 https://cloud.thinkgeo.com/api/v1/location/geocode/{searchText}
 </code>
 //**URL Parameters**//
-  * //**searchText**//: The address to be geocoded.
+  * <html><span class="api-parameter"><span class="api-parameter-name">searchText:</span> The address to be geocoded.</span></html>
-  * //**locationType**//: __Optional__. Specifies what types of locations will be considered a match. Possible values are Address, Street, State, City, County, Zipcode, Country. Defaults to Default.
+  * <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>
-  * //**fuzzyMatch**//: __Optional__. Specifies whether to attempt approximate, as well as exact, matching when performing geocodes. Defaults to false.
+  * <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>
-  * //**maxResults**//: __Optional__. The maximum number of possible matches to return, if multiple candidates are found. Defaults to 10.
+  * <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>
-  * //**verboseResults**//: __Optional__. Indicates whether the results should be verbose or not. When false, the results will have fewer properties. Defaults to false.
+  * <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>
-  * //**srid**//: __Optional__. The SRID (coordinate system ID) in which to express the result. Mutually exclusive from the Proj4String parameter.
+  * <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>
-  * //**proj4String**//: __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".
+  * <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">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/GeocodeAddressV1|GeocodeAddress]] and click "Try It Out" to explore this API online.
@@ Line 35: / Line 40: @@
 https://cloud.thinkgeo.com/api/v1/location/geocode/multi
 </code>
-//**URL Parameters**//
+//**POST Body (Content-Type: application/json)**//
 <code javascript>
-/* POST parameters, if a parameter specified in both POST and GET, the value from POST parameter will be applied. */
 [
   {
     "searchText": "string", // Free-form text representing the address or location to be geocoded.
-    "locationType": "string", // Optional. Specifies what types of locations will be considered a match. Possible values are Address, Street, State, City, County, Postcode, Zipcode, Country. Defaults to all types.
+    "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".
   }
-]</code>
+]
-  * //**locationType**//: __Optional__. Specifies what types of locations will be considered a match. Possible values are Address, Street, State, City, County, Zipcode, Country. Defaults to Default.
+</code>
-  * //**fuzzyMatch**//: __Optional__. Specifies whether to attempt approximate, as well as exact, matching when performing geocodes. Defaults to false.
-  * //**maxResults**//: __Optional__. The maximum number of possible matches to return, if multiple candidates are found. Defaults to 10.
+Each item in the batch can locally override a parameter specified on the request URL.
-  * //**verboseResults**//: __Optional__. Indicates whether the results should be verbose or not. When false, the results will have fewer properties. Defaults to false.
-  * //**srid**//: __Optional__. The SRID (coordinate system ID) in which to express the result. Mutually exclusive from the Proj4String parameter.
+//**Example Request**//
-  * //**proj4String**//: __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".
+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.
@@ Line 64: / Line 105: @@
 ==== SDK for .NET ====
-The SDK for .NET enables developers to build .NET applications that use the ThinkGeo Cloud services. The NuGet package can be found at [[https://www.nuget.org/packages/ThinkGeo.Cloud.Client|ThinkGeo.Cloud.Client]] or you can install this package with PM by running the command: ''Install-Package ThinkGeo.Cloud.Client -Version VERSION_TO_BE_INSTALLED'', here is the complete [[thinkgeo_cloud_.net_client_apis|API List]].  Also you can check out [[https://github.com/ThinkGeo/ThinkGeoCloudGeocodingSample-ForWpf|ThinkGeoCloudGeocodingSample-ForWpf]] for a a jump-start.
+Our .NET SDK //ThinkGeo Cloud Client// makes it easy to consume all of the ThinkGeo Cloud services in your applications. It's available on [[https://www.nuget.org/packages/ThinkGeo.Cloud.Client|NuGet]].  IntelliSense hints will help you get started, and you can also refer to the [[thinkgeo_cloud_.net_client_apis|ThinkGeo Cloud Client API list]] for details.
+At the NuGet Package Manager terminal, you can install this package by running the command: ''Install-Package ThinkGeo.Cloud.Client -Version VERSION_TO_BE_INSTALLED''.  You can also check out ThinkGeo on GitHub for [[https://github.com/ThinkGeo?utf8=%E2%9C%93&q=cloud&type=&language=|samples utilizing the ThinkGeo Cloud Client]].
 === API Documentation ===
@@ Line 72: / Line 115: @@
 ==== SDK for JavaScript ====
 The SDK for JavaScript enables developers to directly access ThinkGeo Cloud services from JavaScript code running in brower. This SDK can be found at [[https://www.npmjs.com/package/thinkgeocloudclient-js|thinkgeocloudclient-js]]. The [[https://cloudclientsamples.thinkgeo.com/#Geocoding|Geocoding]] sample shows how to work with this SDK.
+===== Samples =====
+Online Sample:
+  * [[https://samples.thinkgeo.com/cloud/#FindanAddressintheUS|ThinkGeo Cloud Geocoding Online Sample]]
+Desktop Sample:
+  * [[https://github.com/ThinkGeo/ThinkGeoCloudReverseGeocodingSample-ForWpf|ThinkGeo Cloud Reverse Geocoding Sample for Wpf]] for [[map_suite_desktop_for_wpf|Map Suite Desktop For WPF]]
+Web Sample:
+<code csharp>
+Coming soon
+</code>
+Mobile Sample:
+<code csharp>
+Coming soon
+</code>
 ===== Related Links =====
@@ Line 81: / Line 148: @@
   * [[thinkgeo_cloud_projection|ThinkGeo Cloud Projection]]
   * [[thinkgeo_cloud_colors|ThinkGeo Cloud Colors]]
+  * [[thinkgeo_cloud_timezone|ThinkGeo Cloud Time Zones]]

User Tools

Site Tools

Differences

Page Tools