Yardi Store Developer eXchange

Begins the process of transferring from one rental item to another rental item. The CompleteUnitTransfer SWS method should be called after this SWS method in order to complete the process. Failure to call CompleteUnitTransfer will result in the transfer getting rolled back during nightly processing. If the transfer is canceled after it is initiated but before it is completed, use the RollbackUnitTransfer method.

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 InitiateUnitTransfer request object and a InitiateUnitTransfer response object. We will also need at least one RentalInfo object and at least one UnitInfo object  We can define and create those like this:

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

SWS.RentalInfo fromRentals = new SWS.RentalInfo();
SWS.UnitInfo unitInfo = new SWS.UnitInfo();

Here’s sample code of the Request objects.

// InitiateUnitTransfer Request
fromRentals.RentalID = 123456;
fromRentals.Version = 10;

unitInfo.UnitID = 123456;
unitInfo.Version = 11;
unitInfo.EmailInvoice = 123456;
unitInfo.PerEndDay = 15;

request.OrgID = 123456;
request.SiteID = 123456;
request.AccountID = 123456;
request.PrimaryFromRental = 123456;
request.FromRentals = new SWS.RentalInfo[] { fromRentals };
request.ToUnits = new SWS.UnitInfo[] { unitInfo };

Finally we can call the method and pass across the login object and the request object to initiate unit transfer our reservation. 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.InitiateUnitTransfer(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.