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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	tenantId: 0,
	filterByAgeInMonths: 0,
	filterByUtilityGroupId: 0,
	filterByUtilityId: 0,
	requestIpAddress: String,
	token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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