Customer API V1.0
API change historyRequest
Request URL
Request parameters
-
(optional)array
Parameter available for BSI or Partner and responsible for filtering data per specific customers.
-
(optional)integer
Format - int32. Paramater defines the offset of items to be displayed.
-
(optional)integer
Format - int32. Paramater defines the number of items to be displayed on one page.
Request headers
-
(optional)string
Customer API Key generated in Admin Portal
Request body
Responses
200 OK
OK
Representations
{
"records": [
{
"userId": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"roles": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string"
}
],
"groups": [
{
"id": 0,
"name": "string"
}
],
"licenseIssued": true,
"jobTitle": "string",
"department": "string",
"country": "string",
"sso": {
"userId": "string",
"company": "string",
"location": "string",
"platform": "string",
"customFields": [
{
"name": "string",
"value": "string"
}
]
}
}
],
"totalCount": 0,
"page": 0,
"pageSize": 0
}{
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"name": {
"type": "string"
}
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
}
}
}
},
"licenseIssued": {
"type": "boolean"
},
"jobTitle": {
"type": "string"
},
"department": {
"type": "string"
},
"country": {
"type": "string"
},
"sso": {
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"company": {
"type": "string"
},
"location": {
"type": "string"
},
"platform": {
"type": "string"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
}
},
"readOnly": true
},
"totalCount": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"page": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"pageSize": {
"format": "int32",
"type": "integer",
"readOnly": true
}
}
}{
"records": [
{
"userId": 0,
"firstName": "string",
"lastName": "string",
"email": "string",
"roles": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string"
}
],
"groups": [
{
"id": 0,
"name": "string"
}
],
"licenseIssued": true,
"jobTitle": "string",
"department": "string",
"country": "string",
"sso": {
"userId": "string",
"company": "string",
"location": "string",
"platform": "string",
"customFields": [
{
"name": "string",
"value": "string"
}
]
}
}
],
"totalCount": 0,
"page": 0,
"pageSize": 0
}{
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"name": {
"type": "string"
}
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
}
}
}
},
"licenseIssued": {
"type": "boolean"
},
"jobTitle": {
"type": "string"
},
"department": {
"type": "string"
},
"country": {
"type": "string"
},
"sso": {
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"company": {
"type": "string"
},
"location": {
"type": "string"
},
"platform": {
"type": "string"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
}
},
"readOnly": true
},
"totalCount": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"page": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"pageSize": {
"format": "int32",
"type": "integer",
"readOnly": true
}
}
}<PageDto_x005B_UserDto_x005D_>
<records>
<userId>0</userId>
<firstName>string</firstName>
<lastName>string</lastName>
<email>string</email>
<roles>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
</roles>
<groups>
<id>0</id>
<name>string</name>
</groups>
<licenseIssued>true</licenseIssued>
<jobTitle>string</jobTitle>
<department>string</department>
<country>string</country>
<sso>
<userId>string</userId>
<company>string</company>
<location>string</location>
<platform>string</platform>
<customFields>
<name>string</name>
<value>string</value>
</customFields>
</sso>
</records>
<totalCount>0</totalCount>
<page>0</page>
<pageSize>0</pageSize>
</PageDto_x005B_UserDto_x005D_>{
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"name": {
"type": "string"
}
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
}
}
}
},
"licenseIssued": {
"type": "boolean"
},
"jobTitle": {
"type": "string"
},
"department": {
"type": "string"
},
"country": {
"type": "string"
},
"sso": {
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"company": {
"type": "string"
},
"location": {
"type": "string"
},
"platform": {
"type": "string"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
}
},
"readOnly": true
},
"totalCount": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"page": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"pageSize": {
"format": "int32",
"type": "integer",
"readOnly": true
}
}
}<PageDto_x005B_UserDto_x005D_>
<records>
<userId>0</userId>
<firstName>string</firstName>
<lastName>string</lastName>
<email>string</email>
<roles>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
</roles>
<groups>
<id>0</id>
<name>string</name>
</groups>
<licenseIssued>true</licenseIssued>
<jobTitle>string</jobTitle>
<department>string</department>
<country>string</country>
<sso>
<userId>string</userId>
<company>string</company>
<location>string</location>
<platform>string</platform>
<customFields>
<name>string</name>
<value>string</value>
</customFields>
</sso>
</records>
<totalCount>0</totalCount>
<page>0</page>
<pageSize>0</pageSize>
</PageDto_x005B_UserDto_x005D_>{
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"format": "int32",
"type": "integer"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"example": "00000000-0000-0000-0000-000000000000"
},
"name": {
"type": "string"
}
}
}
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
}
}
}
},
"licenseIssued": {
"type": "boolean"
},
"jobTitle": {
"type": "string"
},
"department": {
"type": "string"
},
"country": {
"type": "string"
},
"sso": {
"type": "object",
"properties": {
"userId": {
"type": "string"
},
"company": {
"type": "string"
},
"location": {
"type": "string"
},
"platform": {
"type": "string"
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
}
},
"readOnly": true
},
"totalCount": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"page": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"pageSize": {
"format": "int32",
"type": "integer",
"readOnly": true
}
}
}Code samples
@ECHO OFF
curl -v -X GET "https://qhapi.quickhelp.com/v1/User/List?customerIds={array}&page={integer}&pageSize={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["customerIds"] = "{array}";
queryString["page"] = "{integer}";
queryString["pageSize"] = "{integer}";
var uri = "https://qhapi.quickhelp.com/v1/User/List?" + 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/List");
builder.setParameter("customerIds", "{array}");
builder.setParameter("page", "{integer}");
builder.setParameter("pageSize", "{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
"customerIds": "{array}",
"page": "{integer}",
"pageSize": "{integer}",
};
$.ajax({
url: "https://qhapi.quickhelp.com/v1/User/List?" + $.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/List";
NSArray* array = @[
// Request parameters
@"entities=true",
@"customerIds={array}",
@"page={integer}",
@"pageSize={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/List');
$url = $request->getUrl();
$headers = array(
// Request headers
'Authorization' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'customerIds' => '{array}',
'page' => '{integer}',
'pageSize' => '{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
'customerIds': '{array}',
'page': '{integer}',
'pageSize': '{integer}',
})
try:
conn = httplib.HTTPSConnection('qhapi.quickhelp.com')
conn.request("GET", "/v1/User/List?%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
'customerIds': '{array}',
'page': '{integer}',
'pageSize': '{integer}',
})
try:
conn = http.client.HTTPSConnection('qhapi.quickhelp.com')
conn.request("GET", "/v1/User/List?%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/List')
query = URI.encode_www_form({
# Request parameters
'customerIds' => '{array}',
'page' => '{integer}',
'pageSize' => '{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