This API allows to get and set data from external data sources within the CrossKnowledge Learning Suite database for administration purpose.
 Learn more about CrossKnowledge Database Objects.
GET  API/ADMIN/v1/REST/Admin/{administrator_login}/AutoConnectionUrl/{context_type}/{context_guid}  version 1.0

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.

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

Method : GET

Return :

This web-service returns a secured single sign-on access url to the CrossKnowledge Learning Suite administration portal.(Back-office)

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
administrator_login string The login of the administrator. richard.roe
context_type string Database object landing page where to redirect the administrator.
Mandatory if a context_guid is given. 		One of the following : default (default value | training | session | registration | learner
context_guid string GUID of database object related to the landing page where to redirect the administrator.
Mandatory if a context_type is given. 		abcdef-12345-XXXXXXX-XXXXXXX

Request : 



GET /API/ADMIN/v1/REST/Admin/richard.roe/AutoConnectionUrl HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXXXX-YYYYYY-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of results counted by the web-service.
count integer The number of results returned by the web-service.
value string A string containing the data in response to the request.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": "https://yourdomain.crossknowledge.com/administration/authentication/admin/..."
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“Not Found” 404
“Unauthorized” 401
Glossary: Administrator Training Session Learning Object Context
 
PUT  API/ADMIN/v1/REST/Administrator/{administrator_login}/  version 1.0

Description :

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

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

Method : PUT

Return :

This web-service returns a JSON object after the administrator has been successfully updated.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
entityGuid string The entity GUID to assign the administrator to. abcdef-12345-XXXXXXX-XXXXXXX

Request : 


PUT /API/ADMIN/v1/REST/Administrator/richard.roe/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXXX-4E19-752A-DB81-5087AB7CA438	
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

entityGuid=XXXXX-289D-2D56-24DE-AC7140E412AA

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of results counted by the web-service.
count integer The number of results returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string the administrator GUID
login string the administrator login
entityGuid string the entity GUID of the administrator
_links object list of endpoints related to the administrator object
self string current web-service endpoint

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXXXXX-11E0-9006-0026B9FD1E70",
            "login": "richard.roe",
            "entityGuid": "XXXXXXX-2D56-24DE-AC7140E412AA",
            "_links": {
                "self": "/API/ADMIN/v1/REST/Administrator/richard.roe/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Administrator/richard.roe/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No administrator found with provided login” 204
“Entity does not exist” 400
“Unauthorized” 401
“Oops, something went wrong” 403
Glossary: Entity Administrator
 
GET  API/ADMIN/v1/REST/Content/{content_guid}/  version 1.0

Description :

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

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

Method : GET

Return :

This web-service returns a json object with the translated metadatas for a given learning object (content).

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
content_guid string The learning object (content) GUID. abcdef-12345-XXXXXXX-XXXXXXX

Request : 


GET /API/ADMIN/v1/REST/Content/XXXX-6B4F-1AC6-A461-3919BAE58A2C/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of learning objects counted by the web-service.
count integer The number of learning objects returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string the content GUID
type string the content type.
subtype string the content subtype.
publisher string the content publisher.
trackingPropagation boolean define is the tracking propagation is enabled on this content.
points integer number of points on the content.
contentVersions object list of localized versions of the content. Each key represents the language code of the content with the learning object metadatas as a value.
guid string The learning Object GUID.
title string The learning object title.
referenceNumber string The learning object code.
thumbnail object Thumbnail URI of the learning object.
version integer The learning object version number.
duration integer The learning object duration (min.).
status string The learning publication status.
authors array The learning object authors name and firstname
summary string The learning object summary.
whatYouWillLearn string The learning object learning points (what you will learn).
included string The learning object included.
targetAudience string The learning object target audience.
level integer The learning object level in the library.
_links object List of web-service endpoint related to the object.
self object The web-service endpoint related to the current object.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXXXX-6B4F-1AC6-A461-3919BAE58A2C",
            "type": "Interactive learning resource",
            "subtype": "",
            "publisher": null,
            "trackingPropagation": false,
            "points": null,
            "contentVersions": {
                "en-GB": {
                    "guid": "XXXXXXXX-72CF-9026-57AF-9A24CFE9BE37",
                    "title": "The All-New Jaguar XKR-S",
                    "referenceNumber": "MOHI002",
                    "thumbnail": "https://yourdomain.crossknowledge.com/lo_picture/...",
                    "version": 1,
                    "duration": 30,
                    "status": "V",
                    "authors": [],
                    "summary": "",
                    "whatYouWillLearn": "",
                    "included": "",
                    "targetAudience": "",
                    "level": 0
                },
                "fr-FR": {
                    "guid": "XXXXXXX-D693-45DE-A67E-C899D8B520A2",
                    "title": "La nouvelle Jaguar XKR-S",
                    "referenceNumber": "MOHI002",
                    "thumbnail": "https://yourdomain.crossknowledge.com/lo_picture/...",
                    "version": 1,
                    "duration": 30,
                    "status": "V",
                    "authors": [ {
						  "name": "Doe",
						  "firstName": "John"
						}],
                    "summary": "",
                    "whatYouWillLearn": "",
                    "included": "",
                    "targetAudience": "",
                    "level": 0
                }
            },
            "_links": {
                "self": "/API/ADMIN/v1/REST/Content/B6574E49-6B4F-1AC6-A461-XXXXXX/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Content/XXXX-6B4F-1AC6-A461-3919BAE58A2C/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“Unauthorized” 401
“Not Found” 404
Glossary: Learning Object (content)
 
GET  API/ADMIN/v1/REST/Entity/{entity_guid} version 1.0

Description :

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

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

Method : GET

Return :

This web-service returns a json object with the entity information.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
entity_guid string The entity GUID. abcdef-12345-XXXXXXX-XXXXXXX

Request : 


GET /API/ADMIN/v1/REST/Entity/XXXX-E3C0-578F-4EE4-F39B406097E5 HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of entity counted by the web-service.
count integer The number of entity returned by the web-service call out.
value array An object or a list of objects containing the data in response to the request.
guid string The entity GUID.
title string The entity title.
tree string The parent entity in the entity’s tree.
_links object The web-service endpoint related to the current object.
self string The web-service endpoint of the current object (entity).

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXX-E3C0-578F-4EE4-F39B406097E5",
            "title": "All users",
            "tree": "All users",
            "_links": {
                "self": "/API/ADMIN/v1/REST/Entity/XXXX-E3C0-578F-4EE4-F39B406097E5/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Entity/XXXX-E3C0-578F-4EE4-F39B406097E5/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“Unauthorized.” 401
Glossary: Learner Entity
 
GET  API/ADMIN/v1/REST/Entity/ version 1.0

Description :

This web-service allows to search or to list all existing entities.

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

Method : GET

Return :

This web-service returns a json object with the entity information.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
page integer The page number that should be displayed, based on the limit number
limit integer Limit to search.</b> Default : 10 Max. 50
title string Filter on title (pattern like here: %title%).</b>
title_exact string Filter on the entity exact title.</b>

Request : 


GET /API/ADMIN/v1/REST/Entity/?title=paris&title_exact=paris school of business HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of entity counted by the web-service.
count integer The number of entity returned by the web-service call out.
value array An object or a list of objects containing the data in response to the request.
guid string The entity GUID.
title string The entity title.
tree string The parent entity in the entity’s tree.
_links object The web-service endpoint related to the current object.
self string The web-service endpoint of the current object (entity).
first string The web-service endpoint of the search result first page.
last string The web-service endpoint of the search result last page.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXX-70F2-4151-7BEC-0450900144C4",
            "title": "Paris School of Business",
            "tree": "All users|Paris School of Business",
            "_links": {
                "self": "/API/ADMIN/v1/REST/Entity/XXXX-70F2-4151-7BEC-0450900144C4/"
            }
        }
    ],
    "_links": {
        "first": "/API/ADMIN/v1/REST/Entity/?limit=10&page=1",
        "last": "/API/ADMIN/v1/REST/Entity/?limit=10&page=1",
        "self": "/API/ADMIN/v1/REST/Entity/?title=paris&title_exact=paris+school+of+business"
    }
}

Codes and messages:

Message Code
“OK” 200
“Not Found” 204
“page”: “This value should be a valid number.” 400
“Unauthorized.” 401
Glossary: Learner Entity
 
GET  API/ADMIN/v1/REST/Learner/{learner_guid}  version 1.0

Description :

This web-service allows to search for a learner profile.

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

Method : GET

Return :

This web-service returns a json object with the learner profile information.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
</tbody> </table>

Request : 


GET /API/ADMIN/v1/REST/Learner/XXXX-E3C0-578F-4EE4-F39B406097E5 HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Required Comment Values
guid string the learner GUID. abcdef-12345-XXXXXXX-XXXXXXX
Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of learners accounts counted by the web-service.
count integer The number of learners accounts returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The learner GUID.
login string The learner login.
referenceNumber string The learner reference number.
name string The learner lastname.
firstname string The learner firstname.
email string The learner email.
entityGuid string The learner entity GUID.
type string The learning object type (in the example below i for Interactive content).
enabled string The learner status.
_links object The web-service endpoints related to the current object (learner).
self object The web-service endpoint of the current object (learner).
registrations integer The web-service enpoint of the registrations of the learner.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXX-FA8B-9DCA-0490-EFC90A0A4A9D",
            "login": "[email protected]",
            "referenceNumber": "Do not delete",
            "name": "Doe",
            "firstName": "John",
            "email": "[email protected]",
            "entityGuid": "XXXX-E3C0-578F-4EE4-F39B406097E5",
            "enabled": true,
            "_links": {
                "self": "/API/ADMIN/v1/REST/Learner/XXXX-FA8B-9DCA-0490-EFC90A0A4A9D/",
                "registrations": "/API/ADMIN/v1/REST/Learner/XXXX-FA8B-9DCA-0490-EFC90A0A4A9D/Registration/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Learner/XXXX-FA8B-9DCA-0490-EFC90A0A4A9D/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“enabled is not a boolean” 400
” “page” : this value should be a valid number.” 400
” “limit” : this value should be 1 or more.” 400
“Not Found” 404
Glossary: Learner
</div>
 
</div>
GET  API/ADMIN/v1/REST/Learner/  version 1.0

Description :

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

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

Method : GET

Return :

This web-service returns a json object with the learner profile information.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
page integer The page number that should be displayed, based on the limit number Default : 1
limit integer Max number of record to search. Default: 10 Max: 50
guid string the learner GUID. abcdef-12345-XXXXXXX-XXXXXXX
login string the learner login. richard.roe
referenceNumber string the learner reference number. abc123
name string the learner lastname. Roe
firstname string the learner firstname. Richard
email string the learner email. [email protected]
entityGuid string the learner entity GUID. abcdef-12345-XXXXXXX-XXXXXXX
enabled string the learner status. true (active) | false (inactive)

Request : 


GET /API/ADMIN/v1/REST/Learner/?name=doe&enabled=true HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of learners accounts counted by the web-service.
count integer The number of learners accounts returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The learner GUID.
login string The learner login.
referenceNumber string The learner reference number.
name string The learner lastname.
firstname string The learner firstname.
email string The learner email.
entityGuid string The learner entity GUID.
type string The learning object type (in the example below i for Interactive content).
enabled string The learner status.
_links object The web-service endpoints related to the current object (learner).
self object The web-service endpoint of the current object (learner).
registrations integer The web-service enpoint of the registrations of the learner.
first string The web-service enpoint of the search result first page.
last string The web-service enpoint of the search result last page.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXX-FA8B-9DCA-0490-EFC90A0A4A9D",
            "login": "[email protected]",
            "referenceNumber": "Do not delete",
            "name": "Doe",
            "firstName": "John",
            "email": "[email protected]",
            "entityGuid": "XXXX-E3C0-578F-4EE4-F39B406097E5",
            "enabled": true,
            "_links": {
                "self": "/API/ADMIN/v1/REST/Learner/XXXX-FA8B-9DCA-0490-EFC90A0A4A9D/",
                "registrations": "/API/ADMIN/v1/REST/Learner/XXXX-FA8B-9DCA-0490-EFC90A0A4A9D/Registration/"
            }
        }
    ],
    "_links": {
        "first": "/API/ADMIN/v1/REST/Learner/?limit=10&page=1",
        "last": "/API/ADMIN/v1/REST/Learner/?limit=10&page=1",
        "self": "/API/ADMIN/v1/REST/Learner/?name=doe&enabled=true"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“enabled is not a boolean” 400
” “page” : this value should be a valid number.” 400
” “limit” : this value should be 1 or more.” 400
“Not Found” 404
Glossary: Learner
 
POST  API/ADMIN/v1/REST/Learner/  version 1.0

Description :

This web-service allows to create a new learner.

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

Method : POST

Return :

This web-service returns a json object with the newly created learner information.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
login string the learner login. richard.roe
referenceNumber string the learner reference number. abc123
name string the learner lastname. Roe
firstName string the learner firstname. Richard
email string the learner email. [email protected]
language string the learner (code) language. en-GB
entityGuid string the learner entity GUID. abcdef-12345-XXXXXXX-XXXXXXX
status string the learner status. Y (active) | N (inactive) | U (active between two dates “start” - “end”)
start string the learner activation date. yyyy-mm-dd
end string the learner deactivation date. yyyy-mm-dd
customFields array the learner custom fields (only string and integer custom field type allowed). “customFields”: {“f114870d-ed13-4e03-bc77-c34841a7a52b”:”France”, “d941cf5f-00a8-4e8d-804e-f913e6aad471”:”IT”}
presentation string the learner presentation.
web string the learner web-site(portfolio).
twitter string the learner twitter profile.
linkedIn string the learner linked in profile.

Request : 


POST /API/ADMIN/v1/REST/Learner/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

login=richard.roe%40tofufighter.com&name=Roe&firstname=Richard&status=U&start=2017-09-20&end=2017-09-29

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of learners counted by the web-service.
count integer The number of learners returned by the web-service.
value object An object or a list of objects containing the data in response to the request.
guid string The learner GUID.
login string The learner login.
referenceNumber string The learner reference number.
name string The learner lastname.
firstname string The learner firstname.
email string The learner email.
entityGuid string The learner entityGuid.
enabled true The learner account status.
language string The learner code language.
status string The learner account status type.
start string The learner activation start date.
end string The learner activation end date.
customFields object The learner account custom fields.
presentation string The learner presentation.
web string The learner portfolio.
twitter string The learner twitter profile.
linkedIn string The learner linked in profile.
points integer The learner points number.
badges integer The learner badges number.
_links string The web-services endpoints related to the current object.
self string The web-service endpoint of the current object.
registrations string The web-service endpoint of the learner registrations.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXXX-D5B3-6C3C-13E7-D0413EA98F49",
            "login": "[email protected]",
            "referenceNumber": "",
            "name": "Roe",
            "firstName": "",
            "email": "[email protected]",
            "entityGuid": "XXXX-E3C0-578F-4EE4-F39B406097E5",
            "enabled": true,
            "language": "en-GB",
            "status": "U",
            "start": "2017-09-20",
            "end": "2017-09-29",
            "customFields": {
                "XXXX-BE6B-19BB-1FB7-7090040590CD": "Kale Yeah!",
                "XXXX-B01F-9087-30D5-CF198F7EE27D": "",
                "XXXX-BBEE-E2C2-EFB7-320A5FDA419D": 0
            },
            "presentation": "",
            "web": "",
            "twitter": "",
            "linkedIn": "",
            "points": 0,
            "badges": 0,
            "_links": {
                "self": "/API/ADMIN/v1/REST/Learner/XXXX-D5B3-6C3C-13E7-D0413EA98F49/",
                "registrations": "/API/ADMIN/v1/REST/Learner/XXXX-D5B3-6C3C-13E7-D0413EA98F49/Registration/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Learner/XXXX-D5B3-6C3C-13E7-D0413EA98F49/"
    }
}

