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

Gets a list of child areas

Request Information

URI Parameters

Name	Type	Additional 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 AreaPreview

Name	Type	Additional information
AreaID	globally unique identifier	None.
ParentID	globally unique identifier	None.
ParentName	string	None.
SupplierName	string	None.
CustomerName	string	None.
StoreName	string	None.
Code	string	None.
Name	string	None.
Type	AreaType	None.
Status	AreaStatus	None.
OwnerName	string	None.
Population	integer	None.
Mailboxes	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AreaID": "d0749335-9b39-44d2-807b-70bfb608bd93",
    "ParentID": "390f86f6-6848-46ac-9ed9-e1ae0d885ea0",
    "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
  },
  {
    "AreaID": "d0749335-9b39-44d2-807b-70bfb608bd93",
    "ParentID": "390f86f6-6848-46ac-9ed9-e1ae0d885ea0",
    "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
  }
]

application/xml, text/xml

Sample:

<ArrayOfAreaPreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <AreaPreview>
    <AreaID>d0749335-9b39-44d2-807b-70bfb608bd93</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>390f86f6-6848-46ac-9ed9-e1ae0d885ea0</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>
  </AreaPreview>
  <AreaPreview>
    <AreaID>d0749335-9b39-44d2-807b-70bfb608bd93</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>390f86f6-6848-46ac-9ed9-e1ae0d885ea0</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>
  </AreaPreview>
</ArrayOfAreaPreview>

multipart/form-data

Sample:

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

d0749335-9b39-44d2-807b-70bfb608bd93
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].ParentID"

390f86f6-6848-46ac-9ed9-e1ae0d885ea0
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].ParentName"

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

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

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

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

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

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

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

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

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

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

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

d0749335-9b39-44d2-807b-70bfb608bd93
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].ParentID"

390f86f6-6848-46ac-9ed9-e1ae0d885ea0
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].ParentName"

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

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

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

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

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

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

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

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

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

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

10
--MultipartDataMediaFormatterBoundary1q2w3e--