Match Geolocations within a Geolocation
This method allows you to search for other geolocations within the vicinity of a particular geolocation using the geolocation ID. If distance is not provided, then it checks for geolocations considering the distance value as 0. The maximum distance that you can search for a geolocation is 20,000 meters.
Base URI:https://<server address>/geolocation/v1/GeoTest/Check/Within/GeoLocation
Request
URI: /geolocation/v1/GeoTest/Check/Within/GeoLocation
HTTP: GET
Roles Required: Geolocation_Viewer, Geolocation_Editor, Geolocation_Super_Editor
For more information on Roles and Permissions, see Role Template and Scopes
Request Parameters
|
Name |
Required |
Data Type |
Description |
|---|---|---|---|
|
GeoLocationId1 |
Yes |
string |
ID of the geolocation to be matched |
|
GeoLocationId2 |
Yes |
string |
ID of the geolocation that contains the previous geolocation |
|
Distance |
Optional |
double |
Distance in meters. For example, 10. The default value is 0. |
/geolocation/v1/GeoTest/Check/Within/GeoLocation
Response
Format: JSON
Sample Response:
|
Code |
Description |
|---|---|
|
200 |
Matched geolocations within the vicinity of a geolocation successfully |
|
400 |
Invalid request. Wrong format or structure of the provided request body |
|
403 |
Access denied. You did not have the required permissions to access the resource. |
|
404 |
Geolocation ID not found. |