Studebaker Submetering API Services

MoveOutTenant

The following routes are available for this service:
All Verbs	/moveOutTenant	Move out a tenant

Parameters:
Name	Parameter	Data Type	Required	Description
TenantId	path	int	No
UseExpressMoveOut	path	bool	No
MoveOutDate	path	string	Yes	The tenant's move out date in the format MM/DD/YYYY
ForwardingAddressLine1	path	string	No	Do not include if the tenant will be receiving the final bill at the unit address
ForwardingAddressLine2	path	string	No
ForwardingAddressLine3	path	string	No
ForwardingAddressCity	path	string	No
ForwardingAddressState	path	string	No
ForwardingAddressZipCode	path	string	No
FinalBalanceCollectedAtProperty	path	bool	No
PropertyToEnterInvoiceManually	path	bool	No
Notes	path	string	No	Any notes from the property manager (max length 500)
TimeDelayInMs	path	int	No	TEST 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 .xml suffix or ?format=xml

HTTP + XML

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

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

<MoveOutTenant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.MoveInOut.Requests">
  <RequestIpAddress xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Common.Requests">String</RequestIpAddress>
  <Token xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Common.Requests">String</Token>
  <FinalBalanceCollectedAtProperty>false</FinalBalanceCollectedAtProperty>
  <ForwardingAddressCity>String</ForwardingAddressCity>
  <ForwardingAddressLine1>String</ForwardingAddressLine1>
  <ForwardingAddressLine2>String</ForwardingAddressLine2>
  <ForwardingAddressLine3>String</ForwardingAddressLine3>
  <ForwardingAddressState>String</ForwardingAddressState>
  <ForwardingAddressZipCode>String</ForwardingAddressZipCode>
  <MoveOutDate>String</MoveOutDate>
  <Notes>String</Notes>
  <PropertyToEnterInvoiceManually>false</PropertyToEnterInvoiceManually>
  <TenantId>0</TenantId>
  <TimeDelayInMs>0</TimeDelayInMs>
  <UseExpressMoveOut>false</UseExpressMoveOut>
</MoveOutTenant>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MoveOutTenantResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.MoveInOut.Responses">
  <FinalInvoiceUrl>String</FinalInvoiceUrl>
  <IsPending>false</IsPending>
  <RefundApplied>0</RefundApplied>
</MoveOutTenantResponse>