Yardi Store Developer eXchange

Allows you to add multiple rental items to an existing rental auction. See the CreateAuction SWS method for information on creating a rental auction.

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, an AddRentalsToAuction request object and an AddRentalsToAuction response object.  We can define and create those like this:

// Create request and response objects and rental item object.
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.AddRentalsToAuction_Request  request = new SWS.AddRentalsToAuction_Request();
SWS.AddRentalToAuction_Response response;

SWS.AuctionRentalItemData rentalData = new SWS.AuctionRentalItemData();

Here’s my sample code of the Request object.

//Create rental data parameters
 rentalData.RentalID = 123456;
 rentalData.UnitContents = "assorted boxes and a dining room set.";
 rentalData.Notes = "This is for whatever notes you wish to add.";

//Add rentals to auction request object
request.AuctionID = 123456;
request.CreateLetter = true;
request.AssessFee = true;
request.SiteID = 123456;
request.Rentals = new SWS.AuctionRentalItemData[] { rentalData };

Finally we can call the method and pass across the login object and the request object for adding rentals to an auction. It’s a good idea to do this in a Try Catch block.

try
{
   // Call the method that will load the response object
   response = service.AddRentalsToAuction(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.