Customer API V1.0
API change historyRequest
Request URL
Request parameters
-
(optional)integer
Format - int32. Parameter responsible for filtering data per specific user.
-
(optional)string
Parameter responsible for filtering data per specific email.
-
(optional)string
Parameter responsible for filtering data per specific user role.
-
(optional)string
Parameter responsible for filtering data per specific group.
-
(optional)string
Parameter responsible for filtering data per specific department.
-
(optional)string
Parameter responsible for filtering data per specific job title.
-
(optional)string
Limits users history to specific country.
-
(optional)string
Limits users history based on SSO attribute.
-
(optional)string
Format - date-time (as date-time in RFC3339). Parameter responsible for filtering data by time range start in format "MM/dd/yyyy".
-
(optional)string
Format - date-time (as date-time in RFC3339). Parameter responsible for filtering data by time range end in format "MM/dd/yyyy".
-
(optional)integer
Format - int32. Parameter available for BSI or Partner and responsible for filtering data per specific customer.
Request headers
-
(optional)string
Customer API Key generated in Admin Portal
Request body
Responses
200 OK
OK
Representations
{}
{
"type": "object"
}
{}
{
"type": "object"
}
<UserHistoryGet200ApplicationXmlResponse />
{
"type": "object"
}
<UserHistoryGet200TextXmlResponse />
{
"type": "object"
}
400 Bad Request
BadRequest
Representations
{}
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"attemptedValue": {
"type": "string",
"readOnly": true
},
"culture": {
"type": "string",
"readOnly": true
},
"rawValue": {
"type": "object",
"readOnly": true
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exception": {
"type": "object",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
}
}
}
}
{}
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"attemptedValue": {
"type": "string",
"readOnly": true
},
"culture": {
"type": "string",
"readOnly": true
},
"rawValue": {
"type": "object",
"readOnly": true
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exception": {
"type": "object",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
}
}
}
}
<UserHistoryGet400ApplicationXmlResponse />
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"attemptedValue": {
"type": "string",
"readOnly": true
},
"culture": {
"type": "string",
"readOnly": true
},
"rawValue": {
"type": "object",
"readOnly": true
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exception": {
"type": "object",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
}
}
}
}
<UserHistoryGet400TextXmlResponse />
{
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"value": {
"type": "object",
"properties": {
"attemptedValue": {
"type": "string",
"readOnly": true
},
"culture": {
"type": "string",
"readOnly": true
},
"rawValue": {
"type": "object",
"readOnly": true
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"exception": {
"type": "object",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
}
}
}
}
Code samples
@ECHO OFF
curl -v -X GET "https://qhapi.quickhelp.com/v1/User/History?userId={integer}&email={string}&role={string}&group={string}&department={string}&jobTitle={string}&country={string}&ssoAttribute={string}&fromDate={string}&toDate={string}&customerId={integer}"
-H "Authorization: "
-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("Authorization", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["userId"] = "{integer}";
queryString["email"] = "{string}";
queryString["role"] = "{string}";
queryString["group"] = "{string}";
queryString["department"] = "{string}";
queryString["jobTitle"] = "{string}";
queryString["country"] = "{string}";
queryString["ssoAttribute"] = "{string}";
queryString["fromDate"] = "{string}";
queryString["toDate"] = "{string}";
queryString["customerId"] = "{integer}";
var uri = "https://qhapi.quickhelp.com/v1/User/History?" + 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://qhapi.quickhelp.com/v1/User/History");
builder.setParameter("userId", "{integer}");
builder.setParameter("email", "{string}");
builder.setParameter("role", "{string}");
builder.setParameter("group", "{string}");
builder.setParameter("department", "{string}");
builder.setParameter("jobTitle", "{string}");
builder.setParameter("country", "{string}");
builder.setParameter("ssoAttribute", "{string}");
builder.setParameter("fromDate", "{string}");
builder.setParameter("toDate", "{string}");
builder.setParameter("customerId", "{integer}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Authorization", "");
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
"userId": "{integer}",
"email": "{string}",
"role": "{string}",
"group": "{string}",
"department": "{string}",
"jobTitle": "{string}",
"country": "{string}",
"ssoAttribute": "{string}",
"fromDate": "{string}",
"toDate": "{string}",
"customerId": "{integer}",
};
$.ajax({
url: "https://qhapi.quickhelp.com/v1/User/History?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Authorization","");
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://qhapi.quickhelp.com/v1/User/History";
NSArray* array = @[
// Request parameters
@"entities=true",
@"userId={integer}",
@"email={string}",
@"role={string}",
@"group={string}",
@"department={string}",
@"jobTitle={string}",
@"country={string}",
@"ssoAttribute={string}",
@"fromDate={string}",
@"toDate={string}",
@"customerId={integer}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_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://qhapi.quickhelp.com/v1/User/History');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'userId' => '{integer}',
'email' => '{string}',
'role' => '{string}',
'group' => '{string}',
'department' => '{string}',
'jobTitle' => '{string}',
'country' => '{string}',
'ssoAttribute' => '{string}',
'fromDate' => '{string}',
'toDate' => '{string}',
'customerId' => '{integer}',
);
$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
'Authorization': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'userId': '{integer}',
'email': '{string}',
'role': '{string}',
'group': '{string}',
'department': '{string}',
'jobTitle': '{string}',
'country': '{string}',
'ssoAttribute': '{string}',
'fromDate': '{string}',
'toDate': '{string}',
'customerId': '{integer}',
})
try:
conn = httplib.HTTPSConnection('qhapi.quickhelp.com')
conn.request("GET", "/v1/User/History?%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
'Authorization': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'userId': '{integer}',
'email': '{string}',
'role': '{string}',
'group': '{string}',
'department': '{string}',
'jobTitle': '{string}',
'country': '{string}',
'ssoAttribute': '{string}',
'fromDate': '{string}',
'toDate': '{string}',
'customerId': '{integer}',
})
try:
conn = http.client.HTTPSConnection('qhapi.quickhelp.com')
conn.request("GET", "/v1/User/History?%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://qhapi.quickhelp.com/v1/User/History')
query = URI.encode_www_form({
# Request parameters
'userId' => '{integer}',
'email' => '{string}',
'role' => '{string}',
'group' => '{string}',
'department' => '{string}',
'jobTitle' => '{string}',
'country' => '{string}',
'ssoAttribute' => '{string}',
'fromDate' => '{string}',
'toDate' => '{string}',
'customerId' => '{integer}'
})
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['Authorization'] = ''
# 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