thinkgeo_cloud_reverse_geocoding
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo_cloud_reverse_geocoding [2019/03/11 08:18] johnnyz [Samples] |
thinkgeo_cloud_reverse_geocoding [2019/03/31 16:39] (current) brianr [Related Links] |
||
|---|---|---|---|
| Line 9: | Line 9: | ||
| //**ThinkGeo Cloud ReverseGeocoding provides the following Restful APIs**.// | //**ThinkGeo Cloud ReverseGeocoding provides the following Restful APIs**.// | ||
| - | ==== Get Resverse Gecoding For Point ==== | + | ==== Get Reverse Geocoding For Point ==== |
| Get reverse geocoding for point. | Get reverse geocoding for point. | ||
| Line 17: | Line 17: | ||
| </code> | </code> | ||
| //**URL 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> |
| | | ||
| - | Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByPointV1|GetResverseGecodingForPoint]] and click "Try It Out" to explore this API 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) ==== | ==== Reverse Geocode By Points (Batch Request) ==== | ||
| Line 60: | Line 60: | ||
| //**URL Parameters**// | //**URL Parameters**// | ||
| - | * //**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> |
| Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByPointsBatchV1|ReverseGeocodeByPointsBatch]] and click "Try It Out" to explore this API online. | Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByPointsBatchV1|ReverseGeocodeByPointsBatch]] and click "Try It Out" to explore this API online. | ||
| - | ==== Get Resverse Gecoding For Area ==== | + | ==== Get Reverse Geocoding For Area ==== |
| - | Get reverse geocoding for area. | + | Get reverse geocoding for area. Returns locations found only within the polygon you specify. |
| <code html> | <code html> | ||
| Line 81: | Line 81: | ||
| </code> | </code> | ||
| //**URL 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> |
| - | Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByAreaV1|GetResverseGecodingForArea]] and click "Try It Out" to explore this API online. | + | Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByAreaV1|GetReverseGeocodingForArea]] and click "Try It Out" to explore this API online. |
| - | ==== Get Resverse Gecoding For Line ==== | + | ==== Get Reverse Geocoding For Line ==== |
| - | 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> | <code html> | ||
| Line 103: | Line 103: | ||
| </code> | </code> | ||
| //**URL 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> |
| - | Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/ReverseGeocodeByLineV1|GetResverseGecodingForLine]] and click "Try It Out" to explore this API 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 Place By ID ==== |
| - | 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> | <code html> | ||
| Line 125: | Line 125: | ||
| </code> | </code> | ||
| //**URL 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> |
| Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetPlaceByIdV1|GetPlaceById]] and click "Try It Out" to explore this API online. | Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetPlaceByIdV1|GetPlaceById]] and click "Try It Out" to explore this API online. | ||
| - | ==== Get Location Cateogries ==== | + | ==== Get Location Categories ==== |
| - | Get location cateogires. | + | 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> | <code html> | ||
| Line 138: | Line 138: | ||
| </code> | </code> | ||
| //**URL Parameters**// | //**URL Parameters**// | ||
| - | <div>//No parameters.//</div> | + | <div><html><span class="api-parameter"><em>No parameters.</em></span></html></div> |
| - | Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetReverseGeocodingLocationCategoriesV1|GetLocationCateogries]] and click "Try It Out" to explore this API online. | + | Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetReverseGeocodingLocationCategoriesV1|GetLocationCategories]] and click "Try It Out" to explore this API online. |
| - | ==== Get Location Cateogries In Common Group ==== | + | ==== Get Common Location Categories ==== |
| - | Get common location cateogires. | + | 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> | <code html> | ||
| Line 150: | Line 150: | ||
| </code> | </code> | ||
| //**URL Parameters**// | //**URL Parameters**// | ||
| - | <div>//No parameters//</div> | + | <div><html><span class="api-parameter"><em>No parameters.</em></span></html></div> |
| - | Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetReverseGeocodingCommonLocationCategoriesV1|GetLocationCateogriesInCommonGroup]] and click "Try It Out" to explore this API online. | + | Visit [[https://cloud.thinkgeo.com/help/#/ReverseGeocoding/GetReverseGeocodingCommonLocationCategoriesV1|GetLocationCategoriesInCommonGroup]] and click "Try It Out" to explore this API online. |
| ===== Consume from Client Side===== | ===== Consume from Client Side===== | ||
| Line 160: | Line 160: | ||
| ==== SDK for .NET ==== | ==== 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 === | === API Documentation === | ||
| Line 184: | Line 186: | ||
| </code> | </code> | ||
| - | Mobile Samples: | + | Mobile Sample: |
| <code csharp> | <code csharp> | ||
| Line 201: | Line 203: | ||
| * [[thinkgeo_cloud_projection|ThinkGeo Cloud Projection]] | * [[thinkgeo_cloud_projection|ThinkGeo Cloud Projection]] | ||
| * [[thinkgeo_cloud_colors|ThinkGeo Cloud Colors]] | * [[thinkgeo_cloud_colors|ThinkGeo Cloud Colors]] | ||
| + | * [[thinkgeo_cloud_timezone|ThinkGeo Cloud Time Zones]] | ||
thinkgeo_cloud_reverse_geocoding.1552292283.txt.gz · Last modified: 2019/03/11 08:18 by johnnyz