Home > API General, Leases, Rental/Reservation > SWS GetDocusignLease Method

SWS GetDocusignLease Method


Will generate a lease and return a URL to the DocuSign site for the lease to be signed. The URL has a limited lifespan and expires after 5 minutes.

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.
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
LeaseURL String
Description The URL to the DocuSign lease to be signed. This has a 5 minute lifespan.

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

// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetDocusignLease_Request request = new SWS.GetDocusignLease_Request();
SWS.GetDocusignLease_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 retrieve the DocuSign URL. 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.GetDocusignLease(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.

  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 )

Google photo

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

Twitter picture

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

Facebook photo

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

Connecting to %s

%d bloggers like this: