Home > API General, Promotions (PCD), Rental/Reservation, Search > SWS GetUnitDataWithPromos Method

SWS GetUnitDataWithPromos Method


Retrieves a collection of unit data for the specified site based on the the filters requested. Can include promotional data.

Parameters

Name DataType Is Required
AccessType Integer Optional
Description The numeric value for the “Access Type” custom look up as defined by the site. See eUnitAccessType for the available values.
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 “Attribute02” custom look up as defined by the site. See eUnitAttr02 for the available values.
ClassType Long Optional
Description The numeric value for the “Class” custom look up as defined by the site. See eUnitClass for the available values.
Climate Integer Optional
Description The numeric value for the “Climate” custom look up as defined by the site. See eUnitClimate for the available values.
Depth Decimal Optional
Description The depth measurment for the unit. This can also be an array.
Door Integer Optional
Description The numeric value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values.
Features Integer Optional
Description The numeric value for the “Features” custom look up as defined by the site. See eUnitFeatures for the available values.
HardReservable Boolean Optional
Description Applies a filter to returne units that are available to be place on a hard reservation (“True”) or not (“False”).
Height Decimal Optional
Description The height measurement of the unit. This can also be an array.
MaxRentRate Decimal Optional
Description Adds a filter to limit the units returned to this amount for the maximum rent rate.
MinRentRate Decimal Optional
Description Adds a filter to limit the units returned to this amount for the minimum rent rate.
ObjectGroup ObjectGroups Optional
Description The rental object group name. Available values:

  • Unknown
  • Storage
  • Parking
  • NonStorage
PromoDataType PCDTypeOptions Optional
Description Filters the return to only those units with the specified promotion type. Available values:

  • None
  • HighestPriorityPromotion
  • AllPromotions
  • HighestPriorityDiscount
  • AllDiscounts
  • HighestPriorityRateMod
  • AllRateMods
  • All
  • HighestPriorityDiscountAndPromo
  • HighestPriorityPCDAndRateMod
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
SoftReservable Boolean Optional
Description Applies a filter to return units that are available to be place on a soft reservation (“True”) or not (“False”).
Status ArrayOfUnitStatusValues Optional
Description The numeric status attribute value for the unit.
Available values:

  • Unknown
  • Available
  • Reserved
  • Rented
  • CompanyUse
  • UnavailableDamaged
  • UnavailablePermanent
  • VirtualLinkedUnits (Not Currently Used)
  • Other
  • UnavailablePending
  • AvailableHold
UnitIDs Long Optional
Description The unit ID or an array of unit IDs. This is returned when you use any of the GetSiteUnitData calls and is maintained through rentals.
UnitNumbers String Optional
Description The unit’s number, or an array of unit numbers, as assigned by the organization. This is not the UnitID.
Width Decimal Optional
Description The unit width or an array of unit widths.

Returned Parameters

