GET Api/v{apiVersion}/Areas?address={address}

Request Information

URI Parameters

Name	Description	Type	Additional information
address		string	Required
apiVersion		string	None.

Body Parameters

None.

Response Information

Resource Description

AreaDetails

Name	Type	Additional information
AreaID	globally unique identifier	None.
Name	string	None.
Category	string	None.
User	UserPreview	None.
FullName	string	None.
Type	AreaType	None.
Status	GenericEntityStatus	None.
NumberOfInhabitants	integer	None.
NumberOfAddresses	integer	None.
Surface	decimal number	None.
IsBuildIn	boolean	None.
OwnerName	string	None.
Reference	string	None.
IsFavorite	boolean	None.
ChildTypes	Collection of AreaType	None.
HasInvalidChildren	boolean	None.
Notes	string	None.
CreatedAt	date	None.
CreatedBy	string	None.
ModifiedAt	date	None.
ModifiedBy	string	None.

Response Formats

application/json, text/json

Sample:

{
  "AreaID": "e35cb005-62ee-4da9-a145-517f0cd962a8",
  "Name": "sample string 2",
  "Category": "sample string 3",
  "User": {
    "UserID": "541c8b8c-63c1-48e4-98c2-0dfc13cf5052",
    "FullName": "sample string 2",
    "DisplayName": "sample string 3",
    "Type": "External",
    "Role": "Reader",
    "EmailAddress": "sample string 4",
    "PhoneNumber": "sample string 5",
    "Status": "InActive",
    "Organization_Name": "sample string 6",
    "Culture": "sample string 7",
    "IsMailSubscribed": true,
    "IsSignedIn": true
  },
  "FullName": "sample string 4",
  "Type": "Country",
  "Status": "InActive",
  "NumberOfInhabitants": 5,
  "NumberOfAddresses": 6,
  "Surface": 7.1,
  "IsBuildIn": true,
  "OwnerName": "sample string 9",
  "Reference": "sample string 10",
  "IsFavorite": false,
  "ChildTypes": [
    "Country",
    "Country"
  ],
  "HasInvalidChildren": true,
  "Notes": "sample string 12",
  "CreatedAt": "2025-12-28T08:35:07.1223811Z",
  "CreatedBy": "sample string 14",
  "ModifiedAt": "2025-12-28T08:35:07.1223811Z",
  "ModifiedBy": "sample string 16"
}

application/xml, text/xml

Sample:

<AreaDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mapalize.Api.ViewModels">
  <AreaID>e35cb005-62ee-4da9-a145-517f0cd962a8</AreaID>
  <Category>sample string 3</Category>
  <ChildTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mapalize.Api.Entities">
    <d2p1:AreaType>Country</d2p1:AreaType>
    <d2p1:AreaType>Country</d2p1:AreaType>
  </ChildTypes>
  <CreatedAt>2025-12-28T09:35:07.1223811+01:00</CreatedAt>
  <CreatedBy>sample string 14</CreatedBy>
  <FullName>sample string 4</FullName>
  <HasInvalidChildren>true</HasInvalidChildren>
  <IsBuildIn>true</IsBuildIn>
  <ModifiedAt>2025-12-28T09:35:07.1223811+01:00</ModifiedAt>
  <ModifiedBy>sample string 16</ModifiedBy>
  <Name>sample string 2</Name>
  <Notes>sample string 12</Notes>
  <NumberOfAddresses>6</NumberOfAddresses>
  <NumberOfInhabitants>5</NumberOfInhabitants>
  <OwnerName>sample string 9</OwnerName>
  <Reference>sample string 10</Reference>
  <Status>InActive</Status>
  <Surface>7.1</Surface>
  <Type>Country</Type>
  <User>
    <Culture>sample string 7</Culture>
    <DisplayName>sample string 3</DisplayName>
    <EmailAddress>sample string 4</EmailAddress>
    <FullName>sample string 2</FullName>
    <IsMailSubscribed>true</IsMailSubscribed>
    <IsSignedIn>true</IsSignedIn>
    <Organization_Name>sample string 6</Organization_Name>
    <PhoneNumber>sample string 5</PhoneNumber>
    <Role>Reader</Role>
    <Status>InActive</Status>
    <Type>External</Type>
    <UserID>541c8b8c-63c1-48e4-98c2-0dfc13cf5052</UserID>
  </User>
</AreaDetails>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AreaID"

e35cb005-62ee-4da9-a145-517f0cd962a8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Category"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.UserID"

541c8b8c-63c1-48e4-98c2-0dfc13cf5052
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.FullName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.DisplayName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.Type"

External
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.Role"

Reader
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.EmailAddress"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.PhoneNumber"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.Organization_Name"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.Culture"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.IsMailSubscribed"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="User.IsSignedIn"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FullName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Type"

Country
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="NumberOfInhabitants"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="NumberOfAddresses"

6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Surface"

7,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsBuildIn"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OwnerName"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Reference"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsFavorite"

False
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ChildTypes[0]"

Country
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ChildTypes[1]"

Country
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="HasInvalidChildren"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedAt"

2025-12-28T09:35:07.1223811+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedBy"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedAt"

2025-12-28T09:35:07.1223811+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedBy"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e--