Module API

API change history

List of APIs related to Module - Module Settings (Description, Facilitators, Readings, Weblinks), Details, Chat (TeamUp)

Search for facilitator

To search for facilitators of the module based on the filter text.

Try it

Request

Request URL

https://luminus.azure-api.net/module/{ResourceID}/SearchManager[?searchtext][&sortby][&offset][&limit][&where][&populate]

Request parameters

ResourceID

string

Format - uuid. Module ID
searchtext (optional)

string

The text used for search
sortby (optional)

string
offset (optional)

integer

Format - int32.
limit (optional)

integer

Format - int32.
where (optional)

string
populate (optional)

string
Accepted populate entities: creator, lastUpdatedUser, photo, groupID
```
        groupID refers to the groupID of the non-activated user.
```

Request headers

Ocp-Apim-Subscription-Key

string

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

Request body

Responses

200 OK

Returns a list of [API.Manager]

Representations

{
  "type": "array",
  "items": {
    "description": "Manager content",
    "required": [
      "aboutMe",
      "creatorEmail",
      "creatorName",
      "creatorUserID",
      "department",
      "email",
      "phoneNo",
      "title",
      "updatorEmail",
      "updatorName",
      "updatorUserID",
      "userID",
      "userMatricNo",
      "userName"
    ],
    "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"
      },
      "accessRole": {
        "description": "Access Role of the Manager for the Module",
        "allOf": [
          {
            "format": "int32",
            "description": "customized user role for IVLE.",
            "enum": [
              1,
              2,
              3,
              4,
              5,
              6
            ],
            "type": "integer"
          }
        ]
      },
      "accessRoleName": {
        "description": "Access Role Name",
        "type": "string"
      },
      "userMatricNo": {
        "description": "User number of the manager",
        "type": "string"
      },
      "userID": {
        "description": "User ID of the manager",
        "type": "string"
      },
      "userName": {
        "description": "Name of the manager",
        "type": "string"
      },
      "email": {
        "description": "Email of the manager",
        "type": "string"
      },
      "title": {
        "description": "Title of the manager",
        "type": "string"
      },
      "department": {
        "description": "Department of the manager",
        "type": "string"
      },
      "phoneNo": {
        "description": "Office contact number of the manager",
        "type": "string"
      },
      "photo": {
        "description": "Photo Path",
        "type": "string"
      },
      "aboutMe": {
        "description": "Write-up about the manager",
        "type": "string"
      },
      "roleID": {
        "format": "uuid",
        "description": "Module Roles. To indicate the role of the manager for the module.",
        "type": "string"
      },
      "moduleRole": {
        "description": "Module Roles. To indicate the role of the manager for the module.",
        "allOf": [
          {
            "format": "int32",
            "description": "Module role for the manager",
            "enum": [
              0,
              1,
              2,
              3,
              4,
              5,
              6,
              7,
              8,
              9,
              10
            ],
            "type": "integer"
          }
        ]
      },
      "roleName": {
        "description": "Text to be displayed for RoleID",
        "type": "string"
      },
      "displayUserPhoto": {
        "description": "True to display photo of the manager",
        "type": "boolean"
      },
      "consultHrs": {
        "description": "Unformatted consultation hours for the manager",
        "type": "string"
      },
      "userGuid": {
        "format": "uuid",
        "description": "GUID of the user for manager",
        "type": "string"
      },
      "imported": {
        "description": "True if the manager is imported from EduRec",
        "type": "boolean"
      },
      "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"
      }
    }
  }
}

Sample
Schema

[
  {
    "id": "string",
    "createdDate": "string",
    "creatorID": "string",
    "lastUpdatedDate": "string",
    "lastUpdatedBy": "string",
    "name": "string",
    "publish": true,
    "parentID": "string",
    "resourceID": "string",
    "accessRole": {},
    "accessRoleName": "string",
    "userMatricNo": "string",
    "userID": "string",
    "userName": "string",
    "email": "string",
    "title": "string",
    "department": "string",
    "phoneNo": "string",
    "photo": "string",
    "aboutMe": "string",
    "roleID": "string",
    "moduleRole": {},
    "roleName": "string",
    "displayUserPhoto": true,
    "consultHrs": "string",
    "userGuid": "string",
    "imported": true,
    "creatorUserID": "string",
    "creatorName": "string",
    "creatorEmail": "string",
    "updatorUserID": "string",
    "updatorName": "string",
    "updatorEmail": "string"
  }
]

