GET api/{website}/PerformanceData?org={org}&ind={ind}&topX={topX}&weight={weight}&filterByCountry={filterByCountry}&filterBySize={filterBySize}&filterByDensity={filterByDensity}&filterByGdp={filterByGdp}&lang={lang}&curr={curr}&year={year}

Get a list of all the countries in the database

Request Information

URI Parameters

NameDescriptionTypeAdditional information
org

Utility Id

integer

Default value is 0

website

Name of the website to filter out data

string

Default value is IBNET

ind

comma separated values of indicators

string

Default value is 0

topX

integer

Default value is 10

weight

How to weight the averages [0 by population, 1 by denominator]

integer

Default value is 1

filterByCountry

[true | false] Only utilites from the same country

boolean

Default value is False

filterBySize

[true | false] Only utilites with 1/4 to 4 times the population of the target utility

boolean

Default value is False

filterByDensity

[true | false] Only utilites with 1/4 to 4 times the density (connections per km of pipe) of the target utility

boolean

Default value is False

filterByGdp

[true | false] Only utilites whoose level of GDP per capita of the country is 1/4 to 4 times the level of the target utility

boolean

Default value is False

lang

ISO 2 code language code [EN, ES, ...] english is default if no translation aviable.

string

Default value is EN

curr

ISO 3 code of the currency [USD, EUR, ...] USD is default is currency infromation is not aviable.

string

Default value is USD

year

integer

Default value is 0

Body Parameters

None.

Response Information

Resource Description

JsonReturnViewModelOfPerformanceDataViewModelAndPerformanceAditionalInfo
NameDescriptionTypeAdditional information
Elements

PerformanceAditionalInfo

None.

Data

Collection of PerformanceDataViewModel

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": [
    {
      "ItemId": 1,
      "Year": 2,
      "ValuePerformersTop": 1.1,
      "ValueAverage": 1.1,
      "Value": 1.1,
      "ValuePerformersBottom": 1.1,
      "MinValue": 1.1,
      "MaxValue": 1.1,
      "ValuePerformersTopNorm": 1.1,
      "ValueAverageNorm": 1.1,
      "ValueNorm": 1.1,
      "ValuePerformersBottomNorm": 1.1,
      "CountTotal": 1.1,
      "CountBigger": 1.1,
      "CountLower": 1.1,
      "TopValue": 1.1,
      "BottomValue": 1.1
    },
    {
      "ItemId": 1,
      "Year": 2,
      "ValuePerformersTop": 1.1,
      "ValueAverage": 1.1,
      "Value": 1.1,
      "ValuePerformersBottom": 1.1,
      "MinValue": 1.1,
      "MaxValue": 1.1,
      "ValuePerformersTopNorm": 1.1,
      "ValueAverageNorm": 1.1,
      "ValueNorm": 1.1,
      "ValuePerformersBottomNorm": 1.1,
      "CountTotal": 1.1,
      "CountBigger": 1.1,
      "CountLower": 1.1,
      "TopValue": 1.1,
      "BottomValue": 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":[{"ItemId":1,"Year":2,"ValuePerformersTop":1.1,"ValueAverage":1.1,"Value":1.1,"ValuePerformersBottom":1.1,"MinValue":1.1,"MaxValue":1.1,"ValuePerformersTopNorm":1.1,"ValueAverageNorm":1.1,"ValueNorm":1.1,"ValuePerformersBottomNorm":1.1,"CountTotal":1.1,"CountBigger":1.1,"CountLower":1.1,"TopValue":1.1,"BottomValue":1.1},{"ItemId":1,"Year":2,"ValuePerformersTop":1.1,"ValueAverage":1.1,"Value":1.1,"ValuePerformersBottom":1.1,"MinValue":1.1,"MaxValue":1.1,"ValuePerformersTopNorm":1.1,"ValueAverageNorm":1.1,"ValueNorm":1.1,"ValuePerformersBottomNorm":1.1,"CountTotal":1.1,"CountBigger":1.1,"CountLower":1.1,"TopValue":1.1,"BottomValue":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:
<JsonReturnViewModelOfPerformanceDataViewModelPerformanceAditionalInfoOhnnz4IO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBNetAPI.ViewModels">
  <Data>
    <PerformanceDataViewModel>
      <BottomValue>1.1</BottomValue>
      <CountBigger>1.1</CountBigger>
      <CountLower>1.1</CountLower>
      <CountTotal>1.1</CountTotal>
      <ItemId>1</ItemId>
      <MaxValue>1.1</MaxValue>
      <MinValue>1.1</MinValue>
      <TopValue>1.1</TopValue>
      <Value>1.1</Value>
      <ValueAverage>1.1</ValueAverage>
      <ValueAverageNorm>1.1</ValueAverageNorm>
      <ValueNorm>1.1</ValueNorm>
      <ValuePerformersBottom>1.1</ValuePerformersBottom>
      <ValuePerformersBottomNorm>1.1</ValuePerformersBottomNorm>
      <ValuePerformersTop>1.1</ValuePerformersTop>
      <ValuePerformersTopNorm>1.1</ValuePerformersTopNorm>
      <Year>2</Year>
    </PerformanceDataViewModel>
    <PerformanceDataViewModel>
      <BottomValue>1.1</BottomValue>
      <CountBigger>1.1</CountBigger>
      <CountLower>1.1</CountLower>
      <CountTotal>1.1</CountTotal>
      <ItemId>1</ItemId>
      <MaxValue>1.1</MaxValue>
      <MinValue>1.1</MinValue>
      <TopValue>1.1</TopValue>
      <Value>1.1</Value>
      <ValueAverage>1.1</ValueAverage>
      <ValueAverageNorm>1.1</ValueAverageNorm>
      <ValueNorm>1.1</ValueNorm>
      <ValuePerformersBottom>1.1</ValuePerformersBottom>
      <ValuePerformersBottomNorm>1.1</ValuePerformersBottomNorm>
      <ValuePerformersTop>1.1</ValuePerformersTop>
      <ValuePerformersTopNorm>1.1</ValuePerformersTopNorm>
      <Year>2</Year>
    </PerformanceDataViewModel>
  </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>
</JsonReturnViewModelOfPerformanceDataViewModelPerformanceAditionalInfoOhnnz4IO>