SWS RentalActivity Method


Retrieves the rental activity statistics of a site or group of sites for today. (Date range is not currently available and defaults to the prior day.)

Parameters

Name DataType Is Required
EndDate DateTime Optional
Description Not currently available. Regardless of the date entered it will used today’s date as the end date.
OrgID Long Required
Description The organization’s ID number.
SiteIDs Long Array Required
Description The site’s ID number. This can be found using the GetSiteList method.
StartDate DateTime Optional
Description Not currently available. Regardless of the date entered it will used today’s date as the start date.

Returned Parameters

Name DataType
BeginningOccupancy Integer
Description The total number of occupied rental items at the start of the date range.
EndOccupancy Integer
Description The total number of occupied rental items at the end of the date range.
Net Integer
Description The total change to number of rental items at the end of the date range.
NewRentals Integer
Description The total number of new rental items at the end of the date range.
PercentOccupancy Decimal
Description The percentage of occupied units at the end of the date range.
RevenueChange Decimal
Description The amount of revenue increase or decrease at the end of the date range.
SiteID Long
Description The site’s ID number.
SiteName String
Description The site’s name.
SiteNumber String
Description The site’s number within the organization. This is not the site ID.
SQFTOccupancy Decimal
Description The total number of square feet occupied at the end of the date range.
TerminatedRentals Integer
Description The total number of terminated rentals at the end of the date range.
TotalUnits Integer
Description The total number of units at the site.

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 RentalActivity request object, and a RentalActivity response object. We can define and create those like this:

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

Here is a sample code of the request object:

// RentalActivity Request
request.OrgID = 123456;
request.SiteIDs = new long[] { 123456, 456789 };

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.RentalActivity(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.

  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: