GET Api/v{apiVersion}/Coverages/{id}

Gets the coverage details

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

CoverageDetails

Name	Type	Additional information
CoverageID	globally unique identifier	None.
Medium	MediumPreview	None.
Area	AreaPreview	None.
Type	CoverageType	None.
Value	decimal number	None.
Status	CoverageStatus	None.
DataCopyright	string	None.
Notes	string	None.
CreatedAt	date	None.
CreatedBy	string	None.
ModifiedAt	date	None.
ModifiedBy	string	None.

Response Formats

application/json, text/json

Sample:

{
  "CoverageID": "51044bdf-f86f-4960-902b-83f93bbd6637",
  "Medium": {
    "MediumID": "ce8f9ef9-4e23-4f29-9521-7bba3c1b844e",
    "Supplier": {
      "SupplierID": "1ca8c5b2-4246-4e9e-85c0-a600f43bb26c",
      "ParentName": "sample string 2",
      "Name": "sample string 3",
      "Status": "InActive",
      "IsBackendSupplier": true,
      "Contact": "sample string 5",
      "PhoneNumber": "sample string 6"
    },
    "Category": {
      "CategoryID": "15a59367-28f1-4883-87bd-966cd443b98f",
      "MediumType": "Print",
      "Name": "sample string 2",
      "Status": "InActive"
    },
    "Name": "sample string 2",
    "Type": "Print",
    "SpreadType": "AdLocations",
    "Status": "InActive"
  },
  "Area": {
    "AreaID": "927d2aa0-a6a5-40f7-9cfd-a0258fe013b8",
    "ParentID": "d0767669-858f-49ba-960a-37a4c078dfd5",
    "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
  },
  "Type": "GeneralAvailable",
  "Value": 2.1,
  "Status": "InActive",
  "DataCopyright": "sample string 3",
  "Notes": "sample string 4",
  "CreatedAt": "2026-07-22T10:57:05.9014679Z",
  "CreatedBy": "sample string 6",
  "ModifiedAt": "2026-07-22T10:57:05.9014679Z",
  "ModifiedBy": "sample string 8"
}

application/xml, text/xml

Sample:

<CoverageDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
  <Area>
    <AreaID>927d2aa0-a6a5-40f7-9cfd-a0258fe013b8</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>d0767669-858f-49ba-960a-37a4c078dfd5</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>51044bdf-f86f-4960-902b-83f93bbd6637</CoverageID>
  <CreatedAt>2026-07-22T12:57:05.9014679+02:00</CreatedAt>
  <CreatedBy>sample string 6</CreatedBy>
  <DataCopyright>sample string 3</DataCopyright>
  <Medium>
    <Category>
      <CategoryID>15a59367-28f1-4883-87bd-966cd443b98f</CategoryID>
      <MediumType>Print</MediumType>
      <Name>sample string 2</Name>
      <Status>InActive</Status>
    </Category>
    <MediumID>ce8f9ef9-4e23-4f29-9521-7bba3c1b844e</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>1ca8c5b2-4246-4e9e-85c0-a600f43bb26c</SupplierID>
    </Supplier>
    <Type>Print</Type>
  </Medium>
  <ModifiedAt>2026-07-22T12:57:05.9014679+02:00</ModifiedAt>
  <ModifiedBy>sample string 8</ModifiedBy>
  <Notes>sample string 4</Notes>
  <Status>InActive</Status>
  <Type>GeneralAvailable</Type>
  <Value>2.1</Value>
</CoverageDetails>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CoverageID"

51044bdf-f86f-4960-902b-83f93bbd6637
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Medium.MediumID"

ce8f9ef9-4e23-4f29-9521-7bba3c1b844e
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Medium.Supplier.SupplierID"

1ca8c5b2-4246-4e9e-85c0-a600f43bb26c
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Medium.Supplier.ParentName"

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

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

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

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

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

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

15a59367-28f1-4883-87bd-966cd443b98f
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Medium.Category.MediumType"

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

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

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

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

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

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

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area.AreaID"

927d2aa0-a6a5-40f7-9cfd-a0258fe013b8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area.ParentID"

d0767669-858f-49ba-960a-37a4c078dfd5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area.ParentName"

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

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

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

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

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

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

Neighbourhood
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area.OwnerName"

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

9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area.Mailboxes"

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Type"

GeneralAvailable
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Value"

2.1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DataCopyright"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedAt"

2026-07-22T12:57:05.9014679+02:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedBy"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedAt"

2026-07-22T12:57:05.9014679+02:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedBy"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e--