Archive

Author Archive

SWS ProcessRefund Method

Submits a request for a cash, check, credit or ‘Deny’ refund, based on a cancelled transaction. You will need data from the cancellation to process this request. If you wish to credit the amount of the refund to an alternate rental on the account, you must use the CancelReservationCashCredit SWS method.

Parameters

Name DataType Is Required
ContactData ContactInfo Required
Description The object containing required data for the accounts contact.
OrgID Long Required
Description The organization’s ID number.
RefundInfo RefundData Required
Description The object containing the required refund details.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
Details String
Description The total amount due to the customer for the assessments.

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 ProcessRefund request object, and a ProcessRefund response object. We will also need a ContactInfo object and a RefundData object. We can define and create those like this:

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

SWS.ContactInfo conRequest = new SWS.ContactInfo();
SWS.RefundData refRequest = new SWS.RefundData();

Here is a sample code of the request object:

// ProcessRefund Request
conRequest.AccountID = 123456;
conRequest.RentalID = 123456;
conRequest.ContactName = "John Doe";
conRequest.Address1 = "123 Main St.";
conRequest.City = "My Town";
conRequest.State = "UT";
conRequest.PostalCode = "12345";

refRequest.TranID = 123456;
refRequest.RefundType = SWS.RefundTypes.CREDIT_CARD;
refRequest.RefundAmount = 25.30m;
refRequest.IsDenied = false;

request.OrgID = 123456;
request.SiteID = 123456;
request.ContactData = conRequest;
request.RefundInfo = refRequest;

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.ProcessRefund(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, Refunds

SWS MiniKeyStats Method

July 18, 2011 1 comment

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

Contacting Web Service Support

You may contact us at anytime regarding usage, bugs, errors etc. in SWS. We will respond within 1 business day to your contact.

Email us: (This is the preferred method of communication. Assistance is available between 7am and 4pm Mountain time.) StoreAPISupport@Yardi.com
For assistance during normal business hours: (This is the Helpdesk number and they may not be able to assist with all SWS/API questions.) 801-303-1333

For emails please include the following information, where applicable.

  1. Your name and the organization to which you are contracted.
  2. A snippet of the code causing the issue and the SOAP method.
  3. The URL you are using to access Store Web Services.
  4. If this is regarding a specific error you are experiencing:
    • The date and time the error occurred.
    • The username you are using to attempt to login. (For security, do not include the password!)
    • A detailed list of the parameters being passed in. (Do not include sensitive data like credit card numbers, social security numbers or passwords.)
    • Detailed error information including the error number and description. (If you can email a screen shot of the response, even better.)

If for any reason a password is included in an email that also contains your username we are required to change the password immediately.

Categories: API General

LookupUser Request Object

The LookupUser object processes your login for almost every function in Store Web Services. If a function does not require the object, it is noted in its documentation. Otherwise, you should assume the object is required. The object will always be the first parameter in a Store function. Note: The channels are created in the Store application by an admin. A list of available channels can be retrieved using the GetChannelList. The default for a SWS user is 999, however, if the organization has set up an additional option (i.e., call center, kiosk, web site, etc.) you should verify what channel to use with your organization contact. The channel will control things like the types of promotions available and is used in tracking.

Name DataType Required Description
Username String Required The user SWS uses to connect to the application. This should never refer back to a specific Store account or contact.
Password String Required The user’s password.
Channel Integer Required The source of the request. The channel is organization specific and could refer to things like call centers, kiosks or websites.

Example

With most methods, we need to pass in credentials. Start with creating the object and setting the parameters.

‘ Create and set authentication credentials
 Dim objLogin As New SWS.LookupUser_Request

Within this object we will pass in our credentials.

‘ Set the Login object params
 With objLogin
 .Username = “UserName”
 .Password = “Store40”
 .Channel = 999
 End With

For a full list of methods see SWS Methods.

Categories: API General