# Integration Guidelines for Partner Relationship Management

# Operator Alarm Utility

## Web Service

The Operator Alarm Utility Web Service allows the Operator to retrieve alarms from Oracle Communications Services Gatekeeper.

### Interface: OpAlarmUtil

The endpoint for this interface is: `http://<host>:<port>/prm_op/services/OpAlarmUtil`

where the value of host and port depend on the Oracle Communications Services Gatekeeper deployment.

### countAlarms

Counts the number of alarms of a certain type of a given severity for a specified time interval

Table 14-1 countAlarms(alarmId, severity, fromDate, toDate)
Parameter Name | Type | Description
--- | --- | ---
Input |  |
alarmId | xsd:int | The ID of the type of alarm.
severity | tns1:AlarmSeverity | Severity of the alarm. See AlarmSeverity. Use null to not filter on this parameter
fromDate | xsd:dateTime | From the date and time. Use null to not filter on this parameter.
toDate | xsd:dateTime | To the date and time. Use null to not filter on this parameter.
Returns |  |
countAlarmsReturn | xsd:long | The number of alarms.
Possible Exceptions |  |
ACCESS_DENIED |  |
CommonException |  |

### listAlarms

Retrieves all alarms matching the given criteria

Table 14-2 listAlarms(alarmId, severity, fromDate, toDate, startIndex, maxEntries)
Parameter Name | Type | Description
--- | --- | ---
Input |  |
alarmId | xsd:int | The ID of the type of alarm.
severity | tns1:AlarmSeverity | Severity of the alarm. See AlarmSeverity. Use null to not filter on this parameter.
fromDate | xsd:dateTime | From date and time.Use null to not filter on this parameter.
toDate | xsd:dateTime | To date and time. Use null to not filter on this parameter.
startIndex | xsd:long | Which entry, in the overall result set, to start the result list on (cursor).
maxEntries | xsd:int | The maximum number of alarms returned.
Returns |  |
listAlarmsReturn | Array of tns1:AlarmInfo | List of alarms. See AlarmInfo.
Possible Exceptions |  |
ACCESS_DENIED |  |
CommonException |  |

### Exceptions

#### CommonException

This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.

### Data types

#### AlarmInfo

Data structure defining an alarm.

Table 14-3 AlarmInfo
Element name | Datatype | Description
--- | --- | ---
alarmInstanceId | xsd:long | The ID of the emitted alarm. Unique identifier for an emitted alarm.
alarmId | xsd:int | The identifier for the alarm type.
source | xsd:string | Specifies the name of the software module that raised the alarm and the IP address of the server the service is installed in.
severity | tns1:AlarmSeverity | Specifies the alarm’s severity level. See AlarmSeverity.
timeStamp | xsd:dateTime | Specifies the time and date the alarm was raised.
info | xsd:string | Alarm information provided by the software module the raised the alarm.
additional_info | xsd:string | Additional information depending on context.

#### AlarmSeverity

Defines the severity of an alarm. Enumeration

Table 14-4 AlarmSeverity
Element name | Datatype | Description
--- | --- | ---
WARNING | xsd:string | Severity level is Warning.
MINOR | xsd:string | Severity level is Minor.
MAJOR | xsd:string | Severity level is Major.
CRITICAL | xsd:string | Severity level is Critical.

.