Administration API Web-services Samples.

The CrossKnowledge Administration API Web-services is built on HTTP REST pattern

GET API/ADMIN/v1/REST/Admin/{administrator_login}/AutoConnectionUrl/{context_type}/{context_guid}

Endpoint : API/ADMIN/v1/REST/Admin/{administrator_login}/AutoConnectionUrl/{context_type}/{context_guid}

Description:

This web-service will creates a SSO URL in order to sign-in an administrator to the back office. To generate the SSO link, the CKLS check only that the user exists and he is enabled. It does not check user rights and restrictions.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Admin/admin/AutoConnectionUrl');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438',
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Admin/admin/AutoConnectionUrl")
  .header("api-key", "14AA9064-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Admin/admin/AutoConnectionUrl");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import requests

url = "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Admin/admin/AutoConnectionUrl"

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache",
    }

response = requests.request("GET", url, headers=headers)

print(response.text)


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Admin/admin/AutoConnectionUrl",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

PUT API/ADMIN/v1/REST/Administrator/{administrator_login}/

Endpoint : API/ADMIN/v1/REST/Administrator/{administrator_login}/

Description:

This web-service updates the entity of the administrator in the database.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Administrator/admin/');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'content-type' => 'application/x-www-form-urlencoded',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields(array(
  'entityGuid' => 'XXXX-289D-2D56-24DE-AC7140E412AA'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.put("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Administrator/admin/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("content-type", "application/x-www-form-urlencoded")
  .header("cache-control", "no-cache")
  .body("entityGuid=XXXX-289D-2D56-24DE-AC7140E412AA")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Administrator/admin/");
var request = new RestRequest(Method.PUT);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
request.AddParameter("application/x-www-form-urlencoded", "entityGuid=XXXX-289D-2D56-24DE-AC7140E412AA", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.jnstaging.crossknowledge.com")

payload = "entityGuid=XXXX-289D-2D56-24DE-AC7140E412AA"

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'content-type': "application/x-www-form-urlencoded",
    'cache-control': "no-cache",
    }

conn.request("PUT", "/API/ADMIN/v1/REST/Administrator/admin/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Administrator/admin/",
  "method": "PUT",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "content-type": "application/x-www-form-urlencoded",
    "cache-control": "no-cache",
  },
  "data": {
	'entityGuid' : 'XXXX-289D-2D56-24DE-AC7140E412AA'
	}
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Training/{training_guid}/Content/

Endpoint : API/ADMIN/v1/REST/Training/{training_guid}/Content/

Description:

This web-service allows to get the learning objects associated to a given training course.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/Content/');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/Content/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/Content/");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache",
    }

conn.request("GET", "/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/Content/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/Content/",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Content/{content_guid}/

Endpoint : API/ADMIN/v1/REST/Content/{content_guid}/

Description:

This web-service allows to read the metadatas of a given learning object.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Content/B6574E49-6B4F-1AC6-A461-3919BAE58A2C/');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Content/B6574E49-6B4F-1AC6-A461-3919BAE58A2C/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Content/B6574E49-6B4F-1AC6-A461-3919BAE58A2C/");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache",
    }

conn.request("GET", "/API/ADMIN/v1/REST/Content/B6574E49-6B4F-1AC6-A461-3919BAE58A2C/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Content/B6574E49-6B4F-1AC6-A461-3919BAE58A2C/",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Training/

Endpoint : API/ADMIN/v1/REST/Training/

Description:

This web-service allows to get the list of existings trainings within the CrossKnowledge Learning Suite database.



$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache"
    }

conn.request("GET", "/API/ADMIN/v1/REST/Training", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Training/{training_guid}/

Endpoint : API/ADMIN/v1/REST/Training/{training_guid}/

Description:

This web-service allows to read the metadatas of a given training course.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'cache-control': "no-cache"
    }

