Yardi Store Developer eXchange

Retrieves rental data for an account or site. This also returns any soft or hard reservations as they are set up with rental IDs. The data is returned as a DataTable.

Parameters

Returned Parameters

Example

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

// Create a request and response objects
StoreServiceClient client = new StoreServiceClient();
GetSiteRentalData_Request request = new GetSiteRentalData_Request();

As with every method we need to pass in credentials. We also set up the parameters for our request.

//Cancel reservation setup
client.ChannelFactory.Credentials.UserName.UserName = "user";
client.ChannelFactory.Credentials.UserName.Password = "pass";
client.ChannelFactory.Credentials.SupportInteractive = true;

request.SiteID = 123456;
request.AccountID = 123456;

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

try
{
    // Call the method that will load the response object
    object resp;
    resp = client.GetSiteRentalData(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 SWS2 Methods.