Quiz API and Integration options

When you give your exams online, ClassMarker allows you to integrate your own user ids to be saved with users test results, allowing you to easily export or send your user ids (along with respective test results) back to your own website in real time.

Use the information below to pass details, such as your systems user_id or other test takers details, to ClassMarker.

Our Online Testing API allows your web developer private access to extract your test results back into your system.

What is an API?

For Developers

1. Pass user details to ClassMarker | Return users to your website

2. Online testing API Documentation

Integrate exams and quizzes with ClassMarker's API

Integrate your own user ids

You can record your own users ids by automatically appending them to the Link your users click to take their test (if they are logged in to your website for example).

Example:
http://www.classmarker.com/online-test/start?quiz=XXXX...&cm_user_id=123

cm_user_id can be any alphanumeric string under 100 characters long.

The cm_user_id will hold your users "user id for your system" and will save this against their test results.

The cm_user_id can be used to:

You can also require tests can only be taken if a user_id is supplied, and limit each user id to one attempt only per test (See Link settings when assigning Tests).

Populate users details as well if you prefer - see "Pre-populate user details" below.

Pre-populate user details

When using our Direct link testing options, you can send your users details to ClassMarker to save them having to fill in their name and email address (should you select to require their details) before they start the test.

When you assign your test to a Direct link, you are given the unique link for your test. This is the link you can send users details to.

Send details using either GET or POST with the following parameters names.

Parameters names:
cm_fn=First name (optional)
cm_ln=Last name (optional)
cm_e=Email (optional)
cm_user_id=123 (optional)

GET Example:

http://www.classmarker.com/online-test/start?quiz=XXXX&
cm_fn=John&cm_ln=Smith&cm_e=john@example.com
&cm_user_id=123

POST Example:

<form action="http://www.classmarker.com/online-test/start/" method="post">
<input type="hidden" name="quiz" value="YOUR_UNIQUE_QUIZ_ID_GOES_HERE"/>
<input type="hidden" name="cm_fn" value="John"/>
<input type="hidden" name="cm_ln" value="Smith"/>
<input type="hidden" name="cm_e" value="john@example.com"/>
<p><input type="submit" value="Take your online test"/></p>
</form>

Return test results in real time

ClassMarker also lets you set a return link for users to follow back to your website after they have completed their test.

Return links can also have the users details, test score and duration appended to it for you to record in real time on your own website.

To use Return links:
Select to assign your test to a direct link from the Assign section, or edit an existing assigned test, then find the 'Return link' section to add your return link and check the box that reads, 'Append 'Test results' parameters to return LINK'. Each time a user completes your test and clicks your Return link, your test scores will be sent to your website on the Return link.

Example:
http://yourReturnLink?cm_ts=24.5&cm_tp=72.2&cm_td=0-12-35&
cm_fn=John&cm_ln=Smith&cm_e=john@example.com

Where:
cm_ts=Test Score (Points scored)
cm_tp=Test Percentage
cm_td=Test Duration (0-12-35 = 0h 12m 35s)
cm_fn=first name
cm_ln=last name
cm_e=email address

Notes:
1) At present cm_ts and cm_tp can be to given to one decimal place if applicable.
EG: 50 or 50.1. Please ensure your system will accept a value to 1 decimal place, 50.0 or 50.1 for future changes.
(For now convert any whole number to one decimal place on your end: 50 to 50.0).

2) In a future enhancement we will be adding an extra parameter cm_tsa=Test Score Available which will be (Total points available) for the Test.
(For now check is this parameter exists and ignore otherwise).

Return custom variables
You can also add your own unique parameters to be returned to you on the return link, by pre pending the parameter names with cm_return_

Example:
The parameter cm_return_employee_id=1234 will be returned to you as &cm_return_employee_id=1234

Note: cm_return_ paramater values are not saved with test results, only returned on the Return URL. Use cm_user_id explained above which will saved it's value with test results of required.

Restrict access with 'Access lists'

When testing non-registered users via a direct link or embedding tests within your website, as well as password protecting your tests, you also have the option to limit exactly who can access your tests by using 'Access list'.

An Access list is a list of unique identifiers you add (email address, employee ids, etc) that a user must use to access your test/s. You can limit how many times each unique identifier can be used per test and they are recorded along with the respective test results.

Both access list items and cm_user_id values can be exported to Excel format with test results, date taken, test duration and IP address.

These methods do not require users to be registered to take your tests, and if using access lists you can mass import identifiers when creating and editing lists.

Brand your tests

Easily add your own logos and colors to your test pages or embed them within your own website.