Library Resources API

API change history

List of APIs related to Library Resources

Update file

Change file information. It is used by user with "LibraryAdmin" role.

Try it

Request

Request URL

https://luminus.azure-api.net/nus_lib/File

Request headers

Content-Type (optional)

string

Media type of the body sent to the API.
Ocp-Apim-Subscription-Key

string

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

Request body

File information

Sample
Schema

{
  "id": "string",
  "name": "string",
  "description": "string",
  "publish": true
}

{
  "description": "HTTP Post Input class when updating file",
  "required": [
    "id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "ID of the File",
      "type": "string"
    },
    "name": {
      "description": "file name as downloaded file name without file extension",
      "maxLength": 200,
      "minLength": 0,
      "type": "string"
    },
    "description": {
      "description": "new file description",
      "type": "string"
    },
    "publish": {
      "description": "whether to publish the file",
      "type": "boolean"
    }
  }
}

Sample
Schema

{
  "id": "string",
  "name": "string",
  "description": "string",
  "publish": true
}

{
  "description": "HTTP Post Input class when updating file",
  "required": [
    "id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "ID of the File",
      "type": "string"
    },
    "name": {
      "description": "file name as downloaded file name without file extension",
      "maxLength": 200,
      "minLength": 0,
      "type": "string"
    },
    "description": {
      "description": "new file description",
      "type": "string"
    },
    "publish": {
      "description": "whether to publish the file",
      "type": "boolean"
    }
  }
}

Sample
Schema

{
  "id": "string",
  "name": "string",
  "description": "string",
  "publish": true
}

{
  "description": "HTTP Post Input class when updating file",
  "required": [
    "id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "ID of the File",
      "type": "string"
    },
    "name": {
      "description": "file name as downloaded file name without file extension",
      "maxLength": 200,
      "minLength": 0,
      "type": "string"
    },
    "description": {
      "description": "new file description",
      "type": "string"
    },
    "publish": {
      "description": "whether to publish the file",
      "type": "boolean"
    }
  }
}

Sample
Schema

{
  "id": "string",
  "name": "string",
  "description": "string",
  "publish": true
}

{
  "description": "HTTP Post Input class when updating file",
  "required": [
    "id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "format": "uuid",
      "description": "ID of the File",
      "type": "string"
    },
    "name": {
      "description": "file name as downloaded file name without file extension",
      "maxLength": 200,
      "minLength": 0,
      "type": "string"
    },
    "description": {
      "description": "new file description",
      "type": "string"
    },
    "publish": {
      "description": "whether to publish the file",
      "type": "boolean"
    }
  }
}

Responses

200 OK

The updated file information

Representations

{
  "description": "the file class, can represent a file or a url uploaded into a folder. It inherites from [contract.Resource.Models.Resource_Content]\r\n<seealso cref=\"T:contract.Resource.Models.Resource_Content\" />",
  "required": [
    "email",
    "userID",
    "userMatricNo",
    "userName"
  ],
  "type": "object",
  "properties": {
    "hasComments": {
      "description": "Indicate whether the file/url has comments. null means has not been checked.",
      "type": "boolean"
    },
    "userID": {
      "description": "the login ID of the user who uploaded this file/url",
      "type": "string"
    },
    "userName": {
      "description": "the name of the user who uploaded this file/url",
      "type": "string"
    },
    "userMatricNo": {
      "description": "the matric number of the user who uploaded this file/url",
      "type": "string"
    },
    "email": {
      "description": "the email of the user who uploaded this file/url",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "the ID of the resource which this content belongs to.",
      "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"
        }
      ]
    }
  }
}

Sample
Schema

{
  "hasComments": true,
  "userID": "string",
  "userName": "string",
  "userMatricNo": "string",
  "email": "string",
  "resourceID": "string",
  "id": "string",
  "createdDate": "string",
  "creatorID": "string",
  "lastUpdatedDate": "string",
  "lastUpdatedBy": "string",
  "lastDeletedDate": "string",
  "lastDeletedBy": "string",
  "name": "string",
  "publish": true,
  "parentID": "string",
  "properties": "string",
  "typeID": {}
}

{
  "description": "the file class, can represent a file or a url uploaded into a folder. It inherites from [contract.Resource.Models.Resource_Content]\r\n<seealso cref=\"T:contract.Resource.Models.Resource_Content\" />",
  "required": [
    "email",
    "userID",
    "userMatricNo",
    "userName"
  ],
  "type": "object",
  "properties": {
    "hasComments": {
      "description": "Indicate whether the file/url has comments. null means has not been checked.",
      "type": "boolean"
    },
    "userID": {
      "description": "the login ID of the user who uploaded this file/url",
      "type": "string"
    },
    "userName": {
      "description": "the name of the user who uploaded this file/url",
      "type": "string"
    },
    "userMatricNo": {
      "description": "the matric number of the user who uploaded this file/url",
      "type": "string"
    },
    "email": {
      "description": "the email of the user who uploaded this file/url",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "the ID of the resource which this content belongs to.",
      "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"
        }
      ]
    }
  }
}

Sample
Schema

{
  "hasComments": true,
  "userID": "string",
  "userName": "string",
  "userMatricNo": "string",
  "email": "string",
  "resourceID": "string",
  "id": "string",
  "createdDate": "string",
  "creatorID": "string",
  "lastUpdatedDate": "string",
  "lastUpdatedBy": "string",
  "lastDeletedDate": "string",
  "lastDeletedBy": "string",
  "name": "string",
  "publish": true,
  "parentID": "string",
  "properties": "string",
  "typeID": {}
}

{
  "description": "the file class, can represent a file or a url uploaded into a folder. It inherites from [contract.Resource.Models.Resource_Content]\r\n<seealso cref=\"T:contract.Resource.Models.Resource_Content\" />",
  "required": [
    "email",
    "userID",
    "userMatricNo",
    "userName"
  ],
  "type": "object",
  "properties": {
    "hasComments": {
      "description": "Indicate whether the file/url has comments. null means has not been checked.",
      "type": "boolean"
    },
    "userID": {
      "description": "the login ID of the user who uploaded this file/url",
      "type": "string"
    },
    "userName": {
      "description": "the name of the user who uploaded this file/url",
      "type": "string"
    },
    "userMatricNo": {
      "description": "the matric number of the user who uploaded this file/url",
      "type": "string"
    },
    "email": {
      "description": "the email of the user who uploaded this file/url",
      "type": "string"
    },
    "resourceID": {
      "format": "uuid",
      "description": "the ID of the resource which this content belongs to.",
      "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"
}

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 PUT "https://luminus.azure-api.net/nus_lib/File"
-H "Content-Type: application/json-patch+json"
-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}");

            var uri = "https://luminus.azure-api.net/nus_lib/File?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}

// // 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/nus_lib/File");


            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("Content-Type", "application/json-patch+json");
            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
        };
      
        $.ajax({
            url: "https://luminus.azure-api.net/nus_lib/File?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // 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/nus_lib/File";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // Request headers
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_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/nus_lib/File');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

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

// 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
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('luminus.azure-api.net')
    conn.request("PUT", "/nus_lib/File?%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
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

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


request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# 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