Skip to main content
PUT
/
ims
/
oneroster
/
rostering
/
v1p2
/
demographics
/
{sourcedId}
Update a Demographic record
curl --request PUT \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/demographics/{sourcedId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "demographics": {
    "sourcedId": "<string>",
    "status": "active",
    "metadata": {},
    "birthDate": "<string>",
    "sex": "male",
    "americanIndianOrAlaskaNative": "true",
    "asian": "true",
    "blackOrAfricanAmerican": "true",
    "nativeHawaiianOrOtherPacificIslander": "true",
    "white": "true",
    "demographicRaceTwoOrMoreRaces": "true",
    "hispanicOrLatinoEthnicity": "true",
    "countryOfBirthCode": "<string>",
    "stateOfBirthAbbreviation": "<string>",
    "cityOfBirth": "<string>",
    "publicSchoolResidenceStatus": "<string>"
  }
}
'
{
  "sourcedId": "<string>",
  "status": "active",
  "birthDate": "<string>",
  "sex": "male",
  "americanIndianOrAlaskaNative": "<string>",
  "asian": "<string>",
  "blackOrAfricanAmerican": "<string>",
  "nativeHawaiianOrOtherPacificIslander": "<string>",
  "white": "<string>",
  "demographicRaceTwoOrMoreRaces": "<string>",
  "hispanicOrLatinoEthnicity": "<string>",
  "countryOfBirthCode": "<string>",
  "stateOfBirthAbbreviation": "<string>",
  "cityOfBirth": "<string>",
  "publicSchoolResidenceStatus": "<string>",
  "dateLastModified": "2023-11-07T05:31:56Z",
  "metadata": {}
}

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

The unique identifier for the demographics record to update

Body

application/json
​
demographics
object
required

Response

Demographics record updated successfully

Represents a student's demographics information.

​
sourcedId
string
required
​
status
enum<string>
required
Available options:
active,
tobedeleted
​
birthDate
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
​
sex
enum<string> | null
required
Available options:
male,
female,
other,
unspecified,
null
​
americanIndianOrAlaskaNative
string | null
required
​
asian
string | null
required
​
blackOrAfricanAmerican
string | null
required
​
nativeHawaiianOrOtherPacificIslander
string | null
required
​
white
string | null
required
​
demographicRaceTwoOrMoreRaces
string | null
required
​
hispanicOrLatinoEthnicity
string | null
required
​
countryOfBirthCode
string | null
required
​
stateOfBirthAbbreviation
string | null
required
​
cityOfBirth
string | null
required
​
publicSchoolResidenceStatus
string | null
required
​
dateLastModified
string<date-time>
​
metadata
object

Additional metadata for the object