Create a learner-facing subject goal
curl --request POST \
--url https://api.alpha-1edtech.ai/goals/{studentId}/subjects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"objective": {
"value": "<string>"
},
"pacing": {
"endDate": "<string>",
"dailyTargetXP": 123
}
}
'import requests
url = "https://api.alpha-1edtech.ai/goals/{studentId}/subjects"
payload = {
"objective": { "value": "<string>" },
"pacing": {
"endDate": "<string>",
"dailyTargetXP": 123
}
}
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({
objective: {value: '<string>'},
pacing: {endDate: '<string>', dailyTargetXP: 123}
})
};
fetch('https://api.alpha-1edtech.ai/goals/{studentId}/subjects', 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/goals/{studentId}/subjects",
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([
'objective' => [
'value' => '<string>'
],
'pacing' => [
'endDate' => '<string>',
'dailyTargetXP' => 123
]
]),
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/goals/{studentId}/subjects"
payload := strings.NewReader("{\n \"objective\": {\n \"value\": \"<string>\"\n },\n \"pacing\": {\n \"endDate\": \"<string>\",\n \"dailyTargetXP\": 123\n }\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/goals/{studentId}/subjects")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"objective\": {\n \"value\": \"<string>\"\n },\n \"pacing\": {\n \"endDate\": \"<string>\",\n \"dailyTargetXP\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpha-1edtech.ai/goals/{studentId}/subjects")
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 \"objective\": {\n \"value\": \"<string>\"\n },\n \"pacing\": {\n \"endDate\": \"<string>\",\n \"dailyTargetXP\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"subject": {
"subject": "<string>",
"baseline": {
"goalId": "<string>",
"dailyTargetXP": 123,
"defaultDailyTargetXP": 123,
"startDate": "<string>",
"updatedAt": "<string>"
},
"goal": {
"id": "<string>",
"startDate": "<string>",
"updatedAt": "<string>",
"objective": {
"value": "<string>"
},
"pacing": {
"endDate": "<string>",
"dailyTargetXP": 123
}
},
"execution": {
"stageId": "<string>",
"courseIds": [
"<string>"
]
},
"computed": {
"xp": {
"total": 123,
"earned": 123,
"remaining": 123,
"pctComplete": 123
},
"pace": {
"requiredDailyXP": 123,
"effectiveDailyXP": 123,
"schoolDaysRemaining": 123
},
"projection": {
"currentGrade": "<string>",
"daysToNextGrade": 123,
"gradeTimeline": [
{
"grade": "<string>",
"remainingXP": 123,
"daysToComplete": 123,
"projectedDate": "<string>",
"totalXP": 123,
"earnedXP": 123,
"courseIds": [
"<string>"
]
}
]
},
"resolution": {
"resolvedTargetGrade": "<string>",
"targetRit": 123
},
"issue": {
"message": "<string>",
"service": "<string>",
"path": "<string>",
"status": 123
}
}
}
}{
"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": [
{}
]
}Goals
Create a learner-facing subject goal
Creates or replaces the active K-8 learner-facing outcome goal for a subject. The service resolves a stable routed course path at save time and stores that execution snapshot behind the product-shaped response.
POST
/
goals
/
{studentId}
/
subjects
Create a learner-facing subject goal
curl --request POST \
--url https://api.alpha-1edtech.ai/goals/{studentId}/subjects \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"objective": {
"value": "<string>"
},
"pacing": {
"endDate": "<string>",
"dailyTargetXP": 123
}
}
'import requests
url = "https://api.alpha-1edtech.ai/goals/{studentId}/subjects"
payload = {
"objective": { "value": "<string>" },
"pacing": {
"endDate": "<string>",
"dailyTargetXP": 123
}
}
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({
objective: {value: '<string>'},
pacing: {endDate: '<string>', dailyTargetXP: 123}
})
};
fetch('https://api.alpha-1edtech.ai/goals/{studentId}/subjects', 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/goals/{studentId}/subjects",
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([
'objective' => [
'value' => '<string>'
],
'pacing' => [
'endDate' => '<string>',
'dailyTargetXP' => 123
]
]),
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/goals/{studentId}/subjects"
payload := strings.NewReader("{\n \"objective\": {\n \"value\": \"<string>\"\n },\n \"pacing\": {\n \"endDate\": \"<string>\",\n \"dailyTargetXP\": 123\n }\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/goals/{studentId}/subjects")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"objective\": {\n \"value\": \"<string>\"\n },\n \"pacing\": {\n \"endDate\": \"<string>\",\n \"dailyTargetXP\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpha-1edtech.ai/goals/{studentId}/subjects")
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 \"objective\": {\n \"value\": \"<string>\"\n },\n \"pacing\": {\n \"endDate\": \"<string>\",\n \"dailyTargetXP\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"subject": {
"subject": "<string>",
"baseline": {
"goalId": "<string>",
"dailyTargetXP": 123,
"defaultDailyTargetXP": 123,
"startDate": "<string>",
"updatedAt": "<string>"
},
"goal": {
"id": "<string>",
"startDate": "<string>",
"updatedAt": "<string>",
"objective": {
"value": "<string>"
},
"pacing": {
"endDate": "<string>",
"dailyTargetXP": 123
}
},
"execution": {
"stageId": "<string>",
"courseIds": [
"<string>"
]
},
"computed": {
"xp": {
"total": 123,
"earned": 123,
"remaining": 123,
"pctComplete": 123
},
"pace": {
"requiredDailyXP": 123,
"effectiveDailyXP": 123,
"schoolDaysRemaining": 123
},
"projection": {
"currentGrade": "<string>",
"daysToNextGrade": 123,
"gradeTimeline": [
{
"grade": "<string>",
"remainingXP": 123,
"daysToComplete": 123,
"projectedDate": "<string>",
"totalXP": 123,
"earnedXP": 123,
"courseIds": [
"<string>"
]
}
]
},
"resolution": {
"resolvedTargetGrade": "<string>",
"targetRit": 123
},
"issue": {
"message": "<string>",
"service": "<string>",
"path": "<string>",
"status": 123
}
}
}
}{
"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
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Student sourcedId
Body
application/json
Response
Subject goal created
Show child attributes
Show child attributes
⌘I