Yardi Store Developer eXchange

Allows the user to change the status of a rental item if the current status is not “Reserved” or “Rented”. Multiple rental items can be individually processed with a new status. It is an expanded function to the UpdateUnitStatus SWS method because it allows for change to occur on the rental item status to another possible status rather than just available or hold.

Parameters

Returned Parameters

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects.  We will need the standard service object, an UpdateUnitStatusExpanded request object, and an UpdateUnitStatusExpanded response object. We will also need an UpdateUnitStatusExpanded_RequestData object to pass to the request. We can define and create those like this:

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

SWS.UpdateUnitStatusExpanded_RequestData reqUnitData 
                       = new SWS.UpdateUnitStatusExpanded_RequestData();

Here is a sample code of the request object:

// UpdateUnitStatusExpanded Request
 With objReq
reqUnitData.OrgID = 123456;
reqUnitData.SiteID = 123456;
reqUnitData.UnitID = 123456;
reqUnitData.UnitVersion = 12;
reqUnitData.UnitStatus = SWS.unitStsVals.AVAILABLE_HOLD;

request.UnitStatusUpdateData[0] = reqUnitData;

Finally we can call the method and pass across the login object and the request object to retrieve our requested information. 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.UpdateUnitStatusExpanded(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.