Announcement API

API change history

List of APIs related to Announcement

Get active announcements by module

  1. Get the list of active announcements (for one module) that are accessible to the login user.
  2. Add log if titleOnly is set to false.

Try it

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 and add log.

Request headers

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

Request body

Responses

200 OK

Returns list of [API_Announcement.API.Announcement]

Representations

{
  "type": "array",
  "items": {
    "description": "The Announcement output class",
    "required": [
      "access",
      "archiveAfter",
      "createdDate",
      "creatorID",
      "displayFrom",
      "email",
      "excludeOwner",
      "expireAfter",
      "id",
      "lastUpdatedBy",
      "lastUpdatedDate",
      "parentID",
      "publish",
      "sms",
      "title"
    ],
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "Announcement ID",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "ID of the parent resource",
        "type": "string"
      },
      "title": {
        "description": "Announcement title",
        "type": "string"
      },
      "description": {
        "description": "Announcement description",
        "type": "string"
      },
      "displayFrom": {
        "format": "date-time",
        "description": "Announcement display start date",
        "type": "string"
      },
      "expireAfter": {
        "format": "date-time",
        "description": "Announcement expiry date. Students can view expired announcement however the announcement will not be highlighted as \"New\".",
        "type": "string"
      },
      "archiveAfter": {
        "format": "date-time",
        "description": "Announcement display end date. Students cannot view announcement that has been archived.",
        "type": "string"
      },
      "publish": {
        "description": "True if the announcement is published",
        "type": "boolean"
      },
      "sms": {
        "description": "True if the announcement has been sent by SMS",
        "type": "boolean"
      },
      "email": {
        "description": "True if the announcement has been sent by email",
        "type": "boolean"
      },
      "excludeOwner": {
        "description": "True to exclude module owner from the list of email/SMS recipients.",
        "type": "boolean"
      },
      "access": {
        "description": "Announcement access rights",
        "allOf": [
          {
            "description": "flags to define access rights",
            "type": "object",
            "properties": {
              "access_Full": {
                "description": "all accesses on the resource and its contents",
                "type": "boolean"
              },
              "access_Read": {
                "description": "read-only access on the contents",
                "type": "boolean"
              },
              "access_Create": {
                "description": "create access on the contents",
                "type": "boolean"
              },
              "access_Update": {
                "description": "update access on the contents",
                "type": "boolean"
              },
              "access_Delete": {
                "description": "delete access on the contents",
                "type": "boolean"
              },
              "access_Settings_Read": {
                "description": "read-only access on the resource setting",
                "type": "boolean"
              },
              "access_Settings_Update": {
                "description": "update access on the resource setting",
                "type": "boolean"
              }
            }
          }
        ]
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date the announcement is created",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "The Guid of the user who created the announcement",
        "type": "string"
      },
      "creatorName": {
        "description": "The name of the user who created the announcement",
        "type": "string"
      },
      "creatorUserID": {
        "description": "The user ID of the user who created the announcement",
        "type": "string"
      },
      "creatorEmail": {
        "description": "The email address of the user who created the announcement",
        "type": "string"
      },
      "lastUpdatedDate": {
        "format": "date-time",
        "description": "The date the announcement is last updated",
        "type": "string"
      },
      "lastUpdatedBy": {
        "format": "uuid",
        "description": "The Guid of the user who last updated the announcement",
        "type": "string"
      },
      "lastUpdatedByName": {
        "description": "The name of the user who last updated the announcement",
        "type": "string"
      },
      "lastUpdatedByUserID": {
        "description": "The user ID of the user who last updated the announcement",
        "type": "string"
      },
      "lastUpdatedByEmail": {
        "description": "The email address of the user who last updated the announcement",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "parentID": "string",
    "title": "string",
    "description": "string",
    "displayFrom": "string",
    "expireAfter": "string",
    "archiveAfter": "string",
    "publish": true,
    "sms": true,
    "email": true,
    "excludeOwner": true,
    "access": {
      "access_Full": true,
      "access_Read": true,
      "access_Create": true,
      "access_Update": true,
      "access_Delete": true,
      "access_Settings_Read": true,
      "access_Settings_Update": true
    },
    "createdDate": "string",
    "creatorID": "string",
    "creatorName": "string",
    "creatorUserID": "string",
    "creatorEmail": "string",
    "lastUpdatedDate": "string",
    "lastUpdatedBy": "string",
    "lastUpdatedByName": "string",
    "lastUpdatedByUserID": "string",
    "lastUpdatedByEmail": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "The Announcement output class",
    "required": [
      "access",
      "archiveAfter",
      "createdDate",
      "creatorID",
      "displayFrom",
      "email",
      "excludeOwner",
      "expireAfter",
      "id",
      "lastUpdatedBy",
      "lastUpdatedDate",
      "parentID",
      "publish",
      "sms",
      "title"
    ],
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "Announcement ID",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "ID of the parent resource",
        "type": "string"
      },
      "title": {
        "description": "Announcement title",
        "type": "string"
      },
      "description": {
        "description": "Announcement description",
        "type": "string"
      },
      "displayFrom": {
        "format": "date-time",
        "description": "Announcement display start date",
        "type": "string"
      },
      "expireAfter": {
        "format": "date-time",
        "description": "Announcement expiry date. Students can view expired announcement however the announcement will not be highlighted as \"New\".",
        "type": "string"
      },
      "archiveAfter": {
        "format": "date-time",
        "description": "Announcement display end date. Students cannot view announcement that has been archived.",
        "type": "string"
      },
      "publish": {
        "description": "True if the announcement is published",
        "type": "boolean"
      },
      "sms": {
        "description": "True if the announcement has been sent by SMS",
        "type": "boolean"
      },
      "email": {
        "description": "True if the announcement has been sent by email",
        "type": "boolean"
      },
      "excludeOwner": {
        "description": "True to exclude module owner from the list of email/SMS recipients.",
        "type": "boolean"
      },
      "access": {
        "description": "Announcement access rights",
        "allOf": [
          {
            "description": "flags to define access rights",
            "type": "object",
            "properties": {
              "access_Full": {
                "description": "all accesses on the resource and its contents",
                "type": "boolean"
              },
              "access_Read": {
                "description": "read-only access on the contents",
                "type": "boolean"
              },
              "access_Create": {
                "description": "create access on the contents",
                "type": "boolean"
              },
              "access_Update": {
                "description": "update access on the contents",
                "type": "boolean"
              },
              "access_Delete": {
                "description": "delete access on the contents",
                "type": "boolean"
              },
              "access_Settings_Read": {
                "description": "read-only access on the resource setting",
                "type": "boolean"
              },
              "access_Settings_Update": {
                "description": "update access on the resource setting",
                "type": "boolean"
              }
            }
          }
        ]
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date the announcement is created",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "The Guid of the user who created the announcement",
        "type": "string"
      },
      "creatorName": {
        "description": "The name of the user who created the announcement",
        "type": "string"
      },
      "creatorUserID": {
        "description": "The user ID of the user who created the announcement",
        "type": "string"
      },
      "creatorEmail": {
        "description": "The email address of the user who created the announcement",
        "type": "string"
      },
      "lastUpdatedDate": {
        "format": "date-time",
        "description": "The date the announcement is last updated",
        "type": "string"
      },
      "lastUpdatedBy": {
        "format": "uuid",
        "description": "The Guid of the user who last updated the announcement",
        "type": "string"
      },
      "lastUpdatedByName": {
        "description": "The name of the user who last updated the announcement",
        "type": "string"
      },
      "lastUpdatedByUserID": {
        "description": "The user ID of the user who last updated the announcement",
        "type": "string"
      },
      "lastUpdatedByEmail": {
        "description": "The email address of the user who last updated the announcement",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "parentID": "string",
    "title": "string",
    "description": "string",
    "displayFrom": "string",
    "expireAfter": "string",
    "archiveAfter": "string",
    "publish": true,
    "sms": true,
    "email": true,
    "excludeOwner": true,
    "access": {
      "access_Full": true,
      "access_Read": true,
      "access_Create": true,
      "access_Update": true,
      "access_Delete": true,
      "access_Settings_Read": true,
      "access_Settings_Update": true
    },
    "createdDate": "string",
    "creatorID": "string",
    "creatorName": "string",
    "creatorUserID": "string",
    "creatorEmail": "string",
    "lastUpdatedDate": "string",
    "lastUpdatedBy": "string",
    "lastUpdatedByName": "string",
    "lastUpdatedByUserID": "string",
    "lastUpdatedByEmail": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "The Announcement output class",
    "required": [
      "access",
      "archiveAfter",
      "createdDate",
      "creatorID",
      "displayFrom",
      "email",
      "excludeOwner",
      "expireAfter",
      "id",
      "lastUpdatedBy",
      "lastUpdatedDate",
      "parentID",
      "publish",
      "sms",
      "title"
    ],
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "Announcement ID",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "ID of the parent resource",
        "type": "string"
      },
      "title": {
        "description": "Announcement title",
        "type": "string"
      },
      "description": {
        "description": "Announcement description",
        "type": "string"
      },
      "displayFrom": {
        "format": "date-time",
        "description": "Announcement display start date",
        "type": "string"
      },
      "expireAfter": {
        "format": "date-time",
        "description": "Announcement expiry date. Students can view expired announcement however the announcement will not be highlighted as \"New\".",
        "type": "string"
      },
      "archiveAfter": {
        "format": "date-time",
        "description": "Announcement display end date. Students cannot view announcement that has been archived.",
        "type": "string"
      },
      "publish": {
        "description": "True if the announcement is published",
        "type": "boolean"
      },
      "sms": {
        "description": "True if the announcement has been sent by SMS",
        "type": "boolean"
      },
      "email": {
        "description": "True if the announcement has been sent by email",
        "type": "boolean"
      },
      "excludeOwner": {
        "description": "True to exclude module owner from the list of email/SMS recipients.",
        "type": "boolean"
      },
      "access": {
        "description": "Announcement access rights",
        "allOf": [
          {
            "description": "flags to define access rights",
            "type": "object",
            "properties": {
              "access_Full": {
                "description": "all accesses on the resource and its contents",
                "type": "boolean"
              },
              "access_Read": {
                "description": "read-only access on the contents",
                "type": "boolean"
              },
              "access_Create": {
                "description": "create access on the contents",
                "type": "boolean"
              },
              "access_Update": {
                "description": "update access on the contents",
                "type": "boolean"
              },
              "access_Delete": {
                "description": "delete access on the contents",
                "type": "boolean"
              },
              "access_Settings_Read": {
                "description": "read-only access on the resource setting",
                "type": "boolean"
              },
              "access_Settings_Update": {
                "description": "update access on the resource setting",
                "type": "boolean"
              }
            }
          }
        ]
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date the announcement is created",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "The Guid of the user who created the announcement",
        "type": "string"
      },
      "creatorName": {
        "description": "The name of the user who created the announcement",
        "type": "string"
      },
      "creatorUserID": {
        "description": "The user ID of the user who created the announcement",
        "type": "string"
      },
      "creatorEmail": {
        "description": "The email address of the user who created the announcement",
        "type": "string"
      },
      "lastUpdatedDate": {
        "format": "date-time",
        "description": "The date the announcement is last updated",
        "type": "string"
      },
      "lastUpdatedBy": {
        "format": "uuid",
        "description": "The Guid of the user who last updated the announcement",
        "type": "string"
      },
      "lastUpdatedByName": {
        "description": "The name of the user who last updated the announcement",
        "type": "string"
      },
      "lastUpdatedByUserID": {
        "description": "The user ID of the user who last updated the announcement",
        "type": "string"
      },
      "lastUpdatedByEmail": {
        "description": "The email address of the user who last updated the announcement",
        "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

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/Active/{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/Active/{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/Active/{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/Active/{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/Active/{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/Active/{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/Active/{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/Active/{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/Active/{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