GET api/{website}/PerformanceData/DataItems?org={org}&topX={topX}&weight={weight}&filterByCountry={filterByCountry}&filterBySize={filterBySize}&filterByDensity={filterByDensity}&filterByGdp={filterByGdp}&ind={ind}&year={year}&lang={lang}&curr={curr}
Get a list od performer Organizations and the values for a given indicator
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
org | integer |
Default value is 0 |
|
website | string |
Default value is IBNET |
|
topX | integer |
Default value is 10 |
|
weight | 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 |
|
ind | string |
Default value is 0 |
|
year | integer |
Default value is 0 |
|
lang |
ISO 2 code language code [EN, ES, ...] english is default if no translation aviable |
string |
Default value is EN |
curr | string |
Default value is USD |
Body Parameters
None.
Response Information
Resource Description
JsonReturnViewModelOfOrganizationsDataItemViewModelAndPerformanceAditionalInfoName | Description | Type | Additional information |
---|---|---|---|
Elements | PerformanceAditionalInfo |
None. |
|
Data | Collection of OrganizationsDataItemViewModel |
None. |
|
Items | Collection of ItemsViewModel |
None. |
|
Status | StatusResultViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{ "Elements": { "Organization": "sample string 1", "OrganizationId": 2, "CurrencyName": "sample string 3", "CurrencyCode": "sample string 4", "CurrencySymbol": "sample string 5", "OrganizationShortName": "sample string 6" }, "Data": [ { "Id": 1, "OrganizationId": 2, "ItemId": 3, "Year": 4, "Code": "sample string 5", "Name": "sample string 6", "City": "sample string 7", "Value": 1.1, "Units": "sample string 8", "ItemClass": "sample string 9", "DefaultUnits": 1.1 }, { "Id": 1, "OrganizationId": 2, "ItemId": 3, "Year": 4, "Code": "sample string 5", "Name": "sample string 6", "City": "sample string 7", "Value": 1.1, "Units": "sample string 8", "ItemClass": "sample string 9", "DefaultUnits": 1.1 } ], "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":{"Organization":"sample string 1","OrganizationId":2,"CurrencyName":"sample string 3","CurrencyCode":"sample string 4","CurrencySymbol":"sample string 5","OrganizationShortName":"sample string 6"},"Data":[{"Id":1,"OrganizationId":2,"ItemId":3,"Year":4,"Code":"sample string 5","Name":"sample string 6","City":"sample string 7","Value":1.1,"Units":"sample string 8","ItemClass":"sample string 9","DefaultUnits":1.1},{"Id":1,"OrganizationId":2,"ItemId":3,"Year":4,"Code":"sample string 5","Name":"sample string 6","City":"sample string 7","Value":1.1,"Units":"sample string 8","ItemClass":"sample string 9","DefaultUnits":1.1}],"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:
<JsonReturnViewModelOfOrganizationsDataItemViewModelPerformanceAditionalInfoOhnnz4IO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBNetAPI.ViewModels"> <Data> <OrganizationsDataItemViewModel> <City>sample string 7</City> <Code>sample string 5</Code> <DefaultUnits>1.1</DefaultUnits> <Id>1</Id> <ItemClass>sample string 9</ItemClass> <ItemId>3</ItemId> <Name>sample string 6</Name> <OrganizationId>2</OrganizationId> <Units>sample string 8</Units> <Value>1.1</Value> <Year>4</Year> </OrganizationsDataItemViewModel> <OrganizationsDataItemViewModel> <City>sample string 7</City> <Code>sample string 5</Code> <DefaultUnits>1.1</DefaultUnits> <Id>1</Id> <ItemClass>sample string 9</ItemClass> <ItemId>3</ItemId> <Name>sample string 6</Name> <OrganizationId>2</OrganizationId> <Units>sample string 8</Units> <Value>1.1</Value> <Year>4</Year> </OrganizationsDataItemViewModel> </Data> <Elements> <CurrencyCode>sample string 4</CurrencyCode> <CurrencyName>sample string 3</CurrencyName> <CurrencySymbol>sample string 5</CurrencySymbol> <Organization>sample string 1</Organization> <OrganizationId>2</OrganizationId> <OrganizationShortName>sample string 6</OrganizationShortName> </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> </JsonReturnViewModelOfOrganizationsDataItemViewModelPerformanceAditionalInfoOhnnz4IO>