Studebaker Submetering API Services

<back to all web services

FindTenants

The following routes are available for this service:
All Verbs/findTenantsFind tenants at a property given a keyword
Parameters:
NameParameterData TypeRequiredDescription
PropertyIdpathstringYesThe id of the property to search
BuildingCodepathstringNoThe building code of the building the tenant is in
UnitNumberpathstringNoThe number of the unit the tenant is in. Note that if you omit buildingCode, then similarly numbered units in multiple buildings will be searched
KeywordpathstringNoThe keyword to search for. First name, last name, account # and property account # are all searched
IncludeMovedOutTenantspathstringNoWhether to include moved out tenants in the results
MaxCountpathstringNoThe maximum number of hits to return

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

<FindTenants xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Tenants.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>
  <BuildingCode>String</BuildingCode>
  <IncludeMovedOutTenants>false</IncludeMovedOutTenants>
  <Keyword>String</Keyword>
  <MaxCount>0</MaxCount>
  <PropertyId>0</PropertyId>
  <UnitNumber>String</UnitNumber>
</FindTenants>

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

<FindTenantsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Tenants.Responses">
  <FoundTenants xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces" i:nil="true" />
</FindTenantsResponse>