DoCurious API Reference / types / StudentRoster

Interface: StudentRoster

Defined in: types/school.types.ts:136

A student's enrollment record within a school, tracking status and class assignment.

Remarks

Managed by school admins via the roster management page or CSV import. Suspended students retain their data but lose platform access until reinstated.

Extends

• BaseEntity

Properties

challengesAssigned?

optional challengesAssigned: number

Defined in: types/school.types.ts:152

Number of challenges assigned to this student

---

challengesCompleted?

optional challengesCompleted: number

Defined in: types/school.types.ts:154

Number of challenges completed by this student

---

classId?

optional classId: string

Defined in: types/school.types.ts:138

---

createdAt

createdAt: string

Defined in: types/common.types.ts:154

ISO 8601 datetime when the entity was created

Inherited from

BaseEntity.createdAt

---

enrolledAt

enrolledAt: string

Defined in: types/school.types.ts:147

---

gradeLevel?

optional gradeLevel: string

Defined in: types/school.types.ts:143

---

id

id: string

Defined in: types/common.types.ts:167

Inherited from

BaseEntity.id

---

lastLoginAt?

optional lastLoginAt: string

Defined in: types/school.types.ts:150

Last time the student logged into the platform

---

reinstatedAt?

optional reinstatedAt: string

Defined in: types/school.types.ts:158

---

schoolId

schoolId: string

Defined in: types/school.types.ts:137

---

status

status: "active" | "suspended" | "inactive" | "transferred" | "alumni"

Defined in: types/school.types.ts:146

Enrollment status -- transferred students are read-only historical records, alumni are graduated

---

studentId?

optional studentId: string

Defined in: types/school.types.ts:142

The school's own student identifier (e.g., "S-12345")

---

suspendedAt?

optional suspendedAt: string

Defined in: types/school.types.ts:156

---

suspendedReason?

optional suspendedReason: string

Defined in: types/school.types.ts:157

---

updatedAt

updatedAt: string

Defined in: types/common.types.ts:156

ISO 8601 datetime when the entity was last modified

Inherited from

BaseEntity.updatedAt

---

user?

optional user: object

Defined in: types/school.types.ts:161

displayName

displayName: string

email

email: string

id

id: string

---

userId

userId: string

Defined in: types/school.types.ts:139