## 3.2 SIF NZ

The New Zealand customisation of the SIF AU data model, includes the following (high-level) changes:

- The `SchoolInfo` data object from SIF AU is replaced with `Provider` data object, as the scope of SIF NZ data model is intended to encompass early childhood education, compulsory schooling (K-12) and tertiary education (higher education).
- The `Organisation` is added in the NZ data model and describes education organisations (such as Kahui Ako) that are known to the NZ education system, not limited to Schools and other Providers.
- `StudentPersonal` data object doesn't include Alert or MedicalAlert messages; Demographics area includes NZ statistical standard Ethnicity and Iwi affiliations.
- `ProviderRelationship` data object records relationships between two education providers.
- `StudentProviderEnrolment` expands on StudentSchoolEnrollment, and has extra complexity to cope with SIF NZ having Providers, rather than Schools.
- Includes only `StudentAttendanceTimeList` & `StudentAttendanceSummary` from SIF AU

### 3.2.1 AcademicDepartment

Information about an academic department within a provider, e.g. Maths Department.

SIF_Events are reported for this object.

Figure 3.2.1-1: AcademicDepartment

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| AcademicDepartment |  | Low | Information about an academic department within a provider, e.g. Maths Department. |
| AcademicDepartmentRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| AcademicDepartmentLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Name | O | Low | The name of the academic department. | xs:normalizedString
| Description | O | Low | Free text description providing more detail about the academic department. | xs:normalizedString
| Provider | M | Low | The ID (GUID) of the provider for this acadmic department resides in. | OrganisationObjectReferenceType
| StaffList | O | Low | A list of the staff members that belong to the academic department. | StaffListType
| CourseList | O | Low | A list of the courses the academic department manages. | CourseListType
| SubjectAreaList | O | Low | A list of the subject areas the academic department manages. | SubjectAreaListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.1-1: AcademicDepartment
JSON
{ "AcademicDepartment": { "AcademicDepartmentRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Science Department", "Provider": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b" }, "StaffList": { "StaffMember": [ { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<AcademicDepartment> <AcademicDepartmentRefId>2ffb63b4-cfef-4820-8501-e7d1e54555cb</AcademicDepartmentRefId> <Name>Science Department</Name> <Provider> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> </Provider> <StaffList> <StaffMember> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </StaffMember> </StaffList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </AcademicDepartment>
Example 3.2.1-1: AcademicDepartment

### 3.2.2 AssessmentTask

This object provides information about a particular assignment, allows applications to synchronize each other's assignment tables, gathers the definition for a StudentAssessmentTask object, etc.

SIF_Events are reported for this object.

Figure 3.2.2-1: AssessmentTask

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| AssessmentTask |  | Low | This object provides information about a particular assignment, allows applications to synchronize each other's assignment tables, gathers the definition for a StudentAssessmentTask object, etc. |
| AssessmentTaskRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| AssessmentTaskLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| AssessmentName | M | Low | The name of the assessment task. | xs:normalizedString
| OrganisationInvolvedList | M | Low | A list of the Providers/Organisations involved and their role, e.g. assessing provider, assessment provider, assessment location provider, registering provider. | OrganisationInvolvedListType
| TeachingGroup | O | Low | Generic object reference to the TeachingGroup object in which this assignment has been set. | ObjectReferenceType
| ProviderCourse | O | Low | Generic object reference to the ProviderCourse all of whose students will be participating in the assessment task. | ObjectReferenceType
| StudentList | O | Low | The GUIDs for students that are the intended participants for this Assessement Task. | StudentListType
| StaffInvolvedList | O | Low | A list of the staff involved and their role in relation to the assessment task, e.g. the moderator, the marker. | StaffInvolvedListType
| Description | O | Low | The text-based description of the assignment. | xs:normalizedString
| PointsPossible | O | Low | The points possible on the assignment. | xs:unsignedInt
| DueDate | O | Low | Date the assignment is due. | xs:date
| Weight | O | Low | The weight of the assignment. | xs:decimal
| MaxAttemptsAllowed | O | Low | How many attempts the student is allowed on the assignment (applicable particularly to online activities). | xs:integer
| DetailedDescriptionURL | O | Low | The location of the document that describes the assignment. If Type is PDF, this element will contain the Base64 encoding of the entire document. Preferred against DetailedDescriptionBinary for online assessment. | xs:anyURI
| AssessmentType | O | Low | Type of assessment (e.g. diagnostic vs paedagogical - Summative or Formative). | NZCodeSetsAssessmentTypeType
| AssessmentMethodology | M | Low | Code denoting the nature of the assessment process; Primary assessment against NZ Curriculum or Te Marautanga o Aotearoa; Secondary assessment against NCEA, Cambridge, International Baccalaureate, or similar. | NZCodeSetsAssessmentMethodologyType
| EvaluationType | O | Low | The type of assessment evaluation, e.g. formative or summative. | NZCodeSetsAssessmentEvaluationTypeType
| Curriculum | O | Low | The curriculum the assessment is for. | NZCodeSetsCurriculumType
| AssessmentToolUsed | O | Low | The assessment tool the assessment is used as part of. Both the original free text value sent by the SMS vendors and the value it is mapped to in this code set are held. | NZCodeSetsAssessmentToolType
| AssessmentToolTest | O | Low | The tests available within an assessment tool that is being used by this assessment task. | NZCodeSetsAssessmentToolTestType
| AssessmentPurpose | O | Low | Purpose for the assessment. | xs:normalizedString
| SubAssessmentTaskList | O | Low | AssessmentTasks which this assessment task is composed of. | AssessmentTaskListType
| PrerequisiteList | O | Low | References to objects (Course, LearningStandard, AssessmentTask etc.) being prerequisite conditions to be met for assessment. | PrerequisiteListType
| SubjectAreaList | O | Low | A list of the subject areas being assessed. | SubjectAreaListType
| AssessedAtYearLevel | O | Low | The year level the Assessment Task pertains to. May only contain the values 1 through to 13 inclusive. | xs:int
xs:minInclusive | 1
xs:maxInclusive | 13
| LearningStandardList | O | Low | A list of references to LearningStandards that will be assessed as part of this AssessmentTask. | LearningStandardListType
| StandardType | O | Low | The type of standard the result is for. Applies to secondary level assessments, e.g. unit and achievement standards, scholarships and International Baccalaureate. | NZCodeSetsLearningStandardTypeType
| SpecialAssessmentConditionExclusionList | O | Low | A list of SACs that are excluded for this particular assessment task. | SpecialAssessmentConditionListType
| Timeframe | O | Low | The timeframe of the assessment, e.g. Mid-Year, End of Year. | NZCodeSetsAssessmentTimeframeType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.2-1: AssessmentTask
JSON
{ "AssessmentTask": { "AssessmentTaskRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "AssessmentName": "NZ History Classroom Test", "OrganisationInvolvedList": { "OrganisationInvolved": [ { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961", "OrganisationRole": "PRO" } ] }, "TeachingGroup": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39" }, "StaffInvolvedList": { "StaffInvolved": [ { "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "StaffRole": "ASS" } ] }, "Description": "Pop Quiz", "PointsPossible": 100, "DueDate": "2018-11-25", "Weight": 1.0, "DetailedDescriptionURL": "http://www.assignmentinfo.com/assignment1.pdf", "AssessmentType": "INT", "AssessmentMethodology": "P", "EvaluationType": "F", "LearningStandardList": { "LearningStandard": [ { "LocalId": "91165-v2" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<AssessmentTask> <AssessmentTaskRefId>359d7510-1ad0-a9d7-a8c3-dad0a85103a2</AssessmentTaskRefId> <AssessmentName>NZ History Classroom Test</AssessmentName> <OrganisationInvolvedList> <OrganisationInvolved> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> <OrganisationRole>PRO</OrganisationRole> </OrganisationInvolved> </OrganisationInvolvedList> <TeachingGroup> <RefId>d0a0a27a-d0a8-510a-d9d7-5101a8c3da39</RefId> </TeachingGroup> <StaffInvolvedList> <StaffInvolved> <RefId>cd106d6d-d9d5-41fb-9943-5feb967c9435</RefId> <StaffRole>ASS</StaffRole> </StaffInvolved> </StaffInvolvedList> <Description>Pop Quiz</Description> <PointsPossible>100</PointsPossible> <DueDate>2018-11-25</DueDate> <Weight>1.0</Weight> <DetailedDescriptionURL>http://www.assignmentinfo.com/assignment1.pdf</DetailedDescriptionURL> <AssessmentType>INT</AssessmentType> <AssessmentMethodology>P</AssessmentMethodology> <EvaluationType>F</EvaluationType> <LearningStandardList> <LearningStandard> <LocalId>91165-v2</LocalId> </LearningStandard> </LearningStandardList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </AssessmentTask>
Example 3.2.2-1: Assessment Task

### 3.2.3 Credential

A qualification or other award published by a national body, professional association or other interested party. The Credential recognises a set of learning that students have undertaken and successfully completed.

SIF_Events are reported for this object.

Figure 3.2.3-1: Credential

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| Credential |  | Low | A qualification or other award published by a national body, professional association or other interested party. The Credential recognises a set of learning that students have undertaken and successfully completed. |
| CredentialRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| CredentialLocalId | O | Low | Code assigned by the Credential administrator to identify the CreLocalIddential. This may not uniquely identify the Credential, where there may be multiple editions or versions of a particular Credential. The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Title | M | Low | The name of the Credential. eg: "NCEA Level 1" | xs:normalizedString
| VersionNo | O | Low | The version number of the Credential. | xs:decimal
| Administrator | O | Low | Generic object reference to the Provider or Organisation that administers the Credential | ObjectReferenceType
| Description | O | Low | Description of the credential | xs:string
| SubjectAreaList | O | Low | Which standard MoE Learning / Subject Areas is this Credential part of? | SubjectAreaListType
| Status | O | Low | A code denoting the current status of the Credential, as set by the Administrator. | NZCodeSetsCredentialStatus
| PublicationDate | O | Low | This is the date that the administering organization published the Credential. | xs:date
| SupercededDate | O | Low | The date the administering organization superceded (or will supercede) the Credential. May be future dated. | xs:date
| DiscontinuedDate | O | Low | The date the administering organization discontinued (or will discontinue) the Credential. May be future dated. | xs:date
| Credits | O | Low | The number of course (or other qualification) credits that will be achieved by attaining this Credential. | xs:decimal
| Level | O | Low | The level of the credential if applicable, eg. 1,2 or 3 for NCEA levels | xs:normalizedString
| RelatedLearningStandardList | O | Low | A list of related LearningStandard references | RelatedLearningStandardsListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.3-1: Credential
JSON
{ "Credential": { "CredentialRefId": "2b560779-872b-4491-afd6-3c6bd5f1c8cc", "CredentialLocalId": "91165-v2", "Title": "NCEA Level 2 - Endorsed with Merit", "VersionNo": 2, "Administrator": { "RefId": "3d614c16-9046-47d1-87b5-51438590de15", "Name": "NZQA" }, "Description": "Achieved sufficient chemistry credits endorsed with merit", "SubjectAreaList": { "SubjectArea": [ "CHEM" ] }, "Status": "PU", "Credits": 4, "Level": 2, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<Credential> <CredentialRefId>2b560779-872b-4491-afd6-3c6bd5f1c8cc</CredentialRefId> <CredentialLocalId>91165-v2</CredentialLocalId> <Title>NCEA Level 2 - Endorsed with Merit</Title> <VersionNo>2</VersionNo> <Administrator> <RefId>3d614c16-9046-47d1-87b5-51438590de15</RefId> <Name>NZQA</Name> </Administrator> <Description>Achieved sufficient chemistry credits endorsed with merit</Description> <SubjectAreaList> <SubjectArea>CHEM</SubjectArea> </SubjectAreaList> <Status>PU</Status> <Credits>4</Credits> <Level>2</Level> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Credential>
Example 3.2.3-1: NZQA Credential Example
JSON
{ "Credential": { "CredentialRefId": "ec907e58-bbfc-427f-be2a-daa987bf3838", "CredentialLocalId": "9709", "Title": "Pure Mathematics", "VersionNo": 2018, "Administrator": { "RefId": "75bad874-84b6-4a9e-b5d2-ef366c6c7492" }, "Description": "Cambridge International AS Mathematics (2018) - Pure Mathematics", "SubjectAreaList": { "SubjectArea": [ "MATH" ] }, "Status": "PU", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<Credential> <CredentialRefId>ec907e58-bbfc-427f-be2a-daa987bf3838</CredentialRefId> <CredentialLocalId>9709</CredentialLocalId> <Title>Pure Mathematics</Title> <VersionNo>2018</VersionNo> <Administrator> <RefId>75bad874-84b6-4a9e-b5d2-ef366c6c7492</RefId> </Administrator> <Description>Cambridge International AS Mathematics (2018) - Pure Mathematics</Description> <SubjectAreaList> <SubjectArea>MATH</SubjectArea> </SubjectAreaList> <Status>PU</Status> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Credential>
Example 3.2.3-2: Cambridge Credential Example

### 3.2.4 Document

The universally unique identifier for the data object record that is used across systems.

SIF_Events are reported for this object.

Figure 3.2.4-1: Document

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| Document |  | Low | The universally unique identifier for the data object record that is used across systems. |
| DocumentRefId | O | Low | The ID (GUID) assigned to uniquely identify this Document. | RefIdType
| DocumentLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Organisation | M | Low | Generic object reference to the Organisation/Provider that first uploaded this document. | OrganisationObjectReferenceType
| Location | O | Low | Location of Documentation. | xs:normalizedString
| DocumentTitle | M | Low | Document's full title. | xs:normalizedString
| DocumentDescription | O | Low | What the document is and how it is related to the Student. | xs:normalizedString
| AddedDateTime | O | Low | The date the document was added at the source system. | xs:dateTime
| ReviewDate | O | Low | Document Review Date. | xs:date
| URL | O | Low | URL if known. | xs:anyURI
| NoteText | O | Low | If the type of document is 'Note' then this is populated with the free text that makes up the note. | xs:normalizedString
| RelatedToList | O | Low | A list of objects that this document relates to, e.g. a Wellbeing Response or Characteristic, Physical Restraint. | RelatedToListType
| DocumentClassification | O | Low | The classification of the document to give an indication of the audience who should have access. | NZCodeSetsDocumentClassificationType
| DocumentType | M | Low | The type of document, e.g. Personalised Plan, Wellbeing Event or Response supporting documentation. | NZCodeSetsDocumentTypeType
| PersonDocumentRoleList | O | Low | The list of people associated to a document and their role in relation to it, e.g. author, owner, reviewer, subject of. | PersonDocumentRoleListType
| DocumentDate | O | Low | The date of the document, e.g. the date the document was produced. | xs:date
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.4-1: Document
JSON
{ "Document": { "DocumentRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "DocumentDescription": "Timmy McGannaway's IEP for 2019", "URL": "http://somehost.co.nz/docs/ghf12312", "DocumentType": "IEP", "PersonDocumentRoleList": { "PersonDocumentRole": [ { "Role": "SU", "Student": { "RefId": "17c9b7aa-bc34-435f-8bba-7e337891f53b", "NationalStudentNumber": "6788765445" } }, { "Role": "AU", "Person": { "RefId": "2a288f40-c3fb-4d9c-857e-0e562f3f5dde", "ObjectType": "StaffPersonal" } } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<Document> <DocumentRefId>2ffb63b4-cfef-4820-8501-e7d1e54555cb</DocumentRefId> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <DocumentDescription>Timmy McGannaway's IEP for 2019</DocumentDescription> <URL>http://somehost.co.nz/docs/ghf12312</URL> <DocumentType>IEP</DocumentType> <PersonDocumentRoleList> <PersonDocumentRole> <Role>SU</Role> <Student> <RefId>17c9b7aa-bc34-435f-8bba-7e337891f53b</RefId> <NationalStudentNumber>6788765445</NationalStudentNumber> </Student> </PersonDocumentRole> <PersonDocumentRole> <Role>AU</Role> <Person> <RefId>2a288f40-c3fb-4d9c-857e-0e562f3f5dde</RefId> <ObjectType>StaffPersonal</ObjectType> </Person> </PersonDocumentRole> </PersonDocumentRoleList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Document>
Example 3.2.4-1: Document

### 3.2.5 LearningStandard

A curriculum standard or the like published by a national body, professional association or other interested party. The LearningStandard describes a set of learning that students are expected to undertake.

SIF_Events are reported for this object.

Figure 3.2.5-1: LearningStandard

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| LearningStandard |  | Low | A curriculum standard or the like published by a national body, professional association or other interested party. The LearningStandard describes a set of learning that students are expected to undertake. |
| LearningStandardRefId | O | Low | System assigned unique identifier for the LearningStandard | RefIdType
| LearningStandardLocalId | O | Low | Code assigned by the LearningStandard publisher to identify the LearningStandard. This may not uniquely identify the LearningStandard, where there may be multiple editions or versions of a particular LearningStandard. The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Title | M | Low | The name of the LearningStandard. eg: "Demonstrate understanding of chemical reactivity" | xs:normalizedString
| Number | O | Low | A unique number that is used to identify the learning standard. One use of this is for NZQA standard numbers which cannot be used as a unique identifier (in LocalId) on their own as they are versioned so are part of a composite key with VersionNo. | xs:int
| VersionNo | O | Low | The version number of the LearningStandard. | xs:decimal
| Publisher | O | Low | Generic object reference to the EducationOrganisation that published the LearningStandard | ObjectReferenceType
| StandardType | O | Low | Code denoting the type of LearningStandard. | NZCodeSetsLearningStandardTypeType
| LearningStandardFamily | O | Low | The family the learning standard is part of. | NZCodeSetsLearningStandardFamilyType
| Description | O | Low | Description of the standards document. | xs:string
| SubjectAreaList | M | Low | Which standard MoE Learning / Subject Areas is this LearningStandard part of? | SubjectAreaListType
| Status | O | Low | A code denoting the current status of the LearningStandard, as set by the Publisher. | NZCodeSetsLearningStandardStatus
| PublicationDate | O | Low | The date the publishing organization published the standard. | xs:date
| SupercededDate | O | Low | The date the publishing organization superceded (or will supercede) the LearningStandard. May be future dated. | xs:date
| DiscontinuedDate | O | Low | The date the publishing organization discontinued (or will discontinue) the LearningStandard. May be future dated. | xs:date
| Credits | O | Low | The number of course (or other qualification) credits that will be achieved by passing this LearningStandard. | xs:decimal
| Level | O | Low | Where the publisher is NZQA, Which NCEA Level applies to the LearningStandard? | xs:decimal
| AssessmentType | O | Low | Code denoting how the LearningStandard is assessed. | NZCodeSetsAssessmentTypeType
| RelatedLearningStandardList | O | Low | A list of related LearningStandard references | RelatedLearningStandardsListType
| CredentialList | O | Low | A list of Credentials that the learning standard contributes to attaining. | CredentialListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.5-1: LearningStandard
JSON
{ "LearningStandard": { "LearningStandardRefId": "cf851d37-6667-4bc6-aa11-ac34ef73af2b", "LearningStandardLocalId": "91165-v2", "Title": "Chemistry - Organic Compounds", "Number": 91165, "VersionNo": 2, "Publisher": { "RefId": "cedf9eae-4358-408d-af57-ec0ea1b0d210" }, "Description": "Demonstrate understanding of the properties of selected organic compounds", "SubjectAreaList": { "SubjectArea": [ "CHEM" ] }, "Status": "PU", "Credits": 4, "Level": "2", "AssessmentType": "INT", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<LearningStandard> <LearningStandardRefId>cf851d37-6667-4bc6-aa11-ac34ef73af2b</LearningStandardRefId> <LearningStandardLocalId>91165-v2</LearningStandardLocalId> <Title>Chemistry - Organic Compounds</Title> <Number>91165</Number> <VersionNo>2</VersionNo> <Publisher> <RefId>cedf9eae-4358-408d-af57-ec0ea1b0d210</RefId> </Publisher> <Description>Demonstrate understanding of the properties of selected organic compounds</Description> <SubjectAreaList> <SubjectArea>CHEM</SubjectArea> </SubjectAreaList> <Status>PU</Status> <Credits>4</Credits> <Level>2</Level> <AssessmentType>INT</AssessmentType> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </LearningStandard>
Example 3.2.5-1: NZQA Learning Standard Example
JSON
{ "LearningStandard": { "LearningStandardRefId": "89568965-c0a5-4cdb-9c48-b3642dbf08ee", "LearningStandardLocalId": "9709-2018", "Title": "Pure Mathematics", "Number": 9709, "VersionNo": 2018, "Publisher": { "RefId": "a4c9f1dc-5e31-46b4-97aa-6d8534998707" }, "Description": "Cambridge International AS Mathematics (2018) - Pure Mathematics", "SubjectAreaList": { "SubjectArea": [ "MATH" ] }, "Status": "PU", "AssessmentType": "EXT", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<LearningStandard> <LearningStandardRefId>89568965-c0a5-4cdb-9c48-b3642dbf08ee</LearningStandardRefId> <LearningStandardLocalId>9709-2018</LearningStandardLocalId> <Title>Pure Mathematics</Title> <Number>9709</Number> <VersionNo>2018</VersionNo> <Publisher> <RefId>a4c9f1dc-5e31-46b4-97aa-6d8534998707</RefId> </Publisher> <Description>Cambridge International AS Mathematics (2018) - Pure Mathematics</Description> <SubjectAreaList> <SubjectArea>MATH</SubjectArea> </SubjectAreaList> <Status>PU</Status> <AssessmentType>EXT</AssessmentType> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </LearningStandard>
Example 3.2.5-2: Cambridge Learning Standard Example

### 3.2.6 Organisation

Education Provider entities (ECEs, Schools & Tertiary Education Institutions), Communities (Kāhui Ako, Learning Support Clusters, etc.), and others (Teen Parent Units, Activity Centres. etc.)

SIF_Events are reported for this object.

Figure 3.2.6-1: Organisation

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| Organisation |  | Low | Education Provider entities (ECEs, Schools & Tertiary Education Institutions), Communities (Kāhui Ako, Learning Support Clusters, etc.), and others (Teen Parent Units, Activity Centres. etc.) | Extension of EduOrganisationType
| Address | O | High | The set of postal and other addresses that the Organisation uses | AddressesType
| CommunicationChannel | O | Low | A list of one or more methods of communication with the organisation | CommunicationChannelsType
| ContactList | O | Low | A list of one or more cotact persons related to the organisation | ContactListType
| EducationRegion | O | Low | A region of New Zealand defined by the Ministry of Education for adminstrative purposes | NZCodeSetsEducationRegionType
| SpecialEducationDistrict | O | Low | The special education district the provider belongs to. | NZCodeSetsSpecialEducationDistrictType
| Email | O | High | The set of contact email addresses that the Organisation uses | OrganisationEmailsType
| EntityClose | O | Low | Closing date of entity. Only present for closed providers. | xs:date
| EntityOpen | O | Low | Opening date of entity. For proposed schools this will be the projected opening date. For open schools this may not be present. | xs:date
| LocationList | O | Low | A list of one or more locations, from which the organisation operates or provides a service. | LocationListType
| Name | M | Low | The normal business name of the Organisation | xs:normalizedString
| Phone | O | High | The set of contact phone numbers that the Organisation uses | OrganisationPhonesType
| RelatedOrganisationList | O | Low | A list of other organisations that are related to the Provider | RelatedOrganisationListType
| OperationalStatus | O | Low | Current status of the Provider | NZCodeSetsOperationalStatusType
| OperationalStatusReason | O | Low | The reason the operational status of the organisation was changed. | NZCodeSetsOperationalStatusReasonType
| Type | M | Low | Describes the nature of the Organisation; for Schools this indicate the schooling levels offered. | NZCodeSetsOrganisationTypeType
| SectorRole | O | Low | Code denoting the role the organisation plays within the education sector, e.g. School Sector Institution, Learning Support Cluster, etc. | NZCodeSetsOrganisationSectorRoleType
| ProviderSMS | O | Low | The name of the School Management System (SMS) that the provider is currently using. Note: not all education providers use an SMS. | NZCodeSetsSchoolManagementSystemType
| TeRitoConfig | O | Low | Provides iinformation specific to Te Rito, e.g. which functionality in Te Rito an organisation (school, ECE etc.) is utilising. | TeRitoConfigurationType
| IsLicencedECEServiceProvider | O | Low | Indicates whether or not an ECE Service Provider Organisation is a Licenced ECE Service Provider. | NZCodeSetsYesOrNoCategoryType
| IsPlaygroupServiceProvider | O | Low | Indicates whether or not an ECE Service Provider Organisation is a Playgroup Service Provider. | NZCodeSetsYesOrNoCategoryType
| ECEServiceProviderOwnershipType | O | Low | The type of ECE Service Provider ownership, e.g. Sole Trader, Company, Charitable Trust etc. | NZCodeSetsECEServiceProviderOwnershipTypeType
| OrganisationRefId | O | Low | The system assigned GUID for the Organisation, that is used across systems. | RefIdType
| OrganisationLocalId | O | Low | The Ministry of Education Organisation Id of the Organisation, as received from FIRST, the master data system for Ministry organisations. | LocalIdType
| Authority | O | Low | A code denoting the authority by which the Provider is authorised to provide education services. | NZCodeSetsProviderAuthorityType
| SchoolService | O | Low | Only present if the Provider is a provider of school education services. Contains properties that are school-specific. | SchoolServiceType
| ECEService | O | Low | Only present if the Provider is a provider of early childhood education services. Contains properties that are ECE specific. | ECEServiceType
| TertiaryService | O | Low | Only present if the Provider is a provider of tertiary education services. Contains properties that are Tertiary Education specific. A placeholder for future expansion | TertiaryServiceType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.6-1: Organisation
JSON
{ "Organisation": { "Address": { "Physical": { "Type": "RU", "Line1": "1175 Lake Ferry Rd", "Suburb": "RD 1", "City": "Martinborough" } }, "CommunicationChannel": { "Website": { "Notes": "Attendance System (Self Service)", "Value": "http://att.hogwarts.school.nz" } }, "ContactList": { "Contact": [ { "Name": { "FamilyName": "Dumbledore", "GivenName": "Albus", "FullName": "Albus Dumbledore" }, "PositionTitle": "Headmaster", "Role": "PRI", "Address": { "Physical": { "Type": "TH", "Line1": "533 Hogwart's Way", "City": "Hogsmead", "PostalCode": "7733" } }, "Email": {}, "Phone": {} }, { "Name": { "FamilyName": "Hagrid", "GivenName": "Rubeus", "FullName": "Rubeus Hagrid" }, "PositionTitle": "Gamekeeper", "Role": "DIR", "Address": { "Physical": { "Type": "TH", "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way", "City": "Hogsmead", "PostalCode": "7733" } }, "Email": {}, "Phone": {} } ] }, "EducationRegion": "TAIT", "Email": { "Main": { "Address": "stuart@gmail.com" } }, "EntityOpen": "1652-04-01", "LocationList": { "Location": [ { "Description": "Only Campus", "Address": { "Type": "RU", "Line1": "1175 Lake Ferry Rd", "Suburb": "RD 1", "City": "Martinborough", "PostalCode": "5781" }, "GridLocation": { "Latitude": -41.2814719, "Longitude": 175.3458472 }, "StatisticalAreaList": { "StatisticalArea": [ { "SpatialUnitType": "GE", "Code": "058" }, { "SpatialUnitType": "TA", "Code": "050" }, { "SpatialUnitType": "WA", "Code": "05003" } ] } } ] }, "Name": "Hogwart's Area School", "Phone": { "Main": { "Notes": "School Secretary DDI", "Number": "(04) 300 9993" } }, "RelatedOrganisationList": { "RelatedOrganisation": [ { "RefId": "5155a60d-b4fd-43b4-9861-77c19df47ed9", "LocalId": "9965", "StartDate": "2012-10-31", "Type": "LOF" }, { "RefId": "592bfa0d-52f8-4468-935c-ae48c71f71c9", "LocalId": "9651", "StartDate": "2012-04-30", "Type": "34028" } ] }, "OperationalStatus": "O", "Type": "21", "OrganisationRefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "OrganisationLocalId": 448, "Authority": "STATE", "SchoolService": { "CoEdStatus": "COED", "Decile": 5, "NewEntrantPolicyList": { "EnactedPolicy": [ { "EffectiveTo": "2018-12-31", "Policy": "AE" }, { "EffectiveFrom": "2019-01-01", "Policy": "CE" } ] }, "SchoolClassificationList": { "Classification": [ "52010", "52004", "52002" ] }, "SchoolYearList": { "SchoolYear": [ { "YearLevel": "1", "Gender": "C" }, { "YearLevel": "2", "Gender": "C" }, { "YearLevel": "3", "Gender": "C" }, { "YearLevel": "4", "Gender": "C" }, { "YearLevel": "5", "Gender": "C" }, { "YearLevel": "6", "Gender": "C" }, { "YearLevel": "7", "Gender": "C" }, { "YearLevel": "8", "Gender": "C" }, { "YearLevel": "9", "Gender": "F" }, { "YearLevel": "10", "Gender": "F" }, { "YearLevel": "11", "Gender": "F" }, { "YearLevel": "12", "Gender": "F" }, { "YearLevel": "13", "Gender": "F" } ] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<Organisation> <Address> <Physical> <Type>RU</Type> <Line1>1175 Lake Ferry Rd</Line1> <Suburb>RD 1</Suburb> <City>Martinborough</City> </Physical> </Address> <CommunicationChannel> <Website> <Notes>Attendance System (Self Service)</Notes> <Value>http://att.hogwarts.school.nz</Value> </Website> </CommunicationChannel> <ContactList> <Contact> <Name> <FamilyName>Dumbledore</FamilyName> <GivenName>Albus</GivenName> <FullName>Albus Dumbledore</FullName> </Name> <PositionTitle>Headmaster</PositionTitle> <Role>PRI</Role> <Address> <Physical> <Type>TH</Type> <Line1>533 Hogwart's Way</Line1> <City>Hogsmead</City> <PostalCode>7733</PostalCode> </Physical> </Address> <Email /> <Phone /> </Contact> <Contact> <Name> <FamilyName>Hagrid</FamilyName> <GivenName>Rubeus</GivenName> <FullName>Rubeus Hagrid</FullName> </Name> <PositionTitle>Gamekeeper</PositionTitle> <Role>DIR</Role> <Address> <Physical> <Type>TH</Type> <Line1>The Enchanted Wood</Line1> <Line2>533 Hogwart's Way</Line2> <City>Hogsmead</City> <PostalCode>7733</PostalCode> </Physical> </Address> <Email /> <Phone /> </Contact> </ContactList> <EducationRegion>TAIT</EducationRegion> <Email> <Main> <Address>stuart@gmail.com</Address> </Main> </Email> <EntityOpen>1652-04-01</EntityOpen> <LocationList> <Location> <Description>Only Campus</Description> <Address> <Type>RU</Type> <Line1>1175 Lake Ferry Rd</Line1> <Suburb>RD 1</Suburb> <City>Martinborough</City> <PostalCode>5781</PostalCode> </Address> <GridLocation> <Latitude>-41.2814719</Latitude> <Longitude>175.3458472</Longitude> </GridLocation> <StatisticalAreaList> <StatisticalArea> <SpatialUnitType>GE</SpatialUnitType> <Code>058</Code> </StatisticalArea> <StatisticalArea> <SpatialUnitType>TA</SpatialUnitType> <Code>050</Code> </StatisticalArea> <StatisticalArea> <SpatialUnitType>WA</SpatialUnitType> <Code>05003</Code> </StatisticalArea> </StatisticalAreaList> </Location> </LocationList> <Name>Hogwart's Area School</Name> <Phone> <Main> <Notes>School Secretary DDI</Notes> <Number>(04) 300 9993</Number> </Main> </Phone> <RelatedOrganisationList> <RelatedOrganisation> <RefId>5155a60d-b4fd-43b4-9861-77c19df47ed9</RefId> <LocalId>9965</LocalId> <StartDate>2012-10-31</StartDate> <Type>LOF</Type> </RelatedOrganisation> <RelatedOrganisation> <RefId>592bfa0d-52f8-4468-935c-ae48c71f71c9</RefId> <LocalId>9651</LocalId> <StartDate>2012-04-30</StartDate> <Type>34028</Type> </RelatedOrganisation> </RelatedOrganisationList> <OperationalStatus>O</OperationalStatus> <Type>21</Type> <OrganisationRefId>e189fd55-a6d8-413a-b85c-caf79868938b</OrganisationRefId> <OrganisationLocalId>448</OrganisationLocalId> <Authority>STATE</Authority> <SchoolService> <CoEdStatus>COED</CoEdStatus> <Decile>5</Decile> <NewEntrantPolicyList> <EnactedPolicy> <EffectiveTo>2018-12-31</EffectiveTo> <Policy>AE</Policy> </EnactedPolicy> <EnactedPolicy> <EffectiveFrom>2019-01-01</EffectiveFrom> <Policy>CE</Policy> </EnactedPolicy> </NewEntrantPolicyList> <SchoolClassificationList> <Classification>52010</Classification> <Classification>52004</Classification> <Classification>52002</Classification> </SchoolClassificationList> <SchoolYearList> <SchoolYear> <YearLevel>1</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>2</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>3</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>4</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>5</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>6</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>7</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>8</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>9</YearLevel> <Gender>F</Gender> </SchoolYear> <SchoolYear> <YearLevel>10</YearLevel> <Gender>F</Gender> </SchoolYear> <SchoolYear> <YearLevel>11</YearLevel> <Gender>F</Gender> </SchoolYear> <SchoolYear> <YearLevel>12</YearLevel> <Gender>F</Gender> </SchoolYear> <SchoolYear> <YearLevel>13</YearLevel> <Gender>F</Gender> </SchoolYear> </SchoolYearList> </SchoolService> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Organisation>
Example 3.2.6-1: School Provider Example

### 3.2.7 OrganisationRelationship

Records a recognised relationship between two education Organisations. The two organisations are referred to as the Source Organisation and the Related Organisation.

RelationshipType records the nature of the relationship between the two organisations, and gives guidance on which is the Source Organisation and which is the Related Organisation.

SIF_Events are reported for this object.

Figure 3.2.7-1: OrganisationRelationship

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| OrganisationRelationship |  | Low | Records a recognised relationship between two education Organisations. The two organisations are referred to as the Source Organisation and the Related Organisation. RelationshipType records the nature of the relationship between the two organisations, and gives guidance on which is the Source Organisation and which is the Related Organisation. |
| OrganisationRelationshipRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| OrganisationRelationshipLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Status | M | Low | Records if this OrganisationRelationship is Active or Inactive | NZCodeSetsOrganisationRelationshipStatusType
| RelationshipType | M | Low | The SIF GUID for the source organisation in the relationship. | NZCodeSetsOrganisationRelationshipTypeType
| SourceOrganisation | M | Low | Generic object reference to the source Organisation in the relationship. | OrganisationObjectReferenceType
| SourceOrganisationRole | O | Low | The role the source Organisation is playing in this relationship. | NZCodeSetsSourceOrganisationRoleType
| SourceOrganisationAgreementDate | O | Low | The date the source Organisation in the relationship registered their agreement to the relationship. nil value if the source Organisation is yet to register their agreement ot the relationship. | xs:date
| RelatedOrganisation | M | Low | Generic object reference to the related Organisation in the relationship. | OrganisationObjectReferenceType
| RelatedOrganisationRole | O | Low | The role the related Organisation is playing in this relationship. | NZCodeSetsRelatedOrganisationRoleType
| RelatedOrganisationAgreementDate | O | Low | The date the related Organisation in the relationship registered their agreement to the relationship. nil value if the related Organisation is yet to register their agreement ot the relationship. | xs:date
| EffectiveDate | M | Low | The date from which the organisation relationship is active. | xs:date
| ExpirationDate | O | Low | The date after which the organisation relationship is no longer active. | xs:date
| YearLevelList | O | Low | A list of YearLevels, denoting the year levels of the learners being hosted or sent from the client or contributing organisation | YearLevelListType
| SubjectAreaList | O | Low | A list of Subject or Learning Areas, denoting the curriculum subjects or learning areas that the learners being sent by the Source Organisation are taught at the Related Organisation. | SubjectAreaListType
| Description | O | Low | Free text description providing more detail about the organisation relationship. | xs:normalizedString
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.7-1: OrganisationRelationship

### 3.2.8 ProviderCalendarEvent

Provides information about a holiday or other Event that may or may not impact upon the schedule of a provider.

SIF_Events are reported for this object.

Figure 3.2.8-1: ProviderCalendarEvent

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| ProviderCalendarEvent |  | Low | Provides information about a holiday or other Event that may or may not impact upon the schedule of a provider. |
| ProviderCalendarEventRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| ProviderCalendarEventLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Organisation | M | Low | The provider the ProviderCalendarEvent relates to. Not populated if it is a National Holiday that applies to all providers. | OrganisationObjectReferenceType
| StartDateTime | M | Low | The date and time the calendar event starts. | xs:dateTime
| EndDateTime | M | Low | The date and time the calendar event ends. | xs:dateTime
| ProviderCalendarEventName | M | Low | The name of the provider's event happening at this date and time. | xs:normalizedString
| Location | O | Low | Free text denoting the location the event is occurring at. | xs:normalizedString
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.8-1: ProviderCalendarEvent
JSON
{ "ProviderCalendarEvent": { "ProviderCalendarEventRefId": "4e8387f0-faed-4eb5-84ef-2139da62133d", "ProviderCalendarEventLocalId": "2019-ANZAC", "StartDateTime": "2019-04-25T00:00:00+12:00", "EndDateTime": "2019-04-25T23:59:59+12:00", "ProviderCalendarEventName": "ANZAC Day, 2019", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<ProviderCalendarEvent> <ProviderCalendarEventRefId>4e8387f0-faed-4eb5-84ef-2139da62133d</ProviderCalendarEventRefId> <ProviderCalendarEventLocalId>2019-ANZAC</ProviderCalendarEventLocalId> <StartDateTime>2019-04-25T00:00:00+12:00</StartDateTime> <EndDateTime>2019-04-25T23:59:59+12:00</EndDateTime> <ProviderCalendarEventName>ANZAC Day, 2019</ProviderCalendarEventName> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ProviderCalendarEvent>
Example 3.2.8-1: Provider Calendar Event

### 3.2.9 ProviderCourse

A Provider defined Course that Students enrol in, and may be assessed for, and achieve passes in.

SIF_Events are reported for this object.

Figure 3.2.9-1: ProviderCourse

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| ProviderCourse |  | Low | A Provider defined Course that Students enrol in, and may be assessed for, and achieve passes in. |
| ProviderCourseRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| ProviderCourseLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Provider | M | Low | Generic object reference to the Provider (school) that defines and offers the Course. | OrganisationObjectReferenceType
| Curriculum | M | Low | Which of New Zealand's three Curricula is covered by the Course. | NZCodeSetsCurriculumType
| SubjectAreaList | O | Low | Subject matter areas covered by the Course. | SubjectAreaListType
| YearLevelList | O | Low | Year Levels covered by the Course. | YearLevelListType
| Title | M | Low | Title of the Course. | xs:normalizedString
| Description | O | Low | Textual description of the Course. | xs:normalizedString
| Duration | O | Low | The number of weeks the course is taught for. | xs:unsignedInt
| Credits | O | Low | The number of credits awarded upon Course completion. | xs:decimal
| LanguageOfInstructionList | O | Low | The language of instruction for the Course. | LanguageOfInstructionListType
| NZQAShortCOurseInd | O | Low | Indicator to advise NZQA that course does not have sufficient credits for endorsement. | NZCodeSetsYesOrNoCategoryType
| LearningStandardList | O | Low | A list of references to LearningStandard data objects that students are assessed against as part of the Course | LearningStandardListType
| CredentialList | O | Low | A list of `ObjectReference`s to the Credentials that may be gained by students completing the course. | CredentialListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.9-1: ProviderCourse
JSON
{ "ProviderCourse": { "ProviderCourseRefId": "9d75101a-8c3d-00aa-001a-0000a2e35b35", "ProviderCourseLocalId": "12CHEM", "Provider": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "Curriculum": "NZC", "SubjectAreaList": { "SubjectArea": [ "CHEM" ] }, "YearLevelList": { "YearLevel": [ 12 ] }, "Title": "Year 12 Chemistry", "Description": "Organic & Inorganic Chemistry for NCEA Level 2", "Duration": 35, "Credits": 11, "LanguageOfInstructionList": { "Language": [ { "Code": "NZS01112", "Level": "1" } ] }, "LearningStandardList": { "LearningStandard": [ { "LocalId": "91165-v2" }, { "LocalId": "91166-v2" }, { "LocalId": "91167-v2" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<ProviderCourse> <ProviderCourseRefId>9d75101a-8c3d-00aa-001a-0000a2e35b35</ProviderCourseRefId> <ProviderCourseLocalId>12CHEM</ProviderCourseLocalId> <Provider> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Provider> <Curriculum>NZC</Curriculum> <SubjectAreaList> <SubjectArea>CHEM</SubjectArea> </SubjectAreaList> <YearLevelList> <YearLevel>12</YearLevel> </YearLevelList> <Title>Year 12 Chemistry</Title> <Description>Organic &amp; Inorganic Chemistry for NCEA Level 2</Description> <Duration>35</Duration> <Credits>11</Credits> <LanguageOfInstructionList> <Language> <Code>NZS01112</Code> <Level>1</Level> </Language> </LanguageOfInstructionList> <LearningStandardList> <LearningStandard> <LocalId>91165-v2</LocalId> </LearningStandard> <LearningStandard> <LocalId>91166-v2</LocalId> </LearningStandard> <LearningStandard> <LocalId>91167-v2</LocalId> </LearningStandard> </LearningStandardList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ProviderCourse>
Example 3.2.9-1: ProviderCourse Example

### 3.2.10 Schedule

A rotation of ScheduleAcademicDays that a Provider has in place to manage their timetable.

SIF_Events are reported for this object.

Figure 3.2.10-1: Schedule

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| Schedule |  | Low | A rotation of ScheduleAcademicDays that a Provider has in place to manage their timetable. |
| ScheduleRefId | O | Low | The ID (GUID) assigned to uniquely identify this Schedule. | RefIdType
| ScheduleLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| ScheduleName | M | Low | The name of the schedule. | xs:normalizedString
| StartDate | O | Medium | The start date of the schedule. | xs:date
| EndDate | O | Medium | The end date of the schedule. | xs:date
| Organisation | M | Low | The provider the schedule is for. | OrganisationObjectReferenceType
| AcademicDayList | O | Low | A list of the academic days in the order they are used in the rotation of this schedule. If a particular academic day appears more than once in the rotation, then it will appear more than once in this list. eg. A 5 day rotation with days A, A, B, A, A, would have 5 entries in the list. | AcademicDayListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.10-1: Schedule
JSON
{ "Schedule": { "ScheduleRefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "ScheduleLocalId": "2019a", "ScheduleName": "Scheule 2019a (Term 1)", "StartDate": "2019-01-30", "EndDate": "2019-04-07", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "AcademicDayList": { "AcademicDay": [ { "RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9", "LocalId": "2019a-A", "Name": "Schedule 2019a, Day A", "SchedulePeriodTime": { "RefId": "8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8", "LocalId": "2019a-Normal" }, "PeriodList": { "Period": [ { "RefId": "215f796c-67f7-4855-83dc-28ad9d002830", "LocalId": "2019a-1", "Name": "Period 1" }, { "RefId": "1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34", "LocalId": "2019a-2", "Name": "Period 2" } ] } }, { "RefId": "337804c6-1247-4c0f-b288-e4aa28584aad", "LocalId": "2019a-B", "Name": "Schedule 2019a, DayB", "SchedulePeriodTime": { "RefId": "8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8", "LocalId": "2019a-Normal" }, "PeriodList": { "Period": [ { "RefId": "215f796c-67f7-4855-83dc-28ad9d002830", "LocalId": "2019a-1", "Name": "Period 1" }, { "RefId": "1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34", "LocalId": "2019a-2", "Name": "Period 2" } ] } } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<Schedule> <ScheduleRefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</ScheduleRefId> <ScheduleLocalId>2019a</ScheduleLocalId> <ScheduleName>Scheule 2019a (Term 1)</ScheduleName> <StartDate>2019-01-30</StartDate> <EndDate>2019-04-07</EndDate> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <AcademicDayList> <AcademicDay> <RefId>364f0aa5-49e2-434e-9c82-45770f4c71a9</RefId> <LocalId>2019a-A</LocalId> <Name>Schedule 2019a, Day A</Name> <SchedulePeriodTime> <RefId>8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8</RefId> <LocalId>2019a-Normal</LocalId> </SchedulePeriodTime> <PeriodList> <Period> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-1</LocalId> <Name>Period 1</Name> </Period> <Period> <RefId>1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34</RefId> <LocalId>2019a-2</LocalId> <Name>Period 2</Name> </Period> </PeriodList> </AcademicDay> <AcademicDay> <RefId>337804c6-1247-4c0f-b288-e4aa28584aad</RefId> <LocalId>2019a-B</LocalId> <Name>Schedule 2019a, DayB</Name> <SchedulePeriodTime> <RefId>8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8</RefId> <LocalId>2019a-Normal</LocalId> </SchedulePeriodTime> <PeriodList> <Period> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-1</LocalId> <Name>Period 1</Name> </Period> <Period> <RefId>1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34</RefId> <LocalId>2019a-2</LocalId> <Name>Period 2</Name> </Period> </PeriodList> </AcademicDay> </AcademicDayList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Schedule>
Example 3.2.10-1: Schedule

### 3.2.11 ScheduleAcademicDay

ScheduleAcademicDay defines an abstract day level construct that is referenced by a teaching group’s timetable (TeachingGroupEvent) to determine on which dates meetings will occur.

These academic days may occur in a rotational manner on a daily basis (“A Day”, “B Day”, “C Day”, “A Day”, etc…), be tied to weekdays or alternating weeks. The nature of these patterns is specified by the way that they are mapped to the real world calendar using the ScheduleDate endpoint.

ScheduleAcademicDay, in combination with TeachingGroupEvent determines WHICH classes will occur on a given day of the rotation.

SIF_Events are reported for this object.

Figure 3.2.11-1: ScheduleAcademicDay

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| ScheduleAcademicDay |  | Low | ScheduleAcademicDay defines an abstract day level construct that is referenced by a teaching group’s timetable (TeachingGroupEvent) to determine on which dates meetings will occur. These academic days may occur in a rotational manner on a daily basis (“A Day”, “B Day”, “C Day”, “A Day”, etc…), be tied to weekdays or alternating weeks. The nature of these patterns is specified by the way that they are mapped to the real world calendar using the ScheduleDate endpoint. ScheduleAcademicDay, in combination with TeachingGroupEvent determines WHICH classes will occur on a given day of the rotation. |
| ScheduleAcademicDayRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| ScheduleAcademicDayLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| AcademicDayName | M | Low | The name of the Academic Day. | xs:normalizedString
| Organisation | M | Low | The provider the academic day belongs to. | OrganisationObjectReferenceType
| Schedule | M | Low | The provider schedule the academic day belongs to. | ObjectReferenceType
| SchedulePeriodTime | O | Low | The schedule period time the academic day is following. | ObjectReferenceType
| PeriodList | O | Low | A list of periods that make up this academic day, e.g. Period 1, Period 2 etc. | PeriodListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.11-1: ScheduleAcademicDay
JSON
{ "ScheduleAcademicDay": { "ScheduleAcademicDayRefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9", "ScheduleAcademicDayLocalId": "2019a-A", "AcademicDayName": "Schedule 2019a, Day A", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "Name": "Scheule 2019a (Term 1)" }, "SchedulePeriodTime": { "RefId": "8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8", "Name": "Schedule 2019a, Normal Period Times" }, "PeriodList": { "Period": [ { "RefId": "215f796c-67f7-4855-83dc-28ad9d002830", "LocalId": "2019a-A1", "Name": "Period 1 on Day A" }, { "RefId": "1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34", "LocalId": "2019a-A2", "Name": "Period 2 on Day A" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<ScheduleAcademicDay> <ScheduleAcademicDayRefId>364f0aa5-49e2-434e-9c82-45770f4c71a9</ScheduleAcademicDayRefId> <ScheduleAcademicDayLocalId>2019a-A</ScheduleAcademicDayLocalId> <AcademicDayName>Schedule 2019a, Day A</AcademicDayName> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Scheule 2019a (Term 1)</Name> </Schedule> <SchedulePeriodTime> <RefId>8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8</RefId> <Name>Schedule 2019a, Normal Period Times</Name> </SchedulePeriodTime> <PeriodList> <Period> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-A1</LocalId> <Name>Period 1 on Day A</Name> </Period> <Period> <RefId>1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34</RefId> <LocalId>2019a-A2</LocalId> <Name>Period 2 on Day A</Name> </Period> </PeriodList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ScheduleAcademicDay>
Example 3.2.11-1: Schedule Academic Day

### 3.2.12 ScheduleDate

The core of the scheduling system, that assigns a particular ScheduleAcademicDay and SchedulePeriodTime to each of a set of calendar dates.

Each entry in the CalendaDateList determines WHICH meetings will occur on that date (via the ScheduleAcademicDay) and WHEN those meetings will take place (via the SchedulePeriodTime), as well as which ScheduleTerms are in session on that particular CalendarDate

SIF_Events are reported for this object.

Figure 3.2.12-1: ScheduleDate

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| ScheduleDate |  | Low | The core of the scheduling system, that assigns a particular ScheduleAcademicDay and SchedulePeriodTime to each of a set of calendar dates. Each entry in the CalendaDateList determines WHICH meetings will occur on that date (via the ScheduleAcademicDay) and WHEN those meetings will take place (via the SchedulePeriodTime), as well as which ScheduleTerms are in session on that particular CalendarDate |
| ScheduleDateRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| ScheduleDateLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Organisation | M | Low | The provider, e.g. school, tertiary institution etc, that this schedule date record belongs to. | OrganisationObjectReferenceType
| Schedule | M | Low | The schedule within the provider to which this ScheduleDate applies. | ObjectReferenceType
| CalendarDateList | M | Low | A list of schedule calendar dates and the period times, academic day and terms that applies to each day. | CalendarDateListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.12-1: ScheduleDate
JSON
{ "ScheduleDate": { "ScheduleDateRefId": "84c40f87-769d-46cc-8077-f5efb912e099", "ScheduleDateLocalId": "2019a-A-06", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "Name": "Schedule 2019a (Term 1)" }, "CalendarDateList": { "CalendarDate": [ { "Date": "2019-03-14", "SchoolClosed": "N", "ScheduleAcademicDay": { "LocalId": "2019a-A" }, "SchedulePeriodTime": { "LocalId": "2019a-Normal" }, "ScheduleTermList": { "ScheduleTerm": [ { "LocalId": "2019-1" } ] } }, { "Date": "2019-03-15", "SchoolClosed": "Y" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<ScheduleDate> <ScheduleDateRefId>84c40f87-769d-46cc-8077-f5efb912e099</ScheduleDateRefId> <ScheduleDateLocalId>2019a-A-06</ScheduleDateLocalId> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Schedule 2019a (Term 1)</Name> </Schedule> <CalendarDateList> <CalendarDate> <Date>2019-03-14</Date> <SchoolClosed>N</SchoolClosed> <ScheduleAcademicDay> <LocalId>2019a-A</LocalId> </ScheduleAcademicDay> <SchedulePeriodTime> <LocalId>2019a-Normal</LocalId> </SchedulePeriodTime> <ScheduleTermList> <ScheduleTerm> <LocalId>2019-1</LocalId> </ScheduleTerm> </ScheduleTermList> </CalendarDate> <CalendarDate> <Date>2019-03-15</Date> <SchoolClosed>Y</SchoolClosed> </CalendarDate> </CalendarDateList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ScheduleDate>
Example 3.2.12-1: Schedule Date

### 3.2.13 ScheduleException

Defines events that may or may not impact the schedule. These events may simply be for display, or may affect the schools academic schedule.

SIF_Events are reported for this object.

Figure 3.2.13-1: ScheduleException

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| ScheduleException |  | Low | Defines events that may or may not impact the schedule. These events may simply be for display, or may affect the schools academic schedule. |
| ScheduleExceptionRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| ScheduleExceptionLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Organisation | M | Low | The provider at which this schedule exception will occur | OrganisationObjectReferenceType
| Schedule | M | Low | The provider schedule the schedule exception is having an effect on. | ObjectReferenceType
| ExceptionDate | M | Low | The date of the exception. | xs:date
| Name | M | Low | The name of the schedule exception. eg. Snow Day - March 3rd | xs:normalizedString
| ScheduleAcademicDayList | O | Low | A list of one or more academic days to be applied to the school calendar for the duration of this event. Not present if the Provider is closed for the duration of the ScheduleException. | ScheduleDayListType
| DayPeriodTimeList | O | Low | A list of the periods that make up the period time schedule and their start and end times for the duration of this event. Not present if the Provider is closed for the duration of the ScheduleException. | DayPeriodTimeListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.13-1: ScheduleException
JSON
{ "ScheduleException": { "ScheduleExceptionRefId": "c79e65df-0b11-4a97-9062-9fbd1c1a38e3", "ScheduleExceptionLocalId": "excMarSnow", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "Name": "Schedule 2019a (Term 1)" }, "ExceptionDate": "2019-03-14", "Name": "14 Mar 2019 - Snow Day" } }
XML
<ScheduleException> <ScheduleExceptionRefId>c79e65df-0b11-4a97-9062-9fbd1c1a38e3</ScheduleExceptionRefId> <ScheduleExceptionLocalId>excMarSnow</ScheduleExceptionLocalId> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Schedule 2019a (Term 1)</Name> </Schedule> <ExceptionDate>2019-03-14</ExceptionDate> <Name>14 Mar 2019 - Snow Day</Name> </ScheduleException>
Example 3.2.13-1: Schedule Exception - Snow Day
JSON
{ "ScheduleException": { "ScheduleExceptionRefId": "f84d9681-03f6-4434-a867-967dba517cf5", "ScheduleExceptionLocalId": "excWinSprt", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "Name": "Schedule 2019a (Term 1)" }, "ExceptionDate": "2019-07-05", "Name": "Winter Sports - 3 Short Periods, Afternoon Off", "ScheduleAcademicDayList": { "ScheduleAcademicDay": [ { "LocalId": "2019a-A" } ] }, "DayPeriodTimeList": { "DayPeriodTime": [ { "SchedulePeriod": { "RefId": "215f796c-67f7-4855-83dc-28ad9d002830", "LocalId": "2019a-A1", "Name": "Period 1" }, "StartTime": "08:45:00+12:00", "EndTime": "09:35:00+12:00" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<ScheduleException> <ScheduleExceptionRefId>f84d9681-03f6-4434-a867-967dba517cf5</ScheduleExceptionRefId> <ScheduleExceptionLocalId>excWinSprt</ScheduleExceptionLocalId> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Schedule 2019a (Term 1)</Name> </Schedule> <ExceptionDate>2019-07-05</ExceptionDate> <Name>Winter Sports - 3 Short Periods, Afternoon Off</Name> <ScheduleAcademicDayList> <ScheduleAcademicDay> <LocalId>2019a-A</LocalId> </ScheduleAcademicDay> </ScheduleAcademicDayList> <DayPeriodTimeList> <DayPeriodTime> <SchedulePeriod> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-A1</LocalId> <Name>Period 1</Name> </SchedulePeriod> <StartTime>08:45:00+12:00</StartTime> <EndTime>09:35:00+12:00</EndTime> </DayPeriodTime> </DayPeriodTimeList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ScheduleException>
Example 3.2.13-2: Schedule Exception - Custom Schedule

### 3.2.14 SchedulePeriod

A SchedulePeriod defines an abstract time slot in which the meeting of a TeachingGroup may take place.

SchedulePeriods do not directly have times because the time at which a given period may occur might vary depending on what day they occur on (for example, on a “full” day period 1 might occur from 9:00 to 10:00, but on a “half” day period 1 might go from 9:00 to 9:30).

SIF_Events are reported for this object.

Figure 3.2.14-1: SchedulePeriod

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| SchedulePeriod |  | Low | A SchedulePeriod defines an abstract time slot in which the meeting of a TeachingGroup may take place. SchedulePeriods do not directly have times because the time at which a given period may occur might vary depending on what day they occur on (for example, on a “full” day period 1 might occur from 9:00 to 10:00, but on a “half” day period 1 might go from 9:00 to 9:30). |
| SchedulePeriodRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| SchedulePeriodLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| PeriodName | M | Low | The name of the schedule period. | xs:normalizedString
| Organisation | M | Low | The provider the schedule period belongs to. | OrganisationObjectReferenceType
| Schedule | M | Low | The provider schedule the schedule period belongs to. | ObjectReferenceType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.14-1: SchedulePeriod
JSON
{ "SchedulePeriod": { "SchedulePeriodRefId": "215f796c-67f7-4855-83dc-28ad9d002830", "SchedulePeriodLocalId": "2019a-1", "PeriodName": "Period 1", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "LocalId": "2019a", "Name": "Scheule 2019a (Term 1)" }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<SchedulePeriod> <SchedulePeriodRefId>215f796c-67f7-4855-83dc-28ad9d002830</SchedulePeriodRefId> <SchedulePeriodLocalId>2019a-1</SchedulePeriodLocalId> <PeriodName>Period 1</PeriodName> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <LocalId>2019a</LocalId> <Name>Scheule 2019a (Term 1)</Name> </Schedule> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </SchedulePeriod>
Example 3.2.14-1: Schedule Period

### 3.2.15 SchedulePeriodTime

A SchedulePeriodTime defines a set of periods that are to occur on a given AcademicDay. It takes the abstract time slots defined by SchedulePeriod (and referenced by TeachingGroupEvent) and assigns start and end times to that set of periods.

SchedulePeriodTime defines WHEN classes will occur on a given day of the rotation

SIF_Events are reported for this object.

Figure 3.2.15-1: SchedulePeriodTime

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| SchedulePeriodTime |  | Low | A SchedulePeriodTime defines a set of periods that are to occur on a given AcademicDay. It takes the abstract time slots defined by SchedulePeriod (and referenced by TeachingGroupEvent) and assigns start and end times to that set of periods. SchedulePeriodTime defines WHEN classes will occur on a given day of the rotation |
| SchedulePeriodTimeRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| SchedulePeriodTimeLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| SchedulePeriodTimeName | M | Low | The name of the Bell Schedule. | xs:normalizedString
| Organisation | M | Low | The provider the bell schedule belongs to. | OrganisationObjectReferenceType
| Schedule | M | Low | The provider schedule the bell schedule belongs to. | ObjectReferenceType
| DayPeriodTimeList | M | Low | A list of the periods that make up the period time schedule and their start and end times. | DayPeriodTimeListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.15-1: SchedulePeriodTime
JSON
{ "SchedulePeriodTime": { "SchedulePeriodTimeRefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "SchedulePeriodTimeLocalId": "2019a-Normal", "SchedulePeriodTimeName": "Schedule 2019a, Normal Period Schedule", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "Schedule": { "LocalId": "2019a-Normal", "Name": "Scheule 2019a (Term 1)" }, "DayPeriodTimeList": { "DayPeriodTime": [ { "SchedulePeriod": { "RefId": "215f796c-67f7-4855-83dc-28ad9d002830", "LocalId": "2019a-1", "Name": "Period 1" }, "StartTime": "08:45:00+12:00", "EndTime": "09:35:00+12:00" }, { "SchedulePeriod": { "RefId": "1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34", "LocalId": "2019a-2", "Name": "Period 2" }, "StartTime": "09:45:00+12:00", "EndTime": "10:35:00+12:00" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<SchedulePeriodTime> <SchedulePeriodTimeRefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</SchedulePeriodTimeRefId> <SchedulePeriodTimeLocalId>2019a-Normal</SchedulePeriodTimeLocalId> <SchedulePeriodTimeName>Schedule 2019a, Normal Period Schedule</SchedulePeriodTimeName> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <Schedule> <LocalId>2019a-Normal</LocalId> <Name>Scheule 2019a (Term 1)</Name> </Schedule> <DayPeriodTimeList> <DayPeriodTime> <SchedulePeriod> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-1</LocalId> <Name>Period 1</Name> </SchedulePeriod> <StartTime>08:45:00+12:00</StartTime> <EndTime>09:35:00+12:00</EndTime> </DayPeriodTime> <DayPeriodTime> <SchedulePeriod> <RefId>1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34</RefId> <LocalId>2019a-2</LocalId> <Name>Period 2</Name> </SchedulePeriod> <StartTime>09:45:00+12:00</StartTime> <EndTime>10:35:00+12:00</EndTime> </DayPeriodTime> </DayPeriodTimeList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </SchedulePeriodTime>
Example 3.2.15-1: Schedule Period Time

### 3.2.16 ScheduleTerm

Provides information about school terms, tertiary terms etc., either at a national, or provider level, within a school year. If the term is being supplied at a national level, no provider information will be linked.

SIF_Events are reported for this object.

Figure 3.2.16-1: ScheduleTerm

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| ScheduleTerm |  | Low | Provides information about school terms, tertiary terms etc., either at a national, or provider level, within a school year. If the term is being supplied at a national level, no provider information will be linked. |
| ScheduleTermRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| ScheduleTermLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| TermName | M | Low | The name of the schedule term. | xs:normalizedString
| Organisation | O | Low | The provider the schedule term applies to, ommitted if it applies to all providers. | OrganisationObjectReferenceType
| SchoolYear | M | Low | The school year the Term is part of. | xs:gYear
| StartDate | M | Low | The start date of the term | xs:date
| EndDate | M | Low | The end date of the term | xs:date
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.16-1: ScheduleTerm
JSON
{ "ScheduleTerm": { "ScheduleTermRefId": "eed03e3c-b088-4b69-bba7-b042f6f7a040", "ScheduleTermLocalId": "2019-1", "TermName": "Term I of 2019", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "StartDate": "2019-01-28", "EndDate": "2019-03-13", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<ScheduleTerm> <ScheduleTermRefId>eed03e3c-b088-4b69-bba7-b042f6f7a040</ScheduleTermRefId> <ScheduleTermLocalId>2019-1</ScheduleTermLocalId> <TermName>Term I of 2019</TermName> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <StartDate>2019-01-28</StartDate> <EndDate>2019-03-13</EndDate> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ScheduleTerm>
Example 3.2.16-1: Schedule Term

### 3.2.17 StaffAssignment

Records assignment of a Staff member to a particular role at a Provider or other EducationOrganisation. A staff member can have multiple concurrent roles at Schools (via Provider data object) and Kāhui Ako (via the EducationOrganisation data object); each role would be a separate StaffAssignment record.

Role assignments can be restricted to categories of Students with the StaffSubjectList and YearLevelList. This allows for assignment to roles with particular responsibility for general cohorts of students, such as "Head of Department (Maths)" or "Year 8 Student Dean".

While assignment to student contact roles such as Subject Teacher, Homeroom Teacher, Whānau Teacher or House Master is made with this data object; Details of the particular group of specific students the staff member is responsible for are made via the TeachingGroup data object.

SIF_Events are reported for this object.

Figure 3.2.17-1: StaffAssignment

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StaffAssignment |  | Low | Records assignment of a Staff member to a particular role at a Provider or other EducationOrganisation. A staff member can have multiple concurrent roles at Schools (via Provider data object) and Kāhui Ako (via the EducationOrganisation data object); each role would be a separate StaffAssignment record. Role assignments can be restricted to categories of Students with the StaffSubjectList and YearLevelList. This allows for assignment to roles with particular responsibility for general cohorts of students, such as "Head of Department (Maths)" or "Year 8 Student Dean". While assignment to student contact roles such as Subject Teacher, Homeroom Teacher, Whānau Teacher or House Master is made with this data object; Details of the particular group of specific students the staff member is responsible for are made via the TeachingGroup data object. |
| StaffAssignmentRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StaffAssignmentLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| StaffAssignmentStatus | O | High | States whether or not this is an inactive or active assignment for a staff member. | NZCodeSetsStaffAssignmentStatusType
| StaffMember | M | Low | Generic object reference to the staff member, as represented in the StaffPersonal object. | ObjectReferenceType
| AssignedLocation | M | Low | A generic object reference to either `Provider` or `Organisation` that the staff member is assigned to. | OrganisationObjectReferenceType
| EmployingOrAccommodatingProvider | O | Low | Indicates whether or not this is the staff member's employing/accommodating provider. Only applies to staff members assigned to schools. | NZCodeSetsYesOrNoCategoryType
| Description | O | Low | Short description of the staff member's assignment to the provider. | xs:normalizedString
| StaffRole | M | Low | The single role the StaffMember has in relation to all students at the assigned location. | NZCodeSetsStaffRoleType
| StartDate | M | Low | This is the date from which the staff assignment is valid (inclusive). | xs:date
| EndDate | O | Low | This is the date through which the staff assignment is valid (inclusive). This can be NULL when the staff member's assignment to a particular role is open-ended. | xs:date
| CasualReliefTeacher | M | Low | Is this teacher a casual relief teacher CRT? | NZCodeSetsYesOrNoCategoryType
| EmploymentStatus | O | High | Status of staff member within this school. Where a Staff member is employed by an organisation that covers more than one school, employment status may be different at each school. | NZCodeSetsStaffStatusType
| StaffSubjectList | O | Low | The set of SubjectArea/LearningAreas the that the staff member is responsible for. e.g. "Head of Dept (Maths)" includes students learning any flavour of Mathematics. | StaffSubjectListType
| YearLevels | O | Low | The set of student Year Levels that the staff member is responsible for. e.g. "Junior Student Dean" could have responsibility for all students in year levels 9 & 10. | YearLevelListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.17-1: StaffAssignment
JSON
{ "StaffAssignment": { "StaffAssignmentRefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652", "StaffMember": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1651" }, "AssignedLocation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "Description": "Senior English Teacher", "StaffRole": "1102", "StartDate": "2000-09-05", "EndDate": "2001-06-25", "CasualReliefTeacher": "N", "EmploymentStatus": "A", "StaffSubjectList": { "StaffSubject": [ { "PreferenceNumber": 1, "Code": "ENGL", "YearLevels": { "YearLevel": [ 11, 12, 13 ] } }, { "PreferenceNumber": 2, "Code": "HIST" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StaffAssignment> <StaffAssignmentRefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</StaffAssignmentRefId> <StaffMember> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1651</RefId> </StaffMember> <AssignedLocation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </AssignedLocation> <Description>Senior English Teacher</Description> <StaffRole>1102</StaffRole> <StartDate>2000-09-05</StartDate> <EndDate>2001-06-25</EndDate> <CasualReliefTeacher>N</CasualReliefTeacher> <EmploymentStatus>A</EmploymentStatus> <StaffSubjectList> <StaffSubject> <PreferenceNumber>1</PreferenceNumber> <Code>ENGL</Code> <YearLevels> <YearLevel>11</YearLevel> <YearLevel>12</YearLevel> <YearLevel>13</YearLevel> </YearLevels> </StaffSubject> <StaffSubject> <PreferenceNumber>2</PreferenceNumber> <Code>HIST</Code> </StaffSubject> </StaffSubjectList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StaffAssignment>
Example 3.2.17-1: StaffAssignment English Teacher Example
JSON
{ "StaffAssignment": { "StaffAssignmentRefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652", "StaffMember": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1651", "LocalId": "SMcG", "Name": "Steve McGannaway" }, "AssignedLocation": { "RefId": "592bfa0d-52f8-4468-935c-ae48c71f71c9", "LocalId": "9651" }, "Description": "Kāhui Ako Cross School Teacher", "StaffRole": "1102", "StartDate": "2000-09-05", "EndDate": "2001-06-25", "CasualReliefTeacher": "N", "EmploymentStatus": "A", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StaffAssignment> <StaffAssignmentRefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</StaffAssignmentRefId> <StaffMember> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1651</RefId> <LocalId>SMcG</LocalId> <Name>Steve McGannaway</Name> </StaffMember> <AssignedLocation> <RefId>592bfa0d-52f8-4468-935c-ae48c71f71c9</RefId> <LocalId>9651</LocalId> </AssignedLocation> <Description>Kāhui Ako Cross School Teacher</Description> <StaffRole>1102</StaffRole> <StartDate>2000-09-05</StartDate> <EndDate>2001-06-25</EndDate> <CasualReliefTeacher>N</CasualReliefTeacher> <EmploymentStatus>A</EmploymentStatus> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StaffAssignment>
Example 3.2.17-2: StaffAssignment Kāhui Ako Cross School Teacher Example

### 3.2.18 StaffPersonal

All the personal contact and demographic information relating to a staff member, who might be a teacher or other employee of a Provider.

Non personal information relating to the staff member's relationship with Providers is stored in the StaffAssignment data object.

SIF_Events are reported for this object.

Figure 3.2.18-1: StaffPersonal

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StaffPersonal |  | High | All the personal contact and demographic information relating to a staff member, who might be a teacher or other employee of a Provider. Non personal information relating to the staff member's relationship with Providers is stored in the StaffAssignment data object. |
| StaffPersonalRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StaffPersonalLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| ESLPairwiseId | O | Medium | The GUID used by Education Sector Logon (ESL) to identify the Staff Member | LocalIdType
| SchoolSMSUserId | O | Medium | The identifier used by the school's SMS to identify the Staff Member | LocalIdType
| PersonInfo | M | High | Personal Information | StaffPersonInfoType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.18-1: StaffPersonal
JSON
{ "StaffPersonal": { "StaffPersonalRefId": "d3e34f41-9d75-101a-8c3d-00aa001a1652", "PersonInfo": { "Name": { "FamilyName": "Smith", "GivenName": "Fred", "FullName": "Fred Smith", "Type": "LGL", "IsVerified": "Y" }, "Email": { "Personal": { "Address": "fsmith@yahoo.com" }, "Work": { "Address": "freddy@gmail.com" } } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StaffPersonal> <StaffPersonalRefId>d3e34f41-9d75-101a-8c3d-00aa001a1652</StaffPersonalRefId> <PersonInfo> <Name> <FamilyName>Smith</FamilyName> <GivenName>Fred</GivenName> <FullName>Fred Smith</FullName> <Type>LGL</Type> <IsVerified>Y</IsVerified> </Name> <Email> <Personal> <Address>fsmith@yahoo.com</Address> </Personal> <Work> <Address>freddy@gmail.com</Address> </Work> </Email> </PersonInfo> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StaffPersonal>
Example 3.2.18-1: StaffPersonal

### 3.2.19 StaffTeachingGroupAssignment

Records assignment of a Staff member to a particular role with a particular TeachingGroup at a Provider

SIF_Events are reported for this object.

Figure 3.2.19-1: StaffTeachingGroupAssignment

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StaffTeachingGroupAssignment |  |  | Records assignment of a Staff member to a particular role with a particular TeachingGroup at a Provider |
| StaffTeachingGroupAssignmentRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StaffTeachingGroupAssignmentLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Status | O | High | States whether or not this is an inactive or active assignment for a staff member. | NZCodeSetsStaffTeachingGroupAssignmentStatusType
| StaffMember | M | Low | Generic object reference to the staff member, as represented in the StaffPersonal object. | ObjectReferenceType
| Organisation | M | Low | A generic object reference to the Provider making the assignment. | OrganisationObjectReferenceType
| TeachingGroup | M | Low | A generic object reference to the TeachingGroup that the staff member is assigned to. | ObjectReferenceType
| Role | M | Low | Code denoting the role the staff member plays within the TeachingGroup, eg. ClassroomTeacher, SubjectTeacher, ClassroomAide, etc. | NZCodeSetsStaffTeachingGroupRoleType
| StartDate | M | Low | This is the date from which the staff assignment is valid (inclusive). | xs:date
| EndDate | O | Low | This is the date through which the staff assignment is valid (inclusive). This can be NULL when the staff member's assignment to a particular role is open-ended. | xs:date
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.19-1: StaffTeachingGroupAssignment
JSON
{ "StaffTeachingGroupAssignment": { "StaffTeachingGroupAssignmentRefId": "92828e71-c702-4944-841e-761203142ccd", "StaffMember": { "RefId": "6c12f5ae-ca86-40e2-b252-593154c8b967" }, "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "TeachingGroup": { "RefId": "edc3ac19-264f-4734-b75b-6d56fbf84a18", "LocalId": "11FrenA", "Name": "Year 11 French, Stream A" }, "Role": "1201", "StartDate": "2000-09-05", "EndDate": "2001-06-25", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StaffTeachingGroupAssignment> <StaffTeachingGroupAssignmentRefId>92828e71-c702-4944-841e-761203142ccd</StaffTeachingGroupAssignmentRefId> <StaffMember> <RefId>6c12f5ae-ca86-40e2-b252-593154c8b967</RefId> </StaffMember> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <TeachingGroup> <RefId>edc3ac19-264f-4734-b75b-6d56fbf84a18</RefId> <LocalId>11FrenA</LocalId> <Name>Year 11 French, Stream A</Name> </TeachingGroup> <Role>1201</Role> <StartDate>2000-09-05</StartDate> <EndDate>2001-06-25</EndDate> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StaffTeachingGroupAssignment>
Example 3.2.19-1: Staff TeachingGroup Assignment French Teacher Example

### 3.2.20 StudentActivityParticipation

This object provides information on a co-curricular or extra-curricular activity in which a student participates during a given school year.

SIF_Events are reported for this object.

Figure 3.2.20-1: StudentActivityParticipation

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentActivityParticipation |  |  | This object provides information on a co-curricular or extra-curricular activity in which a student participates during a given school year. |
| StudentActivityParticipationRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentActivityParticipationLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | Low | Generic object reference to the student participating in the activity. | StudentObjectReferenceType
| Organisation | M | Low | Generic object reference to the Provider running the activity the student is participating in, e.g. schools. | OrganisationObjectReferenceType
| ActivityGroup | O | Low | Standard codes denoting the group of the activity the student is participating in, e.g. sport, art, cultural, music. | NZCodeSetsStudentActivityGroupType
| ActivityType | O | Low | Standard codes denoting the type of activity the student is participating in, e.g. rugby, drama, Kapa Haka, Violin. | NZCodeSetsStudentActivityTypeType
| ActivityName | M | Low | The name of the activity the student participated in. | xs:normalizedString
| LearningArea | O | Low | The learning area the student activity the student is participating in relates to. | NZCodeSetsLearningAreaType
| ParticipationComment | O | Low | Comment related to the student's participation in the activity. | xs:normalizedString
| StartDate | M | Low | This is the date from which the activity participation is valid (inclusive). | xs:date
| EndDate | O | Low | This is the date through which the activity participation is valid (inclusive). If element is supported by the publisher/responder, should contain a date if the student withdraws from the activity before the end of the school year. | xs:date
| Role | O | Low | Specific role the student plays in the activity (e.g., band leader, student body president). | xs:normalizedString
| RecognitionList | O | Low | List of awards and other types of recognition given to the student for this activity. | RecognitionListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.20-1: StudentActivityParticipation
JSON
{ "StudentActivityParticipation": { "StudentActivityParticipationRefId": "9ecc9683-0e02-406f-926c-1c4d3542d122", "Student": { "RefId": "646c5d4a-c829-4886-a02b-971695c7bc06" }, "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "ActivityGroup": "SPO", "ActivityType": "CRI", "ActivityName": "First XI", "ParticipationComment": "First year of participation", "StartDate": "2008-09-01", "Role": "Team Member", "RecognitionList": { "Recognition": [ "Player of the Day" ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentActivityParticipation> <StudentActivityParticipationRefId>9ecc9683-0e02-406f-926c-1c4d3542d122</StudentActivityParticipationRefId> <Student> <RefId>646c5d4a-c829-4886-a02b-971695c7bc06</RefId> </Student> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <ActivityGroup>SPO</ActivityGroup> <ActivityType>CRI</ActivityType> <ActivityName>First XI</ActivityName> <ParticipationComment>First year of participation</ParticipationComment> <StartDate>2008-09-01</StartDate> <Role>Team Member</Role> <RecognitionList> <Recognition>Player of the Day</Recognition> </RecognitionList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentActivityParticipation>
Example 3.2.20-1: StudentActivityParticipation

### 3.2.21 StudentAssessmentTask

Record of a student's attempt at a particular assessment task.

SIF_Events are reported for this object.

Figure 3.2.21-1: StudentAssessmentTask

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentAssessmentTask |  | Low | Record of a student's attempt at a particular assessment task. |
| StudentAssessmentTaskRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentAssessmentTaskLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | Low | Generic object reference to the student held in the StudentPersonal data object who is being assessed against the assessment task. | StudentObjectReferenceType
| AssessmentTask | M | Low | Generic object reference to the AssessmentTask data object that the student assessment is for. | ObjectReferenceType
| StudentAssessmentTaskRegistration | O | Low | Generic object reference to the registration made on behalf of the student by the school to sit this assessment. | ObjectReferenceType
| OrganisationInvolvedList | M | Low | A list of the Providers/Organisations involved and their role, e.g. assessing provider, assessment provider, assessment location provider. | OrganisationInvolvedListType
| StaffInvolvedList | O | Low | A list of the staff involved and their role in relation to the assessment task, e.g. the staff members that supervise the undertaking of the assessment task by the student. | StaffInvolvedListType
| DateTimeAssessmentScheduled | O | Low | The date and time the student is scheduled to be assessed against the assessment task. | xs:dateTime
| DateTimeAssessed | O | Low | The date and time the student was assessed against the assessment task. | xs:dateTime
| Status | O | Low | Code denoting the current status of the student assessment task | NZCodeSetsAssessmentStatusType
| NCEAStatusDate | O | Low | Date the current NCEA status was set. | xs:date
| AssessmentAttempt | O | Low | The attempt number the student is making to pass this assessment, e.g. is it their first, second attempt. | xs:int
| SpecialAssessmentConditionList | O | Low | The list of the special assessment conditions that the student is entitled to have when sitting this assessment task. | SpecialAssessmentConditionListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.21-1: StudentAssessmentTask
JSON
{ "StudentAssessmentTask": { "StudentAssessmentTaskRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "LocalId": "850139-HP", "Name": "Harry Potter", "NationalStudentNumber": "23423421" }, "AssessmentTask": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39" }, "OrganisationInvolvedList": { "OrganisationInvolved": [ { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961", "OrganisationRole": "LOC" }, { "RefId": "8ec05a56-1c5f-4fc7-9ea1-d328c5467c59", "LocalId": "9962", "OrganisationRole": "PRO" } ] }, "StaffInvolvedList": { "StaffInvolved": [ { "RefId": "228a2cbe-93c4-46ba-91fa-b3ae689eb437", "Name": "Prof. McGonnegal", "StaffRole": "INV" } ] }, "DateTimeAssessmentScheduled": "2018-11-25T10:00:00+13:00", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentAssessmentTask> <StudentAssessmentTaskRefId>359d7510-1ad0-a9d7-a8c3-dad0a85103a2</StudentAssessmentTaskRefId> <Student> <RefId>cd106d6d-d9d5-41fb-9943-5feb967c9435</RefId> <LocalId>850139-HP</LocalId> <Name>Harry Potter</Name> <NationalStudentNumber>23423421</NationalStudentNumber> </Student> <AssessmentTask> <RefId>d0a0a27a-d0a8-510a-d9d7-5101a8c3da39</RefId> </AssessmentTask> <OrganisationInvolvedList> <OrganisationInvolved> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> <OrganisationRole>LOC</OrganisationRole> </OrganisationInvolved> <OrganisationInvolved> <RefId>8ec05a56-1c5f-4fc7-9ea1-d328c5467c59</RefId> <LocalId>9962</LocalId> <OrganisationRole>PRO</OrganisationRole> </OrganisationInvolved> </OrganisationInvolvedList> <StaffInvolvedList> <StaffInvolved> <RefId>228a2cbe-93c4-46ba-91fa-b3ae689eb437</RefId> <Name>Prof. McGonnegal</Name> <StaffRole>INV</StaffRole> </StaffInvolved> </StaffInvolvedList> <DateTimeAssessmentScheduled>2018-11-25T09:00:00+12:00</DateTimeAssessmentScheduled> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTask>
Example 3.2.21-1: Student Assessment Task

### 3.2.22 StudentAssessmentTaskRegistration

The student's registration for an assessment task they are intending to participate in.

SIF_Events are reported for this object.

Figure 3.2.22-1: StudentAssessmentTaskRegistration

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentAssessmentTaskRegistration |  | Low | The student's registration for an assessment task they are intending to participate in. |
| StudentAssessmentTaskRegistrationRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentAssessmentTaskRegistrationLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| AssessmentRegistrationStatus | O | Low | The status of the student's registration for an assessment task, e.g. applied, approved, withdrawn. | NZCodeSetsAssessmentRegistrationStatusType
| OrganisationInvolvedList | M | Low | A list of the Providers/Organisations involved and their role, e.g. assessment provider, registering provider. | OrganisationInvolvedListType
| Student | M | Low | Generic object reference to the student held in the StudentPersonal data object whose intention to participate in an assessment task is being registered. | StudentObjectReferenceType
| StaffMember | O | Low | Generic object reference to the StaffPersonal data object representing the teacher who registered the student's intention to participate in the assessment task. | ObjectReferenceType
| AssessmentTask | M | Low | Generic object reference to the AssessmentTask data object that the registration is for. | ObjectReferenceType
| NZQA | O | Low | Extra details to support NZQA assessment registration process | NZQAAssessmentRegistrationType
| SpecialAssessmentConditionList | O | Low | A list of references identifying any Special Assessment Conditions that the student is entitled to for the assessment task they are registering for. | SpecialAssessmentConditionListType
| ProviderCourse | O | Low | Generic object reference to the ProviderCourse that the assessment task is being set as part of. | ObjectReferenceType
| LearningStandard | O | Low | Generic object reference to the LearningStandard the student is registering for. | LearningStandardObjectReferenceType
| SubjectArea | O | Low | Code denoting the Learning or Subject Area the assessment task registration is for. | NZCodeSetsSubjectAreaType
| YearLevel | O | Low | The Year Level of the assessment task the registration is for. May only contain the values 1 through to 13 inclusive. | xs:int
xs:minInclusive | 1
xs:maxInclusive | 13
| DateRegistered | M | Low | The date the student's intent to participate in the assessment task was registered. | xs:date
| AssessmentYear | M | Low | The assessment year the student's intent to participate in the assessment task was registered for. | xs:gYear
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.22-1: StudentAssessmentTaskRegistration
JSON
{ "StudentAssessmentTaskRegistration": { "StudentAssessmentTaskRegistrationRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "OrganisationInvolvedList": { "OrganisationInvolved": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961", "OrganisationRole": "PRO" } }, "Student": { "LocalId": "851039-HP", "Name": "Harry Potter", "NationalStudentNumber": "23423421" }, "StaffMember": { "RefId": "c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb" }, "AssessmentTask": { "RefId": "cedd0ce7-f555-482b-887b-d130e5c40d02" }, "SpecialAssessmentConditionList": { "SpecialAssessmentCondition": [ "COM", "EXT", "SEP" ] }, "SubjectArea": "PHYS", "YearLevel": 12, "DateRegistered": "2018-03-30", "AssessmentYear": 2018, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentAssessmentTaskRegistration> <StudentAssessmentTaskRegistrationRefId>359d7510-1ad0-a9d7-a8c3-dad0a85103a2</StudentAssessmentTaskRegistrationRefId> <OrganisationInvolvedList> <!-- NZQA is Assessor --> <OrganisationInvolved> <RefId>8ec05a56-1c5f-4fc7-9ea1-d328c5467c59</RefId> <LocalId>9772</LocalId> <OrganisationRole>ASR</OrganisationRole> </OrganisationInvolved> <!-- School is Organisation --> <OrganisationInvolved> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> <OrganisationRole>PRO</OrganisationRole> </OrganisationInvolved> </OrganisationInvolvedList> <Student> <LocalId>851039-HP</LocalId> <Name>Harry Potter</Name> <NationalStudentNumber>23423421</NationalStudentNumber> </Student> <StaffMember> <RefId>c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb</RefId> </StaffMember> <AssessmentTask> <RefId>cedd0ce7-f555-482b-887b-d130e5c40d02</RefId> </AssessmentTask> <SpecialAssessmentConditionList> <SpecialAssessmentCondition>COM</SpecialAssessmentCondition> <SpecialAssessmentCondition>EXT</SpecialAssessmentCondition> <SpecialAssessmentCondition>SEP</SpecialAssessmentCondition> </SpecialAssessmentConditionList> <SubjectArea>PHYS</SubjectArea> <YearLevel>12</YearLevel> <DateRegistered>2018-03-30</DateRegistered> <AssessmentYear>2018</AssessmentYear> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTaskRegistration>
Example 3.2.22-1: Student Assessment Task Registration

### 3.2.23 StudentAssessmentTaskResult

Records the result achieved by a single student at a particular assessment task.

SIF_Events are reported for this object.

Figure 3.2.23-1: StudentAssessmentTaskResult

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentAssessmentTaskResult |  | High | Records the result achieved by a single student at a particular assessment task. |
| StudentAssessmentTaskResultRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentAssessmentTaskResultLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| NZQAEntryId | O | Low | The student's NZQA entry Id provided upon confirmation of the student's registration to be assessed against a unit or achievement standard. Identifies what entry the result is for to NZQA. | xs:normalizedString
| AssessmentTask | O | Low | Reference to the AssessmentTask the student was assessed against and the result is for. | ObjectReferenceType
| StudentAssessmentTask | O | Low | Reference to the StudentAssessmentTask data object that the assessment result belongs to. | ObjectReferenceType
| Student | M | Low | Generic object reference to the student held in the StudentPersonal data object whose assessment task result this is. | StudentObjectReferenceType
| AssessmentType | O | Low | The type of assessment the result is for. | NZCodeSetsAssessmentTypeType
| AssessmentMethodology | M | Low | Code denoting the nature of the assessment process; Primary assessment against NZ Curriculum or Te Marautanga o Aotearoa; Secondary assessment against NCEA, Cambridge, International Baccalaureate, or similar. | NZCodeSetsAssessmentMethodologyType
| OrganisationInvolvedList | M | Low |  | OrganisationInvolvedListType
| StaffInvolvedList | O | Low | A list of the staff involved and their role in relation to the assessment task, e.g. the moderator, the marker. | StaffInvolvedListType
| ProviderCourse | O | Low | Reference to the ProviderCourse that this assessment task belongs to. | ObjectReferenceType
| LearningStandardList | O | Low | A list of references to the LearningStandards the assessment task result is related to. | LearningStandardListType
| SubjectAreaList | O | Low | A list of the subject areas that the assessment pertains to. | SubjectAreaListType
| AssessedAtYearLevel | O | Low | Year Level of the Assessment Task the student is being assessed against. May only contain the values 1 through to 13 inclusive. | xs:int
xs:minInclusive | 1
xs:maxInclusive | 13
| Curriculum | O | Low | Code denoting the Year Level of the Assessment Task the result is for. | NZCodeSetsCurriculumType
| AssessmentToolUsed | O | Low | The type of assessment tool used for the assessment task. Both the original free text value sent by the SMS vendors and the value it is mapped to in this code set are held. | NZCodeSetsAssessmentToolType
| AssessmentToolTest | O | Low | The tests available within an assessment tool that is being used by this assessment task. | NZCodeSetsAssessmentToolTestType
| Timeframe | O | Low | The timeframe of the assessment, e.g. Mid-Year, End of Year. | NZCodeSetsAssessmentTimeframeType
| AssessmentAttempt | O | Low | The attempt number the student is making to pass this assessment, e.g. is it their first, second attempt. | xs:int
| EvaluationType | O | Low | The type of assessment evaluation, e.g. formative or summative. | NZCodeSetsAssessmentEvaluationTypeType
| StandardType | O | Low | The type of standard the result is for. Applies to secondary level assessments, e.g. unit and achievement standards, scholarships and International Baccalaureate. | NZCodeSetsLearningStandardTypeType
| DateMarked | O | Low | Date the assessment task was marked. | xs:date
| DateTimeAssessed | O | Low | The date and time the student was assessed against the assessment task. | xs:dateTime
| DateStudentNotified | O | Low | The date the student was notified of their final mark for the assessment task. | xs:date
| NZQAConfirmation | O | Low | Confirmation from NZQA that they have received the result record for the student. | NZCodeSetsYesOrNoCategoryType
| Published | O | Low | Indicates whether or not the result has been published. | NZCodeSetsYesOrNoCategoryType
| PublishedDate | O | Low | The date the assessment task result was first published in a report. | xs:date
| Iteration | O | Low | The iteration of this result for the assessment, e.g. some tasks require multiple assessments before being achieved. | xs:int
| CreditsAchieved | O | Low | The number of credits the student achieved. | xs:decimal
| ResultScoreList | M | Low | A list of the assessment result scores that the student received for this assessment task. | AssessmentResultScoreListType
| Weight | O | Low | Weight placed upon this result | xs:decimal
| EffortComment | O | Low | Free text comment about the effort the student made for the assessment. | xs:normalizedString
| OtherComment | O | Low | Free text comments providing additional information for the students assessment result. | xs:normalizedString
| DocumentList | O | Low | List which describes the meta-data for, and the Location of any associated documents. | DocumentListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.23-1: StudentAssessmentTaskResult
JSON
{ "StudentAssessmentTaskResult": { "StudentAssessmentTaskResultRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "a75a0010-1a8c-301d-02e3-a05b359d0a00" }, "AssessmentType": "INT", "AssessmentMethodology": "P", "OrganisationInvolvedList": { "OrganisationInvolved": [ { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961", "OrganisationRole": "PRO" } ] }, "SubjectAreaList": { "SubjectArea": [ "MATH" ] }, "Curriculum": "NZC", "AssessmentToolUsed": "PATCOMP", "EvaluationType": "F", "DateTimeAssessed": "2018-11-21T15:34:22", "ResultScoreList": { "ResultScore": [ { "ScoreType": "FIN", "ScoreMetric": "RAW", "ScoreValue": "25" }, { "ScoreType": "FIN", "ScoreMetric": "SCA", "ScoreValue": "38.5" }, { "ScoreType": "FIN", "ScoreMetric": "MAR", "ScoreValue": "5.0" }, { "ScoreType": "FIN", "ScoreMetric": "YEA", "ScoreValue": "4" }, { "ScoreType": "FIN", "ScoreMetric": "STA", "ScoreValue": "6" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentAssessmentTaskResult> <StudentAssessmentTaskResultRefId>359d7510-1ad0-a9d7-a8c3-dad0a85103a2</StudentAssessmentTaskResultRefId> <Student> <RefId>a75a0010-1a8c-301d-02e3-a05b359d0a00</RefId> </Student> <AssessmentType>INT</AssessmentType> <AssessmentMethodology>P</AssessmentMethodology> <OrganisationInvolvedList> <OrganisationInvolved> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> <OrganisationRole>PRO</OrganisationRole> </OrganisationInvolved> </OrganisationInvolvedList> <SubjectAreaList> <SubjectArea>MATH</SubjectArea> </SubjectAreaList> <Curriculum>NZC</Curriculum> <AssessmentToolUsed>PATCOMP</AssessmentToolUsed> <EvaluationType>F</EvaluationType> <DateTimeAssessed>2018-11-21T15:34:22</DateTimeAssessed> <ResultScoreList> <ResultScore> <ScoreType>FIN</ScoreType> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>25</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <ScoreMetric>SCA</ScoreMetric> <!-- Scale Score --> <ScoreValue>38.5</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <ScoreMetric>MAR</ScoreMetric> <!-- Margin of Error --> <ScoreValue>5.0</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <ScoreMetric>YEA</ScoreMetric> <!-- Year Level --> <ScoreValue>4</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <ScoreMetric>STA</ScoreMetric> <!-- Stanine --> <ScoreValue>6</ScoreValue> </ResultScore> </ResultScoreList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTaskResult>
Example 3.2.23-1: Student Assessment Task Result - PAT Example
JSON
{ "StudentAssessmentTaskResult": { "StudentAssessmentTaskResultRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "a75a0010-1a8c-301d-02e3-a05b359d0a00" }, "AssessmentType": "INT", "AssessmentMethodology": "P", "OrganisationInvolvedList": { "OrganisationInvolved": [ { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961", "OrganisationRole": "PRO" } ] }, "SubjectAreaList": { "SubjectArea": [ "ENGL" ] }, "Curriculum": "NZC", "AssessmentToolUsed": "STARREA", "EvaluationType": "F", "DateTimeAssessed": "2018-11-01T15:34:22", "ResultScoreList": { "ResultScore": [ { "ScoreType": "FIN", "Competency": "SubTest1", "ScoreMetric": "RAW", "ScoreValue": "8" }, { "ScoreType": "FIN", "Competency": "SubTest2", "ScoreMetric": "RAW", "ScoreValue": "7" }, { "ScoreType": "FIN", "Competency": "SubTest3", "ScoreMetric": "RAW", "ScoreValue": "10" }, { "ScoreType": "FIN", "Competency": "SubTest9", "ScoreMetric": "RAW", "ScoreValue": "9" }, { "ScoreType": "FIN", "Competency": "Summary", "ScoreMetric": "SCA", "ScoreValue": "22" }, { "ScoreType": "FIN", "Competency": "Summary", "ScoreMetric": "YEA", "ScoreValue": "5" }, { "ScoreType": "FIN", "Competency": "Summary", "ScoreMetric": "STA", "ScoreValue": "4" } ] }, "EffortComment": "Good progress this year...", "OtherComment": "Read more at home", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentAssessmentTaskResult> <StudentAssessmentTaskResultRefId>359d7510-1ad0-a9d7-a8c3-dad0a85103a2</StudentAssessmentTaskResultRefId> <Student> <RefId>a75a0010-1a8c-301d-02e3-a05b359d0a00</RefId> </Student> <AssessmentType>INT</AssessmentType> <AssessmentMethodology>P</AssessmentMethodology> <OrganisationInvolvedList> <OrganisationInvolved> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> <OrganisationRole>PRO</OrganisationRole> </OrganisationInvolved> </OrganisationInvolvedList> <SubjectAreaList> <SubjectArea>ENGL</SubjectArea> </SubjectAreaList> <Curriculum>NZC</Curriculum> <AssessmentToolUsed>STARREA</AssessmentToolUsed> <EvaluationType>F</EvaluationType> <DateTimeAssessed>2018-11-01T15:34:22</DateTimeAssessed> <ResultScoreList> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>SubTest1</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>8</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>SubTest2</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>7</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>SubTest3</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>10</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>SubTest9</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>9</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Summary</Competency> <ScoreMetric>SCA</ScoreMetric> <!-- Scale Score --> <ScoreValue>22</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Summary</Competency> <ScoreMetric>YEA</ScoreMetric> <!-- Year Level --> <ScoreValue>5</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Summary</Competency> <ScoreMetric>STA</ScoreMetric> <!-- Stanine Score --> <ScoreValue>4</ScoreValue> </ResultScore> </ResultScoreList> <EffortComment>Good progress this year...</EffortComment> <OtherComment>Read more at home</OtherComment> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTaskResult>
Example 3.2.23-2: Student Assessment Task Result - STAR Example
JSON
{ "StudentAssessmentTaskResult": { "StudentAssessmentTaskResultRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "a75a0010-1a8c-301d-02e3-a05b359d0a00" }, "AssessmentType": "INT", "AssessmentMethodology": "P", "OrganisationInvolvedList": { "OrganisationInvolved": [ { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961", "OrganisationRole": "PRO" } ] }, "SubjectAreaList": { "SubjectArea": [ "ENGL" ] }, "Curriculum": "NZC", "AssessmentToolUsed": "EASREAD", "EvaluationType": "F", "DateTimeAssessed": "2018-11-01T15:34:22", "ResultScoreList": { "ResultScore": [ { "ScoreType": "FIN", "Competency": "Overall", "ScoreMetric": "RAW", "ScoreValue": "1591" }, { "ScoreType": "FIN", "Competency": "Overall", "ScoreMetric": "CUR", "ScoreValue": "5" }, { "ScoreType": "FIN", "Competency": "Ideas", "ScoreMetric": "RAW", "ScoreValue": "1234" }, { "ScoreType": "FIN", "Competency": "Ideas", "ScoreMetric": "CUR", "ScoreValue": "5" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentAssessmentTaskResult> <StudentAssessmentTaskResultRefId>359d7510-1ad0-a9d7-a8c3-dad0a85103a2</StudentAssessmentTaskResultRefId> <Student> <RefId>a75a0010-1a8c-301d-02e3-a05b359d0a00</RefId> </Student> <AssessmentType>INT</AssessmentType> <AssessmentMethodology>P</AssessmentMethodology> <OrganisationInvolvedList> <OrganisationInvolved> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> <OrganisationRole>PRO</OrganisationRole> </OrganisationInvolved> </OrganisationInvolvedList> <SubjectAreaList> <SubjectArea>ENGL</SubjectArea> </SubjectAreaList> <Curriculum>NZC</Curriculum> <AssessmentToolUsed>EASREAD</AssessmentToolUsed> <EvaluationType>F</EvaluationType> <DateTimeAssessed>2018-11-01T15:34:22</DateTimeAssessed> <ResultScoreList> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Overall</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>1591</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Overall</Competency> <ScoreMetric>CUR</ScoreMetric> <!-- Curriculum Level --> <ScoreValue>5</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Ideas</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>1234</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Ideas</Competency> <ScoreMetric>CUR</ScoreMetric> <!-- Curriculum Level --> <ScoreValue>5</ScoreValue> </ResultScore> </ResultScoreList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTaskResult>
Example 3.2.23-3: Student Assessment Task Result - asTTle Example
JSON
{ "StudentAssessmentTaskResult": { "StudentAssessmentTaskResultRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "a75a0010-1a8c-301d-02e3-a05b359d0a00" }, "AssessmentType": "INT", "AssessmentMethodology": "P", "OrganisationInvolvedList": { "OrganisationInvolved": [ { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961", "OrganisationRole": "PRO" } ] }, "SubjectAreaList": { "SubjectArea": [ "MATH" ] }, "Curriculum": "NZC", "EvaluationType": "F", "DateTimeAssessed": "2018-11-01T15:34:22", "ResultScoreList": { "ResultScore": [ { "ScoreType": "FIN", "Competency": "Number Sequence and Order", "ScoreMetric": "NKS", "ScoreValue": "NKS-AP" }, { "ScoreType": "FIN", "Competency": "Fractions", "ScoreMetric": "NKS", "ScoreValue": "NKS-AM" }, { "ScoreType": "FIN", "Competency": "Place Value", "ScoreMetric": "NKS", "ScoreValue": "NKS-AP" }, { "ScoreType": "FIN", "Competency": "Basic Facts", "ScoreMetric": "NKS", "ScoreValue": "NKS-AM" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentAssessmentTaskResult> <StudentAssessmentTaskResultRefId>359d7510-1ad0-a9d7-a8c3-dad0a85103a2</StudentAssessmentTaskResultRefId> <Student> <RefId>a75a0010-1a8c-301d-02e3-a05b359d0a00</RefId> </Student> <AssessmentType>INT</AssessmentType> <AssessmentMethodology>P</AssessmentMethodology> <OrganisationInvolvedList> <OrganisationInvolved> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> <OrganisationRole>PRO</OrganisationRole> </OrganisationInvolved> </OrganisationInvolvedList> <SubjectAreaList> <SubjectArea>MATH</SubjectArea> </SubjectAreaList> <Curriculum>NZC</Curriculum> <EvaluationType>F</EvaluationType> <DateTimeAssessed>2018-11-01T15:34:22</DateTimeAssessed> <ResultScoreList> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Number Sequence and Order</Competency> <ScoreMetric>NKS</ScoreMetric> <!-- Number Knowledge Stage --> <ScoreValue>NKS-AP</ScoreValue> <!-- Advanced Proportional --> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Fractions</Competency> <ScoreMetric>NKS</ScoreMetric> <!-- Number Knowledge Stage --> <ScoreValue>NKS-AM</ScoreValue> <!-- Advanced Multiplicative --> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Place Value</Competency> <ScoreMetric>NKS</ScoreMetric> <!-- Number Knowledge Stage --> <ScoreValue>NKS-AP</ScoreValue> <!-- Advanced Proportional --> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Basic Facts</Competency> <ScoreMetric>NKS</ScoreMetric> <!-- Number Knowledge Stage --> <ScoreValue>NKS-AM</ScoreValue> <!-- Advanced Multiplicative --> </ResultScore> </ResultScoreList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTaskResult>
Example 3.2.23-4: Student Assessment Task Result - IKAN Example

### 3.2.24 StudentAttainment

Records a student gaining an Attainment e.g. NCEA Qualification, Learning Standard etc.

SIF_Events are reported for this object.

Figure 3.2.24-1: StudentAttainment

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentAttainment |  | Low | Records a student gaining an Attainment e.g. NCEA Qualification, Learning Standard etc. |
| StudentAttainmentRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentAttainmentLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| GrantingOrganisation | M | Low | Generic object reference to the Provider/Organisation who is granting the attainment to the student, e.g. NZQA, TEC. | OrganisationObjectReferenceType
| Attainment | M | Low | A generic object reference to the type of attainment the student has achieved e.g. ProviderCourse, LeanringStandard etc. | NamedObjectReferenceType
| Student | M | Low | Generic object reference to the student held in the StudentPersonal data object who the attainment is for. | StudentObjectReferenceType
| AuthorisingStaffMember | O | Low | Generic object reference to the StaffPersonal data object representing the staff member who authorised the attainment. | ObjectReferenceType
| DateAttained | O | Low | The date the student achieved the attainment. | xs:date
| YearAttained | O | Low | The year the student achieved the attainment. | xs:gYear
| JustificationList | O | Low | A list of references identifying the assessment task results that justify the student achieving this attainment. | JustificationListType
| SubjectAreaList | O | Low | Code denoting the Learning or Subject Area the assessment task is for. | SubjectAreaListType
| EndorsementLevel | O | Low | The NCEA endorsement level that was attained by the student. | NZCodeSetsNCEAEndorsementLevelType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.24-1: StudentAttainment
JSON
{ "StudentAttainment": { "StudentAttainmentRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "GrantingOrganisation": { "RefId": "8ec05a56-1c5f-4fc7-9ea1-d328c5467c59", "LocalId": 9772 }, "Attainment": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39", "Name": "NCEA Level 2 Chemistry - Endorsed with merit", "ObjectType": "Credential" }, "Student": { "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "LocalId": "HP85-1039", "Name": "Harry Potter", "NationalStudentNumber": "23423421" }, "DateAttained": "2018-07-25", "JustificationList": { "Justification": [ { "RefId": "2752a16b-b62a-4973-9d44-23e13e1c037b", "LocalId": "91165-v2", "Name": "Demonstrate understanding of the properties of selected organic compounds", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "EXT", "Result": "Achieved", "Date": "2016-06-28", "CreditValue": 4 }, { "RefId": "eca0da5d-94af-4223-aaa6-7c0083006efd", "LocalId": "91166-v2", "Name": "Demonstrate understanding of chemical reactivity", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "INT", "Result": "Achieved with merit", "Date": "2016-06-01", "CreditValue": 3 }, { "RefId": "12f4761d-5e97-4e12-804e-e16d882c86c7", "LocalId": "91167-v2", "Name": "Demonstrate understanding of oxidation-reduction", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "EXT", "Result": "Achieved", "Date": "2016-06-28", "CreditValue": 3 } ] }, "SubjectAreaList": { "SubjectArea": [ "CHEM" ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentAttainment> <StudentAttainmentRefId>359d7510-1ad0-a9d7-a8c3-dad0a85103a2</StudentAttainmentRefId> <GrantingOrganisation> <RefId>8ec05a56-1c5f-4fc7-9ea1-d328c5467c59</RefId> <LocalId>9772</LocalId> </GrantingOrganisation> <Attainment> <RefId>d0a0a27a-d0a8-510a-d9d7-5101a8c3da39</RefId> <Name>NCEA Level 2 Chemistry - Endorsed with merit</Name> <ObjectType>Credential</ObjectType> </Attainment> <Student> <RefId>cd106d6d-d9d5-41fb-9943-5feb967c9435</RefId> <LocalId>HP85-1039</LocalId> <Name>Harry Potter</Name> <NationalStudentNumber>23423421</NationalStudentNumber> </Student> <DateAttained>2018-07-25</DateAttained> <JustificationList> <Justification> <RefId>2752a16b-b62a-4973-9d44-23e13e1c037b</RefId> <LocalId>91165-v2</LocalId> <Name>Demonstrate understanding of the properties of selected organic compounds</Name> <ObjectType>StudentAssessmentTaskResult</ObjectType> <AssessmentType>EXT</AssessmentType> <Result>Achieved</Result> <Date>2016-06-28</Date> <CreditValue>4</CreditValue> </Justification> <Justification> <RefId>eca0da5d-94af-4223-aaa6-7c0083006efd</RefId> <LocalId>91166-v2</LocalId> <Name>Demonstrate understanding of chemical reactivity</Name> <ObjectType>StudentAssessmentTaskResult</ObjectType> <AssessmentType>INT</AssessmentType> <Result>Achieved with merit</Result> <Date>2016-06-01</Date> <CreditValue>3</CreditValue> </Justification> <Justification> <RefId>12f4761d-5e97-4e12-804e-e16d882c86c7</RefId> <LocalId>91167-v2</LocalId> <Name>Demonstrate understanding of oxidation-reduction</Name> <ObjectType>StudentAssessmentTaskResult</ObjectType> <AssessmentType>EXT</AssessmentType> <Result>Achieved</Result> <Date>2016-06-28</Date> <CreditValue>3</CreditValue> </Justification> </JustificationList> <SubjectAreaList> <SubjectArea>CHEM</SubjectArea> </SubjectAreaList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAttainment>
Example 3.2.24-1: Student Attainment - NCEA Course Endorsement
JSON
{ "StudentAttainment": { "StudentAttainmentRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "GrantingOrganisation": { "RefId": "8ec05a56-1c5f-4fc7-9ea1-d328c5467c59", "LocalId": "9772" }, "Attainment": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39", "Name": "Introduction to Astrophysics", "ObjectType": "ProviderCourse" }, "Student": { "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "LocalId": "HP-850139", "Name": "Harry Potter", "NationalStudentNumber": "23423421" }, "AuthorisingStaffMember": { "RefId": "5f399b12-b81f-405a-aa55-648341ca2e3c", "Name": "Prof. McGonnegal" }, "DateAttained": "2018-07-25", "SubjectAreaList": { "SubjectArea": [ "PHYS" ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentAttainment> <StudentAttainmentRefId>359d7510-1ad0-a9d7-a8c3-dad0a85103a2</StudentAttainmentRefId> <GrantingOrganisation> <RefId>8ec05a56-1c5f-4fc7-9ea1-d328c5467c59</RefId> <LocalId>9772</LocalId> </GrantingOrganisation> <Attainment> <RefId>d0a0a27a-d0a8-510a-d9d7-5101a8c3da39</RefId> <Name>Introduction to Astrophysics</Name> <ObjectType>ProviderCourse</ObjectType> </Attainment> <Student> <RefId>cd106d6d-d9d5-41fb-9943-5feb967c9435</RefId> <LocalId>HP-850139</LocalId> <Name>Harry Potter</Name> <NationalStudentNumber>23423421</NationalStudentNumber> </Student> <AuthorisingStaffMember> <RefId>5f399b12-b81f-405a-aa55-648341ca2e3c</RefId> <Name>Prof. McGonnegal</Name> </AuthorisingStaffMember> <DateAttained>2018-07-25</DateAttained> <SubjectAreaList> <SubjectArea>PHYS</SubjectArea> </SubjectAreaList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAttainment>
Example 3.2.24-2: Student Attainment - School Course Completion

### 3.2.25 StudentAttendanceSummary

Provides a summary of a student's daily attendance and membership information for a given provider during the time period between the StartDate and EndDate, inclusive. There will be multiple instances of this object for a student in a school over the course of a school year. This summary may be generated by aggregating more granular attendance records, in which case all fields will be read-only; and RefId element may not be applicable.

SIF_Events are reported for this object.

Figure 3.2.25-1: StudentAttendanceSummary

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentAttendanceSummary |  | Low | Provides a summary of a student's daily attendance and membership information for a given provider during the time period between the StartDate and EndDate, inclusive. There will be multiple instances of this object for a student in a school over the course of a school year. This summary may be generated by aggregating more granular attendance records, in which case all fields will be read-only; and RefId element may not be applicable. |
| StudentAttendanceSummaryRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentAttendanceSummaryLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | Low | The ID (GUID) of the student for whom this attendance information is being reported. | StudentObjectReference
| Organisation | M | Low | The SIF ID of the Provider who is recording this attendance information. | OrganisationObjectReference
| SchoolCalendarYear | M | Low | School year for which the information is applicable. | xs:gYear
| StartDate | M | Low | Starting date of this attendance reporting period. | xs:date
| EndDate | M | Low | Ending date of this attendance reporting period. | xs:date
| StartDay | O | Low | Number of the school day represented in StartDate. | xs:unsignedInt
| EndDay | O | Low | Number of the school day represented in EndDate. | xs:unsignedInt
| FTE | O | Low | Full time equivalent numeric value of the student's course load during this attendance period, expressed in decimal form, where 1.00 represents a full time enrollment. | xs:decimal
xs:minInclusive | 0
xs:maxInclusive | 1
xs:fractionDigits | 2
| AttendancePercentageHalfDays | O | Low | The percentage of half days the student was present when school was in session between the StartDate and EndDate, inclusive. Number of Sessions Present / Total Number of possible sessions = Percentage, e.g. 294/319 = 92.2%. | xs:decimal
| AttendanceUnjustifiedHalfDays | O | Low | The percentage of half days the student had unjustified absences when school was in session between the StartDate and EndDate, inclusive. | xs:decimal
| HalfDaysYearPresent | O | Low | The number of half days the student was present when school was in session between the StartDate and EndDate, inclusive. | xs:decimal
| HalfDaysYearAbsent | O | Low | The number of half days the student was absent when school was in session between the StartDate and EndDate, inclusive. | xs:decimal
| HalfDaysYearJustified | O | Low | The number of half days the student was absent that were justified when school was in session between the StartDate and EndDate, inclusive. | xs:decimal
| HalfDaysYearTotal | O | Low | The total number of half days. | xs:decimal
| HalfDaysYearIntermittantUnjustified | O | Low | The number of days the student was absent from school for an unjustifiable reason when school was in session between the StartDate and EndDate, inclusive, and weren't absence for the complete half-day. | xs:decimal
| HalfDaysYearPercentagePresent | O | Low | The percentage of half days the student was present when school was in session between the StartDate and EndDate, inclusive. | xs:decimal
| HalfDaysYearUnjustified | O | Low | The number of days the student was absent from school for an unjustifiable reason when school was in session between the StartDate and EndDate, inclusive. | xs:decimal
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.25-1: StudentAttendanceSummary
JSON
{ "StudentAttendanceSummary": { "StudentAttendanceSummaryRefId": "d3476fae-8647-384b-da24-31eda3583211", "Student": { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290c" }, "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "SchoolCalendarYear": 2015, "StartDate": "2014-08-30", "EndDate": "2015-06-10", "StartDay": 1, "EndDay": 180, "FTE": 1.0, "HalfDaysYearPresent": 178, "HalfDaysYearJustified": 2, "HalfDaysYearTotal": 2, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentAttendanceSummary> <StudentAttendanceSummaryRefId>d3476fae-8647-384b-da24-31eda3583211</StudentAttendanceSummaryRefId> <Student> <RefId>7c834ea9-eda1-2090-347f-83297e1c290c</RefId> </Student> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <SchoolCalendarYear>2015</SchoolCalendarYear> <StartDate>2014-08-30</StartDate> <EndDate>2015-06-10</EndDate> <StartDay>1</StartDay> <EndDay>180</EndDay> <FTE>1.00</FTE> <HalfDaysYearPresent>178</HalfDaysYearPresent> <HalfDaysYearJustified>2</HalfDaysYearJustified> <HalfDaysYearTotal>2</HalfDaysYearTotal> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAttendanceSummary>
Example 3.2.25-1: StudentAttendanceSummary

### 3.2.26 StudentConsent

A record of Student's consent or non-consent to some action taking place.

SIF_Events are reported for this object.

Figure 3.2.26-1: StudentConsent

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentConsent |  | Extreme | A record of Student's consent or non-consent to some action taking place. |
| StudentConsentRefId | O | Medium | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentConsentLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | Medium | Generic object reference to the student granting or revoking this student consent. | StudentObjectReferenceType
| Organisation | M | Medium | Generic object reference to the organisation being granted this student consent. | OrganisationObjectReferenceType
| StaffMember | O | Medium | Generic object reference to the staff member that is recording this consent. | ObjectReferenceType
| ConsentTo | M |  | What the student is consenting or not consenting to. | NZCodeSetsStudentConsentToType
| ConsentGiven | M |  | Indicates whether or not censent was given, or specifically not given | NZCodeSetsYesNoNotRequiredType
| ConsentGivenBy | O |  | The role of the person who gave consent on behalf of the student, e.g. Whānau, Learner. | NZCodeSetsConsentGivenByType
| ConsentDate | M |  | The date the consent or no consent was given. | xs:date
| ConsentRevokedDate | O |  | The date the consent ended, if it was given. | xs:date
| RelatedObject | O | Medium | Generic object reference to a data object that relates to this consent. e.g. the student enrolment record this consent was captured as part of. | ObjectReferenceType
| AdditionalInformation | O |  | Additional free text information provided about the consent. | xs:normalizedString
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.26-1: StudentConsent
JSON
{ "StudentConsent": { "StudentConsentRefId": "7c834ea9-eda1-2090-347f-83297e1c290c", "StudentConsentLocalId": "S1234567", "Student": { "RefId": "fe659ed3-8a78-4bc0-8876-7b75ac585edf" }, "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentConsent> <StudentConsentRefId>7c834ea9-eda1-2090-347f-83297e1c290c</StudentConsentRefId> <StudentConsentLocalId>S1234567</StudentConsentLocalId> <Student> <RefId>fe659ed3-8a78-4bc0-8876-7b75ac585edf</RefId> </Student> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentConsent>
Example 3.2.26-1: Student Consent

### 3.2.27 StudentContactPersonal

Information about a Student's whānau member.

SIF_Events are reported for this object.

Figure 3.2.27-1: StudentContactPersonal

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentContactPersonal |  | High | Information about a Student's whānau member. |
| StudentContactPersonalRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentContactPersonalLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| HasBOTVote | O | Medium | Records that this Whānau member holds the Whānau's Board of Trustees vote. | NZCodeSetsYesOrNoCategoryType
| PersonInfo | M | High | Personal Information collected about the StudentContact, when that contact is a member of the Student's whānau. | StudentContactPersonInfoType
| HealthcareServiceInfo | O | High | Information about the StudentContact, when that contact is a healthcare service. Details about the actual healthcare pratitioner are kept in the PersonInfo fields. | HealthcareServiceInfoType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.27-1: StudentContactPersonal
JSON
{ "StudentContactPersonal": { "StudentContactPersonalRefId": "7c834ea9-eda1-2090-347f-83297e1c290f", "StudentContactPersonalLocalId": "P1234567", "HasBOTVote": "N", "PersonInfo": { "Name": { "FamilyName": "Hagrid", "GivenName": "Fridwulfa", "FullName": "Fridwulfa Hagrid", "Type": "LGL" }, "Email": { "Personal": { "Address": "ridwulfa@gmail.com" } }, "Address": { "Physical": { "Type": "TH", "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way", "City": "Hogsmead", "PostalCode": "7733" }, "Postal": { "Type": "RU", "Line1": "1175 Lake Ferry Rd", "Suburb": "RD 1", "City": "Martinborough" } }, "Phone": { "Mobile": { "Number": "(021) 300 999" } }, "HouseholdContactInfoList": { "HouseholdContactInfo": [ { "PreferenceNumber": 1, "HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e", "Address": { "Postal": { "Type": "DE", "Line1": "P O Box 81", "City": "Martinborough", "PostalCode": "5781" } }, "Email": { "Work": { "Address": "ridwulfa@gmail.com" } }, "Phone": { "Mobile": { "Number": "(021) 300 999" } } } ] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentContactPersonal> <StudentContactPersonalRefId>7c834ea9-eda1-2090-347f-83297e1c290f</StudentContactPersonalRefId> <StudentContactPersonalLocalId>P1234567</StudentContactPersonalLocalId> <HasBOTVote>N</HasBOTVote> <PersonInfo> <Name> <FamilyName>Hagrid</FamilyName> <GivenName>Fridwulfa</GivenName> <FullName>Fridwulfa Hagrid</FullName> <Type>LGL</Type> </Name> <Email> <Personal> <Address>ridwulfa@gmail.com</Address> </Personal> </Email> <Address> <Physical> <Type>TH</Type> <Line1>The Enchanted Wood</Line1> <Line2>533 Hogwart's Way</Line2> <City>Hogsmead</City> <PostalCode>7733</PostalCode> </Physical> <Postal> <Type>RU</Type> <Line1>1175 Lake Ferry Rd</Line1> <Suburb>RD 1</Suburb> <City>Martinborough</City> </Postal> </Address> <Phone> <Mobile> <Number>(021) 300 999</Number> </Mobile> </Phone> <HouseholdContactInfoList> <HouseholdContactInfo> <PreferenceNumber>1</PreferenceNumber> <HouseholdContactId>7d5c3f5c-d89c-4551-9442-6b008207986e</HouseholdContactId> <Address> <Postal> <Type>DE</Type> <Line1>P O Box 81</Line1> <City>Martinborough</City> <PostalCode>5781</PostalCode> </Postal> </Address> <Email> <Work> <Address>ridwulfa@gmail.com</Address> </Work> </Email> <Phone> <Mobile> <Number>(021) 300 999</Number> </Mobile> </Phone> </HouseholdContactInfo> </HouseholdContactInfoList> </PersonInfo> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentContactPersonal>
Example 3.2.27-1: StudentContactPersonal Family Member Example
JSON
{ "StudentContactPersonal": { "StudentContactPersonalRefId": "7c834ea9-eda1-2090-347f-face7e1c290f", "StudentContactPersonalLocalId": "P1234567", "HasBOTVote": "N", "PersonInfo": { "Name": { "FullName": "Dr Phillips" }, "Email": { "Work": { "Address": "Phillips@mboroHealth.com" } }, "Address": { "Physical": { "Type": "TH", "Line1": "Regent St.", "City": "Martinborough", "PostalCode": "5741" } }, "Phone": { "Work": { "Number": "(021) 300 999" } } }, "HealthcareServiceInfo": { "OrganisationName": "Martinborough Medical Centre", "OrganisationPhoneNum": "06 306 9311", "Notes": "Dr Amy also knows about the epilepsy", "Type": "DOC" }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentContactPersonal> <StudentContactPersonalRefId>7c834ea9-eda1-2090-347f-face7e1c290f</StudentContactPersonalRefId> <StudentContactPersonalLocalId>P1234567</StudentContactPersonalLocalId> <HasBOTVote>N</HasBOTVote> <PersonInfo> <Name> <FullName>Dr Phillips</FullName> </Name> <Email> <Work> <Address>Phillips@mboroHealth.com</Address> </Work> </Email> <Address> <Physical> <Type>TH</Type> <Line1>Regent St.</Line1> <City>Martinborough</City> <PostalCode>5741</PostalCode> </Physical> </Address> <Phone> <Work> <Number>(021) 300 999</Number> </Work> </Phone> </PersonInfo> <HealthcareServiceInfo> <OrganisationName>Martinborough Medical Centre</OrganisationName> <OrganisationPhoneNum>06 306 9311</OrganisationPhoneNum> <Notes>Dr Amy also knows about the epilepsy</Notes> <Type>DOC</Type> </HealthcareServiceInfo> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentContactPersonal>
Example 3.2.27-2: StudentContactPersonal Doctor Example

### 3.2.28 StudentContactRelationship

A relationship between a person who is part of a Student's whānau and that Student. Relationship properties include the relationship type and roles played by the student contact in respect of the student.

Individual details about the student and student contact are provided in other data objects - StudentPersonal and StudentContactPersonal respectively.

SIF_Events are reported for this object.

Figure 3.2.28-1: StudentContactRelationship

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentContactRelationship |  | High | A relationship between a person who is part of a Student's whānau and that Student. Relationship properties include the relationship type and roles played by the student contact in respect of the student. Individual details about the student and student contact are provided in other data objects - StudentPersonal and StudentContactPersonal respectively. |
| StudentContactRelationshipRefId | O | Medium | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentContactRelationshipLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Status | O | High | States whether or not this is an inactive or active Student Contact Relationship. | NZCodeSetsStudentContactRelationshipStatusType
| StartDate | M | Low | The date the relationship between the student and contact was recorded. | xs:date
| EndDate | O | Low | The date the relationship between the student and contact was removed. | xs:date
| Student | M | Medium | Generic object reference to the Student. | StudentObjectReferenceType
| StudentContact | M | Medium | Generic object reference to the student contact. | ObjectReferenceType
| Organisation | M | Low | Generic object reference to the Organisation associated with the relationship. | OrganisationObjectReferenceType
| Relationship | M | Medium | Defines the relationship of the contact to the student. | RelationshipType
| LanguageUsed | O | Low | The language the student and their contact use to communicate. | NZCodeSetsLanguageType
| HouseholdList | O | Medium | A list of one or more household identifiers indicating the households associated with this relationship. | HouseholdListType
| ContactFlags | C | High | Contains characteristics of the contact person's role with the Student. At least one of the flags must be populated with a 'Yes' value. | ContactFlagsType
| ContactSequence | O | Low | Number indicating the order in which the student contact should be contacted. | xs:unsignedInt
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.28-1: StudentContactRelationship
JSON
{ "StudentContactRelationship": { "StudentContactRelationshipRefId": "7572b261-0947-583a-463d-bb345291b332", "StartDate": "2020-06-23", "Student": { "RefId": "dee34b35-9d75-101a-8c3d-00aa001a1652" }, "StudentContact": { "RefId": "6472b261-0947-583a-463d-bb345291b001" }, "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "Relationship": { "Code": "LEG" }, "HouseholdList": { "HouseholdId": [ "FamilyA", "FamilyB" ] }, "ContactFlags": { "ParentLegalGuardian": "Y", "LivesWith": "N", "AccessToRecords": "N", "ReceivesAssessmentReport": "Y", "EmergencyContact": "Y", "CivilDefenceEmergencyContact": "N", "DisciplinaryContact": "N", "AttendanceContact": "N", "PrimaryCareProvider": "N", "FeesBilling": "Y", "FamilyMail": "Y", "CourtOrder": "N" }, "ContactSequence": 1, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentContactRelationship> <StudentContactRelationshipRefId>7572b261-0947-583a-463d-bb345291b332</StudentContactRelationshipRefId> <StartDate>2020-06-23</StartDate> <Student> <RefId>dee34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <StudentContact> <RefId>6472b261-0947-583a-463d-bb345291b001</RefId> </StudentContact> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <Relationship> <Code>LEG</Code> </Relationship> <HouseholdList> <HouseholdId>FamilyA</HouseholdId> <HouseholdId>FamilyB</HouseholdId> </HouseholdList> <ContactFlags> <ParentLegalGuardian>Y</ParentLegalGuardian> <LivesWith>N</LivesWith> <AccessToRecords>N</AccessToRecords> <ReceivesAssessmentReport>Y</ReceivesAssessmentReport> <EmergencyContact>Y</EmergencyContact> <CivilDefenceEmergencyContact>N</CivilDefenceEmergencyContact> <DisciplinaryContact>N</DisciplinaryContact> <AttendanceContact>N</AttendanceContact> <PrimaryCareProvider>N</PrimaryCareProvider> <FeesBilling>Y</FeesBilling> <FamilyMail>Y</FamilyMail> <CourtOrder>N</CourtOrder> </ContactFlags> <ContactSequence>1</ContactSequence> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentContactRelationship>
Example 3.2.28-1: StudentContactRelationship

### 3.2.29 StudentCurriculumProgressReport

A single curriculum progress and achievement report provided for a student. Used in technology centres allowing the host provider to report on student progress to their base school.

May be extended in the future to cover reporting on other curriculum areas.

SIF_Events are reported for this object.

Figure 3.2.29-1: StudentCurriculumProgressReport

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentCurriculumProgressReport |  | Low | A single curriculum progress and achievement report provided for a student. Used in technology centres allowing the host provider to report on student progress to their base school. May be extended in the future to cover reporting on other curriculum areas. |
| StudentCurriculumProgressReportRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentCurriculumProgressReportLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | Low | Generic object reference to the student whose progress is being reported. | StudentObjectReferenceType
| Organisation | M | Low | Generic object reference to the Provider (school) who is making this curriculum progress report. | OrganisationObjectReferenceType
| TeachingGroup | M | Low | Generic object reference to the TeachingGroup the student is enrolled in for which the progress report is being made. | ObjectReferenceType
| AuthorList | O | Low | A list of StaffMembers who are the authors of the curriculum progress report | ProgressReportAuthorList
| RepositoryReceivedDate | O | Low | The date the repository received the students technology centre progress and achievement report. | xs:date
| TimeFrame | O |  | The timeframe of the provided information e.g. Routine Update, Mid-Year, End of Year etc. | NZCodeSetsCurriculumProgressReportTimeframeType
| TechnologyClassList | O | Low | A list of records of the Student's progress in particular classes from the Technology curriculum. e.g. Hard Materials, Food Technology, Digital Design etc. | TechnologyClassList
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.29-1: StudentCurriculumProgressReport
JSON
{ "StudentCurriculumProgressReport": { "StudentCurriculumProgressReportRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "ca285746-359d-7510-1a8c-36432a901a16" }, "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "TeachingGroup": { "RefId": "4f6dce25-cca6-49ef-8be4-675e2cfce8b8", "LocalId": "HM8P", "Name": "Year 8 Hard Materials, Pinehurst School" }, "AuthorList": { "Author": [ { "RefId": "1b6fabed-2af9-4395-b48c-f46c8edb1b78", "LocalId": "SMcG", "Name": "Steve McGannaway" } ] }, "TimeFrame": "TRM", "TechnologyClassList": { "TechnologyClass": [ { "Class": "HM", "BehaviourComment": "Excellent", "EffortComment": "Not particularly interested, attention wanders", "StrandList": { "Strand": [ { "LearningStrand": "TP", "AchievementObjectiveList": { "AchievementObjective": [ { "AchievementObjective": "BD", "CurriculumLevel": 2, "ProgressLevel": "B", "AchievementObjectiveDesc": "Brief Development in hard materials", "OverallStudentEffortNote": "Not particularly interested, attention wanders", "PracticalAbilityDesc": "Beginner", "PracticalAbilityProgressNote": "Struggles with the planning required" } ] } } ] } } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentCurriculumProgressReport> <StudentCurriculumProgressReportRefId>2ffb63b4-cfef-4820-8501-e7d1e54555cb</StudentCurriculumProgressReportRefId> <Student> <RefId>ca285746-359d-7510-1a8c-36432a901a16</RefId> </Student> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <TeachingGroup> <RefId>4f6dce25-cca6-49ef-8be4-675e2cfce8b8</RefId> <LocalId>HM8P</LocalId> <Name>Year 8 Hard Materials, Pinehurst School</Name> </TeachingGroup> <AuthorList> <Author> <RefId>1b6fabed-2af9-4395-b48c-f46c8edb1b78</RefId> <LocalId>SMcG</LocalId> <Name>Steve McGannaway</Name> </Author> </AuthorList> <TimeFrame>TRM</TimeFrame> <TechnologyClassList> <TechnologyClass> <Class>HM</Class> <BehaviourComment>Excellent</BehaviourComment> <EffortComment>Not particularly interested, attention wanders</EffortComment> <StrandList> <Strand> <LearningStrand>TP</LearningStrand> <AchievementObjectiveList> <AchievementObjective> <AchievementObjective>BD</AchievementObjective> <CurriculumLevel>2</CurriculumLevel> <ProgressLevel>B</ProgressLevel> <AchievementObjectiveDesc>Brief Development in hard materials</AchievementObjectiveDesc> <OverallStudentEffortNote>Not particularly interested, attention wanders</OverallStudentEffortNote> <PracticalAbilityDesc>Beginner</PracticalAbilityDesc> <PracticalAbilityProgressNote>Struggles with the planning required</PracticalAbilityProgressNote> </AchievementObjective> </AchievementObjectiveList> </Strand> </StrandList> </TechnologyClass> </TechnologyClassList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentCurriculumProgressReport>
Example 3.2.29-1: Student Curriculum Progress Report

### 3.2.30 StudentLearningSupport

Provides information about a student's learning support.

SIF_Events are reported for this object.

Figure 3.2.30-1: StudentLearningSupport

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentLearningSupport |  | Low | Provides information about a student's learning support. |
| StudentLearningSupportRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentLearningSupportLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | Low | Reference to the student the learning support record is for. | StudentObjectReferenceType
| Organisation | M | Low | Reference to the Provider that created the learning support record for the student. | OrganisationObjectReferenceType
| LearnerStatus | M | Low | The learners learning support status, e.g. are they currently being managed or not. | NZCodeSetsLearningSupportLearnerStatus
| LearnerArchivedDate | O | Low | The date the learner's learning support status was changed from Active to Archived. | xs:date
| StudentConsentList | M | Low | A list of the consents the student has provided / not provided in regards to learning support, e.g. Cluster Sharing COnsent, Recieve Service Consent. | StudentConsentListType
| DyslexiaScreeningTool | O | Low | Indicates whether or the student has been assessed using dyslexia screening tools. | NZCodeSetsYesOrNoCategoryType
| OtherScreening | O | Low | Indicates whether or not the student has under gone any other type of screening. | NZCodeSetsYesOrNoCategoryType
| OtherScreeningDetail | O | Low | Free text describing any other type of screening the student has undergone. Mandatory if 'OtherScreening' = 'Y'. | xs:normalizedString
| AdolescentHealthScreening | O | Low | Indicates whether or not the student has undergone an adolescent health screening, e.g. NZ Aotearoa Adolescent Health and development (NZAAHD) assessment, HEEADDSS (Home, Education/employment, Eating, Activities, Drugs and Alcohol, Sexuality, Suicide/depression, Safety). | NZCodeSetsYesOrNoCategoryType
| NonAttendance | O | Low | Indicates whether or not the student has not been attending the education provider they are enrolled at. | NZCodeSetsYesOrNoCategoryType
| NewToNewZealand | O | Low | Indicates whether or not the student is new to New Zealand. | NZCodeSetsYesOrNoCategoryType
| NumberOfSchoolChanges | O | Low | Indicates whether or not the student has changed education providers reasonably frequently. | NZCodeSetsYesOrNoCategoryType
| B4SchoolCheck | O | Low | Indicates whether or not the student has undergone a B4 School Check. | NZCodeSetsYesOrNoCategoryType
| OtherFamilyContext | O | Low | Indicates whether or not there is other family context that pertains to the student and their needs. | NZCodeSetsYesOrNoCategoryType
| OtherFamilyContextDetail | O | Low | Additional free text detail about any family context that pertains to the student and their needs. Mandatory if OtherStudentContext = 'Y'. | xs:normalizedString
| StudentVoiceList | O | Low | A list of the student's or their whānau's voice about their learning support in regards to the student 's interests, goals, and voice (comments, opinions). | StudentVoiceList
| SupportNeedList | O | Low | A list of learning support needs that have been identified for the student. | SupportNeedListType
| LearnerInterests | O | Low | Free text that describes the interests a learner has that pertains to this wellbeing Characteristic. | xs:normalizedString
| LearnerWhanauGoal | O | Low | Free text describing any goals the student wants to achieve, or any goals their whānau want them to achieve that pertain to this wellbeing characteristic. | xs:normalizedString
| LearnerWhanauVoice | O | Low | Free text capturing the learners and/or their whānaus opinions and point of view in regards to this wellbeing characteristic. | xs:normalizedString
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.30-1: StudentLearningSupport
JSON
{ "StudentLearningSupport": { "StudentLearningSupportRefId": "461b63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "ca285746-359d-7510-1a8c-36432a901a16" }, "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "LearnerStatus": "ACT", "StudentConsentList": { "StudentConsent": [ { "RefId": "461423b4-cfef-4820-8501-e7d1e54555cb" } ] }, "DyslexiaScreeningTool": "Y", "OtherScreening": "N", "AdolescentHealthScreening": "N", "NonAttendance": "Y", "NewToNewZealand": "N", "NumberOfSchoolChanges": "Y", "B4SchoolCheck": "Y", "OtherFamilyContext": "N", "StudentVoiceList": { "StudentVoice": [ { "RefId": "461423b4-cfef-4820-8345-e7d1e54555cb" }, { "RefId": "461423b4-bbef-4820-8345-e7d1e54555cb" } ] }, "SupportNeedList": { "SupportNeed": [ { "Need": { "RefId": "461423b4-bbef-4820-8345-e724e54555cb", "Name": "Literacy" }, "ResponseList": { "Response": [ { "RefId": "461423b4-bbef-4820-8345-e724e5455bbb" } ] } } ] } } }
XML
<StudentLearningSupport> <StudentLearningSupportRefId>461b63b4-cfef-4820-8501-e7d1e54555cb</StudentLearningSupportRefId> <Student> <RefId>ca285746-359d-7510-1a8c-36432a901a16</RefId> </Student> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <LearnerStatus>ACT</LearnerStatus> <StudentConsentList> <StudentConsent> <RefId>461423b4-cfef-4820-8501-e7d1e54555cb</RefId> </StudentConsent> </StudentConsentList> <DyslexiaScreeningTool>Y</DyslexiaScreeningTool> <OtherScreening>N</OtherScreening> <AdolescentHealthScreening>N</AdolescentHealthScreening> <NonAttendance>Y</NonAttendance> <NewToNewZealand>N</NewToNewZealand> <NumberOfSchoolChanges>Y</NumberOfSchoolChanges> <B4SchoolCheck>Y</B4SchoolCheck> <OtherFamilyContext>N</OtherFamilyContext> <StudentVoiceList> <StudentVoice> <RefId>461423b4-cfef-4820-8345-e7d1e54555cb</RefId> </StudentVoice> <StudentVoice> <RefId>461423b4-bbef-4820-8345-e7d1e54555cb</RefId> </StudentVoice> </StudentVoiceList> <SupportNeedList> <SupportNeed> <Need> <RefId>461423b4-bbef-4820-8345-e724e54555cb</RefId> <Name>Literacy</Name> </Need> <ResponseList> <Response> <RefId>461423b4-bbef-4820-8345-e724e5455bbb</RefId> </Response> </ResponseList> </SupportNeed> </SupportNeedList> </StudentLearningSupport>
Example 3.2.30-1: StudentLearningSupport

### 3.2.31 StudentLearningSupportResponse

Provides information about a response provided for a students learning support need.

SIF_Events are reported for this object.

Figure 3.2.31-1: StudentLearningSupportResponse

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentLearningSupportResponse |  | Low | Provides information about a response provided for a students learning support need. |
| StudentLearningSupportResponseRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentLearningSupportResponseLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | Low | The student that the learning support need response its for. | StudentObjectReferenceType
| Organisation | M | Low | The provider that created this learning support need reponse. | OrganisationObjectReferenceType
| LearningSupportNeed | M | Low | The learning support need the reponse is for. | ObjectReferenceType
| ResponseType | M | Low | The type of response provided to the student to support the need. | NZCodeSetsLearningSupportResponseTypeType
| ResponseDetail | O | Low | Code set denoting the additional detail about the response type provided to the student to support the need. | NZCodeSetsLearningSupportResponseDetailType
| ReviewDate | M | Low | The date the response is due to be reviewed. | xs:date
| ResponseGoals | O | Low | The goals of the response in relation to the student's learning support need. | xs:normalizedString
| ResponseNote | O | Low | Free text notes about the response. | xs:normalizedString
| NoteList | O | High | A list of notes that have been written about the learning support response. | NoteListType
| ResponseDesc | O | Low | Free text description about the response type and detail. Mandatory when a response detail of 'Other' is selected. | xs:normalizedString
| TierOfResponse | O | Low | The tier of response for the learning support need response. | NZCodeSetsLearningSupportResponseTierType
| ExternalResponse | C | Low | Additional information for an external response. | SupportNeedExternalResponseType
| InternalResponse | C | Low | Additional information for an internal response. | SupportNeedInternalResponseType
| ReviewList | O | Low | A list of the reviews made about the response. | SupportNeedResponseReviewListType
| AttachmentList | O | Low | A list of attachments associated to the learning support need response. | DocumentListType
| CompletionDate | O | Low | The date the response was completed. | xs:date
| Outcome | O | Low | The outcome of the response. | NZCodeSetsLearningSupportResponseOutcomeType
| OutcomeComment | O | Low | Free text comment about the outcome of the response made for the students learning support need. | xs:normalizedString
| ClosureStatus | O | Low | The status of the learning support need response when it is closed. | NZCodeSetsLearningSupportResponseClosureStatusType
| ClosureStatusDetail | O | Low | Additional detail about the responses closure status. | xs:normalizedString
| CompletionNote | O | Low | Free text notes about the completion of the response to the students learning support need. | xs:normalizedString
| RecordAudit | M | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.31-1: StudentLearningSupportResponse
JSON
{ "StudentLearningSupportResponse": { "StudentLearningSupportResponseRefId": "461b63b4-cfef-4820-8501-e7dbbb4555cb", "Student": { "RefId": "8631e737-c9db-4e6c-804d-a78c65f98f67" }, "LearningSupportNeed": { "RefId": "ca222226-359d-7510-1a8c-36432a901a16" }, "ResponseType": "ADA", "ResponseDetail": "ACU", "ResponseGoals": "The student is confident in their reading ability.", "TierOfResponse": "IND", "InternalResponse": { "ProvidedBy": "TEA", "ProvidedByName": "Jane Doe", "Status": "MON", "FundedBy": "BOA" }, "ReviewList": { "Review": [ { "Reviewer": { "RefId": "ca2bbb26-359d-2480-1a8c-36432a901a16" }, "ReviewDate": "2019-11-11", "ReviewComments": "The student is progressing well. Ability to identify words is increasing and is gaining confidence in trying to sound out words they do not recognise.", "NextReviewDate": "2010-01-21" } ] }, "AttachmentList": { "Document": [ { "RefId": "ca2bbb26-359d-3480-1a8c-36432a901a16" } ] }, "RecordAudit": { "CreatedDateTime": "2019-10-28T06:30:57", "CreatedBy": { "RefId": "ca222226-359d-2480-1a8c-36432a901a16" } } } }
XML
<StudentLearningSupportResponse> <StudentLearningSupportResponseRefId>461b63b4-cfef-4820-8501-e7dbbb4555cb</StudentLearningSupportResponseRefId> <Student> <RefId>8631e737-c9db-4e6c-804d-a78c65f98f67</RefId> </Student> <LearningSupportNeed> <RefId>ca222226-359d-7510-1a8c-36432a901a16</RefId> </LearningSupportNeed> <ResponseType>ADA</ResponseType> <ResponseDetail>ACU</ResponseDetail> <ResponseGoals>The student is confident in their reading ability.</ResponseGoals> <TierOfResponse>IND</TierOfResponse> <InternalResponse> <ProvidedBy>TEA</ProvidedBy> <ProvidedByName>Jane Doe</ProvidedByName> <Status>MON</Status> <FundedBy>BOA</FundedBy> </InternalResponse> <ReviewList> <Review> <Reviewer> <RefId>ca2bbb26-359d-2480-1a8c-36432a901a16</RefId> </Reviewer> <ReviewDate>2019-11-11</ReviewDate> <ReviewComments>The student is progressing well. Ability to identify words is increasing and is gaining confidence in trying to sound out words they do not recognise.</ReviewComments> <NextReviewDate>2010-01-21</NextReviewDate> </Review> </ReviewList> <AttachmentList> <Document> <RefId>ca2bbb26-359d-3480-1a8c-36432a901a16</RefId> </Document> </AttachmentList> <RecordAudit> <CreatedDateTime>2019-10-28T06:30:57</CreatedDateTime> <CreatedBy> <RefId>ca222226-359d-2480-1a8c-36432a901a16</RefId> </CreatedBy> </RecordAudit> </StudentLearningSupportResponse>
Example 3.2.31-1: StudentLearningSupportResponse - External Response

### 3.2.32 StudentPersonal

Contains all the personal information related to the student.

SIF_Events are reported for this object.

Figure 3.2.32-1: StudentPersonal

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentPersonal |  | Extreme | Contains all the personal information related to the student. |
| StudentPersonalRefId | O | Medium | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentPersonalLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. This identifier may be set for each student independently for each provider. Each identifier is only available to be retrieved or maintained by the provider that created it. | LocalIdType
| NationalStudentNumber | M | Medium | The unique identifier allocated to every student in New Zealand, also known as the NSN. | NSNType
| NZQAStudentId | O | Medium | NZQA's unique identifier for a student who has been registered for assessments to be conducted against the NZQA framework to achieve unit/achievement standards and national qualifications. | xs:normalizedString
| FirstNZSchoolingDate | O | Low | The date a student first ever started schooling in New Zealand. This field is used to establish most students’ Funding Year Level. | xs:date
| EarlyChildhoodEducation | O | High | The type of early childhood education the student received before enrolling in their first school. | EarlyChildhoodEducationType
| PersonInfo | M | High | Personal Information | StudentPersonInfoType
| BiographicChangeReason | O | High | The reason that the persons biographic data was changed. | NZCodeSetsBiographicChangeReasonType
| CustodyNote | O | High | Notes about a students care and custody status. | xs:normalizedString
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.32-1: StudentPersonal
JSON
{ "StudentPersonal": { "StudentPersonalRefId": "7c834ea9-eda1-2090-347f-83297e1c290c", "StudentPersonalLocalId": "S1234567", "NationalStudentNumber": "2234523", "FirstNZSchoolingDate": "1996-05-04", "PersonInfo": { "Name": { "FamilyName": "Hagrid", "GivenName": "Rubeus", "FullName": "Rubeus Hagrid", "Type": "LGL", "IsVerified": "N" }, "Email": { "Personal": { "Address": "hagrid@gmail.com" } }, "OtherNameList": { "Name": [ { "FamilyName": "Anderson", "GivenName": "Samuel", "FullName": "Samuel Anderson", "Type": "AKA", "IsVerified": "Y", "Verification": { "Source": "NZPAS", "DocumentSerialNumber": "L905673", "DocumentExpiryDate": "2019-03-30", "IsConfirmed": true, "Timestamp": "2003-11-30T12:34:56.7", "Provider": { "RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba" } } }, { "FamilyName": "Rowinski", "GivenName": "Sam", "FullName": "Sam Rowinski ", "Type": "PRF", "IsVerified": "N" } ] }, "Demographics": { "BirthDate": "1990-09-26", "PlaceOfBirth": "Dunedin", "CountryOfBirth": "ZAF", "CitizenshipList": { "Country": [ "NZL", "ZAF" ] }, "CitizenshipStatus": "NZCI", "CitizenshipVerification": { "Source": "NZPAS", "DocumentSerialNumber": "L905673", "DocumentExpiryDate": "2019-03-30", "IsConfirmed": true, "Timestamp": "2003-11-30T12:34:56.7", "Provider": { "RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba" } }, "Gender": 2, "LanguageList": { "Language": [ { "Code": "NZS01110", "Usage": "FL", "ProficiencyList": { "Proficiency": [ { "Level": "AD", "Type": "SP" } ] } }, { "Code": "NZS01112", "Usage": "SL", "ProficiencyList": { "Proficiency": [ { "Level": "BE", "Type": "SP" } ] } } ] }, "EthnicityList": { "Ethnicity": [ { "PreferenceOrderNumber": 1, "Code": 111 }, { "PreferenceOrderNumber": 1, "Code": 211 } ] }, "IwiAffiliationList": { "Iwi": [ { "Code": "NZS1001", "PreferenceOrderNumber": 1, "HapuAffiliationList": { "Hapu": [ { "HapuName": "Manukorihi", "PreferenceOrderNumber": 1 } ] } } ] }, "ReligiousAffiliationList": { "ReligiousAffiliation": [ "NZS212", "NZS215" ] } }, "Address": { "Physical": { "Type": "TH", "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way", "City": "Hogsmead", "PostalCode": "7733" }, "Postal": { "Type": "RU", "Line1": "1175 Lake Ferry Rd", "Suburb": "RD 1", "City": "Martinborough" } }, "Phone": { "Mobile": { "Number": "(021) 300 999" } }, "HouseholdContactInfoList": { "HouseholdContactInfo": [ { "PreferenceNumber": 1, "HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e", "Address": { "Postal": { "Type": "DE", "Line1": "P O Box 81", "City": "Martinborough", "PostalCode": "5781" } }, "Email": { "Work": { "Address": "hagrid@hogwarts.com" } }, "Phone": { "Home": { "Number": "(03) 300 999" } } } ] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentPersonal> <StudentPersonalRefId>7c834ea9-eda1-2090-347f-83297e1c290c</StudentPersonalRefId> <StudentPersonalLocalId>S1234567</StudentPersonalLocalId> <NationalStudentNumber>2234523</NationalStudentNumber> <FirstNZSchoolingDate>1996-05-04</FirstNZSchoolingDate> <PersonInfo> <Name> <FamilyName>Hagrid</FamilyName> <GivenName>Rubeus</GivenName> <FullName>Rubeus Hagrid</FullName> <Type>LGL</Type> <IsVerified>N</IsVerified> </Name> <Email> <Personal> <Address>hagrid@gmail.com</Address> </Personal> </Email> <OtherNameList> <Name> <FamilyName>Anderson</FamilyName> <GivenName>Samuel</GivenName> <FullName>Samuel Anderson</FullName> <Type>AKA</Type> <IsVerified>Y</IsVerified> <Verification> <Source>NZPAS</Source> <DocumentSerialNumber>L905673</DocumentSerialNumber> <DocumentExpiryDate>2019-03-30</DocumentExpiryDate> <IsConfirmed>true</IsConfirmed> <Timestamp>2003-11-30T12:34:56.7</Timestamp> <Provider> <RefId>822f6c83-2841-4a87-9ff9-49730951b3ba</RefId> </Provider> </Verification> </Name> <Name> <FamilyName>Rowinski</FamilyName> <GivenName>Sam</GivenName> <FullName>Sam Rowinski </FullName> <Type>PRF</Type> <IsVerified>N</IsVerified> </Name> </OtherNameList> <Demographics> <BirthDate>1990-09-26</BirthDate> <PlaceOfBirth>Dunedin</PlaceOfBirth> <CountryOfBirth>ZAF</CountryOfBirth> <CitizenshipList> <Country>NZL</Country> <Country>ZAF</Country> </CitizenshipList> <CitizenshipStatus>NZCI</CitizenshipStatus> <CitizenshipVerification> <Source>NZPAS</Source> <DocumentSerialNumber>L905673</DocumentSerialNumber> <DocumentExpiryDate>2019-03-30</DocumentExpiryDate> <IsConfirmed>true</IsConfirmed> <Timestamp>2003-11-30T12:34:56.7</Timestamp> <Provider> <RefId>822f6c83-2841-4a87-9ff9-49730951b3ba</RefId> </Provider> </CitizenshipVerification> <Gender>2</Gender> <LanguageList> <Language> <Code>NZS01110</Code> <Usage>FL</Usage> <ProficiencyList> <Proficiency> <Level>AD</Level> <Type>SP</Type> </Proficiency> </ProficiencyList> </Language> <Language> <Code>NZS01112</Code> <Usage>SL</Usage> <ProficiencyList> <Proficiency> <Level>BE</Level> <Type>SP</Type> </Proficiency> </ProficiencyList> </Language> </LanguageList> <EthnicityList> <Ethnicity> <PreferenceOrderNumber>1</PreferenceOrderNumber> <Code>111</Code> </Ethnicity> <Ethnicity> <PreferenceOrderNumber>1</PreferenceOrderNumber> <Code>211</Code> </Ethnicity> </EthnicityList> <IwiAffiliationList> <Iwi> <Code>NZS1001</Code> <PreferenceOrderNumber>1</PreferenceOrderNumber> <HapuAffiliationList> <Hapu> <HapuName>Manukorihi</HapuName> <PreferenceOrderNumber>1</PreferenceOrderNumber> </Hapu> </HapuAffiliationList> </Iwi> </IwiAffiliationList> <ReligiousAffiliationList> <ReligiousAffiliation>NZS212</ReligiousAffiliation> <ReligiousAffiliation>NZS215</ReligiousAffiliation> </ReligiousAffiliationList> </Demographics> <Address> <Physical> <Type>TH</Type> <Line1>The Enchanted Wood</Line1> <Line2>533 Hogwart's Way</Line2> <City>Hogsmead</City> <PostalCode>7733</PostalCode> </Physical> <Postal> <Type>RU</Type> <Line1>1175 Lake Ferry Rd</Line1> <Suburb>RD 1</Suburb> <City>Martinborough</City> </Postal> </Address> <Phone> <Mobile> <Number>(021) 300 999</Number> </Mobile> </Phone> <HouseholdContactInfoList> <HouseholdContactInfo> <PreferenceNumber>1</PreferenceNumber> <HouseholdContactId>7d5c3f5c-d89c-4551-9442-6b008207986e</HouseholdContactId> <Address> <Postal> <Type>DE</Type> <Line1>P O Box 81</Line1> <City>Martinborough</City> <PostalCode>5781</PostalCode> </Postal> </Address> <Email> <Work> <Address>hagrid@hogwarts.com</Address> </Work> </Email> <Phone> <Home> <Number>(03) 300 999</Number> </Home> </Phone> </HouseholdContactInfo> </HouseholdContactInfoList> </PersonInfo> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentPersonal>
Example 3.2.32-1: StudentPersonal Example

### 3.2.33 StudentPhysicalRestraint

Provides information about an incident where staff members or other parties used physical restraint on a child.

SIF_Events are reported for this object.

Figure 3.2.33-1: StudentPhysicalRestraint

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentPhysicalRestraint |  | Low | Provides information about an incident where staff members or other parties used physical restraint on a child. |
| StudentPhysicalRestraintRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentPhysicalRestraintLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Provider | M | Low | Generic object reference to the provider under whose supervision the student was, at the time the physical restraint incient occured. | OrganisationObjectReferenceType
| Student | M | Low | Generic object refernece to the student to whom the physical restraint was applied. | StudentObjectReferenceType
| PrincipalOrDelegate | O | Low | Generic object reference to the StaffPersonal object of the Principal or their delegate who oversaw the recording of the physical restraint incident. | ObjectReferenceType
| WellbeingEvent | O | Low | Generic object reference to the Wellbeing Event created for the student the physical reatrint was used on. | ObjectReferenceType
| ConsideredNecessaryReason | O | Low | Free text description on why the physical restraint of the student was considered necessary. | xs:normalizedString
| FirstTimeStudentRestrained | O | Low | Indicates whether or not this was the first time the student was restrained. | NZCodeSetsYesOrNoCategoryType
| IncidentDate | O | Low | The date the physical restraint was used on the student. | xs:date
| LocationDescription | O | Low | Free text description of the location the physical restraint of the student occurred in. | xs:normalizedString
| OtherComment | O | Low | Any other comments on the physical restraint incident. | xs:normalizedString
| ReportedDate | O | Low | The date the use of physical restraint on the student was report. | xs:date
| RestraintEndedTime | O | Low | The time the physical restraint stopped being used. | xs:time
| RestraintStartedTime | O | Low | The time the physical restraint started being used. | xs:time
| RestraintReason | O | Low | The reason the physical restraint was applied to the child. | NZCodeSetsRestraintReasonType
| DocumentList | O | Low | Describes the Location of any associated documents kept in relation to this physical restraint incident. | DocumentListType
| RestraintWitnessList | O | Low | A list of the people that witnessed the physical constraint. | RestraintWitnessListType
| RestraintAdministeredByList | O | Low | A list of the people who administered the physical restraint to the student. | RestraintAdministeredByListType
| BehaviourDirectedAtList | O | Low | The list of the people and/or property that the student, who was restrained, was directing their behaviour at. | BehaviourDirectedAtListType
| StaffReflectionList | O | Low | A list of the reflections made by the staff members who applied the physical restraint. | StaffReflectionListType
| RestraintDebriefingList | O | Low | A list of the debriefings that took place after the physical restraint incident occurred. | RestraintDebriefingListType
| RestraintQuestionList | O | Low | A list of questions and their answers about the physical restraint incident. | RestraintQuestionListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.33-1: StudentPhysicalRestraint

### 3.2.34 StudentProviderEnrolment

A student's association with an education provider for the purpose of receiving educational servics.

Provider enrolments span multiple years with the ProviderEnrolment containing one or more ECE, School or Tertiary Enrolment sub-objects for each particular year.

SIF_Events are reported for this object.

Figure 3.2.34-1: StudentProviderEnrolment

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentProviderEnrolment |  | High | A student's association with an education provider for the purpose of receiving educational servics. Provider enrolments span multiple years with the ProviderEnrolment containing one or more ECE, School or Tertiary Enrolment sub-objects for each particular year. |
| StudentProviderEnrolmentRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentProviderEnrolmentLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | Low | Generic object reference to the Student enrolling at the Provider | StudentObjectReferenceType
| Provider | M | Low | Generic object reference to the education Provider, eg school. | OrganisationObjectReferenceType
| StudentId | M | High | A unique identifier assigned to a Student for a period of enrolment by a provider. | xs:normalizedString
| EntryDate | M | Low | The date from when this enrolment is ACTIVE. The date of the student’s first attendance at the provider. If future dated, then the intended first attendance date of the enrolment. | xs:date
| ExitDate | O | Low | The date of a student’s last attendance at the provider. | xs:date
| Status | O | High | The status of the enrolment WiP | NZCodeSetsProviderEnrolmentStatusType
| Exit | O | High | Details of the reasons, and interventions leading up to the student's enrolment being terminated. | ProviderExitType
| ECEEducationHistoryList | O | High | The list of the types of early childhood education the parent told a primary school that the student received and the hours per week and/or day the student attended. | ECEEducationHistoryList
| EarlyChildhoodEnrolment | O | High | Properties of an enrolment in an early childhood service (WiP). | StudentECEEnrolmentType
| SchoolEnrolmentList | O | High | Properties of an enrolment in a school | StudentSchoolEnrolmentListType
| TertiaryEducationEnrolment | O | High | Properties of an enrolment in a Tertiary Education service (WiP). | StudentTertiaryEnrolmentType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.34-1: StudentProviderEnrolment
JSON
{ "StudentProviderEnrolment": { "StudentProviderEnrolmentRefId": "a8c3d3e3-4b35-9d75-101d-00aa001a1652", "StudentProviderEnrolmentLocalId": "2004H102", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "StudentId": "123ABC", "EntryDate": "2018-01-29", "Status": "WIT", "SchoolEnrolmentList": { "SchoolEnrolment": [ { "SchoolEnrolmentRefId": "38949b5e-f44c-4fb1-8587-8f63f88a8e0f", "SchoolEnrolmentLocalId": "2018-11-HPotter", "SchoolCalendarYear": 2018, "MembershipType": "BASE", "YearLevel": "11", "EligibilityCriteria": "GAE", "EligibilityVerification": { "Source": "AUSPA", "DocumentSerialNumber": "L905673", "DocumentExpiryDate": "2019-03-30", "IsConfirmed": true, "Timestamp": "2003-11-30T12:34:56.7", "Provider": { "RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba" } }, "FTE": 1.0, "FundingType": "EX", "FundingYearLevel": "1", "Curriculum": "NZC", "CurriculumLevel": 5, "InternationalEnrolment": { "NZArrivalDate": "2018-05-02", "ExchangeScheme": "STA" } } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentProviderEnrolment> <StudentProviderEnrolmentRefId>a8c3d3e3-4b35-9d75-101d-00aa001a1652</StudentProviderEnrolmentRefId> <StudentProviderEnrolmentLocalId>2004H102</StudentProviderEnrolmentLocalId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <Provider> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Provider> <StudentId>123ABC</StudentId> <EntryDate>2018-01-29</EntryDate> <Status>WIT</Status> <SchoolEnrolmentList> <SchoolEnrolment> <SchoolEnrolmentRefId>38949b5e-f44c-4fb1-8587-8f63f88a8e0f</SchoolEnrolmentRefId> <SchoolEnrolmentLocalId>2018-11-HPotter</SchoolEnrolmentLocalId> <SchoolCalendarYear>2018</SchoolCalendarYear> <MembershipType>BASE</MembershipType> <YearLevel>11</YearLevel> <EligibilityCriteria>GAE</EligibilityCriteria> <EligibilityVerification> <Source>AUSPA</Source> <DocumentSerialNumber>L905673</DocumentSerialNumber> <DocumentExpiryDate>2019-03-30</DocumentExpiryDate> <IsConfirmed>true</IsConfirmed> <Timestamp>2003-11-30T12:34:56.7</Timestamp> <Provider> <RefId>822f6c83-2841-4a87-9ff9-49730951b3ba</RefId> </Provider> </EligibilityVerification> <FTE>1.0</FTE> <FundingType>EX</FundingType> <FundingYearLevel>1</FundingYearLevel> <Curriculum>NZC</Curriculum> <CurriculumLevel>5</CurriculumLevel> <InternationalEnrolment> <NZArrivalDate>2018-05-02</NZArrivalDate> <ExchangeScheme>STA</ExchangeScheme> </InternationalEnrolment> </SchoolEnrolment> </SchoolEnrolmentList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentProviderEnrolment>
Example 3.2.34-1: Completed International Student School Enrolment
JSON
{ "StudentProviderEnrolment": { "StudentProviderEnrolmentRefId": "a8c3d3e3-4b35-9d75-101d-00aa001a1652", "StudentProviderEnrolmentLocalId": "2004H102", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "StudentId": "123ABC", "EntryDate": "2017-01-29", "Status": "ACT", "SchoolEnrolmentList": { "SchoolEnrolment": [ { "SchoolEnrolmentRefId": "38949b5e-3eeb-4fb1-8587-8f63f88a8e0f", "SchoolEnrolmentLocalId": "2017-10-HPotter", "SchoolCalendarYear": 2017, "MembershipType": "BASE", "YearLevel": "10", "EligibilityCriteria": "NZC", "EligibilityVerification": { "Source": "NZBIR", "DocumentSerialNumber": "L905673", "DocumentExpiryDate": "2019-03-30", "IsConfirmed": true, "Timestamp": "2003-11-30T12:34:56.7", "Provider": { "RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba" } }, "FTE": 1.0, "FundingType": "RE", "FundingYearLevel": "10", "Curriculum": "NZC", "CurriculumLevel": 4, "LanguageOfInstructionList": { "Language": [ { "Code": "NZS01112", "Level": "1" } ] }, "SubjectChoiceList": { "StudentSubjectChoice": [ { "PreferenceNumber": 1, "Code": "FREN" }, { "PreferenceNumber": 2, "Code": "HIST" } ] } }, { "SchoolEnrolmentRefId": "38949b5e-f44c-4fb1-8587-8f63f88a8e0f", "SchoolEnrolmentLocalId": "2018-11-HPotter", "SchoolCalendarYear": 2018, "MembershipType": "BASE", "YearLevel": 11, "EligibilityCriteria": "NZC", "EligibilityVerification": { "Source": "NZPAS", "DocumentSerialNumber": "L905673", "DocumentExpiryDate": "2019-03-30", "IsConfirmed": true, "Timestamp": "2003-11-30T12:34:56.7", "Provider": { "RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba" } }, "FTE": 1.0, "FundingType": "RE", "FundingYearLevel": 11, "Curriculum": "NZC", "CurriculumLevel": 5, "LanguageOfInstructionList": { "Language": [ { "Code": "NZS01112", "Level": "5" } ] }, "SubjectChoiceList": { "StudentSubjectChoice": [ { "PreferenceNumber": 1, "Code": "HIST" }, { "PreferenceNumber": 2, "Code": "GEOG" } ] }, "CourseChoiceList": { "StudentCourseChoice": [ { "PreferenceNumber": 1, "Course": { "LocalId": "Y11HIST" } }, { "PreferenceNumber": 2, "Course": { "LocalId": "Y11GEOG" } } ] } } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentProviderEnrolment> <StudentProviderEnrolmentRefId>a8c3d3e3-4b35-9d75-101d-00aa001a1652</StudentProviderEnrolmentRefId> <StudentProviderEnrolmentLocalId>2004H102</StudentProviderEnrolmentLocalId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <Provider> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Provider> <StudentId>123ABC</StudentId> <EntryDate>2017-01-29</EntryDate> <Status>ACT</Status> <SchoolEnrolmentList> <SchoolEnrolment> <SchoolEnrolmentRefId>38949b5e-3eeb-4fb1-8587-8f63f88a8e0f</SchoolEnrolmentRefId> <SchoolEnrolmentLocalId>2017-10-HPotter</SchoolEnrolmentLocalId> <SchoolCalendarYear>2017</SchoolCalendarYear> <MembershipType>BASE</MembershipType> <YearLevel>10</YearLevel> <EligibilityCriteria>NZC</EligibilityCriteria> <EligibilityVerification> <Source>NZBIR</Source> <DocumentSerialNumber>L905673</DocumentSerialNumber> <DocumentExpiryDate>2019-03-30</DocumentExpiryDate> <IsConfirmed>true</IsConfirmed> <Timestamp>2003-11-30T12:34:56.7</Timestamp> <Provider> <RefId>822f6c83-2841-4a87-9ff9-49730951b3ba</RefId> </Provider> </EligibilityVerification> <FTE>1.0</FTE> <FundingType>RE</FundingType> <FundingYearLevel>10</FundingYearLevel> <Curriculum>NZC</Curriculum> <CurriculumLevel>4</CurriculumLevel> <LanguageOfInstructionList> <Language> <Code>NZS01112</Code> <Level>1</Level> </Language> </LanguageOfInstructionList> <SubjectChoiceList> <StudentSubjectChoice> <PreferenceNumber>1</PreferenceNumber> <Code>FREN</Code> </StudentSubjectChoice> <StudentSubjectChoice> <PreferenceNumber>2</PreferenceNumber> <Code>HIST</Code> </StudentSubjectChoice> </SubjectChoiceList> </SchoolEnrolment> <SchoolEnrolment> <SchoolEnrolmentRefId>38949b5e-f44c-4fb1-8587-8f63f88a8e0f</SchoolEnrolmentRefId> <SchoolEnrolmentLocalId>2018-11-HPotter</SchoolEnrolmentLocalId> <SchoolCalendarYear>2018</SchoolCalendarYear> <MembershipType>BASE</MembershipType> <YearLevel>11</YearLevel> <EligibilityCriteria>NZC</EligibilityCriteria> <EligibilityVerification> <Source>NZPAS</Source> <DocumentSerialNumber>L905673</DocumentSerialNumber> <DocumentExpiryDate>2019-03-30</DocumentExpiryDate> <IsConfirmed>true</IsConfirmed> <Timestamp>2003-11-30T12:34:56.7</Timestamp> <Provider> <RefId>822f6c83-2841-4a87-9ff9-49730951b3ba</RefId> </Provider> </EligibilityVerification> <FTE>1.0</FTE> <FundingType>RE</FundingType> <FundingYearLevel>11</FundingYearLevel> <Curriculum>NZC</Curriculum> <CurriculumLevel>5</CurriculumLevel> <LanguageOfInstructionList> <Language> <Code>NZS01112</Code> <Level>5</Level> </Language> </LanguageOfInstructionList> <SubjectChoiceList> <StudentSubjectChoice> <PreferenceNumber>1</PreferenceNumber> <Code>HIST</Code> </StudentSubjectChoice> <StudentSubjectChoice> <PreferenceNumber>2</PreferenceNumber> <Code>GEOG</Code> </StudentSubjectChoice> </SubjectChoiceList> <CourseChoiceList> <StudentCourseChoice> <PreferenceNumber>1</PreferenceNumber> <Course> <LocalId>Y11HIST</LocalId> </Course> </StudentCourseChoice> <StudentCourseChoice> <PreferenceNumber>2</PreferenceNumber> <Course> <LocalId>Y11GEOG</LocalId> </Course> </StudentCourseChoice> </CourseChoiceList> </SchoolEnrolment> </SchoolEnrolmentList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentProviderEnrolment>
Example 3.2.34-2: Multiple Years, Regular Student School Enrolment

### 3.2.35 StudentTeachingGroupEnrolment

Records a student's arrival to and departure from a TeachingGroup.

SIF_Events are reported for this object.

Figure 3.2.35-1: StudentTeachingGroupEnrolment

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentTeachingGroupEnrolment |  | High | Records a student's arrival to and departure from a TeachingGroup. |
| StudentTeachingGroupEnrolmentRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentTeachingGroupEnrolmentLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Status | O | High | States whether or not this is an inactive or active TeachingGroup enrolment. | NZCodeSetsStudentTeachingGroupEnrolmentStatusType
| Student | M | Low | Generic object reference to the Student enrolling in the TeachingGroup | StudentObjectReferenceType
| Organisation | M | Low | Generic object reference to the Organisation, eg school, that has the TeachingGroup | OrganisationObjectReferenceType
| TeachingGroup | M | Low | Generic object reference to the TeachingGroup the student is enroling in. | ObjectReferenceType
| StartDate | M | Low | The date the Student's enrolment in the teaching group starts. | xs:date
| EndDate | O | Low | The date of a student’s enrolment in the teaching group ends. | xs:date
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.35-1: StudentTeachingGroupEnrolment
JSON
{ "StudentTeachingGroupEnrolment": { "StudentTeachingGroupEnrolmentRefId": "a8c3d3e3-4b35-9d75-101d-00aa001a1652", "StudentTeachingGroupEnrolmentLocalId": "2004H102", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "TeachingGroup": { "RefId": "93b9b77e-a23f-4acd-a65e-e26f1034317f" }, "StartDate": "2018-01-29", "EndDate": "2018-12-05", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentTeachingGroupEnrolment> <StudentTeachingGroupEnrolmentRefId>a8c3d3e3-4b35-9d75-101d-00aa001a1652</StudentTeachingGroupEnrolmentRefId> <StudentTeachingGroupEnrolmentLocalId>2004H102</StudentTeachingGroupEnrolmentLocalId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <TeachingGroup> <RefId>93b9b77e-a23f-4acd-a65e-e26f1034317f</RefId> </TeachingGroup> <StartDate>2018-01-29</StartDate> <EndDate>2018-12-05</EndDate> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentTeachingGroupEnrolment>
Example 3.2.35-1: Student TeachingGroup Enrolment

### 3.2.36 StudentVoice

A record of a student's interests as well as their social, academic and academic goals.

SIF_Events are reported for this object.

Figure 3.2.36-1: StudentVoice

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| StudentVoice |  | Medium | A record of a student's interests as well as their social, academic and academic goals. |
| StudentVoiceRefId | O | Medium | The universally unique identifier for the data object record that is used across systems. | RefIdType
| StudentVoiceLocalId | O | Medium | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | Medium | Generic object reference to The GUID for the student's StudentPersonal record. | StudentObjectReferenceType
| Provider | M | Low | Generic object reference to the school that collected this StudentVoice entry. | OrganisationObjectReferenceType
| VoiceType | O | Medium | Code set denoting the type of student voice being heard, e.g. their interests, goals, voice (comments, opinions). | NZCodeSetsStudentVoiceTypeType
| StudentVoiceNote | O | Medium | Extra notes about the student, and their voice | xs:normalizedString
| StudentInterestList | O | Medium | A list of the diffent interests the student has expressed. | StudentInterestListType
| SocialGoalList | O | Medium | A list of the diffent social goals the student has expressed. | SocialGoalListType
| AcademicGoalList | O | Medium | A list of the diffent academic goals the student has expressed. | AcademicGoalListType
| CareerGoalList | O | Medium | A list of the diffent career goals the student has expressed. | CareerGoalListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.36-1: StudentVoice
JSON
{ "StudentVoice": { "StudentVoiceRefId": "7c834ea9-eda1-2090-347f-83297e1c290c", "StudentVoiceLocalId": 2234523, "Student": { "RefId": "5c33548a-1141-40eb-94d3-9267a2258435" }, "Provider": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "StudentVoiceNote": "Timothy doesn't like talking about setting goals. These goals have been gathered through observation.", "StudentInterestList": { "StudentInterest": [ { "InterestRecordedDate": "2018-11-30", "InterestDescription": "Timothy spends most lunchtimes playing with the piano, or watching others playing music", "InterestName": "Music/Piano", "InterestType": "MUS", "SubjectArea": "MUSP" } ] }, "SocialGoalList": { "SocialGoal": [ { "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy would like to have more friends to play with at lunchtime.", "GoalName": "Have more friends" } ] }, "AcademicGoalList": { "AcademicGoal": [ { "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy wants to excel at Te Reo Māori", "GoalName": "Excel Te Reo", "SubjectArea": "MAOR" } ] }, "CareerGoalList": { "CareerGoal": [ { "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy would like to be a Marine Biologist, or Deep Sea Diver", "GoalName": "Marine Biologist" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<StudentVoice> <StudentVoiceRefId>7c834ea9-eda1-2090-347f-83297e1c290c</StudentVoiceRefId> <StudentVoiceLocalId>2234523</StudentVoiceLocalId> <Student> <RefId>5c33548a-1141-40eb-94d3-9267a2258435</RefId> </Student> <Provider> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Provider> <StudentVoiceNote>Timothy doesn't like talking about setting goals. These goals have been gathered through observation.</StudentVoiceNote> <StudentInterestList> <StudentInterest> <InterestRecordedDate>2018-11-30</InterestRecordedDate> <InterestDescription>Timothy spends most lunchtimes playing with the piano, or watching others playing music</InterestDescription> <InterestName>Music/Piano</InterestName> <InterestType>MUS</InterestType> <SubjectArea>MUSP</SubjectArea> </StudentInterest> </StudentInterestList> <SocialGoalList> <SocialGoal> <GoalRecordedDate>2018-11-30</GoalRecordedDate> <GoalDescription>Timothy would like to have more friends to play with at lunchtime.</GoalDescription> <GoalName>Have more friends</GoalName> </SocialGoal> </SocialGoalList> <AcademicGoalList> <AcademicGoal> <GoalRecordedDate>2018-11-30</GoalRecordedDate> <GoalDescription>Timothy wants to excel at Te Reo Māori</GoalDescription> <GoalName>Excel Te Reo</GoalName> <SubjectArea>MAOR</SubjectArea> </AcademicGoal> </AcademicGoalList> <CareerGoalList> <CareerGoal> <GoalRecordedDate>2018-11-30</GoalRecordedDate> <GoalDescription>Timothy would like to be a Marine Biologist, or Deep Sea Diver</GoalDescription> <GoalName>Marine Biologist</GoalName> </CareerGoal> </CareerGoalList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentVoice>
Example 3.2.36-1: StudentVoice

### 3.2.37 TeachingGroup

Identifies a particular class or other group of students. Such groups can have multiple staff assigned in a variety of roles, may be assigned students from multiple year levels and may be taught multiple courses.

SIF_Events are reported for this object.

Figure 3.2.37-1: TeachingGroup

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| TeachingGroup |  | Medium | Identifies a particular class or other group of students. Such groups can have multiple staff assigned in a variety of roles, may be assigned students from multiple year levels and may be taught multiple courses. |
| TeachingGroupRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| TeachingGroupLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| ShortName | M | Low | Short free format label that describes the group. | xs:normalizedString
| LongName | O | Low | Longer description if required. | xs:normalizedString
| GroupType | O | Low | Provides the means of identifying the type of group such as roll class or subject class for instance and treat them accordingly. | NZCodeSetsTeachingGroupTypeType
| Organisation | M | Low | The organisation who defines the TeachingGroup. Either OrganisationRefId or OrganisationLocalId must be provided. | OrganisationObjectReferenceType
| TeachingOrganisation | O | Low | The organisation who actually teaches the TeachingGroup. Only present when the teaching organisation is not the defining organisation. | OrganisationObjectReferenceType
| ScheduleTerm | O | Medium | The term that the teaching groups run for, e.g. Term 1, Full Year etc. | ObjectReferenceType
| StudentList | O | Medium | List of Students in this Teaching Group | StudentListType
| TeacherList | O | Medium | A List of staff associated with the group – may or may not include the teacher timetabled in the schedule. | StaffListType
| CourseList | O | Medium | List of generic references denoting the Courses the TeachingGroup is being taught. | CourseListType
| SubjectAreaList | O | Medium | List of codes denoting the Learning or Subject Areas of the Course the TeachingGroup is being taught. | SubjectAreaListType
| YearLevelList | O | Medium | For Subject Class teaching groups: the list of codes denoting the Year Levels of the Course the TeachingGroup is being taught. For Roll Class teaching groups, the Year Levels of the students in the roll class group. | YearLevelListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.37-1: TeachingGroup
JSON
{ "TeachingGroup": { "TeachingGroupRefId": "64a309da-063a-2e35-b359-d75101a8c3d1", "TeachingGroupLocalId": "20087ASPN", "ShortName": "7A SPN", "LongName": "Year 7A Maths - Space and Numbers", "GroupType": "SC", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "ScheduleTerm": { "LocalId": "FY2020" }, "StudentList": { "Student": [ { "RefId": "9897466f-200e-4bc1-b9ae-d1507da15cef", "LocalId": "SMI001", "Name": "Peter Smith" }, { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290d", "LocalId": "SMI002", "Name": "Jennifer Smith" }, { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290e", "LocalId": "SMI003", "Name": "Terence Smith" } ] }, "TeacherList": { "StaffMember": [ { "RefId": "a8c3a2e3-5b35-9d75-101d-00aa001a0000", "LocalId": "SMI1", "Name": "Thomas Smith", "Role": "1001" }, { "RefId": "a8cccce3-5b35-9d75-101d-00aa001a0000", "LocalId": "LONG2", "Name": "Tamara Long", "Role": "1002" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<TeachingGroup> <TeachingGroupRefId>64a309da-063a-2e35-b359-d75101a8c3d1</TeachingGroupRefId> <TeachingGroupLocalId>20087ASPN</TeachingGroupLocalId> <ShortName>7A SPN</ShortName> <LongName>Year 7A Maths - Space and Numbers</LongName> <GroupType>SC</GroupType> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <ScheduleTerm> <LocalId>FY2020</LocalId> </ScheduleTerm> <StudentList> <Student> <RefId>9897466f-200e-4bc1-b9ae-d1507da15cef</RefId> <LocalId>SMI001</LocalId> <Name>Peter Smith</Name> </Student> <Student> <RefId>7c834ea9-eda1-2090-347f-83297e1c290d</RefId> <LocalId>SMI002</LocalId> <Name>Jennifer Smith</Name> </Student> <Student> <RefId>7c834ea9-eda1-2090-347f-83297e1c290e</RefId> <LocalId>SMI003</LocalId> <Name>Terence Smith</Name> </Student> </StudentList> <TeacherList> <StaffMember> <RefId>a8c3a2e3-5b35-9d75-101d-00aa001a0000</RefId> <LocalId>SMI1</LocalId> <Name>Thomas Smith</Name> <Role>1001</Role> </StaffMember> <StaffMember> <RefId>a8cccce3-5b35-9d75-101d-00aa001a0000</RefId> <LocalId>LONG2</LocalId> <Name>Tamara Long</Name> <Role>1002</Role> </StaffMember> </TeacherList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </TeachingGroup>
Example 3.2.37-1: TeachingGroup

### 3.2.38 TeachingGroupEvent

Defines a single SchedulePeriod in a Schedule where the TeachingGroup meets.

SIF_Events are reported for this object.

Figure 3.2.38-1: TeachingGroupEvent

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| TeachingGroupEvent |  | Low | Defines a single SchedulePeriod in a Schedule where the TeachingGroup meets. |
| TeachingGroupEventRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| TeachingGroupEventLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Organisation | M | Low | Generic object reference to the Organisation (Provider) defining the TeachingGroup. | OrganisationObjectReferenceType
| TeachingGroup | M | Low | Generic object reference to the TeachingGroup that is meeting. | ObjectReferenceType
| Schedule | M | Low | Generic object reference to the Provider Schedule defining when the TeachingGroup meets. | ObjectReferenceType
| ScheduleAcademicDay | M | Low | Generic object reference to the ScheduleAcademicDay that the TeachingGroup meets. | ObjectReferenceType
| SchedulePeriod | M | Low | Generic object reference to the SchedulePeriod that the TeachingGroup meets. | ObjectReferenceType
| ScheduleTerm | O | Low | Generic object reference to the ScheduleTerm, used when an SMS does not define teaching group events for every applicable date covered by the Schedule start and end date; but rather by terms. If you do not supply a term, it is assumed that the class will occur for the duration of the Schedule. If you do supply a Term, the class will only occur during that Term. | ObjectReferenceType
| RoomId | O | Medium | The Id of the room the teaching group is meeting in. | xs:normalizedString
| RoomName | O | Medium | The name of the room the teaching group is meeting in. | xs:normalizedString
| TakeAttendanceFlag | O | Medium | Indicates whether or not attendance should be taken for this teaching group event. | NZCodeSetsYesOrNoCategoryType
| TeacherList | O | Medium | List of the teacher(s) teaching the class during this timetable event. | StaffListType
| CourseList | O | Medium | The list of Courses that is being taught to the teaching group at this event. | CourseListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.38-1: TeachingGroupEvent
JSON
{ "TeachingGroupEvent": { "TeachingGroupEventRefId": "9356909d-e46a-456a-a177-6a914af861ae", "TeachingGroupEventLocalId": "20197A-SPN-1", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "TeachingGroup": { "RefId": "64a309da-063a-2e35-b359-d75101a8c3d1", "LocalId": "20197ASPN", "Name": "Year 7A Maths - Space and Numbers" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "Name": "Scheule 2019a (Term 1)" }, "ScheduleAcademicDay": { "RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9", "LocalId": "2019a-A", "Name": "Scheule 2019a, Day A" }, "SchedulePeriod": { "RefId": "215f796c-67f7-4855-83dc-28ad9d002830", "LocalId": "2019a-1", "Name": "Schedule 2019a, Period 1" }, "RoomId": "TB202", "RoomName": "Tower Block, Room 202", "TakeAttendanceFlag": "Y", "TeacherList": { "StaffMember": [ { "RefId": "a8c3a2e3-5b35-9d75-101d-00aa001a0000", "LocalId": "SMI1", "Name": "Thomas Smith", "Role": "1001" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<TeachingGroupEvent> <TeachingGroupEventRefId>9356909d-e46a-456a-a177-6a914af861ae</TeachingGroupEventRefId> <TeachingGroupEventLocalId>20197A-SPN-1</TeachingGroupEventLocalId> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <TeachingGroup> <RefId>64a309da-063a-2e35-b359-d75101a8c3d1</RefId> <LocalId>20197ASPN</LocalId> <Name>Year 7A Maths - Space and Numbers</Name> </TeachingGroup> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Scheule 2019a (Term 1)</Name> </Schedule> <ScheduleAcademicDay> <RefId>364f0aa5-49e2-434e-9c82-45770f4c71a9</RefId> <LocalId>2019a-A</LocalId> <Name>Scheule 2019a, Day A</Name> </ScheduleAcademicDay> <SchedulePeriod> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-1</LocalId> <Name>Schedule 2019a, Period 1</Name> </SchedulePeriod> <RoomId>TB202</RoomId> <RoomName>Tower Block, Room 202</RoomName> <TakeAttendanceFlag>Y</TakeAttendanceFlag> <TeacherList> <StaffMember> <RefId>a8c3a2e3-5b35-9d75-101d-00aa001a0000</RefId> <LocalId>SMI1</LocalId> <Name>Thomas Smith</Name> <Role>1001</Role> </StaffMember> </TeacherList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </TeachingGroupEvent>
Example 3.2.38-1: TeachingGroupEvent

### 3.2.39 TeachingGroupMeetingAttendance

Defines a teaching group meeting and the attendance of each student at that meeting. Meetings may either be scheduled or ad hoc.

SIF_Events are reported for this object.

Figure 3.2.39-1: TeachingGroupMeetingAttendance

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| TeachingGroupMeetingAttendance |  | Low | Defines a teaching group meeting and the attendance of each student at that meeting. Meetings may either be scheduled or ad hoc. |
| TeachingGroupMeetingAttendanceRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| TeachingGroupMeetingAttendanceLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Organisation | M | Low | The provider who is providing this teaching group attendance record. | OrganisationObjectReference
| TeachingGroup | M | Low | The TeachingGroup that is meeting, and having it's attendance taken. | ObjectReference
| MeetingDate | M |  | The date the TeachingGroup meeting took place | xs:date
| SubmissionDateTime | O |  | The date and time the teaching group meeting attendance was submitted. | xs:dateTime
| Scheduled | O | Low | Defines details about a scheduled meeting. When scheduled meeting details are provided ad hoc meeting details cannot be provided. | ScheduledMeetingType
| AdHoc | O | Low | Defines details about an ad hoc meeting. When ad hoc meeting details are provided scheduled meeting details cannot be provided. | AdHocMeetingType
| StudentAttendanceList | M | Low | Breakdown of times that the student was recorded as being present or absent from school or class. | StudentAttendanceListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.39-1: TeachingGroupMeetingAttendance
JSON
{ "TeachingGroupMeetingAttendance": { "TeachingGroupMeetingAttendanceRefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd934554", "Organisation": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "TeachingGroup": { "RefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd993378" }, "MeetingDate": "2020-04-03", "Scheduled": { "SchedulePeriod": { "LocalId": "2020a-A" }, "StartTime": "09:30:00", "EndTime": "10:30:00" }, "StudentAttendanceList": { "StudentAttendance": [ { "Student": { "RefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd934554" }, "Code": "P", "CodeGroup": "P", "Note": "Student was present." }, { "Student": { "RefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd934667" }, "Code": "L", "CodeGroup": "U", "Note": "Late to class; Unjustified", "StartTime": "09:45:00", "EndTime": "10:30:00" } ] } } }
XML
<TeachingGroupMeetingAttendance> <TeachingGroupMeetingAttendanceRefId>7f11e3ed-3ac5-4673-9fdc-bcdbcd934554</TeachingGroupMeetingAttendanceRefId> <Organisation> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Organisation> <TeachingGroup> <RefId>7f11e3ed-3ac5-4673-9fdc-bcdbcd993378</RefId> </TeachingGroup> <MeetingDate>2020-04-03</MeetingDate> <Scheduled> <SchedulePeriod> <LocalId>2020a-A</LocalId> </SchedulePeriod> <StartTime>09:30:00</StartTime> <EndTime>10:30:00</EndTime> </Scheduled> <StudentAttendanceList> <StudentAttendance> <Student> <RefId>7f11e3ed-3ac5-4673-9fdc-bcdbcd934554</RefId> </Student> <Code>P</Code> <CodeGroup>P</CodeGroup> <Note>Student was present.</Note> </StudentAttendance> <StudentAttendance> <Student> <RefId>7f11e3ed-3ac5-4673-9fdc-bcdbcd934667</RefId> </Student> <Code>L</Code> <CodeGroup>U</CodeGroup> <Note>Late to class; Unjustified</Note> <StartTime>09:45:00</StartTime> <EndTime>10:30:00</EndTime> </StudentAttendance> </StudentAttendanceList> </TeachingGroupMeetingAttendance>
Example 3.2.39-1: Teaching Group Meeting Attendance

### 3.2.40 WellbeingAlert

Alert indicating to teachers and systems that this student has a 'concern' that needs to be known for 'duty of care', which could be Medical, Legal or other.

The alert may merely draw attention to Wellbeing Characteristics or Events, that contain more detail.

SIF_Events are reported for this object.

Figure 3.2.40-1: WellbeingAlert

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| WellbeingAlert |  | High | Alert indicating to teachers and systems that this student has a 'concern' that needs to be known for 'duty of care', which could be Medical, Legal or other. The alert may merely draw attention to Wellbeing Characteristics or Events, that contain more detail. |
| WellbeingAlertRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| WellbeingAlertLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | High | Generic object reference to the student to whom this WellbeingAlert belongs. | StudentObjectReferenceType
| Provider | M | Low | Generic object reference to the school for which this WellbeingAlert is being reported. | OrganisationObjectReferenceType
| StaffMember | O | Low | Generic object reference to the staff member that is a key contact for this wellbeing alert. | ObjectReferenceType
| PublishedDate | O | Low | The calendar date on which this wellbeing alert was published. | xs:date
| StartDate | O | Low | The date the wellbeing alert period commenced. | xs:date
| EndDate | O | Low | The date the wellbeing alert is due to finish. | xs:date
| AlertCategory | O | High | Category of WellbeingAlert. | NZCodeSetsWellbeingAlertCategoryType
| AlertDescription | O | High | Description of this particular wellbeing alert. | xs:normalizedString
| AcknowledgementList | O | Medium | Key Contact to get information about this wellbeing alert from. | AcknowledgementListType
| KeyContactList | O | Medium | A list of key contacts for the alert. | KeyContactListType
| WellbeingResponseList | O | Medium | A list of the Wellbeing Responses that contributed to the creation of this Wellbeing Alert. | WellbeingResponseListType
| WellbeingAppealList | O | Medium | A list of the Wellbeing Appeal outcomes that contributed to the creation of this Wellbeing Alert. | WellbeingAppealListType
| WellbeingCharacteristicList | O | Medium | A list of the Wellbeing Characteristics that contributed to the creation of this Wellbeing Alert. | WellbeingCharacteristicList
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.40-1: WellbeingAlert
JSON
{ "WellbeingAlert": { "WellbeingAlertRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "StaffMember": { "RefId": "ba265776-359d-7510-1a8c-77432a901a16" }, "PublishedDate": "2017-11-01", "StartDate": "2017-11-01", "AlertCategory": "MED", "AlertDescription": "This Student is allergic to peanuts", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<WellbeingAlert> <WellbeingAlertRefId>2ffb63b4-cfef-4820-8501-e7d1e54555cb</WellbeingAlertRefId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <Provider> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Provider> <StaffMember> <RefId>ba265776-359d-7510-1a8c-77432a901a16</RefId> </StaffMember> <PublishedDate>2017-11-01</PublishedDate> <StartDate>2017-11-01</StartDate> <AlertCategory>MED</AlertCategory> <AlertDescription>This Student is allergic to peanuts</AlertDescription> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </WellbeingAlert>
Example 3.2.40-1: Wellbeing Alert

### 3.2.41 WellbeingAppeal

Records detail of any "appeal" or "request" made by involved parties in regard to a negative/punitive Wellbeing Response that was the result of a student Wellbeing Event.

SIF_Events are reported for this object.

Figure 3.2.41-1: WellbeingAppeal

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| WellbeingAppeal |  | High | Records detail of any "appeal" or "request" made by involved parties in regard to a negative/punitive Wellbeing Response that was the result of a student Wellbeing Event. |
| WellbeingAppealRefId | O | Medium | The universally unique identifier for the data object record that is used across systems. | RefIdType
| WellbeingAppealLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | High | Generic object reference to the student to whom this WellbeingAppeal belongs. | StudentObjectReferenceType
| Provider | M | Low | Generic object reference to the school for which this WellbeingAppeal is being reported. | OrganisationObjectReferenceType
| WellbeingResponse | M | High | Generic object reference to the WellbeingResponse for which this WellbeingAppeal is in response to. | ObjectReferenceType
| WellbeingAlert | O | High | Generic object reference to the WellbeingAlert this WellbeingAppeal's outcome has triggered. | ObjectReferenceType
| AppealStatus | O | High | The status of WellbeingAppeal. | NZCodeSetsWellbeingAppealStatusType
| RegisteredDate | O | Low | The calendar date on which this WellbeingAppeal was registered. | xs:date
| AppealNotes | O | High | Text relating to the particular WellbeingAppeal. | xs:normalizedString
| AppealOutcome | O | High | The outcome of the appeal. | NZCodeSetsWellbeingAppealOutcomeType
| AppealDeterminationBy | O | High | The type of individual or group that determined the appeal outcome. | NZCodeSetsAppealDeterminationByType
| DocumentList | O | High | Describes the Location of any associated documents kept in relation to this Appeal. | DocumentListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.41-1: WellbeingAppeal
JSON
{ "WellbeingAppeal": { "WellbeingAppealRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "WellbeingResponse": { "RefId": "bc385746-359d-7510-1a8c-36432a901a36" }, "AppealStatus": "SU", "RegisteredDate": "2017-11-01", "AppealNotes": "This Appeal was successful.", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<WellbeingAppeal> <WellbeingAppealRefId>2ffb63b4-cfef-4820-8501-e7d1e54555cb</WellbeingAppealRefId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <Provider> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Provider> <WellbeingResponse> <RefId>bc385746-359d-7510-1a8c-36432a901a36</RefId> </WellbeingResponse> <AppealStatus>SU</AppealStatus> <RegisteredDate>2017-11-01</RegisteredDate> <AppealNotes>This Appeal was successful.</AppealNotes> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </WellbeingAppeal>
Example 3.2.41-1: Wellbeing Appeal

### 3.2.42 WellbeingCharacteristic

Core Wellbeing Characteristic that is integral to the Student. This may be a Medical condition, special needs or a characteristic such as a known disability or any other characteristic or condition that is student specific and impacts their learning.

SIF_Events are reported for this object.

Figure 3.2.42-1: WellbeingCharacteristic

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| WellbeingCharacteristic |  | High | Core Wellbeing Characteristic that is integral to the Student. This may be a Medical condition, special needs or a characteristic such as a known disability or any other characteristic or condition that is student specific and impacts their learning. |
| WellbeingCharacteristicRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| WellbeingCharacteristicLocalId | O | High | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | High | Generic object reference to the student to whom this WellbeingCharacteristic belongs. | StudentObjectReferenceType
| RecordingProvider | M | Low | Generic object reference to the provider which recorded this Wellbeing Characteristic. | OrganisationObjectReferenceType
| StartDate | O | Low | Starting Date for this Characteristic to be noted. | xs:date
| EndDate | O | Low | End date for this Characteristic to be noted, if there is one. | xs:date
| ReviewDate | O | Low | Date at which this information should be reviewed. | xs:date
| CharacteristicNotes | O | High | Text relating to the particular WellbeingCharacteristic. | xs:normalizedString
| NoteList | O | High | A list of notes that have been written about the wellbeing characteristic. | NoteListType
| Classification | M | High | Top most category of WellbeingCharacteristic. | NZCodeSetsWellbeingCharacteristicClassType
| Category | M | High | Category of WellbeingCharacteristic. | NZCodeSetsWellbeingCharacteristicCategoryType
| SubCategory | O | High | Sub category of the WellbeingCharacteristic. | NZCodeSetsWellbeingCharacteristicSubCategoryType
| SubSubCategory | O | High | An additional layer to provide more detail around a wellbeing characteristic sub category. For examples for the learner’s support need sub category, e.g. if the support need of ‘Vision’ is selected for the user, the sub needs ‘Low Vision’ and ‘Blind’ are available to further define the type of vision issue the learner has. Not all support needs have sub needs. | NZCodeSetsWellbeingCharacteristicSubSubCategoryType
| SubCategoryDetail | O | High | Additional detail about a sub category. | xs:normalizedString
| CharacteristicPriority | O | High | The priority of the characteristic in relation to other characteristics within the same classification. | NZCodeSetsWellbeingCharacteristicPriorityType
| CaseLead | O | Low | The Agency taking the lead on the learning support need case, e.g. MOE, Police, Corrections etc.) | NZCodeSetsLearningSupportCaseLeadType
| CaseLeadOtherDesc | O | Low | Free text describing the Case Lead Agency when a Case Lead of 'Other' is selected. | xs:normalizedString
| CaseLeadContactPerson | M | Low | The name of the contact person for the Case Lead Agency. | xs:normalizedString
| DailyManagement | O | High |  | xs:normalizedString
| EmergencyManagement | O | High |  | xs:normalizedString
| EmergencyResponsePlan | O | High |  | xs:normalizedString
| Trigger | O | High |  | xs:normalizedString
| ConfidentialFlag | O | High | Flag indicating if the characteristic is confidential or not. If ‘Y’ should not be shared with any other system/school. | NZCodeSetsYesOrNoCategoryType
| Alert | O | High | Create an Alert for this Characteristic? | NZCodeSetsYesOrNoCategoryType
| MedicationList | O | High |  | MedicationListType
| DocumentList | O | High | Describes the Location of any associated documents kept in relation to this Characteristic. | DocumentListType
| WellbeingEventList | O | Medium | A list of any Wellbeing Events that have arisen as a result of this Characteristic. | WellbeingEventListType
| WellbeingAlertList | O | Medium | A list of any Wellbeing Alerts that have arison as a result of this Chracteristic. | WellbeingAlertListType
| SpecialAssessmentConditionList | O | Low | A list of the special assessment conditions that a student is entitled to have when sitting an assessment. | SpecialAssessmentConditionListType
| Status | O | Low | The staus of the Wellbeing Characteristic. | NZCodeSetsWellbeingCharacteristicStatusType
| MedicalCharacteristicDesc | O | Low | Free text providing additional information about a medical need of a student. Especially when a medical need of 'Other' is selected. | xs:normalizedString
| OfficialDiagnosis | O | Low | Indicates whether or not the student has an official diagnosis that pertains to this Wellbeing Characteristic. | NZCodeSetsYesOrNoCategoryType
| OfficialDiagnosisList | O | Low | A list of official diagnoses that pertains to this wellbeing characteristic. At least one diagnosis is required if OfficialDiagnosis = 'Y'. | OfficialDiagnosisListType
| StudentVoiceList | O | Low | A list of the student's or their whānau's voice about their wellbeing characteristic in regards to the student 's interests, goals, and voice (comments, opinions). | StudentVoiceListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType
| LearnerInterests | O | Low | Free text that describes the interests a learner has that pertains to this wellbeing Characteristic. | xs:normalizedString
| LearnerWhanauGoal | O | Low | Free text describing any goals the student wants to achieve, or any goals their whānau want them to achieve that pertain to this wellbeing characteristic. | xs:normalizedString
| LearnerWhanauVoice | O | Low | Free text capturing the learners and/or their whānaus opinions and point of view in regards to this wellbeing characteristic. | xs:normalizedString

Table 3.2.42-1: WellbeingCharacteristic
JSON
{ "WellbeingCharacteristic": { "WellbeingCharacteristicRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "RecordingProvider": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "StartDate": "2017-11-01", "EndDate": "2017-11-10", "CharacteristicNotes": "This Student has a special need.", "Classification": "LSN", "Category": "LSN-SOC", "SubCategory": "LSN-HYP", "CaseLead": "RT", "CaseLeadContactPerson": "Dr RTL Bush", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<WellbeingCharacteristic> <WellbeingCharacteristicRefId>2ffb63b4-cfef-4820-8501-e7d1e54555cb</WellbeingCharacteristicRefId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <RecordingProvider> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </RecordingProvider> <StartDate>2017-11-01</StartDate> <EndDate>2017-11-10</EndDate> <CharacteristicNotes>This Student has a special need.</CharacteristicNotes> <Classification>LSN</Classification> <Category>LSN-SOC</Category> <SubCategory>LSN-HYP</SubCategory> <CaseLead>RT</CaseLead> <CaseLeadContactPerson>Dr RTL Bush</CaseLeadContactPerson> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </WellbeingCharacteristic>
Example 3.2.42-1: WellbeingCharacteristic

### 3.2.43 WellbeingEvent

Record of an event happening that impacts on a school's duty of care to its students. The event records both 'positive' and 'negative' behaviours and is not just the recording of a discipline incident or an accident.

SIF_Events are reported for this object.

Figure 3.2.43-1: WellbeingEvent

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| WellbeingEvent |  | High | Record of an event happening that impacts on a school's duty of care to its students. The event records both 'positive' and 'negative' behaviours and is not just the recording of a discipline incident or an accident. |
| WellbeingEventRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| WellbeingEventLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | High | Object reference to the student to whom this WellbeingEvent belongs. | StudentObjectReferenceType
| ReportingProvider | M | Low | Object reference to the provider for which this WellbeingEvent is being reported. | OrganisationObjectReferenceType
| PhysicalRestraint | O | Low | Object reference tothe StudentPhysicalRestraint if it was administered to the student as part of this WellbeingEvent. | ObjectReferenceType
| EventNotes | O | High | Text relating to the particular WellbeingEvent. | xs:normalizedString
| PossibleMotivationList | O | High | A list of the possible motivations that triggered the event. | PossibleMotivationListType
| EventCategoryClass | O | High | Category of WellbeingEvent. | NZCodeSetsWellbeingEventCategoryClassType
| EventCategoryList | O | High | List of Categories of WellbeingEvent. | WellbeingEventCategoryListType
| ReportingStaffMember | O | Low | Object refernece to the staff member who logged the Wellbeing Event record. | ObjectReferenceType
| EventLocationList | O | Low | A list of the locations where the incident took place. | EventLocationListType
| EventLocationDescription | O | Medium | Details of Event Location. | xs:normalizedString
| EventCreationTimeStamp | O | Low | Date and time of the WellbeingEvent record creation. | xs:dateTime
| EventDate | O | High | The calendar date on which this WellbeingEvent occured. | xs:date
| EventTime | O | High | The time when WellbeingEvent occured. | xs:time
| EventDescription | O | High | A description of the WellbeingEvent. | xs:normalizedString
| EventTimePeriod | O | High | Time period of when the event occurred. | NZCodeSetsWellbeingEventTimePeriodType
| ConfidentialFlag | O | High | Flag indicating if the incident is confidential or not. If ‘Y’ should not be shared with any other system/school. | NZCodeSetsYesOrNoCategoryType
| PersonInvolvementList | O | High | List of People involved in the Wellbeing event. Mandatory if more people than the student to which this event occurs is involved. | PersonInvolvementListType
| Status | O | High | Current Status. | NZCodeSetsWellbeingStatusType
| BehaviourIdentifiedList | O | High | A list of the problem behaviours identified for the student as a result of the Wellbeing Event. There are both minor and major behaviours. | BehaviourIdentifiedListType
| RestraintType | O | High | The StudentPhysicalRestraint if it was administered to the student as part of this WellbeingEvent. | NZCodeSetsWellbeingEventRestraintTypeType
| ActionTakenList | O | High | A list of the actions taken as a result of this WellbeingEvent. | ActionTakenListType
| DocumentList | O | High | Describes the Location of any associated documents kept in relation to this Response. | DocumentListType
| RelatedWellbeingEventList | O | High | A Wellbeing Event gets created for every student involved in an event. This list links together all related Wellbeing Events. | RelatedWellbeingEventListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.43-1: WellbeingEvent
JSON
{ "WellbeingEvent": { "WellbeingEventRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "ReportingProvider": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "EventCategoryClass": "POS", "EventDate": "2017-11-01", "EventTimePeriod": "AM", "RestraintType": "NON", "ActionTakenList": { "ActionTaken": [ "ININ" ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<WellbeingEvent> <WellbeingEventRefId>2ffb63b4-cfef-4820-8501-e7d1e54555cb</WellbeingEventRefId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <ReportingProvider> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </ReportingProvider> <EventCategoryClass>POS</EventCategoryClass> <EventDate>2017-11-01</EventDate> <EventTimePeriod>AM</EventTimePeriod> <RestraintType>NON</RestraintType> <ActionTakenList> <ActionTaken>ININ</ActionTaken> </ActionTakenList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </WellbeingEvent>
Example 3.2.43-1: WellbeingEvent

### 3.2.44 WellbeingResponse

A record of the outcome and follow ups generated by a WellbeingEvent

SIF_Events are reported for this object.

Figure 3.2.44-1: WellbeingResponse

| Element/@Attribute | Char | Privacy Rating | Description | Type
--- | --- | --- | --- | --- | ---
| WellbeingResponse |  | High | A record of the outcome and follow ups generated by a WellbeingEvent |
| WellbeingResponseRefId | O | Low | The universally unique identifier for the data object record that is used across systems. | RefIdType
| WellbeingResponseLocalId | O | Low | The Id of the data object record that was provided by the system that the information was originally sourced from. | LocalIdType
| Student | M | High | Object reference to the student to whom this WellbeingResponse belongs. | StudentObjectReferenceType
| Provider | M | High | Object reference to the provider for which this WellbeingResponse is being reported. | OrganisationObjectReferenceType
| PublishedDate | O | Low | The calendar date on which this WellbeingResponse was published. | xs:date
| StartDate | O | Low | The date the WellbeingResponse period commenced. | xs:date
| EndDate | O | Low | The date the WellbeingResponse is due to finish. | xs:date
| ResponseStatus | O | High | The current status of the response to the wellbeing event. | NZCodeSetsWellbeingStatusType
| ResponseCategory | O | High | Category of WellbeingResponse. | NZCodeSetsWellbeingResponseCategoryType
| ResponseNotes | O | High | Text relating to the particular WellbeingResponse. | xs:normalizedString
| PersonInvolvementList | O | High | List of People involved in the Wellbeing Event/Response. Mandatory if more people than the student to which this event/response occurs is involved. | PersonInvolvementListType
| Suspension | O | High | Container for details of a Suspension or Expulsion. | SuspensionContainerType
| Detention | O | High | Container for details of a Detention. | DetentionContainerType
| PlanRequiredList | O | High | List of plans that are required to be generated as part of the WellbeingResponse | PlanRequiredListType
| Award | O | High | Container for details of an Award. | AwardContainerType
| OtherResponse | O | High | Container for details of another type of Response. | OtherWellbeingResponseContainerType
| DocumentList | O | High | Describes the Location of any associated documents kept in relation to this Response. | DocumentListType
| WellbeingAlert | O | High | The ID (GUID) of the Wellbeing Alert that was generated in response to this WellbeingResponse. | ObjectReferenceType
| WellbeingEvent | O | High | The ID (GUID) of the WellbeingEvent this WellbeingResponse is for. | ObjectReferenceType
| WellbeingAppealList | O | Medium | A list of any appeals that have been made in relation to this Wellbeing Response. | WellbeingAppealListType
| RecordAudit | O | Low | The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By. | RecordAuditType

Table 3.2.44-1: WellbeingResponse
JSON
{ "WellbeingResponse": { "WellbeingResponseRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": "e189fd55-a6d8-413a-b85c-caf79868938b", "LocalId": "9961" }, "PublishedDate": "2017-11-01", "StartDate": "2017-11-01", "EndDate": "2017-11-10", "ResponseCategory": "S", "ResponseNotes": "This Student is to be withdrawn.", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } }
XML
<WellbeingResponse> <WellbeingResponseRefId>2ffb63b4-cfef-4820-8501-e7d1e54555cb</WellbeingResponseRefId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <Provider> <RefId>e189fd55-a6d8-413a-b85c-caf79868938b</RefId> <LocalId>9961</LocalId> </Provider> <PublishedDate>2017-11-01</PublishedDate> <StartDate>2017-11-01</StartDate> <EndDate>2017-11-10</EndDate> <ResponseCategory>S</ResponseCategory> <ResponseNotes>This Student is to be withdrawn.</ResponseNotes> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44fb63b4-cfef-4820-8501-e7d1e54555cb</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </WellbeingResponse>
Example 3.2.44-1: WellbeingResponse