Archive
SWS GetBaseFees Method
Retrieves a list of all fees at the site.
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 |
|---|---|
| ORG_FEE_SITE_ALL | ORG_FEE_SITE_ALL |
| Description | Object containing details off the organizations fees. |
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 GetBaseFees request object and a GetBaseFees response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetBaseFees_Request request = new SWS.GetBaseFees_Request();
SWS.GetBaseFees_Response response;
Here’s my sample code of the Request object.
// GetBaseFees Request
request.SiteID = 123456;
Finally we can call the method and pass across the login object and the request object to get our base fees. 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.GetBaseFees(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 ApplyCreditToAssessments Method
Applies an already created Manager’s Credits to currently due assessments (non-volatile) or future assessments (volatile) that are within 30 days of being due. Manager’s Credits must have been added to the account using the AddUpdatePCD SWS method or through the application. Note: promotions, discounts and rate modications are not used with this SWS method.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AssessId | Long | Required |
| Description | The assessment’s ID number. This is retrieved using the GetAssessments method. | |
| AssessVersion | Integer | Required |
| Description | The assessment’s version number. This is retrieved using the GetAssessments method. | |
| ApplyAmt | Decimal | Required |
| Description | The amount to apply to the specified assessment. This can be all or only a portion of the available manager’s credit. | |
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| 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. | |
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| Successful | Boolean |
| Description | Indicates that the application of the manager’s credit was successful (“True”) or not (“False”). |
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, an ApplyCreditsToAssessments request object and an ApplyCreditsToAssessments response object. We can define and create those like this:
// Create request and response objects and assessment info object
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.ApplyCreditToAssessments_Request request = new SWS.ApplyCreditToAssessments_Request();
SWS.ApplyCreditToAssessments_Response response;
SWS.AssessInfo assess_data = new SWS.AssessInfo();
Here’s my sample code of the Request objects.
//Create assessment info object assess_data.AssessId = 123456; assess_data.AssessVersion = 3; assess_data.ApplyAmt = 10.50m; //Applies the credit to the assessment request.OrgID = 123456; request.SiteID = 123456; request.RentalID = 123456; request.AssessmentInfo = new SWS.AssessInfo[] { assess_data };
We can call the method and pass across the login object and the request object for applying credits to assessments. It’s a good idea to do this in a Try Catch block.
try
{
// Call the method that will load the response object
response = service.ApplyCreditToAssessments(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 AssessFee Method
Adds a fee (i.e., 10% Late Fee, Org Admin Fee, Standard Dumpster Fee, etc.) to a rental item.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| BaseFeeObj | ORG_FEE_SITE_ALL | Optional* |
| Description | The items required for assessing a base fee to the rental. See the GetBaseFees SWS method for available base fees. * Either BaseFeeObj or SchedFeeObj is required. |
|
| 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. | |
| SchedFeeObj | ORG_RENTAL_SCHEDULED_FEES | Optional* |
| Description | The items required for assessing a scheduled fee to the rental. See GetScheduledFees method for available scheduled fees. * Either BaseFeeObj or SchedFeeObj is required. |
|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| Succeeded | Boolean |
| Description | Indicates if the fee was added successfully to the account (“True”) or not (“False”). |
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 fee object, an AssessFee request object and an AssessFee response object. We can define and create those like this:
// Create a request and response objects and grab a fee from GetBaseFees
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.AssessFee_Request request = new SWS.AssessFee_Request();
SWS.AssessFee_Response response;
SWS.GetBaseFees_Response base_fee = service.GetBaseFees(user_request, fee_request);
Here’s my sample code of the Request object.
// Create the Assess fee request
request.SiteID = 123456;
request.RentalID = 123456;
request.BaseFeeObj = base_fee.Details[0];
Finally we can call the method and pass across the login object and the request object to assessing a fee. 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.AssessFee(user_request, request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the fee 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 AddMultipleServices Method
Adds one or more rental item services (i.e., 24 Hour Access, Portable Lockers, Snail Mail Billing, etc.) to a rental item. Services are created by an admin in the Store application.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| 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. | |
| Services | ORG_SERVICE_SITE_OFFERINGS | Required |
| Description | An array of rental item services (i.e., 24 Hour Access, Snail Mail Billing, Portable Lockers, etc.) available at the site. This array can be obtained from the GetAvailableServices SWS method. | |
Returns
| Name | DataType |
|---|---|
| ProcessMessage | String |
| Description | A message that indicates the error that occurred while trying to add the rental item service. |
| Service | ORG_SERVICE_SITE_OFFERINGS |
| Description | The rental item service that was added to the rental. |
| ServiceObjectID | Long |
| Description | If the call failed to add a service, this will indicates the rental item service ID which was not added to the rental. |
| Succeeded | Boolean |
| Description | Indicates success (“True”) or failure (“False”). |
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, an AddMultipleServices request object and an AddMultipleServices response object. We can define and create those like this:
// Create request and response objects SWS.WSSoapClient service = new SWS.WSSoapClient(); SWS.AddMultipleService_Request request = new SWS.AddMultipleService_Request(); SWS.AddMultipleServices_Response[] response; // Our response from GetAvailableServices SWS.GetAvailableServices_Response get_serv_response = new SWS.GetAvailableServices_Response();
Now we set up the parameters for our request.
//Add multiple services request object
request.SiteID = 123456;
request.RentalID = 123456;
request.Service = new SWS.ORG_SERVICE_SITE_OFFERINGS[]
{ get_serv_response.Details[0], get_serv_response.Details[1] };
Finally we can call the method and pass across the login object and the request object to adding the multiple services. It’s a good idea to do this in a Try Catch block.
try
{
// Call the method that will load the response object
response = service.AddMultipleServices(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.
Yardi Store Developer eXchange 