Home > API General, Letters > SWS viewLetterPdf Method

SWS viewLetterPdf Method


Provides a URL to view the requested document.

Parameters

Name DataType 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.
LtrNum Long Required
Description The letter’s ID number used by the Store application.
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 where the lease document is stored. Here is an example of the returned letter path:

https://csiapp1.centershift.com/qa40/letters/
                    1000082928_1303991083.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 ViewLtr 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.ViewLtr_Request request = new SWS.ViewLtr_Request();
SWS.PdfFilePath_Response response;

Here is a sample code of the request object:

// ViewLetterPDF Request
request.SiteID = 123546;
request.AcctId = 123456;
request.RentalId = 123456;
request.LtrNum = 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.viewLetterPdf(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, Letters Tags:
  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: