Archive
SWS mailCentralizedReceipt Method
Creates a letter to be mailed out using centralized mail. Receipts are always account-based even if they are paying for something not tied to an account. A Site/Org level account ID number is required.
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. | |
| PdfTemplateID | Long | Required |
| Description | The letter’s template ID number. Letter templates are always in .PDF. This is the LTR_TYPE_ID from the getReceiptTemplateInfo method. | |
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
| TransactionID | Long | Required |
| Description | The transaction’s ID number. Transaction IDs are system generated for each payment transaction that occurs in the system. If there is no transaction ID the transaction failed. The transaction ID is returned when any MakePayment method is used. | |
Returned Parameters
| Name | DataType |
|---|---|
| LtrNum | Long |
| Description | The system generated letter number assigned to the new letter. |
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 createOrViewReceipt request object, and a tntLtrNum response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.createOrViewReceipt_Request request = new SWS.createOrViewReceipt_Request();
SWS.tntLtrNum_Response response;
Here is a sample code of the request object:
// createOrViewReceipt Request
request.SiteID = 123456;
request.AcctID = 123456;
request.TransactionID = 123456;
request.PdfTemplateID = 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.mailCentralizedReceipt(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.
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.
SWS viewLeasePDF Method
Provides a URL to view the requested document.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| LeaseId | Long | Required |
| Description | The lease’s ID number. This can be found using the LEASE_DEF_ID from the getLeaseTemplateInfo 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. | |
| 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 to where the lease document is stored. This is what a returned PDF lease path might look like:
https://csiapp1.centershift.com/qa40/letters/
1000082928_1303989475.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 viewLease 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.ViewLease_Request request = new SWS.ViewLease_Request();
SWS.PdfFilePath_Response response;
Here is a sample code of the request object:
// ViewLeasePDF Request
request.SiteID = 123546;
request.RentalId = 123456;
request.LeaseId = 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.viewLeasePdf(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.
SWS getTenantLetterList Method
Retrieves tenant letter document information for an entire site, account and/or rental, excludes receipts unless centrally mailed.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AcctID | 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. * Either AcctID, RentalID or SiteID is required. |
|
| EndDate | DateTime | Optional |
| Description | The end date for the requested date range. Defaults to the StartDate if left undefined. | |
| 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. * Either AcctID, RentalID or SiteID is required. |
|
| SiteID | Long | Optional* |
| Description | The site’s ID number. This can be found using the GetSiteList method. * Either AcctID, RentalID or SiteID is required. |
|
| StartDate | DateTime | Optional |
| Description | The start date of the requested date range. Defaults to today if left undefined. | |
Returned Parameters
| Name | DataType |
|---|---|
| ACCT_ID | Long |
| Description | The account’s ID number. |
| CERTIFIED | String |
| Description | Indicates if the letter is set to be sent with certified mail (“Y”) or not (“N”). |
| CREATED | DateTime |
| Description | The created date and time of the record. |
| EXPORTED_DATE | String |
| Description | The date the letter was exported to a .pdf for printing. |
| EXPORT_ID | Long |
| Description | The export ID number in which the letter was sent. |
| GROUP_MEANING | String |
| Description | The textual value of the LTR_TYPE_GROUP. |
| LTR_NAME | String |
| Description | The textual value of the LTR_TYPE_ID |
| LTR_NUMBER | Long |
| Description | The letter number. This is system generated when the letter is generated and is primarily used for tracking. |
| LTR_TYPE_GROUP | Integer |
| Description | The group number assigned to the letter template type. Common values:
|
| LTR_TYPE_ID | Long |
| Description | The ID to the specific letter template used to generate the letter. |
| MAIL_LOCAL | String |
| Description | Indicates if the letter is going to be printed and mailed by the site (“Y”) or through centralized mailing (“N”). |
| PRINT_MEANING | String |
| Description | The textual value of the PRINT_SPECIAL parameter. |
| PRINT_SPECIAL | Integer |
| Description | The type of special printing required for the letter. The default is “0” for “Plain Letter”. |
| RENTAL_ID | Long |
| Description | The rental item’s ID number. |
| SITE_ID | Long |
| Description | The site’s ID number. |
| UNIT_NUMBER | String |
| Description | The unit’s number as assigned by the organization. This is not the UnitID. |
| VERSION | Integer |
| Description | The version number of the letter template that was used to create the letter. Defaults to 1 if there have been no updates. |
| WHO_CREATED | String |
| Description | The name of the user that created the letter. |
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’ll need the standard service object, a getTenantDocList request object, and a GetTenantLetterList response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.getTenantDocList_Request request = new SWS.getTenantDocList_Request();
SWS.getTenantLetterList_Response response;
Here is a sample code of the request object:
// GetTenantLetterList Request
request.SiteID = 123456;
request.RentalID = 123456;
request.StartDate = DateTime.Today.AddDays(-30);
request.EndDate = DateTime.Today;
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.getTenantLetterList(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 