Check Permissions - Rest

API change history

The Check Permissions Rest API powers our website search at www.cla.co.uk, allowing clients to ascertain the permissions for reuse of UK and foreign repertoire under the terms of a CLA licence and usage.

GetPermissionByManifestationId

Lookup permissions using the Manifestation ID from CLA's main operation system.

Try it

Request

Request URL

Request parameters

  • string
  • string
  • string
  • (optional)
    string
  • (optional)
    boolean

Request headers

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

Request body

Responses

200 OK

Success response

Representations

{
  "version": "string",
  "requestParameters": {
    "manifestationId": "string",
    "licenceType": "string",
    "messageId": "string",
    "senderName": "string",
    "usageTypes": "string",
    "htmlToggle": true
  },
  "metadata": {
    "manifestationId": "string",
    "title": "string",
    "identifier": "string",
    "identifierType": "string",
    "publicationType": "string",
    "publicationForm": "string",
    "publicationCountry": "string",
    "publisher": "string",
    "contributor": [
      "string"
    ]
  },
  "usagesSummary": [
    {
      "usageType": "string",
      "reportType": "string",
      "header": {
        "title": "string",
        "introduction": "string"
      },
      "usageTypeId": "string",
      "usageDetails": [
        {
          "title": "string",
          "reportType": "string"
        }
      ],
      "footer": {
        "restrictions": "string",
        "terms": "string"
      }
    }
  ]
}

400 Bad Request

This response occurs when any error has been detected.

Representations

{
  "Message": "string"
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.cla.co.uk/check-permissions/v1/GetPermissionByManifestationId/{manifestationId}/{licenceTypeId}?messageId={string}&usageTypes=1,2,8&htmlToggle=False"
-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["messageId"] = "{string}";
            queryString["usageTypes"] = "1,2,8";
            queryString["htmlToggle"] = "False";
            var uri = "https://api.cla.co.uk/check-permissions/v1/GetPermissionByManifestationId/{manifestationId}/{licenceTypeId}?" + 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://api.cla.co.uk/check-permissions/v1/GetPermissionByManifestationId/{manifestationId}/{licenceTypeId}");

            builder.setParameter("messageId", "{string}");
            builder.setParameter("usageTypes", "1,2,8");
            builder.setParameter("htmlToggle", "False");

            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
            "messageId": "{string}",
            "usageTypes": "1,2,8",
            "htmlToggle": "False",
        };
      
        $.ajax({
            url: "https://api.cla.co.uk/check-permissions/v1/GetPermissionByManifestationId/{manifestationId}/{licenceTypeId}?" + $.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://api.cla.co.uk/check-permissions/v1/GetPermissionByManifestationId/{manifestationId}/{licenceTypeId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"messageId={string}",
                         @"usageTypes=1,2,8",
                         @"htmlToggle=False",
                      ];
    
    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://api.cla.co.uk/check-permissions/v1/GetPermissionByManifestationId/{manifestationId}/{licenceTypeId}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'messageId' => '{string}',
    'usageTypes' => '1,2,8',
    'htmlToggle' => 'False',
);

$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
    'messageId': '{string}',
    'usageTypes': '1,2,8',
    'htmlToggle': 'False',
})

try:
    conn = httplib.HTTPSConnection('api.cla.co.uk')
    conn.request("GET", "/check-permissions/v1/GetPermissionByManifestationId/{manifestationId}/{licenceTypeId}?%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
    'messageId': '{string}',
    'usageTypes': '1,2,8',
    'htmlToggle': 'False',
})

try:
    conn = http.client.HTTPSConnection('api.cla.co.uk')
    conn.request("GET", "/check-permissions/v1/GetPermissionByManifestationId/{manifestationId}/{licenceTypeId}?%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://api.cla.co.uk/check-permissions/v1/GetPermissionByManifestationId/{manifestationId}/{licenceTypeId}')

query = URI.encode_www_form({
    # Request parameters
    'messageId' => '{string}',
    'usageTypes' => '1,2,8',
    'htmlToggle' => 'False'
})

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