Yardi Store Developer eXchange

Allows you to do a bulk update on the street or push rates for a group of units at a site. The method allows for a collection of the PushStreetRateInfo object to be passed in. The return object is a comma delimited string of “Succeeded” or “Failed”. Due to a 4,000 character limitation, the unit_ids in the array are parsed into groupings less than 4,000 characters and each group returns a result of “Succeeded” or “Failed” for the batch appended to the return object. Each PushStreetRateInfo object’s array is parsed into their own groups and appended to the return object for the entire method.

Parameters

Returned Parameters

Example

We’ll assume you’ve got a web reference, let’s name it Store, in your Visual Studio project. At this point we need to reference our objects. We’ll need the standard service object, a UpdatePushStreetRate_Request request object and a PushStreetRateInfo object. We can define and create those like this:

// Create a request and response objects
StoreServiceClient client = new StoreServiceClient();
UpdatePushStreetRate_Request request = new UpdatePushStreetRate_Request();
PushStreetRateInfo rateInfo = new PushStreetRateInfo();

As with every method we need to pass in credentials. We also set up the parameters for our request.

client.ChannelFactory.Credentials.UserName.UserName = "user";
client.ChannelFactory.Credentials.UserName.Password = "pass";
client.ChannelFactory.Credentials.SupportInteractive = true;

rateInfo.UnitIDs = new long[] { 123456, 456789 };
rateInfo.RateType = 1;
rateInfo.NewRate = 50m;

request.SiteID = 123456;
request.PushStreetRateInfo = new PushStreetRateInfo[] { rateInfo };

Finally we can call the method and pass across the login object and the request object to update the rate/s. It’s a good idea to do this in a Try Catch block.

try
{
    // Call the method that will load the response object
    UpdatePushStreetRate_Response resp;
    resp = client.UpdatePushStreetRate(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 SWS2 Methods.

Lets you change the rent rate for a unit. Multiple units can be individually processed with a new rate. Letters can also be scheduled to be sent when updating the rent rates on active rentals. This method allows you to choose if the letter will be centralized mail or local mail.

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 UpdateRentRateV2 request object, and an UpdateRentRateV2 response object. We will also need a RentRateReqDataV2 array we can 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.UpdateRentRateV2_Request request = new SWS.UpdateRentRateV2_Request();
SWS.UpdateRentRateV2_Response response;

SWS.RentRateReqDataV2[] reqRentRate = new SWS.RentRateReqDataV2[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].MailLocal = 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.UpdateRentRateV2(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.