Studebaker Submetering API Services

<back to all web services

GetTenantHistory

The following routes are available for this service:
All Verbs/getTenantHistoryGet the transaction and payment history for a tenant
Parameters:
NameParameterData TypeRequiredDescription
TenantIdpathintYesThe id of the tenant to get the transaction history for

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

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

{
	transactions: 
	[
		{
			transactionDate: 0001-01-01,
			formattedTransactionDate: String,
			description: String,
			previousReading: 0,
			currentReading: 0,
			multiplier: 0,
			quantity: 0,
			unit: String,
			rate: 0,
			transactionAmount: 0
		}
	],
	totalInvoiced: 0,
	totalPayments: 0,
	totalDue: 0
}