Archive

Archive for the ‘Rental/Reservation’ Category

SWS2 GetSiteUnitData Method

April 6, 2017 Leave a comment

Retrieves a list of available unit types including one unit of each type.

Parameters

Name Data Type Is Required
Access Integer (or an array of integers) Optional
Description The numeric value for the “Access” custom look up as defined by the site. See eUnitAccessType for the available values.
Attribute01 Integer (or an array of integers) Optional
Description The numeric value for the “Attribute01” custom look up as defined by the site. See eUnitAttr01 for the available values.
Attribute02 Integer (or an array of integers) Optional
Description The numeric value for the “Attribute02” custom look up as defined by the site. See eUnitAttr02 for the available values.
Channel Integer Optional
Description Indicates from what application the unit will be reserved.
Climate Integer (or an array of integers) 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 measurement of the unit.
Door Integer (or an array of integers) Optional
Description The numeric value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values.
Feature Integer (or an array of integers) Optional
Description The numeric value for the “Features” custom look up as defined by the site. See eUnitFeatures for the available values.
Height Decimal Optional
Description The height measurement of the unit.
MaxRentRate Decimal Optional
Description The maximum rent rate of the unit.
MinRentRate Decimal Optional
Description The minimum rent rate of the unit.
ObjectGroup Integer Not Used
Description Not currently used.
PromoDataType String
Description
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
Status Integer (or an array of integers) Optional
Description The numeric value for the “Status” custom look up as defined by the site. See eUnitStatus for the available values.
Width Decimal Optional
Description The width measurement of the unit.

Returned Parameters

Name Data Type
SITE_ID Long
Description The site’s ID number.
CLASS_DESC String
Description The textual value of the revenue class to which the unit belongs.
SITE_CLASS_ID Long
Description The revenue classes ID number.
OBJECT_GROUP Integer
Description Not currently used.
UNIT_ID Long
Description The unit’s ID number. This is maintained through rentals.
VERSION Integer
Description The unit’s version number which serves to prevent duplicate use of the unit.
RENT_RATE Decimal
Description The current rate at which the unit should be rented.
PUSH_RATE Decimal
Description The lowest rate that is available for the unit. Usually this rate has restrictions, set up by the site, on when it can be used.
STREET_RATE Decimal
Description The default rate of the unit. This is usually the rate at which a unit will be rented when the current tenant moves out.
RACK_RATE Decimal
Description The highest rate available on a unit. This usually has restrictions, set up by the site, on when it can be used.
FUTURE_RATE Decimal
Description If a rate change has been scheduled for the unit, this will be the rate to which it will change.
PROFORMA_RATE Decimal
Description This is used as a goal or base rate.
MIN_RENT_RATE Decimal
Description The minimum rate, set by the site, for a which a unit can be rented.
MAX_RENT_RATE Decimal
Description The maximum rate, set by the site, for which a unit can be rented.
STATUS Integer
Description The numeric value for the “Status” custom look up as defined by the site. See eUnitStatus for the available values.
WIDTH Decimal
Description The width measurment of the unit.
DEPTH Decimal
Description The depth measurement of the unit.
HEIGHT Decimal
Description The height measurement of the unit.
SQUARE_FEET Decimal
Description The area of the unit. This is calculated by multiplying the WIDTH times the DEPTH.
VOLUME Decimal
Description The volume of the unit. This is calculated by multiplying the WIDTH, DEPTH and HEIGHT.
TOTAL_AVAILABLE Integer
Description The number of available units of this type.
TOTAL_UNITS Integer
Description The total number of units of this type.
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 look up 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.
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.
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.
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.
RESERVATION_DEPOSIT Decimal
Description The amount required to hold a reservation.
PROMOCOLLECTION CollectionOfPCD
Description The collection of data applicable to the available promotions/discounts for the unit.

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

