Studebaker Submetering API Services

<back to all web services

MoveOutTenant

The following routes are available for this service:
All Verbs/moveOutTenantMove out a tenant
Parameters:
NameParameterData TypeRequiredDescription
TenantIdpathintNo
UseExpressMoveOutpathboolNo
MoveOutDatepathstringYesThe tenant's move out date in the format MM/DD/YYYY
ForwardingAddressLine1pathstringNoDo not include if the tenant will be receiving the final bill at the unit address
ForwardingAddressLine2pathstringNo
ForwardingAddressLine3pathstringNo
ForwardingAddressCitypathstringNo
ForwardingAddressStatepathstringNo
ForwardingAddressZipCodepathstringNo
FinalBalanceCollectedAtPropertypathboolNo
PropertyToEnterInvoiceManuallypathboolNo
NotespathstringNoAny notes from the property manager (max length 500)
TimeDelayInMspathintNoTEST USE ONLY - Delay the response by a number of milliseconds (default 0)

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/MoveOutTenant HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: application/json
Content-Length: length

{"tenantId":0,"useExpressMoveOut":false,"moveOutDate":"String","forwardingAddressLine1":"String","forwardingAddressLine2":"String","forwardingAddressLine3":"String","forwardingAddressCity":"String","forwardingAddressState":"String","forwardingAddressZipCode":"String","finalBalanceCollectedAtProperty":false,"propertyToEnterInvoiceManually":false,"notes":"String","timeDelayInMs":0,"requestIpAddress":"String","token":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"finalInvoiceUrl":"String","isPending":false,"refundApplied":0}