Codes and messages:

Message Code
“OK” 200
“login” : “this value should not be blank.” 400
“status”: “Invalid learner status: it must be Y, N or U.” 400
“Unauthorized.” 401
Glossary: Learner
 
PUT  API/ADMIN/v1/REST/Learner/{learner_guid}/ version 1.0

Description :

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

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

Method : PUT

Return :

This web-service returns a json object with the updated profile information for a given learner.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
learner_guid string the learner GUID. abcdef-12345-XXXXXXX-XXXXXXX
login string the learner login. richard.roe
referenceNumber string the learner reference number. abc123
name string the learner lastname. Roe
firstname string the learner firstname. Richard
email string the learner email. [email protected]
language string the learner (code) language. en-GB
entityGuid string the learner entity GUID. abcdef-12345-XXXXXXX-XXXXXXX
status string the learner status. Y (active) | N (inactive) | U (active between two dates “start” - “end”)
start string the learner activation date. yyyy-mm-dd
end string the learner deactivation date. yyyy-mm-dd
customFields array the learner custom fields (only string and integer allowed). customFields[‘guid’]=’value’
presentation string the learner presentation.
web string the learner web-site(portfolio).
twitter string the learner twitter profile.
linkedIn string the learner linked in profile.

Request : 


PUT /API/ADMIN/v1/REST/Learner/XXXX-82B0-1388-A60892F2299B/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

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

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of learners counted by the web-service.
count integer The number of learners returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The learner GUID.
login string The learner login.
referenceNumber string The learner reference number.
name string The learner lastname.
firstname string The learner firstname.
email string The learner email.
entityGuid string The learner entityGuid.
enabled true The learner account status.
language string The learner code language.
status string The learner account status type.
start string The learner activation start date.
end string The learner activation end date.
customFields object The learner account custom fields.
presentation string The learner presentation.
web string The learner portfolio.
twitter string The learner twitter profile.
linkedIn string The learner linked in profile.
points integer The learner points number.
badges integer The learner badges number.
_links string The web-services endpoints related to the current object.
self string The web-service endpoint of the current object.
registrations string The web-service endpoint of the learner registrations.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXXX-D5B3-6C3C-13E7-D0413EA98F49",
            "login": "[email protected]",
            "referenceNumber": "",
            "name": "Roe",
            "firstName": "",
            "email": "[email protected]",
            "entityGuid": "XXXX-E3C0-578F-4EE4-F39B406097E5",
            "enabled": false,
            "language": "en-GB",
            "status": "N",
            "start": "2017-09-20",
            "end": "2017-09-29",
            "customFields": {
                "XXXX-BE6B-19BB-1FB7-7090040590CD": "Kale Yeah!",
                "XXXX-B01F-9087-30D5-CF198F7EE27D": "",
                "XXXX-BBEE-E2C2-EFB7-320A5FDA419D": 0
            },
            "presentation": "",
            "web": "",
            "twitter": "",
            "linkedIn": "",
            "points": 0,
            "badges": 0,
            "_links": {
                "self": "/API/ADMIN/v1/REST/Learner/XXXX-D5B3-6C3C-13E7-D0413EA98F49/",
                "registrations": "/API/ADMIN/v1/REST/Learner/XXXX-D5B3-6C3C-13E7-D0413EA98F49/Registration/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Learner/XXXX-D5B3-6C3C-13E7-D0413EA98F49/"
    }
}

