Send an end-of-week report email
curl --request POST \
--url https://api.alpha-1edtech.ai/edubridge/reports/eow/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"studentId": "student-alpha-001",
"year": "2026",
"period": "23",
"mode": "live",
"retryFailed": true
}
'import requests
url = "https://api.alpha-1edtech.ai/edubridge/reports/eow/send"
payload = {
"studentId": "student-alpha-001",
"year": "2026",
"period": "23",
"mode": "live",
"retryFailed": True
}
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({
studentId: 'student-alpha-001',
year: '2026',
period: '23',
mode: 'live',
retryFailed: true
})
};
fetch('https://api.alpha-1edtech.ai/edubridge/reports/eow/send', 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/edubridge/reports/eow/send",
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([
'studentId' => 'student-alpha-001',
'year' => '2026',
'period' => '23',
'mode' => 'live',
'retryFailed' => true
]),
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/edubridge/reports/eow/send"
payload := strings.NewReader("{\n \"studentId\": \"student-alpha-001\",\n \"year\": \"2026\",\n \"period\": \"23\",\n \"mode\": \"live\",\n \"retryFailed\": true\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/edubridge/reports/eow/send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"studentId\": \"student-alpha-001\",\n \"year\": \"2026\",\n \"period\": \"23\",\n \"mode\": \"live\",\n \"retryFailed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpha-1edtech.ai/edubridge/reports/eow/send")
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 \"studentId\": \"student-alpha-001\",\n \"year\": \"2026\",\n \"period\": \"23\",\n \"mode\": \"live\",\n \"retryFailed\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"studentId": "student-alpha-001",
"year": "2026",
"period": "23",
"mode": "live",
"reportVersionId": "<string>",
"outcome": "complete",
"deliveries": [
{
"recipientEmail": "jsmith@example.com",
"status": "provider_accepted",
"provider": "<string>",
"providerMessageId": "<string>",
"errorCode": "<string>",
"retryAfterSeconds": 1,
"createdAt": "<string>",
"updatedAt": "<string>"
}
]
}
}{
"error": "<string>",
"message": "<string>"
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "unauthorisedrequest"
}
]
},
"imsx_error_details": [
{}
]
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"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": [
{}
]
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Reports
Send an end-of-week report email
Synchronously requests one idempotent live delivery to each current parent/guardian, or a version-scoped test delivery to 1-5 recipients on an approved company domain. Historical report weeks are allowed when the report exists. Live callers may explicitly retry definitively failed deliveries without reopening successful or uncertain outcomes.
POST
/
edubridge
/
reports
/
eow
/
send
Send an end-of-week report email
curl --request POST \
--url https://api.alpha-1edtech.ai/edubridge/reports/eow/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"studentId": "student-alpha-001",
"year": "2026",
"period": "23",
"mode": "live",
"retryFailed": true
}
'import requests
url = "https://api.alpha-1edtech.ai/edubridge/reports/eow/send"
payload = {
"studentId": "student-alpha-001",
"year": "2026",
"period": "23",
"mode": "live",
"retryFailed": True
}
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({
studentId: 'student-alpha-001',
year: '2026',
period: '23',
mode: 'live',
retryFailed: true
})
};
fetch('https://api.alpha-1edtech.ai/edubridge/reports/eow/send', 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/edubridge/reports/eow/send",
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([
'studentId' => 'student-alpha-001',
'year' => '2026',
'period' => '23',
'mode' => 'live',
'retryFailed' => true
]),
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/edubridge/reports/eow/send"
payload := strings.NewReader("{\n \"studentId\": \"student-alpha-001\",\n \"year\": \"2026\",\n \"period\": \"23\",\n \"mode\": \"live\",\n \"retryFailed\": true\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/edubridge/reports/eow/send")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"studentId\": \"student-alpha-001\",\n \"year\": \"2026\",\n \"period\": \"23\",\n \"mode\": \"live\",\n \"retryFailed\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpha-1edtech.ai/edubridge/reports/eow/send")
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 \"studentId\": \"student-alpha-001\",\n \"year\": \"2026\",\n \"period\": \"23\",\n \"mode\": \"live\",\n \"retryFailed\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"studentId": "student-alpha-001",
"year": "2026",
"period": "23",
"mode": "live",
"reportVersionId": "<string>",
"outcome": "complete",
"deliveries": [
{
"recipientEmail": "jsmith@example.com",
"status": "provider_accepted",
"provider": "<string>",
"providerMessageId": "<string>",
"errorCode": "<string>",
"retryAfterSeconds": 1,
"createdAt": "<string>",
"updatedAt": "<string>"
}
]
}
}{
"error": "<string>",
"message": "<string>"
}{
"imsx_codeMajor": "failure",
"imsx_severity": "error",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "unauthorisedrequest"
}
]
},
"imsx_error_details": [
{}
]
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"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": [
{}
]
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
- Option 1
- Option 2
OneRoster student sourcedId
Minimum string length:
1Example:
"student-alpha-001"
Report year
Pattern:
^\d{4}$Example:
"2026"
End-of-week report week number, 1-53
Example:
"23"
Allowed value:
"live"Permit definitive failed outcomes to start a new attempt
Response
Email delivery outcomes
Show child attributes
Show child attributes
⌘I