Yardi Store Developer eXchange

Checks a rental item’s auction status.

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 have a web reference, let’s name it SWS, in your Visual Studio project. At this point we need to define the objects. We’ll need the standard service object, a GetRentalAuctionStatus request object, and a GetRentalAuctionStatus response object. We can define and create those like this:

// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetRentalAuctionStatus_Request request = new SWS.GetRentalAuctionStatus_Request();
SWS.GetRentalAuctionStatus_Response response;

Here’s a sample code of the Request object (including optional parameters):

// GetRentalAuctionStatus Request
request.SiteID = 123456;
request.RentalIDs = new long[] { 123546, 456789 };

Finally we can call the method and pass across the login object and the request object to retrieve the specified refunds. 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.GetRentalAuctionStatus(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 capture the message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.