Get assessment progress

curl --request GET \
  --url https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "lessonType": "powerpath-100",
  "remainingQuestionsPerDifficulty": {
    "easy": 123,
    "medium": 123,
    "hard": 123
  },
  "score": 123,
  "seenQuestions": [
    {
      "id": "<string>",
      "index": 123,
      "title": "<string>",
      "url": "<string>",
      "difficulty": "medium",
      "humanApproved": true,
      "content": {
        "rawXml": "<string>",
        "type": "<string>"
      },
      "response": "<string>",
      "responses": {},
      "correct": true,
      "result": {
        "score": 123,
        "feedback": "<string>",
        "outcomes": {}
      },
      "resultId": "<string>",
      "learningObjectives": [
        "<string>"
      ],
      "attachments": [
        {
          "id": "<string>",
          "filename": "<string>",
          "mimeType": "<string>",
          "fileSize": 123
        }
      ],
      "mapMetadata": {
        "difficultyRit": 123,
        "domain": "literary"
      },
      "playerState": "<string>"
    }
  ],
  "attempt": 123,
  "xp": 123,
  "multiplier": 123,
  "accuracy": 123,
  "correctQuestions": 123,
  "totalQuestions": 123,
  "testResultId": "<string>"
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "invaliddata"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "unauthorisedrequest"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "forbidden"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "unknownobject"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "invaliddata"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "server_busy"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "internal_server_error"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "server_busy"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

Lesson Mastery

Get assessment progress

Returns the progress the student has made in the given PowerPath lesson.

A ‘Lesson’ in this context is a ComponentResource object paired with a Resource object representing an activity.

The optional view query parameter controls the runtime projection for internal QTI-backed question content. Omit it, or use authoring, to return the full authored content. Use student-before-answer before rendering internal QTI-backed content to students; this removes answer-leaking content from the returned question XML/JSON. This sanitization only applies to internal QTI-backed content.

GET

powerpath

getAssessmentProgress

Get assessment progress

curl --request GET \
  --url https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.alpha-1edtech.ai/powerpath/getAssessmentProgress")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "lessonType": "powerpath-100",
  "remainingQuestionsPerDifficulty": {
    "easy": 123,
    "medium": 123,
    "hard": 123
  },
  "score": 123,
  "seenQuestions": [
    {
      "id": "<string>",
      "index": 123,
      "title": "<string>",
      "url": "<string>",
      "difficulty": "medium",
      "humanApproved": true,
      "content": {
        "rawXml": "<string>",
        "type": "<string>"
      },
      "response": "<string>",
      "responses": {},
      "correct": true,
      "result": {
        "score": 123,
        "feedback": "<string>",
        "outcomes": {}
      },
      "resultId": "<string>",
      "learningObjectives": [
        "<string>"
      ],
      "attachments": [
        {
          "id": "<string>",
          "filename": "<string>",
          "mimeType": "<string>",
          "fileSize": 123
        }
      ],
      "mapMetadata": {
        "difficultyRit": 123,
        "domain": "literary"
      },
      "playerState": "<string>"
    }
  ],
  "attempt": 123,
  "xp": 123,
  "multiplier": 123,
  "accuracy": 123,
  "correctQuestions": 123,
  "totalQuestions": 123,
  "testResultId": "<string>"
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "invaliddata"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "unauthorisedrequest"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "forbidden"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "unknownobject"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "invaliddata"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "server_busy"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "internal_server_error"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

{
  "imsx_codeMajor": "failure",
  "imsx_severity": "error",
  "imsx_description": "<string>",
  "imsx_CodeMinor": {
    "imsx_codeMinorField": [
      {
        "imsx_codeMinorFieldName": "TargetEndSystem",
        "imsx_codeMinorFieldValue": "server_busy"
      }
    ]
  },
  "imsx_error_details": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

student

string

required

The sourcedId of the student who is answering the question

lesson

string

required

The sourcedId of the lesson (ComponentResource)

attempt

string

The attempt number of the lesson that the student is answering

view

enum<string>

Runtime QTI projection to return. Omit or use 'authoring' for full authored content. Use 'student-before-answer' before rendering to students to remove answer-leaking content.

Available options:

authoring,

student-before-answer

Response

Success

Option 1
Option 2
Option 3

Represents the progress of the student in the PowerPath100 lesson

lessonType

string

required

Allowed value: "powerpath-100"

remainingQuestionsPerDifficulty

object

required

Show child attributes

score

number

required

The current score for this attempt

seenQuestions

object[]

required

Show child attributes

attempt

number

required

The attempt number

number | null

required

The XP the student has earned in the lesson

multiplier

number | null

required

The multiplier for the student's XP

accuracy

number

required

The accuracy of the student's attempted questions

correctQuestions

number

required

The number of correct questions the student has answered in the lesson

totalQuestions

number

required

The total number of questions in the lesson

testResultId

string

The sourcedId of the parent test AssessmentResult

⌘I

Overview

Caliper

CASE

CLR

EduBridge

OneRoster

PowerPath

QTI

Timeback Events

Webhooks

Open Badges

Platform API

Get assessment progress

Authorizations

Query Parameters

Response