TRN APIs

API change history

B2B REST APIs for the TRN Environment

getCatalogue

Gets the catalogue for the specified product for the current week

Try it

Request

Request URL

Request parameters

  • string

    This can either be an int or the catalogue name as specified in the table below. Strings are case insensitive but need to be fully url encoded.

    Int ID - String ID

    1 - AVCS Products

    2 - ARCS Products

    3 - Paper Charts

    5 - ADLL

    6 - ADRS

    7 - Total Tide

    8 - ALL

    9 - ALRS

    10 - Sailing Directions

    11 - Tide Tables

    14 - Misc Publications

    18 - e-NPs

    n/a - AVCS Online

Request headers

  • string

    Authorisation JWT acquired from /auth/

  • (optional)
    string

    Format - RCF1123. Allows a 304 Not Modified to be returned if content is unchanged.

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

Request body

Responses

200 OK

OK - Catalogue returned

Response headers

  • (optional)
    string

    GUID for the request for logging/tracing

  • (optional)
    string

    The last modified date for the requested catalogue

Representations

304 Not Modified

Not modified - Catalogue hasn't changed since the If-Modified-Since date

Response headers

  • (optional)
    string

    GUID for the request for logging/tracing

Representations

401 Unauthorized

Token Authentication Failed

Response headers

  • (optional)
    string

    GUID for the request for logging/tracing

Representations

403 Forbidden

Forbidden or Quota Exceeded.
This will either be because:
- you have no permission to use this API (in which case the body will be empty)
- the quota has been exceeded

Response headers

  • (optional)
    string

    GUID for the request for logging/tracing

Representations

<errorDescription>
  <correlationId>string</correlationId>
  <errors>
    <source>string</source>
    <description>string</description>
  </errors>
</errorDescription>
{
  "type": "object",
  "properties": {
    "correlationId": {
      "type": "string"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "source": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      }
    }
  }
}

404 Not Found

Catalogue ID not found

Response headers

  • (optional)
    string

    GUID for the request for logging/tracing

Representations

{
  "correlationId": "6c254109-8a0f-4446-8649-721775ba9de2",
  "errors": [
    {
      "source": "catalogueId",
      "description": "Catalogue ID not found"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "correlationId": {
      "type": "string"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "source": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      }
    }
  }
}
<errorDescription>
  <correlationId>string</correlationId>
  <errors>
    <source>string</source>
    <description>string</description>
  </errors>
</errorDescription>
{
  "type": "object",
  "properties": {
    "correlationId": {
      "type": "string"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "source": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      }
    }
  }
}

429 Too many requests

Too Many Requests

Representations

{
  "statusCode": 429,
  "message": "Rate limit is exceeded. Try again in 1 seconds."
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}
<ApiManagementError>
  <statusCode>string</statusCode>
  <message>string</message>
</ApiManagementError>
{
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

500 Internal Server Error

Internal Server Error.

Response headers

  • (optional)
    string

    GUID for the request for logging/tracing

Representations

<exceptionDescription>
  <correlationId>string</correlationId>
  <message>string</message>
</exceptionDescription>
{
  "type": "object",
  "properties": {
    "correlationId": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://admiralty.azure-api.net/trn/catalogues/{catalogueId}"
-H "token: "
-H "If-Modified-Since: "
-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("token", "");
            client.DefaultRequestHeaders.IfModifiedSince = DateTimeOffset.Parse("");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://admiralty.azure-api.net/trn/catalogues/{catalogueId}?" + 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://admiralty.azure-api.net/trn/catalogues/{catalogueId}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("token", "");
            request.setHeader("If-Modified-Since", "");
            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://admiralty.azure-api.net/trn/catalogues/{catalogueId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("token","");
                xhrObj.setRequestHeader("If-Modified-Since","");
                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://admiralty.azure-api.net/trn/catalogues/{catalogueId}";
    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:@"" forHTTPHeaderField:@"token"];
    [_request setValue:@"" forHTTPHeaderField:@"If-Modified-Since"];
    [_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://admiralty.azure-api.net/trn/catalogues/{catalogueId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'token' => '',
    'If-Modified-Since' => '',
    '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
    'token': '',
    'If-Modified-Since': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('admiralty.azure-api.net')
    conn.request("GET", "/trn/catalogues/{catalogueId}?%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
    'token': '',
    'If-Modified-Since': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('admiralty.azure-api.net')
    conn.request("GET", "/trn/catalogues/{catalogueId}?%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://admiralty.azure-api.net/trn/catalogues/{catalogueId}')


request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['token'] = ''
# Request headers
request['If-Modified-Since'] = ''
# 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