Statements

Use statement endpoints when you need to validate and ingest learner activity into SD Platform.

Base URL: https://api.simplestdata.com
Version: v1 Current
Client libraries: Ruby
Python
PHP
Java
Node.js
Go
.NET

Endpoint

Request

Send a JSON xAPI statement to the statements collection.

Request

curlJavaScriptPython

bash

curl https://api.simplestdata.com/v1/statements \
  -X POST \
  -H "Authorization: Bearer $SD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "actor": {
      "mbox": "mailto:learner@example.com",
      "name": "Example Learner"
    },
    "verb": {
      "id": "https://adlnet.gov/expapi/verbs/completed",
      "display": { "en-US": "completed" }
    },
    "object": {
      "id": "https://docs.simplestdata.com/activity/intro-course",
      "definition": {
        "type": "http://adlnet.gov/expapi/activities/course",
        "name": { "en-US": "Intro course" }
      }
    }
  }'

Response

Expect an accepted write response that returns the statement identifier and processing status.

Parameters

Authorization header: bearer token or API key for the target environment.
Content-Type: set to application/json.
Request body: a single xAPI statement document to validate and ingest.

Errors

400 Bad Request when the statement is malformed or a required field is missing.
401 Unauthorized when the caller is unauthenticated or targeting the wrong environment.
422 Unprocessable Entity when the statement is well-formed JSON but fails validation rules.