GetTasks3()

Returns task data for one or more users. This includes task statuses, dates, and links, as well as other task information.

When retrieving the task data of one user, the UserID parameter is necessary, whereas when retrieving the task data of multiple users, the IDs parameter is necessary. If both UserID and IDs parameters are provided, GetTasks3() returns the task data for all the users in UserID and IDs. If neither parameter is specified, GetTasks3() does not return any task data.

If either the TaskStatus or TaskType parameters are not specified, GetTasks3() does not return any task data.

This function does not return data for tasks in expired projects unless the ExtensionDays parameter is used. The default value of this parameter is zero, i.e., tasks that are past their end date will not be included. If this parameter is set to 10, tasks whose end date is less than 10 days ago will be included.

Output:

This method returns a list of tasks, each with the following fields:

• Task - The type of the task. Possible values are:
  • FO - Fillout
  • AFO - Fillout signing
  • QP - Question personalization
  • AQP - Question personalization signing
  • RS - Rater selection
  • ARS - Rater selection signing
  • SVM - Subject management
  • DTC - Data prep
• Category - The category of the project that contains the task.
• Subcategory - The subcategory of the project that contains the task.
• ProjectID - The ID of the project that contains the task.
• ProjectTitle - The title of the project that contains the task.
• Status - The status of the task. Possible values are:
  • 0 - not completed: the task has already started and may or may not have expired, but the task has not yet been accessed.
  • 1 - in progress: the task has already started and may or may not have expired; the task has been accessed but not completed.
  • 2 - completed: the task has already started and may or may not have expired. The task has been completed.
  • 3 - not ready: the task hasn't started yet.
• ExpiryDate - The end date of the task.
• SubjectID - The primary subject ID from the task. Only used if the project contains primary subjects. (e.g. “Data1_BIO101”)
• SFN - The first name of the primary subject. Only used if the primary subjects of the project come from a user datasource. (e.g. “John”)
• SLN - The last name of the primary subject. Only used if the primary subjects of the project come from a user datasource. (e.g. “Smith”)
• SN - The name of the primary subject. Only used if the primary subjects of the project come from an object datasource. (e.g. “Biology 101”)
• ConditionID - The secondary subject ID from the task. Only used if the project contains secondary subjects. (e.g. “Data1_JohnSmith”)
• CN - The name of the secondary subject. Only used if the secondary subjects of the project come from an object datasource. (e.g. “Biology 101”)
• CFN - The first name of the secondary subject. Only applicable if the secondary subjects of the project come from a user datasource. (e.g. “John”)
• CLN - The last name of the secondary subject. Only applicable if the secondary subjects of the project come from a user datasource. (e.g. “Smith”)
• UserID - The ID of the task owner, including the ID of the datasource. (e.g. “Data1_JohnSmith”)
• GroupID - The internal ID of the user group of the task owner. The captions of the groups can be retrieved using GetGroupInfo(). (e.g. “c522d439-3604-4573-a45c-11aab74c968a”).
• AuthenticationType - Whether this task’s link enforces authentication. Possible values are:
  • 1 - No authentication is enforced.
  • 2 - Authentication is enforced.
• UFN - The first name of the task owner. (e.g., “John”).
• ULN - The last name of the task owner. (e.g. “Smith”).
• TaskID - The internal ID of the task. (e.g., “10FO”).
• RFN - This field is only available for fillout signing tasks; it is empty for all other task types. It contains the first name of the user who completed the fillout task.
• RLN - This field is only available for fillout signing tasks; it is empty for all other task types. It contains the last name of the user who completed the fillout task.
• Link - The URL link for the task. This link will always start with “~” and is relative to the Blue URL. (e.g., “~/fg-eng.aspx?lang=eng&pid=1bdd0793-e393-444”).

