Web Service Guide - RedCarpet - Login - SilkRoad Technology

RedCarpetTask APIsFour methods are available to interface with tasks from existing employee events:• Add a new task for an existing LifeCycle event for an employee• Delete an existing task from an existing LifeCycle event• Get the existing tasks for an existing LifeCycle event for an employee• Complete an existing active taskThe “Task Definition ID” field defined in the task definition is used as the uniqueidentifier of the task. The Task Definition ID is optional in the task definition butmust exist to add, delete, or complete a task through the API.Input Specifications for Add and Delete Task MethodsAdd a new task (AddTask) and Delete an existing task (DeleteTask) use similararguments:1 strSecurityToken - A Session Id as described in “Logging in to Consume theService” on page 3 of this document.• The RedCarpet user executing the methods must be a member of theEvent Coordinator team for each event included in the strEventNameparameter OR• The RedCarpet user executing the methods must be a member of a teamwith ViewAllTasks permissionNote: SessionIDuser privileges forevent methodsmust include EventCoordinatormembership.2 strForWhomUser - Any of the following employee profile attributes aresupported: the employee Login id, a unique email address, or the profileauthparam. The strForWhomUser parameter will also accept the programgenerated userguid.3 strEventName - The event name (in the default language) or event code as itis displayed on the Administration -> Localization page.4 strTaskDefinitionStringID - A unique identifier for the task as defined in the“Task Definition ID” field on the Edit Task Definition page (Administration ->Manage Events - Manage Events \ Manage Task Definitions \ Edit TaskDefinition page)After the Task Definition ID is entered and saved, it is visible on the ManageTasks list. In the example below, the Task Definition ID is “Transfer_Task1”5 strSendEmails - True to send notification the task has been added, false toskip sending notifications.6 strdontDeleteIfFormExists - Applies only to the DeleteTasks method. If a formis associated with the specified task (strTaskDefinitionStringID), a value ofUser Import and Edit 54