POST api/list/property/polygon?pageSize={pageSize}&pageNumber={pageNumber}

Searches for properties that are within a polygon

Request Information

URI Parameters

NameDescriptionTypeAdditional information
pageSize

How many properties to show per page

integer

Default value is 20

pageNumber

Page number

integer

Default value is 1

Body Parameters

List of points that make a polygon

Collection of Dezrez.Core.DataContracts.External.Api.Location.Query.PointDataContract
NameDescriptionTypeAdditional information
Latitude

decimal number

None.

Longitude

decimal number

None.

Altitude

decimal number

None.

Order

integer

None.

Id

integer

None.

Request Formats

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 'IList`1'.

application/json, text/json

Sample:
[
  {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "Altitude": 3.1,
    "Order": 4,
    "Id": 5
  },
  {
    "Latitude": 1.1,
    "Longitude": 2.1,
    "Altitude": 3.1,
    "Order": 4,
    "Id": 5
  }
]

Response Information

Resource Description

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Property.PropertyListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of Dezrez.Core.DataContracts.External.Api.Lists.Property.PropertyListDataContract

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'Dezrez.Core.Client.Common.Formatters.SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Group.Query.Get.PreferredCompanyDataContract'. Path 'Collection[0].OfferingGroup.PreferredCompanies[0].Group.PreferredCompanies'.

text/json

Sample:

An exception has occurred while using the formatter 'Dezrez.Core.Client.Common.Formatters.SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Group.Query.Get.PreferredCompanyDataContract'. Path 'Collection[0].OfferingGroup.PreferredCompanies[0].Group.PreferredCompanies'.