Kazi Administrator API

This document describes the Administrator API specifications for Kazi administrators

Get the total number of talent scans for the account

Request

Request URL

https://test.api.kazi.be/admin/v2/accounts/{id}/talentscans/totalcount[?shouldHaveExpectations][&teamRoleIds][&workValueIds][&search][&domainIds]

Request parameters

id

string

Format - uuid. The account id
shouldHaveExpectations (optional)

boolean

Whether the talent scan should have expectations or not. This parameter is ignored if there are team role ids or work value ids.
teamRoleIds (optional)

string

A comma separated list of team role expectation ids to filter on
workValueIds (optional)

string

A comma separated list of work value expectation ids to filter on
search (optional)

string

The search string that is used to search on name and email. Partial matches are allowed.
domainIds (optional)

string

A comma separated list of domain ids

Request headers

Ocp-Apim-Subscription-Key

string

Subscription key which provides access to this API. Found in your Profile.
Authorization

string

OAuth 2.0 access token obtained from Trusted Client Credentials grant. Supported grant types: Client credentials.

Request body

Responses

400 Bad Request

Bad Request

Representations

application/json

200 OK

Returns the total number of talent scans for the account

Representations

application/json

Sample
Schema

{
  "type": "integer",
  "format": "int32",
  "x-apim-inline": true
}

Code samples

@ECHO OFF

curl -v -X GET "https://test.api.kazi.be/admin/v2/accounts/{id}/talentscans/totalcount?shouldHaveExpectations={boolean}&teamRoleIds={string}&workValueIds={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["shouldHaveExpectations"] = "{boolean}";
            queryString["teamRoleIds"] = "{string}";
            queryString["workValueIds"] = "{string}";
            queryString["search"] = "{string}";
            queryString["domainIds"] = "{string}";
            var uri = "https://test.api.kazi.be/admin/v2/accounts/{id}/talentscans/totalcount?" + 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/admin/v2/accounts/{id}/talentscans/totalcount");

            builder.setParameter("shouldHaveExpectations", "{boolean}");
            builder.setParameter("teamRoleIds", "{string}");
            builder.setParameter("workValueIds", "{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
            "shouldHaveExpectations": "{boolean}",
            "teamRoleIds": "{string}",
            "workValueIds": "{string}",
            "search": "{string}",
            "domainIds": "{string}",
        };
      
        $.ajax({
            url: "https://test.api.kazi.be/admin/v2/accounts/{id}/talentscans/totalcount?" + $.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/admin/v2/accounts/{id}/talentscans/totalcount";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"shouldHaveExpectations={boolean}",
                         @"teamRoleIds={string}",
                         @"workValueIds={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/admin/v2/accounts/{id}/talentscans/totalcount');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
    'Authorization' => '{access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'shouldHaveExpectations' => '{boolean}',
    'teamRoleIds' => '{string}',
    'workValueIds' => '{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
    'shouldHaveExpectations': '{boolean}',
    'teamRoleIds': '{string}',
    'workValueIds': '{string}',
    'search': '{string}',
    'domainIds': '{string}',
})

try:
    conn = httplib.HTTPSConnection('test.api.kazi.be')
    conn.request("GET", "/admin/v2/accounts/{id}/talentscans/totalcount?%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
    'shouldHaveExpectations': '{boolean}',
    'teamRoleIds': '{string}',
    'workValueIds': '{string}',
    'search': '{string}',
    'domainIds': '{string}',
})

try:
    conn = http.client.HTTPSConnection('test.api.kazi.be')
    conn.request("GET", "/admin/v2/accounts/{id}/talentscans/totalcount?%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/admin/v2/accounts/{id}/talentscans/totalcount')

query = URI.encode_www_form({
    # Request parameters
    'shouldHaveExpectations' => '{boolean}',
    'teamRoleIds' => '{string}',
    'workValueIds' => '{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