TeamDefinition - PM web service
- Last updated
-
-
Save as PDF
Avatar PM WEBSVC.TeamDefinition web service
This web service has the following calls:
- CreateTeamDefinition - Create a new team in myAvatar
- GetTeamDefinition - Get the details of an existing team
- UpdateTeamDefinition - Update details of an existing team
- DeleteTeamDefinition - Delete a team from myAvatar
- AddClientToTeam - Assign a client to an existing team
- RemoveClientFromTeam - Remove a client from an existing team
- GetDictionaryItems - Get all the dictionary fields that are used in this web service
AddClientToTeam
The following tables list the AddClientToTeam parameters, properties, accepted values, and associated dictionaries.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: SAMPLE, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| ClientID |
N/A |
Avatar Client ID |
|
| EpisodeNumber |
N/A |
Episode Number |
|
| TeamID |
N/A |
Team ID |
|
CreateTeamDefinition
The following tables list the CreateTeamDefinition parameters, properties, accepted values, and associated dictionaries.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: SAMPLE, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
Parameters with properties
| Parameter |
Property |
Value Accepted |
Notes |
| TeamDefinitionInfo |
TeamDefinitionObject |
WEBSVC.TeamDefinitionObject |
This parameter is itself a web service object -- see below for its properties |
DeleteTeamDefinition
The following tables list the DeleteTeamDefinition parameters, properties, accepted values, and associated dictionaries.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: SAMPLE, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| TeamID |
N/A |
Team ID to delete |
|
GetDictionaryItems
The following tables list the GetDictionaryItems parameters, properties, accepted values, and associated dictionaries.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: SAMPLE, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
GetTeamDefinition
The following tables list the GetTeamDefinition parameters, properties, accepted values, and associated dictionaries.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: SAMPLE, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| TeamID |
N/A |
Team ID |
|
RemoveClientFromTeam
The following tables list the RemoveClientFromTeam parameters, properties, accepted values, and associated dictionaries.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: SAMPLE, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| ClientID |
N/A |
Avatar Client ID |
|
| EpisodeNumber |
N/A |
Episode Number |
|
| TeamID |
N/A |
Team ID |
|
UpdateTeamDefinition
The following tables list the UpdateTeamDefinition parameters, properties, accepted values, and associated dictionaries.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: SAMPLE, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
Parameters with properties
| Parameter |
Property |
Value Accepted |
Notes |
| TeamDefinitionInfo |
TeamDefinitionObject |
WEBSVC.TeamDefinitionObject |
This parameter is itself a web service object -- see below for its properties |
Object class name: WEBSVC.TeamDefinitionObject
| Parameter |
Property |
Value Accepted |
Notes |
| TeamDefinitionObject |
TeamID |
Free Text |
|
| |
TeamDescription |
Free Text |
|
| |
Type |
Free Text |
|
| |
Active |
Dictionary |
"Y" or "N". RADplus System dictionary item 5703 |
| |
AssignedUserRoles |
Free Text |
|
| |
AssignedUsers |
Free Text |
|
| |
AssignedPrograms |
Free Text |
|
| |
AssignedUnits |
Free Text |
|
| |
AssignedSites |
Free Text |
|
| |
TeamFinalizer |
Free Text |
|
| |
TeamOwners |
Free Text |
|
| |
DisableCaseloadAdd |
Dictionary |
Disable Adding Client to caseload. "Y" or "N". RADplus System dictionary item 5729 |
| |
UseFinalizerAsSupervisor |
Dictionary |
Use Team Finalizer as Default Supervisor for Document Routing. "Y" or "N". RADplus System dictionary item 5730 |
| |
IndividualClientAssignment |
WEBSVC.TeamDefClientObject |
This property of TeamDefinitionObject is itself an Object -- see below for its properties. Multiple TeamDefClientObjects can be associated with one TeamDefinitionObject |
| |
Message |
Free Text |
|
| |
Status |
Free Text |
|
Object class name: WEBSVC.TeamDefClientObject
| Parameter |
Property |
Value Accepted |
Notes |
| TeamDefClientObject |
ClientID |
Avatar Client ID |
|
| |
Episode |
Episode ID |
|
| |
Message |
Free Text |
|
| |
Status |
Free Text |
Status Code |