Codes and messages:

Message Code
“OK” 200
“login” : “this value should not be blank.” 400
“status”: “Invalid learner status: it must be Y, N or U.” 400
“Unauthorized.” 401
Glossary: Learner
 
GET  API/ADMIN/v1/REST/Learner/{learner_guid}/Registration/  version 1.0

Description :

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

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

Method : GET

Return :

This web-service returns a json object with the registrations information of the learner.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment
learner_guid string The learner GUID.

Request : 


GET /API/ADMIN/v1/REST/Learner/XXXX-47C3-CD84-A35C-8AB8622/Registration/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of registration counted by the web-service.
count integer The number of registration returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The registration GUID.
sessionGuid string The training session GUID.
trainingGuid string The trianing GUID.
learnerGuid string The learner GUID.
_links object The web-service endpoints related to the current object.
self string The web-service endpoint of the current object (learner’s registration).
session string The web-service endpoint of the training session registration.
training string The web-service endpoint of training session registration.
learner string The web-service endpoint of the learner.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXX-5D10-3E39-9247-92E9A53222B2",
            "sessionGuid": "XXXX-4C9D-DE71-6B13-FAEBB13B5E21",
            "trainingGuid": "XXXX-C3E7-53FD-A8E8-B300FEE8EE68",
            "learnerGuid": "XXXX-47C3-CD84-A35C-8AB8622AFCE6",
            "_links": {
                "self": "/API/ADMIN/v1/REST/Registration/XXXX-5D10-3E39-9247-92E9A53222B2/",
                "session": "/API/ADMIN/v1/REST/Session/XXXX-4C9D-DE71-6B13-FAEBB13B5E21/",
                "training": "/API/ADMIN/v1/REST/Training/XXXX-C3E7-53FD-A8E8-B300FEE8EE68/",
                "learner": "/API/ADMIN/v1/REST/Learner/XXXX-47C3-CD84-A35C-8AB8622AFCE6/"
            }
        },
		...
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Learner/XXXX-47C3-CD84-A35C-8AB8622AFCE6/Registration/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content.” 204
“Unauthorized.” 401
Glossary: Learner Learning Object Training Session Context
 
GET  API/ADMIN/v1/REST/Learner/{learner_guid}/AuthToken/ version 1.0

Description :

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

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

Method : GET

Return :

This web-service returns a json object with the learner authentication token.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
learner_guid integer the learner GUID. abcdef-12345-XXXXXXX-XXXXXXX

Request : 


