Home > API General, Insurance, Letters > SWS GetInsCancelWarningLetterInfo Method

SWS GetInsCancelWarningLetterInfo Method

This method allows insurance providers to access insurance cancellation warning letter data including when and where the letter was sent.


Name DataType Is Required
OrgID Long Required
Description The organization’s ID number.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList 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.

Returned Parameters

Name DataType
LetterName String
Description The name of the letter that was sent.
UnitNum String
Description The unit’s number as assigned by the organization. This is not the UnitID.
RentalID Long
Description The rental’s ID number.
CustomerAccountName String
Description The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account.
CustomerFirstName String
Description The contact’s first name.
CustomerLastName String
Description The customer’s last name.
CustomerAddressLine1 String
Description Line one of the contact’s address.
CustomerAddressLine2 String
Description Line two of the contact’s address.
CustomerCity String
Description The city of the contact’s address.
CustomerState String
Description The state/province for the contact’s address.
CustomerPostalCode String
Description The postal code from the customer’s address.
SiteID Long
Description The site’s ID number.
SiteName String
Description The name of the site where the rental is located.
OperatorNumber Long
Description The user’s id that created the letter.
DaysInsuranceIsCancelled Long
Description The number of days before insurance will be cancelled from the date the letter was sent.
DaysLetterSent Long
Description The number of days since the letter was sent.
DateLetterCreated DateTime
Description The date the letter was created.
ProjectedInsuranceCancellationDate DateTime
Description The expected date of cancellation.
CancellationDate DateTime
Description If cancellation has occurred, the date insurance was cancelled.
InsuranceEffectiveEndDate DateTime
Description The last date of coverage.


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

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

Now we set up the parameters for our request.

// get letter data request
request.OrgID = 123456;
request.SiteID = 123456;
request.RentalID = 123546;

Finally we can call the method and pass across the login object and the request object to retrieve the data. It’s a good idea to do this in a Try Catch block.

    // Call the method that will load the response object
    response = service.GetInsCancelWarningLetterInfo(user_request, request);
catch (Exception ex)

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.

Categories: API General, Insurance, Letters
  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 )

Facebook photo

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

Connecting to %s