Home > API General, Tasks/to-do > BulkData GetBulkTasks Method

BulkData GetBulkTasks Method


Retrieves any tasks that have been created or updated in the last 72 hours.

Parameters

Name Data Type Is Required
OrgID Long Required
Description The organization’s ID number.
BeginDate DateTime Required
Description The beginning date of the date range for which to pull the list of new accounts. This date cannot be more then 96 hours in the past.
EndDate DateTime Optional
Description The end date of the date range for which to pull the list of new accounts. This will default to SYSDATE if left undefined.

Returned Parameters

Name Data Type
TASK_ID Long
Description The task’s ID number.
SITE_ID Long
Description The site’s ID number.
TASK_TYPE_NUM Integer
Description The numeric value of the task type.
TASK_TYPE_VAL String
Description The textual value of the task type.
TASK_HEADER String
Description The title or subject of the task.
TASK_BODY String
Description The body of the task.
TASK_STATUS_NUM Integer
Description The numeric value of the status of the task.
TASK_STATUS_VAL String
Description The textual value of the status of the task.
TASK_PRIORITY_NUM Integer
Description The numeric value of the priority of the task.
TASK_PRIORITY_VAL String
Description The textual value for the priority of the task.
TASK_START_DATE DateTime
Description The date the task was assigned.
REF_ID Long
Description If the task is associated with a rental or account, this is the rental or account ID.
REF_TYPE_NUM Integer
Description The numeric value of the type of task that is referenced.
REF_TYPE_VAL String
Description The textual value of the type of task that is referenced.
TASK_RECUR_ID Long
Description The ID of the recurring task item information.
RECUR_TYPE_NUM Integer
Description The numeric value for the type of task.
RECUR_TYPE_VAL String
Description The textual value for the type of task.
OCCUR_VAL Integer
Description The number of times a recurring task is scheduled to be completed.
FREQ_VAL Integer
Description The interval specification for the time period chosen.
ANNUAL_DAY DateTime
Description If the recurring task is set to occur annually, this is the day it will occur each year.
MONTHLY_DAY  DateTime
Description If the recurring task is set to occur monthly, this is the day it will occur each month.
MONDAY String
Description If the recurring task is set to occur weekly, this indicates if the task is schedule for this day of the week (“Y”) or not (“N”).
TUESDAY String
Description If the recurring task is set to occur weekly, this indicates if the task is schedule for this day of the week (“Y”) or not (“N”).
WEDNESDAY String
Description If the recurring task is set to occur weekly, this indicates if the task is schedule for this day of the week (“Y”) or not (“N”).
THURSDAY String
Description If the recurring task is set to occur weekly, this indicates if the task is schedule for this day of the week (“Y”) or not (“N”).
FRIDAY String
Description If the recurring task is set to occur weekly, this indicates if the task is schedule for this day of the week (“Y”) or not (“N”).
SATURDAY String
Description If the recurring task is set to occur weekly, this indicates if the task is schedule for this day of the week (“Y”) or not (“N”).
SUNDAY String
Description If the recurring task is set to occur weekly, this indicates if the task is schedule for this day of the week (“Y”) or not (“N”).
START_DAY DateTime
Description The date the task is scheduled to start.
END_DAY DateTime
Description The date by which the task needs to be completed.
CREATED_DATE DateTime
Description The date the task was initially created.
CREATED_BY_ID Long
Description The user’s ID that initially created the task.
CREATED_BY_NAME String
Description The first and last name of the user that initially created the task.
UPDATED_DATE DateTime
Description The date the task was most recently updated.
UPDATED_BY Long
Description The user’s ID that most recently updated the task.
UPDATED_BY_NAME String
Description The first and last name of the user that most recently updated the task.
ORG_ID Long
Description The organization’s ID number.

Example

We’ll assume you’ve got a web reference, let’s name it BulkData, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a user request object and a data request object. We can define and create those like this:

// Create request objects
BulkData.LookupUser_Request user_request = new BulkData.LookupUser_Request();
BulkData.BulkDataSoapClient service = new BulkData.BulkDataSoapClient();
BulkData.BulkData_Request request = new BulkData.BulkData_Request();

Here’s my sample code of the Request and user objects.

// request
user_request.Username = "user";
user_request.Password = "pass";
user_request.Channel = 999;

request.OrgID = 123546;
request.BeginDate = DateTime.Today.AddDays(-1);
request.BeginDate = DateTime.Today;

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

// Call the method that will load the response object
try
{
  BulkData.BulkTasks_Response response;
  response = service.GetBulkTasks(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 BulkData Methods.

Categories: API General, Tasks/to-do
  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: