AVCS Online Discovery API

API change history

The ADMIRALTY Vector Chart Service (AVCS) Online Discovery API provides free access to a trial version of the AVCS Online Web Map Service (WMS). It is intended for use by developers from organisations who are interested in becoming re-sellers of AVCS Online. The Discovery API provides you with Electronic Navigational Charts (ENCs) along the south coast of England. You will have access to a maximum of 2000 API calls per day at a maximum rate of 30 calls per 30 second period.

If you then decide to move to the full AVCS Online solution, as a shore-based user and planning team, you will get access access to more than 18,000 Electronic Navigational Charts (ENCs), regularly updated without customers needing to install Update files, to support vessel tracking, voyage planning and for use in accident and emergency incidents. The inclusion of chart display settings and pick reports enables the on-board experience to be replicated from ashore.

AVCS Online can be integrated into existing web-based systems as a standalone chart solution, or as a base layer with other layers added, to optimise the planning and support potential of the service.

To use the AVCS Online Discovery API, follow the instructions here.

Following your trial of the Discovery API, if you would like to become a re-seller of AVCS Online, please visit: https://www.admiralty.co.uk/working-with-us

Notes

Get notes included in GetFeatureInfo responses.

Try it

Request

Request URL

https://admiraltyapi.azure-api.net/avcso-disco/notes?file={file}[&f]

Request parameters

file

string

The token obtained from feature attributes (txtdesc_token or picrep_token) returned in the GetFeatureInfo request results.
f (optional)

string

The required format.

Request headers

Ocp-Apim-Subscription-Key

string

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

Request body

Responses

200 OK

Success: note returned

401 Unauthorized

Token Authentication Failed

403 Forbidden

Forbidden or Quota Exceeded.
This will either be because:
- you have no permission to use this API
- the quota of calls per day has been exceeded

429 Too many requests

Too many requests - rate limit exceeded

500 Internal Server Error

Internal Server Error

Code samples

@ECHO OFF

curl -v -X GET "https://admiraltyapi.azure-api.net/avcso-disco/notes?file={file}?f=text/plain"
-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["f"] = "text/plain";
            var uri = "https://admiraltyapi.azure-api.net/avcso-disco/notes?file={file}&" + 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://admiraltyapi.azure-api.net/avcso-disco/notes?file={file}");

            builder.setParameter("f", "text/plain");

            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
            "f": "text/plain",
        };
      
        $.ajax({
            url: "https://admiraltyapi.azure-api.net/avcso-disco/notes?file={file}&" + $.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://admiraltyapi.azure-api.net/avcso-disco/notes?file={file}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"f=text/plain",
                      ];
    
    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://admiraltyapi.azure-api.net/avcso-disco/notes?file={file}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'f' => 'text/plain',
);

$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
    'f': 'text/plain',
})

try:
    conn = httplib.HTTPSConnection('admiraltyapi.azure-api.net')
    conn.request("GET", "/avcso-disco/notes?file={file}&%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
    'f': 'text/plain',
})

try:
    conn = http.client.HTTPSConnection('admiraltyapi.azure-api.net')
    conn.request("GET", "/avcso-disco/notes?file={file}&%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://admiraltyapi.azure-api.net/avcso-disco/notes?file={file}')

query = URI.encode_www_form({
    # Request parameters
    'f' => 'text/plain'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
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