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": "c179ca9b-94fc-4776-8d9e-2d613276719c",
"AreaID": "def6b32c-c93d-4259-8db0-3594a1ba51f4",
"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>def6b32c-c93d-4259-8db0-3594a1ba51f4</AreaID> <MediumID>c179ca9b-94fc-4776-8d9e-2d613276719c</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" c179ca9b-94fc-4776-8d9e-2d613276719c --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="AreaID" def6b32c-c93d-4259-8db0-3594a1ba51f4 --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": "941e7165-cd5c-4fd4-8d0e-ae1a61d03cb4",
"Medium": {
"MediumID": "eb69d97e-25b4-4cb1-867d-1373a1c828c1",
"Supplier": {
"SupplierID": "2e3fcafa-d4fb-4aa2-851e-173ebb04929f",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"IsBackendSupplier": true,
"Contact": "sample string 5",
"PhoneNumber": "sample string 6"
},
"Category": {
"CategoryID": "d3118461-c413-453f-a1a6-fe49ff1e498d",
"MediumType": "Print",
"Name": "sample string 2",
"Status": "InActive"
},
"Name": "sample string 2",
"Type": "Print",
"SpreadType": "AdLocations",
"Status": "InActive"
},
"Area": {
"AreaID": "7f5cc50b-a4a2-47a3-ab28-1c5a8877b75e",
"ParentID": "123ccfdd-6e9a-4066-9566-db26a67821eb",
"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-15T14:14:55.7834582Z",
"CreatedBy": "sample string 6",
"ModifiedAt": "2026-01-15T14:14:55.7834582Z",
"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>7f5cc50b-a4a2-47a3-ab28-1c5a8877b75e</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>123ccfdd-6e9a-4066-9566-db26a67821eb</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>941e7165-cd5c-4fd4-8d0e-ae1a61d03cb4</CoverageID>
<CreatedAt>2026-01-15T15:14:55.7834582+01:00</CreatedAt>
<CreatedBy>sample string 6</CreatedBy>
<DataCopyright>sample string 3</DataCopyright>
<Medium>
<Category>
<CategoryID>d3118461-c413-453f-a1a6-fe49ff1e498d</CategoryID>
<MediumType>Print</MediumType>
<Name>sample string 2</Name>
<Status>InActive</Status>
</Category>
<MediumID>eb69d97e-25b4-4cb1-867d-1373a1c828c1</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>2e3fcafa-d4fb-4aa2-851e-173ebb04929f</SupplierID>
</Supplier>
<Type>Print</Type>
</Medium>
<ModifiedAt>2026-01-15T15:14:55.7834582+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" 941e7165-cd5c-4fd4-8d0e-ae1a61d03cb4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Medium.MediumID" eb69d97e-25b4-4cb1-867d-1373a1c828c1 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Medium.Supplier.SupplierID" 2e3fcafa-d4fb-4aa2-851e-173ebb04929f --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" d3118461-c413-453f-a1a6-fe49ff1e498d --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" 7f5cc50b-a4a2-47a3-ab28-1c5a8877b75e --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Area.ParentID" 123ccfdd-6e9a-4066-9566-db26a67821eb --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-15T15:14:55.7834582+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedBy" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedAt" 2026-01-15T15:14:55.7834582+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedBy" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e--