Skip to content

demographics.md

Latest commit

 

History

History
49 lines (43 loc) · 7.84 KB

demographics.md

File metadata and controls

49 lines (43 loc) · 7.84 KB

Demographics

Represents a student's demographics information.

Example Usage

import { Demographics } from "@superbuilders/oneroster/models/components";

let value: Demographics = {
  sourcedId: "<id>",
  status: "active",
  birthDate: "1987-12-09",
  sex: "other",
  americanIndianOrAlaskaNative: "<value>",
  asian: "<value>",
  blackOrAfricanAmerican: "<value>",
  nativeHawaiianOrOtherPacificIslander: "<value>",
  white: "<value>",
  demographicRaceTwoOrMoreRaces: "<value>",
  hispanicOrLatinoEthnicity: "<value>",
  countryOfBirthCode: "<value>",
  stateOfBirthAbbreviation: "<value>",
  cityOfBirth: "<value>",
  publicSchoolResidenceStatus: "<value>",
};

Fields

Field Type Required Description
sourcedId string ✔️ N/A
status components.DemographicsStatus ✔️ N/A
dateLastModified Date ➖ N/A
metadata Record<string, any> ➖ N/A
birthDate string ✔️ N/A
sex components.Sex ✔️ N/A
americanIndianOrAlaskaNative string ✔️ N/A
asian string ✔️ N/A
blackOrAfricanAmerican string ✔️ N/A
nativeHawaiianOrOtherPacificIslander string ✔️ N/A
white string ✔️ N/A
demographicRaceTwoOrMoreRaces string ✔️ N/A
hispanicOrLatinoEthnicity string ✔️ N/A
countryOfBirthCode string ✔️ N/A
stateOfBirthAbbreviation string ✔️ N/A
cityOfBirth string ✔️ N/A
publicSchoolResidenceStatus string ✔️ N/A