Skip to main content
PUT
/
ims
/
oneroster
/
rostering
/
v1p2
/
schools
/
{sourcedId}
Update a School
curl --request PUT \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/schools/{sourcedId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org": {
    "name": "<string>",
    "type": "<string>",
    "sourcedId": "<string>",
    "status": "active",
    "metadata": {},
    "identifier": "<string>",
    "parent": {
      "sourcedId": "<string>"
    }
  }
}
'
{
  "sourcedId": "<string>",
  "status": "active",
  "name": "<string>",
  "type": "department",
  "identifier": "<string>",
  "children": [],
  "dateLastModified": "2023-11-07T05:31:56Z",
  "metadata": {},
  "parent": {
    "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

School sourced ID

Body

application/json
​
org
object
required

Response

School successfully updated

Represents an organization.

​
sourcedId
string
required
​
status
enum<string>
required
Available options:
active,
tobedeleted
​
name
string
required
​
type
enum<string>
required
Available options:
department,
school,
district,
local,
state,
national
​
identifier
string
required
​
children
object[] | null
required
​
dateLastModified
string<date-time>
​
metadata
object
​
parent
object