Search Results
SWS GetEsignLeaseV2 Method
This method will send the required information to either RPost or DocuSign, based on the sites third party authentication set up. Unlike the original method, this method allows you to choose whether to do a local (URL) or remote (Email) lease.
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. | |
| IsRemote | Boolean | Required |
| Description | Indicates if an email should be sent to the customer or if the URL should be returned.Available Options:
Please note that each of these options has a timeout that is set by the electronic lease company. Check with them for that timeout. |
|
Returned Parameters
| Name | DataType |
|---|---|
| LeaseURL | String |
| Description | The URL to the electronic lease to be signed. This has a 5 minute lifespan. |
| LeaseURL | String |
| Description | The URL to the electronic 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 create our objects. We’ll need the standard service object, a GetESignLease request object and a GetESignLease response object. We can define and create those like this:
// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetESignLease_Request request = new SWS.GetESignLease_Request();
SWS.GetESignLease_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 electronic lease 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.GetESignLease(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.
SWS GetESignLease Method
This method will send the required information to either RPost or DocuSign, based on the sites third party authentication set up, and will return a URL to display the lease for immediate signing.
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 electronic 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 create our objects. We’ll need the standard service object, a GetESignLease request object and a GetESignLease response object. We can define and create those like this:
// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetESignLease_Request request = new SWS.GetESignLease_Request();
SWS.GetESignLease_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 electronic lease 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.GetESignLease(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.
SWS GetSiteUnitDataV4 Method
Retrieves a collection of rental item types for a specific group of rental items. Unlike GetSiteUnitData the rental items are grouped by Revenue Class, Width, Depth, Height, Attribute 1, Attribute 2, Climate, Door, Access and Feature values. You will have all the vital data on a randomly selected rental item from each group, including additional data items. There are also additional filtering options, including the ability to pass in multiple values for various filters. Unfiltered, this method will return all rental items with NO promos. The minimum and maximum rates will be retrieved based on the status filter in your request.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| SiteID | Long | Required |
| Description | The ID of the site to which the unit(s) belong. This can be found using the GetSiteList method. | |
| ObjectGroup | ObjectGroups | Optional |
| Description | Not currently used.Available values:
|
|
| Width | ArrayOfDecimal | Optional |
| Description | Filters for the width measurement of the unit. All attributes are customizable by the admin, because of this, these values will be different for each site. | |
| Depth | ArrayOfDecimal1 | Optional |
| Description | Filters for the depth measurement of the unit. All attributes are customizable by the admin, because of this, these values will be different for each site. | |
| Height | ArrayOfDecimal2 | Optional |
| Description | Filters for the height measurement of the unit. All attributes are customizable by the admin, because of this, these values will be different for each site. | |
| MinRentRate | Decimal | Optional |
| Description | Filters for the minimum rent rate for the units requested. | |
| MaxRentRate | Decimal | Optional |
| Description | Filters for the maximum rent rate for the units requested. | |
| MinPushRate | Decimal | Optional |
| Description | Filters for the minimum push rate for the units requested. | |
| MaxPushRate | Decimal | Optional |
| Description | Filters for the maximum push rate for the units requested. | |
| MinStreetRate | Decimal | Optional |
| Description | Filters for the minimum street rate for the units requested. | |
| MaxStreetRate | Decimal | Optional |
| Description | Filters for the maximum street rate for the units requested. | |
| MinRackRate | Decimal | Optional |
| Description | Filters for the minimum rack rate for the units requested. | |
| MaxRackRate | Decimal | Optional |
| Description | Filters for the maximum rack rate for the units requested. | |
| MinProformaRate | Decimal | Optional |
| Description | Filters for the minimum proforma rate for the units requested. | |
| MaxProformaRate | Decimal | Optional |
| Description | Filters for the maximum proforma rate for the units requested. | |
| Attribute01 | ArrayOfInt | Optional |
| Description | Filters using the numeric value for the “Attribute01” custom look up as defined by the site. See eUnitAttr01 for the available values. | |
| Attribute02 | ArrayOfInt1 | Optional |
| Description | Filters using the numeric value for the “Attribute02” custom look up as defined by the site. See eUnitAttr02 for the available values. | |
| Climate | ArrayOfInt2 | Optional |
| Description | Filters using the numeric value for the “Climate” custom look up as defined by the site. See eUnitClimate for the available values. | |
| Door | ArrayOfInt3 | Optional |
| Description | Filters using the numeric value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values. | |
| Access | ArrayOfInt4 | Optional |
| Description | Filters using the numeric value for the “Access Type” custom look up as defined by the site. See eUnitAccessType for the available values. | |
| Feature | ArrayOfInt5 | Optional |
| Description | Filters using the numeric value for the “Features” custom look up as defined by the site. See eUnitFeatures for the available values. | |
| Status | ArrayOfUnitStatusValues | Optional |
| Description | Filters for the rental status of the unit.Available values:
|
|
| PromoDataType | PCDTypeOptions | Optional |
| Description | Filters for the type of promo requested for the item.Available values:
|
|
Returned Parameters
| Name | DataType |
|---|---|
| SiteId | Long |
| Description | The site’s ID number. |
| ClassDescription | String |
| Description | The type of unit, as determined by the admin at the time the unit was created. |
| SiteClassID | Long |
| Description | The system-generated ID of the class. |
| ObjectGroup | Integer |
| Description | Not used currently. |
| UnitID | Long |
| Description | The unit’s ID number. This is maintained through rentals. |
| UnitNumber | String |
| Description | The units’s number as assigned by the organization. This is not the UnitID. |
| RentRate | Decimal |
| Description | The current rate the unit costs per rental cycle. |
| PushRate | Decimal |
| Description | The lowest rate at which the unit should be rented. |
| StreetRate | Decimal |
| Description | The standard rate of the unit. When a customer terminates a rental, regardless of the current rent rate the next customer will rent at this rate, unless modified. |
| RackRate | Decimal |
| Description | The highest rate at which the unit should be rented. |
| FutureRate | Decimal |
| Description | If a rental rate change is scheduled for the unit, this is the price to which it will change. |
| ProformaRate | Decimal |
| Description | A goal rate, or can be used for whatever purpose the site needs. |
| MinimumRentRate | Decimal |
| Description | The minimum rent rate for the unit type. |
| MaximumRentRate | Decimal |
| Description | The maximum rent rate for the unit type. |
| MinimumPushRate | Decimal |
| Description | The minimum push rate for the unit type. |
| MaximumPushRate | Decimal |
| Description | The maximum push rate for the unit type. |
| MinimumStreetRate | Decimal |
| Description | The minimum street rate for the unit type. |
| MaximumStreetRate | Decimal |
| Description | The maximum street rate for the unit type. |
| MinimumRackRate | Decimal |
| Description | The minimum rack rate for the unit type. |
| MaximumRackRate | Decimal |
| Description | The maximum rack rate for the unit type. |
| MinimumProformaRate | Decimal |
| Description | The minimum proforma rate for the unit type. |
| MaximumProformaRate | Decimal |
| Description | The maximum proforma rate for the unit type. |
| Status | UnitStatusValues |
| Description | The current status of the unit.Available values:
|
| Width | Decimal |
| Description | The width measurement of the unit. |
| Depth | Decimal |
| Description | The depth measurement of the unit. |
| Height | Decimal |
| Description | The height measurement of the unit. |
| SquareFeet | Decimal |
| Description | The total square feet of the unit. |
| Volume | Decimal |
| Description | The total volume of the unit. |
| TotalUnitsAvailable | Integer |
| Description | The number of units available to rent with the same attributes. |
| TotalUnits | Integer |
| Description | The number of units that exist with the same attributes. |
| Attribute1 | Integer |
| Description | The numeric value for the “Attribute01” custom look up as defined by the site. See eUnitAttr01 for the available values. |
| Attribute1Value | String |
| Description | The textual value for the “Attribute01” custom lookup as defined by the site. See eUnitAttr01 for the available values. |
| Attribute2 | Integer |
| Description | The numeric value for the “Attribute02” custom look up as defined by the site. See eUnitAttr02 for the available values. |
| Attribute2Value | String |
| Description | The textual value for the “Attribute02” custom lookup as defined by the site. See eUnitAttr02 for the available values. |
| Climate | Integer |
| Description | The numeric value for the “Climate” custom look up as defined by the site. See eUnitClimate for the available values. |
| ClimateValue | String |
| Description | The textual value for the “Climate” custom lookup as defined by the site. See eUnitClimate for the available values. |
| Door | Integer |
| Description | The numeric value for the “Door” custom look up as defined by the site. See eUnitDoor for the available values. |
| DoorValue | String |
| Description | The textual value for the “Door” custom lookup as defined by the site. See eUnitDoor for the available values. |
| Access | Integer |
| Description | The numeric value for the “Access Type” custom look up as defined by the site. See eUnitAccessType for the available values. |
| AccessValue | String |
| Description | The textual value for the “Access Type” custom lookup as defined by the site. See eUnitAccessType for the available values. |
| Features | Integer |
| Description | The numeric value for the “Features” custom look up as defined by the site. See eUnitFeatures for the available values. |
| FeaturesValue | String |
| Description | The textual value for the “Features” custom lookup as defined by the site. See eUnitFeatures for the available values. |
| ReservationDepositAmount | Decimal |
| Description | The amount required for the customer to set the unit to a hard reservation, if there is a reservation deposit. |
| PromoCollection | APPL_BEST_PCD |
| Description | The object containing the requested promotion details. |
| Version | Decimal |
| Description | The unit’s version number which serves to prevent duplicate use of the unit. |
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 GetSiteUnitDataV4 request object and a GetSiteUnitDataV4 response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetSiteUnitDataV4_Request request = new SWS.GetSiteUnitDataV4_Request();
SWS.GetSiteUnitDataV4_Response response;
Here’s my sample code of the Request object using SiteID, Max Rent Rate and Promo Data filter options.
// GetSiteUnitDataV4 Request
request.SiteID = 123456;
request.PromoDataType = SWS.PCDTypeOptions.None;
request.MaxRentRate = 90.50m;
Finally we can call the method and pass across the login object and the request object to get our filtered site unit data. 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.GetSiteUnitDataV4(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.
SWS RemoveFromWaitList Method
Removes an item from a site’s wait list.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| SITE_ID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
| WAIT_LIST_ID | Long | Required |
| Description | The ID number of the wait list item to be removed. This can be found using the GetWaitList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| RESPONSE | String |
| Description | Will return the string “Successfully removed wait list item.” if the item has been removed from the wait list. |
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, an RemoveFromWaitList request object and an RemoveFromWaitList response object. We can define and create those like this:
// Create a request and response objects SWS.WSSoapClient service = new SWS.WSSoapClient(); SWS.RemoveFromWaitList_Request request = new SWS.RemoveFromWaitList_Request(); SWS.RemoveFromWaitList_Response response;
Now we set up the parameters for our request.
// RemoveFromWaitList Request request.SITE_ID = 123456; request.WAIT_LIST_ID = 123456;
Finally we can call the method and pass across the login object and the request object to remove the account from the wait list. 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.RemoveFromWaitList(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.
Yardi Store Developer eXchange 