Class PutPearsonQuestionCommand

Example

Use a bare-bones client and the command you need to make an API call.

import { Apiv2Client, PutPearsonQuestionCommand } from "@codegrade/apiv2-client"; // ES Modules import
// const { Apiv2Client, PutPearsonQuestionCommand } = require("@codegrade/apiv2-client"); // CommonJS import
// import type { Apiv2ClientConfig } from "@codegrade/apiv2-client";
const config = {}; // type is Apiv2ClientConfig
const client = new Apiv2Client(config);
const input = { // PutPearsonQuestionRequest
  tenantId: "STRING_VALUE", // required
  templateId: "STRING_VALUE", // required
  questionId: "STRING_VALUE", // required
  name: "STRING_VALUE", // required
  source: { // PutPearsonQuestionSource Union: only one key present
    coding: { // PutPearsonCodingQuestionSource
      assignmentId: Number("int"), // required
      viewCorrectAnswer: true || false, // required
    },
    multipleChoice: { // PearsonMultipleChoiceQuestionData
      question: "STRING_VALUE", // required
      answers: [ // PearsonMultipleChoiceQuestionAnswers // required
        { // PearsonMultipleChoiceQuestionAnswer
          answer: "STRING_VALUE", // required
          isCorrect: true || false,
          hint: "STRING_VALUE",
        },
      ],
      answerOrder: "index-order" || "random-order",
    },
    selectAll: { // PearsonSelectAllQuestionData
      question: "STRING_VALUE", // required
      answers: [ // PearsonSelectAllQuestionAnswers // required
        { // PearsonSelectAllQuestionAnswer
          answer: "STRING_VALUE", // required
          isCorrect: true || false,
          hints: { // PearsonSelectAllQuestionAnswerHints
            correct: "STRING_VALUE",
            incorrect: "STRING_VALUE",
          },
        },
      ],
      answerOrder: "index-order" || "random-order",
    },
  },
};
const command = new PutPearsonQuestionCommand(input);
const response = await client.send(command);
// { // PutPearsonQuestionResponse
//   questionId: "STRING_VALUE", // required
// };

Copy

Example: An MCQ Question

//
const input = {
  name: "The name of the MCQ step",
  questionId: "question-id",
  source: {
    multipleChoice: {
      answerOrder: "index-order",
      answers: [
        {
          answer: "An option, text in markdown.",
          hint: "Read the answer to find out which one is correct"
        },
        {
          answer: "The correct answer, must be given exactly once.",
          isCorrect: true
        }
      ],
      question: "The question text in markdown"
    }
  },
  templateId: "template-id",
  tenantId: "tenant-id"
};
const command = new PutPearsonQuestionCommand(input);
const response = await client.send(command);
/* response is
{ /* metadata only */ }
*/
Copy

Example: A Select All Question

//
const input = {
  name: "The name of the Select All Question step",
  questionId: "question-id",
  source: {
    selectAll: {
      answerOrder: "random-order",
      answers: [
        {
          answer: "Option 1, this one is correct",
          isCorrect: true
        },
        {
          answer: "Option 2, this one is wrong",
          isCorrect: false
        },
        {
          answer: "Option 3, this one is also correct",
          isCorrect: true
        }
      ],
      question: "The question text in markdown"
    }
  },
  templateId: "template-id",
  tenantId: "tenant-id"
};
const command = new PutPearsonQuestionCommand(input);
const response = await client.send(command);
/* response is
{ /* metadata only */ }
*/
Copy