BulkData GetBulkRentals Method
Allows you to retrieve all rentals that have been updated in the last 48 hours. This will include services that were added to a rental and any updates made to the service or the rental itself.
Parameters
Name | Data Type | Is Required |
---|---|---|
OrgID | Long | Required |
Description | The organization’s ID number.; | |
BeginDate | DateTime | Required |
Description | The start date of the date range for which you wish to retrieve the rentals. | |
EndDate | DateTime | Optional |
Description | The end date of the date range for which you wish to retrieve the rentals. This defaults to today’s date if left undefined. |
Returned Parameters
Name | Data Type |
---|---|
RENTAL_ID | Long |
Description | The rental item’s ID number. |
ACCOUNT_ID | Long |
Description | The account’s ID number. |
ACCOUNT_NAME | String |
Description | The name on the account. This may differ from the primary contact’s name in some instances. |
SITE_ID | Long |
Description | The site’s ID number. |
PARENT_RENTAL_ID | Long |
Description | The ID of the rental to which this service belongs. This will only appear on a service that has been added to a rental. |
OBJECT_ID | Long |
Description | The unit’s ID number. This is maintained through rentals. |
OBJECT_TYPE_NUM | Integer |
Description | The numeric value of the object type. |
OBJECT_TYPE_VAL | String |
Description | The textual value of the object type. |
UNIT_NUMBER | String |
Description | The unit’s number as assigned by the site. This is not the unit ID. |
RENT_START_DATE | DateTime |
Description | The date the rental was initiated by the customer. |
RENT_END_DATE | DateTime |
Description | The date the customer terminated the rental. |
PAID_THRU_DATE | DateTime |
Description | The date through which the customer has paid their rent. |
LEASE_THRU_DATE | DateTime |
Description | The date through which the customer has leased the unit. |
ASSESS_THRU_DATE | DateTime |
Description | The date through which the customer has been assessed. |
RENT_STATUS_NUM | Integer |
Description | The numeric value of the rental status of the rental. |
RENT_STATUS_VAL | String |
Description | The textual value of the rental status of the rental. |
OVERLOCK_STATUS | Integer |
Description | The numeric value of the overlock status of the rental. Available values:
|
DEL_EXEMPT | Boolean |
Description | Indicates if the rental is exempt from the delinquency schedule (“True”) or not (“False”). |
DEL_STEP | Integer |
Description | The step the rental is in the delinquency schedule. The delinquency schedule is customized by the site. Use the GetDelinqSchedule method for the full schedule. |
DEL_SCHEDULE | Long |
Description | The delinquency schedule’s ID. This will only show if it differs from the delinquency schedule assigned to the revenue class. |
DAILY_DEL_SCHEDULE | Long |
Description | Not used. |
EMAIL_CC | String |
Description | Not used. |
MOVEOUT_NOTICE_DATE | DateTime |
Description | The date the customer notified the site of their intended move out date. |
MOVEOUT_DATE | DateTime |
Description | The date the customer has indicated will be the intended move out date. |
TRANSFER_TO_ID | Long |
Description | The rental ID from which the unit was transferred. |
TRANSFER_FROM_ID | Long |
Description | The rental ID to which the unit was transferred. |
TAX_EXEMPT_NUM | Integer |
Description | The numeric value indicating if the rental has tax exempt status. |
TAX_EXEMPT_VAL | String |
Description | The textual value indicating if the rental has tax exempt status. |
TAX_EXEMPT_INFO | Integer |
Description | The tax ID for the institution to show their tax exempt status. |
PER_END_DAY | Integer |
Description | The day of the month that the rental period ends for the rental. |
VERSION | Integer |
Description | The unit’s version number which serves to prevent duplicate use of the unit. |
CREATED_DATE | DateTime |
Description | The date the rental was created. |
CREATED_BY_ID | Long |
Description | The user’s ID number that created the rental. |
CREATED_BY_NAME | String |
Description | The first and last name of the user that created the rental. |
UPDATED_DATE | DateTime |
Description | The date that the rental was last updated. |
UPDATED_BY_ID | Long |
Description | The user’s ID number that last updated the rental. |
UPDATED_BY_NAME | String |
Description | The first and last name of the user that last updated the rental. |
ORG_ID | Long |
Description | The organization’s ID number. |
Example
We’ll assume you’ve got a web reference, let’s name it BulkData, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a user request object and a data request object. We can define and create those like this:
// Create request and response objects
BulkData.LookupUser_Request user_request = new BulkData.LookupUser_Request();
BulkData.BulkDataSoapClient service = new BulkData.BulkDataSoapClient();
BulkData.BulkData_Request request = new BulkData.BulkData_Request();
Here’s my sample code of the Request and user objects.
// request
user_request.Username = "user";
user_request.Password = "pass";
user_request.Channel = 999;
request.OrgID = 123546;
request.BeginDate = DateTime.Today.AddDays(-1);
request.BeginDate = DateTime.Today;
Finally we can call the method and pass across the login object and the request object to retrieve our data. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
BulkData.BulkRentals_Response response;
response = service.GetBulkRentals(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 BulkData Methods.