GET Api/v{apiVersion}/Figures?areaId={areaId}&query={query}&pageSize={pageSize}&currentPage={currentPage}&orderBy={orderBy}&descending={descending}

Request Information

URI Parameters

Name	Type	Additional information
areaId	globally unique identifier	Required
query	string	None.
pageSize	integer	None.
currentPage	integer	None.
orderBy	string	None.
descending	boolean	None.
apiVersion	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of FigurePreview

Name	Type	Additional information
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:

[
  {
    "FigureID": "93838bd2-b2a0-4024-a71b-0c4495a4e086",
    "Area_AreaID": "7acc707e-f924-4100-a954-3df56d319b29",
    "Area_Name": "sample string 3",
    "Area_FullName": "sample string 4",
    "Area_Type": "Country",
    "Area_NumberOfInhabitants": 5,
    "Map_MapID": "b50c624d-5490-471c-8f33-d46ba757b5b5",
    "Map_Name": "sample string 7",
    "Item": "sample string 8",
    "Category": "sample string 9",
    "LocalizedName": "sample string 10",
    "LocalizedCategory": "sample string 11",
    "LocalizedSubCategory": "sample string 12",
    "LocalizedDescription": "sample string 13",
    "Value": 14.1,
    "CountryValue": 1.1,
    "HistoryTrendValue": 1.1,
    "ValueType": "Percent",
    "DisplayValue": "sample string 15",
    "HistoryTrendDisplayValue": "sample string 16",
    "DataSource": "sample string 17",
    "DataYear": 18,
    "IsCalculated": true,
    "IsBuildIn": true,
    "HasHistory": true
  },
  {
    "FigureID": "93838bd2-b2a0-4024-a71b-0c4495a4e086",
    "Area_AreaID": "7acc707e-f924-4100-a954-3df56d319b29",
    "Area_Name": "sample string 3",
    "Area_FullName": "sample string 4",
    "Area_Type": "Country",
    "Area_NumberOfInhabitants": 5,
    "Map_MapID": "b50c624d-5490-471c-8f33-d46ba757b5b5",
    "Map_Name": "sample string 7",
    "Item": "sample string 8",
    "Category": "sample string 9",
    "LocalizedName": "sample string 10",
    "LocalizedCategory": "sample string 11",
    "LocalizedSubCategory": "sample string 12",
    "LocalizedDescription": "sample string 13",
    "Value": 14.1,
    "CountryValue": 1.1,
    "HistoryTrendValue": 1.1,
    "ValueType": "Percent",
    "DisplayValue": "sample string 15",
    "HistoryTrendDisplayValue": "sample string 16",
    "DataSource": "sample string 17",
    "DataYear": 18,
    "IsCalculated": true,
    "IsBuildIn": true,
    "HasHistory": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfFigurePreview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mapalize.Api.ViewModels">
  <FigurePreview>
    <Area_AreaID>7acc707e-f924-4100-a954-3df56d319b29</Area_AreaID>
    <Area_FullName>sample string 4</Area_FullName>
    <Area_Name>sample string 3</Area_Name>
    <Area_NumberOfInhabitants>5</Area_NumberOfInhabitants>
    <Area_Type>Country</Area_Type>
    <Category>sample string 9</Category>
    <CountryValue>1.1</CountryValue>
    <DataSource>sample string 17</DataSource>
    <DataYear>18</DataYear>
    <DisplayValue>sample string 15</DisplayValue>
    <FigureID>93838bd2-b2a0-4024-a71b-0c4495a4e086</FigureID>
    <HasHistory>true</HasHistory>
    <HistoryTrendDisplayValue>sample string 16</HistoryTrendDisplayValue>
    <HistoryTrendValue>1.1</HistoryTrendValue>
    <IsBuildIn>true</IsBuildIn>
    <IsCalculated>true</IsCalculated>
    <Item>sample string 8</Item>
    <LocalizedCategory>sample string 11</LocalizedCategory>
    <LocalizedDescription>sample string 13</LocalizedDescription>
    <LocalizedName>sample string 10</LocalizedName>
    <LocalizedSubCategory>sample string 12</LocalizedSubCategory>
    <Map_MapID>b50c624d-5490-471c-8f33-d46ba757b5b5</Map_MapID>
    <Map_Name>sample string 7</Map_Name>
    <Value>14.1</Value>
    <ValueType>Percent</ValueType>
  </FigurePreview>
  <FigurePreview>
    <Area_AreaID>7acc707e-f924-4100-a954-3df56d319b29</Area_AreaID>
    <Area_FullName>sample string 4</Area_FullName>
    <Area_Name>sample string 3</Area_Name>
    <Area_NumberOfInhabitants>5</Area_NumberOfInhabitants>
    <Area_Type>Country</Area_Type>
    <Category>sample string 9</Category>
    <CountryValue>1.1</CountryValue>
    <DataSource>sample string 17</DataSource>
    <DataYear>18</DataYear>
    <DisplayValue>sample string 15</DisplayValue>
    <FigureID>93838bd2-b2a0-4024-a71b-0c4495a4e086</FigureID>
    <HasHistory>true</HasHistory>
    <HistoryTrendDisplayValue>sample string 16</HistoryTrendDisplayValue>
    <HistoryTrendValue>1.1</HistoryTrendValue>
    <IsBuildIn>true</IsBuildIn>
    <IsCalculated>true</IsCalculated>
    <Item>sample string 8</Item>
    <LocalizedCategory>sample string 11</LocalizedCategory>
    <LocalizedDescription>sample string 13</LocalizedDescription>
    <LocalizedName>sample string 10</LocalizedName>
    <LocalizedSubCategory>sample string 12</LocalizedSubCategory>
    <Map_MapID>b50c624d-5490-471c-8f33-d46ba757b5b5</Map_MapID>
    <Map_Name>sample string 7</Map_Name>
    <Value>14.1</Value>
    <ValueType>Percent</ValueType>
  </FigurePreview>
</ArrayOfFigurePreview>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].FigureID"

93838bd2-b2a0-4024-a71b-0c4495a4e086
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area_AreaID"

7acc707e-f924-4100-a954-3df56d319b29
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area_Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area_FullName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area_Type"

Country
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Area_NumberOfInhabitants"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Map_MapID"

b50c624d-5490-471c-8f33-d46ba757b5b5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Map_Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Item"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Category"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].LocalizedName"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].LocalizedCategory"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].LocalizedSubCategory"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].LocalizedDescription"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].Value"

14,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].CountryValue"

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

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

Percent
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].DisplayValue"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].HistoryTrendDisplayValue"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].DataSource"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].DataYear"

18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].IsCalculated"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].IsBuildIn"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].HasHistory"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].FigureID"

93838bd2-b2a0-4024-a71b-0c4495a4e086
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area_AreaID"

7acc707e-f924-4100-a954-3df56d319b29
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area_Name"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area_FullName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area_Type"

Country
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Area_NumberOfInhabitants"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Map_MapID"

b50c624d-5490-471c-8f33-d46ba757b5b5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Map_Name"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Item"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Category"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].LocalizedName"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].LocalizedCategory"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].LocalizedSubCategory"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].LocalizedDescription"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Value"

14,1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].CountryValue"

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

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

Percent
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].DisplayValue"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].HistoryTrendDisplayValue"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].DataSource"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].DataYear"

18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].IsCalculated"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].IsBuildIn"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].HasHistory"

True
--MultipartDataMediaFormatterBoundary1q2w3e--