Check if a student is eligible to self-request a test-out

curl --request GET \
  --url https://api.alpha-1edtech.ai/powerpath/test-out/getTestOutEligibility/{studentId}/{subject} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alpha-1edtech.ai/powerpath/test-out/getTestOutEligibility/{studentId}/{subject}"

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/test-out/getTestOutEligibility/{studentId}/{subject}', 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/test-out/getTestOutEligibility/{studentId}/{subject}",
  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/test-out/getTestOutEligibility/{studentId}/{subject}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.alpha-1edtech.ai/powerpath/test-out/getTestOutEligibility/{studentId}/{subject}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alpha-1edtech.ai/powerpath/test-out/getTestOutEligibility/{studentId}/{subject}")

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

{
  "eligible": true,
  "reason": "<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": [
    {}
  ]
}

Test Out

Check if a student is eligible to self-request a test-out

Checks whether a student can self-request an assessment to test out of their current grade level for a given subject.

The endpoint performs the following checks in order:

Verifies the student has an active enrollment for the subject in a non-placeholder course (endDate is null or in the future, and course metadata does not have placementPlaceholder set to true)
Fetches the student’s highest grade mastered for the subject
If the highest grade mastered is available, queries the assessment_results table for any existing fully-graded self-elected test-out at the next grade level (highestGradeMastered + 1)
If the highest grade mastered is not available, falls back to the active course sequence to determine the lowest assessment grade for the subject and checks for a prior test-out at that grade

Returns eligible: true if no prior test-out exists at the target grade. Returns eligible: false with a reason if the student has no qualifying active enrollment, or has already tested out.

Subject matching is case-insensitive. Supported subjects: Math, Reading, Language, Science, Writing, Vocabulary.

GET

powerpath

test-out

getTestOutEligibility

{studentId}

{subject}

Check if a student is eligible to self-request a test-out

curl --request GET \
  --url https://api.alpha-1edtech.ai/powerpath/test-out/getTestOutEligibility/{studentId}/{subject} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.alpha-1edtech.ai/powerpath/test-out/getTestOutEligibility/{studentId}/{subject}"

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/test-out/getTestOutEligibility/{studentId}/{subject}', 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/test-out/getTestOutEligibility/{studentId}/{subject}",
  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/test-out/getTestOutEligibility/{studentId}/{subject}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.alpha-1edtech.ai/powerpath/test-out/getTestOutEligibility/{studentId}/{subject}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alpha-1edtech.ai/powerpath/test-out/getTestOutEligibility/{studentId}/{subject}")

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

{
  "eligible": true,
  "reason": "<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": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

studentId

string

required

The OneRoster sourcedId of the student

subject

string

required

The subject to check eligibility for

Response

Eligibility result

eligible

boolean

required

Whether the student is eligible to test out

reason

string

The reason the student is not eligible, only present when eligible is false

Get student placement data

Create a self-elected student test-out assignment

⌘I

Overview

Caliper

CASE

CLR

EduBridge

OneRoster

PowerPath

QTI

Timeback Events

Webhooks

Check if a student is eligible to self-request a test-out

Authorizations

Path Parameters

Response