Lectful icon

Lectful

Interact with the VIPay Lectful API

Overview

The "Get Results" operation of the "Quiz Submission" resource in this node allows users to retrieve the results of a quiz submission for a specific quiz lecture from the Lectful API. This is useful in scenarios where you want to programmatically access quiz outcomes, such as scores, answers, or detailed result data, after a user has completed a quiz.

Practical examples include:

  • Automatically fetching quiz results to trigger follow-up actions like awarding certificates.
  • Integrating quiz performance data into external reporting or analytics tools.
  • Displaying quiz results within custom dashboards or learning management systems.

Properties

Name Meaning
Authentication Mode Choose how to authenticate with the Lectful API:
- Use Stored Credentials
- Manual Configuration (provide base URL and API key manually)
Credentials Note Informational note shown when using Manual Configuration mode about leaving credentials empty and using overrides instead.
Base URL Override Optional base URL to override the stored credential's base URL (excluding /api/v1). Used only in Manual Configuration mode.
API Key Override Optional API key to override the stored credential's API key. Used only in Manual Configuration mode.
Lecture ID The ID of the quiz lecture for which to get the quiz results. This is required.

Output

The output JSON contains the quiz results data returned by the Lectful API for the specified quiz lecture. The exact structure depends on the API response but typically includes details such as:

  • User answers
  • Scores or grades
  • Question-wise feedback or correctness
  • Overall quiz completion status

No binary data is output by this operation.

Dependencies

  • Requires access to the Lectful API.
  • Requires either stored API credentials configured in n8n or manual entry of the base URL and API key.
  • The node uses HTTP requests with Bearer token authentication to communicate with the Lectful API.

Troubleshooting

  • Missing or invalid credentials: If neither valid stored credentials nor manual configuration parameters are provided, the node will throw an error indicating that valid credentials are required.
  • Base URL or API key missing in manual mode: When using Manual Configuration mode, both the Base URL Override and API Key Override must be provided; otherwise, an error is thrown.
  • Invalid Lecture ID: Providing an incorrect or non-existent lecture ID may result in API errors or empty responses.
  • API connectivity issues: Network problems or incorrect base URLs can cause request failures.
  • To resolve these, verify credentials, ensure correct lecture IDs, and confirm network connectivity.

Links and References

  • Lectful API Documentation (Assumed official API docs for further details on quiz results endpoint)
  • n8n documentation on HTTP Request Node for understanding underlying request mechanisms (conceptual reference).

Discussion