Files API

API change history

List of APIs related to folders which contain files

Get files which user has not downloaded

Get list of file records which user has not downloaded.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    Format - uuid. The module ID which containing the folders

  • (optional)
    string

    Accepted populate entities: Creator, lastUpdatedUser.

  • (optional)
    string
  • (optional)
    integer

    Format - int32.

  • (optional)
    integer

    Format - int32.

  • (optional)
    string

Request headers

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

Request body

Responses

200 OK

Returns list of file information which user has not downloaded

Representations

{
  "type": "array",
  "items": {
    "description": "returned file information or weblink information",
    "required": [
      "description",
      "fileFormat",
      "fileName",
      "fileSize",
      "url"
    ],
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "identifier",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "the parent ID if any.  For those contents which is the first level under the resource. the parent ID value will be the same as the ID.",
        "type": "string"
      },
      "resourceID": {
        "format": "uuid",
        "description": "the folder ID  or tool ID which contains this file or url",
        "type": "string"
      },
      "publish": {
        "description": "the publish flag which determine whether the record is published to students.",
        "type": "boolean"
      },
      "name": {
        "description": "the name of the url or the file",
        "type": "string"
      },
      "url": {
        "description": "url address",
        "type": "string"
      },
      "description": {
        "description": "file description or url description",
        "type": "string"
      },
      "isCompulsory": {
        "description": "flag to indicate whether the file/url is a compulsory material",
        "type": "boolean"
      },
      "allowDownload": {
        "description": "indicate whether user can download the file. used in multimedia and lib admin",
        "type": "boolean"
      },
      "fileSize": {
        "format": "double",
        "description": "file size in bytes",
        "type": "number"
      },
      "fileFormat": {
        "description": "type of record, value could be: File, Audio, Video,Weblink",
        "type": "string"
      },
      "fileName": {
        "description": "the actual file name",
        "type": "string"
      },
      "hasComments": {
        "description": "indicate whether there are comments made on this file",
        "type": "boolean"
      },
      "streamUrlPath": {
        "description": "used for audio and video",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "the ID of the user who created this record",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date this record is created",
        "type": "string"
      },
      "creatorName": {
        "description": "The name of the user who created the record",
        "type": "string"
      },
      "creatorUserID": {
        "description": "The user ID of the user who created the record",
        "type": "string"
      },
      "creatorEmail": {
        "description": "The email address of the user who created the record",
        "type": "string"
      },
      "creatorMatricNo": {
        "description": "The Matric Number or Student Number of the user who created the 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"
      },
      "lastUpdatedByName": {
        "description": "The name of the user who last updated the record",
        "type": "string"
      },
      "lastUpdatedByUserID": {
        "description": "The user ID of the user who last updated the record",
        "type": "string"
      },
      "lastUpdatedByEmail": {
        "description": "The email address of the user who last updated the record",
        "type": "string"
      },
      "lastUpdatedByMatricNo": {
        "description": "The Matric Number or Student Number of the user who last updated the record",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "parentID": "string",
    "resourceID": "string",
    "publish": true,
    "name": "string",
    "url": "string",
    "description": "string",
    "isCompulsory": true,
    "allowDownload": true,
    "fileSize": 0.0,
    "fileFormat": "string",
    "fileName": "string",
    "hasComments": true,
    "streamUrlPath": "string",
    "creatorID": "string",
    "createdDate": "string",
    "creatorName": "string",
    "creatorUserID": "string",
    "creatorEmail": "string",
    "creatorMatricNo": "string",
    "lastUpdatedDate": "string",
    "lastUpdatedBy": "string",
    "lastUpdatedByName": "string",
    "lastUpdatedByUserID": "string",
    "lastUpdatedByEmail": "string",
    "lastUpdatedByMatricNo": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "returned file information or weblink information",
    "required": [
      "description",
      "fileFormat",
      "fileName",
      "fileSize",
      "url"
    ],
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "identifier",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "the parent ID if any.  For those contents which is the first level under the resource. the parent ID value will be the same as the ID.",
        "type": "string"
      },
      "resourceID": {
        "format": "uuid",
        "description": "the folder ID  or tool ID which contains this file or url",
        "type": "string"
      },
      "publish": {
        "description": "the publish flag which determine whether the record is published to students.",
        "type": "boolean"
      },
      "name": {
        "description": "the name of the url or the file",
        "type": "string"
      },
      "url": {
        "description": "url address",
        "type": "string"
      },
      "description": {
        "description": "file description or url description",
        "type": "string"
      },
      "isCompulsory": {
        "description": "flag to indicate whether the file/url is a compulsory material",
        "type": "boolean"
      },
      "allowDownload": {
        "description": "indicate whether user can download the file. used in multimedia and lib admin",
        "type": "boolean"
      },
      "fileSize": {
        "format": "double",
        "description": "file size in bytes",
        "type": "number"
      },
      "fileFormat": {
        "description": "type of record, value could be: File, Audio, Video,Weblink",
        "type": "string"
      },
      "fileName": {
        "description": "the actual file name",
        "type": "string"
      },
      "hasComments": {
        "description": "indicate whether there are comments made on this file",
        "type": "boolean"
      },
      "streamUrlPath": {
        "description": "used for audio and video",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "the ID of the user who created this record",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date this record is created",
        "type": "string"
      },
      "creatorName": {
        "description": "The name of the user who created the record",
        "type": "string"
      },
      "creatorUserID": {
        "description": "The user ID of the user who created the record",
        "type": "string"
      },
      "creatorEmail": {
        "description": "The email address of the user who created the record",
        "type": "string"
      },
      "creatorMatricNo": {
        "description": "The Matric Number or Student Number of the user who created the 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"
      },
      "lastUpdatedByName": {
        "description": "The name of the user who last updated the record",
        "type": "string"
      },
      "lastUpdatedByUserID": {
        "description": "The user ID of the user who last updated the record",
        "type": "string"
      },
      "lastUpdatedByEmail": {
        "description": "The email address of the user who last updated the record",
        "type": "string"
      },
      "lastUpdatedByMatricNo": {
        "description": "The Matric Number or Student Number of the user who last updated the record",
        "type": "string"
      }
    }
  }
}
[
  {
    "id": "string",
    "parentID": "string",
    "resourceID": "string",
    "publish": true,
    "name": "string",
    "url": "string",
    "description": "string",
    "isCompulsory": true,
    "allowDownload": true,
    "fileSize": 0.0,
    "fileFormat": "string",
    "fileName": "string",
    "hasComments": true,
    "streamUrlPath": "string",
    "creatorID": "string",
    "createdDate": "string",
    "creatorName": "string",
    "creatorUserID": "string",
    "creatorEmail": "string",
    "creatorMatricNo": "string",
    "lastUpdatedDate": "string",
    "lastUpdatedBy": "string",
    "lastUpdatedByName": "string",
    "lastUpdatedByUserID": "string",
    "lastUpdatedByEmail": "string",
    "lastUpdatedByMatricNo": "string"
  }
]
{
  "type": "array",
  "items": {
    "description": "returned file information or weblink information",
    "required": [
      "description",
      "fileFormat",
      "fileName",
      "fileSize",
      "url"
    ],
    "type": "object",
    "properties": {
      "id": {
        "format": "uuid",
        "description": "identifier",
        "type": "string"
      },
      "parentID": {
        "format": "uuid",
        "description": "the parent ID if any.  For those contents which is the first level under the resource. the parent ID value will be the same as the ID.",
        "type": "string"
      },
      "resourceID": {
        "format": "uuid",
        "description": "the folder ID  or tool ID which contains this file or url",
        "type": "string"
      },
      "publish": {
        "description": "the publish flag which determine whether the record is published to students.",
        "type": "boolean"
      },
      "name": {
        "description": "the name of the url or the file",
        "type": "string"
      },
      "url": {
        "description": "url address",
        "type": "string"
      },
      "description": {
        "description": "file description or url description",
        "type": "string"
      },
      "isCompulsory": {
        "description": "flag to indicate whether the file/url is a compulsory material",
        "type": "boolean"
      },
      "allowDownload": {
        "description": "indicate whether user can download the file. used in multimedia and lib admin",
        "type": "boolean"
      },
      "fileSize": {
        "format": "double",
        "description": "file size in bytes",
        "type": "number"
      },
      "fileFormat": {
        "description": "type of record, value could be: File, Audio, Video,Weblink",
        "type": "string"
      },
      "fileName": {
        "description": "the actual file name",
        "type": "string"
      },
      "hasComments": {
        "description": "indicate whether there are comments made on this file",
        "type": "boolean"
      },
      "streamUrlPath": {
        "description": "used for audio and video",
        "type": "string"
      },
      "creatorID": {
        "format": "uuid",
        "description": "the ID of the user who created this record",
        "type": "string"
      },
      "createdDate": {
        "format": "date-time",
        "description": "The date this record is created",
        "type": "string"
      },
      "creatorName": {
        "description": "The name of the user who created the record",
        "type": "string"
      },
      "creatorUserID": {
        "description": "The user ID of the user who created the record",
        "type": "string"
      },
      "creatorEmail": {
        "description": "The email address of the user who created the record",
        "type": "string"
      },
      "creatorMatricNo": {
        "description": "The Matric Number or Student Number of the user who created the 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"
      },
      "lastUpdatedByName": {
        "description": "The name of the user who last updated the record",
        "type": "string"
      },
      "lastUpdatedByUserID": {
        "description": "The user ID of the user who last updated the record",
        "type": "string"
      },
      "lastUpdatedByEmail": {
        "description": "The email address of the user who last updated the record",
        "type": "string"
      },
      "lastUpdatedByMatricNo": {
        "description": "The Matric Number or Student Number of the user who last updated the record",
        "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"
}

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/files/notdownloaded?ParentID={string}&populate={string}&sortby={string}&offset={integer}&limit={integer}&where={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

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

            builder.setParameter("ParentID", "{string}");
            builder.setParameter("populate", "{string}");
            builder.setParameter("sortby", "{string}");
            builder.setParameter("offset", "{integer}");
            builder.setParameter("limit", "{integer}");
            builder.setParameter("where", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "ParentID": "{string}",
            "populate": "{string}",
            "sortby": "{string}",
            "offset": "{integer}",
            "limit": "{integer}",
            "where": "{string}",
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/files/notdownloaded?" + $.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/files/notdownloaded";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"ParentID={string}",
                         @"populate={string}",
                         @"sortby={string}",
                         @"offset={integer}",
                         @"limit={integer}",
                         @"where={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://luminus.azure-api.net/files/notdownloaded');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'ParentID' => '{string}',
    'populate' => '{string}',
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'ParentID': '{string}',
    'populate': '{string}',
    'sortby': '{string}',
    'offset': '{integer}',
    'limit': '{integer}',
    'where': '{string}',
})

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

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

query = URI.encode_www_form({
    # Request parameters
    'ParentID' => '{string}',
    'populate' => '{string}',
    'sortby' => '{string}',
    'offset' => '{integer}',
    'limit' => '{integer}',
    'where' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body