Module API
API change historyList of APIs related to Module - Module Settings (Description, Facilitators, Readings, Weblinks), Details, Chat (TeamUp)
Sync sections from Bulletin
This will delete the existing bulletin information from the module description sections and create new ones.
Try itRequest
Request URL
Request parameters
-
string
Format - uuid. Module ID
Request headers
Request body
Responses
200 OK
the updated sync-ed records
Representations
{
"description": "Description Section content",
"required": [
"creatorEmail",
"creatorName",
"creatorUserID",
"updatorEmail",
"updatorName",
"updatorUserID"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "identifier",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"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"
},
"name": {
"description": "the name/title of the content",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "the parent content ID if any. For those contents which do not have a parent content, the parent ID value will be the same as the ID.",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "the ID of the resource which this content belongs to.",
"type": "string"
},
"fixed": {
"description": "Whether the description section is from official bulletin, or created by one manually, or default created by system. \r\n\"1\" = Items from offical NUS Bulletin and cannot be modified; \"0\" = Items created by one; \"\" = Items default created by system.",
"type": "string"
},
"isDefault": {
"description": "Whether it is a default item from official Bulletin. True means default. False means not default. If isDefault = true, then cannot be modified or deleted, but can publish/unpublish it.",
"type": "boolean"
},
"description": {
"description": "Message of the description section for items created by system (Fixed = \"\").",
"type": "string"
},
"itemText": {
"description": "Full write-up of the Description Section",
"type": "string"
},
"creatorUserID": {
"description": "User ID of the Creator",
"type": "string"
},
"creatorName": {
"description": "Name of the Creator",
"type": "string"
},
"creatorEmail": {
"description": "Email of the Creator",
"type": "string"
},
"updatorUserID": {
"description": "User ID of the Updator",
"type": "string"
},
"updatorName": {
"description": "Name of the Updator",
"type": "string"
},
"updatorEmail": {
"description": "Email of the Updator",
"type": "string"
}
}
}
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"fixed": "string",
"isDefault": true,
"description": "string",
"itemText": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
{
"description": "Description Section content",
"required": [
"creatorEmail",
"creatorName",
"creatorUserID",
"updatorEmail",
"updatorName",
"updatorUserID"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "identifier",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"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"
},
"name": {
"description": "the name/title of the content",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "the parent content ID if any. For those contents which do not have a parent content, the parent ID value will be the same as the ID.",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "the ID of the resource which this content belongs to.",
"type": "string"
},
"fixed": {
"description": "Whether the description section is from official bulletin, or created by one manually, or default created by system. \r\n\"1\" = Items from offical NUS Bulletin and cannot be modified; \"0\" = Items created by one; \"\" = Items default created by system.",
"type": "string"
},
"isDefault": {
"description": "Whether it is a default item from official Bulletin. True means default. False means not default. If isDefault = true, then cannot be modified or deleted, but can publish/unpublish it.",
"type": "boolean"
},
"description": {
"description": "Message of the description section for items created by system (Fixed = \"\").",
"type": "string"
},
"itemText": {
"description": "Full write-up of the Description Section",
"type": "string"
},
"creatorUserID": {
"description": "User ID of the Creator",
"type": "string"
},
"creatorName": {
"description": "Name of the Creator",
"type": "string"
},
"creatorEmail": {
"description": "Email of the Creator",
"type": "string"
},
"updatorUserID": {
"description": "User ID of the Updator",
"type": "string"
},
"updatorName": {
"description": "Name of the Updator",
"type": "string"
},
"updatorEmail": {
"description": "Email of the Updator",
"type": "string"
}
}
}
{
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"resourceID": "string",
"fixed": "string",
"isDefault": true,
"description": "string",
"itemText": "string",
"creatorUserID": "string",
"creatorName": "string",
"creatorEmail": "string",
"updatorUserID": "string",
"updatorName": "string",
"updatorEmail": "string"
}
{
"description": "Description Section content",
"required": [
"creatorEmail",
"creatorName",
"creatorUserID",
"updatorEmail",
"updatorName",
"updatorUserID"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "identifier",
"type": "string"
},
"createdDate": {
"format": "date-time",
"description": "The date this record is created",
"type": "string"
},
"creatorID": {
"format": "uuid",
"description": "the ID of the user who created this record",
"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"
},
"name": {
"description": "the name/title of the content",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the resource is published to students.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "the parent content ID if any. For those contents which do not have a parent content, the parent ID value will be the same as the ID.",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "the ID of the resource which this content belongs to.",
"type": "string"
},
"fixed": {
"description": "Whether the description section is from official bulletin, or created by one manually, or default created by system. \r\n\"1\" = Items from offical NUS Bulletin and cannot be modified; \"0\" = Items created by one; \"\" = Items default created by system.",
"type": "string"
},
"isDefault": {
"description": "Whether it is a default item from official Bulletin. True means default. False means not default. If isDefault = true, then cannot be modified or deleted, but can publish/unpublish it.",
"type": "boolean"
},
"description": {
"description": "Message of the description section for items created by system (Fixed = \"\").",
"type": "string"
},
"itemText": {
"description": "Full write-up of the Description Section",
"type": "string"
},
"creatorUserID": {
"description": "User ID of the Creator",
"type": "string"
},
"creatorName": {
"description": "Name of the Creator",
"type": "string"
},
"creatorEmail": {
"description": "Email of the Creator",
"type": "string"
},
"updatorUserID": {
"description": "User ID of the Updator",
"type": "string"
},
"updatorName": {
"description": "Name of the Updator",
"type": "string"
},
"updatorEmail": {
"description": "Email of the Updator",
"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
Record 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 PUT "https://luminus.azure-api.net/module/{ResourceID}/Section/Sync"
-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/module/{ResourceID}/Section/Sync?" + 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/module/{ResourceID}/Section/Sync");
URI uri = builder.build();
HttpPut request = new HttpPut(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/module/{ResourceID}/Section/Sync?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
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/module/{ResourceID}/Section/Sync";
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:@"{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/module/{ResourceID}/Section/Sync');
$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_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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("PUT", "/module/{ResourceID}/Section/Sync?%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("PUT", "/module/{ResourceID}/Section/Sync?%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/module/{ResourceID}/Section/Sync')
request = Net::HTTP::Put.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