Yardi Store Developer eXchange

Retrieves a collection of correspondence data for a specified account or rental. If you want all the letters on the account for all rentals use the AccountID. If you are looking for just a specific rental’s letters use the RentalID.

Parameters

Returned Parameters

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

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

Here’s my sample code of the Request object using the account ID, alternately you can use the rental ID.

// GetLetterInfo Request
request.AccountID = 123456;

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