Home > API General, Site Administration, Tasks/to-do > SWS GetSiteTasks Method

SWS GetSiteTasks Method

Retrieves a collection of task data for a specified task or a collection of task data for a specified task type, site, or date.


Name DataType Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
Source eTaskSource Optional*
Description The source where the task was created.
Available values:

  • None
  • SWS
  • Call_Center
  • Website
  • Kiosk

* Required if providing Type.

TaskDate DateTime Optional
Description Filters the results to tasks due on a specific day.
TaskID Long Optional
Description Filters the results to a specific task.
Type eTaskType Optional*
Description The task category to retrieve.
Available values:

  • Task_To_Do
  • Appointment
  • Followup
  • Maintenance
  • Reservation
  • Other

* Required if providing a source.

Returned Parameters

Name Data Type
Description The object containing the response.


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

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

Here’s my sample code of the Request object when pulling tasks by date. Other parameters exist to change or narrow the results.

// GetSiteTasks Request
request.SiteID = 123456;
request.TaskDate = DateTime.Today;

Finally we can call the method and pass across the login object and the request object to get our site tasks. It’s a good idea to do this in a Try Catch block.

   ' Call the method that will load the response object
  response = service.GetSiteTasks(user_request, request);
catch (Exception ex)

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 )

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