POST api/poi/search/box

Request Information

URI Parameters

None.

Body Parameters

PoiGeoBoxQueryDataContract
NameDescriptionTypeAdditional information
PageSize

integer

None.

PageNumber

integer

None.

TopLeft

LatLonDataContract

None.

BottomRight

LatLonDataContract

None.

DistancePoint

LatLonDataContract

None.

Request Formats

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

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PoiGeoBoxQueryDataContract'.

Response Information

Resource Description

PagedCollectionDataContractOfPoiGeoDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

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