Archive

Archive for the ‘Leases’ Category

SWS createAndViewLetter Method

May 12, 2011 Leave a comment

Creates and displays an account letter (i.e., Lien Sale Notice, Welcome Letter, etc).

Parameters

Name DataType Is Required
LtrData swsLtrParams Required
Description The object containing all required and optional parameters to create the letter.

Returned Parameters

Name DataType
createAndViewLetterResult String
Description The URL where the letter is located.

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

// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.createOrViewLtr_Request request = new SWS.createOrViewLtr_Request();
SWS.PdfFilePath_Response response;

Here’s my sample code of the Request object.

// Letter link request
request.LtrData.siteId = 123456;
request.LtrData.acctId = 123456;
request.LtrData.unitNum = "A102";
request.LtrData.ltrTypeId = 123456;
request.LtrData.siteLtrRule = SWS.siteRuleLtrTypeGrpVals.RATECHANGE;
request.LtrData.isMailLocal = true;
request.LtrData.isCOM = false;
request.LtrData.certifiedType = SWS.certifiedVals.NONE;
request.LtrData.contactType = SWS.contactTypeVals.PRIMARY;
request.LtrData.contactOrAddrId = 123456;

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.createAndViewLetter(user_request, request);
}
catch (Exception ex)
{
   MessageBox.Show(ex.Message);
}

Here is what a returned path might look like:

https://csiapp1.centershift.com/qa40/letters/1000085746_1304609631.pdf

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.

Categories: API General, Doc Designer, Leases, Letters Tags:

SWS viewLeasePDF Method

April 28, 2011 Leave a comment

Provides a URL to view the requested document.

Parameters

Name DataType Is Required
LeaseId Long Required
Description The lease’s ID number. This can be found using the LEASE_DEF_ID from the getLeaseTemplateInfo method.
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
TntPdfFilePath String
Description The URL to where the lease document is stored. This is what a returned PDF lease path might look like:

https://csiapp1.centershift.com/qa40/letters/
     1000082928_1303989475.pdf

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

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

Here is a sample code of the request object:

// ViewLeasePDF Request
request.SiteID = 123546;
request.RentalId = 123456;
request.LeaseId = 123456;

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.viewLeasePdf(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.

Categories: API General, Leases Tags: ,