Ellie Assessments API Specification

Introduction

This guide tells you how to use the Ellie Assessments API to submit assignments from external systems.

API Endpoint

Base URL

• https://www.meadowtech.net/wp-json/ellie/v1/

Submit Assignment

• Endpoint: /submit-assignment
• Method: POST
• Description: Sends a new assignment using a file link that the server downloads.

Request

• Authentication: You need a special code (Bearer token) and a secret in the headers.
• Headers:
  • Authorization: Bearer <your-api-key>
  • secret: <your-secret-code>
  • Content-Type: application/json
• Body: A simple list with these items:
  • learner_email (required): The learner’s email (e.g., student@example.com).
  • file_name (required): The file name (e.g., assignment.docx).
  • file_content (required): A link to the file (e.g., https://zapier-dev-files.s3.amazonaws.com/...).
  • assignment_title (optional): The assignment’s name.
  • submitted_at (optional): When it was sent (e.g., 2025-07-28T06:24:00Z).
  • external_reference (optional): A code from another system.
  • source (optional): Where it came from (defaults to external).
• Example Request:

  {
      "learner_email": "student@example.com",
      "file_name": "assignment.docx",
      "file_content": "https://zapier-dev-files.s3.amazonaws.com/cli-platform/20296/abc123...",
      "assignment_title": "Module 3 Essay",
      "submitted_at": "2025-07-28T06:24:00Z",
      "external_reference": "moodle123",
      "source": "moodle"
  }
                  

Response

• Success (HTTP 200):
  • Body: A simple answer with:
    • status: Says success.
    • submitted_by: The email that sent it.
    • timestamp: When it was saved.
  • Example:

    {
        "status": "success",
        "submitted_by": "user@example.com",
        "timestamp": "2025-07-28 06:24:00"
    }
                            

• Error (HTTP 400):
  • Body: An error message like:
    • error: Says what went wrong (e.g., Failed to download file from URL: ...).
  • Example:

    {
        "error": "Failed to download file from URL: Invalid URL"
    }
                            

• Error (HTTP 401):
  • Body: Says {"error": "Missing API key or secret"}.
• Error (HTTP 403):
  • Body: Says {"error": "Invalid or inactive API key"} or {"error": "Invalid secret"}.
• Error (HTTP 404):
  • Body: Says {"error": "User not found"}.
• Error (HTTP 500):
  • Body: Says {"error": "Failed to save submission"} or {"error": "Failed to save temporary file"}.

Authentication

• Method: Use a special code (API key) and secret.
• API Key: Get this from the API Management panel.
• Secret: A unique code that goes with your API key.
• Validation: The server checks your code against a list and matches the secret.

Error Codes

Code	What It Means
200	Everything worked!
400	Something’s wrong (e.g., bad link or missing info)
401	You need to log in with the right code
403	Your code is wrong or not active
404	Can’t find the user
500	Something broke on our end