Archive

Archive for the ‘API General’ Category

SWS GetRemoteDocusignLease Method

April 24, 2017 Leave a comment

Will generate a lease and email it to the lessee via DocuSign. This method will return “Complete” once when the lease has been created and emailed to the lessee. The account associated with this call must have an email address assigned to the primary contact of the account. 

Parameters

Name DataType Is Required
SiteID Long  Required
Description  The site’s ID number. This can be found using the GetSiteList method.
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. This account must have an email address assigned to the primary contact.
RentalId Long  Required
Description The rental’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 Will return “Complete” when successful.

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

// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetRemoteDocusignLease_Request request = new SWS.GetRemoteDocusignLease_Request();
SWS.GetRemoteDocusignLease_Response response;

Here’s my sample code of the Request object.

// get lease URL request
request.SiteID = 123456;
request.AcctID = 123456;
request.RentalID = 123456;

Finally we can call the method and pass across the login object and the request object to send the DocuSign lease. 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.GetRemoteDocusignLease(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, Leases

Helpful Articles for Using SWS

April 21, 2017 Leave a comment
Categories: API General, Articles

Overview: Using Yardi Store Web Services (SWS)

April 16, 2017 Leave a comment
Categories: API General

Store Web Services (SWS) Methods Table of Contents

April 15, 2017 Leave a comment

SWS Method List

  1. AddDeposit
  2. AddInsurance
  3. AddMultipleServices
  4. AddNewAddress
  5. AddNewContact
  6. AddNewPhone
  7. AddRentalsToAuction
  8. AddService
  9. AddToWaitList
  10. AddUpdateAutoPaySettings
  11. AddUpdatePCD
  12. ApplyCreditToAssessments
  13. ApplyPCDs
  14. AssessFee
  15. AuctionEndRental
  16. CancelInsurance
  17. CancelReservation
  18. CancelReservationCashCredit
  19. CancelReservationV2
  20. CancelReservationV3
  21. CompleteUnitTransfer
  22. createAndViewLetter
  23. CreateAuction
  24. createLetter
  25. CreateNewAccount
  26. CreateNewEcommAccount
  27. CreateNotes
  28. CreateSiteTask
  29. eInquirySource
  30. EndRental
  31. eUnitAccessType
  32. eUnitAttr01
  33. eUnitAttr02
  34. eUnitClass
  35. eUnitClimate
  36. eUnitDoor
  37. eUnitFeatures
  38. eUnitStatus
  39. ExportInsuranceDetail
  40. ExportRefundDetail
  41. ExportRefunds
  42. (DEPRECATED)FIUChecksumUpdate
  43. FIUExport
  44. FIUReInt
  45. FIUSelect
  46. FIUValidateExport
  47. GetAccountAdjustments
  48. GetAccountInfo
  49. GetAppliedInsurance
  50. GetAppliedServices
  51. GetAssessments
  52. GetAssessmentsByID
  53. GetAuctionRentals
  54. GetAuctions
  55. GetAuctionTax
  56. GetAutoPaySettings
  57. GetAvailableCredits
  58. GetAvailableDeposits
  59. GetAvailableDiscounts
  60. GetAvailableRetailItems
  61. GetAvailableServices
  62. GetBaseFees
  63. GetCashCredits
  64. GetCertifiedLetterInfo
  65. GetChannelList
  66. GetContactAddresses
  67. GetContactPhoneNumbers
  68. GetContacts
  69. GetDelinqSchedule
  70. GetDocusignLease
  71. GetEcommRentalInfo
  72. GetEligibleAuctionRentals
  73. GetEndRentalRules
  74. GetESignLease
  75. GetESignLeaseV2
  76. GetESignLeaseV3
  77. GetEstimatedRefund
  78. GetGateCodeInfo
  79. GetInsCancelWarningLetterInfo
  80. GetInsuranceBrokerData
  81. GetInsuranceBrokerLocations
  82. GetInsuranceInfo
  83. GetInsuranceProviders
  84. getLeaseGroupTemplateInfo
  85. getLeaseTemplateInfo
  86. GetLetterInfo
  87. getLetterTemplateInfo
  88. GetMiscRevenueClassData
  89. GetMoveOutInfo
  90. GetNotes
  91. GetOrgList
  92. GetOrgSMSStatus
  93. GetPartialPayRules
  94. GetPreReversePayDetails
  95. GetPrimaryRentalInfo
  96. GetPrimaryRentalInfoV2
  97. GetProcessingMailRules
  98. GetQuoteData
  99. GetQuoteStatuses
  100. GetReceiptRules
  101. GetReceiptTemplateInfo
  102. GetRefundDetail
  103. GetRefundDetailV2
  104. GetRefundDetailV3
  105. GetRefunds
  106. GetRemoteDocusignLease
  107. GetRentalActivityUnitLevel
  108. GetRentalAuctionStatus
  1. GetRentalInfo
  2. GetRentalLedger
  3. GetReservations
  4. GetRetailReceiptItems
  5. GetRetailRefundAmount
  6. GetScheduledFees
  7. GetScheduledLetterList
  8. GetSiteAttributes
  9. GetSiteDetails
  10. GetSiteList
  11. GetSiteRules
  12. GetSiteRuleValue
  13. GetSiteSMSFromAddr
  14. GetSiteTasks
  15. GetSiteTasksV2
  16. GetSiteUnitData
  17. GetSiteUnitDataFiltered
  18. GetSiteUnitDataV2
  19. GetSiteUnitDataV3
  20. GetSiteUnitDataV4
  21. GetSMSMessageData
  22. GetSMSCandPhoneData
  23. getTemplateIdRules
  24. getTenantLeaseList
  25. getTenantLetterList
  26. getTenantLetterListV2
  27. GetTotalDue
  28. GetTotalDuePastDue
  29. GetTransactionDetails
  30. GetTransactionRentals
  31. GetUnitData
  32. GetUnitDataV2
  33. GetUnitDataWithPromos
  34. GetUnitFeatures
  35. GetUnitStatus
  36. GetVersion
  37. GetWaitList
  38. GetWaiveVoidFeeStats
  39. GetWebhooksSubscriptions
  40. InitiateUnitTransfer
  41. LocateSimilarQuotes
  42. mailCentralizedReceipt
  43. MakeMultipleReservations
  44. MakePayment
  45. MakeReservation
  46. MiniKeyStats
  47. PhoneSMSBlacklistStatus
  48. PhoneSMSEnableStatus
  49. ProcessManualAutoPay
  50. ProcessRefund
  51. RemoveFromWaitList
  52. RemovePCD
  53. RemoveRentalFromAuction
  54. RemoveReservationPCD
  55. RentalActivity
  56. ResetRefunds
  57. RetrievePassword
  58. ReturnRetailItems
  59. ReversePayment
  60. RollbackUnitTransfer
  61. scheduledLetter
  62. SearchBy
  63. SellRetailNoAccount
  64. SellRetailNoAccountMultiple
  65. SellRetailWithAccount
  66. SellRetailWithAccountMultiple
  67. SendEmail
  68. SendEmailContact
  69. SendEmailWithPassword
  70. SendEmailWithUnit
  71. SetUpMoveOut
  72. TerminateService
  73. TerminateServiceV2
  74. UpdateAccount
  75. UpdateAddress
  76. UpdateAuction
  77. UpdateContact
  78. UpdateEcommPassword
  79. UpdateGatePIN
  80. UpdateInsurance
  81. UpdateLeasePeriod
  82. UpdateOverlockStatus
  83. UpdatePhone
  84. UpdateRefundStatus
  85. UpdateRental
  86. UpdateRentalSettings
  87. UpdateRentalSettingsV2
  88. UpdateRentRate
  89. UpdateRentRateV2
  90. UpdateReservation
  91. UpdateStreetRate
  92. UpdateUnitData
  93. UpdateUnitStatus
  94. UpdateUnitStatusExpanded
  95. VerifyEcommLogin
  96. VerifyLogin
  97. viewLeasePdf
  98. viewLetterPdf
  99. viewReceiptPdf
  100. VoidDeposit
  101. VoidFee
  102. VoidMoveIn
  103. VoidRetailAssessments
  104. VoidTransaction
  105. WaiveFee
  106. WalkThruList
  107. WebhooksSubscribe
  108. WebhooksUnsubscribe
Categories: API General