Differences

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

--- thinkgeo_cloud_reverse_geocoding [2019/03/04 17:51]
sacha [ThinkGeo Cloud Reverse Geocoding]
+++ thinkgeo_cloud_reverse_geocoding [2019/03/31 16:39] (current)
brianr [Related Links]
@@ Line 5: / Line 5: @@
 * //**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 ReverseGeocoding provides the following Restful APIs**.//
+==== Get Reverse Geocoding For Point ====
+Get reverse geocoding for point.
 <code html>
-<!-- Get reverse geocoding for point -->
 HTTP GET
 https://cloud.thinkgeo.com/api/v1/location/reverse-geocode/{pointY},{pointX}
 </code>
-//**Parameters**//
+//**URL Parameters**//
-  * //**pointY**//: The Y coordinate of the point.
+  * <html><span class="api-parameter"><span class="api-parameter-name">pointY:</span> The Y coordinate of the point.</span></html>
-  * //**pointX**//: The X coordinate of the point.
+  * <html><span class="api-parameter"><span class="api-parameter-name">pointX:</span> The X coordinate of the point.</span></html>
-  * //**srid**//: __Optional__. The SRID (coordinate system) in which to express the result. Defaults to 4326.
+  * <html><span class="api-parameter"><span class="api-parameter-name">srid:</span> <em>Optional.</em> The SRID (coordinate system) in which to express the result. Defaults to 4326.</span></html>
-  * //**proj4String**//: __Optional__. The Proj4String (coordinate system) in which to express the result.
+  * <html><span class="api-parameter"><span class="api-parameter-name">proj4String:</span> <em>Optional.</em> The Proj4String (coordinate system) in which to express the result.</span></html>
-  * //**lang**//: __Optional__. The language in which to express the result.
+  * <html><span class="api-parameter"><span class="api-parameter-name">lang:</span> <em>Optional.</em> The language in which to express the result.</span></html>
-  * //**searchRadius**//: __Optional__. The maximun radius around the input point to search for places. Defaults to 200.
+  * <html><span class="api-parameter"><span class="api-parameter-name">searchRadius:</span> <em>Optional.</em> The maximun radius around the input point to search for places. Defaults to 200.</span></html>
-  * //**searchRadiusUnit**//: __Optional__. The unit of measure in which the SearchRadius is expressed. Defaults to "Meter".
+  * <html><span class="api-parameter"><span class="api-parameter-name">searchRadiusUnit:</span> <em>Optional.</em> The unit of measure in which the SearchRadius is expressed. Defaults to "Meter".</span></html>
-  * //**maxResults**//: __Optional__. The maximum number of results to return. Defaults to 20.
+  * <html><span class="api-parameter"><span class="api-parameter-name">maxResults:</span> <em>Optional.</em> The maximum number of results to return. Defaults to 20.</span></html>
-  * //**locationCategories**//: __Optional__. The categories of locations to include in the result set. The default value is "Common".
+  * <html><span class="api-parameter"><span class="api-parameter-name">locationCategories:</span> <em>Optional.</em> The categories of locations to include in the result set. The default value is "Common".</span></html>
-  * //**locationTypes**//: __Optional__. Filters the resulting locations by type. Multiple types should be separated by a comma. Defaults to no filter.
+  * <html><span class="api-parameter"><span class="api-parameter-name">locationTypes:</span> <em>Optional.</em> Filters the resulting locations by type. Multiple types should be separated by a comma. Defaults to no filter.</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">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>
-  * //**distanceFromQueryFeatureUnit**//: __Optional__. The unit of measure in which the distance is expressed. Defaults to "Meter".
+  * <html><span class="api-parameter"><span class="api-parameter-name">distanceFromQueryFeatureUnit:</span> <em>Optional.</em> The unit of measure in which the distance is expressed. Defaults to "Meter".</span></html>
-  *  Hit //**Try it Out**// button below [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByPointV1|GetResverseGecodingForPoint]] to test it online.
+Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByPointV1|GetReverseGeocodingForPoint]] and click "Try It Out" to explore this API online.
+==== Reverse Geocode By Points (Batch Request) ====
+Get reverse geocoding for points.
 <code html>
-<!-- Get reverse geocoding for points -->
 HTTP POST
 https://cloud.thinkgeo.com/api/v1/location/reverse-geocode/multi
 </code>
-//**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. */
 [
   {
@@ Line 53: / Line 56: @@
   }
 ]</code>
