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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/MoveOutTenant HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/csv
Content-Length: length

TenantId,UseExpressMoveOut,MoveOutDate,ForwardingAddressLine1,ForwardingAddressLine2,ForwardingAddressLine3,ForwardingAddressCity,ForwardingAddressState,ForwardingAddressZipCode,FinalBalanceCollectedAtProperty,PropertyToEnterInvoiceManually,Notes,TimeDelayInMs,RequestIpAddress,Token
0,False,String,String,String,String,String,String,String,False,False,String,0,String,String

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

FinalInvoiceUrl,IsPending,RefundApplied
String,False,0