GET api/{website}/PerformanceData/IndicatorCorrelation?org={org}&year={year}&xAxis={xAxis}&yAxis={yAxis}&filterByCountry={filterByCountry}&filterBySize={filterBySize}&filterByDensity={filterByDensity}&filterByGdp={filterByGdp}&lang={lang}&yearCsv={yearCsv}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
org

integer

Default value is 0

website

string

Default value is IBNET

year

integer

Default value is 0

xAxis

integer

Default value is 1

yAxis

integer

Default value is 1

filterByCountry

boolean

Default value is False

filterBySize

boolean

Default value is False

filterByDensity

boolean

Default value is False

filterByGdp

boolean

Default value is False

lang

string

Default value is EN

yearCsv

string

Default value is

Body Parameters

None.

Response Information

Resource Description

JsonReturnViewModelOfCorrelationDataViewModelAndCorrelationElementsViewModel
NameDescriptionTypeAdditional information
Elements

CorrelationElementsViewModel

None.

Data

Collection of CorrelationDataViewModel

None.

Items

Collection of ItemsViewModel

None.

Status

StatusResultViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Elements": {
    "XaxisId": 1,
    "YaxisId": 2,
    "Organization": "sample string 3",
    "OrganizationShortName": "sample string 4"
  },
  "Data": [
    {
      "Id": 1,
      "Year": 2,
      "Type": "sample string 3",
      "Xaxis": 1.1,
      "Yaxis": 1.1,
      "Name": "sample string 4",
      "Code": "sample string 5",
      "Country": "sample string 6",
      "City": "sample string 7",
      "Population": 8
    },
    {
      "Id": 1,
      "Year": 2,
      "Type": "sample string 3",
      "Xaxis": 1.1,
      "Yaxis": 1.1,
      "Name": "sample string 4",
      "Code": "sample string 5",
      "Country": "sample string 6",
      "City": "sample string 7",
      "Population": 8
    }
  ],
  "Items": [
    {
      "ItemId": 1,
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Units": "sample string 5",
      "DefaultUnits": 1.1,
      "NumberFormat": "sample string 6",
      "HighIsBest": 64
    },
    {
      "ItemId": 1,
      "Code": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Units": "sample string 5",
      "DefaultUnits": 1.1,
      "NumberFormat": "sample string 6",
      "HighIsBest": 64
    }
  ],
  "Status": {
    "Status": "sample string 1",
    "StatusMessage": "sample string 2"
  }
}

text/html

Sample:
{"Elements":{"XaxisId":1,"YaxisId":2,"Organization":"sample string 3","OrganizationShortName":"sample string 4"},"Data":[{"Id":1,"Year":2,"Type":"sample string 3","Xaxis":1.1,"Yaxis":1.1,"Name":"sample string 4","Code":"sample string 5","Country":"sample string 6","City":"sample string 7","Population":8},{"Id":1,"Year":2,"Type":"sample string 3","Xaxis":1.1,"Yaxis":1.1,"Name":"sample string 4","Code":"sample string 5","Country":"sample string 6","City":"sample string 7","Population":8}],"Items":[{"ItemId":1,"Code":"sample string 2","Name":"sample string 3","Description":"sample string 4","Units":"sample string 5","DefaultUnits":1.1,"NumberFormat":"sample string 6","HighIsBest":64},{"ItemId":1,"Code":"sample string 2","Name":"sample string 3","Description":"sample string 4","Units":"sample string 5","DefaultUnits":1.1,"NumberFormat":"sample string 6","HighIsBest":64}],"Status":{"Status":"sample string 1","StatusMessage":"sample string 2"}}

application/xml, text/xml

Sample:
<JsonReturnViewModelOfCorrelationDataViewModelCorrelationElementsViewModelOhnnz4IO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBNetAPI.ViewModels">
  <Data>
    <CorrelationDataViewModel>
      <City>sample string 7</City>
      <Code>sample string 5</Code>
      <Country>sample string 6</Country>
      <Id>1</Id>
      <Name>sample string 4</Name>
      <Population>8</Population>
      <Type>sample string 3</Type>
      <Xaxis>1.1</Xaxis>
      <Yaxis>1.1</Yaxis>
      <Year>2</Year>
    </CorrelationDataViewModel>
    <CorrelationDataViewModel>
      <City>sample string 7</City>
      <Code>sample string 5</Code>
      <Country>sample string 6</Country>
      <Id>1</Id>
      <Name>sample string 4</Name>
      <Population>8</Population>
      <Type>sample string 3</Type>
      <Xaxis>1.1</Xaxis>
      <Yaxis>1.1</Yaxis>
      <Year>2</Year>
    </CorrelationDataViewModel>
  </Data>
  <Elements>
    <Organization>sample string 3</Organization>
    <OrganizationShortName>sample string 4</OrganizationShortName>
    <XaxisId>1</XaxisId>
    <YaxisId>2</YaxisId>
  </Elements>
  <Items>
    <ItemsViewModel>
      <Code>sample string 2</Code>
      <DefaultUnits>1.1</DefaultUnits>
      <Description>sample string 4</Description>
      <HighIsBest>64</HighIsBest>
      <ItemId>1</ItemId>
      <Name>sample string 3</Name>
      <NumberFormat>sample string 6</NumberFormat>
      <Units>sample string 5</Units>
    </ItemsViewModel>
    <ItemsViewModel>
      <Code>sample string 2</Code>
      <DefaultUnits>1.1</DefaultUnits>
      <Description>sample string 4</Description>
      <HighIsBest>64</HighIsBest>
      <ItemId>1</ItemId>
      <Name>sample string 3</Name>
      <NumberFormat>sample string 6</NumberFormat>
      <Units>sample string 5</Units>
    </ItemsViewModel>
  </Items>
  <Status>
    <Status>sample string 1</Status>
    <StatusMessage>sample string 2</StatusMessage>
  </Status>
</JsonReturnViewModelOfCorrelationDataViewModelCorrelationElementsViewModelOhnnz4IO>