Electrical

API change history

Electrical calculations and analysis API, covering d.c., single phase and three phase equipment and systems.

Cable Fault Details (verbose)

Calculate full cable fault details, including source fault details, destination fault details and cable fault ratings.

Try it

Request

Request URL

Request parameters

  • number

    Cable detailsID [sourceID > cableLibraryID > cableDetialID]

  • number

    Three Phase Fault current, A

  • number

    Three Phase Fault Power factor (= 1 for d.c. circuits)

  • number

    Three Phase Fault Duration, s

  • number

    Earth Fault current, A

  • number

    Earth Fault Power factor (= 1 for d.c. circuits)

  • number

    Earth Fault Duration, s

  • number

    Positive Sequence Resistance of a cable (single conductor) or circuit element, Ω

  • number

    Positive Sequence Reactance of a cable (single conductor) or circuit element, Ω

  • number

    Zero Sequence Resistance of a cable (single conductor) or circuit element, Ω

  • number

    Zero Sequence Reactance of a cable (single conductor) or circuit element

  • number

    Voltage, V. For a.c. 3-ph line-line expected, for 1-ph line-neutral expected.

  • number

    Phase angle of a.c. voltage, radians. For d.c. or reference set to 0.

  • number

    Phase configuration: 0[d.c.], 1[single phase a.c.], 3[three phase a.c.], 4[three phase + neutral a.c.]

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Code samples

@ECHO OFF

curl -v -X GET "https://mycableengineering.azure-api.net/electrical/fault/cable/rating/{cableDetailsID}/{Ik3}/{IK3pf}/{Ik3t}/{Ik1}/{Ik1pf}/{Ik1t}/{Z1_resistance}/{Z1_reactance}/{Z0_resistance}/{Z0_reactance}/{voltage}/{voltagePhase}/{phase}"
-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}");

            var uri = "https://mycableengineering.azure-api.net/electrical/fault/cable/rating/{cableDetailsID}/{Ik3}/{IK3pf}/{Ik3t}/{Ik1}/{Ik1pf}/{Ik1t}/{Z1_resistance}/{Z1_reactance}/{Z0_resistance}/{Z0_reactance}/{voltage}/{voltagePhase}/{phase}?" + 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://mycableengineering.azure-api.net/electrical/fault/cable/rating/{cableDetailsID}/{Ik3}/{IK3pf}/{Ik3t}/{Ik1}/{Ik1pf}/{Ik1t}/{Z1_resistance}/{Z1_reactance}/{Z0_resistance}/{Z0_reactance}/{voltage}/{voltagePhase}/{phase}");


            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
        };
      
        $.ajax({
            url: "https://mycableengineering.azure-api.net/electrical/fault/cable/rating/{cableDetailsID}/{Ik3}/{IK3pf}/{Ik3t}/{Ik1}/{Ik1pf}/{Ik1t}/{Z1_resistance}/{Z1_reactance}/{Z0_resistance}/{Z0_reactance}/{voltage}/{voltagePhase}/{phase}?" + $.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://mycableengineering.azure-api.net/electrical/fault/cable/rating/{cableDetailsID}/{Ik3}/{IK3pf}/{Ik3t}/{Ik1}/{Ik1pf}/{Ik1t}/{Z1_resistance}/{Z1_reactance}/{Z0_resistance}/{Z0_reactance}/{voltage}/{voltagePhase}/{phase}";
    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 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://mycableengineering.azure-api.net/electrical/fault/cable/rating/{cableDetailsID}/{Ik3}/{IK3pf}/{Ik3t}/{Ik1}/{Ik1pf}/{Ik1t}/{Z1_resistance}/{Z1_reactance}/{Z0_resistance}/{Z0_reactance}/{voltage}/{voltagePhase}/{phase}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$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 = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('mycableengineering.azure-api.net')
    conn.request("GET", "/electrical/fault/cable/rating/{cableDetailsID}/{Ik3}/{IK3pf}/{Ik3t}/{Ik1}/{Ik1pf}/{Ik1t}/{Z1_resistance}/{Z1_reactance}/{Z0_resistance}/{Z0_reactance}/{voltage}/{voltagePhase}/{phase}?%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({
})

try:
    conn = http.client.HTTPSConnection('mycableengineering.azure-api.net')
    conn.request("GET", "/electrical/fault/cable/rating/{cableDetailsID}/{Ik3}/{IK3pf}/{Ik3t}/{Ik1}/{Ik1pf}/{Ik1t}/{Z1_resistance}/{Z1_reactance}/{Z0_resistance}/{Z0_reactance}/{voltage}/{voltagePhase}/{phase}?%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://mycableengineering.azure-api.net/electrical/fault/cable/rating/{cableDetailsID}/{Ik3}/{IK3pf}/{Ik3t}/{Ik1}/{Ik1pf}/{Ik1t}/{Z1_resistance}/{Z1_reactance}/{Z0_resistance}/{Z0_reactance}/{voltage}/{voltagePhase}/{phase}')


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