Quickstart

This guide provides a quick overview of the Powerpath API, which allows students to view courses, attempt questions, and track their results. The API is designed around the concept of achieving a scor

Base URL

All API requests should be made to:

https://api.alpha1edtech.com

Getting Started

1. Find a User

To find a user by their email:

GET /users?email={email}

Example response:

[
  {
    "id": 3132,
    "status": "active",
    "givenName": "John",
    "familyName": "Doe",
    "email": "[email protected]",
    // ... other user details
  }
]

2. List Available Courses

To get an array of available courses:

GET /courses

Example response:

[
  {
    "id": 128,
    "title": "3rd Grade Language",
    "schoolYear": "2024",
    "courseCode": "3rd Grade Language",
    // ... other course details
  },
  // ... more courses
]

3. Get User's Course Progress

To retrieve a user's progress in a specific course:

GET /users/{userId}/courses/{courseId}

This returns all modules in sequential order, with items in each module.

4. Get the Next Question

To fetch the next question for a user in a specific item:

GET /users/{userId}/items/{itemId}/question/next

Example response:

{
  "id": 68633,
  "material": "Which of the following words is correctly divided into syllables?",
  "responses": [
    {
      "id": 119529,
      "label": "ad-ven-ture",
      "isCorrect": true
    },
    // ... other response options
  ]
}

5. Submit a Result

To update the result of an item after a user answers a question:

POST /users/{userId}/results

Request body:

{
  "calculateMastery": true,
  "ccItemId": 68633,
  "result": {
    "type": "Result",
    "resultDescription": "Question answered"
  },
  "isCorrect": true
}

Best Practices

1. Always use the user's email to find their user ID before making user-specific requests.

2. Progress through modules and items sequentially until the progress reaches 100.

3. Use the calculateMastery flag when submitting results to get updated progress information.