DCS Sandbox API v3

API change history

The Digital Content Store (DCS) Course Content URL API allows third party reading lists to access course data. V3 includes new methods that allow Courses to be added and amended and a change now allows specific requests to be returned by the GetCourseContent method.

/AmendCourse

The AmendCourse call is used to amend an existing Course in DCS

Try it

Request

Request URL

Request parameters

  • integer

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

  • string

    Course Code

  • (optional)
    string

    New Course Code

  • (optional)
    string

    Course Name

  • (optional)
    integer

    Number of Weeks defaults to 52 if left blank

  • (optional)
    integer

    The number of students in the course. defaults to 0 if left blank

  • (optional)
    string

    The department the course is run in

  • (optional)
    string

    The Subject of the course

  • (optional)
    string

    The Lead Lecturer, required if LeadLecturerEmail is filled in

  • (optional)
    string

    The Lead Lecturer Email, required if LeadLecturer is filled in

  • (optional)
    string

    Course Status:

Request headers

  • string

    Basic authentication. 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 PUT "https://api.cla.co.uk/dcs-sandbox/v3/AmendCourse?hei={hei}&CourseCode={CourseCode}?NewCourseCode={string}&CourseName={string}&NumberOfWeeks={integer}&NumberOfStudents={integer}&Department={string}&Subject={string}&LeadLecturer={string}&LeadLecturerEmail={string}&Status={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["NewCourseCode"] = "{string}";
            queryString["CourseName"] = "{string}";
            queryString["NumberOfWeeks"] = "{integer}";
            queryString["NumberOfStudents"] = "{integer}";
            queryString["Department"] = "{string}";
            queryString["Subject"] = "{string}";
            queryString["LeadLecturer"] = "{string}";
            queryString["LeadLecturerEmail"] = "{string}";
            queryString["Status"] = "{string}";
            var uri = "https://api.cla.co.uk/dcs-sandbox/v3/AmendCourse?hei={hei}&CourseCode={CourseCode}&" + 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.PutAsync(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/v3/AmendCourse?hei={hei}&CourseCode={CourseCode}");

            builder.setParameter("NewCourseCode", "{string}");
            builder.setParameter("CourseName", "{string}");
            builder.setParameter("NumberOfWeeks", "{integer}");
            builder.setParameter("NumberOfStudents", "{integer}");
            builder.setParameter("Department", "{string}");
            builder.setParameter("Subject", "{string}");
            builder.setParameter("LeadLecturer", "{string}");
            builder.setParameter("LeadLecturerEmail", "{string}");
            builder.setParameter("Status", "{string}");

            URI uri = builder.build();
            HttpPut request = new HttpPut(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
            "NewCourseCode": "{string}",
            "CourseName": "{string}",
            "NumberOfWeeks": "{integer}",
            "NumberOfStudents": "{integer}",
            "Department": "{string}",
            "Subject": "{string}",
            "LeadLecturer": "{string}",
            "LeadLecturerEmail": "{string}",
            "Status": "{string}",
        };
      
        $.ajax({
            url: "https://api.cla.co.uk/dcs-sandbox/v3/AmendCourse?hei={hei}&CourseCode={CourseCode}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Authorization","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // 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/v3/AmendCourse?hei={hei}&CourseCode={CourseCode}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"NewCourseCode={string}",
                         @"CourseName={string}",
                         @"NumberOfWeeks={integer}",
                         @"NumberOfStudents={integer}",
                         @"Department={string}",
                         @"Subject={string}",
                         @"LeadLecturer={string}",
                         @"LeadLecturerEmail={string}",
                         @"Status={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // 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/v3/AmendCourse?hei={hei}&CourseCode={CourseCode}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'NewCourseCode' => '{string}',
    'CourseName' => '{string}',
    'NumberOfWeeks' => '{integer}',
    'NumberOfStudents' => '{integer}',
    'Department' => '{string}',
    'Subject' => '{string}',
    'LeadLecturer' => '{string}',
    'LeadLecturerEmail' => '{string}',
    'Status' => '{string}',
);

$url->setQueryVariables($parameters);

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

// 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
    'NewCourseCode': '{string}',
    'CourseName': '{string}',
    'NumberOfWeeks': '{integer}',
    'NumberOfStudents': '{integer}',
    'Department': '{string}',
    'Subject': '{string}',
    'LeadLecturer': '{string}',
    'LeadLecturerEmail': '{string}',
    'Status': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.cla.co.uk')
    conn.request("PUT", "/dcs-sandbox/v3/AmendCourse?hei={hei}&CourseCode={CourseCode}&%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
    'NewCourseCode': '{string}',
    'CourseName': '{string}',
    'NumberOfWeeks': '{integer}',
    'NumberOfStudents': '{integer}',
    'Department': '{string}',
    'Subject': '{string}',
    'LeadLecturer': '{string}',
    'LeadLecturerEmail': '{string}',
    'Status': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'NewCourseCode' => '{string}',
    'CourseName' => '{string}',
    'NumberOfWeeks' => '{integer}',
    'NumberOfStudents' => '{integer}',
    'Department' => '{string}',
    'Subject' => '{string}',
    'LeadLecturer' => '{string}',
    'LeadLecturerEmail' => '{string}',
    'Status' => '{string}'
})

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

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