Archive

Posts Tagged ‘rental’

SWS RentalActivity Method

May 25, 2011 1 comment

Retrieves the rental activity statistics of a site or group of sites for today. (Date range is not currently available and defaults to the prior day.)

Parameters

Name DataType Is Required
EndDate DateTime Optional
Description Not currently available. Regardless of the date entered it will used today’s date as the end date.
OrgID Long Required
Description The organization’s ID number.
SiteIDs Long Array Required
Description The site’s ID number. This can be found using the GetSiteList method.
StartDate DateTime Optional
Description Not currently available. Regardless of the date entered it will used today’s date as the start date.

Returned Parameters

Name DataType
BeginningOccupancy Integer
Description The total number of occupied rental items at the start of the date range.
EndOccupancy Integer
Description The total number of occupied rental items at the end of the date range.
Net Integer
Description The total change to number of rental items at the end of the date range.
NewRentals Integer
Description The total number of new rental items at the end of the date range.
PercentOccupancy Decimal
Description The percentage of occupied units at the end of the date range.
RevenueChange Decimal
Description The amount of revenue increase or decrease at the end of the date range.
SiteID Long
Description The site’s ID number.
SiteName String
Description The site’s name.
SiteNumber String
Description The site’s number within the organization. This is not the site ID.
SQFTOccupancy Decimal
Description The total number of square feet occupied at the end of the date range.
TerminatedRentals Integer
Description The total number of terminated rentals at the end of the date range.
TotalUnits Integer
Description The total number of units at the site.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

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

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

Here is a sample code of the request object:

// RentalActivity Request
request.OrgID = 123456;
request.SiteIDs = new long[] { 123456, 456789 };

Finally we can call the method and pass across the login object and the request object 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.RentalActivity(user_request, request);
}
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.

SWS VerifyLogin Method

Verifies an eStore customer’s login information. This method returns additional information over the VerifyEcommLogin method. If the information doesn’t match you will receive an error.

Parameters

Name DataType Is Required
EmailAddress String Required
Description The email address of the contact. This acts as the username for eStore/eCommerce. Max string length of 100.
OrgID Long Required
Description The organization’s ID number.
Password String Required
Description The password/eCommerce code of the contact. Max string length of 30.

Returned parameters

Name DataType
ACCT_ID Long
Description The account’s ID number.
ACTIVE String
Description Indicates if the eStore/eCommerce account is active (“Y”) or not (“N”).
CFLEX01 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX02 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX03 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX04 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CFLEX05 String
Description A custom field, set up by the organization, designed to hold additional contact information. This is not displayed in the Store application.
CONTACT_ID Long
Description The rental contact’s ID number.
CONTACT_TYPE Integer
Description The numeric value for the contact type for the account.
Available values:

  • 1 – ACCOUNT_MANAGER
  • 2 – ACCOUNT_USER
  • 3 – ACCOUNT_CONTACT_ONLY
  • 4 – BUSINESS_CONTACT_RECORD
ECOMM_CODE String
Description No longer returned.
EMAIL String
Description The email address for the account or primary contact. This is also used as a username for eStore/eCommerce.
FIRST_NAME String
Description The first name of the rental contact.
KNOWN_AS String
Description The alternate or nick name for the rental contact.
LAST_NAME String
Description The family name for the rental contact.
ORG_ID Long
Description The organization’s ID number.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

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

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

Here is a sample code of the request object:

// Password Request
request.OrgID = 123456;
request.EmailAddress = "j.doe@b.c";
request.Password = "TestPass";

Finally we can call the method and pass across the login object and the request object 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.VerifyLogin(user_request, request);
}
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.

SWS GetTransactionRentals Method

May 23, 2011 Leave a comment

Retrieves information regarding rentals and retail related to a specified transaction.

Parameters

Name DataType Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
TranID ArrayOfLong Required
Description The transaction’s ID number. Transaction IDs are system generated for each monetary transaction that occurs in the system. If there is no transaction ID the transaction failed. The transaction ID is returned when any MakePayment method is used.

Returned Parameters

Name DataType
RENTAL_ID Decimal
Description The rental item’s ID number.
TNX_DATE DateTime
Description The date the transaction occurred.
TNX_ID Long
Description The transaction’s ID number.Transaction IDs are system generated for each monetary transaction that occurs in the system.
HasRetail Boolean
Description Indicates if the transaction included retail assessments (“True”) or not (“False”).
TranID Long
Description The transaction’s ID number. Transaction IDs are system generated for each monetary transaction that occurs in the system. This reiterates the first transaction ID.

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

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

Here’s my sample code of the Request object.

// GetTransactionRentals Request
request.SiteID = 123456;
request.TranID = new long[] { 123456 };

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