Current Outages Public

API change history

The outages that are currently or have recently occurred on our network. These outages include those caused by unexpected faults as well as planned maintenance.

/getCurrentOutages - GET

Fetches all outages that are currently occuring or have recently been restored.

Try it

Request

Request URL

Request body

Responses

200 OK

Successful operation

Representations

{
  "success": "string",
  "currentOutages": [
    {
      "status": "Assumed",
      "crewAssigend": true,
      "startTime": "string",
      "estimatedRestorationTime": "string",
      "restoredTime": "string",
      "customersAffected": 0,
      "customersRestored": 0,
      "area": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "success": {
      "type": "string"
    },
    "currentOutages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "status": {
            "enum": [
              "Assumed",
              "Confirmed",
              "Restored"
            ],
            "type": "string",
            "description": "The current status of the outage. Assumed is an outage that we have heard about. Confirmed is an outage that we have verified that the power is out. Restored is an outage that has been fixed and the power is back on."
          },
          "crewAssigend": {
            "type": "boolean",
            "description": "True if the outage has been assigned to one of the field crew. This does not mean that the crew is on site, they may be on their way or fixing other outages first."
          },
          "startTime": {
            "type": "string",
            "description": "Time the outage was reported, not neccesarily the time the affected customers lost power.",
            "format": "date-time"
          },
          "estimatedRestorationTime": {
            "type": "string",
            "description": "The time that the field crew estimate that they will have the power back on by. Will be null if the field crew have not estimated a time yet.",
            "format": "date-time"
          },
          "restoredTime": {
            "type": "string",
            "description": "The time that the outage was restored. Will be null if the outage is not restored yet.",
            "format": "date-time"
          },
          "customersAffected": {
            "type": "integer",
            "description": "The number of customers affected by the outage"
          },
          "customersRestored": {
            "type": "integer",
            "description": "The number of customers that were affected by the outage and have no had their power restored"
          },
          "area": {
            "type": "string",
            "description": "The area the outage is in. If an outage spans a large area then the suburb in the middle of the outage is chosen."
          }
        },
        "description": "A single outage that is currently occuring or has recently been restored."
      }
    }
  }
}

429 Too many requests

The number of requests has exceeded the rate limit

Representations

{
  "success": false,
  "message": "string"
}
{
  "type": "object",
  "properties": {
    "success": {
      "enum": [
        false
      ],
      "type": "boolean",
      "description": "Will be set to false for a failed operation"
    },
    "message": {
      "type": "string",
      "description": "Error message"
    }
  }
}

500 Internal Server Error

Failed operation

Representations

{
  "success": false,
  "message": "string"
}
{
  "type": "object",
  "properties": {
    "success": {
      "enum": [
        false
      ],
      "type": "boolean",
      "description": "Will be set to false for a failed operation"
    },
    "message": {
      "type": "string",
      "description": "Error message"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://elg-api.azure-api.net/currentoutages/v1/getCurrentOutages"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);


            var uri = "https://elg-api.azure-api.net/currentoutages/v1/getCurrentOutages?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://elg-api.azure-api.net/currentoutages/v1/getCurrentOutages");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://elg-api.azure-api.net/currentoutages/v1/getCurrentOutages?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://elg-api.azure-api.net/currentoutages/v1/getCurrentOutages";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://elg-api.azure-api.net/currentoutages/v1/getCurrentOutages');
$url = $request->getUrl();

$headers = array(
    // Request headers
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('elg-api.azure-api.net')
    conn.request("GET", "/currentoutages/v1/getCurrentOutages?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('elg-api.azure-api.net')
    conn.request("GET", "/currentoutages/v1/getCurrentOutages?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://elg-api.azure-api.net/currentoutages/v1/getCurrentOutages')


request = Net::HTTP::Get.new(uri.request_uri)
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body