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

Gets a list of maps

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 MapPreview

Name	Type	Additional information
MapID	globally unique identifier	None.
Name	string	None.
Description	string	None.
OwnerName	string	None.
CustomerName	string	None.
StoreName	string	None.
Status	MapStatus	None.
Population	integer	None.
Mailboxes	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "MapID": "951c7bc6-ed60-4aa4-9a86-db0ca25441a3",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "OwnerName": "sample string 4",
    "CustomerName": "sample string 5",
    "StoreName": "sample string 6",
    "Status": "InActive",
    "Population": 7,
    "Mailboxes": 8
  },
  {
    "MapID": "951c7bc6-ed60-4aa4-9a86-db0ca25441a3",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "OwnerName": "sample string 4",
    "CustomerName": "sample string 5",
    "StoreName": "sample string 6",
    "Status": "InActive",
    "Population": 7,
    "Mailboxes": 8
  }
]

application/xml, text/xml

Sample:

<ArrayOfMapPreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <MapPreview>
    <CustomerName>sample string 5</CustomerName>
    <Description>sample string 3</Description>
    <Mailboxes>8</Mailboxes>
    <MapID>951c7bc6-ed60-4aa4-9a86-db0ca25441a3</MapID>
    <Name>sample string 2</Name>
    <OwnerName>sample string 4</OwnerName>
    <Population>7</Population>
    <Status>InActive</Status>
    <StoreName>sample string 6</StoreName>
  </MapPreview>
  <MapPreview>
    <CustomerName>sample string 5</CustomerName>
    <Description>sample string 3</Description>
    <Mailboxes>8</Mailboxes>
    <MapID>951c7bc6-ed60-4aa4-9a86-db0ca25441a3</MapID>
    <Name>sample string 2</Name>
    <OwnerName>sample string 4</OwnerName>
    <Population>7</Population>
    <Status>InActive</Status>
    <StoreName>sample string 6</StoreName>
  </MapPreview>
</ArrayOfMapPreview>

multipart/form-data

Sample:

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

951c7bc6-ed60-4aa4-9a86-db0ca25441a3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Name"

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

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

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

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

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

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

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

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

951c7bc6-ed60-4aa4-9a86-db0ca25441a3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Name"

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

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

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

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

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

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

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

8
--MultipartDataMediaFormatterBoundary1q2w3e--