Archive
SWS RemoveRentalFromAuction Method
Removes the selected rental or rentals from the auction to which they are assigned.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| RentalIDs | ArrayOfLong5 | Required |
| Description | The rental ID or an array of rental IDs to be removed from auction. 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 |
|---|---|
| RentalsSucceeded | ArrayOfLong7 |
| Description | The array of rental IDs that were successfully removed from the auction. |
| RentalsFailed | ArrayOfLong8 |
| Description | The array of rental IDs that failed to be removed from the auction. |
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 RemoveRentalFromAuction request object and a RemoveRentalFromAuction response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.RemoveRentalFromAuction_Request request = new
SWS.RemoveRentalFromAuction_Request();
SWS.RemoveRentalFromAuction_Response response;
Here’s my sample code of the Request object.
// RemoveRentalFromAuction Request
request.SiteID = 123456;
request.RentalIDs = new long[] { 123456, 456789, 789123 };
Finally we can call the method and pass across the login object and the request object to remove our rental from auction. 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.RemoveRentalFromAuction(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 GetDelinqSchedule Method
Retrieves a list of the organization’s delinquency schedules and their IDs.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
Returned Parameters
| Name | DataType |
|---|---|
| Del_Schedule_Desc | String |
| Description | The description of the delinquency schedule. |
| Del_Schedule_ID | Long |
| Description | The delinquency schedule’s ID number. |
| Del_Schedule_Name | String |
| Description | The name of the delinquency schedule. |
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 GetDelinqSchedule request object and a GetDelinqSchedule response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetDelinqSchedule_Request request = new SWS.GetDelinqSchedule_Request();
SWS.GetDelinqSchedule_Response response;
Here’s my sample code of the Request object.
// GetDelinqSchedule Request
request.OrgID = 123456;
Finally we can call the method and pass across the login object and the request object to perform our reservation. 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.GetDelinqSchedule(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 GetBaseFees Method
Retrieves a list of all fees at the site.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| ORG_FEE_SITE_ALL | ORG_FEE_SITE_ALL |
| Description | Object containing details off the organizations fees. |
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 GetBaseFees request object and a GetBaseFees response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetBaseFees_Request request = new SWS.GetBaseFees_Request();
SWS.GetBaseFees_Response response;
Here’s my sample code of the Request object.
// GetBaseFees Request
request.SiteID = 123456;
Finally we can call the method and pass across the login object and the request object to get our base fees. 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.GetBaseFees(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 GetAuctionRentals Method
Retrieves detailed information for rental items from a specified auction when the auction ID is provided, it will only return those rental items that are part of that auction; otherwise, all rentals assigned to any auction will be returned.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| AuctionID | Long | Optional |
| Description | The auction’s ID number. If no AuctionID is specified, all auctions will be returned. The AuctionID can be retrieved using the GetAuctions method. | |
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
Returned Parameters
| Name | DataType |
|---|---|
| Acct_ID | Long |
| Description | The account’s ID number. |
| Acct_Name | String |
| Description | The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account. |
| Auction_Date | String |
| Description | The date and time of the auction. |
| Auction_ID | Long |
| Description | The auction’s ID number. |
| Auction_Obj_ID | Long |
| Description | The auction’s item ID number. |
| Auction_Time | String |
| Description | The formatted time of the auction. |
| Del_Rental_ID | Long |
| Description | The rental item’s ID number. |
| Icon | String |
| Description | The URL for the site revenue class icon that displays in the Store application. |
| Last_Payment_Amount | Decimal |
| Description | The amount of the last payment made. |
| Last_Payment_Date | DateTime |
| Description | The date the last payment was made on the rental item. |
| Lien_State | Integer |
| Description | The state/province for the address. |
| LTD | DateTime |
| Description | The lease-thru-date (LTD). |
| Notes | String |
| Description | The free text note as to the auction’s proceedings. |
| PTD | DateTime |
| Description | The paid-thru-date (PTD). |
| Rental_ID | Long |
| Description | The rental item’s ID number. |
| Site_ID | Long |
| Description | The site’s ID number. |
| Total_Due | Decimal |
| Description | The total amount of funds not paid to date. |
| Unit_Contents | String |
| Description | The free text note as to the rental item’s auction status. |
| Unit_Number | String |
| Description | The unit’s number as assigned by the organization. This is not the UnitID. |
| Unit_Status | Integer |
| Description | The rental item’s rental status. |
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 GetAuctionRentals request object and a GetAuctionRentals response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetAuctionRentals_Request request = new SWS.GetAuctionRentals_Request();
SWS.GetAuctionRentals_Response response;
Here’s my sample code of the Request object.
// GetAuctionRentals Request
request.SiteID = 123456;
request.AuctionID = 123456;
Finally we can call the method and pass across the login object and the request object to get our auction 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.GetAuctionRentals(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 