QueryGroup

Returns the details of a specified Group.

Sample SOAP Request

Request Parameters

Name

Description

Type

Optional

groupName

Target name of the Group to be queried

string

no

Sample SOAP Response

Response Parameters

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

SoapQueryGroupsSupervisorList

observedByAll

Indicates whether all Roles can observe this Group

Boolean

observers

List of Group observers

SoapQueryGroupsObserverList

coverages

List of Schedules and associated Teams for this Group

string

coverage

Contains the specifics of each Coverage

SoapQueryGroupsScheduleList

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

SoapTeamList

name

Team's name

string

type

Team type (may be BASIC, EVENT_ROUND_ROBIN, COVERAGE_BASED_ROTATION, or ROTATION)

string

rotationParameters

Present if Team type is ROTATION:

  • interval: integer value indicating how often the Team rotates
  • unit: interval time unit (may be DAYS, WEEKS or MONTHS)
  • start: date/time at which the rotation starts

Present if Team type is COVERAGE_BASED_ROTATION:

  • interval: integer value indicating how often the Team rotates
  • start: date at which the rotation starts

string

members

List of Team members

string

member

Each Team member is represented by the following parameters:

  • name: name of the Team member
  • description: description of the Team member
  • active: Boolean indicating whether or not this Team member is active
  • delay: how long, in minutes, to wait before notifying this Team member
  • escalation: how long, in minutes, before this Team member will be notified based on previous delays
  • inRotation: Boolean indicating whether or not this Team member is included in the rotation (applies only to rotation Teams) string

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

Standard SOAP Parameters

SOAP Response Status Messages