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

Gets a list of presence items

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 CoveragePreview

Name	Type	Additional information
CoverageID	globally unique identifier	None.
Medium	MediumPreview	None.
Area	AreaPreview	None.
Value	decimal number	None.
DataCopyright	string	None.
Type	CoverageType	None.
Status	CoverageStatus	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CoverageID": "3766eca6-2f30-472d-ad65-bbeac71ab25a",
    "Medium": {
      "MediumID": "912a47ff-9da4-49e5-8808-c8e9bbde69b8",
      "Supplier": {
        "SupplierID": "fb5c2b39-d756-445a-ad42-94eb83586853",
        "ParentName": "sample string 2",
        "Name": "sample string 3",
        "Status": "InActive",
        "IsBackendSupplier": true,
        "Contact": "sample string 5",
        "PhoneNumber": "sample string 6"
      },
      "Category": {
        "CategoryID": "d5230180-00cb-4cf2-b146-b5128508ab77",
        "MediumType": "Print",
        "Name": "sample string 2",
        "Status": "InActive"
      },
      "Name": "sample string 2",
      "Type": "Print",
      "SpreadType": "AdLocations",
      "Status": "InActive"
    },
    "Area": {
      "AreaID": "161f11fe-cbdb-4078-9cde-fa8247c7288e",
      "ParentID": "96f82257-27c3-4da0-a8ed-8b7356109626",
      "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
    },
    "Value": 2.1,
    "DataCopyright": "sample string 3",
    "Type": "GeneralAvailable",
    "Status": "InActive"
  },
  {
    "CoverageID": "3766eca6-2f30-472d-ad65-bbeac71ab25a",
    "Medium": {
      "MediumID": "912a47ff-9da4-49e5-8808-c8e9bbde69b8",
      "Supplier": {
        "SupplierID": "fb5c2b39-d756-445a-ad42-94eb83586853",
        "ParentName": "sample string 2",
        "Name": "sample string 3",
        "Status": "InActive",
        "IsBackendSupplier": true,
        "Contact": "sample string 5",
        "PhoneNumber": "sample string 6"
      },
      "Category": {
        "CategoryID": "d5230180-00cb-4cf2-b146-b5128508ab77",
        "MediumType": "Print",
        "Name": "sample string 2",
        "Status": "InActive"
      },
      "Name": "sample string 2",
      "Type": "Print",
      "SpreadType": "AdLocations",
      "Status": "InActive"
    },
    "Area": {
      "AreaID": "161f11fe-cbdb-4078-9cde-fa8247c7288e",
      "ParentID": "96f82257-27c3-4da0-a8ed-8b7356109626",
      "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
    },
    "Value": 2.1,
    "DataCopyright": "sample string 3",
    "Type": "GeneralAvailable",
    "Status": "InActive"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCoveragePreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <CoveragePreview>
    <Area>
      <AreaID>161f11fe-cbdb-4078-9cde-fa8247c7288e</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>96f82257-27c3-4da0-a8ed-8b7356109626</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>
    <CoverageID>3766eca6-2f30-472d-ad65-bbeac71ab25a</CoverageID>
    <DataCopyright>sample string 3</DataCopyright>
    <Medium>
      <Category>
        <CategoryID>d5230180-00cb-4cf2-b146-b5128508ab77</CategoryID>
        <MediumType>Print</MediumType>
        <Name>sample string 2</Name>
        <Status>InActive</Status>
      </Category>
      <MediumID>912a47ff-9da4-49e5-8808-c8e9bbde69b8</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>fb5c2b39-d756-445a-ad42-94eb83586853</SupplierID>
      </Supplier>
      <Type>Print</Type>
    </Medium>
    <Status>InActive</Status>
    <Type>GeneralAvailable</Type>
    <Value>2.1</Value>
  </CoveragePreview>
  <CoveragePreview>
    <Area>
      <AreaID>161f11fe-cbdb-4078-9cde-fa8247c7288e</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>96f82257-27c3-4da0-a8ed-8b7356109626</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>
    <CoverageID>3766eca6-2f30-472d-ad65-bbeac71ab25a</CoverageID>
    <DataCopyright>sample string 3</DataCopyright>
    <Medium>
      <Category>
        <CategoryID>d5230180-00cb-4cf2-b146-b5128508ab77</CategoryID>
        <MediumType>Print</MediumType>
        <Name>sample string 2</Name>
        <Status>InActive</Status>
      </Category>
      <MediumID>912a47ff-9da4-49e5-8808-c8e9bbde69b8</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>fb5c2b39-d756-445a-ad42-94eb83586853</SupplierID>
      </Supplier>
      <Type>Print</Type>
    </Medium>
    <Status>InActive</Status>
    <Type>GeneralAvailable</Type>
    <Value>2.1</Value>
  </CoveragePreview>
</ArrayOfCoveragePreview>

multipart/form-data

Sample:

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

3766eca6-2f30-472d-ad65-bbeac71ab25a
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Medium.MediumID"

912a47ff-9da4-49e5-8808-c8e9bbde69b8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Medium.Supplier.SupplierID"

fb5c2b39-d756-445a-ad42-94eb83586853
--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"

d5230180-00cb-4cf2-b146-b5128508ab77
--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].Area.AreaID"

161f11fe-cbdb-4078-9cde-fa8247c7288e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area.ParentID"

96f82257-27c3-4da0-a8ed-8b7356109626
--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].Value"

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

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

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

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

3766eca6-2f30-472d-ad65-bbeac71ab25a
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Medium.MediumID"

912a47ff-9da4-49e5-8808-c8e9bbde69b8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Medium.Supplier.SupplierID"

fb5c2b39-d756-445a-ad42-94eb83586853
--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"

d5230180-00cb-4cf2-b146-b5128508ab77
--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].Area.AreaID"

161f11fe-cbdb-4078-9cde-fa8247c7288e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area.ParentID"

96f82257-27c3-4da0-a8ed-8b7356109626
--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].Value"

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

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

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

InActive
--MultipartDataMediaFormatterBoundary1q2w3e--