POST api/meter/consumption

Returns meter consumption data for a management firm, property list (csv), and a read date.

Request Information

Parameters

Name	Description	Additional information
request		Define this parameter in the request body.

Request body formats

application/json

Sample:

{
  "PropertyList": "sample string 1",
  "ManagementFirmName": "sample string 2",
  "ReadDate": "sample DateTime 2024-04-30T14:20:13.2607675-06:00"
}

text/json

Sample:

{
  "PropertyList": "sample string 1",
  "ManagementFirmName": "sample string 2",
  "ReadDate": "2024-09-19T11:48:08.6684034-06:00"
}

application/xml, text/xml

Sample:

<ConsumptionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <ManagementFirmName>sample string 2</ManagementFirmName>
  <PropertyList>sample string 1</PropertyList>
  <ReadDate>2024-09-19T11:48:08.6684034-06:00</ReadDate>
</ConsumptionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

application/json

Sample:

{
  "CommunityName": "sample string 1",
  "Ledger": "sample string 2",
  "UnitNumber": "sample string 3",
  "UtilityType": "sample string 4",
  "MeterType": "sample string 5",
  "PhysicalHardwareData": "sample string 6",
  "TransponderNumber": "sample string 7",
  "TransponderType": "sample string 8",
  "UnitOfMeasure": "sample string 9",
  "ReadDate": "sample DateTime 2024-04-30T14:20:13.2607675-06:00",
  "ReadValue": "sample decimal 11.0",
  "UsageValue": "sample decimal 12.0"
}

text/json

Sample:

{
  "response": {
    "Code": "sample string 1",
    "Message": "sample string 2",
    "Description": "sample string 3",
    "Link": "sample string 4"
  },
  "consumptionDataJson": [
    {
      "CommunityName": "sample string 1",
      "Ledger": "sample string 2",
      "UnitNumber": "sample string 3",
      "UtilityType": "sample string 4",
      "MeterType": "sample string 5",
      "PhysicalHardwareData": "sample string 6",
      "TransponderNumber": "sample string 7",
      "TransponderType": "sample string 8",
      "UnitOfMeasure": "sample string 9",
      "ReadDate": "2024-09-19T11:48:08.6684034-06:00",
      "ReadValue": 11.0,
      "UsageValue": 12.0
    },
    {
      "CommunityName": "sample string 1",
      "Ledger": "sample string 2",
      "UnitNumber": "sample string 3",
      "UtilityType": "sample string 4",
      "MeterType": "sample string 5",
      "PhysicalHardwareData": "sample string 6",
      "TransponderNumber": "sample string 7",
      "TransponderType": "sample string 8",
      "UnitOfMeasure": "sample string 9",
      "ReadDate": "2024-09-19T11:48:08.6684034-06:00",
      "ReadValue": 11.0,
      "UsageValue": 12.0
    }
  ]
}

application/xml, text/xml

Sample:

<ConsumptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <consumptionDataJson>
    <Consumption>
      <CommunityName>sample string 1</CommunityName>
      <Ledger>sample string 2</Ledger>
      <MeterType>sample string 5</MeterType>
      <PhysicalHardwareData>sample string 6</PhysicalHardwareData>
      <ReadDate>2024-09-19T11:48:08.6684034-06:00</ReadDate>
      <ReadValue>11</ReadValue>
      <TransponderNumber>sample string 7</TransponderNumber>
      <TransponderType>sample string 8</TransponderType>
      <UnitNumber>sample string 3</UnitNumber>
      <UnitOfMeasure>sample string 9</UnitOfMeasure>
      <UsageValue>12</UsageValue>
      <UtilityType>sample string 4</UtilityType>
    </Consumption>
    <Consumption>
      <CommunityName>sample string 1</CommunityName>
      <Ledger>sample string 2</Ledger>
      <MeterType>sample string 5</MeterType>
      <PhysicalHardwareData>sample string 6</PhysicalHardwareData>
      <ReadDate>2024-09-19T11:48:08.6684034-06:00</ReadDate>
      <ReadValue>11</ReadValue>
      <TransponderNumber>sample string 7</TransponderNumber>
      <TransponderType>sample string 8</TransponderType>
      <UnitNumber>sample string 3</UnitNumber>
      <UnitOfMeasure>sample string 9</UnitOfMeasure>
      <UsageValue>12</UsageValue>
      <UtilityType>sample string 4</UtilityType>
    </Consumption>
  </consumptionDataJson>
  <response>
    <Code>sample string 1</Code>
    <Description>sample string 3</Description>
    <Link>sample string 4</Link>
    <Message>sample string 2</Message>
  </response>
</ConsumptionResponse>