Kazi Identifying API
API change historyThis document describes the Identifying API specifications of Kazi
Get talent scans for account of current connected client
Get talent scans for account of current connected client
Try itRequest
Request URL
Request parameters
-
(optional)string
The unique reference of the talent scan at the account side
-
(optional)boolean
Whether talent scan should have expectations or not
-
(optional)boolean
Whether the returning talent scans should include expectations or not
-
(optional)string
A comma separated list of team role expectation ids to filter on
-
(optional)string
A comma separated list of work value expectation ids
-
(optional)integer
Format - int32. The offset used for pagination
-
(optional)integer
Format - int32. The number of records to return. Standard set to 100
-
(optional)string
The fields to order by, comma separated
-
(optional)string
The search string that is used to search on contact name, contact email, title and employer.
-
(optional)string
A comma separated list of domain ids
Request headers
-
stringOAuth 2.0 access token obtained from Trusted Client Credentials grant. Supported grant types: Client credentials.
Request body
Responses
400 Bad Request
Bad Request
Representations
200 OK
Returns a list of talent scans for the current identified account
Representations
[
{
"clientId": "string",
"createdOn": "string",
"expectations": [
{
"expectationId": "string",
"score": 0.0,
"outDated": true,
"rank": 0,
"reportRank": 0
}
],
"id": "string",
"atsClientId": "string",
"clusterIds": [
"string"
],
"domainIds": [
"string"
],
"email": "string",
"externalRef": "string",
"firstName": "string",
"lastName": "string",
"nationality": "string",
"phone": "string",
"schoolIds": [
"string"
]
}
]
{
"type": "array",
"items": {
"type": "object",
"properties": {
"clientId": {
"type": "string",
"format": "uuid"
},
"createdOn": {
"type": "string",
"format": "date-time"
},
"expectations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"expectationId": {
"type": "string",
"format": "uuid"
},
"score": {
"type": "number",
"format": "double"
},
"outDated": {
"type": "boolean"
},
"rank": {
"type": "integer",
"format": "int32",
"nullable": true
},
"reportRank": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"nullable": true
},
"id": {
"type": "string",
"format": "uuid"
},
"atsClientId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"clusterIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"domainIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"externalRef": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"nationality": {
"type": "string",
"nullable": true
},
"phone": {
"type": "string",
"nullable": true
},
"schoolIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"nullable": true
}
},
"additionalProperties": false
},
"x-apim-inline": true
}
Code samples
@ECHO OFF
curl -v -X GET "https://test.api.kazi.be/identifying/v2/talentscans?externalRef={string}&shouldHaveExpectations={boolean}&includeExpectations={boolean}&teamRoleIds={string}&workValueIds={string}&offset=0&count=100&sort={string}&search={string}&domainIds={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
-H "Authorization: {access token}"
--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}");
client.DefaultRequestHeaders.Add("Authorization", "{access token}");
// Request parameters
queryString["externalRef"] = "{string}";
queryString["shouldHaveExpectations"] = "{boolean}";
queryString["includeExpectations"] = "{boolean}";
queryString["teamRoleIds"] = "{string}";
queryString["workValueIds"] = "{string}";
queryString["offset"] = "0";
queryString["count"] = "100";
queryString["sort"] = "{string}";
queryString["search"] = "{string}";
queryString["domainIds"] = "{string}";
var uri = "https://test.api.kazi.be/identifying/v2/talentscans?" + 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://test.api.kazi.be/identifying/v2/talentscans");
builder.setParameter("externalRef", "{string}");
builder.setParameter("shouldHaveExpectations", "{boolean}");
builder.setParameter("includeExpectations", "{boolean}");
builder.setParameter("teamRoleIds", "{string}");
builder.setParameter("workValueIds", "{string}");
builder.setParameter("offset", "0");
builder.setParameter("count", "100");
builder.setParameter("sort", "{string}");
builder.setParameter("search", "{string}");
builder.setParameter("domainIds", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
request.setHeader("Authorization", "{access token}");
// 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
"externalRef": "{string}",
"shouldHaveExpectations": "{boolean}",
"includeExpectations": "{boolean}",
"teamRoleIds": "{string}",
"workValueIds": "{string}",
"offset": "0",
"count": "100",
"sort": "{string}",
"search": "{string}",
"domainIds": "{string}",
};
$.ajax({
url: "https://test.api.kazi.be/identifying/v2/talentscans?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
xhrObj.setRequestHeader("Authorization","{access token}");
},
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://test.api.kazi.be/identifying/v2/talentscans";
NSArray* array = @[
// Request parameters
@"entities=true",
@"externalRef={string}",
@"shouldHaveExpectations={boolean}",
@"includeExpectations={boolean}",
@"teamRoleIds={string}",
@"workValueIds={string}",
@"offset=0",
@"count=100",
@"sort={string}",
@"search={string}",
@"domainIds={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 setValue:@"{access token}" forHTTPHeaderField:@"Authorization"];
// 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://test.api.kazi.be/identifying/v2/talentscans');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
'Authorization' => '{access token}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'externalRef' => '{string}',
'shouldHaveExpectations' => '{boolean}',
'includeExpectations' => '{boolean}',
'teamRoleIds' => '{string}',
'workValueIds' => '{string}',
'offset' => '0',
'count' => '100',
'sort' => '{string}',
'search' => '{string}',
'domainIds' => '{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}',
'Authorization': '{access token}',
}
params = urllib.urlencode({
# Request parameters
'externalRef': '{string}',
'shouldHaveExpectations': '{boolean}',
'includeExpectations': '{boolean}',
'teamRoleIds': '{string}',
'workValueIds': '{string}',
'offset': '0',
'count': '100',
'sort': '{string}',
'search': '{string}',
'domainIds': '{string}',
})
try:
conn = httplib.HTTPSConnection('test.api.kazi.be')
conn.request("GET", "/identifying/v2/talentscans?%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}',
'Authorization': '{access token}',
}
params = urllib.parse.urlencode({
# Request parameters
'externalRef': '{string}',
'shouldHaveExpectations': '{boolean}',
'includeExpectations': '{boolean}',
'teamRoleIds': '{string}',
'workValueIds': '{string}',
'offset': '0',
'count': '100',
'sort': '{string}',
'search': '{string}',
'domainIds': '{string}',
})
try:
conn = http.client.HTTPSConnection('test.api.kazi.be')
conn.request("GET", "/identifying/v2/talentscans?%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://test.api.kazi.be/identifying/v2/talentscans')
query = URI.encode_www_form({
# Request parameters
'externalRef' => '{string}',
'shouldHaveExpectations' => '{boolean}',
'includeExpectations' => '{boolean}',
'teamRoleIds' => '{string}',
'workValueIds' => '{string}',
'offset' => '0',
'count' => '100',
'sort' => '{string}',
'search' => '{string}',
'domainIds' => '{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 headers
request['Authorization'] = '{access token}'
# 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