edX Contents API

API change history

List of APIs related to external content (edX)

Sync course runs

  1. Sync course runs information.

  2. Only LumiNUS admin can call this API.

Try it

Request

Request URL

Request headers

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

Request body

Responses

200 OK

Returns internal course catalog information

Representations

{
  "description": "",
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "",
      "type": "string"
    },
    "courserunKey": {
      "description": "An identifier for the course run",
      "type": "string"
    },
    "uuid": {
      "format": "uuid",
      "description": "Course unique identifier",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "description": "The start time of the course run.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "The end date of the course run.",
      "type": "string"
    },
    "enrollmentStart": {
      "format": "date-time",
      "description": "The first date and time when this course run is open for learners to enroll. Learners cannot enroll before this date and time.",
      "type": "string"
    },
    "enrollmentEnd": {
      "format": "date-time",
      "description": "The last date and time when this course run is open for learners to enroll. Learners cannot enroll after this date and time.",
      "type": "string"
    },
    "minEffort": {
      "format": "int32",
      "description": "The minimum number of estimated hours of effort per week.",
      "type": "integer"
    },
    "maxEffort": {
      "format": "int32",
      "description": "The maximum number of estimated hours of effort per week.",
      "type": "integer"
    },
    "pacingType": {
      "description": "The pacing of the course. May be self-paced or instructor-paced.",
      "type": "string"
    },
    "weeksToComplete": {
      "format": "int32",
      "description": "The number of weeks required to complete the content item.",
      "type": "integer"
    },
    "availability": {
      "description": "One of Current, Upcoming",
      "type": "string"
    },
    "marketingUrl": {
      "description": "The URL for the course About page.",
      "type": "string"
    },
    "enrollmentUrl": {
      "description": "The URL for the enrollment page.",
      "type": "string"
    },
    "price": {
      "description": "Price for verified track.",
      "type": "string"
    },
    "type": {
      "description": "Type of track. Audit, verified, professional.",
      "type": "string"
    },
    "modularCredit": {
      "format": "int32",
      "description": "Modular Credit (MC) Equivalents",
      "type": "integer"
    }
  }
}
{
  "id": "string",
  "courserunKey": "string",
  "uuid": "string",
  "startDate": "string",
  "endDate": "string",
  "enrollmentStart": "string",
  "enrollmentEnd": "string",
  "minEffort": 0,
  "maxEffort": 0,
  "pacingType": "string",
  "weeksToComplete": 0,
  "availability": "string",
  "marketingUrl": "string",
  "enrollmentUrl": "string",
  "price": "string",
  "type": "string",
  "modularCredit": 0
}
{
  "description": "",
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "",
      "type": "string"
    },
    "courserunKey": {
      "description": "An identifier for the course run",
      "type": "string"
    },
    "uuid": {
      "format": "uuid",
      "description": "Course unique identifier",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "description": "The start time of the course run.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "The end date of the course run.",
      "type": "string"
    },
    "enrollmentStart": {
      "format": "date-time",
      "description": "The first date and time when this course run is open for learners to enroll. Learners cannot enroll before this date and time.",
      "type": "string"
    },
    "enrollmentEnd": {
      "format": "date-time",
      "description": "The last date and time when this course run is open for learners to enroll. Learners cannot enroll after this date and time.",
      "type": "string"
    },
    "minEffort": {
      "format": "int32",
      "description": "The minimum number of estimated hours of effort per week.",
      "type": "integer"
    },
    "maxEffort": {
      "format": "int32",
      "description": "The maximum number of estimated hours of effort per week.",
      "type": "integer"
    },
    "pacingType": {
      "description": "The pacing of the course. May be self-paced or instructor-paced.",
      "type": "string"
    },
    "weeksToComplete": {
      "format": "int32",
      "description": "The number of weeks required to complete the content item.",
      "type": "integer"
    },
    "availability": {
      "description": "One of Current, Upcoming",
      "type": "string"
    },
    "marketingUrl": {
      "description": "The URL for the course About page.",
      "type": "string"
    },
    "enrollmentUrl": {
      "description": "The URL for the enrollment page.",
      "type": "string"
    },
    "price": {
      "description": "Price for verified track.",
      "type": "string"
    },
    "type": {
      "description": "Type of track. Audit, verified, professional.",
      "type": "string"
    },
    "modularCredit": {
      "format": "int32",
      "description": "Modular Credit (MC) Equivalents",
      "type": "integer"
    }
  }
}
{
  "id": "string",
  "courserunKey": "string",
  "uuid": "string",
  "startDate": "string",
  "endDate": "string",
  "enrollmentStart": "string",
  "enrollmentEnd": "string",
  "minEffort": 0,
  "maxEffort": 0,
  "pacingType": "string",
  "weeksToComplete": 0,
  "availability": "string",
  "marketingUrl": "string",
  "enrollmentUrl": "string",
  "price": "string",
  "type": "string",
  "modularCredit": 0
}
{
  "description": "",
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "",
      "type": "string"
    },
    "courserunKey": {
      "description": "An identifier for the course run",
      "type": "string"
    },
    "uuid": {
      "format": "uuid",
      "description": "Course unique identifier",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "description": "The start time of the course run.",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "The end date of the course run.",
      "type": "string"
    },
    "enrollmentStart": {
      "format": "date-time",
      "description": "The first date and time when this course run is open for learners to enroll. Learners cannot enroll before this date and time.",
      "type": "string"
    },
    "enrollmentEnd": {
      "format": "date-time",
      "description": "The last date and time when this course run is open for learners to enroll. Learners cannot enroll after this date and time.",
      "type": "string"
    },
    "minEffort": {
      "format": "int32",
      "description": "The minimum number of estimated hours of effort per week.",
      "type": "integer"
    },
    "maxEffort": {
      "format": "int32",
      "description": "The maximum number of estimated hours of effort per week.",
      "type": "integer"
    },
    "pacingType": {
      "description": "The pacing of the course. May be self-paced or instructor-paced.",
      "type": "string"
    },
    "weeksToComplete": {
      "format": "int32",
      "description": "The number of weeks required to complete the content item.",
      "type": "integer"
    },
    "availability": {
      "description": "One of Current, Upcoming",
      "type": "string"
    },
    "marketingUrl": {
      "description": "The URL for the course About page.",
      "type": "string"
    },
    "enrollmentUrl": {
      "description": "The URL for the enrollment page.",
      "type": "string"
    },
    "price": {
      "description": "Price for verified track.",
      "type": "string"
    },
    "type": {
      "description": "Type of track. Audit, verified, professional.",
      "type": "string"
    },
    "modularCredit": {
      "format": "int32",
      "description": "Modular Credit (MC) Equivalents",
      "type": "integer"
    }
  }
}

400 Bad Request

Bad Request

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

403 Forbidden

Login user not authorized to perform this action

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

404 Not Found

the catalog is not found

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}
string
{
  "type": "string"
}
string
{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X GET "https://luminus.azure-api.net/ExternalLinks/edXCourseruns"
-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}");

            var uri = "https://luminus.azure-api.net/ExternalLinks/edXCourseruns?" + 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://luminus.azure-api.net/ExternalLinks/edXCourseruns");


            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
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/ExternalLinks/edXCourseruns?" + $.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://luminus.azure-api.net/ExternalLinks/edXCourseruns";
    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:@"{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://luminus.azure-api.net/ExternalLinks/edXCourseruns');
$url = $request->getUrl();

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

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/ExternalLinks/edXCourseruns?%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({
})

try:
    conn = http.client.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/ExternalLinks/edXCourseruns?%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://luminus.azure-api.net/ExternalLinks/edXCourseruns')


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