Starte noch heute mit dem Monitoring und erhalte 20% Rabatt auf Deine erste Rechnung. Gültig für alle Versionen.

Diese Seite beschreibt die verfügbaren API-Methoden zur Änderung von Operator-Gruppen. Operator-Gruppen dienen der Organisation von Operators (Nutzer-Accounts) in deinem Account. Diese API bietet Methoden zur Verwaltung jeder Gruppe sowie zum Hinzufügen/Entfernen von Operators zu/von einer Gruppe.

Beschreibung des Operator–Gruppen-Objekts

Die folgenden OperatorGroup-Objekte werden in den nachfolgend beschriebenen API-Methoden verwendet:

Name Beschreibung Datentyp
OperatorGroupGuid Die einzigartige Kennung dieser Operator-Gruppe. Guid
Description Eine Zeichenfolge mit einem beschreibenden Namen. String
IsEveryone Zeigt an, ob dies die Systemgruppe „Jeder“ ist. Boolean
IsAdministratorGroup Zeigt an, ob dies die Systemgruppe „Administratoren“ ist. Boolean

Die Gruppe „Jeder“ ist eine automatisch vom System erstellte Gruppe. Die Gruppe „Jeder“ kann nicht geändert werden: Jeder Operator wird automatisch zu dieser Gruppe hinzugefügt.

„Administratoren“ ist ebenfalls eine vom System erstellte Gruppe, aber du kannst einzelne Operators hinzufügen oder entfernen. Wenn ein Operator zur Gruppe „Administratoren“ hinzugefügt wird, verfügt dieser Operator automatisch über alle Administratorrechte.

OperatorGroup-Endpunkte

Die folgenden API-Endpunkte sind zum Abruf, Erstellen, Ändern und Entfernen von Operator-Gruppen verfügbar.

Anfragetyp Endpunkt Einsatz
GET /OperatorGroup Ruft alle Operator-Gruppen ab.
GET /OperatorGroup/{operatorGroupGuid} Ruft Informationen zu einer Operator-Gruppe ab.
POST /OperatorGroup Erstellt eine neue Operator-Gruppe.
PUT /OperatorGroup/{operatorGroupGuid} Aktualisiert eine bestehende Operator-Gruppe.
DELETE /OperatorGroup/{operatorGroupGuid} Löscht eine bestehende Operator-Gruppe.
GET /OperatorGroup/{operatorGroupGuid}/Member Ruft den Dienstplan eines bestehenden Operators ab.
POST /OperatorGroup/{operatorGroupGuid}/DutySchedule Fügt einen Dienstplan für alle Operators in der angegebenen Gruppe hinzu.
PUT /OperatorGroup/{operatorGroupGuid}/DutySchedule/{dutyScheduleId} Aktualisiert den angegebenen Dienstplan.
DELETE /OperatorGroup/{operatorGroupGuid}/DutySchedule/{dutyScheduleId} Löscht den angegebenen Dienstplan.

GET OperatorGroup

Diese GET-Anfrage ergibt eine Sammlung mit allen Operator-Gruppen, einschließlich der besonderen System-Gruppen.

[
 {
  "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}

Diese GET-Anfrage ergibt die Informationen für die durch die OperatorGroup GUID spezifizierte Operator-Gruppe.

Beispiel-Ausgabe:

{
 "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

Diese Eingabe dient der Erstellung einer neuen Operator-Gruppe mit den bereitgestellten Informationen.

Beispiel-Eingabe:

{
 "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"
}

Die Antwort enthält die erstellte Operator-Gruppe, einschließlich der zugewiesenen OperatorGroup GUID:

{
 "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}

Diese Methode aktualisiert die durch die OperatorGroup GUID spezifizierte Operator-Gruppe mit den Daten, die in der Anfrage übermittelt werden.

Beispiel-Eingabe:

{
 "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}

Diese Methode löscht die durch die OperatorGroup GUID spezifizierte Operator-Gruppe mit den Daten, die in der Anfrage übermittelt werden.