DCS Sandbox API v2

API change history

This version includes the new SubmitRequest call and extra fields returned in the Get calls.

/SubmitRequest

The SubmitRequest call is used to create an academic request in the DCS

Try it

Request

Request URL

Request parameters

  • integer

    Institution id where the acaemic request will be submitted. User must be a lecturer in this institution or must be an API user subscribed to this institution.

  • string

    Lecturer Name

  • string

    Lecturer Email

  • boolean

    Book/Journal

  • (optional)
    string

    The faculty that the course is run in

  • (optional)
    string

    The department the course is run in

  • (optional)
    string

    Course code of the desired course

  • (optional)
    string

    Format - date-time (as date-time in RFC3339). The start date of the course

  • (optional)
    string

    The International Standard Number of the Manifestation, required if title is missing

  • (optional)
    string

    The book title or journal title, required if ISN is missing

  • (optional)
    string

    The chapter title or article title, required for a book if page range not specified

  • (optional)
    string

    Year of the manifest

  • (optional)
    string

    Issue of the article

  • (optional)
    string

    Volume of the article

  • (optional)
    string

    The page range of the extract wanted, not required for a book if extract title is defined

  • (optional)
    string

    Format - date-time (as date-time in RFC3339). The date the extract is required to be published by

  • (optional)
    string

    Some extra notes to help supply the correct extract

  • (optional)
    string

    Subtitle of the book

  • (optional)
    string

    Edition of the book

  • (optional)
    string

    Chapter number of the book

  • (optional)
    string

    Author of the article or the books chapter

  • (optional)
    string

    Publisher of the book/journal

  • (optional)
    integer

    Number of pages in the book

  • (optional)
    string

    Publication Place of the book/journal

  • (optional)
    string

    The book's contributor

  • (optional)
    string

    DOI of the article

Request headers

  • string

    Your base 64 encoded username and password

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

Request body

Responses

200 OK

successful operation

Representations