-  * //**srid**//: __Optional__. The SRID (coordinate system) in which to express the result. Defaults to 4326.
-  * //**proj4String**//: __Optional__. The Proj4String (coordinate system) in which to express the result.
-  * //**lang**//: __Optional__. The language in which to express the result.
-  * //**searchRadius**//: __Optional__. The maximun radius around the input point to search for places. Defaults to 200.
-  * //**searchRadiusUnit**//: __Optional__. The unit of measure in which the SearchRadius is expressed. Defaults to "Meter".
-  * //**maxResults**//: __Optional__. The maximum number of results to return. Defaults to 20.
-  * //**locationCategories**//: __Optional__. The categories of locations to include in the result set. The default value is "Common".
-  * //**locationTypes**//: __Optional__. Filters the resulting locations by type. Multiple types should be separated by a comma. Defaults to no filter.
-  * //**verboseResults**//: __Optional__. Indicates whether the results should be verbose or not. When false, the results will have fewer properties. Defaults to false.
-  * //**distanceFromQueryFeatureUnit**//: __Optional__. The unit of measure in which the distance is expressed. Defaults to "Meter".
-  *  Hit //**Try it Out**// button below [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByPointsBatchV1|ReverseGeocodeByPointsBatch]] to test it online.
+Each item in the batch can locally override a parameter specified on the request URL.
+//**URL Parameters**//
+  * <html><span class="api-parameter"><span class="api-parameter-name">srid:</span> <em>Optional.</em> The SRID (coordinate system) in which to express the result. Defaults to 4326.</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">proj4String:</span> <em>Optional.</em> The Proj4String (coordinate system) in which to express the result.</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">lang:</span> <em>Optional.</em> The language in which to express the result.</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">searchRadius:</span> <em>Optional.</em> The maximun radius around the input point to search for places. Defaults to 200.</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">searchRadiusUnit:</span> <em>Optional.</em> The unit of measure in which the SearchRadius is expressed. Defaults to "Meter".</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">maxResults:</span> <em>Optional.</em> The maximum number of results to return. Defaults to 20.</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">locationCategories:</span> <em>Optional.</em> The categories of locations to include in the result set. The default value is "Common".</span></html>
+  * <html><span class="api-parameter"><span class="api-parameter-name">locationTypes:</span> <em>Optional.</em> Filters the resulting locations by type. Multiple types should be separated by a comma. Defaults to no filter.</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">distanceFromQueryFeatureUnit:</span> <em>Optional.</em> The unit of measure in which the distance is expressed. Defaults to "Meter".</span></html>
+Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByPointsBatchV1|ReverseGeocodeByPointsBatch]] and click "Try It Out" to explore this API online.
+==== Get Reverse Geocoding For Area ====
+Get reverse geocoding for area.  Returns locations found only within the polygon you specify.
 <code html>
-<!-- Get reverse geocoding for area -->
 HTTP GET
 https://cloud.thinkgeo.com/api/v1/location/reverse-geocode/area?wkt={polygon}
 </code>
-//**Parameters**//
+//**URL Parameters**//
-  * //**wkt**//: The Well Known Text (WKT) of the polygon feature to use as the search area.
+  * <html><span class="api-parameter"><span class="api-parameter-name">wkt:</span> The Well Known Text (WKT) of the polygon feature to use as the search area.</span></html>
-  * //**srid**//: __Optional__. The SRID (coordinate system) in which to express the result. Defaults to 4326.
+  * <html><span class="api-parameter"><span class="api-parameter-name">srid:</span> <em>Optional.</em> The SRID (coordinate system) in which to express the result. Defaults to 4326.</span></html>
-  * //**proj4String**//: __Optional__. The Proj4String (coordinate system) in which to express the result.
+  * <html><span class="api-parameter"><span class="api-parameter-name">proj4String:</span> <em>Optional.</em> The Proj4String (coordinate system) in which to express the result.</span></html>
-  * //**lang**//: __Optional__. The language in which to express the result.
+  * <html><span class="api-parameter"><span class="api-parameter-name">lang:</span> <em>Optional.</em> The language in which to express the result.</span></html>
-  * //**searchRadius**//: __Optional__. The maximun radius around the input point to search for places. Defaults to 200.
+  * <html><span class="api-parameter"><span class="api-parameter-name">searchRadius:</span> <em>Optional.</em> The maximun radius around the input point to search for places. Defaults to 200.</span></html>
-  * //**searchRadiusUnit**//: __Optional__. The unit of measure in which the SearchRadius is expressed. Defaults to "Meter".
+  * <html><span class="api-parameter"><span class="api-parameter-name">searchRadiusUnit:</span> <em>Optional.</em> The unit of measure in which the SearchRadius is expressed. Defaults to "Meter".</span></html>
-  * //**maxResults**//: __Optional__. The maximum number of results to return. Defaults to 20.
+  * <html><span class="api-parameter"><span class="api-parameter-name">maxResults:</span> <em>Optional.</em> The maximum number of results to return. Defaults to 20.</span></html>
-  * //**locationCategories**//: __Optional__. The categories of locations to include in the result set. The default value is "Common".
+  * <html><span class="api-parameter"><span class="api-parameter-name">locationCategories:</span> <em>Optional.</em> The categories of locations to include in the result set. The default value is "Common".</span></html>
-  * //**locationTypes**//: __Optional__. Filters the resulting locations by type. Multiple types should be separated by a comma. Defaults to no filter.
+  * <html><span class="api-parameter"><span class="api-parameter-name">locationTypes:</span> <em>Optional.</em> Filters the resulting locations by type. Multiple types should be separated by a comma. Defaults to no filter.</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">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>
-  * //**distanceFromQueryFeatureUnit**//: __Optional__. The unit of measure in which the distance is expressed. Defaults to "Meter".
+  * <html><span class="api-parameter"><span class="api-parameter-name">distanceFromQueryFeatureUnit:</span> <em>Optional.</em> The unit of measure in which the distance is expressed. Defaults to "Meter".</span></html>
-  *  Hit //**Try it Out**// button below [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByAreaV1|GetResverseGecodingForArea]] to test it online.
+Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByAreaV1|GetReverseGeocodingForArea]] and click "Try It Out" to explore this API online.
+==== Get Reverse Geocoding For Line ====
+Get reverse geocoding along a line. Useful for seeing what addresses or places are located along a road or highway.
 <code html>
