Tuesday 27 September 2016

KS API calls

A popular theme for our customers this year is to have closer integration between the KS system and other in-house IT systems. In particular, LMS, HR and E-Learning systems.

So, with this in mind, we have been working on creating a series of automated processes and API calls, which can simplify and speed up the exchange of key data across platforms.

Here is a brief summary of what we have created so far:

List assessments for logged in account:
https://online.knowledgesmart.net/api/api/assessments/getallassessments

Invite user to an assessment (replace the query string elements as required):
https://online.knowledgesmart.net/api/api/assessments/GetNewInvite?UserEmail=john@xyz.com&TestID=4841&FirstName=john&LastName=smith&Status=1

List users for account:
https://online.knowledgesmart.net/api/api/users/getallusers

Search users by name (change the name value to a name you want to search):
https://online.knowledgesmart.net/api/api/users/getusersbyname?name=john

Search users by id (change the userid value to an id you know):
https://online.knowledgesmart.net/api/api/users/getuserbyid?userid=xxxx

List results for account:
https://online.knowledgesmart.net/api/api/results/GetAllResults

List results for a user (change the userid value to an id you know):
https://online.knowledgesmart.net/api/api/results/GetResultsForUser?userid=xxxx

Show all results for a particular test id:
https://online.knowledgesmart.net/api/api/results/GetResultsForAssessment?testid=xxxx
It will return the results for a given test id for the logged in account.

Add a new user:
https://online.knowledgesmart.net/api/api/users/adduser?email=john@xyz.com&firstname=john&lastname=smith

Simply substitute the email/firstname/lastname to the user you would like to add. If a user already exists with that email address then that user is added to the account.

Get answers for a result:
https://online.knowledgesmart.net/api/api/results/getanswersforresult?resultid=xxxx

Pass in the resultid you would like to see the answers for. N.B. you would probably use the existing methods GetAllResults or GetResultsForUser first to get the list of results and their resultids which you could then pass in.


If you would like to schedule a call with our technical team, to discuss your own organisation's requirements for closer integration with KS user and results data, please do get in touch.

R

No comments:

Post a Comment