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

Request Information

URI Parameters

Name	Type	Additional information
targetAreaId	globally unique identifier	Required
compareAreaId	globally unique identifier	None.
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 FigureCompareResultItemDetails

Name	Type	Additional information
Item	string	None.
LocalizedName	string	None.
LocalizedCategory	string	None.
LocalizedSubCategory	string	None.
LocalizedDescription	string	None.
Category	string	None.
ValueType	ValueType	None.
TargetValue	decimal number	None.
CompareValue	decimal number	None.
Delta	decimal number	None.
TargetAreaID	globally unique identifier	None.
CompareAreaID	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Item": "sample string 1",
    "LocalizedName": "sample string 2",
    "LocalizedCategory": "sample string 3",
    "LocalizedSubCategory": "sample string 4",
    "LocalizedDescription": "sample string 5",
    "Category": "sample string 6",
    "ValueType": "Percent",
    "TargetValue": 7.1,
    "CompareValue": 8.1,
    "Delta": 9.1,
    "TargetAreaID": "5cb4441d-de96-4cea-b687-5063164afe61",
    "CompareAreaID": "27613bf2-a528-4219-8e25-4f140333102c"
  },
  {
    "Item": "sample string 1",
    "LocalizedName": "sample string 2",
    "LocalizedCategory": "sample string 3",
    "LocalizedSubCategory": "sample string 4",
    "LocalizedDescription": "sample string 5",
    "Category": "sample string 6",
    "ValueType": "Percent",
    "TargetValue": 7.1,
    "CompareValue": 8.1,
    "Delta": 9.1,
    "TargetAreaID": "5cb4441d-de96-4cea-b687-5063164afe61",
    "CompareAreaID": "27613bf2-a528-4219-8e25-4f140333102c"
  }
]

application/xml, text/xml

Sample:

<ArrayOfFigureCompareResultItemDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mapalize.Api.ViewModels">
  <FigureCompareResultItemDetails>
    <Category>sample string 6</Category>
    <CompareAreaID>27613bf2-a528-4219-8e25-4f140333102c</CompareAreaID>
    <CompareValue>8.1</CompareValue>
    <Delta>9.1</Delta>
    <Item>sample string 1</Item>
    <LocalizedCategory>sample string 3</LocalizedCategory>
    <LocalizedDescription>sample string 5</LocalizedDescription>
    <LocalizedName>sample string 2</LocalizedName>
    <LocalizedSubCategory>sample string 4</LocalizedSubCategory>
    <TargetAreaID>5cb4441d-de96-4cea-b687-5063164afe61</TargetAreaID>
    <TargetValue>7.1</TargetValue>
    <ValueType>Percent</ValueType>
  </FigureCompareResultItemDetails>
  <FigureCompareResultItemDetails>
    <Category>sample string 6</Category>
    <CompareAreaID>27613bf2-a528-4219-8e25-4f140333102c</CompareAreaID>
    <CompareValue>8.1</CompareValue>
    <Delta>9.1</Delta>
    <Item>sample string 1</Item>
    <LocalizedCategory>sample string 3</LocalizedCategory>
    <LocalizedDescription>sample string 5</LocalizedDescription>
    <LocalizedName>sample string 2</LocalizedName>
    <LocalizedSubCategory>sample string 4</LocalizedSubCategory>
    <TargetAreaID>5cb4441d-de96-4cea-b687-5063164afe61</TargetAreaID>
    <TargetValue>7.1</TargetValue>
    <ValueType>Percent</ValueType>
  </FigureCompareResultItemDetails>
</ArrayOfFigureCompareResultItemDetails>

multipart/form-data

Sample:

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

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

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

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

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

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

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

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

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

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

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

5cb4441d-de96-4cea-b687-5063164afe61
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[0].CompareAreaID"

27613bf2-a528-4219-8e25-4f140333102c
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].Item"

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

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

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

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

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

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

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

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

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

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

5cb4441d-de96-4cea-b687-5063164afe61
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="[1].CompareAreaID"

27613bf2-a528-4219-8e25-4f140333102c
--MultipartDataMediaFormatterBoundary1q2w3e--