Studebaker Submetering API Services

<back to all web services

GetTenantConsumptionReport

Parameters:
NameParameterData TypeRequiredDescription
TenantIdpathintYesThe id of the tenant
FilterByAgeInMonthspathintNoThe age filter (defaults to 6 months)
FilterByUtilityGroupIdpathintNoFilter by this utility group id (defaults to no filter)
FilterByUtilityIdpathintNoFilter by this utility id (defaults to no filter)

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/GetTenantConsumptionReport HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/csv
Content-Length: length

TenantId,FilterByAgeInMonths,FilterByUtilityGroupId,FilterByUtilityId,RequestIpAddress,Token
0,0,0,0,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}]}"