DCS Sandbox API

API change history

The Digital Content Store (DCS) Course Content URL API allows third party reading lists to access course data. This is the version configured to use the DCS Demo / Sandbox environment. You will need to use the DCS authorization headers and the Ocp-Apim-Subscription-Key to gain access.

/GetCourseContent?hei={hei}&code={code} - GET

The GetCourseContent call uses the instituion id and course code to return all of the content used in the given course. Note that course codes may change over time at the librarians' discretion.

Try it

Request

Request URL

Request parameters

  • integer

    The ID of the HEI being queried

  • integer

    The course code of the course being queried

Request headers

  • string

    basic authentication

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

Request body

Responses

200 OK

An array of Course content

Representations

{
  "status": "string",
  "status-code": 0,
  "status-message": "string",
  "total-results": 0,
  "HEI": "string",
  "course-ID": 0,
  "content-items": {
    "content-GUID": "string",
    "content-status": "string",
    "last-modified": "string",
    "content-URL": "string",
    "bibliographic-details": {
      "type": "string",
      "identifier": "string",
      "DOI": "string",
      "title": "string",
      "extract-title": "string",
      "publication-form": "string",
      "year": "string",
      "volume": "string",
      "issue": "string",
      "page-range": "string",
      "author": "string",
      "colour-scale": "string",
      "publisher": "string",
      "extract-author": "string",
      "chapter-number": "string",
      "edition": "string",
      "book-pages": 0,
      "publication-place": "string",
      "description": "string",
      "OCR": true,
      "file-size": 0.0
    }
  }
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The status of the API response"
    },
    "status-code": {
      "type": "integer",
      "format": "int32",
      "description": "Status code of the API response"
    },
    "status-message": {
      "type": "string",
      "description": "Message related to the API status code"
    },
    "total-results": {
      "type": "integer",
      "format": "int32",
      "description": "Number of Institutions returned"
    },
    "HEI": {
      "type": "string",
      "description": "Name of the HEI"
    },
    "course-ID": {
      "type": "integer",
      "format": "int32",
      "description": "ID of the course the data comes from."
    },
    "content-items": {
      "type": "object",
      "properties": {
        "content-GUID": {
          "type": "string",
          "format": "guid",
          "description": "Academic year the course is currently in."
        },
        "content-status": {
          "description": "Content’s status (Pending, Active, Archived, Deleted)",
          "type": "string"
        },
        "last-modified": {
          "description": "Date the content item was last modified",
          "type": "string",
          "format": "date-time"
        },
        "content-URL": {
          "type": "string",
          "description": "Content item’s current DCS link"
        },
        "bibliographic-details": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "description": "\"Book\" or \"Journal\""
            },
            "identifier": {
              "type": "string",
              "description": "Content Item’s ISN"
            },
            "DOI": {
              "type": "string",
              "description": "Journal’s DOI if the content is a journal, null otherwise"
            },
            "title": {
              "type": "string",
              "description": "Content’s title"
            },
            "extract-title": {
              "type": "string",
              "description": "Content’s article or chapter title"
            },
            "publication-form": {
              "type": "string",
              "description": "\"Print\" or \"Digital\""
            },
            "year": {
              "type": "string",
              "description": "The year the content was published"
            },
            "volume": {
              "type": "string",
              "description": "The content’s volume number"
            },
            "issue": {
              "type": "string",
              "description": "The content’s issue number"
            },
            "page-range": {
              "type": "string",
              "description": "The page range extracted from the content"
            },
            "author": {
              "type": "string",
              "description": "The author of the content"
            },
            "colour-scale": {
              "type": "string",
              "description": "The content’s color scale (Grey, Colour, Black and White)"
            },
            "publisher": {
              "type": "string",
              "description": "The content’s publisher"
            },
            "extract-author": {
              "type": "string",
              "description": "The content’s extract author"
            },
            "chapter-number": {
              "type": "string",
              "description": "The content’s chapter number"
            },
            "edition": {
              "type": "string",
              "description": "The content’s edition"
            },
            "book-pages": {
              "type": "integer",
              "format": "int32",
              "description": "The content’s book page count"
            },
            "publication-place": {
              "type": "string",
              "description": "The content’s publication place"
            },
            "description": {
              "type": "string",
              "description": "The content’s description"
            },
            "OCR": {
              "type": "boolean",
              "description": "Does the PDF have optical character recognition"
            },
            "file-size": {
              "type": "number",
              "format": "double",
              "description": "The content’s file size in kilobytes"
            }
          }
        }
      }
    }
  }
}

500 Internal Server Error

Unexpected error

Representations

{
  "status": "string",
  "status-code": 0,
  "status-message": "string"
}
{
  "type": "object",
  "properties": {
    "status": {
      "description": "The status of the API response",
      "type": "string"
    },
    "status-code": {
      "type": "integer",
      "format": "int32",
      "description": "The status code of the API response"
    },
    "status-message": {
      "description": "Message related to the API status code",
      "type": "string"
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.cla.co.uk/dcs-sandbox/GetCourseContent?hei={hei}&code={code}"
-H "authorization: "
-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("authorization", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://api.cla.co.uk/dcs-sandbox/GetCourseContent?hei={hei}&code={code}&" + 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/dcs-sandbox/GetCourseContent?hei={hei}&code={code}");


            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("authorization", "");
            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://api.cla.co.uk/dcs-sandbox/GetCourseContent?hei={hei}&code={code}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("authorization","");
                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/dcs-sandbox/GetCourseContent?hei={hei}&code={code}";
    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:@"authorization"];
    [_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/dcs-sandbox/GetCourseContent?hei={hei}&code={code}');
$url = $request->getUrl();

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

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.cla.co.uk')
    conn.request("GET", "/dcs-sandbox/GetCourseContent?hei={hei}&code={code}&%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
    'authorization': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.cla.co.uk')
    conn.request("GET", "/dcs-sandbox/GetCourseContent?hei={hei}&code={code}&%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/dcs-sandbox/GetCourseContent?hei={hei}&code={code}')

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