Learning Flow API
API change historyList of APIs related to Learning Flow
Update topic weeks by NUS calendar
Update topic weeks by NUS calendar Take note that this function will change existing topic weeks to designated NUS calendar format plan topic weeks. If new topic weeks is less than old extra topics weeks, the old topic weeks will remain as orignal. For semester 2 in term descrption, week 0 will be neglected to change and remained as origin since there is no week 0 in semester 2.
Try itRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
Lesson plan input
{
"resourceID": "string",
"displayByWeekPeriod": true,
"timeTableIncluded": true,
"publish": true
}
{
"description": "Input for create by range",
"required": [
"displayByWeekPeriod",
"resourceID"
],
"type": "object",
"properties": {
"resourceID": {
"format": "uuid",
"description": "ID of the resource which this content belongs to",
"type": "string"
},
"displayByWeekPeriod": {
"description": "Set true to set the display based on NUS calendar week, otherwise false to show all",
"type": "boolean"
},
"timeTableIncluded": {
"description": "Set true to set the display the time table events",
"type": "boolean"
},
"publish": {
"description": "Set true to publish in all weeks in NUS Calendar, otherwise false",
"type": "boolean"
}
}
}
{
"resourceID": "string",
"displayByWeekPeriod": true,
"timeTableIncluded": true,
"publish": true
}
{
"description": "Input for create by range",
"required": [
"displayByWeekPeriod",
"resourceID"
],
"type": "object",
"properties": {
"resourceID": {
"format": "uuid",
"description": "ID of the resource which this content belongs to",
"type": "string"
},
"displayByWeekPeriod": {
"description": "Set true to set the display based on NUS calendar week, otherwise false to show all",
"type": "boolean"
},
"timeTableIncluded": {
"description": "Set true to set the display the time table events",
"type": "boolean"
},
"publish": {
"description": "Set true to publish in all weeks in NUS Calendar, otherwise false",
"type": "boolean"
}
}
}
{
"resourceID": "string",
"displayByWeekPeriod": true,
"timeTableIncluded": true,
"publish": true
}
{
"description": "Input for create by range",
"required": [
"displayByWeekPeriod",
"resourceID"
],
"type": "object",
"properties": {
"resourceID": {
"format": "uuid",
"description": "ID of the resource which this content belongs to",
"type": "string"
},
"displayByWeekPeriod": {
"description": "Set true to set the display based on NUS calendar week, otherwise false to show all",
"type": "boolean"
},
"timeTableIncluded": {
"description": "Set true to set the display the time table events",
"type": "boolean"
},
"publish": {
"description": "Set true to publish in all weeks in NUS Calendar, otherwise false",
"type": "boolean"
}
}
}
{
"resourceID": "string",
"displayByWeekPeriod": true,
"timeTableIncluded": true,
"publish": true
}
{
"description": "Input for create by range",
"required": [
"displayByWeekPeriod",
"resourceID"
],
"type": "object",
"properties": {
"resourceID": {
"format": "uuid",
"description": "ID of the resource which this content belongs to",
"type": "string"
},
"displayByWeekPeriod": {
"description": "Set true to set the display based on NUS calendar week, otherwise false to show all",
"type": "boolean"
},
"timeTableIncluded": {
"description": "Set true to set the display the time table events",
"type": "boolean"
},
"publish": {
"description": "Set true to publish in all weeks in NUS Calendar, otherwise false",
"type": "boolean"
}
}
}
Responses
201 Created
Returns updated lesson records
Representations
{
"description": "Represent lesson object",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Identifier",
"type": "string"
},
"name": {
"description": "Title or name",
"type": "string"
},
"description": {
"description": "Title or name",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "Resource ID",
"type": "string"
},
"parentID": {
"format": "uuid",
"description": "Parent ID",
"type": "string"
},
"rootID": {
"format": "uuid",
"description": "First or root lesson ID",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "Created date",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "ID of the user who created this record",
"type": "string"
},
"photoUrl": {
"description": "Creator photo URL",
"type": "string"
},
"userName": {
"description": "Name of the user who posted the category",
"type": "string"
},
"userID": {
"description": "The NUSNETID of the user who created this category",
"type": "string"
},
"email": {
"description": "Email address of the user who posted the category",
"type": "string"
},
"displayStartDate": {
"format": "date-time",
"description": "Starting date to display",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "Start or opening date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "End or expiry date",
"type": "string"
},
"navigationLabel": {
"description": "Navigation label",
"type": "string"
},
"isBookmark": {
"description": "Bookmark flag",
"type": "boolean"
},
"publish": {
"description": "Publish flag",
"type": "boolean"
}
}
}
{
"id": "string",
"name": "string",
"description": "string",
"resourceID": "string",
"parentID": "string",
"rootID": "string",
"createdDate": "string",
"creatorID": "string",
"photoUrl": "string",
"userName": "string",
"userID": "string",
"email": "string",
"displayStartDate": "string",
"startDate": "string",
"endDate": "string",
"navigationLabel": "string",
"isBookmark": true,
"publish": true
}
{
"description": "Represent lesson object",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Identifier",
"type": "string"
},
"name": {
"description": "Title or name",
"type": "string"
},
"description": {
"description": "Title or name",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "Resource ID",
"type": "string"
},
"parentID": {
"format": "uuid",
"description": "Parent ID",
"type": "string"
},
"rootID": {
"format": "uuid",
"description": "First or root lesson ID",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "Created date",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "ID of the user who created this record",
"type": "string"
},
"photoUrl": {
"description": "Creator photo URL",
"type": "string"
},
"userName": {
"description": "Name of the user who posted the category",
"type": "string"
},
"userID": {
"description": "The NUSNETID of the user who created this category",
"type": "string"
},
"email": {
"description": "Email address of the user who posted the category",
"type": "string"
},
"displayStartDate": {
"format": "date-time",
"description": "Starting date to display",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "Start or opening date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "End or expiry date",
"type": "string"
},
"navigationLabel": {
"description": "Navigation label",
"type": "string"
},
"isBookmark": {
"description": "Bookmark flag",
"type": "boolean"
},
"publish": {
"description": "Publish flag",
"type": "boolean"
}
}
}
{
"id": "string",
"name": "string",
"description": "string",
"resourceID": "string",
"parentID": "string",
"rootID": "string",
"createdDate": "string",
"creatorID": "string",
"photoUrl": "string",
"userName": "string",
"userID": "string",
"email": "string",
"displayStartDate": "string",
"startDate": "string",
"endDate": "string",
"navigationLabel": "string",
"isBookmark": true,
"publish": true
}
{
"description": "Represent lesson object",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Identifier",
"type": "string"
},
"name": {
"description": "Title or name",
"type": "string"
},
"description": {
"description": "Title or name",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "Resource ID",
"type": "string"
},
"parentID": {
"format": "uuid",
"description": "Parent ID",
"type": "string"
},
"rootID": {
"format": "uuid",
"description": "First or root lesson ID",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "Created date",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "ID of the user who created this record",
"type": "string"
},
"photoUrl": {
"description": "Creator photo URL",
"type": "string"
},
"userName": {
"description": "Name of the user who posted the category",
"type": "string"
},
"userID": {
"description": "The NUSNETID of the user who created this category",
"type": "string"
},
"email": {
"description": "Email address of the user who posted the category",
"type": "string"
},
"displayStartDate": {
"format": "date-time",
"description": "Starting date to display",
"type": "string"
},
"startDate": {
"format": "date-time",
"description": "Start or opening date",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "End or expiry date",
"type": "string"
},
"navigationLabel": {
"description": "Navigation label",
"type": "string"
},
"isBookmark": {
"description": "Bookmark flag",
"type": "boolean"
},
"publish": {
"description": "Publish flag",
"type": "boolean"
}
}
}
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 PUT "https://luminus.azure-api.net/lessonplan/Lesson/ByNUSCalendar"
-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}");
var uri = "https://luminus.azure-api.net/lessonplan/Lesson/ByNUSCalendar?" + 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://luminus.azure-api.net/lessonplan/Lesson/ByNUSCalendar");
URI uri = builder.build();
HttpPut request = new HttpPut(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
};
$.ajax({
url: "https://luminus.azure-api.net/lessonplan/Lesson/ByNUSCalendar?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
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://luminus.azure-api.net/lessonplan/Lesson/ByNUSCalendar";
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:@"PUT"];
// 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/lessonplan/Lesson/ByNUSCalendar');
$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
);
$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
'Content-Type': 'application/json-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("PUT", "/lessonplan/Lesson/ByNUSCalendar?%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({
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("PUT", "/lessonplan/Lesson/ByNUSCalendar?%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/lessonplan/Lesson/ByNUSCalendar')
request = Net::HTTP::Put.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