Skip to main content
PUT
/
ims
/
oneroster
/
rostering
/
v1p2
/
academicSessions
/
{sourcedId}
Update an Academic Session
curl --request PUT \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/academicSessions/{sourcedId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "academicSession": {
    "sourcedId": "<string>",
    "status": "active",
    "title": "<string>",
    "startDate": "<string>",
    "endDate": "<string>",
    "type": "gradingPeriod",
    "schoolYear": "<string>",
    "org": {
      "sourcedId": "<string>"
    },
    "dateLastModified": "2023-11-07T05:31:56Z",
    "metadata": {},
    "parent": {
      "sourcedId": "<string>"
    },
    "children": [
      {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "academicSession"
      }
    ]
  }
}
'
{
  "sourcedId": "<string>",
  "status": "active",
  "title": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "type": "gradingPeriod",
  "schoolYear": 123,
  "org": {
    "href": "<string>",
    "sourcedId": "<string>",
    "type": "academicSession"
  },
  "dateLastModified": "2023-11-07T05:31:56Z",
  "metadata": {},
  "parent": {
    "href": "<string>",
    "sourcedId": "<string>",
    "type": "academicSession"
  },
  "children": [
    {
      "href": "<string>",
      "sourcedId": "<string>",
      "type": "academicSession"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
sourcedId
string
required

The sourcedId of the academic session to update

Body

application/json
​
academicSession
object
required

Response

Academic session updated

Represents an academic session.

​
sourcedId
string
required
​
status
enum<string>
required
Available options:
active,
tobedeleted
​
title
string
required
​
startDate
string
required
​
endDate
string
required
​
type
enum<string>
required
Available options:
gradingPeriod,
semester,
schoolYear,
term
​
schoolYear
number
required
​
org
object
required
​
dateLastModified
string<date-time>
​
metadata
object

Additional metadata for the object

​
parent
object
​
children
object[] | null