Studebaker Submetering API Services

<back to all web services

GetOccupiedBuildingsAndUnits

The following routes are available for this service:
All Verbs/getOccupiedBuildingsAndUnitsGet the occupied building/units for a property

To override the Content-type in your clients HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/GetOccupiedBuildingsAndUnits HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: application/json
Content-Length: length

{"propertyId":0,"includePreviousOccupantsWithBalances":false,"requestIpAddress":"String","token":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
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":"\/Date(-62135596800000-0000)\/","moveOutDate":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","moveOutDate":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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"}]}}