GET Api/v{apiVersion}/Maps/{id}
Gets the map 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
MapDetails| Name | Description | Type | Additional information |
|---|---|---|---|
| MapID | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| Status | MapStatus |
None. |
|
| Operator | OperatorPreview |
None. |
|
| Customer | CustomerPreview |
None. |
|
| Store | StorePreview |
None. |
|
| OwnerName | string |
None. |
|
| GeographyCopyright | string |
None. |
|
| Population | integer |
None. |
|
| Mailboxes | integer |
None. |
|
| Notes | string |
None. |
|
| CreatedAt | date |
None. |
|
| CreatedBy | string |
None. |
|
| ModifiedAt | date |
None. |
|
| ModifiedBy | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"MapID": "ebf082b5-60e4-4536-af2f-8b56cd61c3a9",
"Name": "sample string 2",
"Description": "sample string 3",
"Status": "InActive",
"Operator": {
"OperatorID": "11271be0-fc4f-49ee-a17e-17d8518b2dde",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"Address": "sample string 4",
"Postcode": "sample string 5",
"City": {
"AreaID": "248c794c-973a-4be5-b0ad-46e24e39f707",
"ParentID": "ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d",
"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
},
"PhoneNumber": "sample string 6",
"EmailAddress": "sample string 7"
},
"Customer": {
"CustomerID": "b46a98aa-5242-4b1e-97b0-4b936d7384c3",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"Address": "sample string 4",
"City": {
"AreaID": "248c794c-973a-4be5-b0ad-46e24e39f707",
"ParentID": "ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d",
"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
},
"Postcode": "sample string 5",
"IsBackendCustomer": true,
"Contact": "sample string 7",
"PhoneNumber": "sample string 8"
},
"Store": {
"StoreID": "6c53d420-7d36-4347-b8fe-7806c6592169",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Customer": {
"CustomerID": "b46a98aa-5242-4b1e-97b0-4b936d7384c3",
"ParentName": "sample string 2",
"Name": "sample string 3",
"Status": "InActive",
"Address": "sample string 4",
"City": {
"AreaID": "248c794c-973a-4be5-b0ad-46e24e39f707",
"ParentID": "ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d",
"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
},
"Postcode": "sample string 5",
"IsBackendCustomer": true,
"Contact": "sample string 7",
"PhoneNumber": "sample string 8"
},
"Status": "InActive",
"Address": "sample string 4",
"City": {
"AreaID": "248c794c-973a-4be5-b0ad-46e24e39f707",
"ParentID": "ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d",
"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
},
"Postcode": "sample string 5",
"Contact": "sample string 6",
"PhoneNumber": "sample string 7",
"MarketAreaName": "sample string 8",
"IsAttentionNeeded": true
},
"OwnerName": "sample string 4",
"GeographyCopyright": "sample string 5",
"Population": 6,
"Mailboxes": 7,
"Notes": "sample string 8",
"CreatedAt": "2026-01-15T13:44:04.2227042Z",
"CreatedBy": "sample string 10",
"ModifiedAt": "2026-01-15T13:44:04.2227042Z",
"ModifiedBy": "sample string 12"
}
application/xml, text/xml
Sample:
<MapDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hier.Api.ViewModels">
<CreatedAt>2026-01-15T14:44:04.2227042+01:00</CreatedAt>
<CreatedBy>sample string 10</CreatedBy>
<Customer>
<Address>sample string 4</Address>
<City>
<AreaID>248c794c-973a-4be5-b0ad-46e24e39f707</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>ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d</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>
</City>
<Contact>sample string 7</Contact>
<CustomerID>b46a98aa-5242-4b1e-97b0-4b936d7384c3</CustomerID>
<IsBackendCustomer>true</IsBackendCustomer>
<Name>sample string 3</Name>
<ParentName>sample string 2</ParentName>
<PhoneNumber>sample string 8</PhoneNumber>
<Postcode>sample string 5</Postcode>
<Status>InActive</Status>
</Customer>
<Description>sample string 3</Description>
<GeographyCopyright>sample string 5</GeographyCopyright>
<Mailboxes>7</Mailboxes>
<MapID>ebf082b5-60e4-4536-af2f-8b56cd61c3a9</MapID>
<ModifiedAt>2026-01-15T14:44:04.2227042+01:00</ModifiedAt>
<ModifiedBy>sample string 12</ModifiedBy>
<Name>sample string 2</Name>
<Notes>sample string 8</Notes>
<Operator>
<Address>sample string 4</Address>
<City>
<AreaID>248c794c-973a-4be5-b0ad-46e24e39f707</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>ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d</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>
</City>
<EmailAddress>sample string 7</EmailAddress>
<Name>sample string 3</Name>
<OperatorID>11271be0-fc4f-49ee-a17e-17d8518b2dde</OperatorID>
<ParentName>sample string 2</ParentName>
<PhoneNumber>sample string 6</PhoneNumber>
<Postcode>sample string 5</Postcode>
<Status>InActive</Status>
</Operator>
<OwnerName>sample string 4</OwnerName>
<Population>6</Population>
<Status>InActive</Status>
<Store>
<Address>sample string 4</Address>
<City>
<AreaID>248c794c-973a-4be5-b0ad-46e24e39f707</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>ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d</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>
</City>
<Contact>sample string 6</Contact>
<Customer>
<Address>sample string 4</Address>
<City>
<AreaID>248c794c-973a-4be5-b0ad-46e24e39f707</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>ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d</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>
</City>
<Contact>sample string 7</Contact>
<CustomerID>b46a98aa-5242-4b1e-97b0-4b936d7384c3</CustomerID>
<IsBackendCustomer>true</IsBackendCustomer>
<Name>sample string 3</Name>
<ParentName>sample string 2</ParentName>
<PhoneNumber>sample string 8</PhoneNumber>
<Postcode>sample string 5</Postcode>
<Status>InActive</Status>
</Customer>
<IsAttentionNeeded>true</IsAttentionNeeded>
<MarketAreaName>sample string 8</MarketAreaName>
<Name>sample string 3</Name>
<ParentName>sample string 2</ParentName>
<PhoneNumber>sample string 7</PhoneNumber>
<Postcode>sample string 5</Postcode>
<Status>InActive</Status>
<StoreID>6c53d420-7d36-4347-b8fe-7806c6592169</StoreID>
</Store>
</MapDetails>
multipart/form-data
Sample:
--MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="MapID" ebf082b5-60e4-4536-af2f-8b56cd61c3a9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Name" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Description" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.OperatorID" 11271be0-fc4f-49ee-a17e-17d8518b2dde --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.Address" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.Postcode" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.AreaID" 248c794c-973a-4be5-b0ad-46e24e39f707 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.ParentID" ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.SupplierName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.CustomerName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.StoreName" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Code" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Name" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Type" Neighbourhood --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.OwnerName" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Population" 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.City.Mailboxes" 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.PhoneNumber" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Operator.EmailAddress" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.CustomerID" b46a98aa-5242-4b1e-97b0-4b936d7384c3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.Address" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.AreaID" 248c794c-973a-4be5-b0ad-46e24e39f707 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.ParentID" ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.SupplierName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.CustomerName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.StoreName" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.Code" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.Name" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.Type" Neighbourhood --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.OwnerName" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.Population" 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.City.Mailboxes" 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.Postcode" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.IsBackendCustomer" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.Contact" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Customer.PhoneNumber" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.StoreID" 6c53d420-7d36-4347-b8fe-7806c6592169 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.CustomerID" b46a98aa-5242-4b1e-97b0-4b936d7384c3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.Name" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.Address" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.AreaID" 248c794c-973a-4be5-b0ad-46e24e39f707 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.ParentID" ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.SupplierName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.CustomerName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.StoreName" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.Code" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.Name" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.Type" Neighbourhood --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.OwnerName" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.Population" 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.City.Mailboxes" 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.Postcode" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.IsBackendCustomer" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.Contact" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Customer.PhoneNumber" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Address" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.AreaID" 248c794c-973a-4be5-b0ad-46e24e39f707 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.ParentID" ebbcd9c5-b768-4d9d-bdc5-c9cc1648fa3d --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.ParentName" sample string 2 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.SupplierName" sample string 3 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.CustomerName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.StoreName" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.Code" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.Name" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.Type" Neighbourhood --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.Status" InActive --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.OwnerName" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.Population" 9 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.City.Mailboxes" 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Postcode" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.Contact" sample string 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.PhoneNumber" sample string 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.MarketAreaName" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Store.IsAttentionNeeded" True --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="OwnerName" sample string 4 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="GeographyCopyright" sample string 5 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Population" 6 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Mailboxes" 7 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="Notes" sample string 8 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedAt" 2026-01-15T14:44:04.2227042+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="CreatedBy" sample string 10 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedAt" 2026-01-15T14:44:04.2227042+01:00 --MultipartDataMediaFormatterBoundary1q2w3e Content-Disposition: form-data; name="ModifiedBy" sample string 12 --MultipartDataMediaFormatterBoundary1q2w3e--