Yardi Store Developer eXchange

Allows you to retrieve a list of quoted, soft-reserved and hard-reserved reservations. This view requires at least one parameter by which to filter.

Returned Columns

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 GetDataView_Request request object and a ParameterValues 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();
GetDataView_Request request = new GetDataView_Request();
ParameterValues parms = new Store.ParameterValues();

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

//get data view setup
client.ChannelFactory.Credentials.UserName.UserName = "user";
client.ChannelFactory.Credentials.UserName.Password = "pass";
client.ChannelFactory.Credentials.SupportInteractive = true;

parms.FilterType = 3;
parms.ParameterName = "quote_created";
parms.ParameterValue = "01-MAR-2017";

request.OrgID = 123456;
request.SiteID = 123456;
request.ViewName = "sws_rental_prospects_v";
request.Parameters = new ParameterValues[] { parms };

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