Begin nu met monitoren en ontvang 20% korting op uw eerste factuur. Beschikbaar voor alle Uptrends-abonnementen.

Op deze pagina worden de beschikbare API-methodes voor het manipuleren van operatorgroepen beschreven. Operatorgroepen worden gebruikt om de operators (gebruikersaccounts) in uw account te organiseren. Deze API leverde methoden voor het beheren van elke groep en voor het toevoegen/verwijderen van operators aan/uit een groep.

Objectbeschrijving operatorgroep

Het volgende OperatorGroup-object wordt gebruikt in de hieronder beschreven API-methodes:

Naam Beschrijving Datatype
OperatorGroupGuid De unieke ID van deze operatorgroep. Guid
Description Een string die een beschrijvende naam bevat. String
IsEveryone Geeft aan of dit de systeemgroep “Iedereen” is. Boolean
IsAdministratorGroup Geeft aan of dit de systeemgroep “Administrators” is. Boolean

De groep “Iedereen” is een automatische, door het systeem gecreëerde groep. De groep Iedereen kan niet worden gewijzigd: elke operator wordt automatisch aan deze groep toegevoegd.

De "Administrators" is ook een door het systeem gecreëerde groep, maar u kunt individuele operators aan deze groep toevoegen of ze er weer uit verwijderen. Wanneer een operator wordt toegevoegd als lid van de groep Administrators, worden alle administratorrechten automatisch toegewezen aan die operator.

Eindpunten OperatorGroup

De volgende API-eindpunten zijn beschikbaar voor het ophalen, maken, bijwerken en verwijderen van operatorgroepen:

Type request Eindpunt Gebruik
GET /OperatorGroup Verkrijgt alle operatorgroepen.
GET /OperatorGroup/{operatorGroupGuid} Verkrijgt de details van een operatorgroep.
POST /OperatorGroup Creëert een nieuwe operatorgroep.
PUT /OperatorGroup/{operatorGroupGuid} Werkt een bestaande operatorgroep bij.
DELETE /OperatorGroup/{operatorGroupGuid} Verwijdert een bestaande operatorgroep.
GET /OperatorGroup/{operatorGroupGuid}/Member Verkrijgt de dienstroosters voor een bestaande operator.
POST /OperatorGroup/{operatorGroupGuid}/DutySchedule Voegt een dienstrooster toe aan alle operators in de gespecificeerde groep.
PUT /OperatorGroup/{operatorGroupGuid}/DutySchedule/{dutyScheduleId} Werkt het gespecificeerde dienstrooster bij.
DELETE /OperatorGroup/{operatorGroupGuid}/DutySchedule/{dutyScheduleId} Verwijdert het gespecificeerde dienstrooster.

GET OperatorGroup

Deze GET request retourneert een verzameling die alle operatorgroepen bevat, inclusief de speciale systeemgroepen.

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

Deze GET request retourneert de details van de specifieke operator die wordt geïdentificeerd door de gespecificeerde operator-GUID.

Voorbeeld uitvoer:

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

Hiermee wordt een nieuwe operatorgroep gemaakt met de verstrekte gegevens.

Voorbeeld invoer:

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

De respons bevat de gecreëerde operator, inclusief de operator-GUID die is toegewezen:

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

Deze methode werkt de operator bij die wordt geïdentificeerd door de opgegeven operator-GUID met behulp van de data die in de request zijn opgegeven.

Voorbeeld invoer:

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

Deze methode verwijdert de operator die wordt geïdentificeerd door de gespecificeerde operator-GUID met behulp van de in de request verstrekte data.