Home > API General, Assessments, Payments > SWS GetAssessmentsByID Method

SWS GetAssessmentsByID Method


Retrieves assessments (i.e., rent, insurance, fees, etc.) for a list of assessment ID numbers and the total amount due for each.

Parameters

Name DataType Is Required
AssessIDs Long Required
Description An array of the assessment’s ID numbers.
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
SOA_GET_ASSESSMENTS SOA_GET_ASSESSMENTS
Description Object containing the information returned for the method.
TotalDue Decimal
Description The total amount due for the assessments.

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 GetAssessmentsByID request object and a GetAssessmentsByID response object.

// Create request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetAssessmentsByID_Request request = new SWS.GetAssessmentsByID_Request();
SWS.GetAssessmentsByID_Response response;

Here’s my sample code of the Request object.

// GetAssessmentsByID Request
request.SiteID = 123456;
request.AssessIDs = new long[] { 213456, 456789 };

Finally we can call the method and pass across the login object and the request object to get our assessments by ID. 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.GetAssessmentsByID(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: