POST api/reports/metertroubleshooting

Returns Meter Troubleshooting Data based on a given property list.

Request Information

Parameters

NameDescriptionAdditional information
request

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "PropertyList": "sample string 1",
  "OracleID": "sample string 2",
  "ManagementFirmName": "sample string 3",
  "Utility": "sample string 4",
  "CheckInPeriod": 5,
  "LowConsumption": 6,
  "HighConsumption": 7,
  "ReadDate": "2025-04-03T19:15:43.3127368-06:00",
  "IncludeDispositioned": true
}

application/xml, text/xml

Sample:
<MeterTroubleshootingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <CheckInPeriod>5</CheckInPeriod>
  <HighConsumption>7</HighConsumption>
  <IncludeDispositioned>true</IncludeDispositioned>
  <LowConsumption>6</LowConsumption>
  <ManagementFirmName>sample string 3</ManagementFirmName>
  <OracleID>sample string 2</OracleID>
  <PropertyList>sample string 1</PropertyList>
  <ReadDate>2025-04-03T19:15:43.3127368-06:00</ReadDate>
  <Utility>sample string 4</Utility>
</MeterTroubleshootingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

application/json, text/json

Sample:
{
  "response": {
    "Code": "sample string 1",
    "Message": "sample string 2",
    "Description": "sample string 3",
    "Link": "sample string 4"
  },
  "meterTroubleshootingUnitJson": [
    {
      "CommunityName": "sample string 1",
      "CommunityCode": "sample string 2",
      "UnitAddress": "sample string 3",
      "UnitCode": "sample string 4",
      "UnitStatus": "sample string 5",
      "UnitTransponder": "sample string 6",
      "Utility": "sample string 7",
      "LastCheckedIn": "2025-04-03T19:15:43.3127368-06:00",
      "ThirtyDayUsage": 9.0,
      "MeterNotes": "sample string 10",
      "Troubleshooting": "sample string 11"
    },
    {
      "CommunityName": "sample string 1",
      "CommunityCode": "sample string 2",
      "UnitAddress": "sample string 3",
      "UnitCode": "sample string 4",
      "UnitStatus": "sample string 5",
      "UnitTransponder": "sample string 6",
      "Utility": "sample string 7",
      "LastCheckedIn": "2025-04-03T19:15:43.3127368-06:00",
      "ThirtyDayUsage": 9.0,
      "MeterNotes": "sample string 10",
      "Troubleshooting": "sample string 11"
    }
  ],
  "meterTroubleshootingRepeaterJson": [
    {
      "RepeaterID": "sample string 1",
      "RepeaterLocation": "sample string 2",
      "LastCheckedIn": "2025-04-03T19:15:43.3127368-06:00",
      "RepeaterNotes": "sample string 4",
      "Troubleshooting": "sample string 5"
    },
    {
      "RepeaterID": "sample string 1",
      "RepeaterLocation": "sample string 2",
      "LastCheckedIn": "2025-04-03T19:15:43.3127368-06:00",
      "RepeaterNotes": "sample string 4",
      "Troubleshooting": "sample string 5"
    }
  ],
  "systemType": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<MeterTroubleshootingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <meterTroubleshootingRepeaterJson xmlns:d2p1="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL.MeterTroubleshootingStep">
    <d2p1:MeterTroubleshootingRepeater>
      <d2p1:LastCheckedIn>2025-04-03T19:15:43.3127368-06:00</d2p1:LastCheckedIn>
      <d2p1:RepeaterID>sample string 1</d2p1:RepeaterID>
      <d2p1:RepeaterLocation>sample string 2</d2p1:RepeaterLocation>
      <d2p1:RepeaterNotes>sample string 4</d2p1:RepeaterNotes>
      <d2p1:Troubleshooting>sample string 5</d2p1:Troubleshooting>
    </d2p1:MeterTroubleshootingRepeater>
    <d2p1:MeterTroubleshootingRepeater>
      <d2p1:LastCheckedIn>2025-04-03T19:15:43.3127368-06:00</d2p1:LastCheckedIn>
      <d2p1:RepeaterID>sample string 1</d2p1:RepeaterID>
      <d2p1:RepeaterLocation>sample string 2</d2p1:RepeaterLocation>
      <d2p1:RepeaterNotes>sample string 4</d2p1:RepeaterNotes>
      <d2p1:Troubleshooting>sample string 5</d2p1:Troubleshooting>
    </d2p1:MeterTroubleshootingRepeater>
  </meterTroubleshootingRepeaterJson>
  <meterTroubleshootingUnitJson xmlns:d2p1="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL.MeterTroubleshootingStep">
    <d2p1:MeterTroubleshootingUnit>
      <d2p1:CommunityCode>sample string 2</d2p1:CommunityCode>
      <d2p1:CommunityName>sample string 1</d2p1:CommunityName>
      <d2p1:LastCheckedIn>2025-04-03T19:15:43.3127368-06:00</d2p1:LastCheckedIn>
      <d2p1:MeterNotes>sample string 10</d2p1:MeterNotes>
      <d2p1:ThirtyDayUsage>9</d2p1:ThirtyDayUsage>
      <d2p1:Troubleshooting>sample string 11</d2p1:Troubleshooting>
      <d2p1:UnitAddress>sample string 3</d2p1:UnitAddress>
      <d2p1:UnitCode>sample string 4</d2p1:UnitCode>
      <d2p1:UnitStatus>sample string 5</d2p1:UnitStatus>
      <d2p1:UnitTransponder>sample string 6</d2p1:UnitTransponder>
      <d2p1:Utility>sample string 7</d2p1:Utility>
    </d2p1:MeterTroubleshootingUnit>
    <d2p1:MeterTroubleshootingUnit>
      <d2p1:CommunityCode>sample string 2</d2p1:CommunityCode>
      <d2p1:CommunityName>sample string 1</d2p1:CommunityName>
      <d2p1:LastCheckedIn>2025-04-03T19:15:43.3127368-06:00</d2p1:LastCheckedIn>
      <d2p1:MeterNotes>sample string 10</d2p1:MeterNotes>
      <d2p1:ThirtyDayUsage>9</d2p1:ThirtyDayUsage>
      <d2p1:Troubleshooting>sample string 11</d2p1:Troubleshooting>
      <d2p1:UnitAddress>sample string 3</d2p1:UnitAddress>
      <d2p1:UnitCode>sample string 4</d2p1:UnitCode>
      <d2p1:UnitStatus>sample string 5</d2p1:UnitStatus>
      <d2p1:UnitTransponder>sample string 6</d2p1:UnitTransponder>
      <d2p1:Utility>sample string 7</d2p1:Utility>
    </d2p1:MeterTroubleshootingUnit>
  </meterTroubleshootingUnitJson>
  <response>
    <Code>sample string 1</Code>
    <Description>sample string 3</Description>
    <Link>sample string 4</Link>
    <Message>sample string 2</Message>
  </response>
  <systemType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </systemType>
</MeterTroubleshootingResponse>