Archive

Archive for the ‘Lookups’ Category

RULE_VALUES Reference

November 11, 2016 Leave a comment

Reference for methods using the RULE_VALUES object.

Name DataType
ABLE_INVOKED String
Description “Y” if the invoked icon should show next to the rule in the Org rules form in Store, “N” if it should not.
ACTIVE String
Description “Y” if the rule is currently “Active”, “N” if it is not.
CLASS_VALUE String
Description The type of object the rule applies to.
CONFIG_ID Decimal
Description The rule value’s ID number.
CREATED_BY Long
Description The Store user’s ID that created the field.
DEP_RULE_ID Decimal
Description The dependent rule’s ID number. For example, if the Auto-Reconcile Cash rule is set to “True”, there are three child rules that are ignored.
DEP_VALUE String
Description The parent rule’s name, if applicable.
DESCRIPTION String
Description A brief description of the item type.
DISP_ORDER Integer
Description The numeric value of the display order for the end rental rules.
DISPLAY String
Description The rule’s display values.
ENTITY_NAME String
Description The org or site name, depending on whether the rule is an Org or Site level rule.
LOOKUP_IS_VIRTUAL Boolean
Description “True” if the lookup is a virtual lookup, “False” if not.
LOOKUP_SET Decimal
Description The lookup ID number.
LOOKUP_USED Boolean
Description “True” if the values are lookups from the cfg_lookups table, “False” if not.
NEG_ONE_MEANING String
Description The value to display in the default value field if no default value is set.
PARENT_ID Long
Description The parent ID number of the site or organization owning the rule.
RULE_CLASS Decimal
Description The numeric value for the category the rule belongs to.
RULE_ID Long
Description The rule’s ID number.
RULE_LEVEL String
Description “Org” or “Site” to indicate what level the rule originates.
RULE_NAME String
Description The rule’s name.
RULE_TYPE Integer
Description The rule type.
SITE_VALUE String
Description The numeric value assigned to the rule.
SITE_VALUE_MEANING String
Description The textual value, if different from the actual value. (I.E., A site has a penalty for vacating without notification. A SITE_VALUE of 4 would indicate that the customer would have a ‘percentage’ penalty of their rent for vacating without notice. The SITE_VALUE would be 4, the SITE_VALUE_MEANING would be ‘% of Refund Penalty’.)
UPDATED_BY Long
Description The Store user’s ID number that last updated the field.
VALUE_DATATYPE Integer
Description A numeric value for the data type of the rule.
VALUE_DEFAULT String
Description The default value of the rule.
VALUE_DEFAULT_MEANING String
Description A textual description of the default value rule.
VALUE_IS_REFERENCE Boolean
Description “True” if the value is a reference to another rental item, “False” if not.
VALUE_LEN Integer
Description The maximum number of characters allowed, if the is a string.
VALUE_MAX Decimal
Description The maximum amount of the value if the value is numeric.
VALUE_MIN Decimal
Description The minimum amount of the value if the value is numeric.
RULE_VALUES RULE_VALUES
Description The rule display. If there is a subset of a rule, this will populate the rule values of that subset.
Categories: API General, Lookups, Rules

SWS eUnitAccessType Method

May 12, 2011 Leave a comment

Retrieves an organizations custom rental item access types (i.e., Exterior, Interior, Ground Level, etc.).

Parameters

Name DataType Is Required
OrgID Long Required
Description The organization’s ID number.

Returned Parameters

Name DataType
CFG_LOOKUPS CFG_LOOKUPS
Description The data object containing all the information about the organizations customized unit access types.

Example

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 and a eUnitAccessType response object. We can define and create those like this:

// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.CFG_LOOKUPS[] response;

Finally we can call the method and pass in the org ID 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.eUnitAccessType(123456);
}
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

Categories: API General, Lookups, Site Administration Tags: , ,

SWS eUnitClimate Method

May 12, 2011 Leave a comment

Retrieves a rental item’s “Climate” types.

Parameters

Name DataType Is Required
OrgID Long Required
Description The organization’s ID number.

Returned Parameters

Name DataType
CFG_LOOKUPS CFG_LOOKUPS
Description Object containing all the information about the climate types available.

Example

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 and a eUnitClimate response object. We can define and create those like this:

// Create a response object
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.CFG_LOOKUPS[] response;

Finally we can call the method and pass in the org ID 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.eUnitClimate(123456);
}
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.

Categories: API General, Lookups, Site Administration Tags: , ,

SWS eUnitAttr01 Method

May 12, 2011 Leave a comment

Retrieves the list of custom items that organization has created for their attribute 1.

Parameters

Name DataType Is Required
OrgID Long Required
Description The organization’s ID number.

Returned Parameters

Name DataType
eUnitAttr01Result CFG_LOOKUPS
Description An array of each item in the organization’s custom list of their Attribute01.

Example

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 and a eUnitAttr01response object. We can define and create those like this:

// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.CFG_LOOKUPS[] response;

Finally we can call the method and pass the org ID 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.eUnitAttr01(123456);
}
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.

Categories: API General, Lookups, Site Administration Tags: , ,