GET /API/ADMIN/v1/REST/Learner/XXXX-7D28-82B0-1388-A60892F2299B/AuthToken HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of learner authentication token counted by the web-service.
count integer The number of learner authentication token returned by the web-service.
value object An object or a list of objects containing the data in response to the request.
token string The 6 digits learner authentication token.
_links string The web-service endpoints related to the current object.
self string The web-service enpoint of the current object.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": {
        "token": "WZF7PN"
    },
    "_links": {
        "self": "/API/ADMIN/v1/REST/Learner/XXXX-7D28-82B0-1388-A60892F2299B/AuthToken"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content.” 204
“Unauthorized.” 401
Glossary: Learner
 
GET  API/Learner/Authenticate  version 1.0

Description :

This web-service grant access to a client application.

Endpoint : https://ckauth.crossknowledge.com/api/learner/authenticate.json

Method : GET

Return :

This web-service returns an authentication token to client application. This authentication token is used to get an access token.

Parameters :

Label Type Required Comment Values
token string The 6 digits code. A1B23C

Request : 



GET /api/learner/authenticate.json?token=A1B23C  HTTP/1.1
Host: ckauth.crossknowledge.com
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
totalResults integer The number of results counted by the web-service.
success boolean Define if yes (true) or no (false) the web-service request was a success.
value object An object containing the data in response to the request.
learnerLogin string The learner login.
password string The learner password.
instanceUrl string The learner learning resource server endpoint.

Example of JSON response :


{
    "message": "Success",
    "totalResults": 1,
    "success": true,
    "value": {
        "learnerLogin": "richard.roe",
        "password": "zh2d3jpfyg",
        "instanceUrl": "yourdomain.crossknowledge.com/"
    }
}

Codes and messages:

Message Code
“Success” 200
“Invalid token” 81004
Glossary: Learner
 
GET  API/ADMIN/v1/REST/Learner/{learner_guid}/Tracking/ version 1.0

Description :

This web-service allows to get the learner tracking history.

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

Method : GET

Return :

This web-service returns a json object with the learner tracking history.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
page integer The page number that should be displayed, based on the limit number. Default: 1
limit integer Limit to search. Default: 10 Maximum: 50
status string Status of trackings to return. “completed”, “inProgress” (no record for not started so we skip this value)

Request : 


GET /API/ADMIN/v1/REST/Learner/XXXX-7D28-82B0-1388-A60892F2299B/Tracking HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of learner authentication token counted by the web-service.
count integer The number of learner authentication token returned by the web-service.
value object An object or a list of objects containing the data in response to the request.
_links string The web-service endpoints related to the current object.

Example of JSON response :


{
  "message": "OK",
  "success": true,
  "totalCount": 2,
  "count": 2,
  "value": [
    {
       "guid": "13C826AF-BD07-1B61-1EE1-10AEB581EA3D",
       "sessionGuid": "09C13FA3-E7AE-2E2C-A2EF-59E574D411C0",
       "trainingGuid": "2F9B175C-5A14-A709-AB61-3703C7CD5981",
       "learnerGuid": "5416D83C-C811-CC25-C468-E4DE0E5AC7A9",
       "contentGuid": "5416D83C-C811-CC25-C468-E4DE0E5AC7A9",
       "contentVersionGuid": "5416D83C-C811-CC25-C468-E4DE0E5AC7A9",
       "_links": {
         "self": "/API/ADMIN/v1/REST/Registration/13C826AF-BD07-1B61-1EE1-10AEB581EA3D/",
         "session": "/API/ADMIN/v1/REST/Session/09C13FA3-E7AE-2E2C-A2EF-59E574D411C0/",
         "training": "/API/ADMIN/v1/REST/Training/2F9B175C-5A14-A709-AB61-3703C7CD5981/",
         "learner": "/API/ADMIN/v1/REST/Learner/5416D83C-C811-CC25-C468-E4DE0E5AC7A9/"
         "content": "/API/ADMIN/v1/REST/content/5416D83C-C811-CC25-C468-E4DE0E5AC7A9/"
       }
    },
    {
       "guid": "26D826AF-BD07-1B61-1EE1-10AEB581EA5G",
       "sessionGuid": "266DA3AA-7F95-49E1-83DF-27E3986C0B6",
       "trainingGuid": "44EA3AA-7F95-49E1-83DF-27E3986C1HC7",
       "learnerGuid": "5416D83C-C811-CC25-C468-E4DE0E5AC7A9",
       "contentGuid": "5416D83C-C811-CC25-C468-E4DE0E5AC7A9",
       "contentVersionGuid": "5416D83C-C811-CC25-C468-E4DE0E5AC7A9",
       "_links": {
         "self": "/API/ADMIN/v1/REST/Registration/26D826AF-BD07-1B61-1EE1-10AEB581EA5G/",
         "session": "/API/ADMIN/v1/REST/Session/266DA3AA-7F95-49E1-83DF-27E3986C0B6/",
         "training": "/API/ADMIN/v1/REST/Training/44EA3AA-7F95-49E1-83DF-27E3986C1HC7/",
         "learner": "/API/ADMIN/v1/REST/Learner/5416D83C-C811-CC25-C468-E4DE0E5AC7A9/"
         "content": "/API/ADMIN/v1/REST/content/5416D83C-C811-CC25-C468-E4DE0E5AC7A9/"
       }
    }
  ],
  "_links": {
    "self": "/API/ADMIN/v1/REST/Learner/5416D83C-C811-CC25-C468-E4DE0E5AC7A9/Tracking/"
  }
}

Codes and messages:

Message Code
“OK” 200
“No Content.” 204
“Unauthorized.” 401
 
GET  API/ADMIN/v1/REST/Tracking/{tracking_guid}/  version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#tag/Trackings-public

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

Endpoint : API/ADMIN/v1/REST/Tracking/{tracking_guid}/

Method : GET

Return :

This web-service returns a json object of the translated metadatas for a given tracking.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
tracking_guid string The tracking GUID to look for. abcdef-12345-XXXXXXX-XXXXXXX1

Request : 


GET /API/ADMIN/v1/REST/Tracking/XXXX-B83E-7A8C-CA0D-B1A5E38F073D/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
guid string The guid of tracking line
sessionGuid string The guid of the session related to the tracking.
trainingGuid string The guid of the training related to the tracking.
learnerGuid string The guid of the learner related to the tracking.
contentGuid string The guid of the content related to the tracking.
contentVersionGuid string The guid of the content version related to the tracking
firstLaunchDate string The date at which the content referenced by the tracking line has been launched for the first time.
firstCompletionDate string The date at which the content referenced by the training has been completed for the first time.
lastCompletionDate string The date at which the content referenced by the training has been last access.
timeSpent integer Time spent on the content.
progress integer Progress done on the content.
score float Score on the content.
status string Status for the tracking line.
_links string The web-service endpoints related to the current object.
self string The web-service endpoint of the current object.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "2D158332-D58B-0A1A-736A-69D68F6A03B1",
            "sessionGuid": "9EBC52C8-F241-BAA1-68EA-61B7E77C5052",
            "trainingGuid": "487636CF-01E1-113D-365B-D55C6013A260",
            "learnerGuid": "16DC7CC3-9F07-A070-CC9A-4E91B6810267",
            "contentGuid": "VDRD310",
            "contentVersionGuid": "VDRD310en-GB",
            "firstLaunchDate": "2013-08-14 12:36:46",
            "firstCompletionDate": "2013-08-14 12:36:46",
            "lastCompletionDate": "2013-08-14 12:36:46",
            "timeSpent": 240,
            "progress": 100,
            "score": 0,
            "status": "c",
            "_links": {
                "self": "/API/ADMIN/v1/REST/Tracking/2D158332-D58B-0A1A-736A-69D68F6A03B1/",
                "session": "/API/ADMIN/v1/REST/Session/9EBC52C8-F241-BAA1-68EA-61B7E77C5052/",
                "training": "/API/ADMIN/v1/REST/Training/487636CF-01E1-113D-365B-D55C6013A260/",
                "learner": "/API/ADMIN/v1/REST/Learner/16DC7CC3-9F07-A070-CC9A-4E91B6810267/",
                "content": "/API/ADMIN/v1/REST/Content/VDRD310/",
                "registration": "/API/ADMIN/v1/REST/Registration/AE43335A-5299-764F-0570-075C3CD85FF3/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Tracking/2D158332-D58B-0A1A-736A-69D68F6A03B1/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“Unauthorized” 401
“Not Found” 404
Glossary: Tracking Training Session Learner Content
 
GET  API/ADMIN/v1/REST/Training/  version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#operation/getTrainingCourseV1

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

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

Method : GET

Return :

This web-service returns a json object containing a list of trainings.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
page integer The page number that should be displayed, based on the limit number. Default: 1
limit integer Limit to search. Default: 10 | Range >= 50.
type string Type of the training course. One of the following:
blended | eLearning | guided | learningChannel | knowledgeCommunity | learningFeed | campus
guid string GUID of the training course to look for . abcdef-12345-XXXXXXX-XXXXXXX
title string Title of the training course to look for (work as a “like” search), will also search in translated titles.
code string Training path code of the training course to look for.
status string Status of the training course to look for. Return all the training courses of the specified status. One of the following:
  • P (Published)
  • C (In Construction)
  • A (Archived)

Request : 


GET /API/ADMIN/v1/REST/Training?status=P HTTP/1.1
Host: yourdomain.jnstaging.crossknowledge.com
API-KEY: XXXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of trainings counted by the web-service.
count integer The number of trainings returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The training GUID.
type string The training modality.
status string The training publication status.
language string The training language.
title string The training title.
_links object List of web-service endpoints related to the object.
self string Current web-service endpoint of the object.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 180,
    "count": 2,
    "value": [
        {
            "guid": "B105AE9A-99AD-D5F7-D38D-XXXX",
            "type": "knowledgeCommunity",
            "status": "P",
            "language": "en-GB",
            "title": "Sales Community",
            "_links": {
                "self": "/API/ADMIN/v1/REST/Training/XXXX-99AD-D5F7-D38D-3098DAE628F9/",
                "sessions": "/API/ADMIN/v1/REST/Training/XXXX-99AD-D5F7-D38D-3098DAE628F9/Session/"
            }
        },
        {
            "guid": "ADA5D92B-0FE7-FBE1-9E35-XXXX",
            "type": "campus",
            "status": "P",
            "language": "en-GB",
            "title": "Campus Library",
            "_links": {
                "self": "/API/ADMIN/v1/REST/Training/XXXX-0FE7-FBE1-9E35-44E5257B5C2E/",
                "sessions": "/API/ADMIN/v1/REST/Training/XXXX-0FE7-FBE1-9E35-44E5257B5C2E/Session/"
            }
        }
	]
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“Invalid training status: must be P, C or A.” 400
“This type ‘[type]’ is not allowed” 400
“Not found” 404
“Unauthorized” 401
Glossary: Training Session
 
GET  API/ADMIN/v1/REST/Training/{training_guid}/  version 1.0

Description :

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

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

Method : GET

Return :

This web-service returns a json object of the translated metadatas for a given training course.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
training_guid string The training GUID to look for. abcdef-12345-XXXXXXX-XXXXXXX1

Request : 


GET /API/ADMIN/v1/REST/Training/XXXX-B83E-7A8C-CA0D-B1A5E38F073D/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of trainings counted by the web-service.
count integer The number of trainings returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The GUID of the training.
type string The modality of the training.
status string The publication status of the training.
language string The language of the training.
title string The title of the training.
code string The code of the training.
mode string The mode of the training.
thumbnail string The thumbnail of the training.
threshold string The training threshold.
cost string The training cost.
duration string The training duration.
description string The description of the training.
welcomeText string the welcome text of the training.
trainingCourseOverview string The trianing overview.
whoShouldAttend string The training audience.
furtheInformation string The training detailed information.
benefits string The training benefits.
translations object The localized versions of the training.
Label Type Comment
active boolean true to activate the language false otherwise (default is false)
title string The training title
cost string The training cost.
duration string The training duration.
description string The training description.
whatYouWillLearn string The training learning points.
trainingCourseOverview string The training overview.
whoShouldAttend string The training audience.
furtherInformation string The training detailed information.
benefits string The training benefits.
welcomeText string The training welcome text.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXX-B83E-7A8C-CA0D-B1A5E38F073D",
            "type": "eLearning",
            "status": "P",
            "language": "fr-FR",
            "title": "Découvrez une formation produit Mohive",
            "code": "",
            "mode": "normal",
            "thumbnail": "https://yourdomain.crossknowledge.com/lo_picture/..."
            "cost": "",
            "duration": "",
            "description": "",
            "whatYouWillLearn": "",
            "trainingCourseOverview": "",
            "whoShouldAttend": "",
            "furtherInformation": "",
			"welcomeText":  "
Bienvenue!
"
			"benefits": "",
            "translations": {
                "en-GB": {
                    "active": false,
                    "title": "",
                    "cost": "",
                    "duration": "",
                    "description": "",
                    "whatYouWillLearn": "",
                    "trainingCourseOverview": "",
                    "whoShouldAttend": "",
                    "furtherInformation": "",
                    "welcomeText": "",
                    "benefits": ""
                },
				...
			},
			"_links": {
                "self": "/API/ADMIN/v1/REST/Training/XXXX-B83E-7A8C-CA0D-B1A5E38F073D/",
                "sessions": "/API/ADMIN/v1/REST/Training/XXXX-B83E-7A8C-CA0D-B1A5E38F073D/Session/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Training/XXXX-B83E-7A8C-CA0D-B1A5E38F073D/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“Unauthorized” 401
“Not Found” 404
Glossary: Training Session
 
POST  API/ADMIN/v1/REST/Training/  version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#operation/postTrainingCourseV1

This web-service allows to create a new training.

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

Method : POST

Return :

This web-service returns a json object with the translated metadatas of the newly created training

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment values
type string The training modality. one of the following: blended | blendedx | eLearning | learningChannel | knowledgeCommunity | learningFeed | campus
title string The training title
code string The training code.
status string The training publication status. One of the following: C (under construction) | P (published) | A (archived), default is C.
language string The training default code language. en-GB, fr-FR …
cost string The training cost. 20 $.
duration string The training duration. 1 hour and half.
description string The training description.
whatYouWillLearn string The training learning points.
trainingCourseOverview string The training overview.
whoShouldAttend string The training audience.
furtherInformation string The training detailed information.
benefits string The training benefits.
welcomeText string The training welcome text.
translations array The training metadatas translated versions (see parameters below).
Translations array parameters:
Label Type Required Comment values
active boolean true to activate the language false otherwise (default is false) true | false
title string The training title
cost string The training cost. 20 $.
duration string The training duration. 1 hour and half.
description string The training description.
whatYouWillLearn string The training learning points.
trainingCourseOverview string The training overview.
whoShouldAttend string The training audience.
furtherInformation string The training detailed information.
benefits string The training benefits.
welcomeText string The training welcome text.

Request : 


POST /API/ADMIN/v1/REST/Training/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

type=learningChannel&title=Tofu+Fighter!&status=P&cost=300%24&language=en-GB&duration=1h+30.

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of trainings counted by the web-service.
count integer The number of trainings returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The GUID of the training.
type string The modality of the training.
status string The publication status of the training.
language string The language of the training.
title string The title of the training.
code string The code of the training.
mode string The mode of the training.
thumbnail string The thumbnail of the training.
threshold string The training threshold.
cost string The training cost.
duration string The training duration.
description string The description of the training.
welcomeText string the welcome text of the training.
trainingCourseOverview string The trianing overview.
whoShouldAttend string The training audience.
furtheInformation string The training detailed information.
benefits string The training benefits.
translations object The localized versions of the training.
Label Type Comment
active boolean true to activate the language false otherwise (default is false)
title string The training title
cost string The training cost.
duration string The training duration.
description string The training description.
whatYouWillLearn string The training learning points.
trainingCourseOverview string The training overview.
whoShouldAttend string The training audience.
furtherInformation string The training detailed information.
benefits string The training benefits.
welcomeText string The training welcome text.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXXX-A8D8-CE53-1E4F-F6E245D9DF25",
            "type": "learningChannel",
            "status": "P",
            "language": "en-GB",
            "title": "Tofu Fighter!",
            "code": "",
            "mode": "singleton",
            "thumbnail": "https://yourdomain.crossknowledge.com/training_picture/guid/...",
            "threshold": null,
            "cost": "300$",
            "duration": "1h 30.",
            "description": "",
            "whatYouWillLearn": "",
            "trainingCourseOverview": "",
            "whoShouldAttend": "",
            "furtherInformation": "",
            "welcomeText": "",
            "benefits": "",
            "translations": {
                "en-US": {
                    "active": false,
                    "title": "Vegan Master!",
                    "cost": "",
                    "duration": "",
                    "description": "",
                    "whatYouWillLearn": "",
                    "trainingCourseOverview": "",
                    "whoShouldAttend": "",
                    "furtherInformation": "",
                    "welcomeText": "",
                    "benefits": ""
                },
				...
			},
			"_links": {
                "self": "/API/ADMIN/v1/REST/Training/XXXXX-A8D8-CE53-1E4F-F6E245D9DF25/",
                "sessions": "/API/ADMIN/v1/REST/Training/XXXXX-A8D8-CE53-1E4F-F6E245D9DF25/Session/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Training/XXXXX-A8D8-CE53-1E4F-F6E245D9DF25/"
    }
}

Codes and messages:

Message Code
“OK” 200
“Oops, something went wrong.” 400
“Invalid training status: must be P, C or A.” 400
“This language doesn’t exist.” 400
“This type ‘%sentType%’ is not allowed.” 400
“Unauthorized” 401
Glossary: Training
 
PUT  API/ADMIN/v1/REST/Training/{training_guid}/  version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#operation/putTrainingCourseV1

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

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

Method : PUT

Return :

This web-service returns a json object of the metadatas of the updated training.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment values
training_guid string The training GUID to update.
title string The training title
code string The training code.
status string The training publication status. One of the following: C (under construction) | P (published) | A (archived), default is C.
language string The training default code language. en-GB, fr-FR …
cost string The training cost. 20 $.
duration string The training duration. 1 hour and half.
description string The training description.
whatYouWillLearn string The training learning points.
trainingCourseOverview string The training overview.
whoShouldAttend string The training audience.
furtherInformation string The training detailed information.
benefits string The training benefits.
welcomeText string The training welcome text.
translations array The training metadatas translated versions (see parameters below).
Translations array parameters :
Label Type Required Comment values
active boolean true to activate the language false otherwise (default is false) true | false
title string The training title
cost string The training cost. 20 $.
duration string The training duration. 1 hour and half.
description string The training description.
whatYouWillLearn string The training learning points.
trainingCourseOverview string The training overview.
whoShouldAttend string The training audience.
furtherInformation string The training detailed information.
benefits string The training benefits.
welcomeText string The training welcome text.

Request : 


PUT /API/ADMIN/v1/REST/Training/XXXXX-A8D8-CE53-1E4F-F6E245D9DF25/ HTTP/1.1
Host: yourdomain.crossknowledge.com
Content-Type: application/x-www-form-urlencoded
API-KEY: XXXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

translations%5Ben-US%5D%5Btitle%5D=Plant+based+fighter!

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of trainings counted by the web-service.
count integer The number of trainings returned by the web-service.
value object An object or a list of objects containing the data in response to the request.
guid string The GUID of the training.
type string The modality of the training.
status string The publication status of the training.
language string The language of the training.
title string The title of the training.
code string The code of the training.
mode string The mode of the training.
thumbnail string The thumbnail of the training.
threshold string The training threshold.
cost string The training cost.
duration string The training duration.
description string The description of the training.
welcomeText string the welcome text of the training.
trainingCourseOverview string The trianing overview.
whoShouldAttend string The training audience.
furtheInformation string The training detailed information.
benefits string The training benefits.
translations object The localized versions of the training.
Label Type Comment
active boolean true to activate the language false otherwise (default is false)
title string The training title
cost string The training cost.
duration string The training duration.
description string The training description.
whatYouWillLearn string The training learning points.
trainingCourseOverview string The training overview.
whoShouldAttend string The training audience.
furtherInformation string The training detailed information.
benefits string The training benefits.
welcomeText string The training welcome text.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXXX-A8D8-CE53-1E4F-F6E245D9DF25",
            "type": "learningChannel",
            "status": "P",
            "language": "en-GB",
            "title": "Tofu Fighter!",
            "code": "",
            "mode": "singleton",
            "thumbnail": "https://yourdomain.crossknowledge.com/training_picture/guid/...",
            "threshold": null,
            "cost": "300$",
            "duration": "1h 30.",
            "description": "",
            "whatYouWillLearn": "",
            "trainingCourseOverview": "",
            "whoShouldAttend": "",
            "furtherInformation": "",
            "welcomeText": "",
            "benefits": "",
            "translations": {
                "en-US": {
                    "active": false,
                    "title": "Plant based fighter!",
                    "cost": "",
                    "duration": "",
                    "description": "",
                    "whatYouWillLearn": "",
                    "trainingCourseOverview": "",
                    "whoShouldAttend": "",
                    "furtherInformation": "",
                    "welcomeText": "",
                    "benefits": ""
                },
				...
			},
			"_links": {
                "self": "/API/ADMIN/v1/REST/Training/XXXX-A8D8-CE53-1E4F-F6E245D9DF25/",
                "sessions": "/API/ADMIN/v1/REST/Training/XXXX-A8D8-CE53-1E4F-F6E245D9DF25/Session/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Training/XXXX-A8D8-CE53-1E4F-F6E245D9DF25/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No message: training was not found with the provided training guid “ 204
“Oops, something went wrong.” 400
“This language does not exist. “ 400
Invalid training status: must be P, C or A. 400
“Unauthorized.” 401
Glossary: Training Session
 
GET  API/ADMIN/v1/REST/Training/{training_guid}/Session/  version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#operation/getTrainingSessionV1

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

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

Method : GET

Return :

This web-service returns a json object with the training sessions list.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
training_guid integer the training GUID abcdef-12345-XXXXXXX-XXXXXXX1

Request : 


GET /API/ADMIN/v1/REST/Training/XXXXXX-B83E-7A8C-CA0D-B1A5E38F073D/Session/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXXXX-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of training sessions counted by the web-service.
count integer The number of training sessions returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The training session GUID.
language string The training session language.
start string The training session start date (YYYY-MM-DD).
end string The training session end date (YYYY-MM-DD).
_links string The web-service endpoints related to the current object.
self string The web-service endpoint of the current object.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 2,
    "count": 2,
    "value": [
        {
            "guid": "XXXX-9499-F0CF-F4413413883C",
            "language": "fr-FR",
            "start": "2012-09-06",
            "end": "",
            "_links": {
                "self": "/API/ADMIN/v1/REST/Session/XXXX-9499-F0CF-F4413413883C/",
                "training": "/API/ADMIN/v1/REST/Training/XXXX-B83E-7A8C-CA0D-B1A5E38F073D/"
            }
        },
        {
            "guid": "XXXX-0652-3C4D-908B-8475A9E0D1CD",
            "language": "fr-FR",
            "start": "2015-06-24",
            "end": "",
            "_links": {
                "self": "/API/ADMIN/v1/REST/Session/XXXX-0652-3C4D-908B-8475A9E0D1CD/",
                "training": "/API/ADMIN/v1/REST/Training/XXXX-B83E-7A8C-CA0D-B1A5E38F073D/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Training/XXXX-B83E-7A8C-CA0D-B1A5E38F073D/Session/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“Unauthorized.” 401
“Not Found” 404
Glossary: Training Session
 
POST  API/ADMIN/v1/REST/Training/{training_guid}/Session/  version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#operation/postTrainingSessionV1

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

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

Method : POST

Return :

This web-service returns a json object with the newly created training session metadatas.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment values
title string the training session title. Size >= 255
start string the start date of the training session. yyyy-mm-dd
end string the end date of the training session. yyyy-mm-dd
welcomeText string the welcome text of the training session (Rich-text allowed).
translations array the training session translated information (title and welcome text) indexed by code language (see parameters below).
Translations array parameters :
Label Type Required Comment values
active boolean the training session activation. true | false
title string The training session translated title
welcomeText string the training session translated welcome text.

Request : 


POST /API/ADMIN/v1/REST/Training/XXXX-C3E7-53FD-A8E8-B300FEE8EE68/Session/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

title=Tofu+Fighter!&start=2017-09-27&end=2018-09-27

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of training sessions counted by the web-service.
count integer The number of training sessions returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The training session GUID.
language string The training session code language.
start string The training session start date.
end string The training session end date .
welcomeText string the training session welcome text.
translations object The training session metadatas translated versions.
Label Type Comment
active boolean Define if the translated version is active or not.
title string The training session title .
welcomeText string the training session welcome text.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXX-4C9D-DE71-6B13-FAEBB13B5E21",
            "language": "fr-FR",
            "start": "2017-09-27",
            "end": "2018-09-27",
            "title": "Tofu Fighter!",
            "welcomeText": "",
            "translations": {
                "en-GB": {
                    "active": true,
                    "title": "How to be a Vegan Master!",
                    "welcomeText": "Hello young Veganwan!"
                },
				...
			}
			"_links": {
                "self": "/API/ADMIN/v1/REST/Session/XXXX-4C9D-DE71-6B13-FAEBB13B5E21/",
                "training": "/API/ADMIN/v1/REST/Training/XXXX-C3E7-53FD-A8E8-B300FEE8EE68/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Session/XXXX-4C9D-DE71-6B13-FAEBB13B5E21/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No message: training was not found with the provided training GUID “ 204
“Training has singleton session, can’t add or update new session. “ 400
“This date must be greater than “%begindate%”. “ 400
“Training course declarative status is set to Active. Sessions cannot be added when a training course is not published. “ 400
“Oops, something went wrong.” 400
“Unauthorized” 401
Glossary: Session Training
 
GET  API/ADMIN/v1/REST/Training/{training_guid}/Content/  version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#operation/getTrainingCourseContentV1

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

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

Method : GET

Return :

This web-service returns a json response with a list of learning objects (content) for the given training.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
training_guid string The training course GUID.

Request : 


GET /API/ADMIN/v1/REST/Training/XXXXXXX-7A8C-CA0D-B1A5E38F073D/Content/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXXXX-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of learning objects counted by the web-service.
count integer The number of learning objects returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The GUID of the learning object.
_links array Array of the web-service endpoints associated of the learning object.
self string The web-service call out endpoint of the learning object.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXX-6B4F-1AC6-A461-3919BAE58A2C",
            "_links": {
                "self": "/API/ADMIN/v1/REST/Content/XXXX-6B4F-1AC6-A461-3919BAE58A2C/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Training/XXXX-B83E-7A8C-CA0D-B1A5E38F073D/Content/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No message: no content in the training” 204
“Unauthorized” 401
Glossary: Training Learning Object (content)
 
GET  API/ADMIN/v1/REST/Session/{session_guid}/  version 1.0

Description :

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

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

Method : GET

Return :

This web-service returns a json object with the metadatas of the session.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment values
session_guid string the training session GUID. abcdef-12345-XXXXXXX-XXXXXXX1

Request : 


GET /API/ADMIN/v1/REST/Session/XXXX-E21E-9499-F0CF-F4413413883C/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of training session counted by the web-service.
count integer The number of training sessions returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The training session GUID.
language string The training session language.
start string The training session start date (YYYY-MM-DD).
end string The training session end date(YYYY-MM-DD).
title string The training session title.
welcomeText string The training session welcome text.
translations object Object containing the translated metadatas of the training session.
Label Type Comment
active boolean true to activate the language false otherwise (default is false)
title string translated session title
welcomeText string translated session welcome text

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXXXX-E21E-9499-F0CF-F4413413883C",
            "language": "en-US",
            "start": "2012-09-06",
            "end": "",
            "title": "Vegan master.",
			"welcomeText": "
Helle world!
"
            "translations": {
                "en-GB": {
                    "active": false,
                    "title": "",
                    "welcomeText": ""
                },
                "fr-FR": {
                    "active": false,
                    "title": "",
                    "welcomeText": ""
                },
				...
			},
			"_links": {
                "self": "/API/ADMIN/v1/REST/Session/XXXXX-E21E-9499-F0CF-F4413413883C/",
                "training": "/API/ADMIN/v1/REST/Training/XXXXX-B83E-7A8C-CA0D-B1A5E38F073D/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Session/XXXXX-E21E-9499-F0CF-F4413413883C/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“Unauthorized” 401
“Not Found” 404
Glossary: Training Session
 
PUT  API/ADMIN/v1/REST/Session/{session_guid}/ version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#operation/putSessionV1

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

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

Method : PUT

Return :

This web-service returns a json object with the updated training session information.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment values
session_guid string the training session GUID.
title string the training session title. Size >= 255
start string the start date of the training session. yyyy-mm-dd
end string the end date of the training session. yyyy-mm-dd
welcomeText string the welcome text of the training session (Rich-text allowed).
translations array the training session translated information indexed by code language.
Translations array parameters :
Label Type Required Comment values
active boolean the training session activation. true | false
title string The training session translated title
welcomeText string the training session translated welcome text.

Request : 


PUT /API/ADMIN/v1/REST/Session/XXXXX-DE71-6B13-FAEBB13B5E21/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

title=Tofu+Fighter!&start=2017-09-27&end=2018-10-31

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of training sessions counted by the web-service.
count integer The number of training sessions returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The training session GUID.
language string The training session code language.
start string The training session start date.
end string The training session end date .
welcomeText string the training session welcome text.
translations object The trainig session metadatas translated versions.
Label Type Comment
active boolean Define if the translated version is active or not.
title string The training session title .
welcomeText string the training session welcome text.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXX-4C9D-DE71-6B13-FAEBB13B5E21",
            "language": "fr-FR",
            "start": "2017-09-27",
            "end": "2018-10-31",
            "title": "Tofu Fighter!",
            "welcomeText": "",
            "translations": {
                "en-GB": {
                    "active": true,
                    "title": "How to be a Vegan Master!",
                    "welcomeText": "Hello young Veganwan!"
                },
				...
			}
			"_links": {
                "self": "/API/ADMIN/v1/REST/Session/XXXX-4C9D-DE71-6B13-FAEBB13B5E21/",
                "training": "/API/ADMIN/v1/REST/Training/XXXX-C3E7-53FD-A8E8-B300FEE8EE68/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Session/XXXX-4C9D-DE71-6B13-FAEBB13B5E21/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No message: training was not found with the provided training GUID “ 204
“Training has singleton session, can’t add or update new session. “ 400
“This date must be greater than “%begindate%”. “ 400
“Training course declarative status is set to Active. Sessions cannot be added when a training course is not published. “ 400
“Oops, something went wrong.” 400
“Unauthorized.” 401
Glossary: Session Training
 
POST  API/ADMIN/v1/REST/Session/{session_guid}/Register/{learner_guid}/ version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#operation/postSessionRegistrationV1

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

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

Method : POST

Return :

This web-service returns a json object with the registration information.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment values
session_guid string the training session GUID. abcdef-12345-XXXXXXX-XXXXXXX
learner_guid string the learner GUID. abcdef-12345-XXXXXXX-XXXXXXX

Request : 


POST /API/ADMIN/v1/REST/Session/XXXX-0652-3C4D-908B-8475A9/Register/XXXX-47C3-CD84-A35C-8AB862/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of registration counted by the web-service.
count integer The number of registration returned by the web-service.
value object An object or a list of objects containing the data in response to the request.
guid string The GUID of the registration.
sessionGuid string The GUID of the training session.
trainingGuid string The title of the training.
learnerGuid string The learner GUID.
registrationDate string The registration date.
firstLaunchDate string The first access date to the registration.
lastAccessDate string The last access date to the training.
completionDate string The first completion date of the training.
timespent integer The learner time spent (seconds) in the training session.
progress integer The learner progression in the training session.
progressMandatory integer The learner progression in the training session for mandatory contents.
score integer The learner score in the training session.
progressStatus string The learner status in the training session for mandatory contents.
points integer The learner points in the training session for mandatory contents.
_links object The web-service endpoints related to the current object (registration).
self string The web-service endpoint of to the current object (registration).
session string The web-service endpoint of the trainnig session related to the registration.
training string The web-service endpoint of the trainnig related to the registration.
learner string The web-service endpoint of the learner related to the registration.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXX-A9D0-B239-F091-344F27E0A49A",
            "sessionGuid": "XXXX-0652-3C4D-908B-8475A9E0D1CD",
            "trainingGuid": "XXXX-B83E-7A8C-CA0D-B1A5E38F073D",
            "learnerGuid": "XXXX-47C3-CD84-A35C-8AB8622AFCE6",
            "registrationDate": "2017-09-27 14:01:23",
            "firstLaunchDate": null,
            "lastAccessDate": null,
            "completionDate": null,
            "timeSpent": 0,
            "progress": 0,
            "progressMandatory": 0,
            "score": 0,
            "progressStatus": "N",
            "points": null,
            "_links": {
                "self": "/API/ADMIN/v1/REST/Registration/XXXX-A9D0-B239-F091-344F27E0A49A/",
                "session": "/API/ADMIN/v1/REST/Session/XXXX-0652-3C4D-908B-8475A9E0D1CD/",
                "training": "/API/ADMIN/v1/REST/Training/XXXX-B83E-7A8C-CA0D-B1A5E38F073D/",
                "learner": "/API/ADMIN/v1/REST/Learner/XXXX-47C3-CD84-A35C-8AB8622AFCE6/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Registration/XXXX-A9D0-B239-F091-344F27E0A49A/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“Unauthorized” 401
Glossary: Training Session Registration Tracking Context
 
GET  API/ADMIN/v1/REST/Registration/{registration_guid}/ version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#operation/getRegistration

This web-service allows to get a given registration information

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

Method : GET

Return :

This web-service returns a json object with the registration data.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
registration_guid string The registration GUID. abcdef-12345-XXXXXXX-XXXXXXX

Request : 


GET /API/ADMIN/v1/REST/Registration/XXXX-5D10-3E39-9247-92E9A/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Cache-Control: no-cache

Response:

Returned data:

Label Type Comment
message string a message indicating the success or the reason of the failure
success boolean Describes if the web-service call was a success or not. (true or false).
totalCount integer The number of registration counted by the web-service.
count integer The number of registration returned by the web-service.
value array An array or a list of objects containing the data in response to the request.
guid string The GUID of the registration.
sessionGuid string The GUID of the training session.
trainingGuid string The title of the training.
learnerGuid string The learner GUID.
registrationDate string The registration date.
firstLaunchDate string The first access date to the registration.
lastAccessDate string The last access date to the training.
completionDate string The first completion date of the training.
timespent integer The learner time spent (seconds) in the training session.
progress integer The learner progression in the training session.
progressMandatory integer The learner progression in the training session for mandatory contents.
score integer The learner score in the training session.
progressStatus string The learner status in the training session for mandatory contents.
points integer The learner points in the training session for mandatory contents.
_links object The web-service endpoints related to the current object (registration).
self string The web-service endpoint of to the current object (registration).
session string The web-service endpoint of the trainnig session related to the registration.
training string The web-service endpoint of the trainnig related to the registration.
learner string The web-service endpoint of the learner related to the registration.

Example of JSON response :


{
    "message": "OK",
    "success": true,
    "totalCount": 1,
    "count": 1,
    "value": [
        {
            "guid": "XXXX-5D10-3E39-9247-92E9A53222B2",
            "sessionGuid": "XXXX-4C9D-DE71-6B13-FAEBB13B5E21",
            "trainingGuid": "XXXX-C3E7-53FD-A8E8-B300FEE8EE68",
            "learnerGuid": "XXXX-47C3-CD84-A35C-8AB8622AFCE6",
            "registrationDate": "2017-09-27 13:59:14",
            "firstLaunchDate": null,
            "lastAccessDate": null,
            "completionDate": null,
            "timeSpent": 0,
            "progress": 0,
            "progressMandatory": 0,
            "score": 0,
            "progressStatus": "N",
            "points": null,
            "_links": {
                "self": "/API/ADMIN/v1/REST/Registration/XXXX-5D10-3E39-9247-92E9A53222B2/",
                "session": "/API/ADMIN/v1/REST/Session/XXXX-4C9D-DE71-6B13-FAEBB13B5E21/",
                "training": "/API/ADMIN/v1/REST/Training/XXXX-C3E7-53FD-A8E8-B300FEE8EE68/",
                "learner": "/API/ADMIN/v1/REST/Learner/XXXX-47C3-CD84-A35C-8AB8622AFCE6/"
            }
        }
    ],
    "_links": {
        "self": "/API/ADMIN/v1/REST/Registration/XXXX-5D10-3E39-9247-92E9A53222B2/"
    }
}

Codes and messages:

Message Code
“OK” 200
“No Content” 204
“Unauthorized” 401
Glossary: Learner Registration Training Session Tracking (Report) Context
 
DELETE  API/ADMIN/v1/REST/Registration/{registration_guid}/ version 1.0

Description :

For new implementations, please refer to: https://docs.crossknowledge.com/api/public/#operation/deleteRegistration

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

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

Method : DELETE

Return :

This web-service returns a json object in response of the delete action.

Parameters :

 Get your CrossKnowledge Learning Suite API key now.
Label Type Required Comment Values
registration_guid string the registration GUID. abcdef-12345-XXXXXXX-XXXXXXX

Request : 


DELETE /API/ADMIN/v1/REST/Registration/XXXX-A9D0-B239-F091-344F27E0A49A/ HTTP/1.1
Host: yourdomain.crossknowledge.com
API-KEY: XXXX-4E19-752A-DB81-5087AB7CA438	
Content-Type: application/x-www-form-urlencoded
Cache-Control: no-cache

Response:

Returned data:

No return.

Codes and messages:

Message Code
“OK” 200
“No Content” 204
Glossary: Learner Learning Object Training Session Tracking (Report) Context