Create a new Grading Period for a Term
curl --request POST \
--url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"academicSession": {
"sourcedId": "<string>",
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"type": "<string>",
"schoolYear": "<string>",
"org": {
"sourcedId": "<string>"
},
"tenantId": "<string>",
"clientAppId": "<string>",
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {},
"parent": {
"sourcedId": "<string>"
},
"children": [
{
"href": "<string>",
"sourcedId": "<string>"
}
]
}
}
'import requests
url = "https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods"
payload = { "academicSession": {
"sourcedId": "<string>",
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"type": "<string>",
"schoolYear": "<string>",
"org": { "sourcedId": "<string>" },
"tenantId": "<string>",
"clientAppId": "<string>",
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {},
"parent": { "sourcedId": "<string>" },
"children": [
{
"href": "<string>",
"sourcedId": "<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({
academicSession: {
sourcedId: '<string>',
title: '<string>',
startDate: '<string>',
endDate: '<string>',
type: '<string>',
schoolYear: '<string>',
org: {sourcedId: '<string>'},
tenantId: '<string>',
clientAppId: '<string>',
dateLastModified: '2023-11-07T05:31:56Z',
metadata: {},
parent: {sourcedId: '<string>'},
children: [{href: '<string>', sourcedId: '<string>'}]
}
})
};
fetch('https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods', 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/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods",
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([
'academicSession' => [
'sourcedId' => '<string>',
'title' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>',
'type' => '<string>',
'schoolYear' => '<string>',
'org' => [
'sourcedId' => '<string>'
],
'tenantId' => '<string>',
'clientAppId' => '<string>',
'dateLastModified' => '2023-11-07T05:31:56Z',
'metadata' => [
],
'parent' => [
'sourcedId' => '<string>'
],
'children' => [
[
'href' => '<string>',
'sourcedId' => '<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/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods"
payload := strings.NewReader("{\n \"academicSession\": {\n \"sourcedId\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"type\": \"<string>\",\n \"schoolYear\": \"<string>\",\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"tenantId\": \"<string>\",\n \"clientAppId\": \"<string>\",\n \"dateLastModified\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {},\n \"parent\": {\n \"sourcedId\": \"<string>\"\n },\n \"children\": [\n {\n \"href\": \"<string>\",\n \"sourcedId\": \"<string>\"\n }\n ]\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/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"academicSession\": {\n \"sourcedId\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"type\": \"<string>\",\n \"schoolYear\": \"<string>\",\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"tenantId\": \"<string>\",\n \"clientAppId\": \"<string>\",\n \"dateLastModified\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {},\n \"parent\": {\n \"sourcedId\": \"<string>\"\n },\n \"children\": [\n {\n \"href\": \"<string>\",\n \"sourcedId\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods")
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 \"academicSession\": {\n \"sourcedId\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"type\": \"<string>\",\n \"schoolYear\": \"<string>\",\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"tenantId\": \"<string>\",\n \"clientAppId\": \"<string>\",\n \"dateLastModified\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {},\n \"parent\": {\n \"sourcedId\": \"<string>\"\n },\n \"children\": [\n {\n \"href\": \"<string>\",\n \"sourcedId\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"academicSession": {
"sourcedId": "<string>",
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"schoolYear": 123,
"org": {
"href": "<string>",
"sourcedId": "<string>"
},
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {},
"parent": {
"href": "<string>",
"sourcedId": "<string>"
},
"children": [
{
"href": "<string>",
"sourcedId": "<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": [
{}
]
}Terms Management
Create a new Grading Period for a Term
To create a new Grading Period for a Term. A Grading Period is a type of Academic Session. The responding system must return the set of sourcedIds that have been allocated to the newly created academicSession record.
POST
/
ims
/
oneroster
/
rostering
/
v1p2
/
terms
/
{termSourcedId}
/
gradingPeriods
Create a new Grading Period for a Term
curl --request POST \
--url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"academicSession": {
"sourcedId": "<string>",
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"type": "<string>",
"schoolYear": "<string>",
"org": {
"sourcedId": "<string>"
},
"tenantId": "<string>",
"clientAppId": "<string>",
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {},
"parent": {
"sourcedId": "<string>"
},
"children": [
{
"href": "<string>",
"sourcedId": "<string>"
}
]
}
}
'import requests
url = "https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods"
payload = { "academicSession": {
"sourcedId": "<string>",
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"type": "<string>",
"schoolYear": "<string>",
"org": { "sourcedId": "<string>" },
"tenantId": "<string>",
"clientAppId": "<string>",
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {},
"parent": { "sourcedId": "<string>" },
"children": [
{
"href": "<string>",
"sourcedId": "<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({
academicSession: {
sourcedId: '<string>',
title: '<string>',
startDate: '<string>',
endDate: '<string>',
type: '<string>',
schoolYear: '<string>',
org: {sourcedId: '<string>'},
tenantId: '<string>',
clientAppId: '<string>',
dateLastModified: '2023-11-07T05:31:56Z',
metadata: {},
parent: {sourcedId: '<string>'},
children: [{href: '<string>', sourcedId: '<string>'}]
}
})
};
fetch('https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods', 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/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods",
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([
'academicSession' => [
'sourcedId' => '<string>',
'title' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>',
'type' => '<string>',
'schoolYear' => '<string>',
'org' => [
'sourcedId' => '<string>'
],
'tenantId' => '<string>',
'clientAppId' => '<string>',
'dateLastModified' => '2023-11-07T05:31:56Z',
'metadata' => [
],
'parent' => [
'sourcedId' => '<string>'
],
'children' => [
[
'href' => '<string>',
'sourcedId' => '<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/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods"
payload := strings.NewReader("{\n \"academicSession\": {\n \"sourcedId\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"type\": \"<string>\",\n \"schoolYear\": \"<string>\",\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"tenantId\": \"<string>\",\n \"clientAppId\": \"<string>\",\n \"dateLastModified\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {},\n \"parent\": {\n \"sourcedId\": \"<string>\"\n },\n \"children\": [\n {\n \"href\": \"<string>\",\n \"sourcedId\": \"<string>\"\n }\n ]\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/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"academicSession\": {\n \"sourcedId\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"type\": \"<string>\",\n \"schoolYear\": \"<string>\",\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"tenantId\": \"<string>\",\n \"clientAppId\": \"<string>\",\n \"dateLastModified\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {},\n \"parent\": {\n \"sourcedId\": \"<string>\"\n },\n \"children\": [\n {\n \"href\": \"<string>\",\n \"sourcedId\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/terms/{termSourcedId}/gradingPeriods")
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 \"academicSession\": {\n \"sourcedId\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"type\": \"<string>\",\n \"schoolYear\": \"<string>\",\n \"org\": {\n \"sourcedId\": \"<string>\"\n },\n \"tenantId\": \"<string>\",\n \"clientAppId\": \"<string>\",\n \"dateLastModified\": \"2023-11-07T05:31:56Z\",\n \"metadata\": {},\n \"parent\": {\n \"sourcedId\": \"<string>\"\n },\n \"children\": [\n {\n \"href\": \"<string>\",\n \"sourcedId\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"academicSession": {
"sourcedId": "<string>",
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"schoolYear": 123,
"org": {
"href": "<string>",
"sourcedId": "<string>"
},
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {},
"parent": {
"href": "<string>",
"sourcedId": "<string>"
},
"children": [
{
"href": "<string>",
"sourcedId": "<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
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The sourcedId of the term
Body
application/json
Show child attributes
Show child attributes
Response
Grading period successfully created
Represents an academic session.
Show child attributes
Show child attributes
⌘I