GET Api/v{apiVersion}/Maps/{id}/CoverageFilterValues

Gets a list of available circulation filter values for this map

Request Information

URI Parameters

Name	Description	Type	Additional information
id		globally unique identifier	Required
apiVersion		string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of CoverageFilterValue

Name	Type	Additional information
Map	MapPreview	None.
Supplier	SupplierPreview	None.
Medium	MediumPreview	None.
MinOfValue	decimal number	None.
MaxOfValue	decimal number	None.
AvgOfValue	decimal number	None.
SumOfValue	decimal number	None.
Type	CoverageType	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Map": {
      "MapID": "fe571488-c3c9-49bf-bced-7037b76768d2",
      "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
    },
    "Supplier": {
      "SupplierID": "1f948075-029b-4d98-b6e2-1d6290e97f6b",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "IsBackendSupplier": true,
      "Contact": "sample string 5",
      "PhoneNumber": "sample string 6"
    },
    "Medium": {
      "MediumID": "6b1f3dbb-0ee4-4ce8-a183-5a7f82a8cb74",
      "Supplier": {
        "SupplierID": "1f948075-029b-4d98-b6e2-1d6290e97f6b",
        "ParentName": "sample string 2",
        "Name": "sample string 3",
        "Status": "InActive",
        "IsBackendSupplier": true,
        "Contact": "sample string 5",
        "PhoneNumber": "sample string 6"
      },
      "Category": {
        "CategoryID": "3b708164-16ee-4950-b005-4f7820edc1d7",
        "MediumType": "Print",
        "Name": "sample string 2",
        "Status": "InActive"
      },
      "Name": "sample string 2",
      "Type": "Print",
      "SpreadType": "AdLocations",
      "Status": "InActive"
    },
    "MinOfValue": 1.1,
    "MaxOfValue": 2.1,
    "AvgOfValue": 3.1,
    "SumOfValue": 4.1,
    "Type": "GeneralAvailable"
  },
  {
    "Map": {
      "MapID": "fe571488-c3c9-49bf-bced-7037b76768d2",
      "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
    },
    "Supplier": {
      "SupplierID": "1f948075-029b-4d98-b6e2-1d6290e97f6b",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "IsBackendSupplier": true,
      "Contact": "sample string 5",
      "PhoneNumber": "sample string 6"
    },
    "Medium": {
      "MediumID": "6b1f3dbb-0ee4-4ce8-a183-5a7f82a8cb74",
      "Supplier": {
        "SupplierID": "1f948075-029b-4d98-b6e2-1d6290e97f6b",
        "ParentName": "sample string 2",
        "Name": "sample string 3",
        "Status": "InActive",
        "IsBackendSupplier": true,
        "Contact": "sample string 5",
        "PhoneNumber": "sample string 6"
      },
      "Category": {
        "CategoryID": "3b708164-16ee-4950-b005-4f7820edc1d7",
        "MediumType": "Print",
        "Name": "sample string 2",
        "Status": "InActive"
      },
      "Name": "sample string 2",
      "Type": "Print",
      "SpreadType": "AdLocations",
      "Status": "InActive"
    },
    "MinOfValue": 1.1,
    "MaxOfValue": 2.1,
    "AvgOfValue": 3.1,
    "SumOfValue": 4.1,
    "Type": "GeneralAvailable"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCoverageFilterValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <CoverageFilterValue>
    <AvgOfValue>3.1</AvgOfValue>
    <Map>
      <CustomerName>sample string 5</CustomerName>
      <Description>sample string 3</Description>
      <Mailboxes>8</Mailboxes>
      <MapID>fe571488-c3c9-49bf-bced-7037b76768d2</MapID>
      <Name>sample string 2</Name>
      <OwnerName>sample string 4</OwnerName>
      <Population>7</Population>
      <Status>InActive</Status>
      <StoreName>sample string 6</StoreName>
    </Map>
    <MaxOfValue>2.1</MaxOfValue>
    <Medium>
      <Category>
        <CategoryID>3b708164-16ee-4950-b005-4f7820edc1d7</CategoryID>
        <MediumType>Print</MediumType>
        <Name>sample string 2</Name>
        <Status>InActive</Status>
      </Category>
      <MediumID>6b1f3dbb-0ee4-4ce8-a183-5a7f82a8cb74</MediumID>
      <Name>sample string 2</Name>
      <SpreadType>AdLocations</SpreadType>
      <Status>InActive</Status>
      <Supplier>
        <Contact>sample string 5</Contact>
        <IsBackendSupplier>true</IsBackendSupplier>
        <Name>sample string 3</Name>
        <ParentName>sample string 2</ParentName>
        <PhoneNumber>sample string 6</PhoneNumber>
        <Status>InActive</Status>
        <SupplierID>1f948075-029b-4d98-b6e2-1d6290e97f6b</SupplierID>
      </Supplier>
      <Type>Print</Type>
    </Medium>
    <MinOfValue>1.1</MinOfValue>
    <SumOfValue>4.1</SumOfValue>
    <Supplier>
      <Contact>sample string 5</Contact>
      <IsBackendSupplier>true</IsBackendSupplier>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <PhoneNumber>sample string 6</PhoneNumber>
      <Status>InActive</Status>
      <SupplierID>1f948075-029b-4d98-b6e2-1d6290e97f6b</SupplierID>
    </Supplier>
    <Type>GeneralAvailable</Type>
  </CoverageFilterValue>
  <CoverageFilterValue>
    <AvgOfValue>3.1</AvgOfValue>
    <Map>
      <CustomerName>sample string 5</CustomerName>
      <Description>sample string 3</Description>
      <Mailboxes>8</Mailboxes>
      <MapID>fe571488-c3c9-49bf-bced-7037b76768d2</MapID>
      <Name>sample string 2</Name>
      <OwnerName>sample string 4</OwnerName>
      <Population>7</Population>
      <Status>InActive</Status>
      <StoreName>sample string 6</StoreName>
    </Map>
    <MaxOfValue>2.1</MaxOfValue>
    <Medium>
      <Category>
        <CategoryID>3b708164-16ee-4950-b005-4f7820edc1d7</CategoryID>
        <MediumType>Print</MediumType>
        <Name>sample string 2</Name>
        <Status>InActive</Status>
      </Category>
      <MediumID>6b1f3dbb-0ee4-4ce8-a183-5a7f82a8cb74</MediumID>
      <Name>sample string 2</Name>
      <SpreadType>AdLocations</SpreadType>
      <Status>InActive</Status>
      <Supplier>
        <Contact>sample string 5</Contact>
        <IsBackendSupplier>true</IsBackendSupplier>
        <Name>sample string 3</Name>
        <ParentName>sample string 2</ParentName>
        <PhoneNumber>sample string 6</PhoneNumber>
        <Status>InActive</Status>
        <SupplierID>1f948075-029b-4d98-b6e2-1d6290e97f6b</SupplierID>
      </Supplier>
      <Type>Print</Type>
    </Medium>
    <MinOfValue>1.1</MinOfValue>
    <SumOfValue>4.1</SumOfValue>
    <Supplier>
      <Contact>sample string 5</Contact>
      <IsBackendSupplier>true</IsBackendSupplier>
      <Name>sample string 3</Name>
      <ParentName>sample string 2</ParentName>
      <PhoneNumber>sample string 6</PhoneNumber>
      <Status>InActive</Status>
      <SupplierID>1f948075-029b-4d98-b6e2-1d6290e97f6b</SupplierID>
    </Supplier>
    <Type>GeneralAvailable</Type>
  </CoverageFilterValue>
</ArrayOfCoverageFilterValue>

multipart/form-data

Sample:

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

fe571488-c3c9-49bf-bced-7037b76768d2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Map.Name"

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

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

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

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

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

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

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

8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Supplier.SupplierID"

1f948075-029b-4d98-b6e2-1d6290e97f6b
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Supplier.ParentName"

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

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

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

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

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

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

6b1f3dbb-0ee4-4ce8-a183-5a7f82a8cb74
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Medium.Supplier.SupplierID"

1f948075-029b-4d98-b6e2-1d6290e97f6b
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Medium.Supplier.ParentName"

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

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

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

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

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

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

3b708164-16ee-4950-b005-4f7820edc1d7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Medium.Category.MediumType"

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

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

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

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

Print
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Medium.SpreadType"

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

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

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

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

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

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

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

fe571488-c3c9-49bf-bced-7037b76768d2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Map.Name"

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

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

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

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

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

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

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

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

1f948075-029b-4d98-b6e2-1d6290e97f6b
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Supplier.ParentName"

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

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

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

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

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

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

6b1f3dbb-0ee4-4ce8-a183-5a7f82a8cb74
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Medium.Supplier.SupplierID"

1f948075-029b-4d98-b6e2-1d6290e97f6b
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Medium.Supplier.ParentName"

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

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

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

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

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

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

3b708164-16ee-4950-b005-4f7820edc1d7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Medium.Category.MediumType"

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

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

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

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

Print
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Medium.SpreadType"

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

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

1.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].MaxOfValue"

2.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].AvgOfValue"

3.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].SumOfValue"

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

GeneralAvailable
--MultipartDataMediaFormatterBoundary1q2w3e--