SWS SendEmailWithUnit Method
Sends an email via eStore using the specified template. The organization can create custom templates, but this method does not currently support them. Currently supports the following email types: AutoPay Confirmation, AutoPay Cancellation and Move-Out Notice.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| EmailType | emailMsgTemplateIds | Required |
| Description | Indicates what template the email will use. Available values:
(Other templates are not available with this method.) |
|
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| RentalID | Long | Required |
| Description | The rental item’s ID number. The emails will be retrieved from the contacts associated with this rental. 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. | |
| UnitNumber | String | Required |
| Description | The unit’s number as assigned by the organization. This is not the UnitID. This is returned when you use any of the GetSiteUnitData calls. | |
Returned Parameters
| Name | DataType |
|---|---|
| SendEmailResult | String |
| Description | The email message ID if successful, or an error message if it failed to send. |
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 SendEmailWithUnit request object, and a SendEmail response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.SendEmailWithUnit_Request request = new SWS.SendEmailWithUnit_Request();
SWS.SendEmail_Response response;
Here is a sample code of the request object:
// SendEmailWithUnit Request
request.OrgID = 123456;
request.SiteID = 123456;
request.RentalID = 123456;
request.UnitNumber = "A1";
request.EmailType = SWS.emailMsgTemplateIds.SWS_CNCL_AUTO_PAY_APPEND;
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.SendEmailWithUnit(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.
Yardi Store Developer eXchange 