This page describes the available API methods for manipulating operators, i.e. user-specific login accounts. 

Operator object description

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

Name Description Data type
OperatorGuid The unique identifier for this operator. Guid
Email The operator's primary email address and login name. String
Password The operator's password. String
FullName The full name for this operator. String
MobilePhone The operator's mobile phone number. String
OutgoingPhoneNumber The operator's outgoing phone number. String
IsAccountAdministrator Indicates whether the operator is the administrator of the account. Boolean
BackupEmail The backup email address for this operator. String
IsOnDuty Indicates whether this operator is currently on duty. Boolean
CultureName If filled, this sets the culture for this operator.
Possible values: en-US, en-GB, fr-FR, de-DE, nl-NL or empty. When this value is set to empty, the overal account culture/language will be used.
String
TimeZoneId The unique identifier for the time zone this user will operate from. Short
SmsProvider The SMS provider used by the operator. If left blank, the settings for your account will be used.
Possible values: UseAccountSetting, SmsProviderEurope, SmsProviderEurope2, SmsProviderUSA, SmsProviderInternational
String
UseNumericSender If the SMS provider is configured specifically for this operator, this field indicates whether a numeric sender should be used. Boolean
PhoneProvider The provider used for phone alerts.  String
AllowNativeLogin If Native Login (username/password) is available and configured for your account, this indicates whether this operator is allowed to log onto Uptrends using their Uptrends username and password.
Possible values: UseAccountSetting, Enabled, Disabled
String
AllowSingleSignon

If Single Signon is available and configured for your account, this indicates whether this operator is allowed to use Single Sign-on.
Possible values: UseAccountSetting, Enabled, Disabled

String

Operator endpoints

The following API endpoints are available:

Request type Endpoint Usage
GET /Operator Gets all operators.
GET /Operator/{operatorGuid} Gets the details of an operator.
POST /Operator Creates a new operator.
PUT /Operator/{operatorGuid} Updates an existing operator.
DELETE /Operator/{operatorGuid} Deletes an existing operator
GET /Operator/{operatorGuid}/DutySchedule Gets the duty schedules for an existing operator.
POST /Operator/{operatorGuid}/DutySchedule Adds a duty schedule for an existing operator.
PUT /Operator/{operatorGuid}/DutySchedule/{dutyScheduleId} Updates the specified duty schedule.
DELETE /Operator/{operatorGuid}/DutySchedule/{dutyScheduleId} Deletes the specified duty schedule.