POST api/poi/search/box

Search for POI's inside a bounding box 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 box query data contract supplied with the request.

PoiGeoBoxQueryDataContract

Name	Description	Type	Additional information
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
TopLeft	The top left value.	LatLonDataContract	None.
BottomRight	The bottom right value.	LatLonDataContract	None.
DistancePoint	The distance point value.	LatLonDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "PageSize": 1,
  "PageNumber": 2,
  "TopLeft": {
    "Latitude": 1.1,
    "Longitude": 2.1
  },
  "BottomRight": {
    "Latitude": 1.1,
    "Longitude": 2.1
  },
  "DistancePoint": {
    "Latitude": 1.1,
    "Longitude": 2.1
  }
}

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
    }
  ]
}