SWS GetEcommRentalInfo Method
Retrieves a collection of rental data for a specified eCommerce account. This relies on the eCommerce data in our system, and may not be useful outside that environment.
Parameters
Name | DataType | Is Required |
---|---|---|
EcommID | Long | Required |
Description | The account’s eStore/eCommerce ID number. This is system generated when the customer is enrolled in eStore. | |
OrgID | Long | Required |
Description | The organization’s ID number. |
Returned Parameters
Name | DataType |
---|---|
ACCT_ID | Long |
Description | The account’s ID number. |
CONTACT_ID | Long |
Description | The rental contact’s ID number. |
CURRENTLY_RENTED | String |
Description | Indicates whether the rental is currently rented (“Y”) or not (“N”). |
DEL_EXEMPT | String |
Description | Indicates if the rental is set to be exempt from the delinquency (“True”) or not (“False”). |
ECOMM_ID | Long |
Description | The eCommerce ID for the customers eStore/eCommerce record |
LTD | DateTime |
Description | The lease-thru-date (LTD). |
NEXT_PTD | DateTime |
Description | The day that they will be paid thru if they make a one rental cycle payment. |
PTD | DateTime |
Description | The current paid-thru-date (PTD). |
RENTAL_ID | Long |
Description | The rental item’s ID number. |
START_DATE | DateTime |
Description | The date the customer initiated the rental. |
TOTAL_DUE | Decimal |
Description | The total amount due if there are any outstanding assessments. |
UNIT_ID | Long |
Description | The unit’s ID number. This is maintained through rentals. |
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. |
ACCT_TYPE | String |
Description | The system-defined account type. This should be set to “Lead”. Available values:
|
ATTRIBUTE01_VAL | String |
Description | The textual value for the “Attribute01” custom lookup as defined by the site. See eUnitAttr01 for the available values. |
CONTACT_TYPE | String |
Description | The contact’s type. Available values:
|
DEPTH | Decimal |
Description | The depth of the rental item. |
String | |
Description | The rental contact’s email address. This is also used as the username if the site supports eStore. |
FIRST_NAME | String |
Description | The given name for the account/rental contact. |
LAST_NAME | String |
Description | The family name for the rental contact. |
OBJ_PERIOD | Long |
Description | The numeric value for the “Unit of Measure” (UOM) type of rental cycle. |
OBJ_PERIOD_UOM | String |
Description | The description for the “Unit of Measure” (UOM) type of rental cycle. |
OVERLOCK_STATUS | String |
Description | An overlock status of the rental item. This is different from a gate lockout. Available values:
|
RENT_RATE | Decimal |
Description | The current rent rate of the unit. |
RENTAL_STATUS | String |
Description | The rental status of the rental item. |
SITE_ID | Long |
Description | The site’s ID number. |
SITE_NAME | String |
Description | The site’s name. |
UNIT_NUMBER | String |
Description | The unit’s number as assigned by the organization. This is not the UnitID. |
WIDTH | Decimal |
Description | The width of the rental item. |
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 GetEcommRentalInfo request object and a GetEcommRentalInfo response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetEcommRentalInfo_Request request = new SWS.GetEcommRentalInfo_Request();
SWS.GetEcommRentalInfo_Response response;
Here’s my sample code of the Request object.
// GetEcommRentalInfo Request
request.OrgID = 123456;
request.EcommID = 123456;
Finally we can call the method and pass across the login object and the request object to retrieve our 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.GetEcommRentalInfo(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.