Web Lecture API and Panopto

API change history

List of APIs related to weblecture which contains sessions and Panopto APIs

Search module

  1. Search module with web lecture

Try it

Request

Request URL

Request parameters

  • (optional)
    string
  • (optional)
    integer

    Format - int32.

  • (optional)
    integer

    Format - int32.

  • (optional)
    string
  • (optional)
    string

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "name_CourseName_LecturerName": "string",
  "terms": [
    "string"
  ]
}
{
  "description": "HTTP Post Input class when searching module",
  "type": "object",
  "properties": {
    "name_CourseName_LecturerName": {
      "description": "Module Code, Module Title or Name of Lecturer",
      "type": "string"
    },
    "terms": {
      "description": "List of Term Codes",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
{
  "name_CourseName_LecturerName": "string",
  "terms": [
    "string"
  ]
}
{
  "description": "HTTP Post Input class when searching module",
  "type": "object",
  "properties": {
    "name_CourseName_LecturerName": {
      "description": "Module Code, Module Title or Name of Lecturer",
      "type": "string"
    },
    "terms": {
      "description": "List of Term Codes",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
{
  "name_CourseName_LecturerName": "string",
  "terms": [
    "string"
  ]
}
{
  "description": "HTTP Post Input class when searching module",
  "type": "object",
  "properties": {
    "name_CourseName_LecturerName": {
      "description": "Module Code, Module Title or Name of Lecturer",
      "type": "string"
    },
    "terms": {
      "description": "List of Term Codes",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
{
  "name_CourseName_LecturerName": "string",
  "terms": [
    "string"
  ]
}
{
  "description": "HTTP Post Input class when searching module",
  "type": "object",
  "properties": {
    "name_CourseName_LecturerName": {
      "description": "Module Code, Module Title or Name of Lecturer",
      "type": "string"
    },
    "terms": {
      "description": "List of Term Codes",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Responses

200 OK

Return list of module web lectures [API_WebLecture.API.WebLecture]

Representations

{
  "type": "array",
  "items": {
    "description": "Web lecture Model.",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "The Web Lecture ID.",
        "type": "string"
      },
      "name": {
        "description": "The Web Lecture Name.",
        "type": "string"
      },
      "startDate": {
        "format": "date-time",
        "description": "the date which this resource is open to students.",
        "type": "string"
      },
      "endDate": {
        "format": "date-time",
        "description": "the date which this resource is closed from students.",
        "type": "string"
      },
      "publish": {
        "description": "accessible to students or not acessible.",
        "type": "boolean"
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date this record is created.",
        "type": "string"
      },
      "lastUpdatedDate": {
        "format": "date-time",
        "description": "the date this record is edited last time",
        "type": "string"
      },
      "lastUpdatedBy": {
        "format": "uuid",
        "description": "the ID of the user who edited this record last time",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "the parent resource ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
        "type": "string"
      },
      "rootID": {
        "format": "uuid",
        "description": "the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "the ID of the user who created this record.",
        "type": "string"
      },
      "userID": {
        "description": "The NUSNETID of the user who created this web lecture.",
        "type": "string"
      },
      "userName": {
        "description": "The name of the user who created this web lecture.",
        "type": "string"
      },
      "email": {
        "description": "The email address of the user who created this web lecture.",
        "type": "string"
      },
      "description": {
        "description": "Web Lecture description",
        "type": "string"
      },
      "allowDownload": {
        "description": "Allow students to download web lectures.",
        "type": "boolean"
      },
      "type": {
        "description": "Type of Lecture: Archive or Live",
        "type": "string"
      },
      "venue": {
        "description": "Lecture Venue",
        "type": "string"
      },
      "isOpen": {
        "description": "Open Lecture to all NUS Students or Restricted to module students only",
        "type": "boolean"
      },
      "isAutoPublish": {
        "description": "Publish sessions immediately after recording or not (For Web Lecture Admin Info)",
        "type": "boolean"
      },
      "isScheduled": {
        "description": "Schedule recordings or not scheduled.",
        "type": "boolean"
      },
      "panoptoFolderURL": {
        "description": "Panopto URL to access the module folder to create/upload video.",
        "type": "string"
      },
      "panoptoStatisticsURL": {
        "description": "Panopto URL to access the module statistics to create/upload video.",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "name": "string",
    "startDate": "string",
    "endDate": "string",
    "publish": true,
    "createdDate": "string",
    "lastUpdatedDate": "string",
    "lastUpdatedBy": "string",
    "parentID": "string",
    "rootID": "string",
    "creatorID": "string",
    "userID": "string",
    "userName": "string",
    "email": "string",
    "description": "string",
    "allowDownload": true,
    "type": "string",
    "venue": "string",
    "isOpen": true,
    "isAutoPublish": true,
    "isScheduled": true,
    "panoptoFolderURL": "string",
    "panoptoStatisticsURL": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "Web lecture Model.",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "The Web Lecture ID.",
        "type": "string"
      },
      "name": {
        "description": "The Web Lecture Name.",
        "type": "string"
      },
      "startDate": {
        "format": "date-time",
        "description": "the date which this resource is open to students.",
        "type": "string"
      },
      "endDate": {
        "format": "date-time",
        "description": "the date which this resource is closed from students.",
        "type": "string"
      },
      "publish": {
        "description": "accessible to students or not acessible.",
        "type": "boolean"
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date this record is created.",
        "type": "string"
      },
      "lastUpdatedDate": {
        "format": "date-time",
        "description": "the date this record is edited last time",
        "type": "string"
      },
      "lastUpdatedBy": {
        "format": "uuid",
        "description": "the ID of the user who edited this record last time",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "the parent resource ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
        "type": "string"
      },
      "rootID": {
        "format": "uuid",
        "description": "the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "the ID of the user who created this record.",
        "type": "string"
      },
      "userID": {
        "description": "The NUSNETID of the user who created this web lecture.",
        "type": "string"
      },
      "userName": {
        "description": "The name of the user who created this web lecture.",
        "type": "string"
      },
      "email": {
        "description": "The email address of the user who created this web lecture.",
        "type": "string"
      },
      "description": {
        "description": "Web Lecture description",
        "type": "string"
      },
      "allowDownload": {
        "description": "Allow students to download web lectures.",
        "type": "boolean"
      },
      "type": {
        "description": "Type of Lecture: Archive or Live",
        "type": "string"
      },
      "venue": {
        "description": "Lecture Venue",
        "type": "string"
      },
      "isOpen": {
        "description": "Open Lecture to all NUS Students or Restricted to module students only",
        "type": "boolean"
      },
      "isAutoPublish": {
        "description": "Publish sessions immediately after recording or not (For Web Lecture Admin Info)",
        "type": "boolean"
      },
      "isScheduled": {
        "description": "Schedule recordings or not scheduled.",
        "type": "boolean"
      },
      "panoptoFolderURL": {
        "description": "Panopto URL to access the module folder to create/upload video.",
        "type": "string"
      },
      "panoptoStatisticsURL": {
        "description": "Panopto URL to access the module statistics to create/upload video.",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "name": "string",
    "startDate": "string",
    "endDate": "string",
    "publish": true,
    "createdDate": "string",
    "lastUpdatedDate": "string",
    "lastUpdatedBy": "string",
    "parentID": "string",
    "rootID": "string",
    "creatorID": "string",
    "userID": "string",
    "userName": "string",
    "email": "string",
    "description": "string",
    "allowDownload": true,
    "type": "string",
    "venue": "string",
    "isOpen": true,
    "isAutoPublish": true,
    "isScheduled": true,
    "panoptoFolderURL": "string",
    "panoptoStatisticsURL": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "Web lecture Model.",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "The Web Lecture ID.",
        "type": "string"
      },
      "name": {
        "description": "The Web Lecture Name.",
        "type": "string"
      },
      "startDate": {
        "format": "date-time",
        "description": "the date which this resource is open to students.",
        "type": "string"
      },
      "endDate": {
        "format": "date-time",
        "description": "the date which this resource is closed from students.",
        "type": "string"
      },
      "publish": {
        "description": "accessible to students or not acessible.",
        "type": "boolean"
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date this record is created.",
        "type": "string"
      },
      "lastUpdatedDate": {
        "format": "date-time",
        "description": "the date this record is edited last time",
        "type": "string"
      },
      "lastUpdatedBy": {
        "format": "uuid",
        "description": "the ID of the user who edited this record last time",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "the parent resource ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
        "type": "string"
      },
      "rootID": {
        "format": "uuid",
        "description": "the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "the ID of the user who created this record.",
        "type": "string"
      },
      "userID": {
        "description": "The NUSNETID of the user who created this web lecture.",
        "type": "string"
      },
      "userName": {
        "description": "The name of the user who created this web lecture.",
        "type": "string"
      },
      "email": {
        "description": "The email address of the user who created this web lecture.",
        "type": "string"
      },
      "description": {
        "description": "Web Lecture description",
        "type": "string"
      },
      "allowDownload": {
        "description": "Allow students to download web lectures.",
        "type": "boolean"
      },
      "type": {
        "description": "Type of Lecture: Archive or Live",
        "type": "string"
      },
      "venue": {
        "description": "Lecture Venue",
        "type": "string"
      },
      "isOpen": {
        "description": "Open Lecture to all NUS Students or Restricted to module students only",
        "type": "boolean"
      },
      "isAutoPublish": {
        "description": "Publish sessions immediately after recording or not (For Web Lecture Admin Info)",
        "type": "boolean"
      },
      "isScheduled": {
        "description": "Schedule recordings or not scheduled.",
        "type": "boolean"
      },
      "panoptoFolderURL": {
        "description": "Panopto URL to access the module folder to create/upload video.",
        "type": "string"
      },
      "panoptoStatisticsURL": {
        "description": "Panopto URL to access the module statistics to create/upload video.",
        "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"
}

500 Internal Server Error

Server Error

Representations

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

Code samples

@ECHO OFF

curl -v -X POST "https://luminus.azure-api.net/weblecture/admin/search?sortby={string}&offset={integer}&limit={integer}&where={string}&populate={string}"
-H "Content-Type: application/json-patch+json"
-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["sortby"] = "{string}";
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["where"] = "{string}";
            queryString["populate"] = "{string}";
            var uri = "https://luminus.azure-api.net/weblecture/admin/search?" + 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://luminus.azure-api.net/weblecture/admin/search");

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

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json-patch+json");
            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
            "sortby": "{string}",
            "offset": "{integer}",
            "limit": "{integer}",
            "where": "{string}",
            "populate": "{string}",
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/weblecture/admin/search?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                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://luminus.azure-api.net/weblecture/admin/search";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"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:@"POST"];
    // Request headers
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_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/weblecture/admin/search');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}',
    'populate' => '{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
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
    'populate': '{string}',
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("POST", "/weblecture/admin/search?%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
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
    'populate': '{string}',
})

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

query = URI.encode_www_form({
    # Request parameters
    '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::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# 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