Archive

Posts Tagged ‘Delinquency’

SWS UpdateOverlockStatus Method

Lets you change the overlock status for a rental item. Multiple rental items can be individually processed with a new status. If a rental item’s ID is passed in but a status does not get passed in, the status will default to NOT_OVERLOCKED.

Parameters

Name DataType Is Required
OrgID Long Required
Description The organization’s ID number.
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.
Status Status Required
Description The overlock status to which you are updating the rental item.
Available values:

  • NOT_OVERLOCKED
  • PENDING_OVERLOCK
  • OVERLOCKED
  • PENDING_LOCK_REMOVAL

Returned Parameters

Name Data Type
RentalID Long
Description The rental’s ID number.
Succeeded Boolean
Description Indicates if the update succeeded (“True”) or not (“False”).
ErrorMessage String
Description If the update wasn’t successful, you will get an error message with why the update was unsuccessful.

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 UpdateOverlockStatus request object, and an UpdateOverlockStatus response object. We will also need an array of RentalOverLock objects. One for each rental to adjust. We can define and create those like this:

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

SWS.RentalOverlockData[] overLock = new SWS.RentalOverlockData[1];

Here is a sample code of the request object:

// UpdateOverlockStatus Request
overLock[0].RentalID = 123456;
overLock[0].Status = SWS.OverlockStatus.OVERLOCKED;

request.OrgID = 123456;
request.OverlockData = overLock

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.UpdateOverlockStatus(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 UpdateAuction Method

Updates the information regarding the specified auction.

Parameters

Name Data Type Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
AuctionID Long Required
Description The ID number assigned to the auction at the time it was created.
AuctionDateTime DateTime Optional
Description The date and time schedule to which you wish to change the auction. If only a portion of this is included will default to either today’s date or 12:00am. For example, if you set the date to 06/20/2017 but do not enter a time, the auction will be scheduled for 06/20/17 at 12:00am.
AuctioneerName String Optional
Description The name of the auctioneer who will be running the auction.
AuctionNotes String Optional
Description Any additional information regarding the auction.
AuctionStatus AuctionStatusValues Optional
Description The status to which you wish to update the auction.
Available values:

  • SCHEDULED
  • COMPLETED
  • CANCELLED

Returned Parameters

Name Data Type
AuctionID Long
Description The auctions ID number that was updated.
SITE_ID Long
Description The site’s ID number.
AUCTION_DATE DateTime
Description The date and time for which the auction is currently scheduled.
AUCTIONEER_NAME String
Description The name of the person who will be running the auction.
NOTES String
Description Any additional information regarding the auction.
STATUS Integer
Description The numeric value of the auction status.
Available values:

  • 1 – SCHEDULED
  • 2 – COMPLETED
  • 3 – CANCELLED
CREATED_BY Long
Description The user’s ID that created the auction.
UPDATED_BY Long
Description The user’s ID that last updated the auction.
AUCTION_TIME String
Description The time during the day that the auction will occur.

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

' Create a request and response objects
 Dim objService As New SWS.WSSoapClient
 Dim objReq As New SWS.UpdateAuction_Request
 Dim objRes As New SWS.UpdateAuction_Response

Here is a sample code of the request object (including optional parameters):

' UpdateAuction Request
 With objReq
 .SiteID = 1000000001
 .AuctionID = 1000000000
 .AuctionDateTime = 2011-05-14T00:00:00.000-06:00
 .AuctioneerName = James Sweet
 .AuctionStatus = SCHEDULED
 End With

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.

Try
 ' Call the method that will load the response object
 objRes = objService.UpdateAuction(objLogin, objReq)
 Catch ex As Exception
 MessageBox.Show(ex.Message)
 End Try

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 GetTotalDuePastDue Method

May 23, 2011 1 comment

Retrieves the total amount due and the past due amount for a rental item, including the number of cycles past due. It works the same as the GetTotalDue SWS method with the exception that it requires each rental ID that you wish to include in the total. This will include all fees and services for the applicable past due and future amounts.

Parameters

Name DataType Is Required
AcctID Long Required
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
Cycles Integer Optional
Description The number of rental periods used to calculate the amount. If no cycle is passed in, it is assumed only one cycle should be included. The number of cycles starts from the PTD of the rental. You are limited to the number of cycles you can retrieve based on the ‘Allowed Number of Days Paid Ahead’ rule for the site. The rule information can be retrieved using the GetSiteRules and GetSiteRulesValue methods.
IsRetail Boolean Optional
Description Indicates that the total retrieved should be for retail assessment only (“True”) or if it should be for the rental assessments only (“False”).
IsRetailAndRental Boolean Optional
Description Indicates that the total retrieved should be for both the retail and the rental assessments on the account (“True”) or only for the rental assessments (“False”).
MoveOutDate DateTime Ignored
Description (Deprecated) The date the customer has indicated they will be moving 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.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
PastDueCycles Decimal
Description The number of rental periods that must be paid to bring the account current.
PastDueTotal Decimal
Description The total amount due to bring the account current.
RequestedTotalDue Decimal
Description The total amount due for the requested number of rental periods.

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

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

Here’s my sample code of the Request object.

// GetTotalDuePastDue Request
request.SiteID = 123456;
request.AcctID = 123456;
request.RentalID = new long[] { 123456 };
request.Cycles = new int[] { 1 };
request.IsRetail = false;
request.IsRetailAndRental = false;

Finally we can call the method and pass across the login object and the request object to retrieve the data. 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.GetTotalDuePastDue(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.

SWS GetWaiveVoidFeeStats Method

May 23, 2011 Leave a comment

Retrieves fee waive and void statistics for a rental item.

Parameters

Name DataType Is Required
OrgID Long Required
Description The organization’s ID number.
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.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
limitWaives waiveLimit
Description The “Fee Waive – Limit Definition” rule value set by the admin for the site.
Available values:

  • NO_LIMIT
  • NUM_WAIVES
  • AMT_WAIVES
maxWaives Integer
Description The “Fee Waive – Annual Limit” rule value set by the admin for the site. Indicates the maximum nuber of waivers allowed if set to NUM_WAIVES or the total dollar limit of waivers if set to AMT_WAIVES. If no limit is set it may still return a maximum value, but this value is ignored for the waivers.
reqWaiveReason Boolean
Description “True” if the sites “Fee Waive – Require Reason” rule is set to require the reason a fee is waived, “False” if not.
usedWaives String
Description If limitWaives is set to NUM_WAIVES this will be the number of waivers the customer has already received. If limitWaives is set to AMT_WAIVES this will be the total amount already waived for the customer.

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

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

Here’s my sample code of the Request object.

//  GetWaiveVoidFeeStats Request
request.OrgID = 123456;
request.SiteID = 123456;
request.RentalID = 123456;

Finally we can call the method and pass across the login object and the request object to get our void fee stats. 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.GetWaiveVoidFeeStats(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.