• VersionLanguage - The language of the project that contains the task. (e.g. “en-US”)
• BaseVersion - Not used.
• InvitationDate - The date, if any, of when the invitation email was sent.
• Reminder1SentDate - The date, if any, of when the first reminder email was sent.
• Reminder2SentDate - The date, if any, of when the second reminder email was sent.
• StartDate - The start date of the task.
• AddtionalField1 - If the AddtionalField1 input parameter was specified, this field contains the value of that demographic field of the primary subject of the task. For example, if the AddtionalField1 input parameter was “Country”, and primary subjects of the project had a “Country” field, this field would contain the “Country” of the primary subject of the task.
• AddtionalField2 - If the AddtionalField2 input parameter was specified, this field contains the value of that demographic field of the primary subject of the task.
• AddtionalField3 - If the AddtionalField3 input parameter was specified, this field contains the value of that demographic field of the primary subject of the task.

MANDATORY PARAMETERS:

• APIKeyHeader - API Key. Must be one of the API Keys generated in the Blue admin console.

OPTIONAL PARAMETERS:

• Message - Leave empty.
• ProjectIDs
  • Filters the tasks returned by the IDs of the projects.
  • Projects IDs can be retrieved by calling GetAllProjectMetaData().
  • If no projects are provided, tasks from all active (non-expired) projects are returned.
• UserID
  • Filters the tasks returned by the ID of the task owner. (e.g. “Data1_JohnSmith”).
  • User IDs can be retrieved by calling GetUserData().
  • If neither this nor the IDs parameter is provided, no task data is returned.
• IDs
  • Filters the tasks returned by the IDs of the task owners.
  • User IDs can be retrieved by calling GetUserData().
  • If neither this nor the UserID parameter is provided, no task data is returned.
• TaskStatus
  • Filters the tasks returned by one or more task status.
  • Accepted values:
    * completed - includes "completed" tasks (output status 2).
    * inprogress - includes “in progress” tasks (output status 1).
    * notcompleted - includes "open", "in progress" and "not ready" tasks (output statuses 0,1 and 3).
    * open - includes “not completed” and “in progress” tasks whose start dates are in the past and end dates are in the future (output statuses 0 and 1 that have not expired).
  • Not case sensitive.
  • If no task statuses are specified, no task data is returned.
• TaskType
  • Filters the tasks returned by one or more task type.
  • Accepted values:
    * FO - Fillout
    * AFO - Fillout signing
    * QP - Question personalization
    * AQP - Question personalization signing
    * RS - Rater selection
    * ARS - Rater selection signing
    * SVM - Subject management
    * DTC - Data prep
  • Not case sensitive.
  • If no task types are provided, no task data is returned.
• StartDate - Not used.
• EndDate - Not used.
• ExtensionDays
  • Number of days after the task end date to include tasks.
  • The user must be in the datasource
  • The default value of this parameter is zero, i.e., tasks that are past their end date will not be included. If this parameter is set to 10, tasks whose end date is less than 10 days ago will be included.
• ShowNotReady
  • Whether tasks whose start date is in the future are returned.
  • The default value of this parameter is false, i.e., future tasks are not returned.
• Language
  • Filters the tasks returned by the language provided.
  • If no language is provided, the returned tasks use the base language of the project.
  • If a project does not support the language provided, no tasks from this project will be returned.
  • Accepted values
    * ar-QA - Arabic
    * en-US - English
    * es-ES - Spanish
    * fr-FR - French
    * zh-CN - Chinese
    * de-DE - German
    * ru-RU - Russian
    * pt-BR - Portuguese
    * nl-NL - Dutch
• AddtionalField1
  • The name of a primary or secondary subject’s demographic field whose value should be returned.
  • The value of the field is returned in the AddtionalField1 output field.
• AddtionalField2
  • The name of a primary or secondary subject’s demographic field whose value should be returned.
  • The value of the field is returned in the AddtionalField2 output field.
• AddtionalField3
  • The name of a primary or secondary subject’s demographic field whose value should be returned.
  • The value of the field is returned in the AddtionalField3 output field.