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

Gets a list of customers

Request Information

URI Parameters

Name	Description	Type	Additional information
query	Optional: search query (e.g. Name.Equals("John Doe") or Name.Contains("Doe"))	string	Default value is
pageSize	Optional: page size, used for server-side paging (e.g. 10)	integer	None.
currentPage	Optional: current page, used for server-side paging (e.g. 1)	integer	None.
orderBy	Optional: property used to order the data, used for server-side ordering (e.g. Name)	string	Default value is
descending	Optional: ordering type (e.g. True)	boolean	None.
apiVersion		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CustomerPreview

Name	Type	Additional information
CustomerID	globally unique identifier	None.
ParentName	string	None.
Name	string	None.
Status	CustomerStatus	None.
Address	string	None.
City	AreaPreview	None.
Postcode	string	None.
IsBackendCustomer	boolean	None.
Contact	string	None.
PhoneNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CustomerID": "ae9aa9ec-427b-46c1-9ba9-a9ae475638e8",
    "ParentName": "sample string 2",
    "Name": "sample string 3",
    "Status": "InActive",
    "Address": "sample string 4",
    "City": {
      "AreaID": "cde50bdd-124e-4184-8e49-6909a2a9e232",
      "ParentID": "8648aa70-f8ae-4310-ba25-76a65d5c6f26",
      "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
    },
    "Postcode": "sample string 5",
    "IsBackendCustomer": true,
    "Contact": "sample string 7",
    "PhoneNumber": "sample string 8"
  },
  {
    "CustomerID": "ae9aa9ec-427b-46c1-9ba9-a9ae475638e8",
    "ParentName": "sample string 2",
    "Name": "sample string 3",
    "Status": "InActive",
    "Address": "sample string 4",
    "City": {
      "AreaID": "cde50bdd-124e-4184-8e49-6909a2a9e232",
      "ParentID": "8648aa70-f8ae-4310-ba25-76a65d5c6f26",
      "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
    },
    "Postcode": "sample string 5",
    "IsBackendCustomer": true,
    "Contact": "sample string 7",
    "PhoneNumber": "sample string 8"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCustomerPreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <CustomerPreview>
    <Address>sample string 4</Address>
    <City>
      <AreaID>cde50bdd-124e-4184-8e49-6909a2a9e232</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>8648aa70-f8ae-4310-ba25-76a65d5c6f26</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>
    </City>
    <Contact>sample string 7</Contact>
    <CustomerID>ae9aa9ec-427b-46c1-9ba9-a9ae475638e8</CustomerID>
    <IsBackendCustomer>true</IsBackendCustomer>
    <Name>sample string 3</Name>
    <ParentName>sample string 2</ParentName>
    <PhoneNumber>sample string 8</PhoneNumber>
    <Postcode>sample string 5</Postcode>
    <Status>InActive</Status>
  </CustomerPreview>
  <CustomerPreview>
    <Address>sample string 4</Address>
    <City>
      <AreaID>cde50bdd-124e-4184-8e49-6909a2a9e232</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>8648aa70-f8ae-4310-ba25-76a65d5c6f26</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>
    </City>
    <Contact>sample string 7</Contact>
    <CustomerID>ae9aa9ec-427b-46c1-9ba9-a9ae475638e8</CustomerID>
    <IsBackendCustomer>true</IsBackendCustomer>
    <Name>sample string 3</Name>
    <ParentName>sample string 2</ParentName>
    <PhoneNumber>sample string 8</PhoneNumber>
    <Postcode>sample string 5</Postcode>
    <Status>InActive</Status>
  </CustomerPreview>
</ArrayOfCustomerPreview>

multipart/form-data

Sample:

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

ae9aa9ec-427b-46c1-9ba9-a9ae475638e8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].ParentName"

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

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

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

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

cde50bdd-124e-4184-8e49-6909a2a9e232
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].City.ParentID"

8648aa70-f8ae-4310-ba25-76a65d5c6f26
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].City.ParentName"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ae9aa9ec-427b-46c1-9ba9-a9ae475638e8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].ParentName"

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

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

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

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

cde50bdd-124e-4184-8e49-6909a2a9e232
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].City.ParentID"

8648aa70-f8ae-4310-ba25-76a65d5c6f26
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].City.ParentName"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e--