Forum API

API change history

List of APIs related to Forum

Get threads

Populate property, LatestPost will include total replies and total views of threads and last updated date will be last post's updated date

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Format - uuid. Category Id

  • (optional)
    string
  • (optional)
    integer

    Format - int32.

  • (optional)
    integer

    Format - int32.

  • (optional)
    string
  • (optional)
    string

    Accepted populate entities: Creator, Photo, LatestPost

Request headers

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

Request body

Responses

200 OK

Returns list of thread information

Representations

{
  "type": "array",
  "items": {
    "description": "Represents post object with resource content base class.",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "identifier",
        "type": "string"
      },
      "name": {
        "description": "Thread title or description",
        "type": "string"
      },
      "resourceID": {
        "format": "uuid",
        "description": "Resource ID.",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "Parent ID if any. For those resource content which do not have a parent, the parent ID value will be the same as the 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"
      },
      "updatedDate": {
        "format": "date-time",
        "description": "Last Updated Date",
        "type": "string"
      },
      "photoUrl": {
        "description": "The url for creator photo",
        "type": "string"
      },
      "isRequireReply": {
        "description": "Gets or sets the require reply flag.",
        "type": "boolean"
      },
      "showOnlyMyPost": {
        "description": "Gets or sets privacy to other students.",
        "type": "boolean"
      },
      "postBody": {
        "description": "Gets or sets a post body content.",
        "type": "string"
      },
      "attachment": {
        "description": "Indicator set to Y if post contain attachment otherwise N.",
        "type": "string"
      },
      "isSticky": {
        "description": "Gets or sets flag for sticky post.",
        "type": "boolean"
      },
      "publish": {
        "description": "To disable for the post instead of delete if there is reply",
        "type": "boolean"
      },
      "isClosed": {
        "description": "Set flag for closed thread",
        "type": "boolean"
      },
      "relatedThreadID": {
        "format": "uuid",
        "description": "ID of the related thread",
        "type": "string"
      },
      "userName": {
        "description": "Name of the user who posted the category",
        "type": "string"
      },
      "userID": {
        "description": "User ID of the user who posted the category",
        "type": "string"
      },
      "email": {
        "description": "Email address of the user who posted the category",
        "type": "string"
      },
      "viewCount": {
        "format": "int32",
        "description": "Total number of views",
        "type": "integer"
      },
      "replyCount": {
        "format": "int32",
        "description": "Total number of reply",
        "type": "integer"
      }
    }
  }
}
[
  {
    "id": "string",
    "name": "string",
    "resourceID": "string",
    "parentID": "string",
    "createdDate": "string",
    "creatorID": "string",
    "updatedDate": "string",
    "photoUrl": "string",
    "isRequireReply": true,
    "showOnlyMyPost": true,
    "postBody": "string",
    "attachment": "string",
    "isSticky": true,
    "publish": true,
    "isClosed": true,
    "relatedThreadID": "string",
    "userName": "string",
    "userID": "string",
    "email": "string",
    "viewCount": 0,
    "replyCount": 0
  }
]
{
  "type": "array",
  "items": {
    "description": "Represents post object with resource content base class.",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "identifier",
        "type": "string"
      },
      "name": {
        "description": "Thread title or description",
        "type": "string"
      },
      "resourceID": {
        "format": "uuid",
        "description": "Resource ID.",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "Parent ID if any. For those resource content which do not have a parent, the parent ID value will be the same as the 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"
      },
      "updatedDate": {
        "format": "date-time",
        "description": "Last Updated Date",
        "type": "string"
      },
      "photoUrl": {
        "description": "The url for creator photo",
        "type": "string"
      },
      "isRequireReply": {
        "description": "Gets or sets the require reply flag.",
        "type": "boolean"
      },
      "showOnlyMyPost": {
        "description": "Gets or sets privacy to other students.",
        "type": "boolean"
      },
      "postBody": {
        "description": "Gets or sets a post body content.",
        "type": "string"
      },
      "attachment": {
        "description": "Indicator set to Y if post contain attachment otherwise N.",
        "type": "string"
      },
      "isSticky": {
        "description": "Gets or sets flag for sticky post.",
        "type": "boolean"
      },
      "publish": {
        "description": "To disable for the post instead of delete if there is reply",
        "type": "boolean"
      },
      "isClosed": {
        "description": "Set flag for closed thread",
        "type": "boolean"
      },
      "relatedThreadID": {
        "format": "uuid",
        "description": "ID of the related thread",
        "type": "string"
      },
      "userName": {
        "description": "Name of the user who posted the category",
        "type": "string"
      },
      "userID": {
        "description": "User ID of the user who posted the category",
        "type": "string"
      },
      "email": {
        "description": "Email address of the user who posted the category",
        "type": "string"
      },
      "viewCount": {
        "format": "int32",
        "description": "Total number of views",
        "type": "integer"
      },
      "replyCount": {
        "format": "int32",
        "description": "Total number of reply",
        "type": "integer"
      }
    }
  }
}
[
  {
    "id": "string",
    "name": "string",
    "resourceID": "string",
    "parentID": "string",
    "createdDate": "string",
    "creatorID": "string",
    "updatedDate": "string",
    "photoUrl": "string",
    "isRequireReply": true,
    "showOnlyMyPost": true,
    "postBody": "string",
    "attachment": "string",
    "isSticky": true,
    "publish": true,
    "isClosed": true,
    "relatedThreadID": "string",
    "userName": "string",
    "userID": "string",
    "email": "string",
    "viewCount": 0,
    "replyCount": 0
  }
]
{
  "type": "array",
  "items": {
    "description": "Represents post object with resource content base class.",
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "identifier",
        "type": "string"
      },
      "name": {
        "description": "Thread title or description",
        "type": "string"
      },
      "resourceID": {
        "format": "uuid",
        "description": "Resource ID.",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "Parent ID if any. For those resource content which do not have a parent, the parent ID value will be the same as the 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"
      },
      "updatedDate": {
        "format": "date-time",
        "description": "Last Updated Date",
        "type": "string"
      },
      "photoUrl": {
        "description": "The url for creator photo",
        "type": "string"
      },
      "isRequireReply": {
        "description": "Gets or sets the require reply flag.",
        "type": "boolean"
      },
      "showOnlyMyPost": {
        "description": "Gets or sets privacy to other students.",
        "type": "boolean"
      },
      "postBody": {
        "description": "Gets or sets a post body content.",
        "type": "string"
      },
      "attachment": {
        "description": "Indicator set to Y if post contain attachment otherwise N.",
        "type": "string"
      },
      "isSticky": {
        "description": "Gets or sets flag for sticky post.",
        "type": "boolean"
      },
      "publish": {
        "description": "To disable for the post instead of delete if there is reply",
        "type": "boolean"
      },
      "isClosed": {
        "description": "Set flag for closed thread",
        "type": "boolean"
      },
      "relatedThreadID": {
        "format": "uuid",
        "description": "ID of the related thread",
        "type": "string"
      },
      "userName": {
        "description": "Name of the user who posted the category",
        "type": "string"
      },
      "userID": {
        "description": "User ID of the user who posted the category",
        "type": "string"
      },
      "email": {
        "description": "Email address of the user who posted the category",
        "type": "string"
      },
      "viewCount": {
        "format": "int32",
        "description": "Total number of views",
        "type": "integer"
      },
      "replyCount": {
        "format": "int32",
        "description": "Total number of reply",
        "type": "integer"
      }
    }
  }
}

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

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

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'CategoryID' => '{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
    'CategoryID': '{string}',
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
    'populate': '{string}',
})

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

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

query = URI.encode_www_form({
    # Request parameters
    'CategoryID' => '{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