Studebaker Submetering API Services

GetConsumptionReport

The following routes are available for this service:
All Verbs	/getConsumptionReport	Get the consumption report for a property

Parameters:
Name	Parameter	Data Type	Required	Description
PropertyId	path	int	Yes	The id of the property
FilterByAgeInMonths	path	int	No	The age filter (defaults to 6 months)
FilterByUnitId	path	int	No	Filter by this unit id (defaults to no filter)
FilterByUtilityGroupId	path	int	No	Filter by this utility group id (defaults to no filter)
FilterByUtilityId	path	int	No	Filter by this utility id (defaults to no filter)
IncludeVacantConsumption	path	bool	No	Include vacant consumption in results (defaults to false)

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

HTTP + CSV

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

POST /csv/reply/GetConsumptionReport HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/csv
Content-Length: length

PropertyId,FilterByAgeInMonths,FilterByUnitId,FilterByUtilityGroupId,FilterByUtilityId,IncludeVacantConsumption,RequestIpAddress,Token
0,0,0,0,0,False,String,String

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

Months,ResponseStatus
"[{monthName:String,cycleStart:0001-01-01,consumption:[{utilityId:0,utilityName:String,utilityGroupId:0,utilityGroupName:String,measure:String,dollarAmount:0,usage:0,isVacantConsumption:False}]}]","{errorCode:String,message:String,stackTrace:String,errors:[{errorCode:String,fieldName:String,message:String}]}"