// Create a request and response objects
StoreServiceClient client = new StoreServiceClient();
GetSiteUnitData_Request request = new GetSiteUnitData_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
    UnitType[] resp;
    resp = client.GetSiteUnitData(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 CancelReservation Method

April 6, 2017 Leave a comment

Allows you to cancel a reservation or an array of reservations.

Parameters

Name Data Type Is Required
AcctID Long Required
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
AccountID Long Required
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
Address1 String Required
Description The first address line of the contact’s address.
Address2 String Required
Description  The second address line of the contact’s address.
City String Required
Description  The city of the contact’s address.
ContactName String Required
Description The first and last name of the account contact.
Country String Required
Description The country of the contact’s address.
PostalCode String Required
Description The postal/ZIP code of the contact’s address.
RentalID Long Required
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
State String Required
Description The state/province of the contact’s address.
DenyDepositRefund Boolean Required
Description Indicates the deposit will be refunded (“True”) or retained (“False”).
DenyRefundReason String Required
Description An explanation of why the refund of the deposit was denied.
LostDemandNotes String Required
Description Explanation of why the customer chose to cancel the reservation rather than rent the unit.
LostDemandReason Integer Required
Description The reason the customer chose not to rent. This can be customized by the organization’s admin. Contact the organization for their list of reasons.
QuoteIds Long Required
Description The quote IDs that you wish to cancel. This can be a single quote id or an array. The quote ID is returned when you use the MakeReservation method.
RentalIDs Long Required
Description The rental IDs that you wish to cancel. This can be a single rental ID or an array. The rental ID is returned when you use the MakeReservation method. This array needs to match 1 to 1 with the QuoteIds array.
SiteID Long Required
Description The site’s ID number. This can be found using the SearchBy method.

Returned Parameters

Name Data Type
AvailableRefundAmount Decimal
Description The amount that is being refunded to the customer.
ErrorMessage String
Description The message explaining why the cancellation was unsuccessful.
HasDeposit Boolean
Description Indicates if there was a deposit on the reservation (“True”) or not (“False”).
ObjectID Long
Description The unit’s ID number. This is maintained through rentals.
RefundMessage String
Description
Succeeded Boolean
Description “True” indicates that the reservation/s were cancelled successfully, or “False” if not.
TranID Long
Description The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. A null or “0” response indicates the transaction failed.

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 CancelReservation_Request request object and a SWS2ContactInfo object. You will also need to pass in credentials. We can define and create those like this:

// Create a request and response objects
StoreServiceClient client = new StoreServiceClient();
CancelReservation_Request request = new CancelReservation_Request();
SWS2ContactInfo thisCon = new SWS2ContactInfo();

As with every method we need to pass in credentials. We also set up the parameters for our request.

//Cancel reservation setup
client.ChannelFactory.Credentials.UserName.UserName = "user";
client.ChannelFactory.Credentials.UserName.Password = "pass";
client.ChannelFactory.Credentials.SupportInteractive = true;

thisCon.AccountID = 123456;
thisCon.RentalID = 123456;
thisCon.ContactName = "John Doe";

request.SiteID = 123456;
request.AcctID = 123456;
request.ContactData = thisCon;
request.RentalIDs = new long[] { 123456 };

Finally we can call the method and pass across the login object and the request object to cancel the reservation. It’s a good idea to do this in a Try Catch block.

try
{
    // Call the method that will load the response object
    object resp;
    resp = client.CancelReservation(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.

SWS GetUnitDataWithPromos Method

February 15, 2017 Leave a comment

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.

QUOTE_RECONCILIATION Reference

December 7, 2016 Leave a comment

Reference for any method using the QUOTE_RECONCILIATION object.

Name DataType
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.
ATTRIBUTE01 String
Description The textual value for the “Attribute01” custom lookup as defined by the site. See eUnitAttr01 for the available values.
ATTRIBUTE01_VAL Integer
Description The numeric value for the “Attribute01” custom look up as defined by the site. See eUnitAttr01 for the available values.
CONTACT_ADDRESS String
Description The primary contact’s address.
CREATED DateTime
Description The date the quote was created.
CREATED_BY Long
Description The user’s ID that created the quote.
EMAIL String
Description The email address for the account or primary contact.
EXPIRATION DateTime
Description The date the quote record expired and was no longer available to the tenant.
FIRST_NAME String
Description The given name for the account/rental contact.
INQUIRY_SOURCE_VAL Integer
Description The inquiry source for the quote. Will show “Unknown” if no inquiry source was entered at the time of the quote.
LAST_NAME String
Description The family name for the rental contact.
MARKET_CODE_VAL String
Description Similar to “Inquiry Source”, indicates the market from which the customer heard of the site.
Not available at all sites
MARKET_SOURCE_VAL String
Description Similar to “Inquiry Source”, indicates the market from which the customer heard of the site.
Not available at all sites
ORG_ID Long
Description The organization’s ID number.
PHONE String
Description The phone number of the primary contact.
QUOTE_ID Long
Description The quote’s ID number.
DISCOUNT_AMOUNT_OFFERED Integer
Description The dollar amount of any discount offered at the time of the quote.
QUOTE_SOURCE String
Description The system used to create the quote record.
QUOTE_START_DATE DateTime
Description The date the quote was initially created.
QUOTE_STATUS_VAL Integer
Description Indicates the numeric value for the type of quote record. Available values:

  • 1 – Open
  • 2 – Confirmed
  • 3 – Expired
  • 4 – Cancelled
  • 5 – Rented
  • 6 – In-Process
QUOTE_TYPE String
Description The numeric value for the type of quote record that was initially created. Available values:

  • 1 – Quote
  • 2 – Soft Reservation
  • 3 – Hard Reservation
QUOTE_TYPE_VAL Integer
Description  The textual value for the type of quote record that was initially created. Available values:

  • Quote – 1
  • Soft Reservation – 2
  • Hard Reservation -3
QUOTED_RATE Integer
Description The monthly rate quoted in the quote record.
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 Store.
STATUS String
Description  Indicates the textual value for the type of quote record. Available values:

  • Open – 1
  • Confirmed – 2
  • Expired – 3
  • Cancelled – 4
  • Rented – 5
  • In-Process – 6
UNIT_DIMENSIONS String
Description The unit’s dimensions. Includes width and depth, and if in the system, height.
UNIT_NUMBER String
Description The unit’s number as assigned by the organization. This is not the UnitID.
UNIT_STATUS_VAL String
Description The current status for the rental unit of the quote record. (I.E., Available, Reserved, Rented.)
USER_NAME String
Description The username of the person that created the quote record.