PUT Api/v{apiVersion}/Coverages/{id}
Updates a coverage
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| apiVersion | string |
None. |
Body Parameters
CoverageValues| Name | Description | Type | Additional information |
|---|---|---|---|
| MediumID | globally unique identifier |
None. |
|
| AreaID | globally unique identifier |
None. |
|
| Type | CoverageType |
None. |
|
| Value | decimal number |
None. |
|
| Status | CoverageStatus |
None. |
|
| Notes | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"MediumID": "89c33756-ce8a-4e06-b821-38b0d77d99b7",
"AreaID": "de30f792-5d2a-454f-8b07-4c7222daac33",
"Type": "GeneralAvailable",
"Value": 1.1,
"Status": "InActive",
"Notes": "sample string 2"
}
application/xml, text/xml
Sample:
<CoverageValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels"> <AreaID>de30f792-5d2a-454f-8b07-4c7222daac33</AreaID> <MediumID>89c33756-ce8a-4e06-b821-38b0d77d99b7</MediumID> <Notes>sample string 2</Notes> <Status>InActive</Status> <Type>GeneralAvailable</Type> <Value>1.1</Value> </CoverageValues>
application/x-www-form-urlencoded
Sample:
Sample not available.
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MediumID" 89c33756-ce8a-4e06-b821-38b0d77d99b7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AreaID" de30f792-5d2a-454f-8b07-4c7222daac33 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Type" GeneralAvailable --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Value" 1.1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Notes" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e--
Response Information
Resource Description
CoverageDetails| Name | Description | 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": "40218b1d-5f3f-4e6c-8091-a7860cf02244",
"Medium": {
"MediumID": "7fc51467-5f7a-4c19-9d81-0e4879c4da74",
"Supplier": {
"SupplierID": "d13b5f07-495c-468b-9576-ff8e005056f6",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"IsBackendSupplier": true,
"Contact": "sample string 5",
"PhoneNumber": "sample string 6"
},
"Category": {
"CategoryID": "365db041-4a54-4ea4-842a-2f167b4f8b37",
"MediumType": "Print",
"Name": "sample string 2",
"Status": "InActive"
},
"Name": "sample string 2",
"Type": "Print",
"SpreadType": "AdLocations",
"Status": "InActive"
},
"Area": {
"AreaID": "d0fdf35d-bece-491a-840d-e216e94f9746",
"ParentID": "f11b0e25-eb99-4693-b834-37c1164ba698",
"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-01-15T13:46:45.7557801Z",
"CreatedBy": "sample string 6",
"ModifiedAt": "2026-01-15T13:46:45.7557801Z",
"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>d0fdf35d-bece-491a-840d-e216e94f9746</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>f11b0e25-eb99-4693-b834-37c1164ba698</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>40218b1d-5f3f-4e6c-8091-a7860cf02244</CoverageID>
<CreatedAt>2026-01-15T14:46:45.7557801+01:00</CreatedAt>
<CreatedBy>sample string 6</CreatedBy>
<DataCopyright>sample string 3</DataCopyright>
<Medium>
<Category>
<CategoryID>365db041-4a54-4ea4-842a-2f167b4f8b37</CategoryID>
<MediumType>Print</MediumType>
<Name>sample string 2</Name>
<Status>InActive</Status>
</Category>
<MediumID>7fc51467-5f7a-4c19-9d81-0e4879c4da74</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>d13b5f07-495c-468b-9576-ff8e005056f6</SupplierID>
</Supplier>
<Type>Print</Type>
</Medium>
<ModifiedAt>2026-01-15T14:46:45.7557801+01: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" 40218b1d-5f3f-4e6c-8091-a7860cf02244 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Medium.MediumID" 7fc51467-5f7a-4c19-9d81-0e4879c4da74 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Medium.Supplier.SupplierID" d13b5f07-495c-468b-9576-ff8e005056f6 --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" 365db041-4a54-4ea4-842a-2f167b4f8b37 --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" d0fdf35d-bece-491a-840d-e216e94f9746 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Area.ParentID" f11b0e25-eb99-4693-b834-37c1164ba698 --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-01-15T14:46:45.7557801+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedBy" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedAt" 2026-01-15T14:46:45.7557801+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedBy" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e--