SCORM API

API change history

List of APIs related to SCORM

Get courses by student

  1. Get the list of SCORM courses (for one module) that are accessible to the login student.
  2. Four key elements of the registration state, i.e. complete, success, score and totaltime, will be returned for each SCORM course.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Format - uuid. Resource ID, this parameter is required.

  • (optional)
    string
  • (optional)
    integer

    Format - int32.

  • (optional)
    integer

    Format - int32.

  • (optional)
    string
  • (optional)
    string

    Populate additional information. Accepted entities: creator

Request headers

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

Request body

Responses

200 OK

Returns list of [API_SCORM.API.StudentCourse]

Representations

{
  "type": "array",
  "items": {
    "description": "Student Course Object",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "Course ID",
        "type": "string"
      },
      "title": {
        "description": "Course title",
        "type": "string"
      },
      "description": {
        "description": "Course description",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "Parent ID",
        "type": "string"
      },
      "resourceID": {
        "format": "uuid",
        "description": "Resource ID",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date the course is created",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "The Guid of the user who created the course",
        "type": "string"
      },
      "creatorName": {
        "description": "The name of the user who created the course",
        "type": "string"
      },
      "creatorUserID": {
        "description": "The user ID of the user who created the course",
        "type": "string"
      },
      "creatorEmail": {
        "description": "The email address of the user who created the course",
        "type": "string"
      },
      "firstAccessDate": {
        "format": "date-time",
        "description": "The date the course is first accessed",
        "type": "string"
      },
      "lastAccessDate": {
        "format": "date-time",
        "description": "The date the course is last accessed",
        "type": "string"
      },
      "complete": {
        "description": "Completion Status",
        "type": "string"
      },
      "success": {
        "description": "Success",
        "type": "string"
      },
      "totalTime": {
        "format": "int32",
        "description": "Total Time",
        "type": "integer"
      },
      "score": {
        "description": "Score",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "title": "string",
    "description": "string",
    "parentID": "string",
    "resourceID": "string",
    "createdDate": "string",
    "creatorID": "string",
    "creatorName": "string",
    "creatorUserID": "string",
    "creatorEmail": "string",
    "firstAccessDate": "string",
    "lastAccessDate": "string",
    "complete": "string",
    "success": "string",
    "totalTime": 0,
    "score": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "Student Course Object",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "Course ID",
        "type": "string"
      },
      "title": {
        "description": "Course title",
        "type": "string"
      },
      "description": {
        "description": "Course description",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "Parent ID",
        "type": "string"
      },
      "resourceID": {
        "format": "uuid",
        "description": "Resource ID",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date the course is created",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "The Guid of the user who created the course",
        "type": "string"
      },
      "creatorName": {
        "description": "The name of the user who created the course",
        "type": "string"
      },
      "creatorUserID": {
        "description": "The user ID of the user who created the course",
        "type": "string"
      },
      "creatorEmail": {
        "description": "The email address of the user who created the course",
        "type": "string"
      },
      "firstAccessDate": {
        "format": "date-time",
        "description": "The date the course is first accessed",
        "type": "string"
      },
      "lastAccessDate": {
        "format": "date-time",
        "description": "The date the course is last accessed",
        "type": "string"
      },
      "complete": {
        "description": "Completion Status",
        "type": "string"
      },
      "success": {
        "description": "Success",
        "type": "string"
      },
      "totalTime": {
        "format": "int32",
        "description": "Total Time",
        "type": "integer"
      },
      "score": {
        "description": "Score",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "title": "string",
    "description": "string",
    "parentID": "string",
    "resourceID": "string",
    "createdDate": "string",
    "creatorID": "string",
    "creatorName": "string",
    "creatorUserID": "string",
    "creatorEmail": "string",
    "firstAccessDate": "string",
    "lastAccessDate": "string",
    "complete": "string",
    "success": "string",
    "totalTime": 0,
    "score": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "Student Course Object",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "Course ID",
        "type": "string"
      },
      "title": {
        "description": "Course title",
        "type": "string"
      },
      "description": {
        "description": "Course description",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "Parent ID",
        "type": "string"
      },
      "resourceID": {
        "format": "uuid",
        "description": "Resource ID",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date the course is created",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "The Guid of the user who created the course",
        "type": "string"
      },
      "creatorName": {
        "description": "The name of the user who created the course",
        "type": "string"
      },
      "creatorUserID": {
        "description": "The user ID of the user who created the course",
        "type": "string"
      },
      "creatorEmail": {
        "description": "The email address of the user who created the course",
        "type": "string"
      },
      "firstAccessDate": {
        "format": "date-time",
        "description": "The date the course is first accessed",
        "type": "string"
      },
      "lastAccessDate": {
        "format": "date-time",
        "description": "The date the course is last accessed",
        "type": "string"
      },
      "complete": {
        "description": "Completion Status",
        "type": "string"
      },
      "success": {
        "description": "Success",
        "type": "string"
      },
      "totalTime": {
        "format": "int32",
        "description": "Total Time",
        "type": "integer"
      },
      "score": {
        "description": "Score",
        "type": "string"
      }
    }
  }
}

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

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/scorm/Course/Student?resourceID={string}&sortby={string}&offset={integer}&limit={integer}&where={string}&populate={string}"
-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["resourceID"] = "{string}";
            queryString["sortby"] = "{string}";
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["where"] = "{string}";
            queryString["populate"] = "{string}";
            var uri = "https://luminus.azure-api.net/scorm/Course/Student?" + 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/scorm/Course/Student");

            builder.setParameter("resourceID", "{string}");
            builder.setParameter("sortby", "{string}");
            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("where", "{string}");
            builder.setParameter("populate", "{string}");

            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
            "resourceID": "{string}",
            "sortby": "{string}",
            "offset": "{integer}",
            "limit": "{integer}",
            "where": "{string}",
            "populate": "{string}",
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/scorm/Course/Student?" + $.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/scorm/Course/Student";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"resourceID={string}",
                         @"sortby={string}",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"where={string}",
                         @"populate={string}",
                      ];
    
    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/scorm/Course/Student');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'resourceID' => '{string}',
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}',
    'populate' => '{string}',
);

$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
    'resourceID': '{string}',
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
    'populate': '{string}',
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("GET", "/scorm/Course/Student?%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
    'resourceID': '{string}',
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
    'populate': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'resourceID' => '{string}',
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}',
    'populate' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
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