Home > API General > General Information and Tips

General Information and Tips


Discovering Methods


This can be easily viewed by opening the web service URL in a browser and selecting an individual method. Changes to these will be communicated through normal channels but are themselves self-documented. For a full list of methods see SWS Methods

Required Parameters


All available parameters for the SWS methods are documented with tables indicating what items are required.

Types/Enums


Some methods will require a specific SWS type to be passed in as a parameter. These Store types are provided as enumeration objects or classes that you should use instead of just hard coding a number. All the available values will appear in the WSDL as well as the method documentation.

If you are using .NET, these values will appear in your intellisense and should be easy to see and use. For example: creating a new account will require an account type, and the available types for this parameter are defined in the AccountClass enumeration.

 //Use of an enumeration to specify a typed parameter
 SWS.CreateNewAccount_Request request = new SWS.CreateNewAccount_Request;
 request.AccountClass = SWS.AccountClass.BUSINESS;

Data Selection Methods


These methods are used to retrieve data from the Store database. These functions only pull data as opposed to functions that are used to also update and insert records into the database as needed. Many of these functions have variable input parameters. There are a minimum number of input requirements such as org_id and/or site_id, but all available parameters can be entered to filter methods for specific returns.

Transactional Methods


These methods are used to update or insert data in the Store database. Many of these functions have variable input parameters. The input requirements will be specific to the table the row is being insert into. Some functions insert into multiple tables and insert more than one row into the additional tables. Therefore, some insert parameters are arrays of a table row.

Security


Security of each organization’s data is of the highest priority to Yardi. Part of each service request is authentication that verifies the user requesting the data has access to this data. This is usually specified at the organization level. Even if key data is passed as a parameter to a method, such as org_id, the account is still validated to ensure granted security access to the data requested.

Time Zones


All time zone data stored in the Store database is in Mountain Time. If your data is time zone dependent you will need to adjust the data retrieved. To do this you will need take the time retrieved and add the time zone offset field. This field may be a negative amount.

LookupUser Object


The lookup user object processes your login for almost every function in Store Web Services. The object will usually be the first parameter in a Store function unless otherwise noted. Exceptions are rare.

Tips

Increasing your buffer


SWS methods pass large recordsets. In order to receive this data it is likely you will need to increase your default buffer size. Maximizing your buffer sizes will prevent overflow errors.

To adjust your .NET(2005+) project buffer go to the App.Config file and look for the following:

 --------------------------------------------------

Expand the buffer properties and message sizes as need. Usually 512k is sufficient.

Service Users


Store users must be set up as “Services Only”. This set up will not give you access to the Store application. Conversely a Store application user cannot access SWS. If you do not have a services password and you need one, please contact the organization, who in turn, will need to send a request to Web Service Support. Store access does not automatically include services access and additional charges may apply.

Categories: API General
  1. No comments yet.
  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: