Announcement API
API change historyList of APIs related to Announcement
Get archived announcements by module
- Get the list of archived announcements (for one module) that are accessible to the login user.
- Only users with Access_Setting_Read access to the archived announcements can view them.
Request
Request URL
Request parameters
-
string
Format - uuid. Parent ID, e.g. ModuleID
-
(optional)string
-
(optional)integer
Format - int32.
-
(optional)integer
Format - int32.
-
(optional)string
-
(optional)string
Populate additional information. Accepted entities: creator, lastUpdatedUser
-
(optional)boolean
True by default. Set to False to return announcement details.
Request headers
Request body
Responses
200 OK
Returns list of [API_Announcement.API.Announcement]
Representations
{
"type": "array",
"items": {
"description": "The Announcement class inherits [contract.Resource.Models.Resource] \r\n<seealso cref=\"T:contract.Resource.Models.Resource\" />",
"type": "object",
"properties": {
"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"
},
"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"
},
"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"
},
"lastDeletedDate": {
"format": "date-time",
"description": "the date this record is deleted if the value is not null",
"type": "string"
},
"lastDeletedBy": {
"format": "uuid",
"description": "the ID of the user who deleted this record if the value is not null",
"type": "string"
},
"name": {
"description": "the name/title of the record",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the record is published to students.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "",
"type": "string"
},
"properties": {
"description": "the serialized string for the rest content properites.",
"type": "string"
},
"typeID": {
"description": "the content 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"
}
]
}
}
}
}[
{
"startDate": "string",
"endDate": "string",
"rootID": "string",
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastDeletedDate": "string",
"lastDeletedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"properties": "string",
"typeID": {}
}
]{
"type": "array",
"items": {
"description": "The Announcement class inherits [contract.Resource.Models.Resource] \r\n<seealso cref=\"T:contract.Resource.Models.Resource\" />",
"type": "object",
"properties": {
"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"
},
"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"
},
"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"
},
"lastDeletedDate": {
"format": "date-time",
"description": "the date this record is deleted if the value is not null",
"type": "string"
},
"lastDeletedBy": {
"format": "uuid",
"description": "the ID of the user who deleted this record if the value is not null",
"type": "string"
},
"name": {
"description": "the name/title of the record",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the record is published to students.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "",
"type": "string"
},
"properties": {
"description": "the serialized string for the rest content properites.",
"type": "string"
},
"typeID": {
"description": "the content 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"
}
]
}
}
}
}[
{
"startDate": "string",
"endDate": "string",
"rootID": "string",
"id": "string",
"createdDate": "string",
"creatorID": "string",
"lastUpdatedDate": "string",
"lastUpdatedBy": "string",
"lastDeletedDate": "string",
"lastDeletedBy": "string",
"name": "string",
"publish": true,
"parentID": "string",
"properties": "string",
"typeID": {}
}
]{
"type": "array",
"items": {
"description": "The Announcement class inherits [contract.Resource.Models.Resource] \r\n<seealso cref=\"T:contract.Resource.Models.Resource\" />",
"type": "object",
"properties": {
"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"
},
"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"
},
"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"
},
"lastDeletedDate": {
"format": "date-time",
"description": "the date this record is deleted if the value is not null",
"type": "string"
},
"lastDeletedBy": {
"format": "uuid",
"description": "the ID of the user who deleted this record if the value is not null",
"type": "string"
},
"name": {
"description": "the name/title of the record",
"type": "string"
},
"publish": {
"description": "the publish flag which determin whether the record is published to students.",
"type": "boolean"
},
"parentID": {
"format": "uuid",
"description": "",
"type": "string"
},
"properties": {
"description": "the serialized string for the rest content properites.",
"type": "string"
},
"typeID": {
"description": "the content 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"
}
]
}
}
}
}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
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 GET "https://luminus.azure-api.net/announcement/Archived/{parentID}?sortby={string}&offset={integer}&limit={integer}&where={string}&populate={string}&titleOnly=True"
-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}";
queryString["titleOnly"] = "True";
var uri = "https://luminus.azure-api.net/announcement/Archived/{parentID}?" + 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/announcement/Archived/{parentID}");
builder.setParameter("sortby", "{string}");
builder.setParameter("offset", "{integer}");
builder.setParameter("limit", "{integer}");
builder.setParameter("where", "{string}");
builder.setParameter("populate", "{string}");
builder.setParameter("titleOnly", "True");
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
"sortby": "{string}",
"offset": "{integer}",
"limit": "{integer}",
"where": "{string}",
"populate": "{string}",
"titleOnly": "True",
};
$.ajax({
url: "https://luminus.azure-api.net/announcement/Archived/{parentID}?" + $.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/announcement/Archived/{parentID}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"sortby={string}",
@"offset={integer}",
@"limit={integer}",
@"where={string}",
@"populate={string}",
@"titleOnly=True",
];
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/announcement/Archived/{parentID}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'sortby' => '{string}',
'offset' => '{integer}',
'limit' => '{integer}',
'where' => '{string}',
'populate' => '{string}',
'titleOnly' => 'True',
);
$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
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
'populate': '{string}',
'titleOnly': 'True',
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/announcement/Archived/{parentID}?%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
'sortby': '{string}',
'offset': '{integer}',
'limit': '{integer}',
'where': '{string}',
'populate': '{string}',
'titleOnly': 'True',
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/announcement/Archived/{parentID}?%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/announcement/Archived/{parentID}')
query = URI.encode_www_form({
# Request parameters
'sortby' => '{string}',
'offset' => '{integer}',
'limit' => '{integer}',
'where' => '{string}',
'populate' => '{string}',
'titleOnly' => 'True'
})
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