Home > API General, Reports > SWS MiniKeyStats Method

SWS MiniKeyStats Method


Retrieves a summary of statistics for a site. The site totals will include totals for 0-30, 31-60, 61-90 and 91+ days in the future. The differences are calculated between the 0-30 days and 91+ days.

Parameters

Name DataType Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
SiteID Long
Description The site’s ID number.
Occupancy Integer
Description The total number of occupied units at the site.
Vacancy Integer
Description The total number of vacant units at the site.
Other Integer
Description The total number of units set as a status other than occupied of vacant. (I.e., Damaged, Company Use.)
GrossPotential Decimal
Description The total amount of the rent that would be collected if every unit were rented at the street rate.
GrossPotentialDifference Decimal
Description The variance between the gross potential rate and the current rent rate of all units.
ProjectedRent Decimal
Description The amount of rent that will be collected if all current rentals pay the amount due.
ProjectedRentDifference Decimal
Description The amount of additional rent that will be collected including any scheduled rate changes on current rentals.
GrossScheduled Decimal
Description The amount of rent that would be collected if all units were rented at market value.
GrossScheduledDifference Decimal
Description The changed amount based on scheduled rate changes.
EconomicOccupancy Decimal
Description The percentage of units that are occupied and collecting rent.
EconomicOccupancyDifference Decimal
Description The percentage difference based on upcoming rate changes.
OccupiedSquareFeet Decimal
Description The total number of square feet occupied at the site.
VacantSquareFeet Decimal
Description The total number of square feet that are vacant at the site.
OtherSquareFeet Decimal
Description The total number of square feet of units not occupied or vacant. (I.e., Damaged, Company Use.)
TotalSquareFeet Decimal
Description The total square feet at the site.
OccupiedSquareFeetPercentage Decimal
Description The percentage of square feet that are occupied at the site.
VacantSquareFeetPercentage Decimal
Description The percentage of square feet that are vacant at the site.
OtherSquareFeetPercentage Decimal
Description The percentage of square feet not listed as occupied or vacant. (I.e., Damaged, Company Use.)
OccupiedPercentage Decimal
Description Total percentage of occupied units at the site.
VacantPercentage Decimal
Description Total percentage of vacant units at the site.
ActiveAutoPay Decimal
Description Total number of rentals actively using AutoPay.
ARTotal Decimal
Description The total of accounts receivable for 30 days, 60 days, 90 days, 91+ days, fees and other items.
ARDifference Decimal
Description The difference between the totals for the 30 days start and the 90 days end.
PrepaidRent Decimal
Description Total amount of rent paid in advance of the due date.
PrepaidRentDifference Decima
Description The amount of rent that will be moved from the prepaid liabilities to the rental revenue GLs.
Prospects Integer
Description The current total number of quotes, soft reservations and hard reservations.
NetYTD Integer
Description The number of new rentals less the number of terminated rentals from the beginning of the year through today.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects.  We will need the standard service object, a MiniKeyStats request object, and a MiniKeyStats response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.MiniKeyStats_Request request = new SWS.MiniKeyStats_Request();
SWS.MiniKeyStats_Response response;

Here is a sample code of the request object:

// MiniKeyStats Request
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to retrieve our requested information. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  response = service.MiniKeyStats(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: API General, Reports
  1. swsBecky
    April 24, 2017 at 3:43 pm

    Updated June 13, 2016: For the following three methods, RentalActivity, WalkThruList, and MiniKeyStats, we have adjusted the permissions required to get access. For these methods only, for Active users, Yardi will now verify site access in addition to the org access check. This will Not impact Services Only users. This change is meant for Store application users that are accessing these methods for report data through our iPhone application.

  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: