Yardi Store Developer eXchange

Retrieves a collection of site details based on filters entered in the parameters. This will only retrieve sites that are in the “Active” status. New sites may still be in “New/Pre-Production” or “Test/Training” which will be accessible through SWS, but will not show on this method’s response.

Parameters

Returned Parameters

Example

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

We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to our objects.  We’ll need the standard service object, a GetSiteList request object and a GetSiteList response object. We can define and create those like this:

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

Here’s my sample code of the Request object for a list of all sites in an organization. Other optional parameters can be applied to further narrow the results.

//GetSiteList Request for all sites in an org
request.OrgID = 123456;

Finally we can call the method and pass across the login object and the request object to get our site list. 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.GetSiteList(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.