POST api/poi/search/radius
Search for POI's in a radius from a point Processes this poi API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The poi geo radius query data contract supplied with the request.
PoiGeoRadiusQueryDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Latitude |
The latitude value. |
decimal number |
None. |
| Longitude |
The longitude value. |
decimal number |
None. |
| Radius |
The radius value. |
decimal number |
None. |
| PageSize |
The page size value. |
integer |
None. |
| PageNumber |
The page number value. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"Latitude": 1.1,
"Longitude": 2.1,
"Radius": 3.1,
"PageSize": 4,
"PageNumber": 5
}
Response Information
Resource Description
The response returned after the operation completes.
PagedCollectionDataContractOfPoiGeoDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount |
The total count value. |
integer |
None. |
| CurrentCount |
The current count value. |
integer |
None. |
| PageSize |
The page size value. |
integer |
None. |
| PageNumber |
The page number value. |
integer |
None. |
| Collection |
The collection of collection. |
Collection of PoiGeoDataContract |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"CurrentCount": 2,
"PageSize": 1,
"PageNumber": 1,
"Collection": [
{
"Distance": 1.1,
"CenterPoint": {
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
},
"Name": "sample string 2",
"PrimaryType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Types": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"Id": 3
},
{
"Distance": 1.1,
"CenterPoint": {
"Latitude": 1.1,
"Longitude": 2.1,
"Altitude": 3.1,
"Order": 4,
"Id": 5
},
"Name": "sample string 2",
"PrimaryType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
"Types": [
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
},
{
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
],
"Id": 3
}
]
}