Studebaker Submetering API Services

<back to all web services

GetTenantsReport

The following routes are available for this service:
All Verbs/getTenantsReportGet the tenants report

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

<GetTenantsReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Reports.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>
  <PropertyId>0</PropertyId>
</GetTenantsReport>

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

<GetTenantsReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Reports.Responses">
  <Units xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:TenantsReportUnitData>
      <d2p1:BuildingCode>String</d2p1:BuildingCode>
      <d2p1:CurrentTenant>
        <d2p1:Balance>0</d2p1:Balance>
        <d2p1:IsPendingMoveOut>false</d2p1:IsPendingMoveOut>
        <d2p1:LastInvoiceUrl>String</d2p1:LastInvoiceUrl>
        <d2p1:MoveInDate>0001-01-01T00:00:00</d2p1:MoveInDate>
        <d2p1:MoveOutDate>0001-01-01T00:00:00</d2p1:MoveOutDate>
        <d2p1:Name>
          <d2p1:FirstName>String</d2p1:FirstName>
          <d2p1:LastName>String</d2p1:LastName>
          <d2p1:Prefix>String</d2p1:Prefix>
          <d2p1:Suffix>String</d2p1:Suffix>
        </d2p1:Name>
        <d2p1:PmsAccount>String</d2p1:PmsAccount>
        <d2p1:TenantId>0</d2p1:TenantId>
      </d2p1:CurrentTenant>
      <d2p1:PendingNewTenant>
        <d2p1:Balance>0</d2p1:Balance>
        <d2p1:IsPendingMoveOut>false</d2p1:IsPendingMoveOut>
        <d2p1:LastInvoiceUrl>String</d2p1:LastInvoiceUrl>
        <d2p1:MoveInDate>0001-01-01T00:00:00</d2p1:MoveInDate>
        <d2p1:MoveOutDate>0001-01-01T00:00:00</d2p1:MoveOutDate>
        <d2p1:Name>
          <d2p1:FirstName>String</d2p1:FirstName>
          <d2p1:LastName>String</d2p1:LastName>
          <d2p1:Prefix>String</d2p1:Prefix>
          <d2p1:Suffix>String</d2p1:Suffix>
        </d2p1:Name>
        <d2p1:PmsAccount>String</d2p1:PmsAccount>
        <d2p1:TenantId>0</d2p1:TenantId>
      </d2p1:PendingNewTenant>
      <d2p1:PreviousTenants>
        <d2p1:TenantsReportTenantData>
          <d2p1:Balance>0</d2p1:Balance>
          <d2p1:IsPendingMoveOut>false</d2p1:IsPendingMoveOut>
          <d2p1:LastInvoiceUrl>String</d2p1:LastInvoiceUrl>
          <d2p1:MoveInDate>0001-01-01T00:00:00</d2p1:MoveInDate>
          <d2p1:MoveOutDate>0001-01-01T00:00:00</d2p1:MoveOutDate>
          <d2p1:Name>
            <d2p1:FirstName>String</d2p1:FirstName>
            <d2p1:LastName>String</d2p1:LastName>
            <d2p1:Prefix>String</d2p1:Prefix>
            <d2p1:Suffix>String</d2p1:Suffix>
          </d2p1:Name>
          <d2p1:PmsAccount>String</d2p1:PmsAccount>
          <d2p1:TenantId>0</d2p1:TenantId>
        </d2p1:TenantsReportTenantData>
      </d2p1:PreviousTenants>
      <d2p1:UnitId>0</d2p1:UnitId>
      <d2p1:UnitNumber>String</d2p1:UnitNumber>
    </d2p1:TenantsReportUnitData>
  </Units>
</GetTenantsReportResponse>