General API
API change historyList of APIs related to general purposes
Add page hit Logs for geNiUS
Log the page hits when user click from LumiNUS to geNiUS website.
Try itRequest
Request URL
Request headers
-
(optional)stringMedia type of the body sent to the API.
Request body
{
"clickFrom": "string",
"rootID": "string",
"resourceID": "string",
"url": "string"
}
{
"description": "The class which is used to log a page hit activity for geNiUS",
"required": [
"clickFrom",
"url"
],
"type": "object",
"properties": {
"clickFrom": {
"description": "Source where the geNiUS website is clicked from LumiNUS. \"geNiUS_geNiUSworld\", \"geNiUS_PopBanner\" or \"geNiUS_geNiUSworldTab\".",
"type": "string"
},
"rootID": {
"format": "uuid",
"description": "The root id - module id",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "The resource id",
"type": "string"
},
"url": {
"description": "The url of the request",
"type": "string"
}
}
}
{
"clickFrom": "string",
"rootID": "string",
"resourceID": "string",
"url": "string"
}
{
"description": "The class which is used to log a page hit activity for geNiUS",
"required": [
"clickFrom",
"url"
],
"type": "object",
"properties": {
"clickFrom": {
"description": "Source where the geNiUS website is clicked from LumiNUS. \"geNiUS_geNiUSworld\", \"geNiUS_PopBanner\" or \"geNiUS_geNiUSworldTab\".",
"type": "string"
},
"rootID": {
"format": "uuid",
"description": "The root id - module id",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "The resource id",
"type": "string"
},
"url": {
"description": "The url of the request",
"type": "string"
}
}
}
{
"clickFrom": "string",
"rootID": "string",
"resourceID": "string",
"url": "string"
}
{
"description": "The class which is used to log a page hit activity for geNiUS",
"required": [
"clickFrom",
"url"
],
"type": "object",
"properties": {
"clickFrom": {
"description": "Source where the geNiUS website is clicked from LumiNUS. \"geNiUS_geNiUSworld\", \"geNiUS_PopBanner\" or \"geNiUS_geNiUSworldTab\".",
"type": "string"
},
"rootID": {
"format": "uuid",
"description": "The root id - module id",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "The resource id",
"type": "string"
},
"url": {
"description": "The url of the request",
"type": "string"
}
}
}
{
"clickFrom": "string",
"rootID": "string",
"resourceID": "string",
"url": "string"
}
{
"description": "The class which is used to log a page hit activity for geNiUS",
"required": [
"clickFrom",
"url"
],
"type": "object",
"properties": {
"clickFrom": {
"description": "Source where the geNiUS website is clicked from LumiNUS. \"geNiUS_geNiUSworld\", \"geNiUS_PopBanner\" or \"geNiUS_geNiUSworldTab\".",
"type": "string"
},
"rootID": {
"format": "uuid",
"description": "The root id - module id",
"type": "string"
},
"resourceID": {
"format": "uuid",
"description": "The resource id",
"type": "string"
},
"url": {
"description": "The url of the request",
"type": "string"
}
}
}
Responses
400 Bad Request
Bad Request
Representations
{
"type": "string"
}
string
{
"type": "string"
}
string
{
"type": "string"
}
403 Forbidden
Forbidden
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"
}
200 OK
success or error message
Representations
Code samples
@ECHO OFF
curl -v -X POST "https://luminus.azure-api.net/resource/PageHitGeNiUS"
-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/resource/PageHitGeNiUS?" + 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.PostAsync(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/resource/PageHitGeNiUS");
URI uri = builder.build();
HttpPost request = new HttpPost(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/resource/PageHitGeNiUS?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// 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/resource/PageHitGeNiUS";
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:@"POST"];
// 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/resource/PageHitGeNiUS');
$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_POST);
// 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("POST", "/resource/PageHitGeNiUS?%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("POST", "/resource/PageHitGeNiUS?%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/resource/PageHitGeNiUS')
request = Net::HTTP::Post.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