xamJoint
docs

Integration Guide

Introduction
Create Exam
Manage Exam
Manage Attendance
Manage Results
Events And Webhook
xamJoint
docs

Create Exam

To create an exam, you'll need to send a POST request with the exam details. Below is an example:
{
  "name": "Introduction to Data Science DSC101",
  "platform": [
    "android",
    "ios",
    "web"
  ],
  "enforceDesktop": false,
  "analytics": {
    "device": true,
    "ip": true,
    "focusing": true
  },
  "openOn": 1719046628502,
  "closeOn": 1719064544928,
  "duration": 1200,
  "restricted_commands": [
    "copy",
    "cut",
    "paste",
    "right_mouse",
    "...more"
  ],
  "logo": "data:base64,WHV4MnJsN2oyZUdmb...",
  "translation": {
    "enableSelection": true,
    "entire": false,
    "langs": [
      "en",
      "zh",
      "ru",
      "de",
      "vi",
      "...more"
    ]
  },
  "redirectionLink": "https://exam.feedback.stanford.com/respondent",
  "monitoring": {
    "cam": true,
    "screen": true
  },
  "result": {
    "availability": "instant",
    "public": false,
    "viewableAns": true
  },
  "respondant": {
    "enforceUser": false,
    "multipleUserAttempts": false,
    "privateExam": false,
    "multipleInvitationAttempts": false,
    "multipleDeviceAttempt": false,
    "resumable": true,
    "charge": false
  },
  "welcomePage": {
    "content": [
      {
        "type": "text",
        "value": "Your custom html text goes here.."
      },
      {
        "type": "about",
        "value": "Enter Matric No."
      },
      {
        "type": "input",
        "value": "Enter Password"
      }
    ],
    "validate": false,
    "multipleAttempts": false
  },
  "thankYouPage": "<div>Thank you for your participation</div>",
  "courses": [
    {
      "title": "Data Wrangling and Cleaning",
      "shuffleQ": true,
      "shuffleOption": false,
      "limit": 1,
      "questions": [
        {
          "q": "Which of the following methods is used to handle missing values in a dataset?",
          "opt": [
            "Normalization",
            "One-Hot Encoding",
            "Imputation",
            "PCA (Principal Component Analysis)"
          ],
          "ans": [
            2
          ],
          "type": "radio",
          "points": 1
        },
        {
          "q": "Explain the process of data cleaning and why it is important in data science. Include examples of common issues found in raw data and how they can be addressed.",
          "type": "free",
          "points": 3
        }
      ]
    },
    {
      "title": "Statistical Analysis and Visualization",
      "shuffleQ": true,
      "shuffleOption": false,
      "questions": [
        {
          "q": "Which of the following are common types of data visualizations used in exploratory data analysis (EDA)? (Select all that apply)",
          "opt": [
            "Bar Chart",
            "Histogram",
            "Scatter Plot",
            "Decision Tree"
          ],
          "ans": [
            0,
            1,
            2
          ],
          "type": "checkbox"
        },
        {
          "q": "Which statistical measure is used to describe the spread or dispersion of a set of data points?",
          "ans": [
            "Standard Deviation",
            "S.D",
            "SD"
          ],
          "type": "exact_or"
        },
        {
          "q": "List 3 methods for measures of central tendency?",
          "ans": [
            "Mean",
            "Median",
            "Mode"
          ],
          "type": "exact_and"
        }
      ]
    }
  ]
}

Explanation

Individual fields and values are explained as follows:
FieldsTypeRequiredDescription
nameString✅This will be the name given to your exam.
It must not be greater than 200 characters
platformArray✅This array should contain platforms you want this exam to support.
Valid values are android, ios and web
enforceDesktopBoolean❌True if this exam can only be taken on devices with screen resolution width greater than 999 pixels. Defaults to false
openOnNumber❌This is the time when the exam should be available.<br /> It is expected to be in epoch time format, which is the number of milliseconds that have elapsed since midnight (UTC) on January 1, 1970.
closeOnNumber❌This is the time when the exam is no longer available.<br /> It is expected to be in epoch time format, which is the number of milliseconds that have elapsed since midnight (UTC) on January 1, 1970.
durationNumber❌This is the maximum seconds within which the respondent can complete the exam.
logoString❌This can be either the base64 data for the exam logo or an HTTPS URL pointing to a valid image.
monitoring.camBoolean❌True if you want to record the respondent cam
monitoring.screenBoolean❌True if you want to record the respondent screen
analytics.deviceBoolean❌True if you want to log respondent device info
analytics.ipBoolean❌True if you want to log the respondent public ip address
analytics.focusingBoolean❌True if you want to log and flag when the respondent loses focus on the exam screen
restricted_commandsArray❌This array should contain the commands to be restricted when respondent is taking their exam.


