Colocation NOC TEST

Method

Events_Report

Report Name

General Reports - Events

Description

Shows depth information for the selected unit/group/cluster/organization events

Parameter Description

Base URL: https://sdk.galooli-systems.com/Json/
Request Method: Events_Report
Common Parameters: userName=[MY USER]&password=[MY PASSWORD]
Requested Fields: requestedPropertiesStr=[fieldName]
Date and Time Stamp:startTime=[YYYY-MM-DD HH:MM:SS]&endTime=[YYYY-MM-DD HH:MM:SS]
Requested Asset Object: requestedUnits=[o/f/g/u ID]

Request Example

https://sdk.galooli-systems.com/Json/Events_Report?userName=userName=[MY USER]&password=[MY PASSWORD]&requestedPropertiesStr=[fieldName]&startTime=[YYYY-MM-DD HH:MM:SS]&endTime=[YYYY-MM-DD HH:MM:SS]&requestedEvents=any&requestedUnits=[o/f/g/u ID]

Results Structure

{
   "CommonResult":{
      "ResultDescription":"",
      "ResultCode":0,
      "DataSet":[
         [
            "Colombia 2",
            "2022-12-24 12:07:53",
            "Battery Full On Solar",
            ""
         ],
         [
            "Colombia 2",
            "2022-12-24 12:24:53",
            "Battery Full On Solar",
            ""
         ],
         [
            "Colombia 2",
            "2022-12-24 12:45:53",
            "Battery Full On Solar",
            ""
         ]
      ]
   }
}

A dedicated API made for end client(s).

We have been asked to allow a method to query the active status of alarms within the ‘APPs - Colocation NOC’ service.

The API will reply to any user that has access rights to the ‘APPs - Colocation NOC’.

User credential perquisites

A valid user (Authorized to login to Galooli’s platform)
The user must have an access permission to the ‘APPs - Colocation NOC’
The user must have at-lease one assigned TENANT

Service Limitations

Max request interval (per user): Request per 10 seconds

Request structure

https://space-apps.galooli.com/AlarmsStatus/AlarmsStatusIndex?handler=APIColocationNOC&user=[USER]&password=[PASSWORD]

Request Parameters

User/Password – self-explanatory

Error Result Codes

Requests are too frequent - max request interval is 10seconds (per user)
Authentication failed – wrong user/password
Invalid User Configuration - Missing Credentials or missing Tenants configuration
Failed to retrieve categories - [Internal] Error while requesting service categories configuration
Invalid Data - [Internal] Error while requesting active alarms status

Valid Result Sample (JSON format)

Note - api_noc_Alarms_item field varies per the configuration of the ‘APPs - Colocation NOC’ service.

[
  {
    "SiteName": "SITE NAME 1",
    "api_noc_Alarms_item": [
      {
        "AlarmName": "AC power",
        "IsActive": true
      },
      {
        "AlarmName": "LVD",
        "IsActive": false
      },
      {
        "AlarmName": "High temperature",
        "IsActive": false
      },
      {
        "AlarmName": "DC Available",
        "IsActive": true
      }
    ],
    "Session_start_time": "2023-04-21T15:09:12",
    "Last_alarm_time": "2023-04-21T15:54:15",
    "TenantsSiteId": "SITE ID 1",
    "DisconnectedTenants": "",
    "PowerDownTenants": "TENANT NAME",
    "LoadDownTenants": "TENANT NAME"
  },
  {
    "SiteName": "SITE NAME 2",
    "api_noc_Alarms_item": [
      {
        "AlarmName": "AC power",
        "IsActive": false
      },
      {
        "AlarmName": "LVD",
        "IsActive": false
      },
      {
        "AlarmName": "High temperature",
        "IsActive": false
      },
      {
        "AlarmName": "DC Available",
        "IsActive": true
      }
    ],
    "Session_start_time": "2023-04-24T00:57:58",
    "Last_alarm_time": "2023-04-24T00:57:58",
    "TenantsSiteId": "SITE ID 2",
    "DisconnectedTenants": "",
    "PowerDownTenants": "TENANT NAME",
    "LoadDownTenants": "TENANT NAME"
  }
]