Get a student's placement state

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

import requests

url = "https://api.alpha-1edtech.ai/powerpath/placement/{studentId}"

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/placement/{studentId}', 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/placement/{studentId}",
  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/placement/{studentId}"

	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/placement/{studentId}")

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

{
  "Reading": {
    "startingGrade": 1,
    "currentGrade": 1,
    "highestGradeMastered": 0,
    "subjectLowestGrade": 0,
    "subjectHighestGrade": 8,
    "RIT": {},
    "results": [
      {
        "testId": "reading-placement-grade-1",
        "title": "Start Reading placement",
        "subject": "Reading",
        "grade": 1,
        "status": "NOT_STARTED",
        "source": "PLACEMENT"
      }
    ],
    "status": "IN_PROGRESS",
    "nextTestId": "reading-placement-grade-1",
    "nextAction": {
      "kind": "assign",
      "testId": "reading-placement-grade-1",
      "title": "Start Reading placement"
    }
  }
}

Placement

Get a student's placement state

Returns the current placement state for each subject.

nextTestId identifies a native TimeBack assessment. It cannot identify external work because external work has a URL instead of a TimeBack test ID.

Before the service enforced external Reading screeners, clients could skip them and open the next native test. After enforcement, the response for a pending screener was IN_PROGRESS with nextTestId: null. Clients then had no screener link.

nextAction supersedes nextTestId for placement actions. nextTestId remains in the response for older clients. It carries a value only for native TimeBack assessments.

nextAction describes only the next placement action for this response. It does not describe other work for the subject.

assign: A native TimeBack placement test is available. testId matches nextTestId, and title is its display label.
launch: Placement continues in an external application. nextTestId is null. url is the exact HTTPS destination, and title is its display label. A client must open url exactly as supplied. It must not add student, grade, result, or battery data.
null: No action object is present in this field.

For K-2 Reading, a launch action can point to AlphaLiteracy. Before this response exposes that action, TimeBack has created a pending generic AlphaLiteracy Assessment result in OneRoster. AlphaLiteracy discovers and resumes that result after sign-in. Provider-internal test selection is not part of this placement API contract.

GET

powerpath

placement

{studentId}

Get a student's placement state

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

import requests

url = "https://api.alpha-1edtech.ai/powerpath/placement/{studentId}"

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/placement/{studentId}', 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/placement/{studentId}",
  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/placement/{studentId}"

	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/placement/{studentId}")

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

{
  "Reading": {
    "startingGrade": 1,
    "currentGrade": 1,
    "highestGradeMastered": 0,
    "subjectLowestGrade": 0,
    "subjectHighestGrade": 8,
    "RIT": {},
    "results": [
      {
        "testId": "reading-placement-grade-1",
        "title": "Start Reading placement",
        "subject": "Reading",
        "grade": 1,
        "status": "NOT_STARTED",
        "source": "PLACEMENT"
      }
    ],
    "status": "IN_PROGRESS",
    "nextTestId": "reading-placement-grade-1",
    "nextAction": {
      "kind": "assign",
      "testId": "reading-placement-grade-1",
      "title": "Start Reading placement"
    }
  }
}

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 sourcedId of the student

Response

Success

Reading

object

Show child attributes

Language

object

Show child attributes

Vocabulary

object

Show child attributes

Writing

object

Show child attributes

Handwriting

object

Show child attributes

Science

object

Show child attributes

FastMath

object

Show child attributes

Math

object

Show child attributes

None

object

Show child attributes

Other

object

Show child attributes

⌘I