SWS WalkThruList Method
Retrieves the list of all rental items at a site, both rented and available. This will list the items in the order set by the admin as the walk thru order. This is primarily used to inspect the property and add or remove overlocks on units as determined by the delinquency schedule.
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_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 guardianship account. |
ATTRIBUTE01 | String |
Description | The textual value for the “Attribute01” custom lookup as defined by the site. See eUnitAttr01 for the available values. |
DAYS_LATE | String |
Description | The number of days that the rental item’s payment is past due. |
DEL_STEP | Decimal |
Description | The current delinquency step of the rental item. |
DIM | String |
Description | The width and depth measurements of the unit. |
ORG_NUMBER_XREF | String |
Description | The sites number as assigned by the admin. This is not the site ID. |
OVERLOCK_STATUS_VAL | String |
Description | The current overlock status of the rental. Available values:
If the unit is not overlocked this will be null. |
PTD | DateTime |
Description | The date the unit is paid thru. |
RENT_RATE | Decimal |
Description | The current rent rate of the unit. |
RENTAL_ID | Long |
Description | The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method. |
RENTAL_START_DATE | DateTime |
Description | The date the customer started their rental. |
SITE_ID | Long |
Description | The site’s ID number. This can be found using the GetSiteList method. |
SITE_NAME | String |
Description | The name of the site to which the unit belongs. |
STATUS | Integer |
Description | The status of the rental. Common values:
|
SUM_DAYS_LATE | Decimal |
Description | The number of days that the rental item’s payment is past due. |
UNIT_ID | Long |
Description | The unit’s ID number. This is maintained through rentals. |
UNIT_NUM_SORT | Long |
Description | The sort order for the rental items at the site. |
UNIT_NUMBER | String |
Description | The unit’s number as assigned by the organization. This is not the UnitID. |
UNIT_STATUS_VAL | Integer |
Description | The rental status of the unit. |
WALK_THRU_ORDER | Integer |
Description | The number indicating what order the unit is, in the list. |
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 WalkThruList request object, and a WalkThruList response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.WalkThruList_Request request = new SWS.WalkThruList_Request();
SWS.WalkThruList_Response response;
Here is a sample code of the request object:
// WalkThruList Request
request.SiteID = 123546;
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.WalkThruList(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.