-<!-- Get reverse geocoding for line -->
 HTTP GET
 https://cloud.thinkgeo.com/api/v1/location/reverse-geocode/line?wkt={line}
 </code>
-//**Parameters**//
+//**URL Parameters**//
-  * //**wkt**//: The Well Known Text (WKT) of the line feature to use as the search area.
+  * <html><span class="api-parameter"><span class="api-parameter-name">wkt:</span> The Well Known Text (WKT) of the line feature to use as the search area.</span></html>
-  * //**srid**//: __Optional__. The SRID (coordinate system) in which to express the result. Defaults to 4326.
+  * <html><span class="api-parameter"><span class="api-parameter-name">srid:</span> <em>Optional.</em> The SRID (coordinate system) in which to express the result. Defaults to 4326.</span></html>
-  * //**proj4String**//: __Optional__. The Proj4String (coordinate system) in which to express the result.
+  * <html><span class="api-parameter"><span class="api-parameter-name">proj4String:</span> <em>Optional.</em> The Proj4String (coordinate system) in which to express the result.</span></html>
-  * //**lang**//: __Optional__. The language in which to express the result.
+  * <html><span class="api-parameter"><span class="api-parameter-name">lang:</span> <em>Optional.</em> The language in which to express the result.</span></html>
-  * //**searchRadius**//: __Optional__. The maximun radius around the input point to search for places. Defaults to 200.
+  * <html><span class="api-parameter"><span class="api-parameter-name">searchRadius:</span> <em>Optional.</em> The maximun radius around the input point to search for places. Defaults to 200.</span></html>
-  * //**searchRadiusUnit**//: __Optional__. The unit of measure in which the SearchRadius is expressed. Defaults to "Meter".
+  * <html><span class="api-parameter"><span class="api-parameter-name">searchRadiusUnit:</span> <em>Optional.</em> The unit of measure in which the SearchRadius is expressed. Defaults to "Meter".</span></html>
-  * //**maxResults**//: __Optional__. The maximum number of results to return. Defaults to 20.
+  * <html><span class="api-parameter"><span class="api-parameter-name">maxResults:</span> <em>Optional.</em> The maximum number of results to return. Defaults to 20.</span></html>
-  * //**locationCategories**//: __Optional__. The categories of locations to include in the result set. The default value is "Common".
+  * <html><span class="api-parameter"><span class="api-parameter-name">locationCategories:</span> <em>Optional.</em> The categories of locations to include in the result set. The default value is "Common".</span></html>
-  * //**locationTypes**//: __Optional__. Filters the resulting locations by type. Multiple types should be separated by a comma. Defaults to no filter.
+  * <html><span class="api-parameter"><span class="api-parameter-name">locationTypes:</span> <em>Optional.</em> Filters the resulting locations by type. Multiple types should be separated by a comma. Defaults to no filter.</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">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>
-  * //**distanceFromQueryFeatureUnit**//: __Optional__. The unit of measure in which the distance is expressed. Defaults to "Meter".
+  * <html><span class="api-parameter"><span class="api-parameter-name">distanceFromQueryFeatureUnit:</span> <em>Optional.</em> The unit of measure in which the distance is expressed. Defaults to "Meter".</span></html>
-  *  Hit //**Try it Out**// button below [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByLineV1|GetResverseGecodingForLine]] to test it online.
+Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByLineV1|GetReverseGeocodingForLine]] and click "Try It Out" to explore this API online.
+==== Get Place By ID ====
+Get details about a specific point of interest by its ID.  Places returned in response to your reverse geocode requests will have IDs associated with them, which you can use with this endpoint.
 <code html>
