Archive

Posts Tagged ‘Rentals’

SWS UpdateReservation Method

May 25, 2011 1 comment

Updates a reservation and has the same input parameters as the MakeReservation SWS method, but it does require the Quote ID to be passed in. It can also be treated as a transfer of a reservation from one rental item to another or for changing the expected move in date to a future date. Rules govern the expiration date of the quote and another rule also dictates how far out hard reservations can be extended.

Parameters

Name DataType Is Required
Request MakeReservation_Request Required
Description The information required for creating the request.

Returned Parameters

Name DataType
QuoteID Long
Description The ID of the quote record that was created.
RentalID Long
Description The ID number of the rental that was created. This will be created for every reservation but not a quote only.

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

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

Here is my sample requesting a change of the reserved unit.

// UpdateReservation request
request.SiteID = 123456;
request.AcctID = 123456;
request.QuoteID = 123456;
request.UnitID = 456789;
request.Version = 34;

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

SWS UpdateRental Method

Sets the customer’s intended move out date as well as indicating the date of notification. This is primarily used for sites that have penalties for moving out without notice.

Parameters

Name DataType Is Required
MoveOutDate DateTime Required
Description The customer’s intended move out date. This can be any date including a future date as it is just a notification and does not move the customer out.
RentalId Long Required
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
CreateTask Boolean Optional
Description Indicates if a task should be created for the site (“True”) or not (“False”).

Returned Parameters

Name DataType
UpdateRentalResult TRAN_RENTALS
Description The array of information returned as the result of the update.

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

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

Here is a sample code of the request object:

// UpdateRental Request
request.RentalId = 123546;
request.MoveOutDate = new DateTime(2017, 9, 1);
request.CreateTask = true;

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