Archive

Archive for the ‘Rates/Pricing’ Category

SWS UpdateRentRate Method

Lets you change the rent rate for a unit. Multiple units can be individually processed with a new rate. Letters can also be scheduled when updating the rent rates for active rentals. The letters will only be scheduled as centralized mail using this method.

Parameters

Name DataType Is Required
AcctID Long Optional
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. Only required when sending a letter.
EffectiveDate DateTime Required
Description The date the future rate will go into effect.
LetterDate DateTime Optional
Description The date the letter is to be sent. Only required when SendLetter is “True”.
NewRate Decimal Required
Description The new rent rate for the rental item.
OrgID Long Required
Description The organization’s ID number.
RentalID Long Optional
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. Only required if SendLetter is ‘True’.
SendLetter Boolean Optional
Description Indicates if the system is to generate a rate change notice letter (“True”) or not (“False”).
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
UnitID Long Required
Description The unit’s ID number for the unit where the rate change will apply. This is returned when you use any of the GetSiteUnitData
calls and is maintained through rentals.
UnitVersion Decimal Required
Description The unit’s version number which serves to prevent duplicate use of the unit.

Returned Parameters

Name DataType
ErrorMessage String
Description The message about any problem that occurred during the process, including details to locate errant code.
Succeeded Boolean
Description Indicates if the rate was changed successfully (“True”) or not (“False”).
UnitID Long
Description The unit’s ID number to which the rate change applied. This is maintained through rentals.

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 UpdateRentRate request object, and an UpdateRentRate response object. We will also need a RentRateReqData array to pass to the request object. We can define and create those like this:

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

SWS.RentRateReqData[] reqRentRate = new SWS.RentRateReqData[1];

Here is a sample code of the request object:

// UpdateRentRate Request
reqRentRate[0].OrgID = 123456;
reqRentRate[0].SiteID = 123456;
reqRentRate[0].AcctId = 123456;
reqRentRate[0].UnitID = 123456;
reqRentRate[0].UnitVersion = 23;
reqRentRate[0].RentalId = 123456;
reqRentRate[0].NewRate = 55.25m;
reqRentRate[0].EffectiveDate = new DateTime(2017, 9,1);
reqRentRate[0].SendLetter = true;
reqRentRate[0].LetterDate = new DateTime(2017, 8, 1);

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.UpdateRentRate(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 UpdateStreetRate Method

April 4, 2011 1 comment

Updates the street rate for a group of rental items, based on dimensions and attributes.

Parameters

Name DataType Is Required
Access Integer Optional
Description The numeric value for the “Access” custom look up as defined by the site. See eUnitAccess for the available values.
Attribute01 Integer Optional
Description The numeric value for the “Attribute01” custom look up as defined by the site. See eUnitAttr01 for the available values.
Attribute02 Integer Optional
Description The numeric value for the “Attribute02” custom look up as defined by the site. See eUnitAttr02 for the available values.
Climate Integer Optional
Description The numeric value for the “Climate” custom look up as defined by the site. See eUnitClimate for the available values.
Depth Decimal Optional
Description The depth measurement of the rental item.
Door Integer Optional
Description The numeric value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values.
Feature Integer Optional
Description The numeric value for the “Feature” custom look up as defined by the site. See eUnitFeatures for the available values.
Height Decimal Optional
Description The height of measurement the rental item.
NewRate Decimal Required
Description The new street rate for the rental items belonging to the collection of units with the attributes specified in the method parameters.
SiteID Long Optional
Description The site’s ID number. This can be found using the GetSiteList method.
Width Decimal Optional
Description The width measurement of the rental item.

Returned Parameters

Name DataType
CountFailed Integer
Description The number of rental items that failed to update.
CountPassed Integer
Description The number of rental items that were updated successfully.
CountRentUpdated Integer
Description The number of vacant rental items where the rent rate was updated to match the street rate.

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 UpdateStreetRate request object and a UpdateStreetRate response object. We will also need UpdateStreetReqData array to pass to the request object.

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

SWS.UpdateStreetReqData[] reqRateData = new SWS.UpdateStreetReqData[1];

Here’s my sample code of the Request object.

// request objects
reqRateData[0].NewRate = 55.50m;
reqRateData[0].Height = 10m;
reqRateData[0].Width = 8m;
reqRateData[0].Attribute01 = 1234;
           
request.SiteID = 123456;
request.StreetRateData = reqRateData;

For each record passed in, a corresponding record will be returned in the response object.  The first record in corresponds to the first record out and so on.
We can call the method and pass across the login object and the request object to make our payment. 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.UpdateStreetRate(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.

Categories: Rates/Pricing Tags: , , ,