Archive

Archive for the ‘Letters’ Category

SWS GetSMSMessageData Method

January 18, 2018 Leave a comment

This method returns SMS message data for a specified SiteID, with available filters based on AccountID, RentalID and/or date range.

Parameters

Name DataType Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
AccountID Long Optional
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
RentalID Long Optional
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBymethod.
BeginDate DateTime Optional
Description The beginning date of the date range for which the SMS text message was scheduled.
EndDate DateTime Optional
Description The end date of the date range for which the SMS text message was scheduled.

Returned Parameters

Name DataType
Response String
Description “SUCCESS” indicates that the query was successful, or “FAILURE” if not. The “FAILURE” message will include additional information about why the method failed.
SMS_ID Long
Description The unique ID number for the SMS message.
SITE_ID Long
Description The site’s ID number.
RENTAL_ID Long
Description The ID number of the rental.
ACCT_ID Long
Description The account’s ID number.
SENT_DATE String
Description The date the message was sent.
SCHEDULED_DATE String
Description The date the message is scheduled to be sent.
SMS_TO String
Description The TO address (phone number) that the message is being sent to.
SMS_FROM String
Description The FROM address (phone number) that the message is being sent from.
SMS_BODY String
Description The body of the message.
SMS_STATUS Integer
Description The numeric value of the delivery status of the message.
Available values:

  • 0 – Not Sent
  • 1 – Accepted
  • 2 – Queued
  • 3 – Sending
  • 4 – Sent
  • 5 – Delivered
  • 6 – Received
  • 7 – Failed
  • 8 – Undelivered
  • 9 – Blacklisted
SMS_STATUS_MEANING String
Description The textual value of the delivery status of the message.
Available values:

  • Not Sent
  • Accepted
  • Queued
  • Sending
  • Sent
  • Delivered
  • Received
  • Failed
  • Undelivered
  • Blacklisted
SCHEDULE_ID String
Description Not currently used.
REGISTER_TYPE Type
Description The indicator of what type of message was sent. This will be “4” to indicate “SMS Message” in all cases.
INCLUDE_URL Boolean
Description Indicates whether a payment URL is to be included with the message (“True”) or not (“False”).
PAYMENT_URL String
Description The sites payment URL that was sent in the message.

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 create our objects. We’ll need the standard service object, a SiteID request object, an AccountRental request object and a GetSMSMessageData response object. We can define and create those objects like this:

// Create the request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.SiteID_Request siteID_rqst = newSWS.SiteID_Request();
SWS.AccountRental_Request acctrental_rqst = new SWS.AccountRental_Request();
SWS.GetSMSMessageData_Response response = new SWS.GetSMSMessageData_Response();

Now we set up the parameters for our request.

// SiteID Request
siteID_rqst.SiteID = 123456;
// Account/Rental Request 
// these are optional parameters, you may set one, both or neither
acctrental_rqst.AccountID = 234567;
acctrental_rqst.RentalID = 345678;

Finally we can call the method and pass across the login object and the request objects to get our resultant dataset. 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.GetSMSMessageData(user_rqst, siteID_rqst,
acctrental_rqst);}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.

Categories: API General, Letters, SMS

SWS GetSMSCandPhoneData Method

January 18, 2018 Leave a comment

This method returns contact, address and phone information for site rentals with optional filtering based upon AccountID and/or RentalID. Candidate records must meet the following criteria:

  • Primary contact is “TRUE”.
  • Phone type is “MOBILE”.
  • Rental status is “CURRENT_OCCUPIED”, “DELINQUENT”, “IN_PROCESS”, “RESERVED” or “SOFT_RESERVED”.

Parameters

Name DataType Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
AccountID Long Optional
Description The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method.
RentalID Long Optional
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
Response String
Description “SUCCESS” indicates that the query was successful, or “FAILURE” if not.
SITE_ID Long
Description The site’s ID number.
ACCT_ID Long
Description The account’s ID number.
ACCT_NAME 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.
ACCT_TYPE Integer
Description The system-defined account type.
Available values:

  • Lead
  • Customer
  • Company Use Acct
  • Other
RENTAL_ID Long
Description The ID number of the rental.
RENTAL_STATUS Integer
Description The rental’s current status.
Available values:

  • 0 – Current
  • 1 – Delinquent
  • 100 – In-Process
  • 101 – Reserved
  • 102 – Soft Reservation
  • 201 – Vacated/Terminated
  • 202 – Voided Rental
  • 203 – In-Transfer
  • 205 – Abandoned Rental
