ToDoItem - PM web service
Avatar PM WEBSVC.ToDoItem web service
This web service has the following call:
- DefineToDoItem
DefineToDoItem call
The following tables list the DefineToDoItem parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password |
Parameters with Properties
| Parameter | Property | Value Accepted | Notes |
| defineToDoObject | Application | "PM,CWS,MSO,CFMS" | If no application is defined, the current application is assumed. For example, if you connect to myAvatar PM but are sending a request attached to an myAvatar CWS form, enter CWS for the Application property. |
| AllowFormAccess | 1 or 0 | If set to 1, the 'Form' entry for the to-do will be a link that opens the form to the RowId given, or a new row if no RowId is defined. Note that if creating a new row on an episode-based form, EpisodeNumber is required to generate the to-do. | |
|
| OptionId | The Option Identifier of the form the ToDo is associated with. | This value can be determined by running Form Documentation. |
| EpisodeNumber | An episode number of the client given as the EntityId.
| This field is ignored if AllowFormAccess is 0 (or undefined). This value should be left blank if the form defined by OptionId is non-episodic. Otherwise, it should be the episode to use when creating a new row of data via the to-do item generated. | |
|
| EntityId | The ID of the entity the row is associated with. |
|
|
| RowId | The Row ID to associate with the ToDo. | This value can be found by querying the tables associated with the forms. If AllowFormAccess is 1, this will be the row of data accessed by the Form link of the to-do. To create a new row of data, RowId should be left blank. |
|
| SendToUser | The user that the ToDo item should be sent to. | Must be an active myAvatar user. |
|
| OutgoingComments | The comments to be attached to the ToDo. |
|