POST api/list/property/polygon?pageSize={pageSize}&pageNumber={pageNumber}
Searches for properties that are within a polygon Processes this list API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
| Name | Description | Type | Additional 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 PointDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Latitude |
The latitude value. |
decimal number |
None. |
| Longitude |
The longitude value. |
decimal number |
None. |
| Altitude |
The altitude value. |
decimal number |
None. |
| Order |
The order value. |
integer |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
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
The response returned after the operation completes.
PagedCollectionDataContractOfPropertyListDataContract| 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 PropertyListDataContract |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.