UNIT_ID Long
Description The unit’s ID number. This is maintained through rentals.
PHONE_ID Long
Description The ID number of the phone. This can be found using the GetContacts method.
PHONE String
Description The contact’s phone number.
PHONE_TYPE Integer
Description The numeric value of the phone number type.
Available values:

  • 1 – Home
  • 2 – Office
  • 3 – Mobile
  • 4 – Fax
  • 5 – Other
CONTACT_ID Long
Description The contact’s ID number.
CONTACT_TYPE Integer
Description The numeric value of the contact type.
Available values:

  • 1 – Account Manager
  • 2 – Account User
  • 3 – Account Contact Only
  • 4 – Business Contact Record
FIRST_NAME String
Description The contact’s first name.
LAST_NAME String
Description The contact’s last name.
KNOWN_AS String
Description The name by which the customer prefers to be called.
EMAIL String
Description The contact’s email address. This is the customer’s username if eStore/eCommerce are supported.
ADDR_ID Long
Description The ID number of the primary contacts address.
ADDR1 String
Description The first line of the street address.
ADDR2 String
Description The second line of the street address.
ADDR3 String
Description The third line of the street address.
CITY String
Description The city in which the address is located.
STATE String
Description The state/province in which the address is located.
POSTAL_CODE String
Description The postal/ZIP code for the address.
COUNTRY String
Description The country in which the address is located.
ADDR_TYPE Integer
Description The numeric value for the address type.
Available values:

  • 1 – HOME
  • 2 – OFFICE
  • 3 – MAILING
  • 4 – SHIPPING
  • 5 – OTHER
PRIMARY_FLAG Boolean
Description Indicates if the contact is the primary contact for the rental (“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 create our objects. We’ll need the standard service object, a SiteID request object, an AccountRental request object and a GetSMSCandPhoneData response object. We can define and create those objects like this:

// Create the request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.SiteID_Request siteID_rqst = new SWS.SiteID_Request();
SWS.AccountRental_Request acctrental_rqst = new SWS.AccountRental_Request();
SWS.GetSMSCandPhoneData_Response response = new SWS.GetSMSCandPhoneData_Response();

Now we set up the parameters for our request.

// SiteID Request
siteID_rqst.SiteID = 123456;
// Account/Rental Request
// these are optional parameters, you may set one, both or neither
acctrental_rqst.AccountID = 234567;
acctrental_rqst.RentalID = 345678;

Finally we can call the method and pass across the login object and the request objects to get our resultant dataset. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response objecttry
{
response = service.GetSMSCandPhoneData(user_rqst, siteID_rqst, acctrental_rqst);
}
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.

Categories: API General, Letters, SMS

POST_LTR_TEMPLATE_INFO Reference

November 28, 2016 Leave a comment

Reference for any method using the POST_LTR_TEMPLATE_INFO object.

Name Data Type
CREATED DateTime
Description The creation date and time of the letter template.
CURR_VERSION  Integer
Description The version number of the letter template, if it has been updated.
GROUP_MEANING String
Description The textual meaning of the LTR_TYPE_GROUP integer.
LTR_NAME String
Description The name of the letter template.
LTR_TYPE_GROUP Integer
Description The type of letter template.
LTR_TYPE_ID Long
Description The letter types ID number.
ORG_ID Long
Description The organizations ID number.
PRINT_MEANING String
Description The textual meaning of the PRINT_SPECIAL integer.
PRINT_SPECIAL Integer
Description The number indicating what type of printing the letter is set to use.
SITE_ID Long
Description The site’s ID number. This can be found using the GetSiteList method.
STATUS Integer
Description The numeric value that indicates whether the letter is enabled or not.
STATUS_MEANING String
Description Textual value of the STATUS.
UPDATED DateTime
Description The date and time the field was created.
WHO_CREATED String
Description The name of the person who created the letter.
WHO_UPDATED String
Description  The name of the person who last updated the letter.
Categories: API General, Letters

SWS GetInsCancelWarningLetterInfo Method

October 24, 2016 Leave a comment

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

Parameters

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.

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

try
{
    // Call the method that will load the response object
    response = service.GetInsCancelWarningLetterInfo(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.

Categories: API General, Insurance, Letters