OGC_WMS_ENC

API change history

OCG Web Mapping Service (V1.3.0) for UK ENC data

WMS_GetMap

A Web Map Service (WMS) produces maps of spatially referenced data dynamically from geographic information. This International Standard defines a “map” to be a portrayal of geographic information as a digital image file suitable for display on a computer screen. A map is not the data itself.WMS-produced maps are generally rendered in a pictorial format such as PNG, GIF or JPEG, or occasionally as vector-based graphical elements in Scalable Vector Graphics (SVG) or Web Computer Graphics Metafile(WebCGM) formats.

This service supports version 1.3.0 of the OGC WMS Specification http://www.opengeospatial.org/standards/wms

Layers:

Display DISPSTD: Standard Display DISPFULL: Full symbolisation DISPBASE: Base display (good for transparency as land one colour 0xCCC57B)

OVERSCALE SECTORS DEPTHCONTOURLABELS BOUNDARY SAFETYCONTOURLABELS FILTERWARNING SHALLOWPATTERN SHALLOWSOUNDINGS SHALLOWWATERDANGERS TEXT DEEPSOUNDINGS SAFETYLABELS TWOSHADES NOSCALE SCAMIN

Try it

Request

Request URL

Request parameters

  • string

    Request version.

  • string

    Request name.

  • string

    Comma-separated list of one or more map layers.

  • string

    Comma-separated list of one rendering style per requested layer.

  • string

    Coordinate reference system.

  • string

    Bounding box corners (lower left, upper right) in CRS units.

  • string

    Width in pixels of map picture.

  • string

    Height in pixels of map picture.

  • string

    Output format of map.

  • (optional)
    string

    OPTIONAL Background transparency of map (default=FALSE).

  • (optional)
    string

    OPTIONALHexadecimal red-green-blue colour value for the background color(default=0xCCC57B Chart Land).

  • (optional)
    string

    OPTIONALThe format in which exceptions are to be reported by the WMS(default=XML).

  • (optional)
    string

    OPTIONALTime value of layer desired.

  • (optional)
    string

    OPTIONALElevation of layer desired.

Request headers

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

Request body

Responses

200 OK

OK

Representations

