Studebaker Submetering API Services

FindTenants

The following routes are available for this service:
All Verbs	/findTenants	Find tenants at a property given a keyword

Parameters:
Name	Parameter	Data Type	Required	Description
PropertyId	path	string	Yes	The id of the property to search
BuildingCode	path	string	No	The building code of the building the tenant is in
UnitNumber	path	string	No	The number of the unit the tenant is in. Note that if you omit buildingCode, then similarly numbered units in multiple buildings will be searched
Keyword	path	string	No	The keyword to search for. First name, last name, account # and property account # are all searched
IncludeMovedOutTenants	path	string	No	Whether to include moved out tenants in the results
MaxCount	path	string	No	The maximum number of hits to return

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/FindTenants HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/csv
Content-Length: length

PropertyId,BuildingCode,UnitNumber,Keyword,IncludeMovedOutTenants,MaxCount,RequestIpAddress,Token
0,String,String,String,False,0,String,String

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

FoundTenants