Create a self-elected student test-out assignment

curl --request POST \
  --url https://api.alpha-1edtech.ai/powerpath/test-out/makeExternalStudentTestOutAssignment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "oneRosterSourcedId": "<string>",
  "subject": "<string>"
}
'

import requests

url = "https://api.alpha-1edtech.ai/powerpath/test-out/makeExternalStudentTestOutAssignment"

payload = {
    "oneRosterSourcedId": "<string>",
    "subject": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({oneRosterSourcedId: '<string>', subject: '<string>'})
};

fetch('https://api.alpha-1edtech.ai/powerpath/test-out/makeExternalStudentTestOutAssignment', 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/makeExternalStudentTestOutAssignment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'oneRosterSourcedId' => '<string>',
    'subject' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.alpha-1edtech.ai/powerpath/test-out/makeExternalStudentTestOutAssignment"

	payload := strings.NewReader("{\n  \"oneRosterSourcedId\": \"<string>\",\n  \"subject\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.alpha-1edtech.ai/powerpath/test-out/makeExternalStudentTestOutAssignment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"oneRosterSourcedId\": \"<string>\",\n  \"subject\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"oneRosterSourcedId\": \"<string>\",\n  \"subject\": \"<string>\"\n}"

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

{
  "success": true,
  "data": {}
}

{
  "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": [
    {}
  ]
}

{
  "httpStatus": 409,
  "success": false,
  "error": "Assignment already exists",
  "data": {
    "existing_assignment": {
      "id": 123,
      "test_url": "<string>",
      "status": "<string>",
      "test_name": "<string>",
      "expires_at": "<string>"
    },
    "message": "<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": "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

Create a self-elected student test-out assignment

Creates an AlphaTest test-out assignment for a student on a given subject.

The endpoint performs the following steps:

Looks up the student’s email using their OneRoster sourcedId
Checks eligibility: the student must have an active enrollment in a non-placeholder course for the subject
Resolves eligibility and the target grade atomically
When advancing from mastered K-2 Reading to the next grade’s test-out, requires a passed ORF screener at the mastered grade (summer-experience students retain their configured waiver while its feature flag is enabled)
Assigns exactly the target grade returned by the eligibility decision
For FastMath Kindergarten and above, selects the first unpassed operation from the active sequence and forwards its exact gradeAssessmentTag

The assignment payload sent to AlphaTest includes:

test_type: “test out”
origin: “self-elected”
metadata.gradeAssessmentTag for FastMath Kindergarten and above (PreK accuracy assignments remain untagged)

Will fail if:

The student does not exist or has no email
The student does not have an active enrollment for the subject (or the course has placementPlaceholder set to true)
The assignment would be the student’s entry into a gated subject and the subject’s all-source placement prerequisites are unmet while FF_TEST_OUT_ENTRY_PLACEMENT_GATE is enabled
Advancing from mastered K-2 Reading is still blocked by that grade’s ORF gate
The test-out grade cannot be determined (no highest grade mastered and no active course sequence with assessment stages)
The AlphaTest API returns an error

POST

powerpath

test-out

makeExternalStudentTestOutAssignment

Create a self-elected student test-out assignment

curl --request POST \
  --url https://api.alpha-1edtech.ai/powerpath/test-out/makeExternalStudentTestOutAssignment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "oneRosterSourcedId": "<string>",
  "subject": "<string>"
}
'

import requests

url = "https://api.alpha-1edtech.ai/powerpath/test-out/makeExternalStudentTestOutAssignment"

payload = {
    "oneRosterSourcedId": "<string>",
    "subject": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({oneRosterSourcedId: '<string>', subject: '<string>'})
};

fetch('https://api.alpha-1edtech.ai/powerpath/test-out/makeExternalStudentTestOutAssignment', 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/makeExternalStudentTestOutAssignment",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'oneRosterSourcedId' => '<string>',
    'subject' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.alpha-1edtech.ai/powerpath/test-out/makeExternalStudentTestOutAssignment"

	payload := strings.NewReader("{\n  \"oneRosterSourcedId\": \"<string>\",\n  \"subject\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.alpha-1edtech.ai/powerpath/test-out/makeExternalStudentTestOutAssignment")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"oneRosterSourcedId\": \"<string>\",\n  \"subject\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"oneRosterSourcedId\": \"<string>\",\n  \"subject\": \"<string>\"\n}"

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

{
  "success": true,
  "data": {}
}

{
  "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": [
    {}
  ]
}

{
  "httpStatus": 409,
  "success": false,
  "error": "Assignment already exists",
  "data": {
    "existing_assignment": {
      "id": 123,
      "test_url": "<string>",
      "status": "<string>",
      "test_name": "<string>",
      "expires_at": "<string>"
    },
    "message": "<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": "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.

Body

application/json

oneRosterSourcedId

string

required

The OneRoster sourcedId of the student who will take the test

Minimum string length: 1

subject

string

required

The subject for which the student will test out (e.g. Math, FastMath, Reading, Language, Science, Writing, Vocabulary)

Response

Assignment created

success

boolean

required

data

object

Show child attributes

⌘I