POST Api/SmartMeterDashboard/GetDashboardData

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
MeterNumber	string	None.
Username	string	None.
Password	string	None.
DeviceManufacturer	string	None.
DeviceModel	string	None.
DeviceSDKInt	string	None.
DeviceSDKVersion	string	None.

Request Formats

application/json, text/json

Sample:

{
  "MeterNumber": "sample string 1",
  "Username": "sample string 2",
  "Password": "sample string 3",
  "DeviceManufacturer": "sample string 4",
  "DeviceModel": "sample string 5",
  "DeviceSDKInt": "sample string 6",
  "DeviceSDKVersion": "sample string 7"
}

application/xml, text/xml

Sample:

<SmartMeterDashboardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <DeviceManufacturer>sample string 4</DeviceManufacturer>
  <DeviceModel>sample string 5</DeviceModel>
  <DeviceSDKInt>sample string 6</DeviceSDKInt>
  <DeviceSDKVersion>sample string 7</DeviceSDKVersion>
  <Password>sample string 3</Password>
  <Username>sample string 2</Username>
  <MeterNumber>sample string 1</MeterNumber>
</SmartMeterDashboardRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SmartMeterDashboardRequest'.

Response Information

Resource Description

SmartMeterDashboardResponse

Name	Type	Additional information
MeterConnected	boolean	None.
AvailableCreditAboveThreshold	boolean	None.
CardData	Collection of SmartMeterDashboardCardData	None.
AnnualOverview	Collection of ConsumptionDataModel	None.
DailyOverview	Collection of ConsumptionDataModel	None.
HourlyOverview	Collection of ConsumptionDataModel	None.
Success	boolean	None.
ErrorMessage	string	None.
ServerDateTime	string	None.
ErrorType	Errors	None.

Response Formats

application/json, text/json

Sample:

{
  "MeterConnected": true,
  "AvailableCreditAboveThreshold": true,
  "CardData": [
    {
      "Header": "sample string 1",
      "Value": "sample string 2",
      "SubValue": "sample string 3",
      "DateUpdated": "2026-05-17T03:28:15.0312102+02:00",
      "DisplayIndex": 5
    },
    {
      "Header": "sample string 1",
      "Value": "sample string 2",
      "SubValue": "sample string 3",
      "DateUpdated": "2026-05-17T03:28:15.0312102+02:00",
      "DisplayIndex": 5
    }
  ],
  "AnnualOverview": [
    {
      "Date": "2026-05-17T03:28:15.0312102+02:00",
      "ConsumptionValue": "sample string 2",
      "ReactiveConsumptionValue": "sample string 3"
    },
    {
      "Date": "2026-05-17T03:28:15.0312102+02:00",
      "ConsumptionValue": "sample string 2",
      "ReactiveConsumptionValue": "sample string 3"
    }
  ],
  "DailyOverview": [
    {
      "Date": "2026-05-17T03:28:15.0312102+02:00",
      "ConsumptionValue": "sample string 2",
      "ReactiveConsumptionValue": "sample string 3"
    },
    {
      "Date": "2026-05-17T03:28:15.0312102+02:00",
      "ConsumptionValue": "sample string 2",
      "ReactiveConsumptionValue": "sample string 3"
    }
  ],
  "HourlyOverview": [
    {
      "Date": "2026-05-17T03:28:15.0312102+02:00",
      "ConsumptionValue": "sample string 2",
      "ReactiveConsumptionValue": "sample string 3"
    },
    {
      "Date": "2026-05-17T03:28:15.0312102+02:00",
      "ConsumptionValue": "sample string 2",
      "ReactiveConsumptionValue": "sample string 3"
    }
  ],
  "Success": true,
  "ErrorMessage": "sample string 4",
  "ServerDateTime": "sample string 5",
  "ErrorType": 0
}

application/xml, text/xml

Sample:

<SmartMeterDashboardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPWAssistMobileAPI.Models">
  <ErrorMessage>sample string 4</ErrorMessage>
  <ErrorType>SystemError</ErrorType>
  <ServerDateTime>sample string 5</ServerDateTime>
  <Success>true</Success>
  <AnnualOverview>
    <ConsumptionDataModel>
      <ConsumptionValue>sample string 2</ConsumptionValue>
      <Date>2026-05-17T03:28:15.0312102+02:00</Date>
      <ReactiveConsumptionValue>sample string 3</ReactiveConsumptionValue>
    </ConsumptionDataModel>
    <ConsumptionDataModel>
      <ConsumptionValue>sample string 2</ConsumptionValue>
      <Date>2026-05-17T03:28:15.0312102+02:00</Date>
      <ReactiveConsumptionValue>sample string 3</ReactiveConsumptionValue>
    </ConsumptionDataModel>
  </AnnualOverview>
  <AvailableCreditAboveThreshold>true</AvailableCreditAboveThreshold>
  <CardData>
    <SmartMeterDashboardCardData>
      <DateUpdated>2026-05-17T03:28:15.0312102+02:00</DateUpdated>
      <DisplayIndex>5</DisplayIndex>
      <Header>sample string 1</Header>
      <SubValue>sample string 3</SubValue>
      <Value>sample string 2</Value>
    </SmartMeterDashboardCardData>
    <SmartMeterDashboardCardData>
      <DateUpdated>2026-05-17T03:28:15.0312102+02:00</DateUpdated>
      <DisplayIndex>5</DisplayIndex>
      <Header>sample string 1</Header>
      <SubValue>sample string 3</SubValue>
      <Value>sample string 2</Value>
    </SmartMeterDashboardCardData>
  </CardData>
  <DailyOverview>
    <ConsumptionDataModel>
      <ConsumptionValue>sample string 2</ConsumptionValue>
      <Date>2026-05-17T03:28:15.0312102+02:00</Date>
      <ReactiveConsumptionValue>sample string 3</ReactiveConsumptionValue>
    </ConsumptionDataModel>
    <ConsumptionDataModel>
      <ConsumptionValue>sample string 2</ConsumptionValue>
      <Date>2026-05-17T03:28:15.0312102+02:00</Date>
      <ReactiveConsumptionValue>sample string 3</ReactiveConsumptionValue>
    </ConsumptionDataModel>
  </DailyOverview>
  <HourlyOverview>
    <ConsumptionDataModel>
      <ConsumptionValue>sample string 2</ConsumptionValue>
      <Date>2026-05-17T03:28:15.0312102+02:00</Date>
      <ReactiveConsumptionValue>sample string 3</ReactiveConsumptionValue>
    </ConsumptionDataModel>
    <ConsumptionDataModel>
      <ConsumptionValue>sample string 2</ConsumptionValue>
      <Date>2026-05-17T03:28:15.0312102+02:00</Date>
      <ReactiveConsumptionValue>sample string 3</ReactiveConsumptionValue>
    </ConsumptionDataModel>
  </HourlyOverview>
  <MeterConnected>true</MeterConnected>
</SmartMeterDashboardResponse>