SWS GetEligibleAuctionRentals Method
Retrieves all rentals that are eligible for auction and are not currently assigned to an existing auction.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| ACCT_ID | Long |
| Description | The account’s ID number. |
| ACCT_NAME | String |
| Description | The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardian account. |
| DEL_RENTAL_ID | Long |
| Description | The rental item’s ID number. |
| DEL_SCHED | Decimal |
| Description | The delinquency schedules ID. |
| DEL_SCHED_NAME | String |
| Description | The name of the delinquency schedule. |
| ICON | String |
| Description | The URL for the site revenue class icon that displays in the Store application. |
| LAST_PAYMENT_AMOUNT | Decimal |
| Description | The amount of the last payment made. |
| LAST_PAYMENT_DATE | DateTime |
| Description | The date the last payment was made on the rental item. |
| LIEN_STATE | Integer |
| Description | The lien status of the rental. This call should always return 1 (Eligible for Auction). |
| LTD | DateTime |
| Description | The date through which the customer has leased the unit. |
| PTD | DateTime |
| Description | The the date through which the customer has paid rent for the unit. |
| RENTAL_ID | Long |
| Description | The rental item’s ID number. |
| SITE_ID | Long |
| Description | The site’s ID number. |
| TOTAL_DUE | Decimal |
| Description | The total amount of funds not paid to date. |
| UNIT_NUMBER | String |
| Description | The unit’s number as assigned by the organization. This is not the UnitID. |
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 GetEligibleAuctionRentals request object and a GetEligibleAuctionRentals response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetEligibleAuctionRentals_Request request = new SWS.GetEligibleAuctionRentals_Request();
SWS.GetEligibleAuctionRentals_Response response;
Here’s my sample code of the Request object.
// GetEligibleAuctionRentals Request
request.SiteID = 123456;
Finally we can call the method and pass across the login object and the request object to get the eligible rental auctions. 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.GetEligibleAuctionRentals(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.