conn.request("GET", "/API/v1/REST/Learner/manager.json", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/v1/REST/Learner/manager.json",
  "method": "GET",
  "headers": {
    "cache-control": "no-cache"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

POST API/ADMIN/v1/REST/Training/

Endpoint : API/ADMIN/v1/REST/Training/

Description:

This web-service allows to create a new training.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'content-type' => 'application/x-www-form-urlencoded',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields(array(
  'type' => 'learningChannel',
  'title' => 'Tofu Fighter!',
  'status' => 'P',
  'cost' => '300$',
  'language' => 'en-GB',
  'duration' => '1h 30.',
  'translations' => array(
					'en-US' => array(
						'title' => 'Vegan Master!'
						)
					)
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.post("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("content-type", "application/x-www-form-urlencoded")
  .header("cache-control", "no-cache")
  .body("type=learningChannel&title=Tofu%20Fighter!&status=P&cost=300%24&language=en-GB&duration=1h%2030.&translations%5Ben-US%5D%5Btitle%5D=Vegan%20Master!")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/");
var request = new RestRequest(Method.POST);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
request.AddParameter("application/x-www-form-urlencoded", "type=learningChannel&title=Tofu%20Fighter!&status=P&cost=300%24&language=en-GB&duration=1h%2030.&translations%5Ben-US%5D%5Btitle%5D=Vegan%20Master!", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

payload = "type=learningChannel&title=Tofu%20Fighter!&status=P&cost=300%24&language=en-GB&duration=1h%2030.&translations%5Ben-US%5D%5Btitle%5D=Vegan%20Master!"

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'content-type': "application/x-www-form-urlencoded",
    'cache-control': "no-cache",
    }

conn.request("POST", "/API/ADMIN/v1/REST/Training/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/",
  "method": "POST",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "content-type": "application/x-www-form-urlencoded",
    "cache-control": "no-cache",
  },
  "data": {
    "type": "learningChannel",
    "title": "Tofu Fighter!",
    "status": "P",
    "cost": "300$",
    "language": "en-GB",
    "duration": "1h 30.",
    "translations" : {
		"en-US" : {
			"title" : "Vegan Master!"
			}
	}
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

PUT API/ADMIN/v1/REST/Training/{training_guid}/

Endpoint : API/ADMIN/v1/REST/Training/{training_guid}/

Description:

This web-service allows to update an existing training course.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/5D261940-A8D8-CE53-1E4F-F6E245D9DF25/');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438',
  'content-type' => 'application/x-www-form-urlencoded'
));

$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields(array(
  'translations' => array(
	'en-US' => array(
		'title' => 'Plant based fighter!'
		)
	)
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.put("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/5D261940-A8D8-CE53-1E4F-F6E245D9DF25/")
  .header("content-type", "application/x-www-form-urlencoded")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .body("translations%5Ben-US%5D%5Btitle%5D=Plant%20based%20fighter!")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/5D261940-A8D8-CE53-1E4F-F6E245D9DF25/");
var request = new RestRequest(Method.PUT);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddParameter("application/x-www-form-urlencoded", "translations%5Ben-US%5D%5Btitle%5D=Plant%20based%20fighter!", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

payload = "translations%5Ben-US%5D%5Btitle%5D=Plant%20based%20fighter!"

headers = {
    'content-type': "application/x-www-form-urlencoded",
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache",
    }

conn.request("PUT", "/API/ADMIN/v1/REST/Training/5D261940-A8D8-CE53-1E4F-F6E245D9DF25/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/5D261940-A8D8-CE53-1E4F-F6E245D9DF25/",
  "method": "PUT",
  "headers": {
    "content-type": "application/x-www-form-urlencoded",
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache",
  },
  "data": {
    "translations" : {
		"en-US" : {
			"title" : "Tofu Fighter!"
			}
	}
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Training/{training_guid}/Session/

Endpoint : API/ADMIN/v1/REST/Training/{training_guid}/Session/

Description:

This web-service allows to read the sessions of a given training course existing within the CrossKnowledge Learning Suite database.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/Session/');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/Session/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/Session/");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache",
    }

conn.request("GET", "/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/Session/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/811BC183-B83E-7A8C-CA0D-B1A5E38F073D/Session/",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Session/{session_guid}/

Endpoint : API/v1/REST/Discussions/list.json

Description:

This web-service allows to read the metadatas of a given session.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/D71C8064-E21E-9499-F0CF-F4413413883C/');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/D71C8064-E21E-9499-F0CF-F4413413883C/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/D71C8064-E21E-9499-F0CF-F4413413883C/");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache",
    }

conn.request("GET", "/API/ADMIN/v1/REST/Session/D71C8064-E21E-9499-F0CF-F4413413883C/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/D71C8064-E21E-9499-F0CF-F4413413883C/",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

POST API/ADMIN/v1/REST/Training/{training_guid}/Session/

Endpoint : API/v1/REST/Discussions/{discussionId}.json

Description:

This web-service allows to create a new training session to a given training course.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/EEDA24F6-C3E7-53FD-A8E8-B300FEE8EE68/Session/');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'content-type' => 'application/x-www-form-urlencoded',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields(array(
  'title' => 'ToFu Fighter',
  'start' =>  '2017-09-27',
  'end' => '2018-09-27'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.post("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/EEDA24F6-C3E7-53FD-A8E8-B300FEE8EE68/Session/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("content-type", "application/x-www-form-urlencoded")
  .header("cache-control", "no-cache")
  .body('title=Tofu Fighter&start=2017-09-27&end=2018-09-27')
  .asString();;


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/EEDA24F6-C3E7-53FD-A8E8-B300FEE8EE68/Session/");
var request = new RestRequest(Method.POST);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
request.AddParameter("application/x-www-form-urlencoded", "title=Tofu Fighter&start=2017-09-27&end=2018-09-27", ParameterType.RequestBody);

IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

payload = "title=Tofu Fighter&start=2017-09-27&end=2018-09-27"

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'content-type': "application/x-www-form-urlencoded",
    'cache-control': "no-cache",
    }

conn.request("POST", "/API/ADMIN/v1/REST/Training/EEDA24F6-C3E7-53FD-A8E8-B300FEE8EE68/Session/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Training/EEDA24F6-C3E7-53FD-A8E8-B300FEE8EE68/Session/",
  "method": "POST",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "content-type": "application/x-www-form-urlencoded",
    "cache-control": "no-cache",
  },
  "data": {
  
	  'title' : 'ToFu Fighter',
	  'start' :  '2017-09-27',
	  'end' : '2018-09-27'
		}
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

PUT API/ADMIN/v1/REST/Session/{session_guid}/ version 1.0

Endpoint : API/ADMIN/v1/REST/Session/{session_guid}/

Description:

This web-service allows to update a given training session information.


$request = new HttpRequest();
$request->setUrl('https://presales.jnstaging.crossknowledge.com/API/ADMIN/v1/REST/Session/36FB0DA7-4C9D-DE71-6B13-FAEBB13B5E21/');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'postman-token' => '552ed8b8-3e43-7cf4-9b0c-d497db9bf628',
  'cache-control' => 'no-cache',
  'content-type' => 'application/x-www-form-urlencoded',
  'api-key' => '14AA9064-4E19-752A-DB81-5087AB7CA438'
));

$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields(array(

  'translations'  => array(
				'en-US' => array(
					'active' => true
					)
				)
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.put("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/36FB0DA7-4C9D-DE71-6B13-FAEBB13B5E21/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("content-type", "application/x-www-form-urlencoded")
  .header("cache-control", "no-cache")
  .body("title=&start=&end=&translations%5Ben-GB%5D%5Bactive%5D=")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/36FB0DA7-4C9D-DE71-6B13-FAEBB13B5E21/");
var request = new RestRequest(Method.PUT);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
request.AddParameter("application/x-www-form-urlencoded", "title=&start=&end=&translations%5Ben-GB%5D%5Bactive%5D=", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

payload = "title=&start=&end=&translations%5Ben-GB%5D%5Bactive%5D="

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'content-type': "application/x-www-form-urlencoded",
    'cache-control': "no-cache"
    }

conn.request("PUT", "/API/ADMIN/v1/REST/Session/36FB0DA7-4C9D-DE71-6B13-FAEBB13B5E21/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/36FB0DA7-4C9D-DE71-6B13-FAEBB13B5E21/",
  "method": "PUT",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "content-type": "application/x-www-form-urlencoded",
    "cache-control": "no-cache"
  },
  "data": {
	
	'translations' : 
				'en-US' : {
					'active' => true
					}
				
  
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

POST API/ADMIN/v1/REST/Session/{session_guid}/Register/{learner_guid}/ version 1.0

Endpoint : API/ADMIN/v1/REST/Session/{session_guid}/Register/{learner_guid}/

Description:

This web-service allows to register a learner to a give training session.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/7687DDDE-0652-3C4D-908B-8475A9E0D1CD/Register/51711782-47C3-CD84-A35C-8AB8622AFCE6/');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'content-type' => 'application/x-www-form-urlencoded',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.post("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/7687DDDE-0652-3C4D-908B-8475A9E0D1CD/Register/51711782-47C3-CD84-A35C-8AB8622AFCE6/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("content-type", "application/x-www-form-urlencoded")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/7687DDDE-0652-3C4D-908B-8475A9E0D1CD/Register/51711782-47C3-CD84-A35C-8AB8622AFCE6/");
var request = new RestRequest(Method.POST);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'content-type': "application/x-www-form-urlencoded",
    'cache-control': "no-cache",
    }

conn.request("POST", "/API/ADMIN/v1/REST/Session/7687DDDE-0652-3C4D-908B-8475A9E0D1CD/Register/51711782-47C3-CD84-A35C-8AB8622AFCE6/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Session/7687DDDE-0652-3C4D-908B-8475A9E0D1CD/Register/51711782-47C3-CD84-A35C-8AB8622AFCE6/",
  "method": "POST",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "content-type": "application/x-www-form-urlencoded",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Registration/{registration_guid}/ version 1.0

Endpoint : API/ADMIN/v1/REST/Registration/{registration_guid}/

Description:

This web-service allows to get a given registration information



$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Registration/AC15C46A-5D10-3E39-9247-92E9A53222B2');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Registration/AC15C46A-5D10-3E39-9247-92E9A53222B2")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Registration/AC15C46A-5D10-3E39-9247-92E9A53222B2");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache",
    }

conn.request("GET", "/API/ADMIN/v1/REST/Registration/AC15C46A-5D10-3E39-9247-92E9A53222B2", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Registration/AC15C46A-5D10-3E39-9247-92E9A53222B2",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

DELETE API/ADMIN/v1/REST/Registration/{registration_guid}/ version 1.0

Endpoint : API/ADMIN/v1/REST/Registration/{registration_guid}/

Description:

This web-service allows to delete a given registration object.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Registration/354131E0-A9D0-B239-F091-344F27E0A49A/');
$request->setMethod(HTTP_METH_DELETE);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'content-type' => 'application/x-www-form-urlencoded',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.delete("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Registration/354131E0-A9D0-B239-F091-344F27E0A49A/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("content-type", "application/x-www-form-urlencoded")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Registration/354131E0-A9D0-B239-F091-344F27E0A49A/");
var request = new RestRequest(Method.DELETE);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'content-type': "application/x-www-form-urlencoded",
    'cache-control': "no-cache"
    }

conn.request("DELETE", "/API/ADMIN/v1/REST/Registration/354131E0-A9D0-B239-F091-344F27E0A49A/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Registration/354131E0-A9D0-B239-F091-344F27E0A49A/",
  "method": "DELETE",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "content-type": "application/x-www-form-urlencoded",
    "cache-control": "no-cache"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Learner/

Endpoint : API/ADMIN/v1/REST/Learner/

Description:

This web-service allows to search for a learner profile or to list all learners information.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'name' => 'doe',
  'enabled' => 'true'
));

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://presales.jnstaging.crossknowledge.com/API/ADMIN/v1/REST/Learner/?name=doe&enabled=true")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/?name=doe&enabled=true");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache",
    }

conn.request("GET", "/API/ADMIN/v1/REST/Learner/?name=doe&enabled=true", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/?name=doe&enabled=true",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

POST API/ADMIN/v1/REST/Learner/

Endpoint : API/ADMIN/v1/REST/Learner/

Description:

This web-service allows to create a new learner.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/');
$request->setMethod(HTTP_METH_POST);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'content-type' => 'application/x-www-form-urlencoded',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields(array(
  'login' => 'richard.roe',
  'name' => 'Roe',
  'firstname' => 'Richard',
  'enabled' => true
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.post("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("content-type", "application/x-www-form-urlencoded")
  .header("cache-control", "no-cache")
  .body("login=richard.roe&enabled=true")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/");
var request = new RestRequest(Method.POST);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
request.AddParameter("application/x-www-form-urlencoded", "login=richard.roe&enabled=true", ParameterType.RequestBody);

IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

payload = "login=richard.roe&enabled=true"

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'content-type': "application/x-www-form-urlencoded",
    'cache-control': "no-cache",
    }

conn.request("POST", "/API/ADMIN/v1/REST/Learner/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/",
  "method": "POST",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "content-type": "application/x-www-form-urlencoded",
    "cache-control": "no-cache"
  },
  "data": {
	"login": "richard.roe",
	"enabled" : true
	}
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Learner/{learner_guid}/AuthToken/ version 1.0

Endpoint : API/ADMIN/v1/REST/Learner/{learner_guid}/AuthToken/

Description:

This web-service allows to get the learner authentication token.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/4AB68D3C-7D28-82B0-1388-A60892F2299B/AuthToken');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/4AB68D3C-7D28-82B0-1388-A60892F2299B/AuthToken")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/4AB68D3C-7D28-82B0-1388-A60892F2299B/AuthToken");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache"
    }

conn.request("GET", "/API/ADMIN/v1/REST/Learner/4AB68D3C-7D28-82B0-1388-A60892F2299B/AuthToken", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/4AB68D3C-7D28-82B0-1388-A60892F2299B/AuthToken",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache",
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

PUT API/ADMIN/v1/REST/Learner/{learner_guid}/ version 1.0

Endpoint : API/v1/REST/LearningObjects/themes.json

Description:

This web-service allows to update a given learner profile information


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/4AB68D3C-7D28-82B0-1388-A60892F2299B/');
$request->setMethod(HTTP_METH_PUT);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'content-type' => 'application/x-www-form-urlencoded',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

$request->setContentType('application/x-www-form-urlencoded');
$request->setPostFields(array(
  'login' => '[email protected]',
  'enabled' => 'false',
  'status' => 'N'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.put("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/4AB68D3C-7D28-82B0-1388-A60892F2299B/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("content-type", "application/x-www-form-urlencoded")
  .header("cache-control", "no-cache")
  .body("login=richard.roe%40kale.com&enabled=false&status=N")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/4AB68D3C-7D28-82B0-1388-A60892F2299B/");
var request = new RestRequest(Method.PUT);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
request.AddParameter("application/x-www-form-urlencoded", "login=richard.roe%40kale.com&enabled=false&status=N", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

payload = "login=richard.roe%40kale.com&enabled=false&status=N"

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'content-type': "application/x-www-form-urlencoded",
    'cache-control': "no-cache"
    }

conn.request("PUT", "/API/ADMIN/v1/REST/Learner/4AB68D3C-7D28-82B0-1388-A60892F2299B/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/4AB68D3C-7D28-82B0-1388-A60892F2299B/",
  "method": "PUT",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "content-type": "application/x-www-form-urlencoded",
    "cache-control": "no-cache",
  },
  "data": {
    "login": "[email protected]",
    "enabled": false,
    "status": "N"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Learner/{learner_guid}/Registration/

Endpoint : API/ADMIN/v1/REST/Learner/{learner_guid}/Registration/

Description:

This web-service allows to get the registrations of a given learner.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/51711782-47C3-CD84-A35C-8AB8622AFCE6/Registration/');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache'
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/51711782-47C3-CD84-A35C-8AB8622AFCE6/Registration/")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/51711782-47C3-CD84-A35C-8AB8622AFCE6/Registration/");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache"
    }

conn.request("GET", "/API/ADMIN/v1/REST/Learner/51711782-47C3-CD84-A35C-8AB8622AFCE6/Registration/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Learner/51711782-47C3-CD84-A35C-8AB8622AFCE6/Registration/",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Entity/{entity_guid} version 1.0

Endpoint : API/ADMIN/v1/REST/Entity/

Description:

This web-service allows to get a given entity information.


$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Entity/');
$request->setMethod(HTTP_METH_GET);

$request->setQueryData(array(
  'page' => '1',
  'title' => 'paris',
  'title_exact' => 'paris school of business'
));

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => 'XXXX-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Entity/?page=1&title=paris&title_exact=paris%20school%20of%20business")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Entity/?page=1&title=paris&title_exact=paris%20school%20of%20business");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache"
    }

conn.request("GET", "/API/ADMIN/v1/REST/Entity/?page=1&title=paris&title_exact=paris%20school%20of%20business", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Entity/?page=1&title=paris&title_exact=paris%20school%20of%20business",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

GET API/ADMIN/v1/REST/Entity/{entity_guid} version 1.0

Endpoint : API/ADMIN/v1/REST/Entity/{entity_guid}

Description:

This web-service allows to get a given entity information.



$request = new HttpRequest();
$request->setUrl('https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Entity/7D8532CB-E3C0-578F-4EE4-F39B406097E5');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'cache-control' => 'no-cache',
  'api-key' => '14AA9064-4E19-752A-DB81-5087AB7CA438'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}


HttpResponse response = Unirest.get("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Entity/7D8532CB-E3C0-578F-4EE4-F39B406097E5")
  .header("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438")
  .header("cache-control", "no-cache")
  .asString();


var client = new RestClient("https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Entity/7D8532CB-E3C0-578F-4EE4-F39B406097E5");
var request = new RestRequest(Method.GET);
request.AddHeader("cache-control", "no-cache");
request.AddHeader("api-key", "XXXX-4E19-752A-DB81-5087AB7CA438");
IRestResponse response = client.Execute(request);


import http.client

conn = http.client.HTTPSConnection("yourdomain.crossknowledge.com")

headers = {
    'api-key': "XXXX-4E19-752A-DB81-5087AB7CA438",
    'cache-control': "no-cache"
    }

conn.request("GET", "/API/ADMIN/v1/REST/Entity/7D8532CB-E3C0-578F-4EE4-F39B406097E5", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://yourdomain.crossknowledge.com/API/ADMIN/v1/REST/Entity/7D8532CB-E3C0-578F-4EE4-F39B406097E5",
  "method": "GET",
  "headers": {
    "api-key": "XXXX-4E19-752A-DB81-5087AB7CA438",
    "cache-control": "no-cache"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});