copy: This should disable any command that are associated with copying text on the exam page (e.g CTRL+C, CMD+C).
cut: This should disable any command that are associated with cutting text on the exam page (e.g CTRL+X, CMD+X).
paste: This should disable any command that are associated with pasting text on the exam page (e.g CTRL+V, CMD+V).
right_mouse: This should disable mouse right click
print: This should disable any command that are associated with printing the exam page (e.g CTRL+P, CMD+P).
fullscreen: This should disable any command that are associated with entering fullscreen on the exam page (e.g CTRL+CMD+F).
shortcut: This should disable all shortcut key (e.g ArrowUp, ArrowDown, ArrowLeft, ArrowRight, n, p, 1 - 9)
sci_cal: This should disable the scientific calculator
basic_cal: This should disable the basic calculator
result.availabilityString✅This can be any of the following:

instant: If you want respondent result to be available instantly
manual: If you want to release respondent result manually
off: If you don't intend to release respondent result on our platform
result.publicBoolean✅True if you want all respondent to see each other scores
result.viewableAnsBoolean✅True if you want respondent to see there markings and attempts
respondant.enforceUserBoolean✅Enforce user sign-in for respondents.
respondant.multipleUserAttemptsBoolean❌Enable multiple attempts from the same user. Defaults to false.
Please note: this value will be ignored if respondant.enforceUser is false
respondant.privateExamBoolean✅True if you want this exam to be taken only by respondents you have invited.
respondant.multipleInvitationAttemptsBoolean❌Enable multiple attempts from the same invitation link. Defaults to false
Please note: this value will be ignored if respondant.privateExam is false
respondant.multipleDeviceAttemptBoolean❌Enable multiple attempts from the same browser or device. Defaults to false
respondant.resumableBoolean❌Make exam resumable when respondent reloads the page. Defaults to false
respondant.chargeBoolean❌Charge respondent the required token for taking this exam. Defaults to false
respondant.limitNumer❌This should be a positive whole number representing the maximum respondent that can attempt this exam
redirectionLinkString❌Providing this will redirect the user to the specified link when the test is completed, with appended query parameter of respondent_id=unique_id.

For example, if you provided https://exam.feedback.stanford.com/respondent as your redirection link, respondent will be redirected to https://exam.feedback.stanford.com/respondent?respondent_id=unique_id. where unique_id will be the id of the respondent.
translation.enableSelectionBoolean❌True if you want to enable language selection or use the default system language
translation.entireBoolean❌True if you want to translate the entire exam text, including questions and options
translation.langsArray❌This array should contain the ISO 639-1 language codes in which you want your exam translation to be available in.

Supported Languages
  • English (en)
  • French (fr)
  • Chinese (zh)
  • German (de)
  • Swahili (sw)
  • Spanish (es)
  • Russian (ru)
  • Portuguese (pt)
  • Hindi (hi)
  • Arabic (ar)
  • Bengali (bn)
  • Japanese (ja)
  • Korean (ko)
  • Italian (it)
  • Turkish (tr)
  • Vietnamese (vi)
  • Dutch (nl)
  • Thai (th)
  • Indonesian (id)
  • Polish (pl)
  • Malay (ms)
  • Filipino (tl)
  • Swedish (sv)
  • Greek (el)
  • Czech (cs)
  • Romanian (ro)
  • Hungarian (hu)
  • Ukrainian (uk)
  • Hebrew (he)
  • Farsi (fa)
  • Danish (da)
  • Norwegian (no)
  • Finnish (fi)
  • Bulgarian (bg)
  • Albanian (sq)
  • Latvian (lv)
  • Mongolian (mn)
  • Slovak (sk)
  • Catalan (ca)
  • Georgian (ka)
  • Lithuanian (lt)
  • Serbian (sr)