{
  "type": "array",
  "items": {
    "description": "Manager content",
    "required": [
      "aboutMe",
      "creatorEmail",
      "creatorName",
      "creatorUserID",
      "department",
      "email",
      "phoneNo",
      "title",
      "updatorEmail",
      "updatorName",
      "updatorUserID",
      "userID",
      "userMatricNo",
      "userName"
    ],
    "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"
      },
      "accessRole": {
        "description": "Access Role of the Manager for the Module",
        "allOf": [
          {
            "format": "int32",
            "description": "customized user role for IVLE.",
            "enum": [
              1,
              2,
              3,
              4,
              5,
              6
            ],
            "type": "integer"
          }
        ]
      },
      "accessRoleName": {
        "description": "Access Role Name",
        "type": "string"
      },
      "userMatricNo": {
        "description": "User number of the manager",
        "type": "string"
      },
      "userID": {
        "description": "User ID of the manager",
        "type": "string"
      },
      "userName": {
        "description": "Name of the manager",
        "type": "string"
      },
      "email": {
        "description": "Email of the manager",
        "type": "string"
      },
      "title": {
        "description": "Title of the manager",
        "type": "string"
      },
      "department": {
        "description": "Department of the manager",
        "type": "string"
      },
      "phoneNo": {
        "description": "Office contact number of the manager",
        "type": "string"
      },
      "photo": {
        "description": "Photo Path",
        "type": "string"
      },
      "aboutMe": {
        "description": "Write-up about the manager",
        "type": "string"
      },
      "roleID": {
        "format": "uuid",
        "description": "Module Roles. To indicate the role of the manager for the module.",
        "type": "string"
      },
      "moduleRole": {
        "description": "Module Roles. To indicate the role of the manager for the module.",
        "allOf": [
          {
            "format": "int32",
            "description": "Module role for the manager",
            "enum": [
              0,
              1,
              2,
              3,
              4,
              5,
              6,
              7,
              8,
              9,
              10
            ],
            "type": "integer"
          }
        ]
      },
      "roleName": {
        "description": "Text to be displayed for RoleID",
        "type": "string"
      },
      "displayUserPhoto": {
        "description": "True to display photo of the manager",
        "type": "boolean"
      },
      "consultHrs": {
        "description": "Unformatted consultation hours for the manager",
        "type": "string"
      },
      "userGuid": {
        "format": "uuid",
        "description": "GUID of the user for manager",
        "type": "string"
      },
      "imported": {
        "description": "True if the manager is imported from EduRec",
        "type": "boolean"
      },
      "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"
      }
    }
  }
}

Sample
Schema

[
  {
    "id": "string",
    "createdDate": "string",
    "creatorID": "string",
    "lastUpdatedDate": "string",
    "lastUpdatedBy": "string",
    "name": "string",
    "publish": true,
    "parentID": "string",
    "resourceID": "string",
    "accessRole": {},
    "accessRoleName": "string",
    "userMatricNo": "string",
    "userID": "string",
    "userName": "string",
    "email": "string",
    "title": "string",
    "department": "string",
    "phoneNo": "string",
    "photo": "string",
    "aboutMe": "string",
    "roleID": "string",
    "moduleRole": {},
    "roleName": "string",
    "displayUserPhoto": true,
    "consultHrs": "string",
    "userGuid": "string",
    "imported": true,
    "creatorUserID": "string",
    "creatorName": "string",
    "creatorEmail": "string",
    "updatorUserID": "string",
    "updatorName": "string",
    "updatorEmail": "string"
  }
]

{
  "type": "array",
  "items": {
    "description": "Manager content",
    "required": [
      "aboutMe",
      "creatorEmail",
      "creatorName",
      "creatorUserID",
      "department",
      "email",
      "phoneNo",
      "title",
      "updatorEmail",
      "updatorName",
      "updatorUserID",
      "userID",
      "userMatricNo",
      "userName"
    ],
    "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"
      },
      "accessRole": {
        "description": "Access Role of the Manager for the Module",
        "allOf": [
          {
            "format": "int32",
            "description": "customized user role for IVLE.",
            "enum": [
              1,
              2,
              3,
              4,
              5,
              6
            ],
            "type": "integer"
          }
        ]
      },
      "accessRoleName": {
        "description": "Access Role Name",
        "type": "string"
      },
      "userMatricNo": {
        "description": "User number of the manager",
        "type": "string"
      },
      "userID": {
        "description": "User ID of the manager",
        "type": "string"
      },
      "userName": {
        "description": "Name of the manager",
        "type": "string"
      },
      "email": {
        "description": "Email of the manager",
        "type": "string"
      },
      "title": {
        "description": "Title of the manager",
        "type": "string"
      },
      "department": {
        "description": "Department of the manager",
        "type": "string"
      },
      "phoneNo": {
        "description": "Office contact number of the manager",
        "type": "string"
      },
      "photo": {
        "description": "Photo Path",
        "type": "string"
      },
      "aboutMe": {
        "description": "Write-up about the manager",
        "type": "string"
      },
      "roleID": {
        "format": "uuid",
        "description": "Module Roles. To indicate the role of the manager for the module.",
        "type": "string"
      },
      "moduleRole": {
        "description": "Module Roles. To indicate the role of the manager for the module.",
        "allOf": [
          {
            "format": "int32",
            "description": "Module role for the manager",
            "enum": [
              0,
              1,
              2,
              3,
              4,
              5,
              6,
              7,
              8,
              9,
              10
            ],
            "type": "integer"
          }
        ]
      },
      "roleName": {
        "description": "Text to be displayed for RoleID",
        "type": "string"
      },
      "displayUserPhoto": {
        "description": "True to display photo of the manager",
        "type": "boolean"
      },
      "consultHrs": {
        "description": "Unformatted consultation hours for the manager",
        "type": "string"
      },
      "userGuid": {
        "format": "uuid",
        "description": "GUID of the user for manager",
        "type": "string"
      },
      "imported": {
        "description": "True if the manager is imported from EduRec",
        "type": "boolean"
      },
      "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"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

403 Forbidden

Representations

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

500 Internal Server Error

Server Error

Representations

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Sample
Schema

string

{
  "type": "string"
}

Code samples

@ECHO OFF

curl -v -X GET "https://luminus.azure-api.net/module/{ResourceID}/SearchManager?searchtext={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["searchtext"] = "{string}";
            queryString["sortby"] = "{string}";
            queryString["offset"] = "{integer}";
            queryString["limit"] = "{integer}";
            queryString["where"] = "{string}";
            queryString["populate"] = "{string}";
            var uri = "https://luminus.azure-api.net/module/{ResourceID}/SearchManager?" + 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/module/{ResourceID}/SearchManager");

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

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

$request->setHeader($headers);

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

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

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

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