GET Api/v{apiVersion}/Areas/FromRange?latitude={latitude}&longitude={longitude}&range={range}&type={type}&areaType={areaType}

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional 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.

Type

AreaType

None.

Status

GenericEntityStatus

None.

NumberOfInhabitants

integer

None.

NumberOfAddresses

integer

None.

Surface

decimal number

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AreaID": "ecb9e28f-efa1-4fb5-849c-06f01bbf2217",
    "Name": "sample string 2",
    "Category": "sample string 3",
    "FullName": "sample string 4",
    "Reference": "sample string 5",
    "IsBuildIn": true,
    "OwnerName": "sample string 7",
    "User_UserID": "defce720-464f-4ff0-9e2b-ebf95befa791",
    "User_FullName": "sample string 8",
    "Type": "Country",
    "Status": "InActive",
    "NumberOfInhabitants": 9,
    "NumberOfAddresses": 10,
    "Surface": 11.1
  },
  {
    "AreaID": "ecb9e28f-efa1-4fb5-849c-06f01bbf2217",
    "Name": "sample string 2",
    "Category": "sample string 3",
    "FullName": "sample string 4",
    "Reference": "sample string 5",
    "IsBuildIn": true,
    "OwnerName": "sample string 7",
    "User_UserID": "defce720-464f-4ff0-9e2b-ebf95befa791",
    "User_FullName": "sample string 8",
    "Type": "Country",
    "Status": "InActive",
    "NumberOfInhabitants": 9,
    "NumberOfAddresses": 10,
    "Surface": 11.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>ecb9e28f-efa1-4fb5-849c-06f01bbf2217</AreaID>
    <Category>sample string 3</Category>
    <FullName>sample string 4</FullName>
    <IsBuildIn>true</IsBuildIn>
    <Name>sample string 2</Name>
    <NumberOfAddresses>10</NumberOfAddresses>
    <NumberOfInhabitants>9</NumberOfInhabitants>
    <OwnerName>sample string 7</OwnerName>
    <Reference>sample string 5</Reference>
    <Status>InActive</Status>
    <Surface>11.1</Surface>
    <Type>Country</Type>
    <User_FullName>sample string 8</User_FullName>
    <User_UserID>defce720-464f-4ff0-9e2b-ebf95befa791</User_UserID>
  </AreaPreview>
  <AreaPreview>
    <AreaID>ecb9e28f-efa1-4fb5-849c-06f01bbf2217</AreaID>
    <Category>sample string 3</Category>
    <FullName>sample string 4</FullName>
    <IsBuildIn>true</IsBuildIn>
    <Name>sample string 2</Name>
    <NumberOfAddresses>10</NumberOfAddresses>
    <NumberOfInhabitants>9</NumberOfInhabitants>
    <OwnerName>sample string 7</OwnerName>
    <Reference>sample string 5</Reference>
    <Status>InActive</Status>
    <Surface>11.1</Surface>
    <Type>Country</Type>
    <User_FullName>sample string 8</User_FullName>
    <User_UserID>defce720-464f-4ff0-9e2b-ebf95befa791</User_UserID>
  </AreaPreview>
</ArrayOfAreaPreview>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].AreaID"

ecb9e28f-efa1-4fb5-849c-06f01bbf2217
--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"

defce720-464f-4ff0-9e2b-ebf95befa791
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].User_FullName"

sample string 8
--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"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].NumberOfAddresses"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Surface"

11,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].AreaID"

ecb9e28f-efa1-4fb5-849c-06f01bbf2217
--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"

defce720-464f-4ff0-9e2b-ebf95befa791
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].User_FullName"

sample string 8
--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"

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].NumberOfAddresses"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Surface"

11,1
--MultipartDataMediaFormatterBoundary1q2w3e--