Archive

Archive for the ‘Revenue Classes’ Category

SWS GetMiscRevenueClassData Method

May 17, 2011 Leave a comment

Retrieves a collection of miscellaneous revenue class data for making miscellaneous payments.

Parameters

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

Returned Parameters

Name Data Type
ClassID Long
Description The system generated ID for the revenue class.
MiscClassID Long
Description The system generated ID for the miscellaneous class of the organization.
Description String
Description The name of the revenue class.
ClassRef Long
Description The indicator of what type of revenue class this is.
TaxGroupID Long
Description If the revenue class is taxed this indicates which tax group is used.

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

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

Here’s my sample code of the Request object.

// GetMiscRevenueClassData Request
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to get our misc revenue class 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.GetMiscRevenueClassData(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.

SWS eUnitClass Method

Returns the site’s available rental revenue classes for a given site along with each unit type in that class.

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
ACCT_CATEGORY String
Description The site’s revenue class category.
APPL_RENTAL_
OBJECTS_DETAIL_NonOccupiable
APPL_RENTAL_OBJECTS_DETAIL
Description The object details of a non-occupiable rental unit. (I.E., mailboxes.)
APPL_RENTAL_
OBJECTS_DETAIL_Occupiable
APPL_RENTAL_OBJECTS_DETAIL
Description The object details of an occupiable rental unit.
CLASS_DESC String
Description The textual description of the site’s revenue class.
CLASS_TYPE Integer
Description The numeric value for the site’s revenue class type.
ICON String
Description The URL for the site revenue class icon that displays in the Store application.
SITE_CLASS_ID Long
Description The site’s revenue class ID number that describes the general rules for the site.
SITE_ID Long
Description The site’s ID number.

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

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

Finally we can call the method and pass in the site 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.eUnitClass(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.