Returns the details of a specified Group.
Name |
Description |
Type |
Optional |
groupName |
Target name of the Group to be queried |
string |
no |
Name |
Description |
Type |
active |
Indicates whether this Group is active |
Boolean |
name |
Group's name |
string |
description |
Group's description |
string |
timezone |
Group's time zone |
string |
site |
Site used to determine Group holidays |
string |
externallyOwned |
Indicates whether the Group is managed by Data Synchronization |
Boolean |
useDefaultDevices |
Indicates whether to use Group member's default Devices when other Devices are not available |
Boolean |
allowDuplicates |
Indicates whether the Group allows duplicate members |
Boolean |
supervisors |
List of the Group’s supervisors |
|
observedByAll |
Indicates whether all Roles can observe this Group |
Boolean |
observers |
List of Group observers |
|
coverages |
List of Schedules and associated Teams for this Group |
string |
coverage |
Contains the specifics of each Coverage |
|
timeframe |
Specification of a shift; for an example, see FindWhoIsOnDuty |
string |
isActive |
Indicates whether the Schedule is active |
Boolean |
teams |
List of Teams which are members of this Group |
string |
team |
Team associated with this Group |
|
name |
Team's name |
string |
type |
Team type (may be BASIC, EVENT_ROUND_ROBIN, |
string |
rotationParameters |
Present if Team type is ROTATION:
Present if Team type is COVERAGE_BASED_ROTATION:
|
string |
members |
List of Team members |
string |
member |
Each Team member is represented by the following parameters:
|
string |
serverTimestamp |
Time corresponding to the server time when the request was made (this should match the associated persisted audit event) |
string |
status |
Final status of the request |
string |