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

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

FigureDetails

Name	Type	Additional information
Area	AreaPreview	None.
Map	MapPreview	None.
OwnerName	string	None.
History	Dictionary of integer [key] and decimal number [value]	None.
Notes	string	None.
CreatedAt	date	None.
CreatedBy	string	None.
ModifiedAt	date	None.
ModifiedBy	string	None.
FigureID	globally unique identifier	None.
Area_AreaID	globally unique identifier	None.
Area_Name	string	None.
Area_FullName	string	None.
Area_Type	AreaType	None.
Area_NumberOfInhabitants	integer	None.
Map_MapID	globally unique identifier	None.
Map_Name	string	None.
Item	string	None.
Category	string	None.
LocalizedName	string	None.
LocalizedCategory	string	None.
LocalizedSubCategory	string	None.
LocalizedDescription	string	None.
Value	decimal number	None.
CountryValue	decimal number	None.
HistoryTrendValue	decimal number	None.
ValueType	ValueType	None.
DisplayValue	string	None.
HistoryTrendDisplayValue	string	None.
DataSource	string	None.
DataYear	integer	None.
IsCalculated	boolean	None.
IsBuildIn	boolean	None.
HasHistory	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Area": {
    "AreaID": "21ff3aa0-69e2-4b65-894c-fdcd04b33a18",
    "Name": "sample string 2",
    "Category": "sample string 3",
    "FullName": "sample string 4",
    "Reference": "sample string 5",
    "IsBuildIn": true,
    "OwnerName": "sample string 7",
    "User_UserID": "90ec3485-b8ae-4c35-b0ad-944b68ebab14",
    "User_FullName": "sample string 8",
    "Type": "Country",
    "Status": "InActive",
    "NumberOfInhabitants": 9,
    "NumberOfAddresses": 10,
    "Surface": 11.1
  },
  "Map": {
    "MapID": "6dce4c8d-77a4-4388-a89c-fe1c6397cfaa",
    "Name": "sample string 2",
    "IsBuildIn": true,
    "OwnerName": "sample string 4",
    "Location_LocationID": "7067d887-a370-47c0-9efa-1943a7195b59",
    "Location_Name": "sample string 5",
    "Location_FullName": "sample string 6",
    "Status": "InActive",
    "LevelOfDetail": "Country",
    "CreationDate": "2025-12-28T08:35:07.4505118Z",
    "IsLocked": true
  },
  "OwnerName": "sample string 1",
  "History": {
    "1": 2.1,
    "3": 4.1
  },
  "Notes": "sample string 2",
  "CreatedAt": "2025-12-28T08:35:07.4505118Z",
  "CreatedBy": "sample string 4",
  "ModifiedAt": "2025-12-28T08:35:07.4505118Z",
  "ModifiedBy": "sample string 6",
  "FigureID": "5aceca25-8307-45ac-99a8-8887b5c5e3eb",
  "Area_AreaID": "e975dd80-1e0c-4ce2-95e8-1d012aaec58d",
  "Area_Name": "sample string 9",
  "Area_FullName": "sample string 10",
  "Area_Type": "Country",
  "Area_NumberOfInhabitants": 11,
  "Map_MapID": "b5e5a2e9-b100-4443-8f1a-aeeb33555341",
  "Map_Name": "sample string 13",
  "Item": "sample string 14",
  "Category": "sample string 15",
  "LocalizedName": "sample string 16",
  "LocalizedCategory": "sample string 17",
  "LocalizedSubCategory": "sample string 18",
  "LocalizedDescription": "sample string 19",
  "Value": 20.1,
  "CountryValue": 1.1,
  "HistoryTrendValue": 1.1,
  "ValueType": "Percent",
  "DisplayValue": "sample string 21",
  "HistoryTrendDisplayValue": "sample string 22",
  "DataSource": "sample string 23",
  "DataYear": 24,
  "IsCalculated": true,
  "IsBuildIn": true,
  "HasHistory": true
}

application/xml, text/xml

Sample:

<FigureDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mapalize.Api.ViewModels">
  <Area_AreaID>e975dd80-1e0c-4ce2-95e8-1d012aaec58d</Area_AreaID>
  <Area_FullName>sample string 10</Area_FullName>
  <Area_Name>sample string 9</Area_Name>
  <Area_NumberOfInhabitants>11</Area_NumberOfInhabitants>
  <Area_Type>Country</Area_Type>
  <Category>sample string 15</Category>
  <CountryValue>1.1</CountryValue>
  <DataSource>sample string 23</DataSource>
  <DataYear>24</DataYear>
  <DisplayValue>sample string 21</DisplayValue>
  <FigureID>5aceca25-8307-45ac-99a8-8887b5c5e3eb</FigureID>
  <HasHistory>true</HasHistory>
  <HistoryTrendDisplayValue>sample string 22</HistoryTrendDisplayValue>
  <HistoryTrendValue>1.1</HistoryTrendValue>
  <IsBuildIn>true</IsBuildIn>
  <IsCalculated>true</IsCalculated>
  <Item>sample string 14</Item>
  <LocalizedCategory>sample string 17</LocalizedCategory>
  <LocalizedDescription>sample string 19</LocalizedDescription>
  <LocalizedName>sample string 16</LocalizedName>
  <LocalizedSubCategory>sample string 18</LocalizedSubCategory>
  <Map_MapID>b5e5a2e9-b100-4443-8f1a-aeeb33555341</Map_MapID>
  <Map_Name>sample string 13</Map_Name>
  <Value>20.1</Value>
  <ValueType>Percent</ValueType>
  <Area>
    <AreaID>21ff3aa0-69e2-4b65-894c-fdcd04b33a18</AreaID>
    <Category>sample string 3</Category>
    <FullName>sample string 4</FullName>
    <IsBuildIn>true</IsBuildIn>
    <Name>sample string 2</Name>
    <NumberOfAddresses>10</NumberOfAddresses>
    <NumberOfInhabitants>9</NumberOfInhabitants>
    <OwnerName>sample string 7</OwnerName>
    <Reference>sample string 5</Reference>
    <Status>InActive</Status>
    <Surface>11.1</Surface>
    <Type>Country</Type>
    <User_FullName>sample string 8</User_FullName>
    <User_UserID>90ec3485-b8ae-4c35-b0ad-944b68ebab14</User_UserID>
  </Area>
  <CreatedAt>2025-12-28T09:35:07.4505118+01:00</CreatedAt>
  <CreatedBy>sample string 4</CreatedBy>
  <History xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfshortfloat>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>2.1</d2p1:Value>
    </d2p1:KeyValueOfshortfloat>
    <d2p1:KeyValueOfshortfloat>
      <d2p1:Key>3</d2p1:Key>
      <d2p1:Value>4.1</d2p1:Value>
    </d2p1:KeyValueOfshortfloat>
  </History>
  <Map>
    <CreationDate>2025-12-28T09:35:07.4505118+01:00</CreationDate>
    <IsBuildIn>true</IsBuildIn>
    <IsLocked>true</IsLocked>
    <LevelOfDetail>Country</LevelOfDetail>
    <Location_FullName>sample string 6</Location_FullName>
    <Location_LocationID>7067d887-a370-47c0-9efa-1943a7195b59</Location_LocationID>
    <Location_Name>sample string 5</Location_Name>
    <MapID>6dce4c8d-77a4-4388-a89c-fe1c6397cfaa</MapID>
    <Name>sample string 2</Name>
    <OwnerName>sample string 4</OwnerName>
    <Status>InActive</Status>
  </Map>
  <ModifiedAt>2025-12-28T09:35:07.4505118+01:00</ModifiedAt>
  <ModifiedBy>sample string 6</ModifiedBy>
  <Notes>sample string 2</Notes>
  <OwnerName>sample string 1</OwnerName>
</FigureDetails>

multipart/form-data

Sample:

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

21ff3aa0-69e2-4b65-894c-fdcd04b33a18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area.Name"

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

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

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

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

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

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

90ec3485-b8ae-4c35-b0ad-944b68ebab14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area.User_FullName"

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

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

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

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

10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area.Surface"

11,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.MapID"

6dce4c8d-77a4-4388-a89c-fe1c6397cfaa
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.IsBuildIn"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.OwnerName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.Location_LocationID"

7067d887-a370-47c0-9efa-1943a7195b59
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.Location_Name"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.Location_FullName"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.Status"

InActive
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.LevelOfDetail"

Country
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.CreationDate"

2025-12-28T09:35:07.4505118+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map.IsLocked"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OwnerName"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="History[0].Key"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="History[0].Value"

2,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="History[1].Key"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="History[1].Value"

4,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Notes"

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

2025-12-28T09:35:07.4505118+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CreatedBy"

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

2025-12-28T09:35:07.4505118+01:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ModifiedBy"

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

5aceca25-8307-45ac-99a8-8887b5c5e3eb
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area_AreaID"

e975dd80-1e0c-4ce2-95e8-1d012aaec58d
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area_Name"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area_FullName"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area_Type"

Country
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Area_NumberOfInhabitants"

11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map_MapID"

b5e5a2e9-b100-4443-8f1a-aeeb33555341
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Map_Name"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Item"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Category"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="LocalizedName"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="LocalizedCategory"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="LocalizedSubCategory"

sample string 18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="LocalizedDescription"

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Value"

20,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CountryValue"

1,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="HistoryTrendValue"

1,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ValueType"

Percent
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DisplayValue"

sample string 21
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="HistoryTrendDisplayValue"

sample string 22
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DataSource"

sample string 23
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DataYear"

24
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsCalculated"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsBuildIn"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="HasHistory"

True
--MultipartDataMediaFormatterBoundary1q2w3e--