string
{
  "type": "string"
}
string
{
  "type": "string"
}
<WebchartingWMS_ENCV130V1GetMapGet200ApplicationXmlResponse>string</WebchartingWMS_ENCV130V1GetMapGet200ApplicationXmlResponse>
{
  "type": "string"
}
<WebchartingWMS_ENCV130V1GetMapGet200TextXmlResponse>string</WebchartingWMS_ENCV130V1GetMapGet200TextXmlResponse>
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X GET "https://ukho.azure-api.net/api/webcharting/WMS_ENC/v130/v1/GetMap?VERSION={VERSION}&REQUEST={REQUEST}&LAYERS={LAYERS}&STYLES={STYLES}&CRS={CRS}&BBOX={BBOX}&HEIGHT={HEIGHT}&WIDTH={WIDTH}&FORMAT={FORMAT}?TRANSPARENT={string}&BGCOLOR={string}&EXCEPTIONS={string}&TIME={string}&ELEVATION={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["TRANSPARENT"] = "{string}";
            queryString["BGCOLOR"] = "{string}";
            queryString["EXCEPTIONS"] = "{string}";
            queryString["TIME"] = "{string}";
            queryString["ELEVATION"] = "{string}";
            var uri = "https://ukho.azure-api.net/api/webcharting/WMS_ENC/v130/v1/GetMap?VERSION={VERSION}&REQUEST={REQUEST}&LAYERS={LAYERS}&STYLES={STYLES}&CRS={CRS}&BBOX={BBOX}&HEIGHT={HEIGHT}&WIDTH={WIDTH}&FORMAT={FORMAT}&" + 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://ukho.azure-api.net/api/webcharting/WMS_ENC/v130/v1/GetMap?VERSION={VERSION}&REQUEST={REQUEST}&LAYERS={LAYERS}&STYLES={STYLES}&CRS={CRS}&BBOX={BBOX}&HEIGHT={HEIGHT}&WIDTH={WIDTH}&FORMAT={FORMAT}");

            builder.setParameter("TRANSPARENT", "{string}");
            builder.setParameter("BGCOLOR", "{string}");
            builder.setParameter("EXCEPTIONS", "{string}");
            builder.setParameter("TIME", "{string}");
            builder.setParameter("ELEVATION", "{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
            "TRANSPARENT": "{string}",
            "BGCOLOR": "{string}",
            "EXCEPTIONS": "{string}",
            "TIME": "{string}",
            "ELEVATION": "{string}",
        };
      
        $.ajax({
            url: "https://ukho.azure-api.net/api/webcharting/WMS_ENC/v130/v1/GetMap?VERSION={VERSION}&REQUEST={REQUEST}&LAYERS={LAYERS}&STYLES={STYLES}&CRS={CRS}&BBOX={BBOX}&HEIGHT={HEIGHT}&WIDTH={WIDTH}&FORMAT={FORMAT}&" + $.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://ukho.azure-api.net/api/webcharting/WMS_ENC/v130/v1/GetMap?VERSION={VERSION}&REQUEST={REQUEST}&LAYERS={LAYERS}&STYLES={STYLES}&CRS={CRS}&BBOX={BBOX}&HEIGHT={HEIGHT}&WIDTH={WIDTH}&FORMAT={FORMAT}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"TRANSPARENT={string}",
                         @"BGCOLOR={string}",
                         @"EXCEPTIONS={string}",
                         @"TIME={string}",
                         @"ELEVATION={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://ukho.azure-api.net/api/webcharting/WMS_ENC/v130/v1/GetMap?VERSION={VERSION}&REQUEST={REQUEST}&LAYERS={LAYERS}&STYLES={STYLES}&CRS={CRS}&BBOX={BBOX}&HEIGHT={HEIGHT}&WIDTH={WIDTH}&FORMAT={FORMAT}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'TRANSPARENT' => '{string}',
    'BGCOLOR' => '{string}',
    'EXCEPTIONS' => '{string}',
    'TIME' => '{string}',
    'ELEVATION' => '{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
    'TRANSPARENT': '{string}',
    'BGCOLOR': '{string}',
    'EXCEPTIONS': '{string}',
    'TIME': '{string}',
    'ELEVATION': '{string}',
})

try:
    conn = httplib.HTTPSConnection('ukho.azure-api.net')
    conn.request("GET", "/api/webcharting/WMS_ENC/v130/v1/GetMap?VERSION={VERSION}&REQUEST={REQUEST}&LAYERS={LAYERS}&STYLES={STYLES}&CRS={CRS}&BBOX={BBOX}&HEIGHT={HEIGHT}&WIDTH={WIDTH}&FORMAT={FORMAT}&%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
    'TRANSPARENT': '{string}',
    'BGCOLOR': '{string}',
    'EXCEPTIONS': '{string}',
    'TIME': '{string}',
    'ELEVATION': '{string}',
})

try:
    conn = http.client.HTTPSConnection('ukho.azure-api.net')
    conn.request("GET", "/api/webcharting/WMS_ENC/v130/v1/GetMap?VERSION={VERSION}&REQUEST={REQUEST}&LAYERS={LAYERS}&STYLES={STYLES}&CRS={CRS}&BBOX={BBOX}&HEIGHT={HEIGHT}&WIDTH={WIDTH}&FORMAT={FORMAT}&%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://ukho.azure-api.net/api/webcharting/WMS_ENC/v130/v1/GetMap?VERSION={VERSION}&REQUEST={REQUEST}&LAYERS={LAYERS}&STYLES={STYLES}&CRS={CRS}&BBOX={BBOX}&HEIGHT={HEIGHT}&WIDTH={WIDTH}&FORMAT={FORMAT}')

query = URI.encode_www_form({
    # Request parameters
    'TRANSPARENT' => '{string}',
    'BGCOLOR' => '{string}',
    'EXCEPTIONS' => '{string}',
    'TIME' => '{string}',
    'ELEVATION' => '{string}'
})
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