welcomePage.validateBoolean❌True if you want to validate the field values of welcomePage.content via your webhook url. Defaults to false.
welcomePage.multipleAttemptsBoolean❌True if you want allow multiple attempt of same field values. Default to false.
welcomePage.content.typeString❌Render content at the top of the exam welcome page
value can be any of the following:

text: renders text or html content.
input: renders input field, corresponding welcomePage.content.value will be used as a placeholder for the input field.
thankYouPageString❌Text or html content that is displayed to the respondent after they completes or submits their exam.
courses.titleString✅The title of the course
courses.shuffleQBoolean❌True to shuffle the questions in this section
courses.shuffleOptionBoolean❌True to shuffle the options in questions with radio or checkbox
courses.limitInteger❌An whole positive integer value that limit the maximum number of questions the respondent can attempt on this course
courses.questions.qString✅individual question in text or html form.
courses.questions.optArray❌The options of the question. Should be an array of string, can support upto 26 items.
This should only be provided if courses.questions.type is either "radio" or "checkbox".
courses.questions.ansArray❌The answer to the question.If courses.questions.type is either "radio" or "checkbox", this should be an array of integer as the position of correct options.Else if courses.questions.type is either "exact" or "exact_and", then it should be an array of string.
courses.questions.typeString✅Value can be any of the following:

radio: suitable when the question has options with a single answer.
checkbox: suitable when the question has an options with a multiple answer.
exact: check against the respondent attempt with the correct answer using bitwise OR.
exact_and: check against the respondent attempt with the correct answer using bitwise AND.
free: suitable when answer to the question is a free text, such as an essay or explanation. Please note that question like this will be mark by our ai engine.
courses.questions.pointsNumber❌numbers of points to be assign to this question. Defaults to 1
courses.questions.expString❌explanation for the correct answer to the question.

Edit Exam

When editing an existing exam, You are not allowed to update the monitoring, result and respondant field. But you can update the limit in the respondent field as respondant.limit.
No merge operation is performed when updating a field that contains an object or array as its value. Instead, the entire value of such a field is replaced with the new one.
You can set a field to null if you want to remove it


To edit an existing exam, you'll need to send a PUT request along with the exam_id.
{
  "platform": [
    "web"
  ],
  "openOn": null,
  "restricted_commands": [
    "copy",
    "cut",
    "paste"
  ],
  "translation": {
    "enableSelection": true,
    "entire": true,
    "langs": [
      "en",
      "zh",
      "ru"
    ]
  },
  "questions": [
    {
      "title": "Data Wrangling and Cleaning",
      "shuffleQ": true,
      "shuffleOption": false,
      "limit": 1,
      "questions": [
        {
          "q": "Which of the following methods is used to handle missing values in a dataset?",
          "opt": [
            "Normalization",
            "One-Hot Encoding",
            "Imputation",
            "PCA (Principal Component Analysis)"
          ],
          "ans": [
            2
          ],
          "type": "radio",
          "points": 1
        },
        {
          "q": "Explain the process of data cleaning and why it is important in data science. Include examples of common issues found in raw data and how they can be addressed.",
          "type": "free",
          "points": 3
        }
      ]
    },
    {
      "title": "Statistical Analysis and Visualization",
      "shuffleQ": true,
      "shuffleOption": false,
      "questions": [
        {
          "q": "Which of the following is a Python library used for data visualization?",
          "opt": [
            "NumPy",
            "Pandas",
            "Matplotlib",
            "Scikit-learn"
          ],
          "ans": [
            2
          ],
          "type": "radio"
        },
        {
          "q": "Discuss the importance of exploratory data analysis (EDA) in data science and describe how visualization tools can be used to perform EDA.",
          "type": "free",
          "points": 2
        }
      ]
    }
  ]
}

Delete Exam

To delete an exam, you'll need to send a DELETE request along with the exam_id.
Deleting an exam will delete every data associated with such exam, including all media data, questions and respondent data
{
  "x-client-id": "xxx-xxx-xxx",
  "x-client-secret": "xxxxxxx",
  "content-type": "application/json"
}

Feedback Comments (0)

Sign In

Integration Guide

Introduction
Create Exam
Manage Exam
Manage Attendance
Manage Results
Events And Webhook