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

Gets a list of Features for this Area

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

query

string

Default value is

pageSize

integer

None.

currentPage

integer

None.

orderBy

string

Default value is

descending

boolean

None.

apiVersion

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of FeaturePreview
NameDescriptionTypeAdditional information
FeatureID

globally unique identifier

None.

Area

AreaPreview

None.

Category

string

None.

Item

string

None.

Value

decimal number

None.

IsCalculated

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "FeatureID": "b458bc93-d752-4c7b-af78-ae305aa987bc",
    "Area": {
      "AreaID": "e67e9fdf-bb3b-4510-9d2a-0dacf325b50e",
      "ParentID": "66aafca5-c06a-4da4-aeea-c9c80c084672",
      "ParentName": "sample string 2",
      "SupplierName": "sample string 3",
      "CustomerName": "sample string 4",
      "StoreName": "sample string 5",
      "Code": "sample string 6",
      "Name": "sample string 7",
      "Type": "Neighbourhood",
      "Status": "InActive",
      "OwnerName": "sample string 8",
      "Population": 9,
      "Mailboxes": 10
    },
    "Category": "sample string 2",
    "Item": "sample string 3",
    "Value": 4.1,
    "IsCalculated": true
  },
  {
    "FeatureID": "b458bc93-d752-4c7b-af78-ae305aa987bc",
    "Area": {
      "AreaID": "e67e9fdf-bb3b-4510-9d2a-0dacf325b50e",
      "ParentID": "66aafca5-c06a-4da4-aeea-c9c80c084672",
      "ParentName": "sample string 2",
      "SupplierName": "sample string 3",
      "CustomerName": "sample string 4",
      "StoreName": "sample string 5",
      "Code": "sample string 6",
      "Name": "sample string 7",
      "Type": "Neighbourhood",
      "Status": "InActive",
      "OwnerName": "sample string 8",
      "Population": 9,
      "Mailboxes": 10
    },
    "Category": "sample string 2",
    "Item": "sample string 3",
    "Value": 4.1,
    "IsCalculated": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfFeaturePreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <FeaturePreview>
    <Area>
      <AreaID>e67e9fdf-bb3b-4510-9d2a-0dacf325b50e</AreaID>
      <Code>sample string 6</Code>
      <CustomerName>sample string 4</CustomerName>
      <Mailboxes>10</Mailboxes>
      <Name>sample string 7</Name>
      <OwnerName>sample string 8</OwnerName>
      <ParentID>66aafca5-c06a-4da4-aeea-c9c80c084672</ParentID>
      <ParentName>sample string 2</ParentName>
      <Population>9</Population>
      <Status>InActive</Status>
      <StoreName>sample string 5</StoreName>
      <SupplierName>sample string 3</SupplierName>
      <Type>Neighbourhood</Type>
    </Area>
    <Category>sample string 2</Category>
    <FeatureID>b458bc93-d752-4c7b-af78-ae305aa987bc</FeatureID>
    <IsCalculated>true</IsCalculated>
    <Item>sample string 3</Item>
    <Value>4.1</Value>
  </FeaturePreview>
  <FeaturePreview>
    <Area>
      <AreaID>e67e9fdf-bb3b-4510-9d2a-0dacf325b50e</AreaID>
      <Code>sample string 6</Code>
      <CustomerName>sample string 4</CustomerName>
      <Mailboxes>10</Mailboxes>
      <Name>sample string 7</Name>
      <OwnerName>sample string 8</OwnerName>
      <ParentID>66aafca5-c06a-4da4-aeea-c9c80c084672</ParentID>
      <ParentName>sample string 2</ParentName>
      <Population>9</Population>
      <Status>InActive</Status>
      <StoreName>sample string 5</StoreName>
      <SupplierName>sample string 3</SupplierName>
      <Type>Neighbourhood</Type>
    </Area>
    <Category>sample string 2</Category>
    <FeatureID>b458bc93-d752-4c7b-af78-ae305aa987bc</FeatureID>
    <IsCalculated>true</IsCalculated>
    <Item>sample string 3</Item>
    <Value>4.1</Value>
  </FeaturePreview>
</ArrayOfFeaturePreview>

multipart/form-data

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

b458bc93-d752-4c7b-af78-ae305aa987bc
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.AreaID"

e67e9fdf-bb3b-4510-9d2a-0dacf325b50e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.ParentID"

66aafca5-c06a-4da4-aeea-c9c80c084672
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.OwnerName"

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

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

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

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

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

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

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].FeatureID"

b458bc93-d752-4c7b-af78-ae305aa987bc
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.AreaID"

e67e9fdf-bb3b-4510-9d2a-0dacf325b50e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.ParentID"

66aafca5-c06a-4da4-aeea-c9c80c084672
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.ParentName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.SupplierName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.CustomerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.StoreName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.Code"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.Type"

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.OwnerName"

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

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

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

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

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

4.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].IsCalculated"

True
--MultipartDataMediaFormatterBoundary1q2w3e--