SSHost

<back to all web services

GetMetersStatusRequest

Requires Authentication
Required role:ApiUser
The following routes are available for this service:
All Verbs/Meter/GetMetersStatus
GetMetersStatusRequest Parameters:
NameParameterData TypeRequiredDescription
OrgNamequerystringNo
AreaNamequerystringNo
PageIndexqueryintNo
PageSizequeryintNo
IBaseRequest Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
OptionsformRequestOptionsNo
RequestOptions Parameters:
NameParameterData TypeRequiredDescription
SendNoWaitformboolNo
RequestTimeoutformintNo
DebugformboolNo
GetMetersStatusResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<MeterStatus>No
IBaseResult Parameters:
NameParameterData TypeRequiredDescription
CommandformstringNo
StatusformstringNo
ErrorMessageformstringNo
ErrListformList<long>No
DeviceListformList<DeviceData>No
DeviceData Parameters:
NameParameterData TypeRequiredDescription
ActionNameformstringNo
DeviceNumberformstringNo
ActionResultformstringNo
ByteDataformbyte[]No
ByteResultformbyte[]No
ErrorMessageformstringNo
ConnectStatusformintNo
ByteDataHstrformstringNo
MeterStatus Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
SampleTimeformDateTime?No
LocalTimeformDateTime?No
OrgformstringNo
AreaformstringNo
GatewayNameformstringNo
GatewayAddressformstringNo
GatewayUIDformlongNo
AckformstringNo
NameformstringNo
SIMformstringNo
DataSampingPeriodformintNo
CurrentAformdouble?No
CurrentBformdouble?No
CurrentCformdouble?No
VoltageAformdouble?No
VoltageBformdouble?No
VoltageCformdouble?No
PowerAformdouble?No
PowerBformdouble?No
PowerCformdouble?No
PowerTformdouble?No
PowerFactorAformdouble?No
PowerFactorBformdouble?No
PowerFactorCformdouble?No
PowerFactorTformdouble?No
PowerConsumptionAformdouble?No
PowerConsumptionBformdouble?No
PowerConsumptionCformdouble?No
PowerConsumptionTformdouble?No
ActiveEnergyLine123Rate1formdouble?No
ActiveEnergyLine123Rate2formdouble?No
ActiveEnergyLine123Rate3formdouble?No
ApparantEnergyLine123Rate1formdouble?No
ApparantEnergyLine123Rate2formdouble?No
ApparantEnergyLine123Rate3formdouble?No
ActiveEnergyLine123Rate1WHformdouble?No
ActiveEnergyLine123Rate2WHformdouble?No
ActiveEnergyLine123Rate3WHformdouble?No
ApparantEnergyLine123Rate1VAHformdouble?No
ApparantEnergyLine123Rate2VAHformdouble?No
ApparantEnergyLine123Rate3VAHformdouble?No
StatusformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Meter/GetMetersStatus HTTP/1.1 
Host: 122.112.255.199 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetMetersStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Command>String</Command>
  <Options>
    <Debug>false</Debug>
    <RequestTimeout>0</RequestTimeout>
    <SendNoWait>false</SendNoWait>
  </Options>
  <AreaName>String</AreaName>
  <OrgName>String</OrgName>
  <PageIndex>0</PageIndex>
  <PageSize>0</PageSize>
</GetMetersStatusRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetMetersStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LedServer.SS">
  <Command>String</Command>
  <DeviceList xmlns:d2p1="http://schemas.datacontract.org/2004/07/LedServer.Models">
    <d2p1:DeviceData>
      <d2p1:ActionName>String</d2p1:ActionName>
      <d2p1:ActionResult>String</d2p1:ActionResult>
      <d2p1:ByteData>AA==</d2p1:ByteData>
      <d2p1:ByteResult>AA==</d2p1:ByteResult>
      <d2p1:ConnectStatus>0</d2p1:ConnectStatus>
      <d2p1:DeviceNumber>String</d2p1:DeviceNumber>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
    </d2p1:DeviceData>
  </DeviceList>
  <ErrList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </ErrList>
  <ErrorMessage>String</ErrorMessage>
  <Status>String</Status>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/LedServer.SqlModels">
    <d2p1:MeterStatus>
      <d2p1:Ack>String</d2p1:Ack>
      <d2p1:ActiveEnergyLine123Rate1>0</d2p1:ActiveEnergyLine123Rate1>
      <d2p1:ActiveEnergyLine123Rate1WH>0</d2p1:ActiveEnergyLine123Rate1WH>
      <d2p1:ActiveEnergyLine123Rate2>0</d2p1:ActiveEnergyLine123Rate2>
      <d2p1:ActiveEnergyLine123Rate2WH>0</d2p1:ActiveEnergyLine123Rate2WH>
      <d2p1:ActiveEnergyLine123Rate3>0</d2p1:ActiveEnergyLine123Rate3>
      <d2p1:ActiveEnergyLine123Rate3WH>0</d2p1:ActiveEnergyLine123Rate3WH>
      <d2p1:ApparantEnergyLine123Rate1>0</d2p1:ApparantEnergyLine123Rate1>
      <d2p1:ApparantEnergyLine123Rate1VAH>0</d2p1:ApparantEnergyLine123Rate1VAH>
      <d2p1:ApparantEnergyLine123Rate2>0</d2p1:ApparantEnergyLine123Rate2>
      <d2p1:ApparantEnergyLine123Rate2VAH>0</d2p1:ApparantEnergyLine123Rate2VAH>
      <d2p1:ApparantEnergyLine123Rate3>0</d2p1:ApparantEnergyLine123Rate3>
      <d2p1:ApparantEnergyLine123Rate3VAH>0</d2p1:ApparantEnergyLine123Rate3VAH>
      <d2p1:Area>String</d2p1:Area>
      <d2p1:CurrentA>0</d2p1:CurrentA>
      <d2p1:CurrentB>0</d2p1:CurrentB>
      <d2p1:CurrentC>0</d2p1:CurrentC>
      <d2p1:DataSampingPeriod>0</d2p1:DataSampingPeriod>
      <d2p1:GatewayAddress>String</d2p1:GatewayAddress>
      <d2p1:GatewayName>String</d2p1:GatewayName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LocalTime>0001-01-01T00:00:00</d2p1:LocalTime>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Org>String</d2p1:Org>
      <d2p1:PowerA>0</d2p1:PowerA>
      <d2p1:PowerB>0</d2p1:PowerB>
      <d2p1:PowerC>0</d2p1:PowerC>
      <d2p1:PowerConsumptionA>0</d2p1:PowerConsumptionA>
      <d2p1:PowerConsumptionB>0</d2p1:PowerConsumptionB>
      <d2p1:PowerConsumptionC>0</d2p1:PowerConsumptionC>
      <d2p1:PowerConsumptionT>0</d2p1:PowerConsumptionT>
      <d2p1:PowerFactorA>0</d2p1:PowerFactorA>
      <d2p1:PowerFactorB>0</d2p1:PowerFactorB>
      <d2p1:PowerFactorC>0</d2p1:PowerFactorC>
      <d2p1:PowerFactorT>0</d2p1:PowerFactorT>
      <d2p1:PowerT>0</d2p1:PowerT>
      <d2p1:SIM>String</d2p1:SIM>
      <d2p1:SampleTime>0001-01-01T00:00:00</d2p1:SampleTime>
      <d2p1:VoltageA>0</d2p1:VoltageA>
      <d2p1:VoltageB>0</d2p1:VoltageB>
      <d2p1:VoltageC>0</d2p1:VoltageC>
    </d2p1:MeterStatus>
  </Data>
</GetMetersStatusResponse>