Skip to main content
PUT
/
ims
/
oneroster
/
rostering
/
v1p2
/
classes
/
{sourcedId}
Update a Class
curl --request PUT \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/classes/{sourcedId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "class": {
    "status": "active",
    "metadata": {},
    "title": "<string>",
    "classCode": "<string>",
    "classType": "homeroom",
    "location": "<string>",
    "grades": [
      "-1"
    ],
    "subjects": [
      "Reading"
    ],
    "subjectCodes": [
      "<string>"
    ],
    "periods": [
      "<string>"
    ],
    "resources": [
      {
        "sourcedId": "<string>"
      }
    ],
    "terms": [
      {
        "sourcedId": "<string>"
      }
    ]
  }
}
'
{
  "sourcedId": "<string>",
  "status": "active",
  "title": "<string>",
  "classCode": "<string>",
  "classType": "homeroom",
  "location": "<string>",
  "course": {
    "href": "<string>",
    "sourcedId": "<string>",
    "type": "<string>"
  },
  "school": {
    "href": "<string>",
    "sourcedId": "<string>",
    "type": "<string>"
  },
  "terms": [
    {
      "href": "<string>",
      "sourcedId": "<string>",
      "type": "<string>"
    }
  ],
  "dateLastModified": "2023-11-07T05:31:56Z",
  "metadata": {},
  "grades": [
    "3"
  ],
  "subjects": [
    "Reading"
  ],
  "subjectCodes": [
    "<string>"
  ],
  "periods": [
    "<string>"
  ],
  "resources": [
    {
      "href": "<string>",
      "sourcedId": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.timeback.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
sourcedId
string
required

Class sourcedId

Body

application/json
​
class
object
required

Response

Class successfully updated

Represents a class.

​
sourcedId
string
required
​
status
enum<string>
required
Available options:
active,
tobedeleted
​
title
string
required
​
classCode
string | null
required
​
classType
enum<string>
required
Available options:
homeroom,
scheduled
​
location
string | null
required
​
course
object
required
​
school
object
required
​
terms
object[]
required
​
dateLastModified
string<date-time>
​
metadata
object

Additional metadata for the object

​
grades
enum<string>[]

The grades of the course

Available options:
-1,
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
​
subjects
enum<string>[]

The subjects of the course

Available options:
Reading,
Language,
Vocabulary,
Social Studies,
Writing,
Science,
FastMath,
Math,
None,
Other
​
subjectCodes
string[]
​
periods
string[]
​
resources
object[]