{
  "status": "string",
  "status-code": 0,
  "status-message": "string",
  "request-id": 0
}
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "status-code": {
      "type": "integer",
      "format": "int32"
    },
    "status-message": {
      "type": "string"
    },
    "request-id": {
      "type": "integer"
    }
  }
}

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 POST "https://api.cla.co.uk/dcs-sandbox/v2/SubmitRequest?hei={hei}&AcademicName={AcademicName}&EmailAddress={EmailAddress}&IsBook={IsBook}?Faculty={string}&Department={string}&CourseCode={string}&CourseStartDate={string}&ISN={string}&Title={string}&ExtractTitle={string}&Year={string}&Issue={string}&Volume={string}&PageRange={string}&DeliveryDate={string}&Notes={string}&Subtitle={string}&Edition={string}&ChapterNumber={string}&ExtractAuthor={string}&Publisher={string}&TotalNumberofPages={integer}&PublicationPlace={string}&Contributor={string}&DOI={string}"
-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}");

            // Request parameters
            queryString["Faculty"] = "{string}";
            queryString["Department"] = "{string}";
            queryString["CourseCode"] = "{string}";
            queryString["CourseStartDate"] = "{string}";
            queryString["ISN"] = "{string}";
            queryString["Title"] = "{string}";
            queryString["ExtractTitle"] = "{string}";
            queryString["Year"] = "{string}";
            queryString["Issue"] = "{string}";
            queryString["Volume"] = "{string}";
            queryString["PageRange"] = "{string}";
            queryString["DeliveryDate"] = "{string}";
            queryString["Notes"] = "{string}";
            queryString["Subtitle"] = "{string}";
            queryString["Edition"] = "{string}";
            queryString["ChapterNumber"] = "{string}";
            queryString["ExtractAuthor"] = "{string}";
            queryString["Publisher"] = "{string}";
            queryString["TotalNumberofPages"] = "{integer}";
            queryString["PublicationPlace"] = "{string}";
            queryString["Contributor"] = "{string}";
            queryString["DOI"] = "{string}";
            var uri = "https://api.cla.co.uk/dcs-sandbox/v2/SubmitRequest?hei={hei}&AcademicName={AcademicName}&EmailAddress={EmailAddress}&IsBook={IsBook}&" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // 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/v2/SubmitRequest?hei={hei}&AcademicName={AcademicName}&EmailAddress={EmailAddress}&IsBook={IsBook}");

            builder.setParameter("Faculty", "{string}");
            builder.setParameter("Department", "{string}");
            builder.setParameter("CourseCode", "{string}");
            builder.setParameter("CourseStartDate", "{string}");
            builder.setParameter("ISN", "{string}");
            builder.setParameter("Title", "{string}");
            builder.setParameter("ExtractTitle", "{string}");
            builder.setParameter("Year", "{string}");
            builder.setParameter("Issue", "{string}");
            builder.setParameter("Volume", "{string}");
            builder.setParameter("PageRange", "{string}");
            builder.setParameter("DeliveryDate", "{string}");
            builder.setParameter("Notes", "{string}");
            builder.setParameter("Subtitle", "{string}");
            builder.setParameter("Edition", "{string}");
            builder.setParameter("ChapterNumber", "{string}");
            builder.setParameter("ExtractAuthor", "{string}");
            builder.setParameter("Publisher", "{string}");
            builder.setParameter("TotalNumberofPages", "{integer}");
            builder.setParameter("PublicationPlace", "{string}");
            builder.setParameter("Contributor", "{string}");
            builder.setParameter("DOI", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(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
            "Faculty": "{string}",
            "Department": "{string}",
            "CourseCode": "{string}",
            "CourseStartDate": "{string}",
            "ISN": "{string}",
            "Title": "{string}",
            "ExtractTitle": "{string}",
            "Year": "{string}",
            "Issue": "{string}",
            "Volume": "{string}",
            "PageRange": "{string}",
            "DeliveryDate": "{string}",
            "Notes": "{string}",
            "Subtitle": "{string}",
            "Edition": "{string}",
            "ChapterNumber": "{string}",
            "ExtractAuthor": "{string}",
            "Publisher": "{string}",
            "TotalNumberofPages": "{integer}",
            "PublicationPlace": "{string}",
            "Contributor": "{string}",
            "DOI": "{string}",
        };
      
        $.ajax({
            url: "https://api.cla.co.uk/dcs-sandbox/v2/SubmitRequest?hei={hei}&AcademicName={AcademicName}&EmailAddress={EmailAddress}&IsBook={IsBook}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("authorization","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // 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/v2/SubmitRequest?hei={hei}&AcademicName={AcademicName}&EmailAddress={EmailAddress}&IsBook={IsBook}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"Faculty={string}",
                         @"Department={string}",
                         @"CourseCode={string}",
                         @"CourseStartDate={string}",
                         @"ISN={string}",
                         @"Title={string}",
                         @"ExtractTitle={string}",
                         @"Year={string}",
                         @"Issue={string}",
                         @"Volume={string}",
                         @"PageRange={string}",
                         @"DeliveryDate={string}",
                         @"Notes={string}",
                         @"Subtitle={string}",
                         @"Edition={string}",
                         @"ChapterNumber={string}",
                         @"ExtractAuthor={string}",
                         @"Publisher={string}",
                         @"TotalNumberofPages={integer}",
                         @"PublicationPlace={string}",
                         @"Contributor={string}",
                         @"DOI={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // 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/v2/SubmitRequest?hei={hei}&AcademicName={AcademicName}&EmailAddress={EmailAddress}&IsBook={IsBook}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'Faculty' => '{string}',
    'Department' => '{string}',
    'CourseCode' => '{string}',
    'CourseStartDate' => '{string}',
    'ISN' => '{string}',
    'Title' => '{string}',
    'ExtractTitle' => '{string}',
    'Year' => '{string}',
    'Issue' => '{string}',
    'Volume' => '{string}',
    'PageRange' => '{string}',
    'DeliveryDate' => '{string}',
    'Notes' => '{string}',
    'Subtitle' => '{string}',
    'Edition' => '{string}',
    'ChapterNumber' => '{string}',
    'ExtractAuthor' => '{string}',
    'Publisher' => '{string}',
    'TotalNumberofPages' => '{integer}',
    'PublicationPlace' => '{string}',
    'Contributor' => '{string}',
    'DOI' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// 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({
    # Request parameters
    'Faculty': '{string}',
    'Department': '{string}',
    'CourseCode': '{string}',
    'CourseStartDate': '{string}',
    'ISN': '{string}',
    'Title': '{string}',
    'ExtractTitle': '{string}',
    'Year': '{string}',
    'Issue': '{string}',
    'Volume': '{string}',
    'PageRange': '{string}',
    'DeliveryDate': '{string}',
    'Notes': '{string}',
    'Subtitle': '{string}',
    'Edition': '{string}',
    'ChapterNumber': '{string}',
    'ExtractAuthor': '{string}',
    'Publisher': '{string}',
    'TotalNumberofPages': '{integer}',
    'PublicationPlace': '{string}',
    'Contributor': '{string}',
    'DOI': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.cla.co.uk')
    conn.request("POST", "/dcs-sandbox/v2/SubmitRequest?hei={hei}&AcademicName={AcademicName}&EmailAddress={EmailAddress}&IsBook={IsBook}&%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({
    # Request parameters
    'Faculty': '{string}',
    'Department': '{string}',
    'CourseCode': '{string}',
    'CourseStartDate': '{string}',
    'ISN': '{string}',
    'Title': '{string}',
    'ExtractTitle': '{string}',
    'Year': '{string}',
    'Issue': '{string}',
    'Volume': '{string}',
    'PageRange': '{string}',
    'DeliveryDate': '{string}',
    'Notes': '{string}',
    'Subtitle': '{string}',
    'Edition': '{string}',
    'ChapterNumber': '{string}',
    'ExtractAuthor': '{string}',
    'Publisher': '{string}',
    'TotalNumberofPages': '{integer}',
    'PublicationPlace': '{string}',
    'Contributor': '{string}',
    'DOI': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.cla.co.uk')
    conn.request("POST", "/dcs-sandbox/v2/SubmitRequest?hei={hei}&AcademicName={AcademicName}&EmailAddress={EmailAddress}&IsBook={IsBook}&%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/v2/SubmitRequest?hei={hei}&AcademicName={AcademicName}&EmailAddress={EmailAddress}&IsBook={IsBook}')

query = URI.encode_www_form({
    # Request parameters
    'Faculty' => '{string}',
    'Department' => '{string}',
    'CourseCode' => '{string}',
    'CourseStartDate' => '{string}',
    'ISN' => '{string}',
    'Title' => '{string}',
    'ExtractTitle' => '{string}',
    'Year' => '{string}',
    'Issue' => '{string}',
    'Volume' => '{string}',
    'PageRange' => '{string}',
    'DeliveryDate' => '{string}',
    'Notes' => '{string}',
    'Subtitle' => '{string}',
    'Edition' => '{string}',
    'ChapterNumber' => '{string}',
    'ExtractAuthor' => '{string}',
    'Publisher' => '{string}',
    'TotalNumberofPages' => '{integer}',
    'PublicationPlace' => '{string}',
    'Contributor' => '{string}',
    'DOI' => '{string}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Post.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