Archive
SWS2 GetDataView Method – quote_reconciliation_3_v
The new view is quote_reconciliation_3_v which is a duplicate of quote_reconciliation_2_v and includes postal_code, updated_by and updated_user.
Returned Parameters
Name | Data Type |
---|---|
QUOTE_ID | Long |
Description | The quote’s ID number. |
ORG_ID | Long |
Description | The organization’s ID number. |
CREATED_BY | Long |
Description | The user’s ID that created the quote/reservation. |
USER_NAME | String |
Description | The user’s username that created the quote/reservation. |
QUOTE_TYPE | Integer |
Description | The numeric value of the quote type for the quote/reservation. |
QUOTE_TYPE_VAL | String |
Description | The textual value of the quote type for the quote/reservation. |
STATUS | Integer |
Description | The numeric value of quote’s status. |
QUOTE_STATUS_VAL | String |
Description | The textual value of the quote’s status. |
QUOTE_SOURCE | String |
Description | The application source that created the quote/reservation. |
QUOTE_START_DATE | DateTime |
Description | The date the quote/reservation was originally created. |
EXPIRATION | DateTime |
Description | The date the quote/reservation is no longer available. |
ACCT_ID | Long |
Description | The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. |
CONTACT_ID | Long |
Description | The rental contact’s ID number. This is returned when using the CreateNewAccount or AddNewContact methods or you can search for it using the SearchBy method. |
ADDR_ID | Long |
Description | The primary contact’s address ID number. |
PHONE_ID | Long |
Description | The primary contact’s phone ID number |
SITE_ID | Long |
Description | The site’s ID number. This can be found using the GetSiteList method. |
SITE_NAME | String |
Description | The site’s name as it appears in the Store application. |
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. |
FIRST_NAME | String |
Description | The primary contact’s first name. |
LAST_NAME | String |
Description | The primary contact’s last name. |
CONTACT_ADDRESS | String |
Description | The primary contact’s complete address. This includes all applicable address lines, city, state/province and ZIP/postal code. |
PHONE | String |
Description | The primary contact’s phone number. |
String | |
Description | The primary contact’s email address. This acts as the username if eStore/eCommerce are supported. |
UNIT_NUMBER | String |
Description | The unit’s number as assigned by the organization. This is not the UnitID. |
UNIT_STATUS_VAL | String |
Description | The rental status of the unit. |
UNIT_DIMENSIONS | String |
Description | The width and depth measurements together as a string. |
ATTRIBUTE01 | 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. |
QUOTED_RATE | Decimal |
Description | The amount quoted for the monthly rental rate. |
DISCOUNT_AMOUNT_OFFERED | Decimal |
Description | The dollar amount of any discount applicable to the quote/reservation. |
MARKET_CODE_VAL | Integer |
Description | The numeric indicator as to where the customer heard about the site. This is available to only specific sites. |
MARKET_SOURCE_VAL | String |
Description | The textual indicator as to where the customer heard about the site. This is available to only specific sites. |
INQUIRY_SOURCE_VAL | String |
Description | Indicates how the customer heard about the site. |
CREATED | DateTime |
Description | The date the quote/reservation was initially created. |
UPDATED | DateTime |
Description | The date that quote/reservation was most recently updated. |
POSTAL_CODE | String |
Description | The ZIP/postal code of the primary contact’s address. |
UPDATED_BY | Long |
Description | The user’s ID that last updated the quote/reservation. |
UPDATED_USER | String |
Description | The username of the person that last updated the quote/reservation. |
SWS2 GetDataView Method – sws_new_rentals_v
This is the same view that is used in the “New Rental” report and provides a list of new rentals. This is available at the organization or site level.
Returned Columns
Name | Data Type |
---|---|
UNIT_NUMBER | String |
Description | The unit’s number as assigned by the organization. This is not the UnitID. This can be retrieved using any of the GetSiteUnitData methods. |
UNIT_ID | Long |
Description | The unit’s ID number. This is maintained through rentals. |
WIDTH | Integer |
Description | The width measurement of the unit dimensions. |
DEPTH | Integer |
Description | The depth measurement of the unit dimensions. |
AVGLOS | Decimal |
Description | The average length of stay, in months, of the tenants in this unit. |
HEIGHT | Integer |
Description | The height measurement of the unit dimensions. |
DIM_ATTRIB | String |
Description | The width and depth dimensions as well as the “Attribute01” as a string. |
RENTAL_START_DATE | DateTime |
Description | The date and time that the customer initiated the rental. |
RENT_RATE | Decimal |
Description | The rate at which the unit was rented. |
ACCT_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, such as a business account or a guardian account. |
FIRST_NAME | String |
Description | The first name of the primary contact. |
LAST_NAME | String |
Description | The last name of the primary contact. |
String | |
Description | The email of the primary contact. |
ADDRESS | String |
Description | A combination of all three address lines of the primary contact’s address |
CITY | String |
Description | The city of the primary contact’s address. |
STATE | String |
Description | The state/province of the primary contact’s address. |
POSTAL_CODE | String |
Description | The ZIP/postal code of the primary contact’s address. |
PHONE | String |
Description | The primary conact’s phone number. |
MOVED_IN_BY | String |
Description | The first and last name of the user that moved the customer into the unit. |
SITE_ID | Long |
Description | The site’s ID number |
SITE_NAME | String |
Description | The site’s name. |
ORG_ID | Long |
Description | The organization’s ID number. |
START_DATE | DateTime |
Description | The date the customer started the rental. |
CLASS_DESC | String |
Description | The textual description for the class type of the unit. |
ORG_NUMBER_XREF | String |
Description | The organization’s site number. This is not the site ID. |
CURR_STATUS | String |
Description | The current rental status of the specific unit. |
END_DATE | DateTime |
Description | If the rental has been terminated, this is the date the the rental was terminated. |
UNIT_NUM_SORT | String |
Description | A number used to allow us to sort the units in the application. |
SWS2 GetUnitData Method
If SiteIDs are provided then the result set will be those records matching the requested SiteIDs. Otherwise, the result set will be those records matching the specified search criteria.
Parameters
Name | Data Type | Is Required |
---|---|---|
AccessType | Integer | Optional |
Description | The numeric value for the “AccessType” custom look up as defined by the site. See eUnitAccessType for the available values. | |
Active | Boolean | Optional |
Description | Indicates if the unit is active (“True”) or not (“False”). | |
Attribute01 | Integer | Optional |
Description | The numeric value for the “Attribute01” custom look up as defined by the site. See eUnitAttr01 for the available values. | |
Attribute02 | Integer | Optional |
Description | The numeric value for the “Attribute0” custom look up as defined by the site. See eUnitAttr02 for the available values. | |
Channel | Integer | Optional |
Description | The indicator of what application is being used to pull the data. | |
ClassType | Integer | Optional |
Description | ||
Climate | Integer | Optional |
Description | The numeric value for the “Climate” custom look up as defined by the site. See eUnitClimate for the available values. | |
DepthDecimal | Decimal | Optional |
Description | The depth measurement of the unit. | |
Door | Integer | Optional |
Description | The numeric value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values. | |
Feature | Integer | Optional |
Description | The numeric value for the “Features” custom look up as defined by the site. See eUnitFeatures for the available values. | |
HeightDecimal | Decimal | Optional |
Description | The height measurement of the unit. | |
MaxRentRate | Decimal | Optional |
Description | The maximum rent that can be charged for the unit type. | |
MinRentRate | Decimal | Optional |
Description | The minimum rent that can be charged for the unit type. | |
SiteID | Long | Required |
Description | The site’s ID number. This can be found using the GetSiteList method. |
|
Status | Integer | Optional |
Description | The numeric value for the “Status” custom look up as defined by the site. See eUnitStatus for the available values. | |
UnitIDs | Long (or an array of longs) | Optional |
Description | Adds a filter for the unit’s ID number. This is returned when you use any of the GetSiteUnitData calls and is maintained through rentals. |
|
UnitNumber | String | Optional |
Description | The unit’s number as assigned by the organization. This is not the UnitID. | |
WidthDecimal | Decimal | Optional |
Description | The width measurement of the unit. |
Returned Parameters
Name | Data Type |
---|---|
SITE_ID | Long |
Description | The site’s ID number. |
UNIT_ID | Long |
Description | The unit’s ID number. This is maintained through rentals. |
ORG_CLASS_ID | Long |
Description | The organization’s revenue class ID number. |
SITE_CLASS_ID | Long |
Description | The site’s revenue class ID number. |
CLASS_DESC | String |
Description | The description of the site’s revenue class. |
CLASS_REF | Integer |
Description | The reference number assigned by the system to the site’s revenue class. |
ICON | String |
Description | The name of the icon that is displayed in the Store application. |
CLASS_TYPE | Integer |
Description | The class of rental applicable to the unit. |
ACTIVE | Boolean |
Description | Indicates if the unit is active (“True”) or not (“False”). |
STATUS | Integer |
Description | The numeric indicator of the unit’s rental status. |
STATUS_VAL | String |
Description | The textual value of the unit’s rental status. |
UNIT_NUMBER | String |
Description | The unit’s number as assigned by the organization. This is not the UnitID. |
ATTRIBUTE01 | Integer |
Description | The numeric value for the “Attribute01” custom look up as defined by the site. |
ATTRIBUTE01_VAL | String |
Description | The textual value for the “Attribute01” custom lookup as defined by the site. |
ATTRIBUTE02 | Integer |
Description | The numeric value for the “Attribute02” custom look up as defined by the site. |
ATTRIBUTE02_VAL | String |
Description | The textual value for the “Attribute02” custom lookup as defined by the site. |
ACCESS_TYPE | Integer |
Description | The numeric value for the “AccessType” custom look up as defined by the site. |
ACCESS_TYPE_VAL | String |
Description | The textual value for the “AccessType” custom lookup as defined by the site. |
CLIMATE | Integer |
Description | The numeric value for the “Climate” custom look up as defined by the site. |
CLIMATE_VAL | String |
Description | The textual value for the “Climate” custom lookup as defined by the site. |
DOOR | Integer |
Description | The numeric value for the “Door” custom look up as defined by the site. |
DOOR_VAL | String |
Description | The textual value for the “Door” custom lookup as defined by the site. |
FEATURES | Integer |
Description | The numeric value for the “Features” custom look up as defined by the site. |
FEATURES_VAL | String |
Description | The textual value for the “Features” custom lookup as defined by the site. |
VOL_EXEMPT | Boolean |
Description | Indicates if the unit has volume (“True”) or not (“False”). |
PORTABLE | Boolean |
Description | Indicates if the unit is portable (“True”) or not (“False”). |
RENT_RATE | Decimal |
Description | The current rate at which the unit should be rented. |
OBJ_PERIOD | Integer |
Description | The length, in months, of the unit’s rental period. |
OBJ_PERIOD_UOM | Integer |
Description | The type of rental period that applies to the unit. |
OBJ_PERIOD_UOM_VAL | String |
Description | The textual value of the OBJ_PERIOD_UOM. |
OBJ_INV_FREQ | Integer |
Description | The number of months to include on the invoice. |
FOM_IND | Boolean |
Description | Indicates if the unit should be first of the month (“True”) or not (“False”). |
GP_MULTIPLIER | Decimal |
Description | This is the gross potential multiplier. This is used to calculate the potential earnings of the unit if the UOM is not just 1 month. |
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. Calculated by multiplying the width, depth and height. |
SERIAL01 | Integer |
Description | Not currently used. |
SERIAL02 | Long |
Description | Not currently used. |
NOTES | String |
Description | Any notes that the site has added to the unit. |
WALK_THRU_ORDER | Integer |
Description | The order number where the unit falls during the walk through of the property. |
LINK_ID | Long |
Description | Not currently used. |
TAX_GROUP_ID | Long |
Description | The ID to the taxes that are charged to the unit. |
LEASE_GROUP_ID | Long |
Description | The ID to the group of documents generated at the time of lease. |
DEL_MODEL_ID | Long |
Description | The ID to the delinquency schedule used for the unit type. |
RES_GROUP_ID | Long |
Description | The ID to the applicable reservation deposit for the unit. |
DEP_GROUP_ID | Long |
Description | The ID to the applicable security deposit for the unit. |
MUX | Long |
Description | Not currently used. |
ALARM | Long |
Description | Not currently used. |
VERSION | Integer |
Description | The unit’s version number which serves to prevent duplicate use of the unit. |
FEE_OBJECT_ID | Long |
Description | The ID to the applicable administration fee for the unit. |
GATE_KEYPAD | Integer |
Description | The default gate keypad zone applicable to the unit. |
CREATED_BY | Long |
Description | The user’s ID that created the unit. |
UPDATED_BY | Long |
Description | The user’s ID that last updated the unit data. |
RES_AMOUNT | Decimal |
Description | The dollar amount of the reservation deposit. |
SQUARE_FEET | Integer |
Description | The area measurement of the unit. This is calculated by multiplying the width and the depth. |
PUSH_RATE | Decimal |
Description | The lowest rate at which the unit should be rented. |
Example
We’ll assume you’ve got a web reference, let’s name it Store, in your Visual Studio project. At this point we need to reference our objects. We’ll need the standard service object, a GetUnitData_Request request object. We can define and create those like this:
// Create a request and response objects
StoreServiceClient client = new StoreServiceClient();
GetUnitData_Request request = new GetUnitData_Request();
As with every method we need to pass in credentials. We also set up the parameters for our request.
client.ChannelFactory.Credentials.UserName.UserName = "user"; client.ChannelFactory.Credentials.UserName.Password = "pass"; client.ChannelFactory.Credentials.SupportInteractive = true; request.SiteID = 123456;
Finally we can call the method and pass across the login object and the request object to retrieve the data. It’s a good idea to do this in a Try Catch block.
try
{
// Call the method that will load the response object
System.Data.DataTable resp;
resp = client.GetUnitData(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 SWS2 Methods.
SWS2 GetDataView Method – quote_reconciliation_2_v
This view is a duplicate of quote_reconciliation_v but includes acctID, contactID, AddrID and PhoneID.
Returned Parameters
Name | Data Type |
---|---|
QUOTE_ID | Long |
Description | The quote’s ID number. |
ORG_ID | Long |
Description | The organization’s ID number. |
CREATED_BY | Long |
Description | The user’s ID that created the quote/reservation. |
USER_NAME | String |
Description | The user’s username that created the quote/reservation. |
QUOTE_TYPE | Integer |
Description | The numeric value of the quote type for the quote/reservation. |
QUOTE_TYPE_VAL | String |
Description | The textual value of the quote type for the quote/reservation. |
STATUS | Integer |
Description | The numeric value of quote’s status. |
QUOTE_STATUS_VAL | String |
Description | The textual value of the quote’s status. |
QUOTE_SOURCE | String |
Description | The application source that created the quote/reservation. |
QUOTE_START_DATE | DateTime |
Description | The date the quote/reservation was originally created. |
EXPIRATION | DateTime |
Description | The date the quote/reservation is no longer available. |
ACCT_ID | Long |
Description | The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. |
CONTACT_ID | Long |
Description | The rental contact’s ID number. This is returned when using the CreateNewAccount or AddNewContact methods or you can search for it using the SearchBy method. |
ADDR_ID | Long |
Description | The primary contact’s address ID number. |
PHONE_ID | Long |
Description | The primary contact’s phone ID number |
SITE_ID | Long |
Description | The site’s ID number. This can be found using the GetSiteList method. |
SITE_NAME | String |
Description | The site’s name as it appears in the Store application. |
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. |
FIRST_NAME | String |
Description | The primary contact’s first name. |
LAST_NAME | String |
Description | The primary contact’s last name. |
CONTACT_ADDRESS | String |
Description | The primary contact’s complete address. This includes all applicable address lines, city, state/province and ZIP/postal code. |
PHONE | String |
Description | The primary contact’s phone number. |
String | |
Description | The primary contact’s email address. This acts as the username if eStore/eCommerce are supported. |
UNIT_NUMBER | String |
Description | The unit’s number as assigned by the organization. This is not the UnitID. |
UNIT_STATUS_VAL | String |
Description | The rental status of the unit. |
UNIT_DIMENSIONS | String |
Description | The width and depth measurements together as a string. |
ATTRIBUTE01 | 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. |
QUOTED_RATE | Decimal |
Description | The amount quoted for the monthly rental rate. |
DISCOUNT_AMOUNT_OFFERED | Decimal |
Description | The dollar amount of any discount applicable to the quote/reservation. |
MARKET_CODE_VAL | Integer |
Description | The numeric indicator as to where the customer heard about the site. This is available to only specific sites. |
MARKET_SOURCE_VAL | String |
Description | The textual indicator as to where the customer heard about the site. This is available to only specific sites. |
INQUIRY_SOURCE_VAL | String |
Description | Indicates how the customer heard about the site. |
CREATED | DateTime |
Description | The date the quote/reservation was initially created. |
UPDATED | DateTime |
Description | The date that quote/reservation was most recently updated. |