Archive

Posts Tagged ‘Auction’

SWS UpdateAuction Method

May 29, 2011 Leave a comment

Updates the information regarding the specified auction.

Parameters

Name Data Type Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
AuctionID Long Required
Description The ID number assigned to the auction at the time it was created.
AuctionDateTime DateTime Optional
Description The date and time schedule to which you wish to change the auction. If only a portion of this is included will default to either today’s date or 12:00am. For example, if you set the date to 06/20/2017 but do not enter a time, the auction will be scheduled for 06/20/17 at 12:00am.
AuctioneerName String Optional
Description The name of the auctioneer who will be running the auction.
AuctionNotes String Optional
Description Any additional information regarding the auction.
AuctionStatus AuctionStatusValues Optional
Description The status to which you wish to update the auction.
Available values:

  • SCHEDULED
  • COMPLETED
  • CANCELLED

Returned Parameters

Name Data Type
AuctionID Long
Description The auctions ID number that was updated.
SITE_ID Long
Description The site’s ID number.
AUCTION_DATE DateTime
Description The date and time for which the auction is currently scheduled.
AUCTIONEER_NAME String
Description The name of the person who will be running the auction.
NOTES String
Description Any additional information regarding the auction.
STATUS Integer
Description The numeric value of the auction status.
Available values:

  • 1 – SCHEDULED
  • 2 – COMPLETED
  • 3 – CANCELLED
CREATED_BY Long
Description The user’s ID that created the auction.
UPDATED_BY Long
Description The user’s ID that last updated the auction.
AUCTION_TIME String
Description The time during the day that the auction will occur.

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

' Create a request and response objects
 Dim objService As New SWS.WSSoapClient
 Dim objReq As New SWS.UpdateAuction_Request
 Dim objRes As New SWS.UpdateAuction_Response

Here is a sample code of the request object (including optional parameters):

' UpdateAuction Request
 With objReq
 .SiteID = 1000000001
 .AuctionID = 1000000000
 .AuctionDateTime = 2011-05-14T00:00:00.000-06:00
 .AuctioneerName = James Sweet
 .AuctionStatus = SCHEDULED
 End With

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.

Try
 ' Call the method that will load the response object
 objRes = objService.UpdateAuction(objLogin, objReq)
 Catch ex As Exception
 MessageBox.Show(ex.Message)
 End Try

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.

Categories: API General, Auction, Delinquency Tags: ,

SWS RemoveRentalFromAuction Method

May 23, 2011 Leave a comment

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.

Categories: API General, Auction, Delinquency, Rental/Reservation Tags: , ,

SWS GetEligibleAuctionRentals Method

May 16, 2011 Leave a comment

Retrieves all rentals that are eligible for auction and are not currently assigned to an existing auction.

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
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 guardian account.
DEL_RENTAL_ID Long
Description The rental item’s ID number.
DEL_SCHED Decimal
Description The delinquency schedules ID.
DEL_SCHED_NAME String
Description The name of the delinquency schedule.
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 lien status of the rental. This call should always return 1 (Eligible for Auction).
LTD DateTime
Description The date through which the customer has leased the unit.
PTD DateTime
Description The the date through which the customer has paid rent for the unit.
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_NUMBER String
Description The unit’s number as assigned by the organization. This is not the UnitID.

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

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetEligibleAuctionRentals_Request request = new SWS.GetEligibleAuctionRentals_Request();
SWS.GetEligibleAuctionRentals_Response response;

Here’s my sample code of the Request object.

// GetEligibleAuctionRentals Request
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to get the eligible rental auctions. 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.GetEligibleAuctionRentals(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, Auction Tags:

SWS GetAuctionTax Method

May 13, 2011 Leave a comment

Returns the applicable tax of the amount for which the item was auctioned.

Parameters

Name DataType Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
Amount Decimal Required
Description The amount collected on the auctioned unit.

Returned Parameters

Name DataType
baseAmount Decimal
Description The amount collected on the auctioned unit.
taxAmount Decimal
Description The total of the taxes applicable to the baseAmount.

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

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.AuctionProceeds request = new SWS.AuctionProceeds();
SWS.GetAuctionTax_Response response;

Here’s my sample code of the Request object.

// GetAuctionTax Request
request.SiteID = 123456;
request.AuctionProceedsAmount = new decimal[] { 326m };

We can call the method and pass across the login object and the request object to return our auction tax amount. 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.GetAuctionTax(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, Auction, Tax Tags: ,