Planned Outages Public

API change history

Planned interruptions to the power for maintnence on Electra's network

/getPlannedOutages - GET

Fetches all planned outages that are set to start today or in the future.

Try it

Request

Request URL

Request body

Responses

200 OK

Successful operation

Representations

{
  "success": true,
  "plannedOutages": [
    {
      "jobStatus": "Scheduled",
      "primaryStartTimeUTC": "string",
      "primaryEndTimeUTC": "string",
      "secondaryStartTimeUTC": "string",
      "secondaryEndTimeUTC": "string",
      "jobArea": "Foxton",
      "affectedStreets": [
        "string"
      ],
      "numAffected": 0,
      "jobID": "string",
      "reason": "string"
    }
  ]
}
{
  "properties": {
    "success": {
      "type": "boolean"
    },
    "plannedOutages": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "jobStatus": {
                "enum": [
                  "Scheduled",
                  "Delayed",
                  "Cancelled",
                  "Completed"
                ],
                "type": "string"
              },
              "primaryStartTimeUTC": {
                "type": "string",
                "description": "The power will be turned off at some point after this time.",
                "format": "date-time"
              },
              "primaryEndTimeUTC": {
                "type": "string",
                "description": "The power is planned to be back on by this time.",
                "format": "date-time"
              },
              "secondaryStartTimeUTC": {
                "type": "string",
                "description": "If the job was not done in the primary window, the power will be turned off at some point after this time.",
                "format": "date-time"
              },
              "secondaryEndTimeUTC": {
                "type": "string",
                "description": "If the job was not done in the primary window, the power is planned to be back on by this time.",
                "format": "date-time"
              },
              "jobArea": {
                "enum": [
                  "Foxton",
                  "Foxton Beach",
                  "Hokio Beach",
                  "Levin",
                  "Manakau",
                  "Muhunoa East",
                  "Ohau",
                  "Shannon",
                  "Waikawa Beach",
                  "Waitarere",
                  "Otaihanga",
                  "Otaki",
                  "Otaki Beach",
                  "Paekakariki",
                  "Paraparaumu",
                  "Paraparaumu Beach",
                  "Peka Peka",
                  "Raumati",
                  "Te Horo",
                  "Waikanae",
                  "Waikanae Beach"
                ],
                "type": "string",
                "description": "The suburb that the job will take place in. Useful if you want to easily filter jobs to ones local to you."
              },
              "affectedStreets": {
                "type": "array",
                "items": {
                  "maxLength": 100,
                  "type": "string"
                },
                "description": "A list of street names that will have at least one property affected."
              },
              "numAffected": {
                "type": "integer",
                "description": "Number of properties affected by the planned outage."
              },
              "jobID": {
                "maxLength": 16,
                "type": "string",
                "description": "The ID of the job. This is not unique, a job may be split across several days and have multiple planned outages associated with it."
              },
              "reason": {
                "maxLength": 255,
                "type": "string",
                "description": "A short description of what work is happening"
              }
            },
            "description": "An individual planned outage. This may be a one off, or one event for a larger job."
          }
        ]
      }
    }
  },
  "description": "Response for the getPlannedOutages reuqest when the query type parameter is not set to Internal"
}

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": true,
  "message": "string"
}
{
  "properties": {
    "success": {
      "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/PlannedOutages/v1/getPlannedOutages"

--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/PlannedOutages/v1/getPlannedOutages?" + 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/PlannedOutages/v1/getPlannedOutages");


            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/PlannedOutages/v1/getPlannedOutages?" + $.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/PlannedOutages/v1/getPlannedOutages";
    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/PlannedOutages/v1/getPlannedOutages');
$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", "/PlannedOutages/v1/getPlannedOutages?%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", "/PlannedOutages/v1/getPlannedOutages?%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/PlannedOutages/v1/getPlannedOutages')


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