Studebaker Submetering API Services

<back to all web services

GetTenantsReport

The following routes are available for this service:
All Verbs/getTenantsReportGet the tenants report

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

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

{
	units: 
	[
		{
			unitId: 0,
			buildingCode: String,
			unitNumber: String,
			currentTenant: 
			{
				tenantId: 0,
				pmsAccount: String,
				name: 
				{
					prefix: String,
					firstName: String,
					lastName: String,
					suffix: String
				},
				balance: 0,
				lastInvoiceUrl: String,
				isPendingMoveOut: False,
				moveInDate: 0001-01-01,
				moveOutDate: 0001-01-01
			},
			pendingNewTenant: 
			{
				tenantId: 0,
				pmsAccount: String,
				name: 
				{
					prefix: String,
					firstName: String,
					lastName: String,
					suffix: String
				},
				balance: 0,
				lastInvoiceUrl: String,
				isPendingMoveOut: False,
				moveInDate: 0001-01-01,
				moveOutDate: 0001-01-01
			},
			previousTenants: 
			[
				{
					tenantId: 0,
					pmsAccount: String,
					name: 
					{
						prefix: String,
						firstName: String,
						lastName: String,
						suffix: String
					},
					balance: 0,
					lastInvoiceUrl: String,
					isPendingMoveOut: False,
					moveInDate: 0001-01-01,
					moveOutDate: 0001-01-01
				}
			]
		}
	]
}