Name DataType
AccessValue String
Description The textual value for the “Access Type” custom lookup as defined by the site. See eUnitAccessType for the available values.
AccessValueID Integer
Description The numeric value for the “Access Type” custom look up as defined by the site. See eUnitAccessType for the available values.
AlarmChannel Integer
Description No longer used.
Attribute01Value String
Description The textual value for the “Attribute01” custom lookup as defined by the site. See eUnitAttr01 for the available values.
Attribute01ValueID Integer
Description The numeric value for the “Attribute01” custom look up as defined by the site. See eUnitAttr01 for the available values.
Attribute02Value String
Description The textual value for the “Attribute02” custom lookup as defined by the site. See eUnitAttr02 for the available values.
Attribute02ValueID Integer
Description The numeric value for the “Attribute02” custom look up as defined by the site. See eUnitAttr02 for the available values.
ClassActive Boolean
Description Indicates if the revenue class is active (“True”) or not (“False”).
ClassDescription String
Description The textual value for the “Class” custom lookup as defined by the site. See eUnitClass for the available values.
ClimateValue String
Description The textual value for the “Climate” custom lookup as defined by the site. See eUnitClimate for the available values.
ClimateValueID Integer
Description The numeric value for the “Climate” custom look up as defined by the site. See eUnitClimate for the available values.
CreatedBy Long
Description The ID of the store user who created the unit.
CreatedDate DateTime
Description The date the unit was created.
PromotionCollection APPL_BEST_PCD
Description The object containing all the PCD details.
DeepestDiscount PCDItem
Description The object containing the discount level details.
DelinquencyModelID Long
Description The ID of the delinquency schedule assigned to the unit.
DepositGroupID Long
Description The deposit schedule ID assigned to the unit.
Depth Decimal
Description The unit’s depth measurement.
DoorValue String
Description The textual value for the “Door” custom lookup as defined by the site. See eUnitDoor for the available values.
DoorValueID Integer
Description The numeric value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values.
FeaturesValue String
Description The textual value for the “Features” custom lookup as defined by the site. See eUnitFeatures for the available values.
FeaturesValueID Integer
Description The numeric value for the “Features” custom look up as defined by the site. See eUnitFeatures for the available values.
FeeObjectID Long
Description The ID of the admin fee assigned to the revenue class to which the unit belongs.
FOMIndicator Boolean
Description Indicates if the unit is a first of the month rental cycle (“True”) or not (“False”).
FutureRate Decimal
Description If there is a rate change scheduled on the unit, this indicates the amount of the new rate.
GateKeyPadZone Integer
Description The gate keypad zone assigned to the unit.
HardReservable Boolean
Description Indicates if the unit can be place on a hard reservation (“True”) or not (“False”).
Height Decimal
Description The unit’s height measurement.
Icon String
Description The URL to the icon displayed in the Store application.
IsPortable Boolean
Description Indicates if the unit is portable (“True”) or not (“False”).
LeaseGroupID Long
Description The ID of the group of lease documents assigned to the unit’s revenue class.
LinkID Long
Description Not currently used.
MaximumRate Decimal
Description The maximum rate for which a unit of this type will rent.
MinimumRate Decimal
Description The minimum rate for which a unit of this type will rent.
MUX Integer
Description Not currently used.
Notes String
Description Any notes about the unit.
ObjectGroup ObjectGroups
Description Indicates the object group to which the unit belongs. Available values:

  • Unknown
  • Storage
  • Parking
  • NonStorage
ObjectPeriodUOM String
Description Indicates the length of the unit’s cycle. Currently all cycles are “Month”.
OrgClassID Long
Description The ID of the revenue class to which the unit belongs.
ProformaRate Decimal
Description The current proforma rate assigned to the unit.
PushRate Decimal
Description The current push rate assigned to the unit.
RackRate Decimal
Description The current rack rate assigned to the unit.
RentRate Decimal
Description The current rent rate assigned to the unit.
ReservationAmount Decimal
Description The amount of the deposit required to put a unit on a hard reservation.
ReservationGroupID Long
Description The ID of the reservation deposit applicable to the unit.
SerialNumber1 Long
Description Not currently used.
SerialNumber2 Long
Description Not currently used.
SiteClassID Long
Description The revenue class to which the unit belongs.
SoftReservable Boolean
Description Indicates if the unit can be place on a soft reservation (“True”) or not (“False”).
SquareFeet Decimal
Description The unit’s square footage total.
Status UnitStatusValues
Description The unit’s status. Available values:

  • Unknown
  • Available
  • Reserved
  • Rented
  • CompanyUse
  • UnavailableDamaged
  • UnavailablePermanent
  • VirtualLinkedUnits (Not Currently Used)
  • Other
  • UnavailablePending
  • AvailableHold
StreetRate Decimal
Description The current street rate of the unit. This is the default rate of the unit at time of rental.
TaxGroupID Long
Description The ID of the tax group assigned to the revenue class of the unit.
TotalAvailable Decimal
Description The number of units, matching all attributes, that are available to rent.
UnitCount Decimal
Description The total number of units, matching all attributes, that exist at the site.
UnitID Long
Description The unit’s ID number. This is maintained through rentals.
UnitNumber String
Description The unit’s number as assigned by the organization. This is not the UnitID.
UpdatedDate DateTime
Description The date the unit was last updated.
Version Decimal
Description The unit’s version number which serves to prevent duplicate use of the unit.
Volume Decimal
Description The unit’s volume measurement.
WalkThruOrder Integer
Description The location the unit falls in the walk thru of the site.
Width Decimal
Description The unit’s width measurement.
UpdatedBy Long
Description The ID of the store user who last updated the unit.

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

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

Here’s sample code of the Request object for all available units for a site with the highest priority promotion available for the unit.

// GetUnitDataWithPromos Request
request.SiteID = 123456;
request.Status = new SWS.UnitStatusValues[] { SWS.UnitStatusValues.Available };
request.PromoDataType = SWS.PCDTypeOptions.HighestPriorityPromotion;

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