Home > Accounting, API General, Assessments, Rental/Reservation, Retail/Merchandise > SWS GetTransactionRentals Method

SWS GetTransactionRentals Method


Retrieves information regarding rentals and retail related to a specified transaction.

Parameters

Name DataType Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
TranID ArrayOfLong Required
Description The transaction’s ID number. Transaction IDs are system generated for each monetary transaction that occurs in the system. If there is no transaction ID the transaction failed. The transaction ID is returned when any MakePayment method is used.

Returned Parameters

Name DataType
RENTAL_ID Decimal
Description The rental item’s ID number.
TNX_DATE DateTime
Description The date the transaction occurred.
TNX_ID Long
Description The transaction’s ID number.Transaction IDs are system generated for each monetary transaction that occurs in the system.
HasRetail Boolean
Description Indicates if the transaction included retail assessments (“True”) or not (“False”).
TranID Long
Description The transaction’s ID number. Transaction IDs are system generated for each monetary transaction that occurs in the system. This reiterates the first transaction ID.

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

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

Here’s my sample code of the Request object.

// GetTransactionRentals Request
request.SiteID = 123456;
request.TranID = new long[] { 123456 };

Finally we can call the method and pass across the login object and the request object to get our transaction rentals. 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.GetTransactionRentals(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: