Web Service Documentation / Categories / Meter Services / Get Waste Data
Updated on August 8, 2016
This web service retrieves waste data for a specific meter. The meter must already be shared with you. The waste data is returned in sets of 120. An optional date range can be specified to return a certain set of waste data records.
23.0
GET
/meter/(meterId)/wasteData?page=(page)&startDate=(YYYY-MM-DD)&endDate=(YYYY-MM-DD)
Field Name | Value | Comments |
---|---|---|
Authorization | Basic credentials |
Yes
Parameter Name | Description |
---|---|
endDate | Optional. Indicates the end date of a custom date range to retrieve waste data. Must be a valid date formatted as YYYY-MM-DD. |
meterId | Id to the meter |
page | Optional. Indicates the page number set of results to retrieve. This is typically omitted on the initial call and is provided if the results are paginated. |
startDate | Optional. Indicates the start date of a custom date range to retrieve waste data. Must be a valid date formatted as YYYY-MM-DD. |
Request/Response | Schema Name |
---|---|
Request | None |
Response | wasteData.xsd |
The following example retrieves waste information for a meter that has an id of 100. If you want to just retrieve waste records that cover a date range of January 1st, 2011 to December 31st, 2011 then the following URL parameters should be provided: startDate=2011-01-01&endDate=2011-12-31
GET /meter/100/wasteData
The following example returns the first set of 120 waste data records for a meter and provides a link to the next set. For example purposes, assume that over 20 records are returned.
<?xml version="1.0" encoding="UTF-8"?>
<wasteDataList>
<wasteData estimatedValue="true">
<audit>
<createdBy>ACME</createdBy>
<createdDate>2016-06-02T15:08:52.663-04:00</createdDate>
<lastUpdatedBy>ACME</lastUpdatedBy>
<lastUpdatedDate>2016-06-02T15:08:52.663-04:00</lastUpdatedDate>
</audit>
<id>783569361</id>
<startDate>2013-01-01</startDate>
<endDate>2013-01-31</endDate>
<quantity>50</quantity>
<cost>100</cost>
<disposalDestination>
<id>597370</id>
<incinerationPercentage>25</incinerationPercentage>
<landfillPercentage>25</landfillPercentage>
<unknownDestPercentage>25</unknownDestPercentage>
<wasteToEnergyPercentage>25</wasteToEnergyPercentage>
</disposalDestination>
</wasteData>
<wasteData estimatedValue="true">
<audit>
<createdBy>ACME</createdBy>
<createdDate>2016-06-02T15:08:52.663-04:00</createdDate>
<lastUpdatedBy>ACME</lastUpdatedBy>
<lastUpdatedDate>2016-06-02T15:08:52.663-04:00</lastUpdatedDate>
</audit>
<id>783569362</id>
<startDate>2013-02-01</startDate>
<endDate>2013-02-28</endDate>
<quantity>50</quantity>
<cost>100</cost>
<disposalDestination>
<id>597373</id>
<incinerationPercentage>25</incinerationPercentage>
<landfillPercentage>25</landfillPercentage>
<unknownDestPercentage>25</unknownDestPercentage>
<wasteToEnergyPercentage>25</wasteToEnergyPercentage>
</disposalDestination>
</wasteData>
...
<links>
<link httpMethod="get" link="/meter/100/wasteData?page=2" linkDescription="next page"/>
</links>
</wasteDataList>