-<!-- Get place by Id -->
 HTTP GET
 https://cloud.thinkgeo.com/api/v1/location/place/{placeId}
 </code>
-//**Parameters**//
+//**URL Parameters**//
-  * //**placeId**//: The OpenStreetMap ID of the place.
+  * <html><span class="api-parameter"><span class="api-parameter-name">placeId:</span> The OpenStreetMap ID of the place.</span></html>
-  * //**lang**//: __Optional__. Sets the language for the search result. The default value is "en".
+  * <html><span class="api-parameter"><span class="api-parameter-name">lang:</span> <em>Optional.</em> Sets the language for the search result. The default value is "en".</span></html>
-  *  Hit //**Try it Out**// button below [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetPlaceByIdV1|GetPlaceById]] to test it online.
+Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetPlaceByIdV1|GetPlaceById]] and click "Try It Out" to explore this API online.
+==== Get Location Categories ====
+Get a list of the available location categories.  These can be passed in to the reverse geocoding endpoints to filter the types of locations the service will return to you.
 <code html>
-<!-- Get location cateogires -->
 HTTP GET
 https://cloud.thinkgeo.com/api/v1/location/reverse-geocode/location-categories
 </code>
-//**Parameters**//
+//**URL Parameters**//
-<div>//No parameters.//</div>
+<div><html><span class="api-parameter"><em>No parameters.</em></span></html></div>
-  *  Hit //**Try it Out**// button below [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetReverseGeocodingLocationCategoriesV1|GetLocationCateogries]] to test it online.
+Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetReverseGeocodingLocationCategoriesV1|GetLocationCategories]] and click "Try It Out" to explore this API online.
+==== Get Common Location Categories ====
+When requesting a reverse geocode, you can filter the types of locations the service will return to you, with one option being "Common".  This API lists what types of categories fall under "Common".
 <code html>
-<!--  Get common location cateogires -->
 HTTP GET
 https://cloud.thinkgeo.com/api/v1/location/reverse-geocode/location-categories/common
 </code>
-//**Parameters**//
+//**URL Parameters**//
-<div>//No parameters//</div>
+<div><html><span class="api-parameter"><em>No parameters.</em></span></html></div>
-  *  Hit //**Try it Out**// button below [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetReverseGeocodingCommonLocationCategoriesV1|GetLocationCateogriesInCommonGroup]] to test it online.
+Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetReverseGeocodingCommonLocationCategoriesV1|GetLocationCategoriesInCommonGroup]] and click "Try It Out" to explore this API online.
 ===== Consume from Client Side=====
-ThinkGeo Cloud ReverseGeocoding does not allow anonymous users to access. Before working with these APIs, you need to get your own clients. A new account come with two clients: **NativeConfidential** and **JavaScript**. See more details at [[thinkgeo_cloud_client_keys_guideline|here]].
+ThinkGeo Cloud Reverse Geocoding does not allow anonymous users to access the API. Before working with these APIs, you will need to register with ThinkGeo Cloud and create your own clients. A new account comes with two clients: **NativeConfidential** and **JavaScript**. See more details at [[thinkgeo_cloud_client_keys_guideline|here]].
-ThinkGeo Cloud provides standard RESTful APIs which can be consumed in any platform through any language. ThinkGeo also offers two prepackaged API clients to make it easier to integrate into .NET and JavaScript applications.
+ThinkGeo Cloud provides standard RESTful APIs which can be consumed on any platform through any language. ThinkGeo also offers two prepackaged API clients to make it easier to integrate into .NET and JavaScript applications.
 ==== SDK for .NET ====
-The SDK for .NET enables developers to build .NET application that uses 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 the [[https://github.com/ThinkGeo/ThinkGeoCloudReverseGeocodingSample-ForWpf|ThinkGeoCloudReverseGeocodingSample-ForWpf]] for the 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/ThinkGeoCloudReverseGeocodingSample-ForWpf|a sample project]] to get you started.
 === API Documentation ===
@@ Line 155: / Line 169: @@
 ==== 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/#Reverse-Geocoding|ReverseGeocoding]] sample shows how to work with this SDK.
+===== Samples =====
+Online Sample:
+  * [[https://samples.thinkgeo.com/cloud/#FindNearbyPlaces|ThinkGeo Cloud Geocoding Online Sample]]
+Desktop Sample:
+  * [[https://github.com/ThinkGeo/ThinkGeoCloudGeocodingSample-ForWpf|ThinkGeo Cloud 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 164: / Line 203: @@
   * [[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