Studebaker Submetering API Services

<back to all web services

GetIrregularUsageDetail

The following routes are available for this service:
All Verbs/getIrregularUsageDetailGet the current irregular usage details for a property

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

{
	propertyId: 0,
	cycleId: 0,
	requestIpAddress: String,
	token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	lowUsage: 0,
	highUsage: 0,
	utilities: 
	[
		{
			utilityGroupId: 0,
			groupName: String
		}
	],
	irregularUsage: 
	[
		{
			buildingUnit: String,
			tenantName: String,
			tenantId: 0,
			details: 
			[
				{
					utilityGroupId: 0,
					utilityId: 0,
					utilityServiceName: String,
					unitOfMeasure: String,
					totalUsage: 0,
					totalCharge: 0,
					type: String,
					tenantId: 0,
					tenantName: String,
					buildingUnit: String,
					isIrregular: False
				}
			]
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	}
}