GET Api/v{apiVersion}/Areas/FromRange?latitude={latitude}&longitude={longitude}&range={range}&type={type}&areaType={areaType}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| latitude | decimal number |
Required |
|
| longitude | decimal number |
Required |
|
| range | decimal number |
Required |
|
| type | RangeType |
Default value is Radius |
|
| areaType | AreaType |
None. |
|
| apiVersion | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of AreaPreview| Name | Description | Type | Additional information |
|---|---|---|---|
| AreaID | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Category | string |
None. |
|
| FullName | string |
None. |
|
| Reference | string |
None. |
|
| IsBuildIn | boolean |
None. |
|
| OwnerName | string |
None. |
|
| User_UserID | globally unique identifier |
None. |
|
| User_FullName | string |
None. |
|
| Organization_OrganizationID | globally unique identifier |
None. |
|
| Organization_Name | string |
None. |
|
| Type | AreaType |
None. |
|
| Status | GenericEntityStatus |
None. |
|
| NumberOfInhabitants | integer |
None. |
|
| NumberOfAddresses | integer |
None. |
|
| Surface | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"AreaID": "8d50114d-bb0b-4cdc-9f5e-b4e8b94d43ac",
"Name": "sample string 2",
"Category": "sample string 3",
"FullName": "sample string 4",
"Reference": "sample string 5",
"IsBuildIn": true,
"OwnerName": "sample string 7",
"User_UserID": "00f8bec6-2568-4562-84dc-456b3e668efc",
"User_FullName": "sample string 8",
"Organization_OrganizationID": "16ca17f0-7695-4a9a-99c2-1e68264b9b80",
"Organization_Name": "sample string 9",
"Type": "Country",
"Status": "InActive",
"NumberOfInhabitants": 10,
"NumberOfAddresses": 11,
"Surface": 12.1
},
{
"AreaID": "8d50114d-bb0b-4cdc-9f5e-b4e8b94d43ac",
"Name": "sample string 2",
"Category": "sample string 3",
"FullName": "sample string 4",
"Reference": "sample string 5",
"IsBuildIn": true,
"OwnerName": "sample string 7",
"User_UserID": "00f8bec6-2568-4562-84dc-456b3e668efc",
"User_FullName": "sample string 8",
"Organization_OrganizationID": "16ca17f0-7695-4a9a-99c2-1e68264b9b80",
"Organization_Name": "sample string 9",
"Type": "Country",
"Status": "InActive",
"NumberOfInhabitants": 10,
"NumberOfAddresses": 11,
"Surface": 12.1
}
]
application/xml, text/xml
Sample:
<ArrayOfAreaPreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mapalize.Api.ViewModels">
<AreaPreview>
<AreaID>8d50114d-bb0b-4cdc-9f5e-b4e8b94d43ac</AreaID>
<Category>sample string 3</Category>
<FullName>sample string 4</FullName>
<IsBuildIn>true</IsBuildIn>
<Name>sample string 2</Name>
<NumberOfAddresses>11</NumberOfAddresses>
<NumberOfInhabitants>10</NumberOfInhabitants>
<Organization_Name>sample string 9</Organization_Name>
<Organization_OrganizationID>16ca17f0-7695-4a9a-99c2-1e68264b9b80</Organization_OrganizationID>
<OwnerName>sample string 7</OwnerName>
<Reference>sample string 5</Reference>
<Status>InActive</Status>
<Surface>12.1</Surface>
<Type>Country</Type>
<User_FullName>sample string 8</User_FullName>
<User_UserID>00f8bec6-2568-4562-84dc-456b3e668efc</User_UserID>
</AreaPreview>
<AreaPreview>
<AreaID>8d50114d-bb0b-4cdc-9f5e-b4e8b94d43ac</AreaID>
<Category>sample string 3</Category>
<FullName>sample string 4</FullName>
<IsBuildIn>true</IsBuildIn>
<Name>sample string 2</Name>
<NumberOfAddresses>11</NumberOfAddresses>
<NumberOfInhabitants>10</NumberOfInhabitants>
<Organization_Name>sample string 9</Organization_Name>
<Organization_OrganizationID>16ca17f0-7695-4a9a-99c2-1e68264b9b80</Organization_OrganizationID>
<OwnerName>sample string 7</OwnerName>
<Reference>sample string 5</Reference>
<Status>InActive</Status>
<Surface>12.1</Surface>
<Type>Country</Type>
<User_FullName>sample string 8</User_FullName>
<User_UserID>00f8bec6-2568-4562-84dc-456b3e668efc</User_UserID>
</AreaPreview>
</ArrayOfAreaPreview>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].AreaID" 8d50114d-bb0b-4cdc-9f5e-b4e8b94d43ac --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Name" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Category" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].FullName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Reference" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].IsBuildIn" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].OwnerName" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].User_UserID" 00f8bec6-2568-4562-84dc-456b3e668efc --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].User_FullName" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Organization_OrganizationID" 16ca17f0-7695-4a9a-99c2-1e68264b9b80 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Organization_Name" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Type" Country --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].NumberOfInhabitants" 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].NumberOfAddresses" 11 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[0].Surface" 12,1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].AreaID" 8d50114d-bb0b-4cdc-9f5e-b4e8b94d43ac --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Name" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Category" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].FullName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Reference" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].IsBuildIn" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].OwnerName" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].User_UserID" 00f8bec6-2568-4562-84dc-456b3e668efc --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].User_FullName" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Organization_OrganizationID" 16ca17f0-7695-4a9a-99c2-1e68264b9b80 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Organization_Name" sample string 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Type" Country --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].NumberOfInhabitants" 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].NumberOfAddresses" 11 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="[1].Surface" 12,1 --MultipartDataMediaFormatterBoundary1q2w3e--