Multimedia API
API change historyList of APIs related to Multimedia
Export media logs
Export number of views of media by mediaID to Excel.
Caller must have creator rights to media.
Request
Request URL
Request parameters
-
string
Format - uuid. ID of media
-
(optional)string
Format - date-time (as date-time in RFC3339). start date of logs
-
(optional)string
Format - date-time (as date-time in RFC3339). end date of logs
Request headers
Request body
Responses
200 OK
Return the viewing records
Representations
{
"description": "Logs for the Media Hits content",
"type": "object",
"properties": {
"title": {
"description": "Media Title",
"type": "string"
},
"logDate": {
"format": "date-time",
"description": "Date of the media is viewed",
"type": "string"
},
"userID": {
"description": "User ID of the viewer",
"type": "string"
},
"name": {
"description": "Name of the viewer",
"type": "string"
},
"email": {
"description": "Email of the viewer",
"type": "string"
},
"department": {
"description": "Department/Faculty of the viewer",
"type": "string"
}
}
}
{
"title": "string",
"logDate": "string",
"userID": "string",
"name": "string",
"email": "string",
"department": "string"
}
{
"description": "Logs for the Media Hits content",
"type": "object",
"properties": {
"title": {
"description": "Media Title",
"type": "string"
},
"logDate": {
"format": "date-time",
"description": "Date of the media is viewed",
"type": "string"
},
"userID": {
"description": "User ID of the viewer",
"type": "string"
},
"name": {
"description": "Name of the viewer",
"type": "string"
},
"email": {
"description": "Email of the viewer",
"type": "string"
},
"department": {
"description": "Department/Faculty of the viewer",
"type": "string"
}
}
}
{
"title": "string",
"logDate": "string",
"userID": "string",
"name": "string",
"email": "string",
"department": "string"
}
{
"description": "Logs for the Media Hits content",
"type": "object",
"properties": {
"title": {
"description": "Media Title",
"type": "string"
},
"logDate": {
"format": "date-time",
"description": "Date of the media is viewed",
"type": "string"
},
"userID": {
"description": "User ID of the viewer",
"type": "string"
},
"name": {
"description": "Name of the viewer",
"type": "string"
},
"email": {
"description": "Email of the viewer",
"type": "string"
},
"department": {
"description": "Department/Faculty of the viewer",
"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/multimedia/{id}/exportmedialog?startDate={string}&endDate={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["startDate"] = "{string}";
queryString["endDate"] = "{string}";
var uri = "https://luminus.azure-api.net/multimedia/{id}/exportmedialog?" + 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/multimedia/{id}/exportmedialog");
builder.setParameter("startDate", "{string}");
builder.setParameter("endDate", "{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
"startDate": "{string}",
"endDate": "{string}",
};
$.ajax({
url: "https://luminus.azure-api.net/multimedia/{id}/exportmedialog?" + $.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/multimedia/{id}/exportmedialog";
NSArray* array = @[
// Request parameters
@"entities=true",
@"startDate={string}",
@"endDate={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/multimedia/{id}/exportmedialog');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'startDate' => '{string}',
'endDate' => '{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
'startDate': '{string}',
'endDate': '{string}',
})
try:
conn = httplib.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/multimedia/{id}/exportmedialog?%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
'startDate': '{string}',
'endDate': '{string}',
})
try:
conn = http.client.HTTPSConnection('luminus.azure-api.net')
conn.request("GET", "/multimedia/{id}/exportmedialog?%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/multimedia/{id}/exportmedialog')
query = URI.encode_www_form({
# Request parameters
'startDate' => '{string}',
'endDate' => '{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