GET Api/v{apiVersion}/Areas?mapid={mapid}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Request Information

URI Parameters

Name	Type	Additional information
mapid	globally unique identifier	Required
query	string	None.
pageSize	integer	None.
currentPage	integer	None.
orderBy	string	None.
descending	boolean	None.
apiVersion	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of AreaPreview

Name	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": "3ec05fd7-c948-4a5b-83dd-84caf6009923",
    "Name": "sample string 2",
    "Category": "sample string 3",
    "FullName": "sample string 4",
    "Reference": "sample string 5",
    "IsBuildIn": true,
    "OwnerName": "sample string 7",
    "User_UserID": "07b16a12-1b9a-426b-a31c-8b3c17212e20",
    "User_FullName": "sample string 8",
    "Organization_OrganizationID": "3fbb8cce-d509-4610-8b4b-8da764f8848b",
    "Organization_Name": "sample string 9",
    "Type": "Country",
    "Status": "InActive",
    "NumberOfInhabitants": 10,
    "NumberOfAddresses": 11,
    "Surface": 12.1
  },
  {
    "AreaID": "3ec05fd7-c948-4a5b-83dd-84caf6009923",
    "Name": "sample string 2",
    "Category": "sample string 3",
    "FullName": "sample string 4",
    "Reference": "sample string 5",
    "IsBuildIn": true,
    "OwnerName": "sample string 7",
    "User_UserID": "07b16a12-1b9a-426b-a31c-8b3c17212e20",
    "User_FullName": "sample string 8",
    "Organization_OrganizationID": "3fbb8cce-d509-4610-8b4b-8da764f8848b",
    "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>3ec05fd7-c948-4a5b-83dd-84caf6009923</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>3fbb8cce-d509-4610-8b4b-8da764f8848b</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>07b16a12-1b9a-426b-a31c-8b3c17212e20</User_UserID>
  </AreaPreview>
  <AreaPreview>
    <AreaID>3ec05fd7-c948-4a5b-83dd-84caf6009923</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>3fbb8cce-d509-4610-8b4b-8da764f8848b</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>07b16a12-1b9a-426b-a31c-8b3c17212e20</User_UserID>
  </AreaPreview>
</ArrayOfAreaPreview>

multipart/form-data

Sample:

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

3ec05fd7-c948-4a5b-83dd-84caf6009923
--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"

07b16a12-1b9a-426b-a31c-8b3c17212e20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].User_FullName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Organization_OrganizationID"

3fbb8cce-d509-4610-8b4b-8da764f8848b
--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"

3ec05fd7-c948-4a5b-83dd-84caf6009923
--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"

07b16a12-1b9a-426b-a31c-8b3c17212e20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].User_FullName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Organization_OrganizationID"

3fbb8cce-d509-4610-8b4b-8da764f8848b
--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--