@roar-firebase-functions/core

---

@roar-firebase-functions/core / Administration

Interface: Administration

Defined in: packages/core/src/models/administration.model.ts:24

An interface representing an administration. This interface is used to define the structure of an administration object. Administration

Extends

• OrgsList

Properties

assessments

assessments: Assessment[]

Defined in: packages/core/src/models/administration.model.ts:29

The array of assessments in this administration.

---

classes?

optional classes: string[]

Defined in: packages/core/src/models/org.model.ts:15

An array of class IDs.

Inherited from

OrgsList.classes

---

createdBy

createdBy: string

Defined in: packages/core/src/models/administration.model.ts:25

The ID of the user who created the administration.

---

dateClosed

dateClosed: Date

Defined in: packages/core/src/models/administration.model.ts:28

The date the administration closes.

---

dateCreated

dateCreated: Date

Defined in: packages/core/src/models/administration.model.ts:26

The date the administration was created.

---

dateOpened

dateOpened: Date

Defined in: packages/core/src/models/administration.model.ts:27

The date the administration opens.

---

demoData?

optional demoData: boolean

Defined in: packages/core/src/models/administration.model.ts:37

A boolean indicating whether the administration contains demo data.

---

districts?

optional districts: string[]

Defined in: packages/core/src/models/org.model.ts:13

An array of district IDs.

Inherited from

OrgsList.districts

---

families?

optional families: string[]

Defined in: packages/core/src/models/org.model.ts:29

An array of family IDs.

Inherited from

OrgsList.families

---

groups?

optional groups: string[]

Defined in: packages/core/src/models/org.model.ts:31

An array of group IDs.

Inherited from

OrgsList.groups

---

legal?

optional legal: Legal

Defined in: packages/core/src/models/administration.model.ts:33

An object with information about consent and assent forms for this administration.

---

minimalOrgs

minimalOrgs: OrgsList

Defined in: packages/core/src/models/administration.model.ts:32

An interface representing only the top-level organizations that are assigned to this administration.

---

name?

optional name: string

Defined in: packages/core/src/models/administration.model.ts:34

A string inidcating the name of the administration.

---

publicName?

optional publicName: string

Defined in: packages/core/src/models/administration.model.ts:35

A string indicating the full, user-facing name of the administration.

---

readOrgs

readOrgs: OrgsList

Defined in: packages/core/src/models/administration.model.ts:31

An interface representing the organizations that can read administration data.

---

schools?

optional schools: string[]

Defined in: packages/core/src/models/org.model.ts:14

An array of school IDs.

Inherited from

OrgsList.schools

---

sequential

sequential: boolean

Defined in: packages/core/src/models/administration.model.ts:30

A boolean indicating whether the assessments in the administration are sequential.

---

testData?

optional testData: boolean

Defined in: packages/core/src/models/administration.model.ts:36

A boolean indicating whether the administration contains test data.