ICP connection data v2
API change historyThe ICP connection data API provides two functions to get data on Installation Control Points (ICP):
- The GET action - a search function, allows searching by via address filters and returns matching results allowing the correct ICP to be identified.
- The GET action - get by id, takes a single ICP and returns detailed information about it.
A management policy for this API is set in the API product.
In order to use the ICP connection data you must subscribe to the ICP connection data API product to receive your API key.
Search
The most accurate and fast way to find connection information is by using the ‘get by id’ call with an ICP number. This is a wildcard search filter and if you are using this search function you will likely get multiple addresses returned. For example a search for “2 Main Street” will return results for locations at 2, 20, 22… etc, along with results for any other Main Streets around the country. However, in some instances no information might be returned. This may be due to the way the address information is stored in the registry or other differences between the address of the ICP and the address entered or address that the ICP serves. ICP numbers can be found on any power bill.
Try itRequest
Request URL
Request parameters
-
(optional)string
The street number. This is a wildcard value. (e.g. 2 will return 2, 20, 22 etc)
-
(optional)string
The street name. This is a wildcard value.
-
(optional)string
The suburb or town. This is a wildcard value.
-
(optional)string
The region. This is NOT a wildcard value.
Request headers
Request body
Responses
200 OK
Success
Representations
{
"Address": {
"PropertyNameOrDescription": "string",
"PhysicalAddressUnit": "string",
"PhysicalAddressNumber": "string",
"PhysicalAddressStreet": "string",
"PhysicalAddressSuburb": "string",
"PhysicalAddressTown": "string",
"PhysicalAddressRegion": "string",
"PhysicalAddressPostCode": 0,
"GPS_Easting": 0.11158078265068716,
"GPS_Northing": 0.53635229909462989
},
"ICPIdentifier": "string",
"ICPStatus": 0,
"Messages": [
"string"
]
}
{
"type": "object",
"properties": {
"Address": {
"type": "object",
"properties": {
"PropertyNameOrDescription": {
"type": "string"
},
"PhysicalAddressUnit": {
"type": "string"
},
"PhysicalAddressNumber": {
"type": "string"
},
"PhysicalAddressStreet": {
"type": "string"
},
"PhysicalAddressSuburb": {
"type": "string"
},
"PhysicalAddressTown": {
"type": "string"
},
"PhysicalAddressRegion": {
"type": "string"
},
"PhysicalAddressPostCode": {
"format": "int32",
"type": "integer"
},
"GPS_Easting": {
"format": "double",
"type": "number"
},
"GPS_Northing": {
"format": "double",
"type": "number"
}
},
"example": {
"PropertyNameOrDescription": "string",
"PhysicalAddressUnit": "string",
"PhysicalAddressNumber": "string",
"PhysicalAddressStreet": "string",
"PhysicalAddressSuburb": "string",
"PhysicalAddressTown": "string",
"PhysicalAddressRegion": "string",
"PhysicalAddressPostCode": 0,
"GPS_Easting": 0.1778884353872654,
"GPS_Northing": 0.24947440612677929
}
},
"ICPIdentifier": {
"type": "string"
},
"ICPStatus": {
"format": "int32",
"type": "integer"
},
"Messages": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"Address": {
"PropertyNameOrDescription": "string",
"PhysicalAddressStreet": "string",
"PhysicalAddressSuburb": "string",
"PhysicalAddressTown": "string",
"PhysicalAddressRegion": "string",
"PhysicalAddressPostCode": 0,
"GPS_Easting": 0.0989286100290292,
"GPS_Northing": 0.799358073891151
},
"ICPIdentifier": "string",
"ICPStatus": 0,
"Messages": [
"string"
]
}
}
400 Bad Request
Invalid search filters provided - at least streetNumber AND streetName must contain values. Optionally also provide values for suburbOrTown and/or region.
Representations
{
"Message": "string"
}
{
"type": "object",
"properties": {
"Message": {
"type": "string"
}
},
"example": {
"Message": "string"
}
}
403 Forbidden
Forbidden
Representations
{
"statusCode": 0,
"message": "string"
}
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"message": {
"type": "string"
}
},
"example": {
"statusCode": 0,
"message": "string"
}
}
429 Too many requests
The management policy has been exceeded on the API. See the EMI API website for policy details.
Representations
{
"Message": "string"
}
{
"type": "object",
"properties": {
"Message": {
"type": "string"
}
},
"example": {
"Message": "string"
}
}
503 Service Unavailable
The underlying service is currently busy. Please try again later.
Representations
{
"Message": "string"
}
{
"type": "object",
"properties": {
"Message": {
"type": "string"
}
},
"example": {
"Message": "string"
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://emi.azure-api.net/ICPConnectionData/v2/search/?streetNumber={string}&streetName={string}&suburbOrTown={string}®ion={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--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);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["streetNumber"] = "{string}";
queryString["streetName"] = "{string}";
queryString["suburbOrTown"] = "{string}";
queryString["region"] = "{string}";
var uri = "https://emi.azure-api.net/ICPConnectionData/v2/search/?" + 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://emi.azure-api.net/ICPConnectionData/v2/search/");
builder.setParameter("streetNumber", "{string}");
builder.setParameter("streetName", "{string}");
builder.setParameter("suburbOrTown", "{string}");
builder.setParameter("region", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// 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
"streetNumber": "{string}",
"streetName": "{string}",
"suburbOrTown": "{string}",
"region": "{string}",
};
$.ajax({
url: "https://emi.azure-api.net/ICPConnectionData/v2/search/?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
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://emi.azure-api.net/ICPConnectionData/v2/search/";
NSArray* array = @[
// Request parameters
@"entities=true",
@"streetNumber={string}",
@"streetName={string}",
@"suburbOrTown={string}",
@"region={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// 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://emi.azure-api.net/ICPConnectionData/v2/search/');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'streetNumber' => '{string}',
'streetName' => '{string}',
'suburbOrTown' => '{string}',
'region' => '{string}',
);
$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 = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'streetNumber': '{string}',
'streetName': '{string}',
'suburbOrTown': '{string}',
'region': '{string}',
})
try:
conn = httplib.HTTPSConnection('emi.azure-api.net')
conn.request("GET", "/ICPConnectionData/v2/search/?%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 = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'streetNumber': '{string}',
'streetName': '{string}',
'suburbOrTown': '{string}',
'region': '{string}',
})
try:
conn = http.client.HTTPSConnection('emi.azure-api.net')
conn.request("GET", "/ICPConnectionData/v2/search/?%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://emi.azure-api.net/ICPConnectionData/v2/search/')
query = URI.encode_www_form({
# Request parameters
'streetNumber' => '{string}',
'streetName' => '{string}',
'suburbOrTown' => '{string}',
'region' => '{string}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# 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