This page describes the available API methods for manipulating operator groups. Operator groups are used to organize the operators (user accounts) in your account. This API provided methods for managing each group, and for adding/removing operators to and from a group.

Operator group object description

The following OperatorGroup object is used in the API methods described below:

Name Description Data type
OperatorGroupGuid The unique identifier for this operator group. Guid
Description
A string containing a descriptive name.
String
IsEveryone Indicates whether this is the “Everyone” system group. Boolean
IsAdministratorGroup Indicates whether this is the “Administrators” system group Boolean

The "Everyone" group is an automatic, system-created group. The Everyone group cannot be changed: each operator is automatically added to this group.

The "Administrators" is also a system-created group, but you can add individual operators to it or remove them again from this group. When an operator is added as a member of the Administrators group, all administrative privileges are automatically assigned to that operator.

OperatorGroup endpoints

The following API endpoints for retrieving, creating, updating and removing operator groups are available:

Request type Endpoint Usage
GET /OperatorGroup Gets all operator groups.
GET /OperatorGroup/{operatorGroupGuid} Gets the details of an operator group.
POST /OperatorGroup Creates a new operator group.
PUT /OperatorGroup/{operatorGroupGuid} Updates an existing operator group.
DELETE /OperatorGroup/{operatorGroupGuid} Deletes an existing operator group.
GET /OperatorGroup/{operatorGroupGuid}/Member Gets the duty schedules for an existing operator.
POST /OperatorGroup/{operatorGroupGuid}/DutySchedule Adds a duty schedule to all operators in the specified group.
PUT /OperatorGroup/{operatorGroupGuid}/DutySchedule/{dutyScheduleId} Updates the specified duty schedule.
DELETE /OperatorGroup/{operatorGroupGuid}/DutySchedule/{dutyScheduleId} Deletes the specified duty schedule.

GET OperatorGroup

This GET request will return a collection containing all operator groups, including the special system groups.

[
 {
  "operatorGroupGuid": "36fad910-6e9f-4886-b1a7-9b4637362cb8",
  "FullName": "First Operator",
  "Email": "FirstOperator@acme.com",
  "MobilePhone": "",
  "IsAccountAdministrator": true,
  "BackupEmail": " FirstOperator@gmail.com ",
  "IsOnDuty": true,
  "SmsProvider": "UseAccountSetting",
  "PhoneProvider": "UseAccountSetting",
  "AllowNativeLogin": "UseAccountSetting",
  "AllowSingleSignon": "UseAccountSetting"
 },
 {
  "operatorGroupGuid": "23a75d1f-0dec-4963-86d8-0cee21267db4",
  "UserName": "SecondOperator@acme.com",
  "FullName": "Second Operator",
  "Email": "SecondOperator@acme.com",
  "MobilePhone": "",
  "IsAccountAdministrator": false,
  "BackupEmail": "",
  "IsOnDuty": false,
  "SmsProvider": "SmsProviderEurope",
  "UseNumericSender": false,
  "PhoneProvider": "UseAccountSetting",
  "AllowNativeLogin": "UseAccountSetting",
  "AllowSingleSignon": "UseAccountSetting"
 }
]

GET OperatorGroup/{operatorGroupGuid}

This GET request will return the details of the specific operator identified by the operator GUID specified.

Example output:

{
 "operatorGroupGuid": "d2782d76-62e7-4946-a41c-fc7f86c96300",
 "FullName": "Third Operator",
 "Email": "ThirdOperator@acme.com",
 "MobilePhone": "+31612345678",
 "OutgoingPhoneNumber": "",
 "IsAccountAdministrator": false,
 "BackupEmail": "",
 "IsOnDuty": false,
 "CultureName": "",
 "TimeZoneId": 56,
 "SmsProvider": "SmsProviderUSA",
 "UseNumericSender": false,
 "PhoneProvider": "UseAccountSetting",
 "AllowNativeLogin": "UseAccountSetting",
 "AllowSingleSignon": "UseAccountSetting"
}

POST OperatorGroup

This will create a new operator group with the details provided.

Example input:

{
 "FullName": "Third Operator",
 "Email": "ThirdOperator@acme.com",
 "MobilePhone": "+31612345678",
 "OutgoingPhoneNumber": "",
 "IsAccountAdministrator": false,
 "BackupEmail": "",
 "IsOnDuty": false,
 "CultureName": "",
 "TimeZoneId": 56,
 "SmsProvider": "SmsProviderUSA",
 "UseNumericSender": false,
 "PhoneProvider": "UseAccountSetting",
 "AllowNativeLogin": "UseAccountSetting",
 "AllowSingleSignon": "UseAccountSetting"
}

The response will contain the created operator, including the operator GUID that was assigned:

{
 "operatorGroupGuid": "d2782d76-62e7-4946-a41c-fc7f86c96300",
 "FullName": "Third Operator",
 "Email": "ThirdOperator@acme.com",
 "MobilePhone": "+31612345678",
 "OutgoingPhoneNumber": "",
 "IsAccountAdministrator": false,
 "BackupEmail": "",
 "IsOnDuty": false,
 "CultureName": "",
 "TimeZoneId": 56,
 "SmsProvider": "SmsProviderUSA",
 "UseNumericSender": false,
 "PhoneProvider": "UseAccountSetting",
 "AllowNativeLogin": "UseAccountSetting",
 "AllowSingleSignon": "UseAccountSetting"
}

PUT OperatorGroup/{operatorGroupGuid}

This method will update the operator identified by the operator GUID specified, using the data provided in the request.

Example input:

{
 "operatorGroupGuid": "d2782d76-62e7-4946-a41c-fc7f86c96300",
 "FullName": "Third Operator",
 "Email": "ThirdOperator@acme.com",
 "MobilePhone": "+31612345678",
 "OutgoingPhoneNumber": "",
 "IsAccountAdministrator": false,
 "BackupEmail": "",
 "IsOnDuty": false,
 "CultureName": "",
 "TimeZoneId": 56,
 "SmsProvider": "SmsProviderUSA",
 "UseNumericSender": false,
 "PhoneProvider": "UseAccountSetting",
 "AllowNativeLogin": "UseAccountSetting",
 "AllowSingleSignon": "UseAccountSetting"
}

DELETE OperatorGroup/{operatorGroupGuid}

This method will delete the operator identified by the operator GUID specified, using the data provided in the request.