GET api/{website}/Profile?org={org}&year={year}&lang={lang}&ind={ind}&curr={curr}

Get the Profile Information of the Utility

Request Information

URI Parameters

NameDescriptionTypeAdditional information
org

Utility Id [INT: 19940]

integer

Default value is 0

year

Year [SMALLINT: 2013]

integer

Default value is 0

lang

Language iso2 code[STRING: EN]

string

Default value is EN

ind

Comma separated value of Raw Data Ids [CSV of SMALLINT: 7,20,23,24,25,27,72, 137, 51]

string

Default value is 17,20,23,24,25,27,72,137,51

website

string

Default value is IBNET

curr

string

Default value is USD

Body Parameters

None.

Response Information

Resource Description

JsonReturnViewModelOfRawDataItemViewModelAndProfileElementsViewModel
NameDescriptionTypeAdditional information
Elements

ProfileElementsViewModel

None.

Data

Collection of RawDataItemViewModel

None.

Items

Collection of ItemsViewModel

None.

Status

StatusResultViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Elements": {
    "Name": "sample string 1",
    "DisplayName": "sample string 2",
    "GeographyName": "sample string 3",
    "City": "sample string 4",
    "Country": "sample string 5",
    "CountryId": 6,
    "MaxYear": 7,
    "MinYear": 8,
    "Lat": 1.1,
    "Long": 1.1,
    "Year": 9,
    "CurrencySymbol": "sample string 10"
  },
  "Data": [
    {
      "ItemId": 1,
      "Name": "sample string 2",
      "Units": "sample string 3",
      "Description": "sample string 4",
      "ItemType": "sample string 5",
      "Value": 1.1,
      "Text": "sample string 6",
      "Option": "sample string 7"
    },
    {
      "ItemId": 1,
      "Name": "sample string 2",
      "Units": "sample string 3",
      "Description": "sample string 4",
      "ItemType": "sample string 5",
      "Value": 1.1,
      "Text": "sample string 6",
      "Option": "sample string 7"
    }
  ],
  "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":{"Name":"sample string 1","DisplayName":"sample string 2","GeographyName":"sample string 3","City":"sample string 4","Country":"sample string 5","CountryId":6,"MaxYear":7,"MinYear":8,"Lat":1.1,"Long":1.1,"Year":9,"CurrencySymbol":"sample string 10"},"Data":[{"ItemId":1,"Name":"sample string 2","Units":"sample string 3","Description":"sample string 4","ItemType":"sample string 5","Value":1.1,"Text":"sample string 6","Option":"sample string 7"},{"ItemId":1,"Name":"sample string 2","Units":"sample string 3","Description":"sample string 4","ItemType":"sample string 5","Value":1.1,"Text":"sample string 6","Option":"sample string 7"}],"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:
<JsonReturnViewModelOfRawDataItemViewModelProfileElementsViewModelOhnnz4IO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBNetAPI.ViewModels">
  <Data>
    <RawDataItemViewModel>
      <Description>sample string 4</Description>
      <ItemId>1</ItemId>
      <ItemType>sample string 5</ItemType>
      <Name>sample string 2</Name>
      <Option>sample string 7</Option>
      <Text>sample string 6</Text>
      <Units>sample string 3</Units>
      <Value>1.1</Value>
    </RawDataItemViewModel>
    <RawDataItemViewModel>
      <Description>sample string 4</Description>
      <ItemId>1</ItemId>
      <ItemType>sample string 5</ItemType>
      <Name>sample string 2</Name>
      <Option>sample string 7</Option>
      <Text>sample string 6</Text>
      <Units>sample string 3</Units>
      <Value>1.1</Value>
    </RawDataItemViewModel>
  </Data>
  <Elements>
    <City>sample string 4</City>
    <Country>sample string 5</Country>
    <CountryId>6</CountryId>
    <CurrencySymbol>sample string 10</CurrencySymbol>
    <DisplayName>sample string 2</DisplayName>
    <GeographyName>sample string 3</GeographyName>
    <Lat>1.1</Lat>
    <Long>1.1</Long>
    <MaxYear>7</MaxYear>
    <MinYear>8</MinYear>
    <Name>sample string 1</Name>
    <Year>9</Year>
  </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>
</JsonReturnViewModelOfRawDataItemViewModelProfileElementsViewModelOhnnz4IO>