Studebaker Submetering API Services

GetBuildingsAndUnits

The following routes are available for this service:
All Verbs	/getBuildingsAndUnits	Get the building/units 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/GetBuildingsAndUnits 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

{
	buildings: 
	[
		{
			buildingId: 0,
			buildingCode: String,
			units: 
			[
				{
					unitId: 0,
					unitNumber: String,
					occupant: 
					{
						accountId: 0,
						propertyId: 0,
						propertyName: String,
						namePrefix: String,
						firstName: String,
						lastName: String,
						nameSuffix: String,
						balance: 0,
						moveInDate: 0001-01-01,
						moveOutDate: 0001-01-01,
						email: String,
						emailBeingChecked: String,
						emailCheckAuth: String,
						receiveServiceAlertSms: False,
						receiveServiceAlertEmail: False,
						receiveServiceAlertVoice: False,
						numberOfOccupants: 0,
						numberOfOccupantsCanBeSet: False,
						phone: String,
						phoneExt: String,
						mobile: String,
						mailingAddress: 
						{
							line1: String,
							line2: String,
							line3: String,
							city: String,
							state: String,
							zipCode: String
						},
						showGoPaperless: False,
						goPaperlessEmail: String,
						goPaperlessVerificationPending: False,
						fullName: String String String String,
						lastInvoiceUrl: String,
						payNowUrl: String,
						canPayOnline: False,
						pmsAccount: String,
						propertyUsesIntegration: False,
						propertyIsCollected: False,
						resetPasswordAuth: String,
						resetPasswordRequested: 0001-01-01,
						password: String,
						passwordHash: String,
						updatePassword: False,
						isWebAccessEnabled: False,
						tenantDetailsReadOnly: False,
						isExempt: False
					},
					previousOccupants: 
					[
						{
							accountId: 0,
							propertyId: 0,
							propertyName: String,
							namePrefix: String,
							firstName: String,
							lastName: String,
							nameSuffix: String,
							balance: 0,
							moveInDate: 0001-01-01,
							moveOutDate: 0001-01-01,
							email: String,
							emailBeingChecked: String,
							emailCheckAuth: String,
							receiveServiceAlertSms: False,
							receiveServiceAlertEmail: False,
							receiveServiceAlertVoice: False,
							numberOfOccupants: 0,
							numberOfOccupantsCanBeSet: False,
							phone: String,
							phoneExt: String,
							mobile: String,
							mailingAddress: 
							{
								line1: String,
								line2: String,
								line3: String,
								city: String,
								state: String,
								zipCode: String
							},
							showGoPaperless: False,
							goPaperlessEmail: String,
							goPaperlessVerificationPending: False,
							fullName: String String String String,
							lastInvoiceUrl: String,
							payNowUrl: String,
							canPayOnline: False,
							pmsAccount: String,
							propertyUsesIntegration: False,
							propertyIsCollected: False,
							resetPasswordAuth: String,
							resetPasswordRequested: 0001-01-01,
							password: String,
							passwordHash: String,
							updatePassword: False,
							isWebAccessEnabled: False,
							tenantDetailsReadOnly: False,
							isExempt: False
						}
					]
				}
			]
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	}
}