Home > API General, Site Administration > SWS GetUnitFeatures Method

SWS GetUnitFeatures Method


Returns a collection of features for each type of rental item the site manages. No specific rental item identification or availability is included.

Parameters

Name DataType Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
ACCESS_TYPE Integer
Description The numeric value for the “Access Type” custom look up as defined by the site. See eUnitAccessType for the available values.
ACCESS_TYPE_VAL String
Description The textual value for the “Access Type” custom look up as defined by the site. See eUnitAccessType for the available values.
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.
ATTRIBUTE02 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 numeric value for the “Attribute02” custom look up as defined by the site. See eUnitAttr02 for the available values.
CLIMATE Integer
Description The numeric value for the “Climate” custom look up as defined by the site. See eUnitClimate for the available values.
CLIMATE_VAL String
Description The textual value for the “Climate” custom look up as defined by the site. See eUnitClimate for the available values.
DEPTH Decimal
Description The depth measurement of the rental item.
DOOR Integer
Description The numeric value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values.
DOOR_VAL String
Description The textual value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values.
FEATURES Integer
Description The numeric value for the “Features” custom look up as defined by the site. See eUnitFeatures for the available values.
FEATURES_VAL String
Description The textual value for the “Features” custom look up as defined by the site. See eUnitFeatures for the available values.
HEIGHT Decimal
Description The height measurement of the rental item.
SITE_ID Long
Description The site’s ID number.
WIDTH Decimal
Description The width measurement 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 GetUnitFeatures request object and a GetUnitFeatures response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetUnitFeatures_Request request = new SWS.GetUnitFeatures_Request();
SWS.GetUnitFeatures_Response response;

Here’s my sample code of the Request object.

// GetUnitFeatures Request
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to get our unit features. 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.GetUnitFeatures(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.

  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: