BulkData GetBulkUnits Method
Retrieves a list of units that have been created or updated in the last 48 hours.
Parameters
Name | Data Type | Is Required |
---|---|---|
OrgID | Long | Required |
Description | The organization’s ID number. | |
BeginDate | DateTime | Required |
Description | The beginning date of the date range for which to pull the list of new accounts. This date cannot be more then 96 hours in the past. | |
EndDate | DateTime | Optional |
Description | The end date of the date range for which to pull the list of new accounts. This will default to SYSDATE if left undefined. |
Returned Parameters
Name | Data Type |
---|---|
UNIT_ID | Long |
Description | The unit’s ID number. This is maintained through rentals. |
UNIT_NUMBER | String |
Description | The unit’s number as assigned by the organization. This is not the UnitID. |
SITE_ID | Long |
Description | The site’s ID number. |
SITE_NAME | String |
Description | The name of the site as it appears in Store. |
SITE_CLASS_ID | Long |
Description | The ID of the revenue class to which the unit belongs. |
TAX_GROUP_ID | Long |
Description | The ID of the tax group that is applicable to the unit. |
TAX_GROUP_NAME | String |
Description | The name of the tax group that is applicable to the unit. |
LEASE_GROUP_ID | Long |
Description | The ID of the group of documents that is set up to be printed when a lease is created. |
LEASE_GROUP_NAME | String |
Description | The name of the group of documents that is set up to be printed when a lease is created. |
RESERVATION_DEP_GRP_ID | Long |
Description | The ID for the fee that is required to hold a reservation. |
RESERVATION_DEP_GRP_NAME | String |
Description | The name of the fee that is required to hold a reservation. |
SECURITY_DEP_GRP_ID | Long |
Description | The ID for the security deposit required when the unit is leased. |
SECURITY_DEP_GRP_NAME | String |
Description | The name of the security deposit required when the unit is leased. |
WIDTH | Decimal |
Description | The width measurement of the unit. |
DEPTH | Decimal |
Description | The depth measurement of the unit. |
HEIGHT | Decimal |
Description | The height measurement of the unit. |
VOLUME | Decimal |
Description | The volume measurement of the unit. Calculation: WIDTH x DEPTH x HEIGHT. |
SQUARE_FEET | Decimal |
Description | The square footage measurement of the unit. Calculation: WIDTH x DEPTH. |
ATTRIBUTE01_NUM | Integer |
Description | The numeric value for the “Attribute01” custom look up as defined by the site. See eUnitAttr01 for the available values. |
ATTRIBUTE01_VAL | String |
Description | The textual value for the “Attribute01” custom look up as defined by the site. See eUnitAttr01 for the available values. |
ATTRIBUTE02_NUM | Integer |
Description | The numeric value for the “Attribute02” custom look up as defined by the site. See eUnitAttr02 for the available values. |
ATTRIBUTE02_VAL | String |
Description | The textual value for the “Attribute02” custom look up as defined by the site. See eUnitAttr02 for the available values. |
CLIMATE_TYPE_NUM | Integer |
Description | The numeric value for the “Climate” custom look up as defined by the site. See eUnitClimate for the available values. |
CLIMATE_TYPE_VAL | String |
Description | The textual value for the “Climate” custom look up as defined by the site. See eUnitClimate for the available values. |
DOOR_TYPE_NUM | Integer |
Description | The numeric value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values. |
DOOR_TYPE_VAL | String |
Description | The textual value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values. |
ACCESS_TYPE_NUM | Integer |
Description | The numeric value for the “AccessType” custom look up as defined by the site. See eUnitAccessType for the available values. |
ACCESS_TYPE_VAL | String |
Description | The textual value for the “AccessType” custom look up as defined by the site. See eUnitAccessType for the available values. |
DEL_MODEL_ID | Long |
Description | The ID for the delinquency schedule assigned to the unit. |
FEE_OBJECT_ID | Long |
Description | The ID for the admin fee assigned to the unit. |
FEATURES | Integer |
Description | The numeric value for the “Features” custom look up as defined by the site. See eUnitFeatures for the available values. |
SERIAL01 | Long |
Description | Not currently used. |
SERIAL02 | Long |
Description | Not currently used. |
NOTES | String |
Description | Any notes that may have been applied to the unit. |
STATUS_NUM | Integer |
Description | The numeric value for the rental status of the unit. |
STATUS_VAL | String |
Description | The textual value for the rental status of the unit. |
WALK_THRU_ORDER | Integer |
Description | The numeric indicator of where the unit falls within the walk thru of the site. |
LINK_ID | Long |
Description | Not currently used. |
MUX | Integer |
Description | Not currently used. |
ALARM | Integer |
Description | Not currently used. |
GATE_KEPAD | Integer |
Description | The default keypad zone of the unit within the gate software. |
VERSION | Integer |
Description | The unit’s version number which serves to prevent duplicate use of the unit. |
CREATED_DATE | DateTime |
Description | The date the unit was created. |
CREATED_BY_ID | Long |
Description | The user’s ID that created the unit. |
CREATED_BY_NAME | String |
Description | The first and last name of the user that created the unit. |
UPDATED_DATE | DateTime |
Description | The date that the unit was most recently updated. |
UPDATED_BY_ID | Long |
Description | The user’s ID that most recently updated the unit. |
UPDATED_BY_NAME | String |
Description | The first and last name of the user that most recently updated the unit. |
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 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.BulkUnits_Response response;
response = service.GetBulkUnits(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.