Forum API
API change historyList of APIs related to Forum
Get search posts
Get searched post details by filtering headerID, categoryID, threadID , UserID, GroupIDs
Try itRequest
Request URL
Request parameters
-
(optional)string
Format - uuid. Module Id
-
(optional)string
Format - uuid. Optional Header ID
-
(optional)string
Format - uuid. Optional Category ID
-
(optional)string
Format - uuid. Optional Thread ID
-
(optional)string
Optional Class Group IDs separated by comma
-
(optional)string
Format - uuid. Optional User ID
-
(optional)string
Format - date-time (as date-time in RFC3339). Optional Start Date
-
(optional)string
Format - date-time (as date-time in RFC3339). Optional End Date
-
(optional)string
-
(optional)integer
Format - int32.
-
(optional)integer
Format - int32.
-
(optional)string
Request headers
Request body
Responses
200 OK
Returns list of searched post details information
Representations
{
"description": "Forum Report",
"type": "object",
"properties": {
"name": {
"description": "Student name",
"type": "string"
},
"userID": {
"description": "Student name",
"type": "string"
},
"number": {
"description": "Student number",
"type": "string"
},
"groupIDs": {
"description": "Class group number",
"type": "string"
},
"groupIDList": {
"description": "Group ID in list string format",
"type": "array",
"items": {
"type": "string"
}
},
"postDate": {
"format": "date-time",
"description": "Post date",
"type": "string"
},
"header": {
"description": "Forum Header",
"type": "string"
},
"forumTitle": {
"description": "Forum Category",
"type": "string"
},
"postTitle": {
"description": "Post title",
"type": "string"
},
"publish": {
"description": "To disable for the post instead of delete if there is reply",
"type": "boolean"
},
"content": {
"description": "Post content",
"type": "string"
},
"ancestor": {
"description": "link url",
"type": "array",
"items": {
"description": "Target which can be resource or resource content",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "entity id",
"type": "string"
},
"name": {
"description": "entity name",
"type": "string"
},
"typeID": {
"description": "entity type",
"allOf": [
{
"format": "int32",
"description": "type of resource or content",
"enum": [
1,
2,
6,
7,
8,
10,
11,
13,
14,
15,
16,
17,
19,
20,
22,
24,
25,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
39,
41,
42,
44,
45,
47,
48,
51,
54,
55,
56,
57,
58,
59,
60,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
83,
100,
200,
1000,
1001,
1002,
1003,
1004,
1005,
1006
],
"type": "integer"
}
]
},
"typeName": {
"description": "entity type name",
"type": "string"
},
"isResourceType": {
"description": "whether the entity is a resource",
"type": "boolean"
}
}
}
}
}
}{
"name": "string",
"userID": "string",
"number": "string",
"groupIDs": "string",
"groupIDList": [
"string"
],
"postDate": "string",
"header": "string",
"forumTitle": "string",
"postTitle": "string",
"publish": true,
"content": "string",
"ancestor": [
{
"id": "string",
"name": "string",
"typeID": {},
"typeName": "string",
"isResourceType": true
}
]
}{
"description": "Forum Report",
"type": "object",
"properties": {
"name": {
"description": "Student name",
"type": "string"
},
"userID": {
"description": "Student name",
"type": "string"
},
"number": {
"description": "Student number",
"type": "string"
},
"groupIDs": {
"description": "Class group number",
"type": "string"
},
"groupIDList": {
"description": "Group ID in list string format",
"type": "array",
"items": {
"type": "string"
}
},
"postDate": {
"format": "date-time",
"description": "Post date",
"type": "string"
},
"header": {
"description": "Forum Header",
"type": "string"
},
"forumTitle": {
"description": "Forum Category",
"type": "string"
},
"postTitle": {
"description": "Post title",
"type": "string"
},
"publish": {
"description": "To disable for the post instead of delete if there is reply",
"type": "boolean"
},
"content": {
"description": "Post content",
"type": "string"
},
"ancestor": {
"description": "link url",
"type": "array",
"items": {
"description": "Target which can be resource or resource content",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "entity id",
"type": "string"
},
"name": {
"description": "entity name",
"type": "string"
},
"typeID": {
"description": "entity type",
"allOf": [
{
"format": "int32",
"description": "type of resource or content",
"enum": [
1,
2,
6,
7,
8,
10,
11,
13,
14,
15,
16,
17,
19,
20,
22,
24,
25,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
39,
41,
42,
44,
45,
47,
48,
51,
54,
55,
56,
57,
58,
59,
60,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
83,
100,
200,
1000,
1001,
1002,
1003,
1004,
1005,
1006
],
"type": "integer"
}
]
},
"typeName": {
"description": "entity type name",
"type": "string"
},
"isResourceType": {
"description": "whether the entity is a resource",
"type": "boolean"
}
}
}
}
}
}{
"name": "string",
"userID": "string",
"number": "string",
"groupIDs": "string",
"groupIDList": [
"string"
],
"postDate": "string",
"header": "string",
"forumTitle": "string",
"postTitle": "string",
"publish": true,
"content": "string",
"ancestor": [
{
"id": "string",
"name": "string",
"typeID": {},
"typeName": "string",
"isResourceType": true
}
]
}{
"description": "Forum Report",
"type": "object",
"properties": {
"name": {
"description": "Student name",
"type": "string"
},
"userID": {
"description": "Student name",
"type": "string"
},
"number": {
"description": "Student number",
"type": "string"
},
"groupIDs": {
"description": "Class group number",
"type": "string"
},
"groupIDList": {
"description": "Group ID in list string format",
"type": "array",
"items": {
"type": "string"
}
},
"postDate": {
"format": "date-time",
"description": "Post date",
"type": "string"
},
"header": {
"description": "Forum Header",
"type": "string"
},
"forumTitle": {
"description": "Forum Category",
"type": "string"
},
"postTitle": {
"description": "Post title",
"type": "string"
},
"publish": {
"description": "To disable for the post instead of delete if there is reply",
"type": "boolean"
},
"content": {
"description": "Post content",
"type": "string"
},
"ancestor": {
"description": "link url",
"type": "array",
"items": {
"description": "Target which can be resource or resource content",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "entity id",
"type": "string"
},
"name": {
"description": "entity name",
"type": "string"
},
"typeID": {
"description": "entity type",
"allOf": [
{
"format": "int32",
"description": "type of resource or content",
"enum": [
1,
2,
6,
7,
8,
10,
11,
13,
14,
15,
16,
17,
19,
20,
22,
24,
25,
27,
28,
29,
30,
31,
32,
33,
34,
35,
36,
37,
39,
41,
42,
44,
45,
47,
48,
51,
54,
55,
56,
57,
58,
59,
60,
62,
63,
64,
65,
66,
67,
68,
69,
70,
71,
72,
73,
74,
75,
76,
77,
78,
79,
80,
81,
83,
100,
200,
1000,
1001,
1002,
1003,
1004,
1005,
1006
],
"type": "integer"
}
]
},
"typeName": {
"description": "entity type name",
"type": "string"
},
"isResourceType": {
"description": "whether the entity is a resource",
"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 GET "https://luminus.azure-api.net/forum/Report/Search?moduleID={string}&headerID={string}&categoryID={string}&threadID={string}&groupIDs={string}&userID={string}&startDate={string}&endDate={string}&sortby={string}&offset={integer}&limit={integer}&where={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["moduleID"] = "{string}";
queryString["headerID"] = "{string}";
queryString["categoryID"] = "{string}";
queryString["threadID"] = "{string}";
queryString["groupIDs"] = "{string}";
queryString["userID"] = "{string}";
queryString["startDate"] = "{string}";
queryString["endDate"] = "{string}";
queryString["sortby"] = "{string}";
queryString["offset"] = "{integer}";
queryString["limit"] = "{integer}";
queryString["where"] = "{string}";
var uri = "https://luminus.azure-api.net/forum/Report/Search?" + 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/forum/Report/Search");
builder.setParameter("moduleID", "{string}");
builder.setParameter("headerID", "{string}");
builder.setParameter("categoryID", "{string}");
builder.setParameter("threadID", "{string}");
builder.setParameter("groupIDs", "{string}");
builder.setParameter("userID", "{string}");
builder.setParameter("startDate", "{string}");
builder.setParameter("endDate", "{string}");
builder.setParameter("sortby", "{string}");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{integer}");
builder.setParameter("where", "{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
"moduleID": "{string}",
"headerID": "{string}",
"categoryID": "{string}",
"threadID": "{string}",
"groupIDs": "{string}",
"userID": "{string}",
"startDate": "{string}",
"endDate": "{string}",
"sortby": "{string}",
"offset": "{integer}",
"limit": "{integer}",
"where": "{string}",
};
$.ajax({
url: "https://luminus.azure-api.net/forum/Report/Search?" + $.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/forum/Report/Search";
NSArray* array = @[
// Request parameters
@"entities=true",
@"moduleID={string}",
@"headerID={string}",
@"categoryID={string}",
@"threadID={string}",
@"groupIDs={string}",
@"userID={string}",
@"startDate={string}",
@"endDate={string}",
@"sortby={string}",
@"offset={integer}",
@"limit={integer}",
@"where={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/forum/Report/Search');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'moduleID' => '{string}',
'headerID' => '{string}',
'categoryID' => '{string}',
'threadID' => '{string}',
'groupIDs' => '{string}',
'userID' => '{string}',
'startDate' => '{string}',
'endDate' => '{string}',
'sortby' => '{string}',
'offset' => '{integer}',
'limit' => '{integer}',
'where' => '{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
'moduleID': '{string}',
'headerID': '{string}',
'categoryID': '{string}',
'threadID': '{string}',
'groupIDs': '{string}',
'userID': '{string}',
'startDate': '{string}',
'endDate': '{string}',
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/forum/Report/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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'moduleID': '{string}',
'headerID': '{string}',
'categoryID': '{string}',
'threadID': '{string}',
'groupIDs': '{string}',
'userID': '{string}',
'startDate': '{string}',
'endDate': '{string}',
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/forum/Report/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/forum/Report/Search')
query = URI.encode_www_form({
# Request parameters
'moduleID' => '{string}',
'headerID' => '{string}',
'categoryID' => '{string}',
'threadID' => '{string}',
'groupIDs' => '{string}',
'userID' => '{string}',
'startDate' => '{string}',
'endDate' => '{string}',
'sortby' => '{string}',
'offset' => '{integer}',
'limit' => '{integer}',
'where' => '{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