SWS GetSiteTasksV2 Method
This method provides a wider range of task sources and types that previously were not available in the original method. Both the type and the source have been changed to integer types which will allow the method to grow as well.
Parameters
| Name | Data Type | Required |
|---|---|---|
| TaskId | Long | Optional |
| Description | Filters the results to a specific task. | |
| Type | Integer | Optional* |
| Description | The task category to retrieve. Most common values:
* Required if providing a source. |
|
| Source | Integer | Optional* |
| Description | The source of where the task was created. Most common values:
* Required if providing a type. |
|
| SiteID | Long | Required |
| Description | The site’s ID number. This can be found using the GetSiteList method. | |
| TaskDate | DateTime | Optional |
| Description | Filters the results to tasks due on a specific day. | |
Returned Parameters
| Name | Data Type |
|---|---|
| SOA_GET_SITE_TASKS | SOA_GET_SITE_TASKS |
| Description | The object containing the response. |
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 GetSiteTasksV2 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.GetSiteTasksV2_Request request = new SWS.GetSiteTasksV2_Request();
SWS.GetSiteTasks_Response response;
Here’s my sample code of the Request object by type and source. Other optional parameters exists to change or narrow results.
// GetSiteTasks Request
request.SiteID = 123456;
request.Type = 1;
request.Source = 5;
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
try
{
response = service.GetSiteTasksV2(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 