diff --git a/demo/openapi.yaml b/demo/openapi.yaml index fc3ce073..1efeafcd 100644 --- a/demo/openapi.yaml +++ b/demo/openapi.yaml @@ -1,928 +1,117953 @@ -openapi: 3.0.0 -servers: - - url: //petstore.swagger.io/v2 - description: Default server - - url: //petstore.swagger.io/sandbox - description: Sandbox server +openapi: 3.0.2 info: - description: | - This is a sample server Petstore server. - You can find out more about Swagger at - [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). - For this sample, you can use the api key `special-key` to test the authorization filters. - - # Introduction - This API is documented in **OpenAPI format** and is based on - [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team. - It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo) - tool and [ReDoc](https://github.com/Rebilly/ReDoc) documentation. In addition to standard - OpenAPI syntax we use a few [vendor extensions](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md). - - # OpenAPI Specification - This API is documented in **OpenAPI format** and is based on - [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team. - It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo) - tool and [ReDoc](https://github.com/Rebilly/ReDoc) documentation. In addition to standard - OpenAPI syntax we use a few [vendor extensions](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md). - - # Cross-Origin Resource Sharing - This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). - And that allows cross-domain communication from the browser. - All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. - - # Authentication - - Petstore offers two forms of authentication: - - API Key - - OAuth2 - OAuth2 - an open protocol to allow secure authorization in a simple - and standard method from web, mobile and desktop applications. - - - - version: 1.0.0 - title: Swagger Petstore - termsOfService: 'http://swagger.io/terms/' + version: v1 + title: Te Rito SIF APIs + description:

Derived from Systems Interoperability Framework™ SIF Implementation + Specification (New Zealand) 3.0 (RC 3)

Release Date: + 8-Aug-2019

+ basePath: v1 contact: - name: API Support - email: apiteam@swagger.io - url: https://github.com/Rebilly/ReDoc - x-logo: - url: 'https://rebilly.github.io/ReDoc/petstore-logo.png' - altText: Petstore logo - license: - name: Apache 2.0 - url: 'http://www.apache.org/licenses/LICENSE-2.0.html' -externalDocs: - description: Find out how to create Github repo for your OpenAPI spec. - url: 'https://github.com/Rebilly/generator-openapi-repo' -tags: - - name: pet - description: Everything about your Pets - - name: store - description: Access to Petstore orders - - name: user - description: Operations about user + name: Ministry of Education + url: http://www.education.govt.nz + email: terito@education.govt.nz + host: api.terito.education.govt.nz x-tagGroups: - - name: General + - name: Data Analysis ESR - Milestone 1 tags: - - pet - - store - - name: User Management + - environment + - Provider + - StudentPersonal + - StudentProviderEnrolment + - StudentAttendanceTimeList + - StaffPersonal + - StaffAssignment + - name: Data Analysis ESR - Milestone 2 tags: - - user + - StudentAssessmentTaskResult + - LearningStandard + - StudentAttainment + - name: Data Analysis ESR - Milestone 3 + tags: + - WellbeingEvent + - WellbeingCharacteristic + - StudentLearningSupportParticipation + - name: Data Analysis ESR - Milestone 4 + tags: + - StudentAssessmentTaskResult + - name: SIF Infrastructure Services + tags: + - environment + - name: Provider + tags: + - ProviderOverview + - Provider + - Organisation + - ProviderRelationship + - StaffPersonal + - StaffAssignment + - ProviderCourse + - TeachingGroup + - AcademicDepartment + - Schedule + - ScheduleAcademicDay + - SchedulePeriod + - ScheduleTerm + - ScheduleDate + - ScheduleEvent + - BellSchedule + - ScheduleHoliday + - TeachingGroupEvent + - LearningSupportRegisterDirectory + - name: Student & Whānau + tags: + - StudentWhānauOverview + - StudentPersonal + - StudentContactPersonal + - StudentContactRelationship + - StudentConsent + - name: Enrolment + tags: + - EnrolmentOverview + - StudentProviderEnrolment + - StudentTeachingGroupEnrolment + - name: Hauora / Wellbeing + tags: + - HauoraWellbeingOverview + - WellbeingCharacteristic + - WellbeingAlert + - WellbeingEvent + - WellbeingResponse + - WellbeingAppeal + - StudentLearningSupportParticipation + - Document + - StudentVoice + - StudentPhysicalRestraint + - name: Schedule & Attendance + tags: + - ScheduleAttendanceOverview + - StudentAttendanceTimeList + - StudentAttendanceSummary + - name: Aromatawai / Assessment + tags: + - AromatawaiAssessmentOverview + - StudentAssessmentTaskRegistration + - AssessmentTask + - StudentAssessmentTask + - StudentAssessmentTaskResult + - StudentAttainment + - Credential + - LearningStandard + - StudentCurriculumProgressReport +tags: + - name: environment + description:

The Consumer Environment Service is the gateway to all other services. + It scopes the Consumer's possible interactions with the infrastructure and + any Provider Services accessible from it. The Environment Service provides + the set of (possibly customized) information the Application needs to + interoperate successfully.

+ externalDocs: + description: Environment service in SIF Infrastructure v3.3 + url: http://specification.sifassociation.org/Implementation/Infrastructure/3.3/infrastructures/SIFInfrastructureServices.html#351Environment + - name: ProviderOverview + x-displayName: Provider Overview + description:

The Provider domain describes education provider entities, the + relationships between them, and the Staff that work at them.

+ Background documentation on the Provider domain is available here +

+ externalDocs: + description: Provider Domain in SIF NZ Data Model + url: https://sifnzmodel.azurewebsites.net/SIFNZ-v3.0-rc3/DomainMap.html#Domain__Provider + - name: StudentWhānauOverview + x-displayName: Student & Whānau Overview + description:

The Student domain describes Student entities, their Whānau, and the + relationships between them.

Background documentation on the + Student & Whānau domain is available here +

+ externalDocs: + description: Student & Whānau Domain in SIF NZ Data Model + url: https://sifnzmodel.azurewebsites.net/SIFNZ-v3.0-rc3/DomainMap.html#Domain__StudentWhānau + - name: EnrolmentOverview + x-displayName: Enrolment Overview + description:

The Enrolment domain describes transactional entities whereby Students + enrol at Providers, in LearningProgrammes, in Sections, or in Activities. +

Background documentation on the Enrolment domain is available + here +

+ externalDocs: + description: Enrolment Domain in SIF NZ Data Model + url: https://sifnzmodel.azurewebsites.net/SIFNZ-v3.0-rc3/DomainMap.html#Domain__Enrolment + - name: HauoraWellbeingOverview + x-displayName: Hauora / Wellbeing Overview + description:

The Hauora / Wellbing domain records everything from Student's health + conditions through behavioural incidents (both good and bad) to Student's + aspirations and goals participation in extra-curricular activities and the + provision of Learning Support programmes.

Background documentation on + the Hauora / Wellbeing domain is available here + externalDocs: + description: Hauora / Wellbeing Domain in SIF NZ Data Model + url: https://sifnzmodel.azurewebsites.net/SIFNZ-v3.0-rc3/DomainMap.html#Domain__Hauora/Wellbeing + - name: ScheduleAttendanceOverview + x-displayName: Schedule & Attendance Overview + description:

The Schedule & Attendance domain describes the school's schedule or + timetable, along with transactional entities that record a Student's + attendance at & absence from Providers. Attendance is recorded at either + Day, Half-Day or individual Period granuality at the choice of the + Provider; and reported back in summary form.

Background + documentation on the Schedule domain is available here +

Background documentation on the Attendance domain is available + here +

+ externalDocs: + description: Schedule & Attendance Domain in SIF NZ Data Model + url: https://sifnzmodel.azurewebsites.net/SIFNZ-v3.0-rc3/DomainMap.html#Domain__ScheduleAttendance + - name: AromatawaiAssessmentOverview + x-displayName: Aromatawai / Assessment Overview + description:

The Assessment domain describes transactional entities that record + assessment of Student's learning. The domain covers everything from a + simple in-class assessment task (eg grading assignment, test or essay) + through to end of Course or year final marks, and curriculum progress + reports as well as formal external assessments performed by external + agencies (eg. NZQA, Cambridge International Education, International + Baccalaureate, etc).

Background documentation on the Aromatawai / + Assessment domain is available here +

+ externalDocs: + description: Aromatawai / Assessment Domain in SIF NZ Data Model + url: https://sifnzmodel.azurewebsites.net/SIFNZ-v3.0-rc3/DomainMap.html#Domain__Aromatawai/Assessment + - name: Provider + description: A recognised provider of education services in the New Zealand education + system. Providers may operate in the Early Childhood, Compulsory Schooling + or Tertiary sectors. + - name: ProviderRelationship + description:

Records a recognised relationship between two education Providers. The + two providers are referred to as the Source Provider and the Related + Provider.

RelationshipType records the nature of the relationship + between the two providers, and gives guidance on which Provider is the + Source Provider and which is the Related Provider.

+ - name: Organisation + description: A generic organisation that operates within the education sector; but + doesn’t provide education services. e.g. Communities of Learning | Kāhui + Ako, Ministry local offices, Industry training organisations, etc. + - name: AcademicDepartment + description:

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

+ - name: StaffPersonal + description:

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.

+ - name: StaffAssignment + description:

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.

+ - name: StaffTeachingGroupAssignment + description:

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

+ - name: StudentPersonal + description: Contains all the personal information related to the student. + - name: StudentContactPersonal + description: Information about a Student's whānau member. + - name: StudentContactRelationship + description:

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.

+ - name: Document + description:

Location and meta-data of a document, including evidentiary documents, + personalised plans, and action plans.

+ - name: StudentConsent + description: A record of Student's consent or non-consent to some action taking place. + - name: TeachingGroup + description:

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. +

+ - name: ProviderCourse + description:

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

+ - name: LearningStandard + description:

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.

+ - name: Credential + description:

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.

+ - name: StudentProviderEnrolment + description:

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.

+ - name: StudentTeachingGroupEnrolment + description:

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

+ - name: Schedule + description: Provides information about a schedule for a provider. + - name: ScheduleAcademicDay + description: An academic day that makes up all or part of a schedule for a provider. An + academic day represents a structured day that reoccurs consistently e.g. + Day A has five periods that occurs Mon-Wed and Day B has four periods and + occurs Thurs-Fri. + - name: SchedulePeriod + description: Defines the periods that take place within an academic day + - name: BellSchedule + description: Defines bell schedules, each of which is a collection of periods within an + academic day with start and end times associated. These bell schedules are + assigned to calendar dates on which the school is in session using + ScheduleDate in order to specify the school schedule on those dates. These + bell schedules should generally only be used to define standard day types. + Exception days (unless they repeat multiple times and follow a common + template) are defined using ScheduleEvent and ScheduleCustomDayEvent. + - name: ScheduleTerm + description:

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.

+ - name: ScheduleHoliday + description:

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

+ - name: ScheduleDate + description: Provides information about the schedule that is being followed on a + specific calendar date at a particular Provider, e.g. Academic Day A from + the Term 1 Schedule using the Periods and their start and end times + defined in Bell Schedule Day A. + - name: TeachingGroupEvent + description:

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

+ - name: ScheduleEvent + description:

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

+ - name: StudentAttendanceSummary + description:

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.

+ - name: StudentAttendanceTimeList + description:

This object provides more detail about the attendance spans for a + single student during the day it provides more detailed information than + the single TimeIn and TimeOut elements in StudentDailyAttendance.

+ - name: WellbeingAlert + description:

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.

+ - name: WellbeingCharacteristic + description:

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.

+ - name: WellbeingEvent + description:

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.

+ - name: WellbeingResponse + description:

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

+ - name: WellbeingAppeal + description:

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.

+ - name: StudentActivityParticipation + description: This object provides information on a co-curricular or extra-curricular + activity in which a student participates during a given school year. + - name: StudentPhysicalRestraint + description:

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

+ - name: StudentVoice + description: A record of a student's interests as well as their social, academic and + academic goals. + - name: LearningSupportRegisterDirectory + description:

Learning Support Needs are grouped by similarity. The Learning Support + Directory maps those groups to Learning Support Interventions so when a + Learning Support Need is identified for the Student only applicable + Interventions for the group it belongs to are presented to the user. It + also holds additional information about the Learning Support + Interventions, e.g. Description, Funded By, Provided by.

+ - name: StudentLearningSupportParticipation + description:

Contains information pertaining to a student's participation in + learning support.

+ - name: AssessmentTask + description:

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.

+ - name: StudentAssessmentTaskResult + description:

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

+ - name: StudentAssessmentTaskRegistration + description:

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

+ - name: StudentAssessmentTask + description:

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

+ - name: StudentAttainment + description:

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

+ - name: StudentCurriculumProgressReport + description:

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.

paths: - /pet: - parameters: - - name: cookieParam - in: cookie - description: Some cookie - required: true - schema: - type: integer - format: int64 + /environments: post: tags: - - pet - summary: Add a new pet to the store - description: Add new pet to the store inventory. - operationId: addPet - responses: - '405': - description: Invalid input - security: - - petstore_auth: - - 'write:pets' - - 'read:pets' - x-code-samples: - - lang: 'C#' - source: | - PetStore.v1.Pet pet = new PetStore.v1.Pet(); - pet.setApiKey("your api key"); - pet.petType = PetStore.v1.Pet.TYPE_DOG; - pet.name = "Rex"; - // set other fields - PetStoreResponse response = pet.create(); - if (response.statusCode == HttpStatusCode.Created) - { - // Successfully created - } - else - { - // Something wrong -- check response for errors - Console.WriteLine(response.getRawResponse()); - } - - lang: PHP - source: | - $form = new \PetStore\Entities\Pet(); - $form->setPetType("Dog"); - $form->setName("Rex"); - // set other fields - try { - $pet = $client->pets()->create($form); - } catch (UnprocessableEntityException $e) { - var_dump($e->getErrors()); - } - requestBody: - $ref: '#/components/requestBodies/Pet' - put: - tags: - - pet - summary: Update an existing pet - description: '' - operationId: updatePet - responses: - '400': - description: Invalid ID supplied - '404': - description: Pet not found - '405': - description: Validation exception - security: - - petstore_auth: - - 'write:pets' - - 'read:pets' - x-code-samples: - - lang: PHP - source: | - $form = new \PetStore\Entities\Pet(); - $form->setPetId(1); - $form->setPetType("Dog"); - $form->setName("Rex"); - // set other fields - try { - $pet = $client->pets()->update($form); - } catch (UnprocessableEntityException $e) { - var_dump($e->getErrors()); - } - requestBody: - $ref: '#/components/requestBodies/Pet' - '/pet/{petId}': - get: - tags: - - pet - summary: Find pet by ID - description: Returns a single pet - operationId: getPetById - parameters: - - name: petId - in: path - description: ID of pet to return - required: true - deprecated: true - schema: - type: integer - format: int64 - responses: - '200': - description: successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/Pet' - application/xml: - schema: - $ref: '#/components/schemas/Pet' - '400': - description: Invalid ID supplied - '404': - description: Pet not found - security: - - api_key: [] - post: - tags: - - pet - summary: Updates a pet in the store with form data - description: '' - operationId: updatePetWithForm - parameters: - - name: petId - in: path - description: ID of pet that needs to be updated - required: true - schema: - type: integer - format: int64 - responses: - '405': - description: Invalid input - security: - - petstore_auth: - - 'write:pets' - - 'read:pets' + - environment + summary: Initiate SIF Environment + operationId: createEnvironment requestBody: + description: Initial operation to create a SIF Environment (or Session) content: - application/x-www-form-urlencoded: + application/json: schema: type: object properties: - name: - description: Updated name of the pet - type: string - status: - description: Updated status of the pet - type: string - delete: + environment: + type: object + required: + - type + - authenticationMethod + - consumerName + - applicationInfo + properties: + type: + type: string + xml: + attribute: true + enum: + - DIRECT + authenticationMethod: + type: string + description:

Defines the way in which the applicationKey can be + used to enforce security.

+ consumerName: + type: string + description:

A descriptive name for the application that will be + readily identifiable to Zone Administrators if it + becomes a Registered Consumer

+ applicationInfo: + type: object + required: + - applicationKey + - supportedInfrastructureVersion + - dataModelNamespace + - transport + properties: + applicationKey: + type: string + description:

An opaque (to the SIF standard) element which + contains any required Consumer authentication + information. The content of this element is + site-specific. For a Direct Environment which + accepts Consumer Registration Requests from a mobile + application, this element might contain a + combination of the User ID and Password.

+ supportedInfrastructureVersion: + type: string + description:

The version of the SIF infrastructure which the + Consumer supports.

+ dataModelNamespace: + type: string + format: uri + description:

The namespace of the data payloads conveyed by + this environment. Returns may be of a diffrent minor + version. Utility payloads will be of the + infrastructure namespace.

+ transport: + type: string + description:

The transport which the Consumer expects the + infrastructure to use to interoperate with it. The + default is whichever transport the create request + was issued on

+ enum: + - REST + description:

The SIF Environment Service is the gateway to all other + SIF services. It scopes the Client's possible interactions + with the infrastructure and any Services accessible from it. + The Environment Service provides the set of (possibly + customized) information the Application needs to + interoperate successfully.

+ example: + environment: + type: DIRECT + authenticationMethod: OAuth + consumerName: SMS Name + applicationInfo: + applicationKey: Example + supportedInfrastructureVersion: 3.3 + dataModelNamespace: http://www.sifassociation.org/datamodel/nz/3.0 + transport: REST + application/xml: + schema: + type: object + properties: + environment: + $ref: "#/paths/~1environments/post/requestBody/content/applicatio\ + n~1json/schema/properties/environment" + example: "$ref: '../examples/environment.yaml#/post/xml'" + responses: + "200": + description: SIF Environment successfully initiated + content: + application/json: + schema: + type: object + properties: + environment: + type: object + required: + - type + - id + - sessionToken + - defaultZone + - authenticationMethod + - consumerName + - applicationInfo + - infrastructureServices + - provisionedZones + properties: + type: + type: string + xml: + attribute: true + enum: + - DIRECT + id: + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[14][a-fA-F0-9]{3}-[a-\ + fA-F0-9]{4}-[a-fA-F0-9]{12}" + xml: + attribute: true + sessionToken: + type: string + defaultZone: + type: object + properties: + id: + type: string + xml: + attribute: true + description: + type: string + description:

A short (possibly multi-sentence) description + of the Zone

+ properties: + type: object + required: + - property + properties: + property: + type: array + items: + type: object + properties: + value: + type: string + name: + type: string + description:

Name/Value pair.

+ xml: + attribute: true + description:

Zone identifiers are chosen by the administrator + and can follow any convention that best meets the + needs of the deploying organization. The Zone in which + the Service is to be found always qualifies every + Consumer request for any Provider Service. Each + Service Consumer is assigned a "default" Zone at + Registration time, which is used whenever a specific + Zone is not explicitly included in one of its Provider + Service Requests.

+ authenticationMethod: + type: string + description:

Defines the way in which the applicationKey can be + used to enforce security.

+ consumerName: + type: string + description:

A descriptive name for the application that will be + readily identifiable to Zone Administrators if it + becomes a Registered Consumer

+ applicationInfo: + type: object + description: A description of the SIF application environment that + has been provisioned for the client + required: + - supportedInfrastructureVersion + - dataModelNamespace + - transport + properties: + supportedInfrastructureVersion: + type: string + description:

The version of the SIF infrastructure which the + SIF Environment supports.

+ dataModelNamespace: + type: string + format: uri + description:

The namespace of the data payloads conveyed by + this environment. Returns may be of a diffrent + minor version. Utility payloads will be of the + infrastructure namespace.

+ transport: + type: string + description:

The transport which the Consumer expects the + infrastructure to use to interoperate with it. The + default is whichever transport the create request + was issued on

+ enum: + - REST + infrastructureServices: + type: object + description: A set of two (2) Infrastructure Service definitions, + that have been provisioned for the client + required: + - infrastructureService + properties: + infrastructureService: + type: array + items: + type: object + properties: + value: + type: string + description: Full or Partial URL of the SIF + Infrastructure Service that will accept the + relevant REST calls + name: + type: string + description: >- + The name of the SIF Infrastructure Service + being defined; one of: + oneOf: + - enum: + - environment + - enum: + - provisionRequests + - enum: + - requestsConnector + - enum: + - eventsConnector + - enum: + - queues + - enum: + - subscriptions + - enum: + - servicesConnector + xml: + attribute: true + provisionedZones: + type: object + description: >- +

+ The set of Zones that have been provisioned as part of this SIF Environment (Session). + Each Zone represents an individual School or Kāhui Ako, and is identified with it's MoE OrganisationId +

+ For the Te Rito Data Analysis ESR; each SIF Environment will be provisioned with a single Zone. Future ESRs + and the full Te Rito project will make use of SIF Environments provisioned with multiple Zones. +

+ required: + - provisionedZone + properties: + provisionedZone: + type: array + items: + type: object + required: + - id + - services + properties: + id: + type: string + description:

The unique id of the Zone, and the key to + the Zone element in the Zone Registry.

+ xml: + attribute: true + services: + type: object + description: A set of SIF Service definitions, (ACL + lists) for each of the SIF services that are + available to the connecting client in this + particular Zone + required: + - service + properties: + service: + type: array + items: + type: object + required: + - contextId + - name + - rights + - type + properties: + type: + type: string + oneOf: + - enum: + - UTILITY + - enum: + - OBJECT + - enum: + - FUNCTIONAL + - enum: + - SERVICEPATH + - enum: + - XQUERYTEMPLATE + - enum: + - SERVICE + xml: + attribute: true + name: + type: string + description:

The name of the Service. For + utilities, this is fixed to one of + the defined set of Utility Service + Names. For objects and functions, + it is defined by the Data + Model.

+ xml: + attribute: true + contextId: + type: string + description:

The unique identity of a + context element, which is + associated with a Provider of this + name and type operating in a Zone + with this ID. All Services with + the same name in the same Zone + must have different Context IDs. + Only one such Service can have no + Context.

+ xml: + attribute: true + rights: + type: object + required: + - right + description: The Access Control List (ACL) + denoting which operations are + available to the connecting client + for this SIF Service + properties: + right: + type: array + items: + type: object + properties: + value: + type: string + oneOf: + - enum: + - APPROVED + - enum: + - SUPPORTED + - enum: + - REJECTED + - enum: + - UNSUPPORTED + - enum: + - REQUESTED + type: + description:

The type of the + requested Access + Right

+ oneOf: + - enum: + - QUERY + - enum: + - CREATE + - enum: + - UPDATE + - enum: + - DELETE + - enum: + - SUBSCRIBE + - enum: + - PROVIDE + xml: + attribute: true + description:

The SIF Environment Service is the gateway to all other + SIF services. It scopes the Client's possible interactions + with the infrastructure and any Services accessible from + it. The SIF Environment Service provides the set of + (possibly customized) information the Application needs to + interoperate successfully.

+ example: + environment: + type: DIRECT + sessionToken: a579ff69-0148-1000-007f-14109fdcaf83 + defaultZone: + id: b9969a95-352c-445e-bf13-1d01e1c6bc12 + description: Zone for Wellington College, MoE ProviderId=275 + properties: + property: + - name: providerId + value: "275" + - name: emailContact + value: john.smith@district.k12.wa.us + - name: phoneContact + value: (360)555-1234 + authenticationMethod: Bearer + consumerName: SMS Name + applicationInfo: + applicationKey: Example + supportedInfrastructureVersion: 3.3 + dataModelNamespace: http://www.sifassociation.org/datamodel/nz/3.0 + transport: REST + infrastructureServices: + infrastructureService: + - name: environment + value: https://testharness.sifassociation.org/SIFConnector/v1/environments/ + - name: requestsConnector + value: https://testharness.sifassociation.org/SIFConnector/v1/ + provisionedZones: + provisionedZone: + id: b9969a95-352c-445e-bf13-1d01e1c6bc12" + services: + service: + - name: providers + contextId="DEFAULT": null + type="OBJECT": null + rights: + - right: + type: QUERY + value: APPROVED + - right: + type: CREATE + value: REJECTED + - right: + type: UPDATE + value: REJECTED + - right: + type: DELETE + value: REJECTED + - right: + type: SUBSCRIBE + value: UNSUPPORTED + - name: studentpersonals + contextId="DEFAULT": null + type="OBJECT": null + rights: + - right: + type: QUERY + value: APPROVED + - right: + type: CREATE + value: REJECTED + - right: + type: UPDATE + value: REJECTED + - right: + type: DELETE + value: REJECTED + - right: + type: SUBSCRIBE + value: UNSUPPORTED + - name: studentproviderenrolments + contextId="DEFAULT": null + type="OBJECT": null + rights: + - right: + type: QUERY + value: APPROVED + - right: + type: CREATE + value: REJECTED + - right: + type: UPDATE + value: REJECTED + - right: + type: DELETE + value: REJECTED + - right: + type: SUBSCRIBE + value: UNSUPPORTED + application/xml: + schema: + type: object + properties: + environment: + $ref: "#/paths/~1environments/post/responses/200/content/applic\ + ation~1json/schema/properties/environment" + example: "$ref: '../examples/environment.yaml#/get/xml'" + default: + description: Failed to Initiate SIF Environment. + content: + application/json: + schema: + $ref: "#/components/errors/create/content/application~1json/schema" + application/xml: + schema: + $ref: "#/components/errors/create/content/application~1json/schema" + "/environments/{id}": + get: tags: - - pet - summary: Deletes a pet - description: '' - operationId: deletePet + - environment + summary: Retrieve a SIF Environment + operationId: getEnvironment + description: Retrieve current settings for a particular SIF Environment parameters: - - name: api_key - in: header - required: false + - name: id + in: path + description: GUID identifying the environment being retrieved. + required: true schema: type: string - example: "Bearer " - - name: petId - in: path - description: Pet id to delete - required: true - schema: - type: integer - format: int64 responses: - '400': - description: Invalid pet value - security: - - petstore_auth: - - 'write:pets' - - 'read:pets' - '/pet/{petId}/uploadImage': - post: - tags: - - pet - summary: uploads an image - description: '' - operationId: uploadFile - parameters: - - name: petId - in: path - description: ID of pet to update - required: true - schema: - type: integer - format: int64 - responses: - '200': - description: successful operation + "200": + description: Successfully retrieved SIF Environment content: application/json: schema: - $ref: '#/components/schemas/ApiResponse' - security: - - petstore_auth: - - 'write:pets' - - 'read:pets' - requestBody: - content: - application/octet-stream: - schema: - type: string - format: binary - /pet/findByStatus: - get: - tags: - - pet - summary: Finds Pets by status - description: Multiple status values can be provided with comma seperated strings - operationId: findPetsByStatus - parameters: - - name: status - in: query - description: Status values that need to be considered for filter - required: true - style: form - schema: - type: array - minItems: 1 - maxItems: 3 - items: - type: string - enum: - - available - - pending - - sold - default: available - responses: - '200': - description: successful operation - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Pet' + type: object + properties: + environment: + $ref: "#/paths/~1environments/post/responses/200/content/applic\ + ation~1json/schema/properties/environment" + example: {} application/xml: schema: - type: array - items: - $ref: '#/components/schemas/Pet' - '400': - description: Invalid status value - security: - - petstore_auth: - - 'write:pets' - - 'read:pets' - /pet/findByTags: - get: - tags: - - pet - summary: Finds Pets by tags - description: >- - Muliple tags can be provided with comma seperated strings. Use tag1, - tag2, tag3 for testing. - operationId: findPetsByTags - deprecated: true - parameters: - - name: tags - in: query - description: Tags to filter by - required: true - style: form - schema: - type: array - items: - type: string - responses: - '200': - description: successful operation + type: object + properties: + environment: + $ref: "#/paths/~1environments/post/responses/200/content/applic\ + ation~1json/schema/properties/environment" + example: "$ref: '#/components/examples/environment/get/xml'" + default: + description: Failed to retrieve SIF Environment content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/Pet' + type: object + properties: + error: + $ref: "#/components/errors/query/content/application~1json/sche\ + ma/properties/error" application/xml: schema: - type: array - items: - $ref: '#/components/schemas/Pet' - '400': - description: Invalid tag value - security: - - petstore_auth: - - 'write:pets' - - 'read:pets' - /store/inventory: + type: object + properties: + error: + $ref: "#/components/errors/query/content/application~1json/sche\ + ma/properties/error" + delete: + tags: + - environment + summary: Terminate a SIF environment + operationId: delEnvironment + description: Terminate a particular SIF Environment + parameters: + - name: id + in: path + description: GUID identifying the environment to be terminated. + required: true + schema: + type: string + responses: + "200": + description: successful operation + default: + description: Failed to terminate SIF Environment + content: + application/json: + schema: + type: object + properties: + error: + $ref: "#/components/errors/query/content/application~1json/sche\ + ma/properties/error" + application/xml: + schema: + type: object + properties: + error: + $ref: "#/components/errors/query/content/application~1json/sche\ + ma/properties/error" + /Providers: get: tags: - - store - summary: Returns pet inventories by status - description: Returns a map of status codes to quantities - operationId: getInventory + - Provider + summary: Default operation to get a list of all available Providers + description: Search the set of available Providers, according to the search criteria + in the URL parameters. Returns the first 20 objects located; with SIF + defined navigation headers, indicating how to retrieve subsequent sets + of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string responses: - '200': + "200": description: successful operation content: application/json: schema: type: object - additionalProperties: - type: integer - format: int32 - security: - - api_key: [] - /store/order: - post: - tags: - - store - summary: Place an order for a pet - description: '' - operationId: placeOrder - responses: - '200': - description: successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/Order' - application/xml: - schema: - $ref: '#/components/schemas/Order' - '400': - description: Invalid Order - content: - application/json: + properties: + Providers: + type: object + description: A List of Provider objects + properties: + Provider: + type: array + items: + required: + - Type + type: object + description: A recognised provider of education services in the + New Zealand education system. Providers may operate + in the Early Childhood, Compulsory Schooling or + Tertiary sectors. + properties: + MinistryOfEducationId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + AddressList: + description:

The set of postal and other addresses that + the Organisation uses

+ type: object + required: + - Address + properties: + Address: + type: array + items: + description:

This element contains address data.

+ type: object + required: + - Street + properties: + Type: + type: string + title: Address Type + description: >- +

Address type allows an address to + be categorised according to its + component structure. Address type can + be used to build processing rules for + validating, managing and presenting + addresses. Address type is independent + of the use of the address by any + party. To describe how a party may use + an address (residence, billing, term + address etc) see AddressRoleType

+ + oneOf: + - title: Thoroughfare + description: "\"

Also called 'Street' + addresses, The most general, and + widely used type of address, and + can contain the widest variety of + components

In general a + thoroughfare address will include + components for a number, a + roadname, and a locality.

+

They cannot contain any of the + components specific to a delivery + service, rural post delivery, or + water address.

These + addresses are used to find a + location.

Example: 30 - 40 + Lambton Quay, Wellington, + 6165

\"" + enum: + - TH + - title: Rural Post Delivery + description: '"

Defined by New Zealand Post, + these addresses are assigned by NZ + Post for customers who purchase a + rural delivery service (mail and + also other goods).

They + will have the same number and + roadname components as the street + address, and may have the same + region component.

They do + not have a component that + identifies the locality the + address is within. The locality + and city or town components are + replaced by components that + identify the rural delivery route + (RD number), and the town from + which the rural delivery route + starts and finishes (the mail + town). Only addresses of this + class can contain these + components.

+ Example: 121 Waitaha + Road, RD 1, Ross, 7885

"' + enum: + - RU + - title: Delivery Service + description: '"

Defined by New Zealand Post, + and used exclusively for NZ Post + services other than standard mail + delivery. Addresses in this class + include PO Box, Private Bag, and + Counter Delivery addresses.

+

Example: Private Bag + 2345, Auckland, 1142

"' + enum: + - DE + - title: Water + description: '"

Where properties have no road + access, but do have access to + water frontage (coastline or + riverbank or lakefront), a water + address uses the name of a water + feature (for example, islands, + rivers, bays, or peninsulas).

+

Example: 235 Lochmara + Bay, Queen Charlotte Sound, + Marlborough Sounds

"' + enum: + - WA + - title: Foreign Address + description: '"

A foreign address identifies + a location outside of New + Zealand.

Example: + Rudolf-Diesel-Strasse 14, 54595 + Prüm, Germany

"' + enum: + - FO + Role: + type: string + title: Address Role + description: >- +

A standardised description of the + role or usage of an address by a party + (person or organisation). Where a + party has more than one address, this + provides context for deciding which + address to use.

+ oneOf: + - title: Physical Address + description: Applies to addresses associated + with persons + enum: + - PHY + - title: Postal Address + description: Applies to addresses associated + with persons or organisations + enum: + - POS + Street: + description:

The street element is a complex + element and breaks the street down + into several parts. (Allow for PO Box + here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban addresses, + or the 'RD No' part of rural + addresses

+ City: + type: string + description:

The city part of the address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only applicable if + a non-New Zealand Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid x,y + coordinates and converted to Latitude + and Longitude values per the World + Geodetic System 1984 (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes north + of the equator are positive, + latitudes south of the equator are + negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes east of + the Prime Meridian in Greenwich + are positive, longitudes west of + the Prime Meridian are negative. + The 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

The + list may contain exactly one + StatisticalArea element for each of + the following spatial unit types:

+ + type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area + defined by Statistics New + Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + type: string + title: Spatial Unit Type + description: >- +

A classification of + geographical boundaries or + statistical areas as defined + by Statistics NZ’s + geographic hierarchy.

+ + oneOf: + - title: Area Unit + description:

Area units are + aggregations of + meshblocks. They are + non–administrative areas + that are in between + meshblocks and + territorial authorities + in size. Area units must + either define or + aggregate to define, + regional councils, + territorial authorities + and urban areas.

+ Statistics NZ + Classification of Area + Unit 2013 v1.0.0 + enum: + - AE + - title: General Electoral + District + description:

The general electoral + districts as constituted + under the Electoral Act + 1993.

Statistics NZ + General Electoral + District 2014 v1.0.0 + enum: + - GE + - title: Community Board + description:

(aka Local Board + within Auckland) Local + boards provide + governance at the local + level within Auckland + Council. They enable + democratic decision + making by, and on behalf + of communities within + the local board + area.

Statistics NZ + Community Board 2013 + v1.0.0 + enum: + - CB + - title: Māori Electoral District + description:

Māori electoral + districts are the voting + districts for + parliamentary elections + for people who choose to + be on the Māori + Electoral Roll.

+ Statistics NZ Māori + Electoral District 2014 + v1.0.0 + enum: + - ME + - title: Mesh Block + description:

A meshblock is the + smallest geographic unit + for which statistical + data is collected and + processed by Statistics + New Zealand.

A + meshblock is defined by + a geographic area, which + can vary in size from + part of a city block to + a large area of rural + land. Each meshblock + borders on another to + form a network covering + all of New Zealand, + including coasts and + inlets and extending out + to the 200-mile economic + zone.

Statistics NZ + Statistical Standard for + Meshblock 2013 v1.0.0 + enum: + - MB + - title: Regional Council + description:

The top tier of local + government in New + Zealand, defined by the + Local Government Act + 2002, which requires the + boundaries of regions to + conform as far as + possible to one or more + water catchments. When + determining regional + boundaries, the Local + Government Commission + gave consideration to + regional communities of + interest when selecting + water catchments to be + included in a region. It + also considered factors + such as natural resource + management, land use + planning and + environmental + matters.

Statistics + NZ Regional Council 2013 + v1.0.0 + enum: + - RC + - title: Territorial Authority + description:

The second tier of + local government in New + Zealand, defined under + the Local Government Act + 2002 as a city council + or district council. + There are 67 territorial + authorities consisting + of 12 city councils, 53 + districts, Auckland + Council, and Chatham + Islands Council.

+ Statistics NZ + Territorial Authority + 2013 v1.0.0 + enum: + - TA + - title: Urban Area + description: '"

Urban Areas are + statistically defined + areas with no + administrative or legal + basis. There is a three + part hierarchical + sub-division of urban + areas into: main urban + areas, secondary urban + areas, minor urban + areas. Together the + populations in main, + secondary and minor + urban areas comprise the + statistically defined + urban population of New + Zealand. The urban area + classification is + designed to identify + concentrated urban or + semi-urban settlements + without the distortions + of administrative + boundaries.

+ Statistics NZ Urban Area + 2013 v2.0.0"' + enum: + - UA + - title: Ward + description:

Wards are defined + under the Local + Electoral Act 2001 and + result from the + division, for electoral + purposes, of the + district of a + territorial authority. + The ward system was + designed to allow for + the recognition of + communities within a + district and to increase + community involvement in + the local government + system.

Statistics + NZ Ward 2013 v1.0.0 + enum: + - WA + Code: + type: string + description:

A valid value defined by + the nominated spatial unit + type, defined by Statistics + New Zealand in one of the + following statistical area + defintion standards:

+
Area Unit
+
Statistics NZ + Classification of Area Unit + 2017 v1.0.0
General + Electoral District
+
Statistics NZ General + Electoral District 2014 + v1.0.0
Community + Board
Statistics NZ + Community Board (codes 07601 + - 07621) 2018 v1.0.0
+
Māori Electoral + District
Statistics + NZ Māori Electoral District + 2014 v1.0.0
Mesh + Block
Statistics NZ + Statistical Standard for + Meshblock 2018 v1.0.0
+
Regional Council
+
Statistics NZ Regional + Council 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority 2018 + v1.0.0
Urban + Area
Statistics NZ + Urban Area 2018 v1.0.0
+
Ward
Statistics + NZ Ward 2018 v1.0.0
+
+ CommunicationChannelList: + description:

A list of one or more methods of + communication with the organisation

+ type: object + required: + - Channel + properties: + Channel: + type: array + items: + description:

A particular person or organisation's + communications method

+ type: object + required: + - Value + properties: + Type: + type: string + title: Communication Channel Type + description: >- +

A standardised method of describing + a communication channel used to + communicate with or find information + about a party. Provides a more generic + definition than phone and email. + Intended to provide for future + requirements to record social network + channels, eg Facebook & Twitter + identifiers for a school.

+ oneOf: + - title: Website + description: Typically refers to the home page + for an entity + enum: + - WEB + - title: Twitter + description: Twitter handle + enum: + - TWT + - title: Facebook + description: Facebook page + enum: + - FBK + Value: + type: string + description: "

The unique value that provides + access to the channel. eg: URL for a + website; Facebook page addess, Twitter + handle.

" + ContactList: + description:

A list of one or more cotact persons related + to the organisation

+ type: object + required: + - Contact + properties: + Contact: + type: array + items: + description:

A particular person's contact + details

+ type: object + required: + - Name + properties: + Name: + description:

The contact's name

+ type: object + properties: + Title: + type: string + description:

A title or prefix associated + with the name.

+ FamilyName: + type: string + description:

Also known as Last Name, + although some cultures may not + present a family name as the last + name.

+ GivenName: + type: string + description:

Also known as First Name, + although some cultures may not + present this name as the first + element in a name. May contain a + composite of all given names.

+ MiddleName: + type: string + description:

Where more than one Given Name, + these may be combined in one + composite field or else populated + in several elements.

+ FamilyNameFirst: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, + no, unknown and not provided + values.

+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PreferredFamilyName: + type: string + description:

A preferred version of the + Family Name. Note:A name cannot + have both a Preferred Family and + Preferred Given Name within the + same Name structure – only one of + these fields should be populated. + If a person does have both a + Preferred Family and Preferred + Given Name then this must be + populated as a separate Name of + type ‘Preferred’.

+ PreferredFamilyNameFirst: + $ref: "#/paths/~1Providers/get/response\ + s/200/content/application~1json/s\ + chema/properties/Providers/proper\ + ties/Provider/items/properties/Co\ + ntactList/properties/Contact/item\ + s/properties/Name/properties/Fami\ + lyNameFirst" + PreferredGivenName: + type: string + description: "

A preferred version of the + Given Name. Note: A name cannot + have both a Preferred Family and + Preferred Given Name within the + same Name structure – only one of + these fields should be populated. + If a person does have both a + Preferred Family and Preferred + Given Name then this must be + populated as a separate Name of + type ‘Preferred’.

" + Suffix: + type: string + description:

Textual suffix like PHD, JP, + BSc.

+ FullName: + type: string + description:

A combination of all name + elements as one composite text + element

+ Type: + type: string + title: Name Usage Type + description: >- +

A standardised method of + describing the usage of a name by + a person. Where a person has more + than one current name, the usage + type indicates which name may be + used according to the purpose.

+

Code values are based on SIF + Australia 3.4.

+ oneOf: + - title: Preferred Name + description:

The name by which an + individual prefers to be known + and addressed.

Only + usage type applicable for + student name usage (other + types are not supported by + NSI).

+ enum: + - PRF + - title: Foreign Official Name + description:

Included for future usage + in NZ, especially for tertiary + students.

+ enum: + - FON + - title: Previous name + enum: + - PRV + - title: Also Known As + description: AKA or Alias + enum: + - AKA + - title: Name at Birth + enum: + - BTH + - title: Legal Name + description:

Legal Name or Official Name + as defined by the organisation + which collects it (legal name + is not defined in this + standard)

+ enum: + - LGL + IsVerified: + $ref: "#/paths/~1Providers/get/response\ + s/200/content/application~1json/s\ + chema/properties/Providers/proper\ + ties/Provider/items/properties/Co\ + ntactList/properties/Contact/item\ + s/properties/Name/properties/Fami\ + lyNameFirst" + PositionTitle: + type: string + description:

The title the contact has within + the Organisation being contacted

+ Role: + type: string + title: Organisation Contact Role + description: >- +

The role played by a person in an + organisation where that person is + recorded as a contact. The role + definition is used to recognise + similar functions across + organisations, however individuals + with the same role may be given + different position titles that differ + from the generic role description. For + example, a principal may have a title + of ‘headmaster’.

+ oneOf: + - title: Principal + enum: + - PRI + - title: Acting Principal + enum: + - ACT + - title: Director + enum: + - DIR + - title: ECE Management Contact + enum: + - ECE + AddressList: + description:

A list of Address elements.

+ type: object + required: + - Address + properties: + Address: + type: array + items: + description:

This element contains address + data.

+ type: object + required: + - Street + properties: + Type: + $ref: "#/paths/~1Providers/get/re\ + sponses/200/content/applica\ + tion~1json/schema/propertie\ + s/Providers/properties/Prov\ + ider/items/properties/Addre\ + ssList/properties/Address/i\ + tems/properties/Type" + Role: + $ref: "#/paths/~1Providers/get/re\ + sponses/200/content/applica\ + tion~1json/schema/propertie\ + s/Providers/properties/Prov\ + ider/items/properties/Addre\ + ssList/properties/Address/i\ + tems/properties/Role" + Street: + description:

The street element is a + complex element and breaks + the street down into several + parts. (Allow for PO Box + here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' + part of rural addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province + code. StateTerritory Code + only applicable if a non-New + Zealand Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude + of the location. Grid + location values are derived + from New Zealand Map Grid + x,y coordinates and + converted to Latitude and + Longitude values per the + World Geodetic System 1984 + (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

+ Latitudes north of the + equator are positive, + latitudes south of the + equator are negative + [ISO 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

+

Longitudes east of + the Prime Meridian in + Greenwich are positive, + longitudes west of the + Prime Meridian are + negative. The 180th + meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical + Areas containing the + location.

The list + may contain exactly one + StatisticalArea element for + each of the following + spatial unit types:

+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular + statistical area + defined by Statistics + New Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + $ref: "#/paths/~1Provid\ + ers/get/responses/2\ + 00/content/applicat\ + ion~1json/schema/pr\ + operties/Providers/\ + properties/Provider\ + /items/properties/A\ + ddressList/properti\ + es/Address/items/pr\ + operties/Statistica\ + lAreaList/propertie\ + s/StatisticalArea/i\ + tems/properties/Spa\ + tialUnitType" + Code: + type: string + description:

A valid value + defined by the + nominated spatial + unit type, defined + by Statistics New + Zealand in one of + the following + statistical area + defintion + standards:

+
Area Unit
+
Statistics NZ + Classification of + Area Unit 2017 + v1.0.0
+
General + Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community + Board
+
Statistics NZ + Community Board + (codes 07601 - + 07621) 2018 + v1.0.0
+
Māori Electoral + District
+
Statistics NZ + Māori Electoral + District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard + for Meshblock 2018 + v1.0.0
+
Regional + Council
+
Statistics NZ + Regional Council + 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial + Authority 2018 + v1.0.0
+
Urban Area
+
Statistics NZ + Urban Area 2018 + v1.0.0
+
Ward
+
Statistics NZ + Ward 2018 + v1.0.0
+ EmailList: + description:

List of Email elements.

+ type: object + required: + - Email + properties: + Email: + type: array + items: + description:

This element represents an + e-mail address of one of a + number of types and occurs in + objects such as StudentPersonal, + StaffPersonal, + StudentContactPersonal, etc. +

+ type: object + required: + - Address + properties: + Type: + type: string + title: Email Type + description: >- +

A standardised method of + describing an electronic + mail address used as contact + method by a party. Where a + party has more than one + email address, this may + provide context for deciding + which email address to + use.

+ oneOf: + - title: Primary + description: Applicable to + organisations, eg + schools + enum: + - PRIM + - title: Work + description: Only used for persons + enum: + - WORK + - title: Personal + description: Only used for persons + enum: + - PERS + - title: Alternate 1 + enum: + - ALT1 + - title: Alternate 2 + enum: + - ALT2 + - title: Alternate 3 + enum: + - ALT3 + - title: Alternate 4 + enum: + - ALT4 + Address: + type: string + description:

The actual email + address.

+ PhoneNumberList: + description:

List of PhoneNumber elements.

+ type: object + required: + - PhoneNumber + properties: + PhoneNumber: + type: array + items: + description:

This element represents a + phone number and occurs within + objects such as StudentPersonal, + StaffPersonal, etc.

+ type: object + required: + - Number + properties: + Type: + type: string + title: Telephone Number Type + description: >- +

A standardised method of + describing a + telecommunications device + used as contact method by a + party. Where a party has + more than one phone number, + this may provide context for + deciding which number to + use.

+ oneOf: + - title: Main Telephone Number + enum: + - MAI + - title: Facsimile Number + enum: + - FAX + - title: Home Telephone Number + description: Person usage only + enum: + - HTE + - title: Home Mobile + description: Person usage only + enum: + - HMO + - title: Mobile + enum: + - MOB + - title: Work Mobile + enum: + - WMO + - title: Work Telephone Number + enum: + - WTE + Number: + type: string + description: "

Phone number. Free-form, + but typical New Zealand + formats include:

" + Extension: + type: string + description:

Phone number + extension.

+ ListedStatus: + $ref: "#/paths/~1Providers/get/re\ + sponses/200/content/applica\ + tion~1json/schema/propertie\ + s/Providers/properties/Prov\ + ider/items/properties/Conta\ + ctList/properties/Contact/i\ + tems/properties/Name/proper\ + ties/FamilyNameFirst" + EducationRegion: + type: string + title: Education Region + description: >- + Regions of New Zealand defined by Ministry of + Education for administrative purposes. + oneOf: + - title: Tai Tokerau + enum: + - TAIT + - title: Auckland + enum: + - AUCK + - title: Waikato + enum: + - WAIK + - title: Bay of Plenty, Waiariki + enum: + - BOPW + - title: Hawke's Bay, Tairāwhiti + enum: + - HAWK + - title: Taranaki, Whanganui, Manawatū + enum: + - TARA + - title: Wellington + enum: + - WELL + - title: Nelson, Marlborough, West Coast + enum: + - NELS + - title: Canterbury, Chatham Islands + enum: + - CANT + - title: Otago, Southland + enum: + - OTAG + EmailList: + description:

The set of contact email addresses that the + Organisation uses

+ type: object + required: + - Email + properties: + Email: + type: array + items: + description:

This element represents an e-mail + address of one of a number of types and + occurs in objects such as StudentPersonal, + StaffPersonal, StudentContactPersonal, + etc.

+ type: object + required: + - Address + properties: + Type: + $ref: "#/paths/~1Providers/get/responses/20\ + 0/content/application~1json/schema/pr\ + operties/Providers/properties/Provide\ + r/items/properties/ContactList/proper\ + ties/Contact/items/properties/EmailLi\ + st/properties/Email/items/properties/\ + Type" + Address: + type: string + description:

The actual email address.

+ EntityClose: + type: string + format: date + description:

Closing date of entity. Only present for + closed providers.

+ EntityOpen: + type: string + format: date + description:

Opening date of entity. For proposed schools + this will be the projected opening date. For + open schools this may not be present.

+ LocationList: + description:

A list of one or more locations, from which + the organisation operates or provides a + service.

+ type: object + required: + - Location + properties: + Location: + type: array + items: + description:

This element contains data about a + geographical location.

+ type: object + properties: + Description: + type: string + description:

A description for the Location.

+ Address: + description:

The physical address of the + Location

+ type: object + required: + - Street + properties: + Type: + $ref: "#/paths/~1Providers/get/response\ + s/200/content/application~1json/s\ + chema/properties/Providers/proper\ + ties/Provider/items/properties/Ad\ + dressList/properties/Address/item\ + s/properties/Type" + Role: + $ref: "#/paths/~1Providers/get/response\ + s/200/content/application~1json/s\ + chema/properties/Providers/proper\ + ties/Provider/items/properties/Ad\ + dressList/properties/Address/item\ + s/properties/Role" + Street: + description:

The street element is a complex + element and breaks the street down + into several parts. (Allow for PO + Box here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' part of + rural addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only + applicable if a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid + x,y coordinates and converted to + Latitude and Longitude values per + the World Geodetic System 1984 + (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes + north of the equator are + positive, latitudes south of + the equator are negative [ISO + 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes + east of the Prime Meridian in + Greenwich are positive, + longitudes west of the Prime + Meridian are negative. The + 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

+

The list may contain exactly + one StatisticalArea element for + each of the following spatial unit + types:

+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical + area defined by Statistics + New Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + $ref: "#/paths/~1Providers/ge\ + t/responses/200/content\ + /application~1json/sche\ + ma/properties/Providers\ + /properties/Provider/it\ + ems/properties/AddressL\ + ist/properties/Address/\ + items/properties/Statis\ + ticalAreaList/propertie\ + s/StatisticalArea/items\ + /properties/SpatialUnit\ + Type" + Code: + type: string + description:

A valid value defined + by the nominated spatial + unit type, defined by + Statistics New Zealand + in one of the following + statistical area + defintion standards:

+
Area Unit
+
Statistics NZ + Classification of Area + Unit 2017 v1.0.0
+
General Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community Board
+
Statistics NZ + Community Board (codes + 07601 - 07621) 2018 + v1.0.0
Māori + Electoral District
+
Statistics NZ Māori + Electoral District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard for + Meshblock 2018 + v1.0.0
Regional + Council
+
Statistics NZ + Regional Council 2018 + v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority + 2018 v1.0.0
+
Urban Area
+
Statistics NZ Urban + Area 2018 v1.0.0
+
Ward
+
Statistics NZ Ward + 2018 v1.0.0
+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid x,y + coordinates and converted to Latitude + and Longitude values per the World + Geodetic System 1984 (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes north + of the equator are positive, + latitudes south of the equator are + negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes east of + the Prime Meridian in Greenwich + are positive, longitudes west of + the Prime Meridian are negative. + The 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

The + list may contain exactly one + StatisticalArea element for each of + the following spatial unit types:

+ + type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area + defined by Statistics New + Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + $ref: "#/paths/~1Providers/get/re\ + sponses/200/content/applica\ + tion~1json/schema/propertie\ + s/Providers/properties/Prov\ + ider/items/properties/Addre\ + ssList/properties/Address/i\ + tems/properties/Statistical\ + AreaList/properties/Statist\ + icalArea/items/properties/S\ + patialUnitType" + Code: + type: string + description:

A valid value defined by + the nominated spatial unit + type, defined by Statistics + New Zealand in one of the + following statistical area + defintion standards:

+
Area Unit
+
Statistics NZ + Classification of Area Unit + 2017 v1.0.0
General + Electoral District
+
Statistics NZ General + Electoral District 2014 + v1.0.0
Community + Board
Statistics NZ + Community Board (codes 07601 + - 07621) 2018 v1.0.0
+
Māori Electoral + District
Statistics + NZ Māori Electoral District + 2014 v1.0.0
Mesh + Block
Statistics NZ + Statistical Standard for + Meshblock 2018 v1.0.0
+
Regional Council
+
Statistics NZ Regional + Council 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority 2018 + v1.0.0
Urban + Area
Statistics NZ + Urban Area 2018 v1.0.0
+
Ward
Statistics + NZ Ward 2018 v1.0.0
+
+ Name: + type: string + description:

The normal business name of the + Organisation

+ PhoneNumberList: + description:

The set of contact phone numbers that the + Organisation uses

+ type: object + required: + - PhoneNumber + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone number + and occurs within objects such as + StudentPersonal, StaffPersonal, etc.

+ type: object + required: + - Number + properties: + Type: + $ref: "#/paths/~1Providers/get/responses/20\ + 0/content/application~1json/schema/pr\ + operties/Providers/properties/Provide\ + r/items/properties/ContactList/proper\ + ties/Contact/items/properties/PhoneNu\ + mberList/properties/PhoneNumber/items\ + /properties/Type" + Number: + type: string + description: "

Phone number. Free-form, but + typical New Zealand formats + include:

" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1Providers/get/responses/20\ + 0/content/application~1json/schema/pr\ + operties/Providers/properties/Provide\ + r/items/properties/ContactList/proper\ + ties/Contact/items/properties/Name/pr\ + operties/FamilyNameFirst" + RelatedOrganisationList: + description:

A list of other organisations that are + related to the Provider

+ type: object + required: + - RelatedOrganisation + properties: + RelatedOrganisation: + type: array + items: + description:

Extends + ObjectReferenceType to add an + extra element, + OrganisationType, describing + the nature of the related + organisation.

+ type: object + required: + - ObjectType + - Type + properties: + StartDate: + type: string + format: date + description:

The start date of the relationship + between the two organisations

+ EndDate: + type: string + format: date + description:

The end date of the relationship + between the two organisations

+ Type: + type: string + title: Organisation Relationship Type + description: >- +

A code describing the nature of the + relationship between a pair of + Organisations

+ oneOf: + - title: Teen Parent Unit + description: Related organisation is a Teen + Parent Unit co-located with the + main Organisation. + enum: + - TPU + - title: Activity Centre + description: Related organisation is an + Activity Centre co-located with + the main Organisation. + enum: + - ACR + - title: MoE Local Office + description: Related organisation is Ministry + of Education Local Office that + deals with the Provider. + enum: + - MOE + - title*: + en: Community of Learning + mi: Kāhui Ako + description: Related organisation is the + Community of Learning / Kāhui Ako + that the main Organisation is a + member of + enum: + - COL + OperationalStatus: + type: string + title: Operational Status + description: >- +

Indicates the operational status of an + organisation.

+ oneOf: + - title: Closed + enum: + - C + - title: Open + enum: + - O + - title: Proposed + description: SIF AU uses the term ‘Pending’ + enum: + - P + Type: + type: string + title: Organisation Type + description: >- + Describes the organisation type of the provider, + indicating the services provided, function or + purpose of the organisation. plus 1 more value(s) at NZCodeSetsOrganisationTypeType + oneOf: + - title: Composite School (Year 1-15) + enum: + - "32" + - title: Contributing Primary (Year 1-6) + enum: + - "21" + - title: The Correspondence School + enum: + - "34" + - title: Full Primary (Year 1-8) + enum: + - "20" + - title: Intermediate (Year 7-8) + enum: + - "22" + - title: Restricted Composite School (Year 7-10) + enum: + - "35" + - title: Secondary School (Year 7-15) + enum: + - "30" + - title: Secondary School (Year 9-15) + enum: + - "40" + - title: Special School + enum: + - "23" + - title: Teen Parent Unit (Year 9-15) + enum: + - "41" + - title: Activity Centre + enum: + - "997" + - title: Community of Learning | Kāhui Ako + enum: + - "998" + - title: Ministry of Education Local Office + enum: + - "999" + ProviderRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + ProviderLocalId: + $ref: "#/paths/~1Providers/get/responses/200/content/\ + application~1json/schema/properties/Providers/p\ + roperties/Provider/items/properties/MinistryOfE\ + ducationId" + Authority: + type: string + title: Provider Authority + description: >- + The authority by which the provider is + authorised to provide education services. + Describes the ownership/operation or + registration status of an educational + institution.
    +
  • 'STATE' - State
    • +
  • 'STINT' - State: Integrated
    • +
  • 'PRFUL' - Private: Fully Registered
    • +
  • 'PRPRO' - Private: Provisionally Registered
    • +
  • 'OTVOT' - Other: Vote Education
    • +
  • 'PASCH' - Partnership School
    • +
+ oneOf: + - title: State + description: "\"Also known as 'State: Non-Integrated'\"" + enum: + - STATE + - title: "State: Integrated" + enum: + - STINT + - title: "Private: Fully Registered" + enum: + - PRFUL + - title: "Private: Provisionally Registered" + enum: + - PRPRO + - title: "Other: Vote Education" + description: Owned by another organisation, funded from + Vote Education. + enum: + - OTVOT + - title: Partnership School + enum: + - PASCH + SchoolService: + description:

Only present if the Provider is a provider of + school education services. Contains properties + that are school-specific.

+ type: object + properties: + CoEdStatus: + type: string + title: School Co-Ed Status + description: >- +

A summary description of the gender of + students that a school accepts, indicating + the type of school from a gender + perspective.

    +
  • 'COED' - Co-Educational
    • +
  • 'GIRL' - Girls School
    • +
  • 'BOYS' - Boys School
    • +
  • 'PRCO' - Primary Co-Ed, Secondary Girls
    • +
  • 'JUBO' - Junior Boys, Senior Co-Ed
    • +
+ oneOf: + - title: Co-Educational + enum: + - COED + - title: Girls School + enum: + - GIRL + - title: Boys School + enum: + - BOYS + - title: Primary Co-Ed, Secondary Girls + enum: + - PRCO + - title: Junior Boys, Senior Co-Ed + enum: + - JUBO + Decile: + type: integer + description:

A description of the socio-economic + position of a school's student community + according to the MoE decile rating system. +

+ NewEntrantPolicyList: + description:

A list of recognised policy choices + adopted by the School.

+ type: object + required: + - EnactedPolicy + properties: + EnactedPolicy: + type: array + items: + description:

A descriptor for a particular + enacted policy that has been adopted + by a school.

+ type: object + required: + - Policy + properties: + EffectiveFrom: + type: string + format: date + description:

The date from which the school + adopted the policy. If not + populated then this is the + current/original policy of the + school.

+ EffectiveTo: + type: string + format: date + description:

The date after which the school + has no longer adopted the policy. + If not populated then the school + has no planned date to end the + policy.

+ Policy: + type: string + title: Enacted Policy + description: >- +

A policy that a school may + choose to implement as part of its + operating rules. For example, + policies may concern student + behaviour, clothing/appearance, + wellbeing and new entrant + enrolment.

    +
  • 'AE' - Age Entry
    • +
  • 'CE' - Cohort Entry
    • +
+ oneOf: + - title: Age Entry + description: Indicates that new starters + will start on the next school + day following their 5 + birthday. + enum: + - AE + - title: Cohort Entry + description: Indicates that new starters + will start in a cohort group + only on specific notified + dates after their 5th + birthday. + enum: + - CE + DefinitionList: + description:

A list of School definition descriptors + that further describe the nature of a + school

+ type: object + required: + - Definition + properties: + Definition: + type: array + items: + type: string + title: School Definition + description: >- +

A school-specific definition of a + provider, describing the school + according to specialist services or + facilities that it provides for + students or for teaching staff.

+
    +
  • 'DCSC' - Designated Character School
    • +
  • 'SMBS' - Secondary Māori Boarding School
    • +
  • 'BISC' - Bilingual School
    • +
  • 'KKMA' - Kura Kaupapa Māori
    • +
  • 'CYBS' - Contributing with Year 7 & 8 Bilingual Students
    • +
  • 'SWBF' - School with Boarding Facilities
    • +
  • 'SFVI' - School for Vision Impaired
    • +
  • 'SDHI' - School for Deaf/Hearing Impaired
    • +
  • 'SFPD' - School for Physical Disabilities
    • +
  • 'SFII' - School for Intellectual Impairments
    • +
  • 'SLSD' - School for Learning/Social Difficulties
    • +
  • 'RHSC' - Regional Health School
    • +
plus 3 more value(s) at NZCodeSetsSchoolDefinitionType + oneOf: + - title: Designated Character School + enum: + - DCSC + - title: Secondary Māori Boarding School + enum: + - SMBS + - title: Bilingual School + description: '"Historic: Not to be used"' + enum: + - BISC + - title: Kura Kaupapa Māori + enum: + - KKMA + - title: Contributing with Year 7 & 8 + Bilingual Students + description: Contributing School - but is able + to retain Y7 & 8 bilingual + students + enum: + - CYBS + - title: School with Boarding Facilities + enum: + - SWBF + - title: School for Vision Impaired + enum: + - SFVI + - title: School for Deaf/Hearing Impaired + enum: + - SDHI + - title: School for Physical Disabilities + enum: + - SFPD + - title: School for Intellectual Impairments + enum: + - SFII + - title: School for Learning/Social + Difficulties + enum: + - SLSD + - title: Regional Health School + enum: + - RHSC + - title: Normal School + description: A school with extra resources for + teacher training purposes + enum: + - NORM + - title: Model School + description: Set up like a rural school, for + teacher training purposes + enum: + - MODE + - title: Normal School (Model Classes) + description: Normal School with Model Classes + enum: + - MSMC + SchoolYearList: + description:

A list of SchoolYear + elements describing the genders of students + accepted for enrolment at each year + level.

+ type: object + required: + - SchoolYear + properties: + SchoolYear: + type: array + items: + description:

A descriptor for a particular Year + Level offered by the school, including + detail of the gender of students that + are accepted for enrolment in this + year level.

+ type: object + required: + - Gender + - YearLevel + properties: + YearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values + that are valid for describing + Funding Year Level and Current + Year Level for a student + enrolment.

Current Year + Level indicates the year level of + the student’s class cohort and the + level at which the student spends + most of their time at school. + While a student may be enrolled in + subjects at varying instructional + year levels, in relation to the + student enrolment this value + represents the year level at which + the student is considered to be + predominantly taught.

+

Funding Year Level measures the + actual number of years that the + student has attended a school. It + provides the Ministry with a + method of counting students for + funding purposes which is + independent of the way schools are + organised or the particular + programme of study that a student + may undertake. Funding Year Level + for most students is based on the + date they first started + school.

School Year Level + is used to indicate the + instructional year levels offered + by a school, i.e. those years for + which student enrolments may be + accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year + Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this + code indicates Year 14 and + above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year + Level + enum: + - "15" + Gender: + type: string + title: Schooling Gender + description: >- +

A description of the gender of + students that the school accepts + at a certain year level or other + instructional grouping.

+ For use at the year level or + course only, rather than school + level. For instance a school may + accept boys only in year 11 but + both girls and boys at years 12 + and 13.

    +
  • 'C' - Both Girls and Boys
    • +
  • 'F' - Girls Only
    • +
  • 'M' - Boys Only
    • +
+ oneOf: + - title: Both Girls and Boys + enum: + - C + - title: Girls Only + enum: + - F + - title: Boys Only + enum: + - M + TechnologyCentreName: + description: "The name of the Technology Centre that is + run as part of the School; Eg: Marlborough + Technology Centre is run as part of Bohally + Intermediate School." + ECEService: + description:

Only present if the Provider is a provider of + early childhood education services. Contains + properties that are ECE specific.

+ type: object + required: + - Type + properties: + Type: + type: string + title: ECEService Type + description: >- +

Codes denoting the nature of an Early + Childhood Education service.

    +
  • 'KG' - Kindergarten
    • +
  • 'PC' - Playcentre
    • +
  • 'KR' - Te Kohanga Reo
    • +
+ oneOf: + - title: Kindergarten + enum: + - KG + - title: Playcentre + enum: + - PC + - title: Te Kohanga Reo + enum: + - KR + TertiarySerice: + type: string + description:

Only present if the Provider is a provider of + tertiary education services. Contains properties + that are Tertiary Education specific.

A + placeholder for future expansion

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] example: - status: 400 - message: "Invalid Order" - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Order' - description: order placed for purchasing the pet - required: true - '/store/order/{orderId}': - get: - tags: - - store - summary: Find purchase order by ID - description: >- - For valid response try integer IDs with value <= 5 or > 10. Other values - will generated exceptions - operationId: getOrderById - parameters: - - name: orderId - in: path - description: ID of pet that needs to be fetched - required: true - schema: - type: integer - format: int64 - minimum: 1 - maximum: 5 - responses: - '200': - description: successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/Order' + Providers: + Provider: + - AddressList: + Address: + - Type: RU + Role: PHY + Street: + Line1: 1175 Lake Ferry Rd + Suburb: RD 1 + City: Martinborough + CommunicationChannelList: + Channel: + - Notes: Attendance System (Self Service) + Type: WEB + Value: http://att.hogwarts.school.nz + - Notes: School Website + Type: WEB + Value: http://www.hogwarts.school.nz + ContactList: + Contact: + - Name: + FamilyName: Dumbledore + GivenName: Albus + FullName: Albus Dumbledore + PositionTitle: Headmaster + Role: PRI + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + - Name: + FamilyName: Hagrid + GivenName: Rubeus + FullName: Rubeus Hagrid + PositionTitle: Gamekeeper + Role: DIR + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + EducationRegion: TAIT + EmailList: + Email: + - Type: PRIM + Address: stuart@gmail.com + EntityOpen: 1652-04-01 + LocationList: + Location: + - Description: Only Campus + Address: + Type: RU + Role: PHY + Street: + 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 + PhoneNumberList: + PhoneNumber: + - Notes: Attendance Office (Automated) + Usage: SMS + Type: WTE + Number: (0274) 300 9991 + - Notes: Attendance Office + Usage: INT + Type: WTE + Number: (04) 300 9992 + - Notes: School Secretary DDI + Type: WTE + Number: (04) 300 9993 + RelatedOrganisationList: + RelatedOrganisation: + - RefId: 0951bacf-fc88-4ed6-8113-11a6d6335c07 + LocalId: "99102" + Name: Tai Tokerau + ObjectType: Organisation + StartDate: 2012-10-31 + Type: MOE + - RefId: ac0871d9-6562-4209-ae86-abdb3661842b + LocalId: "99204" + Name: Masterton (Whakaoriori) Kāhui Ako + ObjectType: Organisation + StartDate: 2012-04-30 + Type: COL + OperationalStatus: O + Type: 21 + ProviderRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + ProviderLocalId: "01011234" + Authority: STATE + SchoolService: + CoEdStatus: COED + Decile: 5 + NewEntrantPolicyList: + EnactedPolicy: + - EffectiveTo: 2018-12-31 + Policy: AE + - EffectiveFrom: 2019-01-01 + Policy: CE + DefinitionList: + Definition: + - SMBS + - KKMA + - SWBF + 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 application/xml: schema: - $ref: '#/components/schemas/Order' - '400': - description: Invalid ID supplied - '404': - description: Order not found - delete: - tags: - - store - summary: Delete purchase order by ID - description: >- - For valid response try integer IDs with value < 1000. Anything above - 1000 or nonintegers will generate API errors - operationId: deleteOrder - parameters: - - name: orderId - in: path - description: ID of the order that needs to be deleted - required: true - schema: - type: string - minimum: 1 - responses: - '400': - description: Invalid ID supplied - '404': - description: Order not found - /user: + type: object + properties: + Providers: + type: object + description: A List of Provider objects + properties: + Provider: + type: array + items: + $ref: "#/paths/~1Providers/get/responses/200/content/appl\ + ication~1json/schema/properties/Providers/propertie\ + s/Provider/items" + example: "$ref: '../examples/Provider.yaml#/getList/xml'" + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/Providers/{ProviderRefId}": post: tags: - - user - summary: Create user - description: This can only be done by the logged in user. - operationId: createUser - responses: - default: - description: successful operation - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/User' - description: Created user object - required: true - '/user/{username}': - get: - tags: - - user - summary: Get user by user name - description: '' - operationId: getUserByName + - Provider + summary: Default operation to create a single Provider parameters: - - name: username + - name: ProviderRefId in: path - description: 'The name that needs to be fetched. Use user1 for testing. ' + description:

The SIF GUID used by systems to identify the organisation.

required: true schema: type: string + operationId: createProvider + requestBody: + description: CRUD operation on Provider + content: + application/json: + schema: + type: object + properties: + Provider: + $ref: "#/paths/~1Providers/get/responses/200/content/application~\ + 1json/schema/properties/Providers/properties/Provider/items" + example: + Provider: + AddressList: + Address: + - Type: RU + Role: PHY + Street: + Line1: 1175 Lake Ferry Rd + Suburb: RD 1 + City: Martinborough + CommunicationChannelList: + Channel: + - Notes: Attendance System (Self Service) + Type: WEB + Value: http://att.hogwarts.school.nz + - Notes: School Website + Type: WEB + Value: http://www.hogwarts.school.nz + ContactList: + Contact: + - Name: + FamilyName: Dumbledore + GivenName: Albus + FullName: Albus Dumbledore + PositionTitle: Headmaster + Role: PRI + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + - Name: + FamilyName: Hagrid + GivenName: Rubeus + FullName: Rubeus Hagrid + PositionTitle: Gamekeeper + Role: DIR + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + EducationRegion: TAIT + EmailList: + Email: + - Type: PRIM + Address: stuart@gmail.com + EntityOpen: 1652-04-01 + LocationList: + Location: + - Description: Only Campus + Address: + Type: RU + Role: PHY + Street: + 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 + PhoneNumberList: + PhoneNumber: + - Notes: Attendance Office (Automated) + Usage: SMS + Type: WTE + Number: (0274) 300 9991 + - Notes: Attendance Office + Usage: INT + Type: WTE + Number: (04) 300 9992 + - Notes: School Secretary DDI + Type: WTE + Number: (04) 300 9993 + RelatedOrganisationList: + RelatedOrganisation: + - RefId: 0951bacf-fc88-4ed6-8113-11a6d6335c07 + LocalId: "99102" + Name: Tai Tokerau + ObjectType: Organisation + StartDate: 2012-10-31 + Type: MOE + - RefId: ac0871d9-6562-4209-ae86-abdb3661842b + LocalId: "99204" + Name: Masterton (Whakaoriori) Kāhui Ako + ObjectType: Organisation + StartDate: 2012-04-30 + Type: COL + OperationalStatus: O + Type: 21 + ProviderRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + ProviderLocalId: "01011234" + Authority: STATE + SchoolService: + CoEdStatus: COED + Decile: 5 + NewEntrantPolicyList: + EnactedPolicy: + - EffectiveTo: 2018-12-31 + Policy: AE + - EffectiveFrom: 2019-01-01 + Policy: CE + DefinitionList: + Definition: + - SMBS + - KKMA + - SWBF + 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 + application/xml: + schema: + type: object + properties: + Provider: + $ref: "#/paths/~1Providers/get/responses/200/content/application~\ + 1json/schema/properties/Providers/properties/Provider/items" + example: "$ref: '../examples/Provider.yaml#/post/xml'" responses: - '200': - description: successful operation - content: - application/json: - schema: - $ref: '#/components/schemas/User' - application/xml: - schema: - $ref: '#/components/schemas/User' - '400': - description: Invalid username supplied - '404': - description: User not found + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" put: tags: - - user - summary: Updated user - description: This can only be done by the logged in user. - operationId: updateUser + - Provider + summary: Default operation to update a single Provider parameters: - - name: username + - name: ProviderRefId in: path - description: name that need to be deleted + description:

The SIF GUID used by systems to identify the organisation.

required: true schema: type: string - responses: - '400': - description: Invalid user supplied - '404': - description: User not found + operationId: updateProvider requestBody: + description: CRUD operation on Provider content: application/json: schema: - $ref: '#/components/schemas/User' - description: Updated user object - required: true - delete: - tags: - - user - summary: Delete user - description: This can only be done by the logged in user. - operationId: deleteUser - parameters: - - name: username - in: path - description: The name that needs to be deleted - required: true - schema: - type: string - responses: - '400': - description: Invalid username supplied - '404': - description: User not found - /user/createWithArray: - post: - tags: - - user - summary: Creates list of users with given input array - description: '' - operationId: createUsersWithArrayInput + type: object + properties: + Provider: + type: object + description: A recognised provider of education services in the New + Zealand education system. Providers may operate in the Early + Childhood, Compulsory Schooling or Tertiary sectors. + properties: + MinistryOfEducationId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + AddressList: + description:

The set of postal and other addresses that the + Organisation uses

+ type: object + properties: + Address: + type: array + items: + description:

This element contains address data.

+ type: object + properties: + Type: + type: string + title: Address Type + description: >- +

Address type allows an address to be + categorised according to its component + structure. Address type can be used to build + processing rules for validating, managing and + presenting addresses. Address type is + independent of the use of the address by any + party. To describe how a party may use an + address (residence, billing, term address etc) + see AddressRoleType

    +
  • 'TH' - Thoroughfare
    • +
  • 'RU' - Rural Post Delivery
    • +
  • 'DE' - Delivery Service
    • +
  • 'WA' - Water
    • +
  • 'FO' - Foreign Address
    • +
+ oneOf: + - title: Thoroughfare + description: "\"

Also called 'Street' addresses, The + most general, and widely used type of + address, and can contain the widest + variety of components

In general a + thoroughfare address will include + components for a number, a roadname, and a + locality.

They cannot contain any + of the components specific to a delivery + service, rural post delivery, or water + address.

These addresses are used + to find a location.

Example: 30 - + 40 Lambton Quay, Wellington, 6165

\"" + enum: + - TH + - title: Rural Post Delivery + description: '"

Defined by New Zealand Post, these + addresses are assigned by NZ Post for + customers who purchase a rural delivery + service (mail and also other goods).

+

They will have the same number and + roadname components as the street address, + and may have the same region + component.

They do not have a + component that identifies the locality the + address is within. The locality and city + or town components are replaced by + components that identify the rural + delivery route (RD number), and the town + from which the rural delivery route starts + and finishes (the mail town). Only + addresses of this class can contain these + components.

Example: 121 + Waitaha Road, RD 1, Ross, 7885

"' + enum: + - RU + - title: Delivery Service + description: '"

Defined by New Zealand Post, and used + exclusively for NZ Post services other + than standard mail delivery. Addresses in + this class include PO Box, Private Bag, + and Counter Delivery addresses.

+ Example: Private Bag 2345, + Auckland, 1142

"' + enum: + - DE + - title: Water + description: '"

Where properties have no road access, + but do have access to water frontage + (coastline or riverbank or lakefront), a + water address uses the name of a water + feature (for example, islands, rivers, + bays, or peninsulas).

+ Example: 235 Lochmara Bay, Queen + Charlotte Sound, Marlborough Sounds

"' + enum: + - WA + - title: Foreign Address + description: '"

A foreign address identifies a + location outside of New Zealand.

+ Example: Rudolf-Diesel-Strasse + 14, 54595 Prüm, Germany

"' + enum: + - FO + Role: + type: string + title: Address Role + description: >- +

A standardised description of the role or + usage of an address by a party (person or + organisation). Where a party has more than one + address, this provides context for deciding + which address to use.

    +
  • 'PHY' - Physical Address
    • +
  • 'POS' - Postal Address
    • +
+ oneOf: + - title: Physical Address + description: Applies to addresses associated with + persons + enum: + - PHY + - title: Postal Address + description: Applies to addresses associated with + persons or organisations + enum: + - POS + Street: + description:

The street element is a complex element and + breaks the street down into several parts. + (Allow for PO Box here)

+ type: object + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban addresses, or the + 'RD No' part of rural addresses

+ City: + type: string + description:

The city part of the address.

+ StateProvince: + type: string + description:

The state or province code. StateTerritory + Code only applicable if a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the location. + Grid location values are derived from New + Zealand Map Grid x,y coordinates and converted + to Latitude and Longitude values per the World + Geodetic System 1984 (G1762)

+ type: object + properties: + Latitude: + description:

Latitude in decimal degrees.

+ Latitudes north of the equator are + positive, latitudes south of the equator + are negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal degrees.

+

Longitudes east of the Prime Meridian + in Greenwich are positive, longitudes west + of the Prime Meridian are negative. The + 180th meridian is negative. [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas containing the + location.

The list may contain exactly + one StatisticalArea element for each of the + following spatial unit types:

    +
  • Ward
  • Urban Area
  • Census + Area Unit
  • Māori Electorate
    • +
  • Mesh Block
  • General + Electorate
  • Territorial Authority
    • +
  • Local Board (Auckland Only)
    • +
  • Regional Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area defined + by Statistics New Zealand.

+ type: object + properties: + SpatialUnitType: + type: string + title: Spatial Unit Type + description: >- +

A classification of geographical + boundaries or statistical areas as + defined by Statistics NZ’s + geographic hierarchy.

    +
  • 'AE' - Area Unit
    • +
  • 'GE' - General Electoral District
    • +
  • 'CB' - Community Board
    • +
  • 'ME' - Māori Electoral District
    • +
  • 'MB' - Mesh Block
    • +
  • 'RC' - Regional Council
    • +
  • 'TA' - Territorial Authority
    • +
  • 'UA' - Urban Area
    • +
  • 'WA' - Ward
    • +
+ oneOf: + - title: Area Unit + description:

Area units are aggregations + of meshblocks. They are + non–administrative areas that + are in between meshblocks and + territorial authorities in size. + Area units must either define or + aggregate to define, regional + councils, territorial + authorities and urban areas.

+ Statistics NZ Classification of + Area Unit 2013 v1.0.0 + enum: + - AE + - title: General Electoral District + description:

The general electoral + districts as constituted under + the Electoral Act 1993.

+ Statistics NZ General Electoral + District 2014 v1.0.0 + enum: + - GE + - title: Community Board + description:

(aka Local Board within + Auckland) Local boards provide + governance at the local level + within Auckland Council. They + enable democratic decision + making by, and on behalf of + communities within the local + board area.

Statistics NZ + Community Board 2013 v1.0.0 + enum: + - CB + - title: Māori Electoral District + description:

Māori electoral districts are + the voting districts for + parliamentary elections for + people who choose to be on the + Māori Electoral Roll.

+ Statistics NZ Māori Electoral + District 2014 v1.0.0 + enum: + - ME + - title: Mesh Block + description:

A meshblock is the smallest + geographic unit for which + statistical data is collected + and processed by Statistics New + Zealand.

A meshblock is + defined by a geographic area, + which can vary in size from part + of a city block to a large area + of rural land. Each meshblock + borders on another to form a + network covering all of New + Zealand, including coasts and + inlets and extending out to the + 200-mile economic zone.

+ Statistics NZ Statistical + Standard for Meshblock 2013 + v1.0.0 + enum: + - MB + - title: Regional Council + description:

The top tier of local + government in New Zealand, + defined by the Local Government + Act 2002, which requires the + boundaries of regions to conform + as far as possible to one or + more water catchments. When + determining regional boundaries, + the Local Government Commission + gave consideration to regional + communities of interest when + selecting water catchments to be + included in a region. It also + considered factors such as + natural resource management, + land use planning and + environmental matters.

+ Statistics NZ Regional Council + 2013 v1.0.0 + enum: + - RC + - title: Territorial Authority + description:

The second tier of local + government in New Zealand, + defined under the Local + Government Act 2002 as a city + council or district council. + There are 67 territorial + authorities consisting of 12 + city councils, 53 districts, + Auckland Council, and Chatham + Islands Council.

Statistics + NZ Territorial Authority 2013 + v1.0.0 + enum: + - TA + - title: Urban Area + description: '"

Urban Areas are + statistically defined areas with + no administrative or legal + basis. There is a three part + hierarchical sub-division of + urban areas into: main urban + areas, secondary urban areas, + minor urban areas. Together the + populations in main, secondary + and minor urban areas comprise + the statistically defined urban + population of New Zealand. The + urban area classification is + designed to identify + concentrated urban or semi-urban + settlements without the + distortions of administrative + boundaries.

Statistics NZ + Urban Area 2013 v2.0.0"' + enum: + - UA + - title: Ward + description:

Wards are defined under the + Local Electoral Act 2001 and + result from the division, for + electoral purposes, of the + district of a territorial + authority. The ward system was + designed to allow for the + recognition of communities + within a district and to + increase community involvement + in the local government + system.

Statistics NZ Ward + 2013 v1.0.0 + enum: + - WA + Code: + type: string + description:

A valid value defined by the + nominated spatial unit type, defined + by Statistics New Zealand in one of + the following statistical area + defintion standards:

+
Area Unit
Statistics NZ + Classification of Area Unit 2017 + v1.0.0
General Electoral + District
Statistics NZ + General Electoral District 2014 + v1.0.0
Community Board
+
Statistics NZ Community Board + (codes 07601 - 07621) 2018 + v1.0.0
Māori Electoral + District
Statistics NZ + Māori Electoral District 2014 + v1.0.0
Mesh Block
+
Statistics NZ Statistical + Standard for Meshblock 2018 + v1.0.0
Regional + Council
Statistics NZ + Regional Council 2018 v1.0.0
+
Territorial Authority
+
Statistics NZ Territorial + Authority 2018 v1.0.0
Urban + Area
Statistics NZ Urban + Area 2018 v1.0.0
Ward
+
Statistics NZ Ward 2018 + v1.0.0
+ CommunicationChannelList: + description:

A list of one or more methods of communication with + the organisation

+ type: object + properties: + Channel: + type: array + items: + description:

A particular person or organisation's + communications method

+ type: object + properties: + Type: + type: string + title: Communication Channel Type + description: >- +

A standardised method of describing a + communication channel used to communicate with + or find information about a party. Provides a + more generic definition than phone and email. + Intended to provide for future requirements to + record social network channels, eg Facebook + & Twitter identifiers for a school.

+
    +
  • 'WEB' - Website
    • +
  • 'TWT' - Twitter
    • +
  • 'FBK' - Facebook
    • +
+ oneOf: + - title: Website + description: Typically refers to the home page for an + entity + enum: + - WEB + - title: Twitter + description: Twitter handle + enum: + - TWT + - title: Facebook + description: Facebook page + enum: + - FBK + Value: + type: string + description: "

The unique value that provides access to + the channel. eg: URL for a website; Facebook + page addess, Twitter handle.

" + ContactList: + description:

A list of one or more cotact persons related to the + organisation

+ type: object + properties: + Contact: + type: array + items: + description:

A particular person's contact details

+ type: object + properties: + Name: + description:

The contact's name

+ type: object + properties: + Title: + type: string + description:

A title or prefix associated with the + name.

+ FamilyName: + type: string + description:

Also known as Last Name, although some + cultures may not present a family name as + the last name.

+ GivenName: + type: string + description:

Also known as First Name, although some + cultures may not present this name as the + first element in a name. May contain a + composite of all given names.

+ MiddleName: + type: string + description:

Where more than one Given Name, these + may be combined in one composite field or + else populated in several elements.

+ FamilyNameFirst: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, + unknown and not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PreferredFamilyName: + type: string + description:

A preferred version of the Family Name. + Note:A name cannot have both a Preferred + Family and Preferred Given Name within the + same Name structure – only one of these + fields should be populated. If a person + does have both a Preferred Family and + Preferred Given Name then this must be + populated as a separate Name of type + ‘Preferred’.

+ PreferredFamilyNameFirst: + $ref: "#/paths/~1Providers~1%7BProviderRefId%7D\ + /put/requestBody/content/application~1jso\ + n/schema/properties/Provider/properties/C\ + ontactList/properties/Contact/items/prope\ + rties/Name/properties/FamilyNameFirst" + PreferredGivenName: + type: string + description: "

A preferred version of the Given Name. + Note: A name cannot have both a Preferred + Family and Preferred Given Name within the + same Name structure – only one of these + fields should be populated. If a person + does have both a Preferred Family and + Preferred Given Name then this must be + populated as a separate Name of type + ‘Preferred’.

" + Suffix: + type: string + description:

Textual suffix like PHD, JP, BSc.

+ FullName: + type: string + description:

A combination of all name elements as + one composite text element

+ Type: + type: string + title: Name Usage Type + description: >- +

A standardised method of describing the + usage of a name by a person. Where a + person has more than one current name, the + usage type indicates which name may be + used according to the purpose.

Code + values are based on SIF Australia 3.4.

+
    +
  • 'PRF' - Preferred Name
    • +
  • 'FON' - Foreign Official Name
    • +
  • 'PRV' - Previous name
    • +
  • 'AKA' - Also Known As
    • +
  • 'BTH' - Name at Birth
    • +
  • 'LGL' - Legal Name
    • +
+ oneOf: + - title: Preferred Name + description:

The name by which an individual + prefers to be known and addressed.

+

Only usage type applicable for + student name usage (other types are + not supported by NSI).

+ enum: + - PRF + - title: Foreign Official Name + description:

Included for future usage in NZ, + especially for tertiary students.

+ enum: + - FON + - title: Previous name + enum: + - PRV + - title: Also Known As + description: AKA or Alias + enum: + - AKA + - title: Name at Birth + enum: + - BTH + - title: Legal Name + description:

Legal Name or Official Name as + defined by the organisation which + collects it (legal name is not defined + in this standard)

+ enum: + - LGL + IsVerified: + $ref: "#/paths/~1Providers~1%7BProviderRefId%7D\ + /put/requestBody/content/application~1jso\ + n/schema/properties/Provider/properties/C\ + ontactList/properties/Contact/items/prope\ + rties/Name/properties/FamilyNameFirst" + PositionTitle: + type: string + description:

The title the contact has within the + Organisation being contacted

+ Role: + type: string + title: Organisation Contact Role + description: >- +

The role played by a person in an + organisation where that person is recorded as + a contact. The role definition is used to + recognise similar functions across + organisations, however individuals with the + same role may be given different position + titles that differ from the generic role + description. For example, a principal may have + a title of ‘headmaster’.

    +
  • 'PRI' - Principal
    • +
  • 'ACT' - Acting Principal
    • +
  • 'DIR' - Director
    • +
  • 'ECE' - ECE Management Contact
    • +
+ oneOf: + - title: Principal + enum: + - PRI + - title: Acting Principal + enum: + - ACT + - title: Director + enum: + - DIR + - title: ECE Management Contact + enum: + - ECE + AddressList: + description:

A list of Address elements.

+ type: object + properties: + Address: + type: array + items: + description:

This element contains address + data.

+ type: object + properties: + Type: + $ref: "#/paths/~1Providers~1%7BProviderRe\ + fId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/Pro\ + vider/properties/AddressList/proper\ + ties/Address/items/properties/Type" + Role: + $ref: "#/paths/~1Providers~1%7BProviderRe\ + fId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/Pro\ + vider/properties/AddressList/proper\ + ties/Address/items/properties/Role" + Street: + description:

The street element is a complex + element and breaks the street down + into several parts. (Allow for PO + Box here)

+ type: object + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' part of + rural addresses

+ City: + type: string + description:

The city part of the address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only applicable + if a non-New Zealand Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid + x,y coordinates and converted to + Latitude and Longitude values per + the World Geodetic System 1984 + (G1762)

+ type: object + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes north + of the equator are positive, + latitudes south of the equator + are negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes east + of the Prime Meridian in + Greenwich are positive, + longitudes west of the Prime + Meridian are negative. The 180th + meridian is negative. [ISO + 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

The + list may contain exactly one + StatisticalArea element for each of + the following spatial unit + types:

  • Ward
    • +
  • Urban Area
  • Census Area + Unit
  • Māori Electorate
    • +
  • Mesh Block
  • General + Electorate
  • Territorial + Authority
  • Local Board + (Auckland Only)
  • Regional + Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical + area defined by Statistics New + Zealand.

+ type: object + properties: + SpatialUnitType: + $ref: "#/paths/~1Providers~1%7B\ + ProviderRefId%7D/put/requ\ + estBody/content/applicati\ + on~1json/schema/propertie\ + s/Provider/properties/Add\ + ressList/properties/Addre\ + ss/items/properties/Stati\ + sticalAreaList/properties\ + /StatisticalArea/items/pr\ + operties/SpatialUnitType" + Code: + type: string + description:

A valid value defined + by the nominated spatial + unit type, defined by + Statistics New Zealand in + one of the following + statistical area defintion + standards:

+
Area Unit
+
Statistics NZ + Classification of Area + Unit 2017 v1.0.0
+
General Electoral + District
+
Statistics NZ General + Electoral District 2014 + v1.0.0
Community + Board
Statistics + NZ Community Board (codes + 07601 - 07621) 2018 + v1.0.0
Māori + Electoral District
+
Statistics NZ Māori + Electoral District 2014 + v1.0.0
Mesh + Block
Statistics + NZ Statistical Standard + for Meshblock 2018 + v1.0.0
Regional + Council
+
Statistics NZ Regional + Council 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority 2018 + v1.0.0
Urban + Area
Statistics + NZ Urban Area 2018 + v1.0.0
Ward
+
Statistics NZ Ward + 2018 v1.0.0
+ EmailList: + description:

List of Email elements.

+ type: object + properties: + Email: + type: array + items: + description:

This element represents an e-mail + address of one of a number of types and + occurs in objects such as + StudentPersonal, StaffPersonal, + StudentContactPersonal, etc.

+ type: object + properties: + Type: + type: string + title: Email Type + description: >- +

A standardised method of + describing an electronic mail + address used as contact method by a + party. Where a party has more than + one email address, this may provide + context for deciding which email + address to use.

    +
  • 'PRIM' - Primary
    • +
  • 'WORK' - Work
    • +
  • 'PERS' - Personal
    • +
  • 'ALT1' - Alternate 1
    • +
  • 'ALT2' - Alternate 2
    • +
  • 'ALT3' - Alternate 3
    • +
  • 'ALT4' - Alternate 4
    • +
+ oneOf: + - title: Primary + description: Applicable to organisations, eg + schools + enum: + - PRIM + - title: Work + description: Only used for persons + enum: + - WORK + - title: Personal + description: Only used for persons + enum: + - PERS + - title: Alternate 1 + enum: + - ALT1 + - title: Alternate 2 + enum: + - ALT2 + - title: Alternate 3 + enum: + - ALT3 + - title: Alternate 4 + enum: + - ALT4 + Address: + type: string + description:

The actual email address.

+ PhoneNumberList: + description:

List of PhoneNumber elements.

+ type: object + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone + number and occurs within objects such as + StudentPersonal, StaffPersonal, etc.

+ type: object + properties: + Type: + type: string + title: Telephone Number Type + description: >- +

A standardised method of + describing a telecommunications + device used as contact method by a + party. Where a party has more than + one phone number, this may provide + context for deciding which number to + use.

    +
  • 'MAI' - Main Telephone Number
    • +
  • 'FAX' - Facsimile Number
    • +
  • 'HTE' - Home Telephone Number
    • +
  • 'HMO' - Home Mobile
    • +
  • 'MOB' - Mobile
    • +
  • 'WMO' - Work Mobile
    • +
  • 'WTE' - Work Telephone Number
    • +
+ oneOf: + - title: Main Telephone Number + enum: + - MAI + - title: Facsimile Number + enum: + - FAX + - title: Home Telephone Number + description: Person usage only + enum: + - HTE + - title: Home Mobile + description: Person usage only + enum: + - HMO + - title: Mobile + enum: + - MOB + - title: Work Mobile + enum: + - WMO + - title: Work Telephone Number + enum: + - WTE + Number: + type: string + description: "

Phone number. Free-form, but + typical New Zealand formats + include:

  • (0##) + ###-####
  • ###-####
    • +
  • +##### ### ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1Providers~1%7BProviderRe\ + fId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/Pro\ + vider/properties/ContactList/proper\ + ties/Contact/items/properties/Name/\ + properties/FamilyNameFirst" + EducationRegion: + type: string + title: Education Region + description: >- + Regions of New Zealand defined by Ministry of Education + for administrative purposes.
    +
  • 'TAIT' - Tai Tokerau
    • +
  • 'AUCK' - Auckland
    • +
  • 'WAIK' - Waikato
    • +
  • 'BOPW' - Bay of Plenty, Waiariki
    • +
  • 'HAWK' - Hawke's Bay, Tairāwhiti
    • +
  • 'TARA' - Taranaki, Whanganui, Manawatū
    • +
  • 'WELL' - Wellington
    • +
  • 'NELS' - Nelson, Marlborough, West Coast
    • +
  • 'CANT' - Canterbury, Chatham Islands
    • +
  • 'OTAG' - Otago, Southland
    • +
+ oneOf: + - title: Tai Tokerau + enum: + - TAIT + - title: Auckland + enum: + - AUCK + - title: Waikato + enum: + - WAIK + - title: Bay of Plenty, Waiariki + enum: + - BOPW + - title: Hawke's Bay, Tairāwhiti + enum: + - HAWK + - title: Taranaki, Whanganui, Manawatū + enum: + - TARA + - title: Wellington + enum: + - WELL + - title: Nelson, Marlborough, West Coast + enum: + - NELS + - title: Canterbury, Chatham Islands + enum: + - CANT + - title: Otago, Southland + enum: + - OTAG + EmailList: + description:

The set of contact email addresses that the + Organisation uses

+ type: object + properties: + Email: + type: array + items: + description:

This element represents an e-mail address of + one of a number of types and occurs in objects + such as StudentPersonal, StaffPersonal, + StudentContactPersonal, etc.

+ type: object + properties: + Type: + $ref: "#/paths/~1Providers~1%7BProviderRefId%7D/put\ + /requestBody/content/application~1json/schema\ + /properties/Provider/properties/ContactList/p\ + roperties/Contact/items/properties/EmailList/\ + properties/Email/items/properties/Type" + Address: + type: string + description:

The actual email address.

+ EntityClose: + type: string + format: date + description:

Closing date of entity. Only present for closed + providers.

+ EntityOpen: + type: string + format: date + description:

Opening date of entity. For proposed schools this + will be the projected opening date. For open schools + this may not be present.

+ LocationList: + description:

A list of one or more locations, from which the + organisation operates or provides a service.

+ type: object + properties: + Location: + type: array + items: + description:

This element contains data about a geographical + location.

+ type: object + properties: + Description: + type: string + description:

A description for the Location.

+ Address: + description:

The physical address of the Location

+ type: object + properties: + Type: + $ref: "#/paths/~1Providers~1%7BProviderRefId%7D\ + /put/requestBody/content/application~1jso\ + n/schema/properties/Provider/properties/A\ + ddressList/properties/Address/items/prope\ + rties/Type" + Role: + $ref: "#/paths/~1Providers~1%7BProviderRefId%7D\ + /put/requestBody/content/application~1jso\ + n/schema/properties/Provider/properties/A\ + ddressList/properties/Address/items/prope\ + rties/Role" + Street: + description:

The street element is a complex element + and breaks the street down into several + parts. (Allow for PO Box here)

+ type: object + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban addresses, or + the 'RD No' part of rural addresses

+ City: + type: string + description:

The city part of the address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only applicable if a + non-New Zealand Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are derived + from New Zealand Map Grid x,y coordinates + and converted to Latitude and Longitude + values per the World Geodetic System 1984 + (G1762)

+ type: object + properties: + Latitude: + description:

Latitude in decimal degrees.

+

Latitudes north of the equator are + positive, latitudes south of the + equator are negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal degrees.

+

Longitudes east of the Prime + Meridian in Greenwich are positive, + longitudes west of the Prime Meridian + are negative. The 180th meridian is + negative. [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas containing + the location.

The list may contain + exactly one StatisticalArea element for + each of the following spatial unit + types:

  • Ward
  • Urban + Area
  • Census Area Unit
    • +
  • Māori Electorate
  • Mesh + Block
  • General Electorate
    • +
  • Territorial Authority
  • Local + Board (Auckland Only)
  • Regional + Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area + defined by Statistics New + Zealand.

+ type: object + properties: + SpatialUnitType: + $ref: "#/paths/~1Providers~1%7BProvid\ + erRefId%7D/put/requestBody/cont\ + ent/application~1json/schema/pr\ + operties/Provider/properties/Ad\ + dressList/properties/Address/it\ + ems/properties/StatisticalAreaL\ + ist/properties/StatisticalArea/\ + items/properties/SpatialUnitTyp\ + e" + Code: + type: string + description:

A valid value defined by the + nominated spatial unit type, + defined by Statistics New + Zealand in one of the following + statistical area defintion + standards:

Area + Unit
Statistics NZ + Classification of Area Unit 2017 + v1.0.0
General + Electoral District
+
Statistics NZ General + Electoral District 2014 + v1.0.0
Community + Board
Statistics NZ + Community Board (codes 07601 - + 07621) 2018 v1.0.0
+
Māori Electoral + District
Statistics NZ + Māori Electoral District 2014 + v1.0.0
Mesh Block
+
Statistics NZ Statistical + Standard for Meshblock 2018 + v1.0.0
Regional + Council
Statistics NZ + Regional Council 2018 + v1.0.0
Territorial + Authority
Statistics NZ + Territorial Authority 2018 + v1.0.0
Urban Area
+
Statistics NZ Urban Area + 2018 v1.0.0
Ward
+
Statistics NZ Ward 2018 + v1.0.0
+ GridLocation: + description:

The latitude & longitude of the location. + Grid location values are derived from New + Zealand Map Grid x,y coordinates and converted + to Latitude and Longitude values per the World + Geodetic System 1984 (G1762)

+ type: object + properties: + Latitude: + description:

Latitude in decimal degrees.

+ Latitudes north of the equator are + positive, latitudes south of the equator + are negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal degrees.

+

Longitudes east of the Prime Meridian + in Greenwich are positive, longitudes west + of the Prime Meridian are negative. The + 180th meridian is negative. [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas containing the + location.

The list may contain exactly + one StatisticalArea element for each of the + following spatial unit types:

    +
  • Ward
  • Urban Area
  • Census + Area Unit
  • Māori Electorate
    • +
  • Mesh Block
  • General + Electorate
  • Territorial Authority
    • +
  • Local Board (Auckland Only)
    • +
  • Regional Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area defined + by Statistics New Zealand.

+ type: object + properties: + SpatialUnitType: + $ref: "#/paths/~1Providers~1%7BProviderRe\ + fId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/Pro\ + vider/properties/AddressList/proper\ + ties/Address/items/properties/Stati\ + sticalAreaList/properties/Statistic\ + alArea/items/properties/SpatialUnit\ + Type" + Code: + type: string + description:

A valid value defined by the + nominated spatial unit type, defined + by Statistics New Zealand in one of + the following statistical area + defintion standards:

+
Area Unit
Statistics NZ + Classification of Area Unit 2017 + v1.0.0
General Electoral + District
Statistics NZ + General Electoral District 2014 + v1.0.0
Community Board
+
Statistics NZ Community Board + (codes 07601 - 07621) 2018 + v1.0.0
Māori Electoral + District
Statistics NZ + Māori Electoral District 2014 + v1.0.0
Mesh Block
+
Statistics NZ Statistical + Standard for Meshblock 2018 + v1.0.0
Regional + Council
Statistics NZ + Regional Council 2018 v1.0.0
+
Territorial Authority
+
Statistics NZ Territorial + Authority 2018 v1.0.0
Urban + Area
Statistics NZ Urban + Area 2018 v1.0.0
Ward
+
Statistics NZ Ward 2018 + v1.0.0
+ Name: + type: string + description:

The normal business name of the Organisation

+ PhoneNumberList: + description:

The set of contact phone numbers that the + Organisation uses

+ type: object + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone number and + occurs within objects such as StudentPersonal, + StaffPersonal, etc.

+ type: object + properties: + Type: + $ref: "#/paths/~1Providers~1%7BProviderRefId%7D/put\ + /requestBody/content/application~1json/schema\ + /properties/Provider/properties/ContactList/p\ + roperties/Contact/items/properties/PhoneNumbe\ + rList/properties/PhoneNumber/items/properties\ + /Type" + Number: + type: string + description: "

Phone number. Free-form, but typical New + Zealand formats include:

  • (0##) + ###-####
  • ###-####
  • +##### ### + ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1Providers~1%7BProviderRefId%7D/put\ + /requestBody/content/application~1json/schema\ + /properties/Provider/properties/ContactList/p\ + roperties/Contact/items/properties/Name/prope\ + rties/FamilyNameFirst" + RelatedOrganisationList: + description:

A list of other organisations that are related to the + Provider

+ type: object + properties: + RelatedOrganisation: + type: array + items: + description:

Extends ObjectReferenceType to add + an extra element, OrganisationType, + describing the nature of the related + organisation.

+ type: object + properties: + StartDate: + type: string + format: date + description:

The start date of the relationship between + the two organisations

+ EndDate: + type: string + format: date + description:

The end date of the relationship between + the two organisations

+ Type: + type: string + title: Organisation Relationship Type + description: >- +

A code describing the nature of the + relationship between a pair of + Organisations

    +
  • 'TPU' - Teen Parent Unit
    • +
  • 'ACR' - Activity Centre
    • +
  • 'MOE' - MoE Local Office
    • +
  • 'COL' - Community of Learning - Kāhui Ako
    • +
+ oneOf: + - title: Teen Parent Unit + description: Related organisation is a Teen Parent Unit + co-located with the main Organisation. + enum: + - TPU + - title: Activity Centre + description: Related organisation is an Activity Centre + co-located with the main Organisation. + enum: + - ACR + - title: MoE Local Office + description: Related organisation is Ministry of + Education Local Office that deals with the + Provider. + enum: + - MOE + - title*: + en: Community of Learning + mi: Kāhui Ako + description: Related organisation is the Community of + Learning / Kāhui Ako that the main + Organisation is a member of + enum: + - COL + OperationalStatus: + type: string + title: Operational Status + description: >- +

Indicates the operational status of an + organisation.

    +
  • 'C' - Closed
    • +
  • 'O' - Open
    • +
  • 'P' - Proposed
    • +
+ oneOf: + - title: Closed + enum: + - C + - title: Open + enum: + - O + - title: Proposed + description: SIF AU uses the term ‘Pending’ + enum: + - P + Type: + type: string + title: Organisation Type + description: >- + Describes the organisation type of the provider, + indicating the services provided, function or purpose of + the organisation.
    +
  • '32' - Composite School (Year 1-15)
    • +
  • '21' - Contributing Primary (Year 1-6)
    • +
  • '34' - The Correspondence School
    • +
  • '20' - Full Primary (Year 1-8)
    • +
  • '22' - Intermediate (Year 7-8)
    • +
  • '35' - Restricted Composite School (Year 7-10)
    • +
  • '30' - Secondary School (Year 7-15)
    • +
  • '40' - Secondary School (Year 9-15)
    • +
  • '23' - Special School
    • +
  • '41' - Teen Parent Unit (Year 9-15)
    • +
  • '997' - Activity Centre
    • +
  • '998' - Community of Learning | Kāhui Ako
    • +
plus 1 more value(s) at NZCodeSetsOrganisationTypeType + oneOf: + - title: Composite School (Year 1-15) + enum: + - "32" + - title: Contributing Primary (Year 1-6) + enum: + - "21" + - title: The Correspondence School + enum: + - "34" + - title: Full Primary (Year 1-8) + enum: + - "20" + - title: Intermediate (Year 7-8) + enum: + - "22" + - title: Restricted Composite School (Year 7-10) + enum: + - "35" + - title: Secondary School (Year 7-15) + enum: + - "30" + - title: Secondary School (Year 9-15) + enum: + - "40" + - title: Special School + enum: + - "23" + - title: Teen Parent Unit (Year 9-15) + enum: + - "41" + - title: Activity Centre + enum: + - "997" + - title: Community of Learning | Kāhui Ako + enum: + - "998" + - title: Ministry of Education Local Office + enum: + - "999" + ProviderRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + ProviderLocalId: + $ref: "#/paths/~1Providers~1%7BProviderRefId%7D/put/requestBo\ + dy/content/application~1json/schema/properties/Provider\ + /properties/MinistryOfEducationId" + Authority: + type: string + title: Provider Authority + description: >- + The authority by which the provider is authorised to + provide education services. Describes the + ownership/operation or registration status of an + educational institution.
    +
  • 'STATE' - State
    • +
  • 'STINT' - State: Integrated
    • +
  • 'PRFUL' - Private: Fully Registered
    • +
  • 'PRPRO' - Private: Provisionally Registered
    • +
  • 'OTVOT' - Other: Vote Education
    • +
  • 'PASCH' - Partnership School
    • +
+ oneOf: + - title: State + description: "\"Also known as 'State: Non-Integrated'\"" + enum: + - STATE + - title: "State: Integrated" + enum: + - STINT + - title: "Private: Fully Registered" + enum: + - PRFUL + - title: "Private: Provisionally Registered" + enum: + - PRPRO + - title: "Other: Vote Education" + description: Owned by another organisation, funded from Vote + Education. + enum: + - OTVOT + - title: Partnership School + enum: + - PASCH + SchoolService: + description:

Only present if the Provider is a provider of school + education services. Contains properties that are + school-specific.

+ type: object + properties: + CoEdStatus: + type: string + title: School Co-Ed Status + description: >- +

A summary description of the gender of students + that a school accepts, indicating the type of school + from a gender perspective.

    +
  • 'COED' - Co-Educational
    • +
  • 'GIRL' - Girls School
    • +
  • 'BOYS' - Boys School
    • +
  • 'PRCO' - Primary Co-Ed, Secondary Girls
    • +
  • 'JUBO' - Junior Boys, Senior Co-Ed
    • +
+ oneOf: + - title: Co-Educational + enum: + - COED + - title: Girls School + enum: + - GIRL + - title: Boys School + enum: + - BOYS + - title: Primary Co-Ed, Secondary Girls + enum: + - PRCO + - title: Junior Boys, Senior Co-Ed + enum: + - JUBO + Decile: + type: integer + description:

A description of the socio-economic position of a + school's student community according to the MoE + decile rating system.

+ NewEntrantPolicyList: + description:

A list of recognised policy choices adopted by + the School.

+ type: object + properties: + EnactedPolicy: + type: array + items: + description:

A descriptor for a particular enacted + policy that has been adopted by a school.

+ type: object + properties: + EffectiveFrom: + type: string + format: date + description:

The date from which the school adopted + the policy. If not populated then this is + the current/original policy of the + school.

+ EffectiveTo: + type: string + format: date + description:

The date after which the school has no + longer adopted the policy. If not + populated then the school has no planned + date to end the policy.

+ Policy: + type: string + title: Enacted Policy + description: >- +

A policy that a school may choose to + implement as part of its operating rules. + For example, policies may concern student + behaviour, clothing/appearance, wellbeing + and new entrant enrolment.

    +
  • 'AE' - Age Entry
    • +
  • 'CE' - Cohort Entry
    • +
+ oneOf: + - title: Age Entry + description: Indicates that new starters will start + on the next school day following their + 5 birthday. + enum: + - AE + - title: Cohort Entry + description: Indicates that new starters will start + in a cohort group only on specific + notified dates after their 5th + birthday. + enum: + - CE + DefinitionList: + description:

A list of School definition descriptors that + further describe the nature of a school

+ type: object + properties: + Definition: + type: array + items: + type: string + title: School Definition + description: >- +

A school-specific definition of a provider, + describing the school according to specialist + services or facilities that it provides for + students or for teaching staff.

    +
  • 'DCSC' - Designated Character School
    • +
  • 'SMBS' - Secondary Māori Boarding School
    • +
  • 'BISC' - Bilingual School
    • +
  • 'KKMA' - Kura Kaupapa Māori
    • +
  • 'CYBS' - Contributing with Year 7 & 8 Bilingual Students
    • +
  • 'SWBF' - School with Boarding Facilities
    • +
  • 'SFVI' - School for Vision Impaired
    • +
  • 'SDHI' - School for Deaf/Hearing Impaired
    • +
  • 'SFPD' - School for Physical Disabilities
    • +
  • 'SFII' - School for Intellectual Impairments
    • +
  • 'SLSD' - School for Learning/Social Difficulties
    • +
  • 'RHSC' - Regional Health School
    • +
plus 3 more value(s) at NZCodeSetsSchoolDefinitionType + oneOf: + - title: Designated Character School + enum: + - DCSC + - title: Secondary Māori Boarding School + enum: + - SMBS + - title: Bilingual School + description: '"Historic: Not to be used"' + enum: + - BISC + - title: Kura Kaupapa Māori + enum: + - KKMA + - title: Contributing with Year 7 & 8 Bilingual + Students + description: Contributing School - but is able to + retain Y7 & 8 bilingual students + enum: + - CYBS + - title: School with Boarding Facilities + enum: + - SWBF + - title: School for Vision Impaired + enum: + - SFVI + - title: School for Deaf/Hearing Impaired + enum: + - SDHI + - title: School for Physical Disabilities + enum: + - SFPD + - title: School for Intellectual Impairments + enum: + - SFII + - title: School for Learning/Social Difficulties + enum: + - SLSD + - title: Regional Health School + enum: + - RHSC + - title: Normal School + description: A school with extra resources for teacher + training purposes + enum: + - NORM + - title: Model School + description: Set up like a rural school, for teacher + training purposes + enum: + - MODE + - title: Normal School (Model Classes) + description: Normal School with Model Classes + enum: + - MSMC + SchoolYearList: + description:

A list of SchoolYear elements + describing the genders of students accepted for + enrolment at each year level.

+ type: object + properties: + SchoolYear: + type: array + items: + description:

A descriptor for a particular Year Level + offered by the school, including detail of the + gender of students that are accepted for + enrolment in this year level.

+ type: object + properties: + YearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are + valid for describing Funding Year Level + and Current Year Level for a student + enrolment.

Current Year Level + indicates the year level of the student’s + class cohort and the level at which the + student spends most of their time at + school. While a student may be enrolled in + subjects at varying instructional year + levels, in relation to the student + enrolment this value represents the year + level at which the student is considered + to be predominantly taught.

Funding + Year Level measures the actual number of + years that the student has attended a + school. It provides the Ministry with a + method of counting students for funding + purposes which is independent of the way + schools are organised or the particular + programme of study that a student may + undertake. Funding Year Level for most + students is based on the date they first + started school.

School Year Level + is used to indicate the instructional year + levels offered by a school, i.e. those + years for which student enrolments may be + accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code + indicates Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + Gender: + type: string + title: Schooling Gender + description: >- +

A description of the gender of students + that the school accepts at a certain year + level or other instructional grouping.

+

For use at the year level or course + only, rather than school level. For + instance a school may accept boys only in + year 11 but both girls and boys at years + 12 and 13.

    +
  • 'C' - Both Girls and Boys
    • +
  • 'F' - Girls Only
    • +
  • 'M' - Boys Only
    • +
+ oneOf: + - title: Both Girls and Boys + enum: + - C + - title: Girls Only + enum: + - F + - title: Boys Only + enum: + - M + TechnologyCentreName: + description: "The name of the Technology Centre that is run as + part of the School; Eg: Marlborough Technology + Centre is run as part of Bohally Intermediate + School." + ECEService: + description:

Only present if the Provider is a provider of early + childhood education services. Contains properties that + are ECE specific.

+ type: object + properties: + Type: + type: string + title: ECEService Type + description: >- +

Codes denoting the nature of an Early Childhood + Education service.

    +
  • 'KG' - Kindergarten
    • +
  • 'PC' - Playcentre
    • +
  • 'KR' - Te Kohanga Reo
    • +
+ oneOf: + - title: Kindergarten + enum: + - KG + - title: Playcentre + enum: + - PC + - title: Te Kohanga Reo + enum: + - KR + TertiarySerice: + type: string + description:

Only present if the Provider is a provider of + tertiary education services. Contains properties that + are Tertiary Education specific.

A placeholder + for future expansion

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + Provider: + AddressList: + Address: + - Type: RU + Role: PHY + Street: + Line1: 1175 Lake Ferry Rd + Suburb: RD 1 + City: Martinborough + CommunicationChannelList: + Channel: + - Notes: Attendance System (Self Service) + Type: WEB + Value: http://att.hogwarts.school.nz + - Notes: School Website + Type: WEB + Value: http://www.hogwarts.school.nz + ContactList: + Contact: + - Name: + FamilyName: Dumbledore + GivenName: Albus + FullName: Albus Dumbledore + PositionTitle: Headmaster + Role: PRI + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + - Name: + FamilyName: Hagrid + GivenName: Rubeus + FullName: Rubeus Hagrid + PositionTitle: Gamekeeper + Role: DIR + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + EducationRegion: TAIT + EmailList: + Email: + - Type: PRIM + Address: stuart@gmail.com + EntityOpen: 1652-04-01 + LocationList: + Location: + - Description: Only Campus + Address: + Type: RU + Role: PHY + Street: + 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 + PhoneNumberList: + PhoneNumber: + - Notes: Attendance Office (Automated) + Usage: SMS + Type: WTE + Number: (0274) 300 9991 + - Notes: Attendance Office + Usage: INT + Type: WTE + Number: (04) 300 9992 + - Notes: School Secretary DDI + Type: WTE + Number: (04) 300 9993 + RelatedOrganisationList: + RelatedOrganisation: + - RefId: 0951bacf-fc88-4ed6-8113-11a6d6335c07 + LocalId: "99102" + Name: Tai Tokerau + ObjectType: Organisation + StartDate: 2012-10-31 + Type: MOE + - RefId: ac0871d9-6562-4209-ae86-abdb3661842b + LocalId: "99204" + Name: Masterton (Whakaoriori) Kāhui Ako + ObjectType: Organisation + StartDate: 2012-04-30 + Type: COL + OperationalStatus: O + Type: 21 + ProviderRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + ProviderLocalId: "01011234" + Authority: STATE + SchoolService: + CoEdStatus: COED + Decile: 5 + NewEntrantPolicyList: + EnactedPolicy: + - EffectiveTo: 2018-12-31 + Policy: AE + - EffectiveFrom: 2019-01-01 + Policy: CE + DefinitionList: + Definition: + - SMBS + - KKMA + - SWBF + 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 + application/xml: + schema: + type: object + properties: + Provider: + $ref: "#/paths/~1Providers~1%7BProviderRefId%7D/put/requestBody/c\ + ontent/application~1json/schema/properties/Provider" + example: "$ref: '../examples/Provider.yaml#/put/xml'" responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" default: - description: successful operation - requestBody: - $ref: '#/components/requestBodies/UserArray' - /user/createWithList: - post: - tags: - - user - summary: Creates list of users with given input array - description: '' - operationId: createUsersWithListInput - responses: - default: - description: successful operation - requestBody: - $ref: '#/components/requestBodies/UserArray' - /user/login: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" get: tags: - - user - summary: Logs user into the system - description: '' - operationId: loginUser + - Provider + summary: Default operation to get a single Provider parameters: - - name: username - in: query - description: The user name for login - required: true - schema: - type: string - - name: password - in: query - description: The password for login in clear text + - name: ProviderRefId + in: path + description:

The SIF GUID used by systems to identify the organisation.

required: true schema: type: string responses: - '200': + "200": description: successful operation - headers: - X-Rate-Limit: - description: calls per hour allowed by the user - schema: - type: integer - format: int32 - X-Expires-After: - description: date in UTC when toekn expires - schema: - type: string - format: date-time content: application/json: schema: - type: string - examples: - response: - value: OK + type: object + properties: + Provider: + $ref: "#/paths/~1Providers/get/responses/200/content/applicatio\ + n~1json/schema/properties/Providers/properties/Provider/i\ + tems" + example: + Provider: + AddressList: + Address: + - Type: RU + Role: PHY + Street: + Line1: 1175 Lake Ferry Rd + Suburb: RD 1 + City: Martinborough + CommunicationChannelList: + Channel: + - Notes: Attendance System (Self Service) + Type: WEB + Value: http://att.hogwarts.school.nz + - Notes: School Website + Type: WEB + Value: http://www.hogwarts.school.nz + ContactList: + Contact: + - Name: + FamilyName: Dumbledore + GivenName: Albus + FullName: Albus Dumbledore + PositionTitle: Headmaster + Role: PRI + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + - Name: + FamilyName: Hagrid + GivenName: Rubeus + FullName: Rubeus Hagrid + PositionTitle: Gamekeeper + Role: DIR + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + EducationRegion: TAIT + EmailList: + Email: + - Type: PRIM + Address: stuart@gmail.com + EntityOpen: 1652-04-01 + LocationList: + Location: + - Description: Only Campus + Address: + Type: RU + Role: PHY + Street: + 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 + PhoneNumberList: + PhoneNumber: + - Notes: Attendance Office (Automated) + Usage: SMS + Type: WTE + Number: (0274) 300 9991 + - Notes: Attendance Office + Usage: INT + Type: WTE + Number: (04) 300 9992 + - Notes: School Secretary DDI + Type: WTE + Number: (04) 300 9993 + RelatedOrganisationList: + RelatedOrganisation: + - RefId: 0951bacf-fc88-4ed6-8113-11a6d6335c07 + LocalId: "99102" + Name: Tai Tokerau + ObjectType: Organisation + StartDate: 2012-10-31 + Type: MOE + - RefId: ac0871d9-6562-4209-ae86-abdb3661842b + LocalId: "99204" + Name: Masterton (Whakaoriori) Kāhui Ako + ObjectType: Organisation + StartDate: 2012-04-30 + Type: COL + OperationalStatus: O + Type: 21 + ProviderRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + ProviderLocalId: "01011234" + Authority: STATE + SchoolService: + CoEdStatus: COED + Decile: 5 + NewEntrantPolicyList: + EnactedPolicy: + - EffectiveTo: 2018-12-31 + Policy: AE + - EffectiveFrom: 2019-01-01 + Policy: CE + DefinitionList: + Definition: + - SMBS + - KKMA + - SWBF + 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 application/xml: schema: - type: string - examples: - response: - value: OK - text/plain: - examples: - response: - value: OK - '400': - description: Invalid username/password supplied - /user/logout: + type: object + properties: + Provider: + $ref: "#/paths/~1Providers/get/responses/200/content/applicatio\ + n~1json/schema/properties/Providers/properties/Provider/i\ + tems" + example: "$ref: '../examples/Provider.yaml#/get/xml'" + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - Provider + summary: Default operation to delete a single Provider + parameters: + - name: ProviderRefId + in: path + description:

The SIF GUID used by systems to identify the organisation.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /ProviderRelationships: get: tags: - - user - summary: Logs out current logged in user session - description: '' - operationId: logoutUser - responses: - default: - description: successful operation -components: - schemas: - ApiResponse: - type: object - properties: - code: - type: integer - format: int32 - type: - type: string - message: - type: string - Cat: - description: A representation of a cat - allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - huntingSkill: - type: string - description: The measured skill for hunting - default: lazy - enum: - - clueless - - lazy - - adventurous - - aggressive - required: - - huntingSkill - Category: - type: object - properties: - id: - description: Category ID - allOf: - - $ref: '#/components/schemas/Id' - name: - description: Category name - type: string - minLength: 1 - sub: - description: Test Sub Category - type: object - properties: - prop1: - type: string - description: Dumb Property - xml: - name: Category - Dog: - description: A representation of a dog - allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - packSize: - type: integer - format: int32 - description: The size of the pack the dog is from - default: 1 - minimum: 1 - required: - - packSize - HoneyBee: - description: A representation of a honey bee - allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - honeyPerDay: - type: number - description: Average amount of honey produced per day in ounces - example: 3.14 - required: - - honeyPerDay - Id: - type: integer - format: int64 - readOnly: true - Order: - type: object - properties: - id: - description: Order ID - allOf: - - $ref: '#/components/schemas/Id' - petId: - description: Pet ID - allOf: - - $ref: '#/components/schemas/Id' - quantity: - type: integer - format: int32 - minimum: 1 - default: 1 - shipDate: - description: Estimated ship date - type: string - format: date-time - status: - type: string - description: Order Status - enum: - - placed - - approved - - delivered - complete: - description: Indicates whenever order was completed or not - type: boolean - default: false - xml: - name: Order - Pet: - type: object - required: - - name - - photoUrls - discriminator: - propertyName: petType - mapping: - cat: '#/components/schemas/Cat' - dog: '#/components/schemas/Dog' - bee: '#/components/schemas/HoneyBee' - properties: - id: - externalDocs: - description: "Find more info here" - url: "https://example.com" - description: Pet ID - allOf: - - $ref: '#/components/schemas/Id' - category: - description: Categories this pet belongs to - allOf: - - $ref: '#/components/schemas/Category' - name: - description: The name given to a pet - type: string - example: Guru - photoUrls: - description: The list of URL to a cute photos featuring pet - type: array - maxItems: 20 - xml: - name: photoUrl - wrapped: true - items: + - ProviderRelationship + summary: Default operation to get a list of all available ProviderRelationships + description: Search the set of available ProviderRelationships, according to the + search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: type: string - format: url - friend: - allOf: - - $ref: '#/components/schemas/Pet' - tags: - description: Tags attached to the pet - type: array - minItems: 1 - xml: - name: tag - wrapped: true - items: - $ref: '#/components/schemas/Tag' - status: - type: string - description: Pet status in the store - enum: - - available - - pending - - sold - petType: - description: Type of a pet - type: string - xml: - name: Pet - Tag: - type: object - properties: - id: - description: Tag ID - allOf: - - $ref: '#/components/schemas/Id' - name: - description: Tag name - type: string - minLength: 1 - xml: - name: Tag - User: - type: object - properties: - id: - $ref: '#/components/schemas/Id' - pet: - oneOf: - - $ref: '#/components/schemas/Pet' - - $ref: '#/components/schemas/Tag' - username: - description: User supplied username - type: string - minLength: 4 - example: John78 - firstName: - description: User first name - type: string - minLength: 1 - example: John - lastName: - description: User last name - type: string - minLength: 1 - example: Smith - email: - description: User email address - type: string - format: email - example: john.smith@example.com - password: - type: string - description: >- - User password, MUST contain a mix of upper and lower case letters, - as well as digits - format: password - minLength: 8 - pattern: '(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])' - example: drowssaP123 - phone: - description: User phone number in international format - type: string - pattern: '^\+(?:[0-9]-?){6,14}[0-9]$' - example: +1-202-555-0192 - nullable: true - userStatus: - description: User status - type: integer - format: int32 - xml: - name: User - requestBodies: - Pet: + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ProviderRelationships: + type: object + description: A List of ProviderRelationship objects + properties: + ProviderRelationship: + type: array + items: + required: + - EffectiveDate + - RelatedProvider + - RelationshipType + - SourceProvider + type: object + properties: + ProviderRelationshipRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + ProviderRelationshipLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + RelationshipType: + type: string + title: Provider Relationship Type + description: >- +

A code describing the nature of the + relationship between the pair of Providers

+
    +
  • 'CAR' - Contributor and Receiver
    • +
  • 'CAH' - Client and Host
    • +
  • 'TPU' - Teen Parent Unit
    • +
  • 'ACE' - Activity Centre
    • +
+ oneOf: + - title: Contributor and Receiver + description: Source Provider contributes learners to the + related Provider, once the learners have + completed education at the source Provider. + enum: + - CAR + - title: Client and Host + description: Source Provider sends learners to the + related Provider for the provision of some + classes. Exact student and class details + will be recorded in co-enrolment flavour of + StudentProviderEnrolment. + enum: + - CAH + - title: Teen Parent Unit + description: Source Provider is a Teen Parent Unit which + is operated as part of the related Provider. + Learners who are also parents attend classes + at both the Teen Parent Unit and the host + school. + enum: + - TPU + - title: Activity Centre + description: Source Provider is an Activity Centre which + is operated as part of the related Provider. + Learners who have been identified as being + at risk of disengaging from mainstream + Schooling attend classes at both the + Activity Centre and the host school. + enum: + - ACE + SourceProvider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1ProviderRelationships/get/respon\ + ses/200/content/application~1json/schema/pr\ + operties/ProviderRelationships/properties/P\ + roviderRelationship/items/properties/Provid\ + erRelationshipRefId" + LocalId: + $ref: "#/paths/~1ProviderRelationships/get/respon\ + ses/200/content/application~1json/schema/pr\ + operties/ProviderRelationships/properties/P\ + roviderRelationship/items/properties/Provid\ + erRelationshipLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + SourceProviderAgreementDate: + type: string + format: date + description:

The date the source Provider in the + relationship registered their agreement to the + relationship. nil value if the source Provider + is yet to register their agreement ot the + relationship.

+ RelatedProvider: + $ref: "#/paths/~1ProviderRelationships/get/responses/\ + 200/content/application~1json/schema/properties\ + /ProviderRelationships/properties/ProviderRelat\ + ionship/items/properties/SourceProvider" + RelatedProviderAgreementDate: + type: string + format: date + description:

The date the related Provider in the + relationship registered their agreement to the + relationship. nil value if the related Provider + is yet to register their agreement ot the + relationship.

+ EffectiveDate: + type: string + format: date + description:

The date from which the provider relationship + is active.

+ ExpirationDate: + type: string + format: date + description:

The date after which the provider + relationship is no longer active.

+ YearLevelList: + description:

A list of YearLevels, denoting the year + levels of the learners being hosted or sent from + the client or contributing provider

+ type: object + required: + - YearLevel + properties: + YearLevel: + type: array + items: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are + valid for describing Funding Year Level + and Current Year Level for a student + enrolment.

Current Year Level + indicates the year level of the student’s + class cohort and the level at which the + student spends most of their time at + school. While a student may be enrolled in + subjects at varying instructional year + levels, in relation to the student + enrolment this value represents the year + level at which the student is considered + to be predominantly taught.

Funding + Year Level measures the actual number of + years that the student has attended a + school. It provides the Ministry with a + method of counting students for funding + purposes which is independent of the way + schools are organised or the particular + programme of study that a student may + undertake. Funding Year Level for most + students is based on the date they first + started school.

School Year Level + is used to indicate the instructional year + levels offered by a school, i.e. those + years for which student enrolments may be + accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code + indicates Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + SubjectAreaList: + description:

A list of Subject or Learning Areas, denoting + the curriculum subjects or learning areas that + the learners being sent by the Source Provider + are taught at the Related Provider.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZ Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication + Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural + Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication + (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + Description: + type: string + description:

Free text description providing more detail + about the provider relationship.

+ description:

Records a recognised relationship between two + education Providers. The two providers are referred + to as the Source Provider and the Related Provider. +

RelationshipType records the nature of the + relationship between the two providers, and gives + guidance on which Provider is the Source Provider + and which is the Related Provider.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + application/xml: + schema: + type: object + properties: + ProviderRelationships: + type: object + description: A List of ProviderRelationship objects + properties: + ProviderRelationship: + type: array + items: + $ref: "#/paths/~1ProviderRelationships/get/responses/200/\ + content/application~1json/schema/properties/Provide\ + rRelationships/properties/ProviderRelationship/item\ + s" + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/ProviderRelationships/{ProviderRelationshipRefId}": + post: + tags: + - ProviderRelationship + summary: Default operation to create a single ProviderRelationship + parameters: + - name: ProviderRelationshipRefId + in: path + description:

The SIF GUID for the relationship between two providers.

+ required: true + schema: + type: string + operationId: createProviderRelationship + requestBody: + description: CRUD operation on ProviderRelationship + content: + application/json: + schema: + type: object + properties: + ProviderRelationship: + $ref: "#/paths/~1ProviderRelationships/get/responses/200/content/\ + application~1json/schema/properties/ProviderRelationships/p\ + roperties/ProviderRelationship/items" + application/xml: + schema: + type: object + properties: + ProviderRelationship: + $ref: "#/paths/~1ProviderRelationships/get/responses/200/content/\ + application~1json/schema/properties/ProviderRelationships/p\ + roperties/ProviderRelationship/items" + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - ProviderRelationship + summary: Default operation to update a single ProviderRelationship + parameters: + - name: ProviderRelationshipRefId + in: path + description:

The SIF GUID for the relationship between two providers.

+ required: true + schema: + type: string + operationId: updateProviderRelationship + requestBody: + description: CRUD operation on ProviderRelationship + content: + application/json: + schema: + type: object + properties: + ProviderRelationship: + type: object + properties: + ProviderRelationshipRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + ProviderRelationshipLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + RelationshipType: + type: string + title: Provider Relationship Type + description: >- +

A code describing the nature of the relationship + between the pair of Providers

    +
  • 'CAR' - Contributor and Receiver
    • +
  • 'CAH' - Client and Host
    • +
  • 'TPU' - Teen Parent Unit
    • +
  • 'ACE' - Activity Centre
    • +
+ oneOf: + - title: Contributor and Receiver + description: Source Provider contributes learners to the related + Provider, once the learners have completed education + at the source Provider. + enum: + - CAR + - title: Client and Host + description: Source Provider sends learners to the related + Provider for the provision of some classes. Exact + student and class details will be recorded in + co-enrolment flavour of StudentProviderEnrolment. + enum: + - CAH + - title: Teen Parent Unit + description: Source Provider is a Teen Parent Unit which is + operated as part of the related Provider. Learners + who are also parents attend classes at both the Teen + Parent Unit and the host school. + enum: + - TPU + - title: Activity Centre + description: Source Provider is an Activity Centre which is + operated as part of the related Provider. Learners + who have been identified as being at risk of + disengaging from mainstream Schooling attend classes + at both the Activity Centre and the host school. + enum: + - ACE + SourceProvider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1ProviderRelationships~1%7BProviderRelati\ + onshipRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/ProviderRelationship/proper\ + ties/ProviderRelationshipRefId" + LocalId: + $ref: "#/paths/~1ProviderRelationships~1%7BProviderRelati\ + onshipRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/ProviderRelationship/proper\ + ties/ProviderRelationshipLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + SourceProviderAgreementDate: + type: string + format: date + description:

The date the source Provider in the relationship + registered their agreement to the relationship. nil + value if the source Provider is yet to register their + agreement ot the relationship.

+ RelatedProvider: + $ref: "#/paths/~1ProviderRelationships~1%7BProviderRelationsh\ + ipRefId%7D/put/requestBody/content/application~1json/sc\ + hema/properties/ProviderRelationship/properties/SourceP\ + rovider" + RelatedProviderAgreementDate: + type: string + format: date + description:

The date the related Provider in the relationship + registered their agreement to the relationship. nil + value if the related Provider is yet to register their + agreement ot the relationship.

+ EffectiveDate: + type: string + format: date + description:

The date from which the provider relationship is + active.

+ ExpirationDate: + type: string + format: date + description:

The date after which the provider relationship is no + longer active.

+ YearLevelList: + description:

A list of YearLevels, denoting the year levels of the + learners being hosted or sent from the client or + contributing provider

+ type: object + properties: + YearLevel: + type: array + items: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid + for describing Funding Year Level and Current Year + Level for a student enrolment.

Current Year + Level indicates the year level of the student’s + class cohort and the level at which the student + spends most of their time at school. While a + student may be enrolled in subjects at varying + instructional year levels, in relation to the + student enrolment this value represents the year + level at which the student is considered to be + predominantly taught.

Funding Year Level + measures the actual number of years that the + student has attended a school. It provides the + Ministry with a method of counting students for + funding purposes which is independent of the way + schools are organised or the particular programme + of study that a student may undertake. Funding + Year Level for most students is based on the date + they first started school.

School Year + Level is used to indicate the instructional year + levels offered by a school, i.e. those years for + which student enrolments may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates + Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + SubjectAreaList: + description:

A list of Subject or Learning Areas, denoting the + curriculum subjects or learning areas that the learners + being sent by the Source Provider are taught at the + Related Provider.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + Description: + type: string + description:

Free text description providing more detail about the + provider relationship.

+ description:

Records a recognised relationship between two education + Providers. The two providers are referred to as the Source + Provider and the Related Provider.

RelationshipType + records the nature of the relationship between the two + providers, and gives guidance on which Provider is the + Source Provider and which is the Related Provider.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + application/xml: + schema: + type: object + properties: + ProviderRelationship: + $ref: "#/paths/~1ProviderRelationships~1%7BProviderRelationshipRe\ + fId%7D/put/requestBody/content/application~1json/schema/pro\ + perties/ProviderRelationship" + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - ProviderRelationship + summary: Default operation to get a single ProviderRelationship + parameters: + - name: ProviderRelationshipRefId + in: path + description:

The SIF GUID for the relationship between two providers.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ProviderRelationship: + $ref: "#/paths/~1ProviderRelationships/get/responses/200/conten\ + t/application~1json/schema/properties/ProviderRelationshi\ + ps/properties/ProviderRelationship/items" + application/xml: + schema: + type: object + properties: + ProviderRelationship: + $ref: "#/paths/~1ProviderRelationships/get/responses/200/conten\ + t/application~1json/schema/properties/ProviderRelationshi\ + ps/properties/ProviderRelationship/items" + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - ProviderRelationship + summary: Default operation to delete a single ProviderRelationship + parameters: + - name: ProviderRelationshipRefId + in: path + description:

The SIF GUID for the relationship between two providers.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /Organisations: + get: + tags: + - Organisation + summary: Default operation to get a list of all available Organisations + description: Search the set of available Organisations, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + Organisations: + type: object + description: A List of Organisation objects + properties: + Organisation: + type: array + items: + required: + - Type + type: object + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. e.g. Communities of Learning | Kāhui Ako, + Ministry local offices, Industry training + organisations, etc. + properties: + MinistryOfEducationId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + AddressList: + description:

The set of postal and other addresses that + the Organisation uses

+ type: object + required: + - Address + properties: + Address: + type: array + items: + description:

This element contains address data.

+ type: object + required: + - Street + properties: + Type: + type: string + title: Address Type + description: >- +

Address type allows an address to + be categorised according to its + component structure. Address type can + be used to build processing rules for + validating, managing and presenting + addresses. Address type is independent + of the use of the address by any + party. To describe how a party may use + an address (residence, billing, term + address etc) see AddressRoleType

+
    +
  • 'TH' - Thoroughfare
    • +
  • 'RU' - Rural Post Delivery
    • +
  • 'DE' - Delivery Service
    • +
  • 'WA' - Water
    • +
  • 'FO' - Foreign Address
    • +
+ oneOf: + - title: Thoroughfare + description: "\"

Also called 'Street' + addresses, The most general, and + widely used type of address, and + can contain the widest variety of + components

In general a + thoroughfare address will include + components for a number, a + roadname, and a locality.

+

They cannot contain any of the + components specific to a delivery + service, rural post delivery, or + water address.

These + addresses are used to find a + location.

Example: 30 - 40 + Lambton Quay, Wellington, + 6165

\"" + enum: + - TH + - title: Rural Post Delivery + description: '"

Defined by New Zealand Post, + these addresses are assigned by NZ + Post for customers who purchase a + rural delivery service (mail and + also other goods).

They + will have the same number and + roadname components as the street + address, and may have the same + region component.

They do + not have a component that + identifies the locality the + address is within. The locality + and city or town components are + replaced by components that + identify the rural delivery route + (RD number), and the town from + which the rural delivery route + starts and finishes (the mail + town). Only addresses of this + class can contain these + components.

+ Example: 121 Waitaha + Road, RD 1, Ross, 7885

"' + enum: + - RU + - title: Delivery Service + description: '"

Defined by New Zealand Post, + and used exclusively for NZ Post + services other than standard mail + delivery. Addresses in this class + include PO Box, Private Bag, and + Counter Delivery addresses.

+

Example: Private Bag + 2345, Auckland, 1142

"' + enum: + - DE + - title: Water + description: '"

Where properties have no road + access, but do have access to + water frontage (coastline or + riverbank or lakefront), a water + address uses the name of a water + feature (for example, islands, + rivers, bays, or peninsulas).

+

Example: 235 Lochmara + Bay, Queen Charlotte Sound, + Marlborough Sounds

"' + enum: + - WA + - title: Foreign Address + description: '"

A foreign address identifies + a location outside of New + Zealand.

Example: + Rudolf-Diesel-Strasse 14, 54595 + Prüm, Germany

"' + enum: + - FO + Role: + type: string + title: Address Role + description: >- +

A standardised description of the + role or usage of an address by a party + (person or organisation). Where a + party has more than one address, this + provides context for deciding which + address to use.

    +
  • 'PHY' - Physical Address
    • +
  • 'POS' - Postal Address
    • +
+ oneOf: + - title: Physical Address + description: Applies to addresses associated + with persons + enum: + - PHY + - title: Postal Address + description: Applies to addresses associated + with persons or organisations + enum: + - POS + Street: + description:

The street element is a complex + element and breaks the street down + into several parts. (Allow for PO Box + here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban addresses, + or the 'RD No' part of rural + addresses

+ City: + type: string + description:

The city part of the address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only applicable if + a non-New Zealand Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid x,y + coordinates and converted to Latitude + and Longitude values per the World + Geodetic System 1984 (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes north + of the equator are positive, + latitudes south of the equator are + negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes east of + the Prime Meridian in Greenwich + are positive, longitudes west of + the Prime Meridian are negative. + The 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

The + list may contain exactly one + StatisticalArea element for each of + the following spatial unit types:

+
  • Ward
  • Urban Area
    • +
  • Census Area Unit
  • Māori + Electorate
  • Mesh Block
    • +
  • General Electorate
    • +
  • Territorial Authority
    • +
  • Local Board (Auckland Only)
    • +
  • Regional Council
+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area + defined by Statistics New + Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + type: string + title: Spatial Unit Type + description: >- +

A classification of + geographical boundaries or + statistical areas as defined + by Statistics NZ’s + geographic hierarchy.

+
    +
  • 'AE' - Area Unit
    • +
  • 'GE' - General Electoral District
    • +
  • 'CB' - Community Board
    • +
  • 'ME' - Māori Electoral District
    • +
  • 'MB' - Mesh Block
    • +
  • 'RC' - Regional Council
    • +
  • 'TA' - Territorial Authority
    • +
  • 'UA' - Urban Area
    • +
  • 'WA' - Ward
    • +
+ oneOf: + - title: Area Unit + description:

Area units are + aggregations of + meshblocks. They are + non–administrative areas + that are in between + meshblocks and + territorial authorities + in size. Area units must + either define or + aggregate to define, + regional councils, + territorial authorities + and urban areas.

+ Statistics NZ + Classification of Area + Unit 2013 v1.0.0 + enum: + - AE + - title: General Electoral + District + description:

The general electoral + districts as constituted + under the Electoral Act + 1993.

Statistics NZ + General Electoral + District 2014 v1.0.0 + enum: + - GE + - title: Community Board + description:

(aka Local Board + within Auckland) Local + boards provide + governance at the local + level within Auckland + Council. They enable + democratic decision + making by, and on behalf + of communities within + the local board + area.

Statistics NZ + Community Board 2013 + v1.0.0 + enum: + - CB + - title: Māori Electoral District + description:

Māori electoral + districts are the voting + districts for + parliamentary elections + for people who choose to + be on the Māori + Electoral Roll.

+ Statistics NZ Māori + Electoral District 2014 + v1.0.0 + enum: + - ME + - title: Mesh Block + description:

A meshblock is the + smallest geographic unit + for which statistical + data is collected and + processed by Statistics + New Zealand.

A + meshblock is defined by + a geographic area, which + can vary in size from + part of a city block to + a large area of rural + land. Each meshblock + borders on another to + form a network covering + all of New Zealand, + including coasts and + inlets and extending out + to the 200-mile economic + zone.

Statistics NZ + Statistical Standard for + Meshblock 2013 v1.0.0 + enum: + - MB + - title: Regional Council + description:

The top tier of local + government in New + Zealand, defined by the + Local Government Act + 2002, which requires the + boundaries of regions to + conform as far as + possible to one or more + water catchments. When + determining regional + boundaries, the Local + Government Commission + gave consideration to + regional communities of + interest when selecting + water catchments to be + included in a region. It + also considered factors + such as natural resource + management, land use + planning and + environmental + matters.

Statistics + NZ Regional Council 2013 + v1.0.0 + enum: + - RC + - title: Territorial Authority + description:

The second tier of + local government in New + Zealand, defined under + the Local Government Act + 2002 as a city council + or district council. + There are 67 territorial + authorities consisting + of 12 city councils, 53 + districts, Auckland + Council, and Chatham + Islands Council.

+ Statistics NZ + Territorial Authority + 2013 v1.0.0 + enum: + - TA + - title: Urban Area + description: '"

Urban Areas are + statistically defined + areas with no + administrative or legal + basis. There is a three + part hierarchical + sub-division of urban + areas into: main urban + areas, secondary urban + areas, minor urban + areas. Together the + populations in main, + secondary and minor + urban areas comprise the + statistically defined + urban population of New + Zealand. The urban area + classification is + designed to identify + concentrated urban or + semi-urban settlements + without the distortions + of administrative + boundaries.

+ Statistics NZ Urban Area + 2013 v2.0.0"' + enum: + - UA + - title: Ward + description:

Wards are defined + under the Local + Electoral Act 2001 and + result from the + division, for electoral + purposes, of the + district of a + territorial authority. + The ward system was + designed to allow for + the recognition of + communities within a + district and to increase + community involvement in + the local government + system.

Statistics + NZ Ward 2013 v1.0.0 + enum: + - WA + Code: + type: string + description:

A valid value defined by + the nominated spatial unit + type, defined by Statistics + New Zealand in one of the + following statistical area + defintion standards:

+
Area Unit
+
Statistics NZ + Classification of Area Unit + 2017 v1.0.0
General + Electoral District
+
Statistics NZ General + Electoral District 2014 + v1.0.0
Community + Board
Statistics NZ + Community Board (codes 07601 + - 07621) 2018 v1.0.0
+
Māori Electoral + District
Statistics + NZ Māori Electoral District + 2014 v1.0.0
Mesh + Block
Statistics NZ + Statistical Standard for + Meshblock 2018 v1.0.0
+
Regional Council
+
Statistics NZ Regional + Council 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority 2018 + v1.0.0
Urban + Area
Statistics NZ + Urban Area 2018 v1.0.0
+
Ward
Statistics + NZ Ward 2018 v1.0.0
+
+ CommunicationChannelList: + description:

A list of one or more methods of + communication with the organisation

+ type: object + required: + - Channel + properties: + Channel: + type: array + items: + description:

A particular person or organisation's + communications method

+ type: object + required: + - Value + properties: + Type: + type: string + title: Communication Channel Type + description: >- +

A standardised method of describing + a communication channel used to + communicate with or find information + about a party. Provides a more generic + definition than phone and email. + Intended to provide for future + requirements to record social network + channels, eg Facebook & Twitter + identifiers for a school.

    +
  • 'WEB' - Website
    • +
  • 'TWT' - Twitter
    • +
  • 'FBK' - Facebook
    • +
+ oneOf: + - title: Website + description: Typically refers to the home page + for an entity + enum: + - WEB + - title: Twitter + description: Twitter handle + enum: + - TWT + - title: Facebook + description: Facebook page + enum: + - FBK + Value: + type: string + description: "

The unique value that provides + access to the channel. eg: URL for a + website; Facebook page addess, Twitter + handle.

" + ContactList: + description:

A list of one or more cotact persons related + to the organisation

+ type: object + required: + - Contact + properties: + Contact: + type: array + items: + description:

A particular person's contact + details

+ type: object + required: + - Name + properties: + Name: + description:

The contact's name

+ type: object + properties: + Title: + type: string + description:

A title or prefix associated + with the name.

+ FamilyName: + type: string + description:

Also known as Last Name, + although some cultures may not + present a family name as the last + name.

+ GivenName: + type: string + description:

Also known as First Name, + although some cultures may not + present this name as the first + element in a name. May contain a + composite of all given names.

+ MiddleName: + type: string + description:

Where more than one Given Name, + these may be combined in one + composite field or else populated + in several elements.

+ FamilyNameFirst: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, + no, unknown and not provided + values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PreferredFamilyName: + type: string + description:

A preferred version of the + Family Name. Note:A name cannot + have both a Preferred Family and + Preferred Given Name within the + same Name structure – only one of + these fields should be populated. + If a person does have both a + Preferred Family and Preferred + Given Name then this must be + populated as a separate Name of + type ‘Preferred’.

+ PreferredFamilyNameFirst: + $ref: "#/paths/~1Organisations/get/resp\ + onses/200/content/application~1js\ + on/schema/properties/Organisation\ + s/properties/Organisation/items/p\ + roperties/ContactList/properties/\ + Contact/items/properties/Name/pro\ + perties/FamilyNameFirst" + PreferredGivenName: + type: string + description: "

A preferred version of the + Given Name. Note: A name cannot + have both a Preferred Family and + Preferred Given Name within the + same Name structure – only one of + these fields should be populated. + If a person does have both a + Preferred Family and Preferred + Given Name then this must be + populated as a separate Name of + type ‘Preferred’.

" + Suffix: + type: string + description:

Textual suffix like PHD, JP, + BSc.

+ FullName: + type: string + description:

A combination of all name + elements as one composite text + element

+ Type: + type: string + title: Name Usage Type + description: >- +

A standardised method of + describing the usage of a name by + a person. Where a person has more + than one current name, the usage + type indicates which name may be + used according to the purpose.

+

Code values are based on SIF + Australia 3.4.

    +
  • 'PRF' - Preferred Name
    • +
  • 'FON' - Foreign Official Name
    • +
  • 'PRV' - Previous name
    • +
  • 'AKA' - Also Known As
    • +
  • 'BTH' - Name at Birth
    • +
  • 'LGL' - Legal Name
    • +
+ oneOf: + - title: Preferred Name + description:

The name by which an + individual prefers to be known + and addressed.

Only + usage type applicable for + student name usage (other + types are not supported by + NSI).

+ enum: + - PRF + - title: Foreign Official Name + description:

Included for future usage + in NZ, especially for tertiary + students.

+ enum: + - FON + - title: Previous name + enum: + - PRV + - title: Also Known As + description: AKA or Alias + enum: + - AKA + - title: Name at Birth + enum: + - BTH + - title: Legal Name + description:

Legal Name or Official Name + as defined by the organisation + which collects it (legal name + is not defined in this + standard)

+ enum: + - LGL + IsVerified: + $ref: "#/paths/~1Organisations/get/resp\ + onses/200/content/application~1js\ + on/schema/properties/Organisation\ + s/properties/Organisation/items/p\ + roperties/ContactList/properties/\ + Contact/items/properties/Name/pro\ + perties/FamilyNameFirst" + PositionTitle: + type: string + description:

The title the contact has within + the Organisation being contacted

+ Role: + type: string + title: Organisation Contact Role + description: >- +

The role played by a person in an + organisation where that person is + recorded as a contact. The role + definition is used to recognise + similar functions across + organisations, however individuals + with the same role may be given + different position titles that differ + from the generic role description. For + example, a principal may have a title + of ‘headmaster’.

    +
  • 'PRI' - Principal
    • +
  • 'ACT' - Acting Principal
    • +
  • 'DIR' - Director
    • +
  • 'ECE' - ECE Management Contact
    • +
+ oneOf: + - title: Principal + enum: + - PRI + - title: Acting Principal + enum: + - ACT + - title: Director + enum: + - DIR + - title: ECE Management Contact + enum: + - ECE + AddressList: + description:

A list of Address elements.

+ type: object + required: + - Address + properties: + Address: + type: array + items: + description:

This element contains address + data.

+ type: object + required: + - Street + properties: + Type: + $ref: "#/paths/~1Organisations/ge\ + t/responses/200/content/app\ + lication~1json/schema/prope\ + rties/Organisations/propert\ + ies/Organisation/items/prop\ + erties/AddressList/properti\ + es/Address/items/properties\ + /Type" + Role: + $ref: "#/paths/~1Organisations/ge\ + t/responses/200/content/app\ + lication~1json/schema/prope\ + rties/Organisations/propert\ + ies/Organisation/items/prop\ + erties/AddressList/properti\ + es/Address/items/properties\ + /Role" + Street: + description:

The street element is a + complex element and breaks + the street down into several + parts. (Allow for PO Box + here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' + part of rural addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province + code. StateTerritory Code + only applicable if a non-New + Zealand Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude + of the location. Grid + location values are derived + from New Zealand Map Grid + x,y coordinates and + converted to Latitude and + Longitude values per the + World Geodetic System 1984 + (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

+ Latitudes north of the + equator are positive, + latitudes south of the + equator are negative + [ISO 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

+

Longitudes east of + the Prime Meridian in + Greenwich are positive, + longitudes west of the + Prime Meridian are + negative. The 180th + meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical + Areas containing the + location.

The list + may contain exactly one + StatisticalArea element for + each of the following + spatial unit types:

    +
  • Ward
  • Urban + Area
  • Census Area + Unit
  • Māori + Electorate
  • Mesh + Block
  • General + Electorate
    • +
  • Territorial + Authority
  • Local + Board (Auckland Only)
    • +
  • Regional Council
    • +
+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular + statistical area + defined by Statistics + New Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + $ref: "#/paths/~1Organi\ + sations/get/respons\ + es/200/content/appl\ + ication~1json/schem\ + a/properties/Organi\ + sations/properties/\ + Organisation/items/\ + properties/AddressL\ + ist/properties/Addr\ + ess/items/propertie\ + s/StatisticalAreaLi\ + st/properties/Stati\ + sticalArea/items/pr\ + operties/SpatialUni\ + tType" + Code: + type: string + description:

A valid value + defined by the + nominated spatial + unit type, defined + by Statistics New + Zealand in one of + the following + statistical area + defintion + standards:

+
Area Unit
+
Statistics NZ + Classification of + Area Unit 2017 + v1.0.0
+
General + Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community + Board
+
Statistics NZ + Community Board + (codes 07601 - + 07621) 2018 + v1.0.0
+
Māori Electoral + District
+
Statistics NZ + Māori Electoral + District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard + for Meshblock 2018 + v1.0.0
+
Regional + Council
+
Statistics NZ + Regional Council + 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial + Authority 2018 + v1.0.0
+
Urban Area
+
Statistics NZ + Urban Area 2018 + v1.0.0
+
Ward
+
Statistics NZ + Ward 2018 + v1.0.0
+ EmailList: + description:

List of Email elements.

+ type: object + required: + - Email + properties: + Email: + type: array + items: + description:

This element represents an + e-mail address of one of a + number of types and occurs in + objects such as StudentPersonal, + StaffPersonal, + StudentContactPersonal, etc. +

+ type: object + required: + - Address + properties: + Type: + type: string + title: Email Type + description: >- +

A standardised method of + describing an electronic + mail address used as contact + method by a party. Where a + party has more than one + email address, this may + provide context for deciding + which email address to + use.

    +
  • 'PRIM' - Primary
    • +
  • 'WORK' - Work
    • +
  • 'PERS' - Personal
    • +
  • 'ALT1' - Alternate 1
    • +
  • 'ALT2' - Alternate 2
    • +
  • 'ALT3' - Alternate 3
    • +
  • 'ALT4' - Alternate 4
    • +
+ oneOf: + - title: Primary + description: Applicable to + organisations, eg + schools + enum: + - PRIM + - title: Work + description: Only used for persons + enum: + - WORK + - title: Personal + description: Only used for persons + enum: + - PERS + - title: Alternate 1 + enum: + - ALT1 + - title: Alternate 2 + enum: + - ALT2 + - title: Alternate 3 + enum: + - ALT3 + - title: Alternate 4 + enum: + - ALT4 + Address: + type: string + description:

The actual email + address.

+ PhoneNumberList: + description:

List of PhoneNumber elements.

+ type: object + required: + - PhoneNumber + properties: + PhoneNumber: + type: array + items: + description:

This element represents a + phone number and occurs within + objects such as StudentPersonal, + StaffPersonal, etc.

+ type: object + required: + - Number + properties: + Type: + type: string + title: Telephone Number Type + description: >- +

A standardised method of + describing a + telecommunications device + used as contact method by a + party. Where a party has + more than one phone number, + this may provide context for + deciding which number to + use.

    +
  • 'MAI' - Main Telephone Number
    • +
  • 'FAX' - Facsimile Number
    • +
  • 'HTE' - Home Telephone Number
    • +
  • 'HMO' - Home Mobile
    • +
  • 'MOB' - Mobile
    • +
  • 'WMO' - Work Mobile
    • +
  • 'WTE' - Work Telephone Number
    • +
+ oneOf: + - title: Main Telephone Number + enum: + - MAI + - title: Facsimile Number + enum: + - FAX + - title: Home Telephone Number + description: Person usage only + enum: + - HTE + - title: Home Mobile + description: Person usage only + enum: + - HMO + - title: Mobile + enum: + - MOB + - title: Work Mobile + enum: + - WMO + - title: Work Telephone Number + enum: + - WTE + Number: + type: string + description: "

Phone number. Free-form, + but typical New Zealand + formats include:

    +
  • (0##) ###-####
    • +
  • ###-####
  • +##### + ### ####
" + Extension: + type: string + description:

Phone number + extension.

+ ListedStatus: + $ref: "#/paths/~1Organisations/ge\ + t/responses/200/content/app\ + lication~1json/schema/prope\ + rties/Organisations/propert\ + ies/Organisation/items/prop\ + erties/ContactList/properti\ + es/Contact/items/properties\ + /Name/properties/FamilyName\ + First" + EducationRegion: + type: string + title: Education Region + description: >- + Regions of New Zealand defined by Ministry of + Education for administrative purposes.
    +
  • 'TAIT' - Tai Tokerau
    • +
  • 'AUCK' - Auckland
    • +
  • 'WAIK' - Waikato
    • +
  • 'BOPW' - Bay of Plenty, Waiariki
    • +
  • 'HAWK' - Hawke's Bay, Tairāwhiti
    • +
  • 'TARA' - Taranaki, Whanganui, Manawatū
    • +
  • 'WELL' - Wellington
    • +
  • 'NELS' - Nelson, Marlborough, West Coast
    • +
  • 'CANT' - Canterbury, Chatham Islands
    • +
  • 'OTAG' - Otago, Southland
    • +
+ oneOf: + - title: Tai Tokerau + enum: + - TAIT + - title: Auckland + enum: + - AUCK + - title: Waikato + enum: + - WAIK + - title: Bay of Plenty, Waiariki + enum: + - BOPW + - title: Hawke's Bay, Tairāwhiti + enum: + - HAWK + - title: Taranaki, Whanganui, Manawatū + enum: + - TARA + - title: Wellington + enum: + - WELL + - title: Nelson, Marlborough, West Coast + enum: + - NELS + - title: Canterbury, Chatham Islands + enum: + - CANT + - title: Otago, Southland + enum: + - OTAG + EmailList: + description:

The set of contact email addresses that the + Organisation uses

+ type: object + required: + - Email + properties: + Email: + type: array + items: + description:

This element represents an e-mail + address of one of a number of types and + occurs in objects such as StudentPersonal, + StaffPersonal, StudentContactPersonal, + etc.

+ type: object + required: + - Address + properties: + Type: + $ref: "#/paths/~1Organisations/get/response\ + s/200/content/application~1json/schem\ + a/properties/Organisations/properties\ + /Organisation/items/properties/Contac\ + tList/properties/Contact/items/proper\ + ties/EmailList/properties/Email/items\ + /properties/Type" + Address: + type: string + description:

The actual email address.

+ EntityClose: + type: string + format: date + description:

Closing date of entity. Only present for + closed providers.

+ EntityOpen: + type: string + format: date + description:

Opening date of entity. For proposed schools + this will be the projected opening date. For + open schools this may not be present.

+ LocationList: + description:

A list of one or more locations, from which + the organisation operates or provides a + service.

+ type: object + required: + - Location + properties: + Location: + type: array + items: + description:

This element contains data about a + geographical location.

+ type: object + properties: + Description: + type: string + description:

A description for the Location.

+ Address: + description:

The physical address of the + Location

+ type: object + required: + - Street + properties: + Type: + $ref: "#/paths/~1Organisations/get/resp\ + onses/200/content/application~1js\ + on/schema/properties/Organisation\ + s/properties/Organisation/items/p\ + roperties/AddressList/properties/\ + Address/items/properties/Type" + Role: + $ref: "#/paths/~1Organisations/get/resp\ + onses/200/content/application~1js\ + on/schema/properties/Organisation\ + s/properties/Organisation/items/p\ + roperties/AddressList/properties/\ + Address/items/properties/Role" + Street: + description:

The street element is a complex + element and breaks the street down + into several parts. (Allow for PO + Box here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' part of + rural addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only + applicable if a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid + x,y coordinates and converted to + Latitude and Longitude values per + the World Geodetic System 1984 + (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes + north of the equator are + positive, latitudes south of + the equator are negative [ISO + 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes + east of the Prime Meridian in + Greenwich are positive, + longitudes west of the Prime + Meridian are negative. The + 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

+

The list may contain exactly + one StatisticalArea element for + each of the following spatial unit + types:

  • Ward
    • +
  • Urban Area
  • Census + Area Unit
  • Māori + Electorate
  • Mesh + Block
  • General + Electorate
  • Territorial + Authority
  • Local Board + (Auckland Only)
  • Regional + Council
+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical + area defined by Statistics + New Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + $ref: "#/paths/~1Organisation\ + s/get/responses/200/con\ + tent/application~1json/\ + schema/properties/Organ\ + isations/properties/Org\ + anisation/items/propert\ + ies/AddressList/propert\ + ies/Address/items/prope\ + rties/StatisticalAreaLi\ + st/properties/Statistic\ + alArea/items/properties\ + /SpatialUnitType" + Code: + type: string + description:

A valid value defined + by the nominated spatial + unit type, defined by + Statistics New Zealand + in one of the following + statistical area + defintion standards:

+
Area Unit
+
Statistics NZ + Classification of Area + Unit 2017 v1.0.0
+
General Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community Board
+
Statistics NZ + Community Board (codes + 07601 - 07621) 2018 + v1.0.0
Māori + Electoral District
+
Statistics NZ Māori + Electoral District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard for + Meshblock 2018 + v1.0.0
Regional + Council
+
Statistics NZ + Regional Council 2018 + v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority + 2018 v1.0.0
+
Urban Area
+
Statistics NZ Urban + Area 2018 v1.0.0
+
Ward
+
Statistics NZ Ward + 2018 v1.0.0
+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid x,y + coordinates and converted to Latitude + and Longitude values per the World + Geodetic System 1984 (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes north + of the equator are positive, + latitudes south of the equator are + negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes east of + the Prime Meridian in Greenwich + are positive, longitudes west of + the Prime Meridian are negative. + The 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

The + list may contain exactly one + StatisticalArea element for each of + the following spatial unit types:

+
  • Ward
  • Urban Area
    • +
  • Census Area Unit
  • Māori + Electorate
  • Mesh Block
    • +
  • General Electorate
    • +
  • Territorial Authority
    • +
  • Local Board (Auckland Only)
    • +
  • Regional Council
+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area + defined by Statistics New + Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + $ref: "#/paths/~1Organisations/ge\ + t/responses/200/content/app\ + lication~1json/schema/prope\ + rties/Organisations/propert\ + ies/Organisation/items/prop\ + erties/AddressList/properti\ + es/Address/items/properties\ + /StatisticalAreaList/proper\ + ties/StatisticalArea/items/\ + properties/SpatialUnitType" + Code: + type: string + description:

A valid value defined by + the nominated spatial unit + type, defined by Statistics + New Zealand in one of the + following statistical area + defintion standards:

+
Area Unit
+
Statistics NZ + Classification of Area Unit + 2017 v1.0.0
General + Electoral District
+
Statistics NZ General + Electoral District 2014 + v1.0.0
Community + Board
Statistics NZ + Community Board (codes 07601 + - 07621) 2018 v1.0.0
+
Māori Electoral + District
Statistics + NZ Māori Electoral District + 2014 v1.0.0
Mesh + Block
Statistics NZ + Statistical Standard for + Meshblock 2018 v1.0.0
+
Regional Council
+
Statistics NZ Regional + Council 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority 2018 + v1.0.0
Urban + Area
Statistics NZ + Urban Area 2018 v1.0.0
+
Ward
Statistics + NZ Ward 2018 v1.0.0
+
+ Name: + type: string + description:

The normal business name of the + Organisation

+ PhoneNumberList: + description:

The set of contact phone numbers that the + Organisation uses

+ type: object + required: + - PhoneNumber + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone number + and occurs within objects such as + StudentPersonal, StaffPersonal, etc.

+ type: object + required: + - Number + properties: + Type: + $ref: "#/paths/~1Organisations/get/response\ + s/200/content/application~1json/schem\ + a/properties/Organisations/properties\ + /Organisation/items/properties/Contac\ + tList/properties/Contact/items/proper\ + ties/PhoneNumberList/properties/Phone\ + Number/items/properties/Type" + Number: + type: string + description: "

Phone number. Free-form, but + typical New Zealand formats + include:

  • (0##) + ###-####
  • ###-####
    • +
  • +##### ### ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1Organisations/get/response\ + s/200/content/application~1json/schem\ + a/properties/Organisations/properties\ + /Organisation/items/properties/Contac\ + tList/properties/Contact/items/proper\ + ties/Name/properties/FamilyNameFirst" + RelatedOrganisationList: + description:

A list of other organisations that are + related to the Provider

+ type: object + required: + - RelatedOrganisation + properties: + RelatedOrganisation: + type: array + items: + description:

Extends + ObjectReferenceType to add an + extra element, + OrganisationType, describing + the nature of the related + organisation.

+ type: object + required: + - ObjectType + - Type + properties: + StartDate: + type: string + format: date + description:

The start date of the relationship + between the two organisations

+ EndDate: + type: string + format: date + description:

The end date of the relationship + between the two organisations

+ Type: + type: string + title: Organisation Relationship Type + description: >- +

A code describing the nature of the + relationship between a pair of + Organisations

    +
  • 'TPU' - Teen Parent Unit
    • +
  • 'ACR' - Activity Centre
    • +
  • 'MOE' - MoE Local Office
    • +
  • 'COL' - Community of Learning - Kāhui Ako
    • +
+ oneOf: + - title: Teen Parent Unit + description: Related organisation is a Teen + Parent Unit co-located with the + main Organisation. + enum: + - TPU + - title: Activity Centre + description: Related organisation is an + Activity Centre co-located with + the main Organisation. + enum: + - ACR + - title: MoE Local Office + description: Related organisation is Ministry + of Education Local Office that + deals with the Provider. + enum: + - MOE + - title*: + en: Community of Learning + mi: Kāhui Ako + description: Related organisation is the + Community of Learning / Kāhui Ako + that the main Organisation is a + member of + enum: + - COL + OperationalStatus: + type: string + title: Operational Status + description: >- +

Indicates the operational status of an + organisation.

    +
  • 'C' - Closed
    • +
  • 'O' - Open
    • +
  • 'P' - Proposed
    • +
+ oneOf: + - title: Closed + enum: + - C + - title: Open + enum: + - O + - title: Proposed + description: SIF AU uses the term ‘Pending’ + enum: + - P + Type: + type: string + title: Organisation Type + description: >- + Describes the organisation type of the provider, + indicating the services provided, function or + purpose of the organisation.
    +
  • '32' - Composite School (Year 1-15)
    • +
  • '21' - Contributing Primary (Year 1-6)
    • +
  • '34' - The Correspondence School
    • +
  • '20' - Full Primary (Year 1-8)
    • +
  • '22' - Intermediate (Year 7-8)
    • +
  • '35' - Restricted Composite School (Year 7-10)
    • +
  • '30' - Secondary School (Year 7-15)
    • +
  • '40' - Secondary School (Year 9-15)
    • +
  • '23' - Special School
    • +
  • '41' - Teen Parent Unit (Year 9-15)
    • +
  • '997' - Activity Centre
    • +
  • '998' - Community of Learning | Kāhui Ako
    • +
plus 1 more value(s) at NZCodeSetsOrganisationTypeType + oneOf: + - title: Composite School (Year 1-15) + enum: + - "32" + - title: Contributing Primary (Year 1-6) + enum: + - "21" + - title: The Correspondence School + enum: + - "34" + - title: Full Primary (Year 1-8) + enum: + - "20" + - title: Intermediate (Year 7-8) + enum: + - "22" + - title: Restricted Composite School (Year 7-10) + enum: + - "35" + - title: Secondary School (Year 7-15) + enum: + - "30" + - title: Secondary School (Year 9-15) + enum: + - "40" + - title: Special School + enum: + - "23" + - title: Teen Parent Unit (Year 9-15) + enum: + - "41" + - title: Activity Centre + enum: + - "997" + - title: Community of Learning | Kāhui Ako + enum: + - "998" + - title: Ministry of Education Local Office + enum: + - "999" + OrganisationRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + OrganisationLocalId: + $ref: "#/paths/~1Organisations/get/responses/200/cont\ + ent/application~1json/schema/properties/Organis\ + ations/properties/Organisation/items/properties\ + /MinistryOfEducationId" + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + Organisations: + Organisation: + - AddressList: {} + CommunicationChannelList: {} + ContactList: + Contact: + Name: + FamilyName: Dumbledore + GivenName: Albus + FullName: Albus Dumbledore + PositionTitle: Lead School Headmaster + Role: PRI + AddressList: + Address: + Type: TH + Role: PHY + Street: + Line1: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + EmailList: + Email: + - Type: PRIM + Address: stuart@gmail.com + LocationList: {} + Name: Masterton (Whakaoriori) Kāhui Ako + PhoneNumberList: + PhoneNumber: + Notes: Lead School Secretary (Mobile) + Type: MOB + Number: (021) 300 999 + Type: 998 + OrganisationRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + OrganisationLocalId: 99204 + application/xml: + schema: + type: object + properties: + Organisations: + type: object + description: A List of Organisation objects + properties: + Organisation: + type: array + items: + $ref: "#/paths/~1Organisations/get/responses/200/content/\ + application~1json/schema/properties/Organisations/p\ + roperties/Organisation/items" + example: >- + + + + + + + + Dumbledore + Albus + Albus Dumbledore + + Lead School Headmaster + PRI + +
+ TH + PHY + + 533 Hogwart's Way + + Hogsmead + 7733 +
+ + + + + + + + PRIM + stuart@gmail.com + + + + Masterton (Whakaoriori) Kāhui Ako + + + Lead School Secretary (Mobile) + MOB + (021) 300 999 + + + 998 + D3E34B35-9D75-101A-8C3D-00AA001A1652 + 99204 + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/Organisations/{OrganisationRefId}": + post: + tags: + - Organisation + summary: Default operation to create a single Organisation + parameters: + - name: OrganisationRefId + in: path + description:

The SIF GUID used by systems to identify the organisation.

+ required: true + schema: + type: string + operationId: createOrganisation + requestBody: + description: CRUD operation on Organisation + content: + application/json: + schema: + type: object + properties: + Organisation: + $ref: "#/paths/~1Organisations/get/responses/200/content/applicat\ + ion~1json/schema/properties/Organisations/properties/Organi\ + sation/items" + example: + Organisation: + AddressList: {} + CommunicationChannelList: {} + ContactList: + Contact: + Name: + FamilyName: Dumbledore + GivenName: Albus + FullName: Albus Dumbledore + PositionTitle: Lead School Headmaster + Role: PRI + AddressList: + Address: + Type: TH + Role: PHY + Street: + Line1: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + EmailList: + Email: + - Type: PRIM + Address: stuart@gmail.com + LocationList: {} + Name: Masterton (Whakaoriori) Kāhui Ako + PhoneNumberList: + PhoneNumber: + Notes: Lead School Secretary (Mobile) + Type: MOB + Number: (021) 300 999 + Type: 998 + OrganisationRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + OrganisationLocalId: 99204 + application/xml: + schema: + type: object + properties: + Organisation: + $ref: "#/paths/~1Organisations/get/responses/200/content/applicat\ + ion~1json/schema/properties/Organisations/properties/Organi\ + sation/items" + example: >- + + + + + + + Dumbledore + Albus + Albus Dumbledore + + Lead School Headmaster + PRI + +
+ TH + PHY + + 533 Hogwart's Way + + Hogsmead + 7733 +
+ + + + + + + + PRIM + stuart@gmail.com + + + + Masterton (Whakaoriori) Kāhui Ako + + + Lead School Secretary (Mobile) + MOB + (021) 300 999 + + + 998 + D3E34B35-9D75-101A-8C3D-00AA001A1652 + 99204 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - Organisation + summary: Default operation to update a single Organisation + parameters: + - name: OrganisationRefId + in: path + description:

The SIF GUID used by systems to identify the organisation.

+ required: true + schema: + type: string + operationId: updateOrganisation + requestBody: + description: CRUD operation on Organisation + content: + application/json: + schema: + type: object + properties: + Organisation: + type: object + description: A generic organisation that operates within the education + sector; but doesn’t provide education services. e.g. + Communities of Learning | Kāhui Ako, Ministry local offices, + Industry training organisations, etc. + properties: + MinistryOfEducationId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + AddressList: + description:

The set of postal and other addresses that the + Organisation uses

+ type: object + properties: + Address: + type: array + items: + description:

This element contains address data.

+ type: object + properties: + Type: + type: string + title: Address Type + description: >- +

Address type allows an address to be + categorised according to its component + structure. Address type can be used to build + processing rules for validating, managing and + presenting addresses. Address type is + independent of the use of the address by any + party. To describe how a party may use an + address (residence, billing, term address etc) + see AddressRoleType

    +
  • 'TH' - Thoroughfare
    • +
  • 'RU' - Rural Post Delivery
    • +
  • 'DE' - Delivery Service
    • +
  • 'WA' - Water
    • +
  • 'FO' - Foreign Address
    • +
+ oneOf: + - title: Thoroughfare + description: "\"

Also called 'Street' addresses, The + most general, and widely used type of + address, and can contain the widest + variety of components

In general a + thoroughfare address will include + components for a number, a roadname, and a + locality.

They cannot contain any + of the components specific to a delivery + service, rural post delivery, or water + address.

These addresses are used + to find a location.

Example: 30 - + 40 Lambton Quay, Wellington, 6165

\"" + enum: + - TH + - title: Rural Post Delivery + description: '"

Defined by New Zealand Post, these + addresses are assigned by NZ Post for + customers who purchase a rural delivery + service (mail and also other goods).

+

They will have the same number and + roadname components as the street address, + and may have the same region + component.

They do not have a + component that identifies the locality the + address is within. The locality and city + or town components are replaced by + components that identify the rural + delivery route (RD number), and the town + from which the rural delivery route starts + and finishes (the mail town). Only + addresses of this class can contain these + components.

Example: 121 + Waitaha Road, RD 1, Ross, 7885

"' + enum: + - RU + - title: Delivery Service + description: '"

Defined by New Zealand Post, and used + exclusively for NZ Post services other + than standard mail delivery. Addresses in + this class include PO Box, Private Bag, + and Counter Delivery addresses.

+ Example: Private Bag 2345, + Auckland, 1142

"' + enum: + - DE + - title: Water + description: '"

Where properties have no road access, + but do have access to water frontage + (coastline or riverbank or lakefront), a + water address uses the name of a water + feature (for example, islands, rivers, + bays, or peninsulas).

+ Example: 235 Lochmara Bay, Queen + Charlotte Sound, Marlborough Sounds

"' + enum: + - WA + - title: Foreign Address + description: '"

A foreign address identifies a + location outside of New Zealand.

+ Example: Rudolf-Diesel-Strasse + 14, 54595 Prüm, Germany

"' + enum: + - FO + Role: + type: string + title: Address Role + description: >- +

A standardised description of the role or + usage of an address by a party (person or + organisation). Where a party has more than one + address, this provides context for deciding + which address to use.

    +
  • 'PHY' - Physical Address
    • +
  • 'POS' - Postal Address
    • +
+ oneOf: + - title: Physical Address + description: Applies to addresses associated with + persons + enum: + - PHY + - title: Postal Address + description: Applies to addresses associated with + persons or organisations + enum: + - POS + Street: + description:

The street element is a complex element and + breaks the street down into several parts. + (Allow for PO Box here)

+ type: object + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban addresses, or the + 'RD No' part of rural addresses

+ City: + type: string + description:

The city part of the address.

+ StateProvince: + type: string + description:

The state or province code. StateTerritory + Code only applicable if a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the location. + Grid location values are derived from New + Zealand Map Grid x,y coordinates and converted + to Latitude and Longitude values per the World + Geodetic System 1984 (G1762)

+ type: object + properties: + Latitude: + description:

Latitude in decimal degrees.

+ Latitudes north of the equator are + positive, latitudes south of the equator + are negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal degrees.

+

Longitudes east of the Prime Meridian + in Greenwich are positive, longitudes west + of the Prime Meridian are negative. The + 180th meridian is negative. [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas containing the + location.

The list may contain exactly + one StatisticalArea element for each of the + following spatial unit types:

    +
  • Ward
  • Urban Area
  • Census + Area Unit
  • Māori Electorate
    • +
  • Mesh Block
  • General + Electorate
  • Territorial Authority
    • +
  • Local Board (Auckland Only)
    • +
  • Regional Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area defined + by Statistics New Zealand.

+ type: object + properties: + SpatialUnitType: + type: string + title: Spatial Unit Type + description: >- +

A classification of geographical + boundaries or statistical areas as + defined by Statistics NZ’s + geographic hierarchy.

    +
  • 'AE' - Area Unit
    • +
  • 'GE' - General Electoral District
    • +
  • 'CB' - Community Board
    • +
  • 'ME' - Māori Electoral District
    • +
  • 'MB' - Mesh Block
    • +
  • 'RC' - Regional Council
    • +
  • 'TA' - Territorial Authority
    • +
  • 'UA' - Urban Area
    • +
  • 'WA' - Ward
    • +
+ oneOf: + - title: Area Unit + description:

Area units are aggregations + of meshblocks. They are + non–administrative areas that + are in between meshblocks and + territorial authorities in size. + Area units must either define or + aggregate to define, regional + councils, territorial + authorities and urban areas.

+ Statistics NZ Classification of + Area Unit 2013 v1.0.0 + enum: + - AE + - title: General Electoral District + description:

The general electoral + districts as constituted under + the Electoral Act 1993.

+ Statistics NZ General Electoral + District 2014 v1.0.0 + enum: + - GE + - title: Community Board + description:

(aka Local Board within + Auckland) Local boards provide + governance at the local level + within Auckland Council. They + enable democratic decision + making by, and on behalf of + communities within the local + board area.

Statistics NZ + Community Board 2013 v1.0.0 + enum: + - CB + - title: Māori Electoral District + description:

Māori electoral districts are + the voting districts for + parliamentary elections for + people who choose to be on the + Māori Electoral Roll.

+ Statistics NZ Māori Electoral + District 2014 v1.0.0 + enum: + - ME + - title: Mesh Block + description:

A meshblock is the smallest + geographic unit for which + statistical data is collected + and processed by Statistics New + Zealand.

A meshblock is + defined by a geographic area, + which can vary in size from part + of a city block to a large area + of rural land. Each meshblock + borders on another to form a + network covering all of New + Zealand, including coasts and + inlets and extending out to the + 200-mile economic zone.

+ Statistics NZ Statistical + Standard for Meshblock 2013 + v1.0.0 + enum: + - MB + - title: Regional Council + description:

The top tier of local + government in New Zealand, + defined by the Local Government + Act 2002, which requires the + boundaries of regions to conform + as far as possible to one or + more water catchments. When + determining regional boundaries, + the Local Government Commission + gave consideration to regional + communities of interest when + selecting water catchments to be + included in a region. It also + considered factors such as + natural resource management, + land use planning and + environmental matters.

+ Statistics NZ Regional Council + 2013 v1.0.0 + enum: + - RC + - title: Territorial Authority + description:

The second tier of local + government in New Zealand, + defined under the Local + Government Act 2002 as a city + council or district council. + There are 67 territorial + authorities consisting of 12 + city councils, 53 districts, + Auckland Council, and Chatham + Islands Council.

Statistics + NZ Territorial Authority 2013 + v1.0.0 + enum: + - TA + - title: Urban Area + description: '"

Urban Areas are + statistically defined areas with + no administrative or legal + basis. There is a three part + hierarchical sub-division of + urban areas into: main urban + areas, secondary urban areas, + minor urban areas. Together the + populations in main, secondary + and minor urban areas comprise + the statistically defined urban + population of New Zealand. The + urban area classification is + designed to identify + concentrated urban or semi-urban + settlements without the + distortions of administrative + boundaries.

Statistics NZ + Urban Area 2013 v2.0.0"' + enum: + - UA + - title: Ward + description:

Wards are defined under the + Local Electoral Act 2001 and + result from the division, for + electoral purposes, of the + district of a territorial + authority. The ward system was + designed to allow for the + recognition of communities + within a district and to + increase community involvement + in the local government + system.

Statistics NZ Ward + 2013 v1.0.0 + enum: + - WA + Code: + type: string + description:

A valid value defined by the + nominated spatial unit type, defined + by Statistics New Zealand in one of + the following statistical area + defintion standards:

+
Area Unit
Statistics NZ + Classification of Area Unit 2017 + v1.0.0
General Electoral + District
Statistics NZ + General Electoral District 2014 + v1.0.0
Community Board
+
Statistics NZ Community Board + (codes 07601 - 07621) 2018 + v1.0.0
Māori Electoral + District
Statistics NZ + Māori Electoral District 2014 + v1.0.0
Mesh Block
+
Statistics NZ Statistical + Standard for Meshblock 2018 + v1.0.0
Regional + Council
Statistics NZ + Regional Council 2018 v1.0.0
+
Territorial Authority
+
Statistics NZ Territorial + Authority 2018 v1.0.0
Urban + Area
Statistics NZ Urban + Area 2018 v1.0.0
Ward
+
Statistics NZ Ward 2018 + v1.0.0
+ CommunicationChannelList: + description:

A list of one or more methods of communication with + the organisation

+ type: object + properties: + Channel: + type: array + items: + description:

A particular person or organisation's + communications method

+ type: object + properties: + Type: + type: string + title: Communication Channel Type + description: >- +

A standardised method of describing a + communication channel used to communicate with + or find information about a party. Provides a + more generic definition than phone and email. + Intended to provide for future requirements to + record social network channels, eg Facebook + & Twitter identifiers for a school.

+
    +
  • 'WEB' - Website
    • +
  • 'TWT' - Twitter
    • +
  • 'FBK' - Facebook
    • +
+ oneOf: + - title: Website + description: Typically refers to the home page for an + entity + enum: + - WEB + - title: Twitter + description: Twitter handle + enum: + - TWT + - title: Facebook + description: Facebook page + enum: + - FBK + Value: + type: string + description: "

The unique value that provides access to + the channel. eg: URL for a website; Facebook + page addess, Twitter handle.

" + ContactList: + description:

A list of one or more cotact persons related to the + organisation

+ type: object + properties: + Contact: + type: array + items: + description:

A particular person's contact details

+ type: object + properties: + Name: + description:

The contact's name

+ type: object + properties: + Title: + type: string + description:

A title or prefix associated with the + name.

+ FamilyName: + type: string + description:

Also known as Last Name, although some + cultures may not present a family name as + the last name.

+ GivenName: + type: string + description:

Also known as First Name, although some + cultures may not present this name as the + first element in a name. May contain a + composite of all given names.

+ MiddleName: + type: string + description:

Where more than one Given Name, these + may be combined in one composite field or + else populated in several elements.

+ FamilyNameFirst: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, + unknown and not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PreferredFamilyName: + type: string + description:

A preferred version of the Family Name. + Note:A name cannot have both a Preferred + Family and Preferred Given Name within the + same Name structure – only one of these + fields should be populated. If a person + does have both a Preferred Family and + Preferred Given Name then this must be + populated as a separate Name of type + ‘Preferred’.

+ PreferredFamilyNameFirst: + $ref: "#/paths/~1Organisations~1%7BOrganisation\ + RefId%7D/put/requestBody/content/applicat\ + ion~1json/schema/properties/Organisation/\ + properties/ContactList/properties/Contact\ + /items/properties/Name/properties/FamilyN\ + ameFirst" + PreferredGivenName: + type: string + description: "

A preferred version of the Given Name. + Note: A name cannot have both a Preferred + Family and Preferred Given Name within the + same Name structure – only one of these + fields should be populated. If a person + does have both a Preferred Family and + Preferred Given Name then this must be + populated as a separate Name of type + ‘Preferred’.

" + Suffix: + type: string + description:

Textual suffix like PHD, JP, BSc.

+ FullName: + type: string + description:

A combination of all name elements as + one composite text element

+ Type: + type: string + title: Name Usage Type + description: >- +

A standardised method of describing the + usage of a name by a person. Where a + person has more than one current name, the + usage type indicates which name may be + used according to the purpose.

Code + values are based on SIF Australia 3.4.

+
    +
  • 'PRF' - Preferred Name
    • +
  • 'FON' - Foreign Official Name
    • +
  • 'PRV' - Previous name
    • +
  • 'AKA' - Also Known As
    • +
  • 'BTH' - Name at Birth
    • +
  • 'LGL' - Legal Name
    • +
+ oneOf: + - title: Preferred Name + description:

The name by which an individual + prefers to be known and addressed.

+

Only usage type applicable for + student name usage (other types are + not supported by NSI).

+ enum: + - PRF + - title: Foreign Official Name + description:

Included for future usage in NZ, + especially for tertiary students.

+ enum: + - FON + - title: Previous name + enum: + - PRV + - title: Also Known As + description: AKA or Alias + enum: + - AKA + - title: Name at Birth + enum: + - BTH + - title: Legal Name + description:

Legal Name or Official Name as + defined by the organisation which + collects it (legal name is not defined + in this standard)

+ enum: + - LGL + IsVerified: + $ref: "#/paths/~1Organisations~1%7BOrganisation\ + RefId%7D/put/requestBody/content/applicat\ + ion~1json/schema/properties/Organisation/\ + properties/ContactList/properties/Contact\ + /items/properties/Name/properties/FamilyN\ + ameFirst" + PositionTitle: + type: string + description:

The title the contact has within the + Organisation being contacted

+ Role: + type: string + title: Organisation Contact Role + description: >- +

The role played by a person in an + organisation where that person is recorded as + a contact. The role definition is used to + recognise similar functions across + organisations, however individuals with the + same role may be given different position + titles that differ from the generic role + description. For example, a principal may have + a title of ‘headmaster’.

    +
  • 'PRI' - Principal
    • +
  • 'ACT' - Acting Principal
    • +
  • 'DIR' - Director
    • +
  • 'ECE' - ECE Management Contact
    • +
+ oneOf: + - title: Principal + enum: + - PRI + - title: Acting Principal + enum: + - ACT + - title: Director + enum: + - DIR + - title: ECE Management Contact + enum: + - ECE + AddressList: + description:

A list of Address elements.

+ type: object + properties: + Address: + type: array + items: + description:

This element contains address + data.

+ type: object + properties: + Type: + $ref: "#/paths/~1Organisations~1%7BOrgani\ + sationRefId%7D/put/requestBody/cont\ + ent/application~1json/schema/proper\ + ties/Organisation/properties/Addres\ + sList/properties/Address/items/prop\ + erties/Type" + Role: + $ref: "#/paths/~1Organisations~1%7BOrgani\ + sationRefId%7D/put/requestBody/cont\ + ent/application~1json/schema/proper\ + ties/Organisation/properties/Addres\ + sList/properties/Address/items/prop\ + erties/Role" + Street: + description:

The street element is a complex + element and breaks the street down + into several parts. (Allow for PO + Box here)

+ type: object + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' part of + rural addresses

+ City: + type: string + description:

The city part of the address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only applicable + if a non-New Zealand Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid + x,y coordinates and converted to + Latitude and Longitude values per + the World Geodetic System 1984 + (G1762)

+ type: object + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes north + of the equator are positive, + latitudes south of the equator + are negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes east + of the Prime Meridian in + Greenwich are positive, + longitudes west of the Prime + Meridian are negative. The 180th + meridian is negative. [ISO + 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

The + list may contain exactly one + StatisticalArea element for each of + the following spatial unit + types:

  • Ward
    • +
  • Urban Area
  • Census Area + Unit
  • Māori Electorate
    • +
  • Mesh Block
  • General + Electorate
  • Territorial + Authority
  • Local Board + (Auckland Only)
  • Regional + Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical + area defined by Statistics New + Zealand.

+ type: object + properties: + SpatialUnitType: + $ref: "#/paths/~1Organisations~\ + 1%7BOrganisationRefId%7D/\ + put/requestBody/content/a\ + pplication~1json/schema/p\ + roperties/Organisation/pr\ + operties/AddressList/prop\ + erties/Address/items/prop\ + erties/StatisticalAreaLis\ + t/properties/StatisticalA\ + rea/items/properties/Spat\ + ialUnitType" + Code: + type: string + description:

A valid value defined + by the nominated spatial + unit type, defined by + Statistics New Zealand in + one of the following + statistical area defintion + standards:

+
Area Unit
+
Statistics NZ + Classification of Area + Unit 2017 v1.0.0
+
General Electoral + District
+
Statistics NZ General + Electoral District 2014 + v1.0.0
Community + Board
Statistics + NZ Community Board (codes + 07601 - 07621) 2018 + v1.0.0
Māori + Electoral District
+
Statistics NZ Māori + Electoral District 2014 + v1.0.0
Mesh + Block
Statistics + NZ Statistical Standard + for Meshblock 2018 + v1.0.0
Regional + Council
+
Statistics NZ Regional + Council 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority 2018 + v1.0.0
Urban + Area
Statistics + NZ Urban Area 2018 + v1.0.0
Ward
+
Statistics NZ Ward + 2018 v1.0.0
+ EmailList: + description:

List of Email elements.

+ type: object + properties: + Email: + type: array + items: + description:

This element represents an e-mail + address of one of a number of types and + occurs in objects such as + StudentPersonal, StaffPersonal, + StudentContactPersonal, etc.

+ type: object + properties: + Type: + type: string + title: Email Type + description: >- +

A standardised method of + describing an electronic mail + address used as contact method by a + party. Where a party has more than + one email address, this may provide + context for deciding which email + address to use.

    +
  • 'PRIM' - Primary
    • +
  • 'WORK' - Work
    • +
  • 'PERS' - Personal
    • +
  • 'ALT1' - Alternate 1
    • +
  • 'ALT2' - Alternate 2
    • +
  • 'ALT3' - Alternate 3
    • +
  • 'ALT4' - Alternate 4
    • +
+ oneOf: + - title: Primary + description: Applicable to organisations, eg + schools + enum: + - PRIM + - title: Work + description: Only used for persons + enum: + - WORK + - title: Personal + description: Only used for persons + enum: + - PERS + - title: Alternate 1 + enum: + - ALT1 + - title: Alternate 2 + enum: + - ALT2 + - title: Alternate 3 + enum: + - ALT3 + - title: Alternate 4 + enum: + - ALT4 + Address: + type: string + description:

The actual email address.

+ PhoneNumberList: + description:

List of PhoneNumber elements.

+ type: object + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone + number and occurs within objects such as + StudentPersonal, StaffPersonal, etc.

+ type: object + properties: + Type: + type: string + title: Telephone Number Type + description: >- +

A standardised method of + describing a telecommunications + device used as contact method by a + party. Where a party has more than + one phone number, this may provide + context for deciding which number to + use.

    +
  • 'MAI' - Main Telephone Number
    • +
  • 'FAX' - Facsimile Number
    • +
  • 'HTE' - Home Telephone Number
    • +
  • 'HMO' - Home Mobile
    • +
  • 'MOB' - Mobile
    • +
  • 'WMO' - Work Mobile
    • +
  • 'WTE' - Work Telephone Number
    • +
+ oneOf: + - title: Main Telephone Number + enum: + - MAI + - title: Facsimile Number + enum: + - FAX + - title: Home Telephone Number + description: Person usage only + enum: + - HTE + - title: Home Mobile + description: Person usage only + enum: + - HMO + - title: Mobile + enum: + - MOB + - title: Work Mobile + enum: + - WMO + - title: Work Telephone Number + enum: + - WTE + Number: + type: string + description: "

Phone number. Free-form, but + typical New Zealand formats + include:

  • (0##) + ###-####
  • ###-####
    • +
  • +##### ### ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1Organisations~1%7BOrgani\ + sationRefId%7D/put/requestBody/cont\ + ent/application~1json/schema/proper\ + ties/Organisation/properties/Contac\ + tList/properties/Contact/items/prop\ + erties/Name/properties/FamilyNameFi\ + rst" + EducationRegion: + type: string + title: Education Region + description: >- + Regions of New Zealand defined by Ministry of Education + for administrative purposes.
    +
  • 'TAIT' - Tai Tokerau
    • +
  • 'AUCK' - Auckland
    • +
  • 'WAIK' - Waikato
    • +
  • 'BOPW' - Bay of Plenty, Waiariki
    • +
  • 'HAWK' - Hawke's Bay, Tairāwhiti
    • +
  • 'TARA' - Taranaki, Whanganui, Manawatū
    • +
  • 'WELL' - Wellington
    • +
  • 'NELS' - Nelson, Marlborough, West Coast
    • +
  • 'CANT' - Canterbury, Chatham Islands
    • +
  • 'OTAG' - Otago, Southland
    • +
+ oneOf: + - title: Tai Tokerau + enum: + - TAIT + - title: Auckland + enum: + - AUCK + - title: Waikato + enum: + - WAIK + - title: Bay of Plenty, Waiariki + enum: + - BOPW + - title: Hawke's Bay, Tairāwhiti + enum: + - HAWK + - title: Taranaki, Whanganui, Manawatū + enum: + - TARA + - title: Wellington + enum: + - WELL + - title: Nelson, Marlborough, West Coast + enum: + - NELS + - title: Canterbury, Chatham Islands + enum: + - CANT + - title: Otago, Southland + enum: + - OTAG + EmailList: + description:

The set of contact email addresses that the + Organisation uses

+ type: object + properties: + Email: + type: array + items: + description:

This element represents an e-mail address of + one of a number of types and occurs in objects + such as StudentPersonal, StaffPersonal, + StudentContactPersonal, etc.

+ type: object + properties: + Type: + $ref: "#/paths/~1Organisations~1%7BOrganisationRefI\ + d%7D/put/requestBody/content/application~1jso\ + n/schema/properties/Organisation/properties/C\ + ontactList/properties/Contact/items/propertie\ + s/EmailList/properties/Email/items/properties\ + /Type" + Address: + type: string + description:

The actual email address.

+ EntityClose: + type: string + format: date + description:

Closing date of entity. Only present for closed + providers.

+ EntityOpen: + type: string + format: date + description:

Opening date of entity. For proposed schools this + will be the projected opening date. For open schools + this may not be present.

+ LocationList: + description:

A list of one or more locations, from which the + organisation operates or provides a service.

+ type: object + properties: + Location: + type: array + items: + description:

This element contains data about a geographical + location.

+ type: object + properties: + Description: + type: string + description:

A description for the Location.

+ Address: + description:

The physical address of the Location

+ type: object + properties: + Type: + $ref: "#/paths/~1Organisations~1%7BOrganisation\ + RefId%7D/put/requestBody/content/applicat\ + ion~1json/schema/properties/Organisation/\ + properties/AddressList/properties/Address\ + /items/properties/Type" + Role: + $ref: "#/paths/~1Organisations~1%7BOrganisation\ + RefId%7D/put/requestBody/content/applicat\ + ion~1json/schema/properties/Organisation/\ + properties/AddressList/properties/Address\ + /items/properties/Role" + Street: + description:

The street element is a complex element + and breaks the street down into several + parts. (Allow for PO Box here)

+ type: object + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban addresses, or + the 'RD No' part of rural addresses

+ City: + type: string + description:

The city part of the address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only applicable if a + non-New Zealand Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are derived + from New Zealand Map Grid x,y coordinates + and converted to Latitude and Longitude + values per the World Geodetic System 1984 + (G1762)

+ type: object + properties: + Latitude: + description:

Latitude in decimal degrees.

+

Latitudes north of the equator are + positive, latitudes south of the + equator are negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal degrees.

+

Longitudes east of the Prime + Meridian in Greenwich are positive, + longitudes west of the Prime Meridian + are negative. The 180th meridian is + negative. [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas containing + the location.

The list may contain + exactly one StatisticalArea element for + each of the following spatial unit + types:

  • Ward
  • Urban + Area
  • Census Area Unit
    • +
  • Māori Electorate
  • Mesh + Block
  • General Electorate
    • +
  • Territorial Authority
  • Local + Board (Auckland Only)
  • Regional + Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area + defined by Statistics New + Zealand.

+ type: object + properties: + SpatialUnitType: + $ref: "#/paths/~1Organisations~1%7BOr\ + ganisationRefId%7D/put/requestB\ + ody/content/application~1json/s\ + chema/properties/Organisation/p\ + roperties/AddressList/propertie\ + s/Address/items/properties/Stat\ + isticalAreaList/properties/Stat\ + isticalArea/items/properties/Sp\ + atialUnitType" + Code: + type: string + description:

A valid value defined by the + nominated spatial unit type, + defined by Statistics New + Zealand in one of the following + statistical area defintion + standards:

Area + Unit
Statistics NZ + Classification of Area Unit 2017 + v1.0.0
General + Electoral District
+
Statistics NZ General + Electoral District 2014 + v1.0.0
Community + Board
Statistics NZ + Community Board (codes 07601 - + 07621) 2018 v1.0.0
+
Māori Electoral + District
Statistics NZ + Māori Electoral District 2014 + v1.0.0
Mesh Block
+
Statistics NZ Statistical + Standard for Meshblock 2018 + v1.0.0
Regional + Council
Statistics NZ + Regional Council 2018 + v1.0.0
Territorial + Authority
Statistics NZ + Territorial Authority 2018 + v1.0.0
Urban Area
+
Statistics NZ Urban Area + 2018 v1.0.0
Ward
+
Statistics NZ Ward 2018 + v1.0.0
+ GridLocation: + description:

The latitude & longitude of the location. + Grid location values are derived from New + Zealand Map Grid x,y coordinates and converted + to Latitude and Longitude values per the World + Geodetic System 1984 (G1762)

+ type: object + properties: + Latitude: + description:

Latitude in decimal degrees.

+ Latitudes north of the equator are + positive, latitudes south of the equator + are negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal degrees.

+

Longitudes east of the Prime Meridian + in Greenwich are positive, longitudes west + of the Prime Meridian are negative. The + 180th meridian is negative. [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas containing the + location.

The list may contain exactly + one StatisticalArea element for each of the + following spatial unit types:

    +
  • Ward
  • Urban Area
  • Census + Area Unit
  • Māori Electorate
    • +
  • Mesh Block
  • General + Electorate
  • Territorial Authority
    • +
  • Local Board (Auckland Only)
    • +
  • Regional Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area defined + by Statistics New Zealand.

+ type: object + properties: + SpatialUnitType: + $ref: "#/paths/~1Organisations~1%7BOrgani\ + sationRefId%7D/put/requestBody/cont\ + ent/application~1json/schema/proper\ + ties/Organisation/properties/Addres\ + sList/properties/Address/items/prop\ + erties/StatisticalAreaList/properti\ + es/StatisticalArea/items/properties\ + /SpatialUnitType" + Code: + type: string + description:

A valid value defined by the + nominated spatial unit type, defined + by Statistics New Zealand in one of + the following statistical area + defintion standards:

+
Area Unit
Statistics NZ + Classification of Area Unit 2017 + v1.0.0
General Electoral + District
Statistics NZ + General Electoral District 2014 + v1.0.0
Community Board
+
Statistics NZ Community Board + (codes 07601 - 07621) 2018 + v1.0.0
Māori Electoral + District
Statistics NZ + Māori Electoral District 2014 + v1.0.0
Mesh Block
+
Statistics NZ Statistical + Standard for Meshblock 2018 + v1.0.0
Regional + Council
Statistics NZ + Regional Council 2018 v1.0.0
+
Territorial Authority
+
Statistics NZ Territorial + Authority 2018 v1.0.0
Urban + Area
Statistics NZ Urban + Area 2018 v1.0.0
Ward
+
Statistics NZ Ward 2018 + v1.0.0
+ Name: + type: string + description:

The normal business name of the Organisation

+ PhoneNumberList: + description:

The set of contact phone numbers that the + Organisation uses

+ type: object + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone number and + occurs within objects such as StudentPersonal, + StaffPersonal, etc.

+ type: object + properties: + Type: + $ref: "#/paths/~1Organisations~1%7BOrganisationRefI\ + d%7D/put/requestBody/content/application~1jso\ + n/schema/properties/Organisation/properties/C\ + ontactList/properties/Contact/items/propertie\ + s/PhoneNumberList/properties/PhoneNumber/item\ + s/properties/Type" + Number: + type: string + description: "

Phone number. Free-form, but typical New + Zealand formats include:

  • (0##) + ###-####
  • ###-####
  • +##### ### + ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1Organisations~1%7BOrganisationRefI\ + d%7D/put/requestBody/content/application~1jso\ + n/schema/properties/Organisation/properties/C\ + ontactList/properties/Contact/items/propertie\ + s/Name/properties/FamilyNameFirst" + RelatedOrganisationList: + description:

A list of other organisations that are related to the + Provider

+ type: object + properties: + RelatedOrganisation: + type: array + items: + description:

Extends ObjectReferenceType to add + an extra element, OrganisationType, + describing the nature of the related + organisation.

+ type: object + properties: + StartDate: + type: string + format: date + description:

The start date of the relationship between + the two organisations

+ EndDate: + type: string + format: date + description:

The end date of the relationship between + the two organisations

+ Type: + type: string + title: Organisation Relationship Type + description: >- +

A code describing the nature of the + relationship between a pair of + Organisations

    +
  • 'TPU' - Teen Parent Unit
    • +
  • 'ACR' - Activity Centre
    • +
  • 'MOE' - MoE Local Office
    • +
  • 'COL' - Community of Learning - Kāhui Ako
    • +
+ oneOf: + - title: Teen Parent Unit + description: Related organisation is a Teen Parent Unit + co-located with the main Organisation. + enum: + - TPU + - title: Activity Centre + description: Related organisation is an Activity Centre + co-located with the main Organisation. + enum: + - ACR + - title: MoE Local Office + description: Related organisation is Ministry of + Education Local Office that deals with the + Provider. + enum: + - MOE + - title*: + en: Community of Learning + mi: Kāhui Ako + description: Related organisation is the Community of + Learning / Kāhui Ako that the main + Organisation is a member of + enum: + - COL + OperationalStatus: + type: string + title: Operational Status + description: >- +

Indicates the operational status of an + organisation.

    +
  • 'C' - Closed
    • +
  • 'O' - Open
    • +
  • 'P' - Proposed
    • +
+ oneOf: + - title: Closed + enum: + - C + - title: Open + enum: + - O + - title: Proposed + description: SIF AU uses the term ‘Pending’ + enum: + - P + Type: + type: string + title: Organisation Type + description: >- + Describes the organisation type of the provider, + indicating the services provided, function or purpose of + the organisation.
    +
  • '32' - Composite School (Year 1-15)
    • +
  • '21' - Contributing Primary (Year 1-6)
    • +
  • '34' - The Correspondence School
    • +
  • '20' - Full Primary (Year 1-8)
    • +
  • '22' - Intermediate (Year 7-8)
    • +
  • '35' - Restricted Composite School (Year 7-10)
    • +
  • '30' - Secondary School (Year 7-15)
    • +
  • '40' - Secondary School (Year 9-15)
    • +
  • '23' - Special School
    • +
  • '41' - Teen Parent Unit (Year 9-15)
    • +
  • '997' - Activity Centre
    • +
  • '998' - Community of Learning | Kāhui Ako
    • +
plus 1 more value(s) at NZCodeSetsOrganisationTypeType + oneOf: + - title: Composite School (Year 1-15) + enum: + - "32" + - title: Contributing Primary (Year 1-6) + enum: + - "21" + - title: The Correspondence School + enum: + - "34" + - title: Full Primary (Year 1-8) + enum: + - "20" + - title: Intermediate (Year 7-8) + enum: + - "22" + - title: Restricted Composite School (Year 7-10) + enum: + - "35" + - title: Secondary School (Year 7-15) + enum: + - "30" + - title: Secondary School (Year 9-15) + enum: + - "40" + - title: Special School + enum: + - "23" + - title: Teen Parent Unit (Year 9-15) + enum: + - "41" + - title: Activity Centre + enum: + - "997" + - title: Community of Learning | Kāhui Ako + enum: + - "998" + - title: Ministry of Education Local Office + enum: + - "999" + OrganisationRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + OrganisationLocalId: + $ref: "#/paths/~1Organisations~1%7BOrganisationRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/\ + Organisation/properties/MinistryOfEducationId" + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + Organisation: + AddressList: {} + CommunicationChannelList: {} + ContactList: + Contact: + Name: + FamilyName: Dumbledore + GivenName: Albus + FullName: Albus Dumbledore + PositionTitle: Lead School Headmaster + Role: PRI + AddressList: + Address: + Type: TH + Role: PHY + Street: + Line1: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + EmailList: + Email: + - Type: PRIM + Address: stuart@gmail.com + LocationList: {} + Name: Masterton (Whakaoriori) Kāhui Ako + PhoneNumberList: + PhoneNumber: + Notes: Lead School Secretary (Mobile) + Type: MOB + Number: (021) 300 999 + Type: 998 + OrganisationRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + OrganisationLocalId: 99204 + application/xml: + schema: + type: object + properties: + Organisation: + $ref: "#/paths/~1Organisations~1%7BOrganisationRefId%7D/put/reque\ + stBody/content/application~1json/schema/properties/Organisa\ + tion" + example: >- + + + + + + + Dumbledore + Albus + Albus Dumbledore + + Lead School Headmaster + PRI + +
+ TH + PHY + + 533 Hogwart's Way + + Hogsmead + 7733 +
+ + + + + + + + PRIM + stuart@gmail.com + + + + Masterton (Whakaoriori) Kāhui Ako + + + Lead School Secretary (Mobile) + MOB + (021) 300 999 + + + 998 + D3E34B35-9D75-101A-8C3D-00AA001A1652 + 99204 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - Organisation + summary: Default operation to get a single Organisation + parameters: + - name: OrganisationRefId + in: path + description:

The SIF GUID used by systems to identify the organisation.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + Organisation: + $ref: "#/paths/~1Organisations/get/responses/200/content/applic\ + ation~1json/schema/properties/Organisations/properties/Or\ + ganisation/items" + example: + Organisation: + AddressList: {} + CommunicationChannelList: {} + ContactList: + Contact: + Name: + FamilyName: Dumbledore + GivenName: Albus + FullName: Albus Dumbledore + PositionTitle: Lead School Headmaster + Role: PRI + AddressList: + Address: + Type: TH + Role: PHY + Street: + Line1: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + EmailList: {} + PhoneNumberList: {} + EmailList: + Email: + - Type: PRIM + Address: stuart@gmail.com + LocationList: {} + Name: Masterton (Whakaoriori) Kāhui Ako + PhoneNumberList: + PhoneNumber: + Notes: Lead School Secretary (Mobile) + Type: MOB + Number: (021) 300 999 + Type: 998 + OrganisationRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + OrganisationLocalId: 99204 + application/xml: + schema: + type: object + properties: + Organisation: + $ref: "#/paths/~1Organisations/get/responses/200/content/applic\ + ation~1json/schema/properties/Organisations/properties/Or\ + ganisation/items" + example: >- + + + + + + + Dumbledore + Albus + Albus Dumbledore + + Lead School Headmaster + PRI + +
+ TH + PHY + + 533 Hogwart's Way + + Hogsmead + 7733 +
+ + + + + + + + PRIM + stuart@gmail.com + + + + Masterton (Whakaoriori) Kāhui Ako + + + Lead School Secretary (Mobile) + MOB + (021) 300 999 + + + 998 + D3E34B35-9D75-101A-8C3D-00AA001A1652 + 99204 + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - Organisation + summary: Default operation to delete a single Organisation + parameters: + - name: OrganisationRefId + in: path + description:

The SIF GUID used by systems to identify the organisation.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /AcademicDepartments: + get: + tags: + - AcademicDepartment + summary: Default operation to get a list of all available AcademicDepartments + description: Search the set of available AcademicDepartments, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + AcademicDepartments: + type: object + description: A List of AcademicDepartment objects + properties: + AcademicDepartment: + type: array + items: + required: + - Provider + type: object + properties: + AcademicDepartmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + AcademicDepartmentLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Name: + type: string + description:

The name of the academic department.

+ Description: + type: string + description:

Free text description providing more detail + about the academic department.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1AcademicDepartments/get/response\ + s/200/content/application~1json/schema/prop\ + erties/AcademicDepartments/properties/Acade\ + micDepartment/items/properties/AcademicDepa\ + rtmentRefId" + LocalId: + $ref: "#/paths/~1AcademicDepartments/get/response\ + s/200/content/application~1json/schema/prop\ + erties/AcademicDepartments/properties/Acade\ + micDepartment/items/properties/AcademicDepa\ + rtmentLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + StaffList: + description:

A list of the staff members that belong to + the academic department.

+ type: object + required: + - StaffMember + properties: + StaffMember: + type: array + items: + description:

The individual staff member as a member + of the StaffList and their role.

+ type: object + required: + - ObjectType + - Role + properties: + Role: + type: string + title: Staff Role + description: >- +

Describes the role a staff member + has at a Provider or other + EducationOrganisation.

    +
  • '1001' - Principal
    • +
  • '1002' - Deputy Principal
    • +
  • '1003' - Associate Principal
    • +
  • '1004' - Assistant Principal
    • +
  • '1005' - Principal's Nominee (NZQA)
    • +
  • '1006' - Enrolment Officer
    • +
  • '1007' - Timetabler
    • +
  • '1008' - Relief Coordinator
    • +
  • '1009' - Office Manager
    • +
  • '1010' - Office Assistant
    • +
  • '1012' - Finance Assistant
    • +
  • '1013' - IT Manager
    • +
plus 51 more value(s) at NZCodeSetsStaffRoleType + oneOf: + - title: Principal + enum: + - "1001" + - title: Deputy Principal + enum: + - "1002" + - title: Associate Principal + enum: + - "1003" + - title: Assistant Principal + enum: + - "1004" + - title: Principal's Nominee (NZQA) + enum: + - "1005" + - title: Enrolment Officer + enum: + - "1006" + - title: Timetabler + enum: + - "1007" + - title: Relief Coordinator + enum: + - "1008" + - title: Office Manager + enum: + - "1009" + - title: Office Assistant + enum: + - "1010" + - title: Finance Assistant + enum: + - "1012" + - title: IT Manager + enum: + - "1013" + - title: IT Assistant + enum: + - "1014" + - title: Head Librarian + enum: + - "1015" + - title: Assistant Librarian + enum: + - "1016" + - title: Board of Trustees Member (Staff) + enum: + - "1017" + - title: Board of Trustees Member (Parent) + enum: + - "1018" + - title: Head of Department + enum: + - "1101" + - title: Assistant Head of Department + enum: + - "1102" + - title: Technician + enum: + - "1103" + - title: Subject Teacher + enum: + - "1201" + - title: STP Coordinator + enum: + - "1302" + - title: Learning Support Coordinator + enum: + - "1303" + - title: Learning Support Staff + enum: + - "1304" + - title: SAC Coordinator + enum: + - "1305" + - title: Special Needs Coordinator (SENCO) + enum: + - "1306" + - title: Distance Education Coordinator + enum: + - "1307" + - title: Resource Teacher Literacy (RTLit) + enum: + - "1308" + - title: Resource Teacher Learning and + Behaviour (RTLB) + enum: + - "1309" + - title: Parent Help + enum: + - "1310" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homerrom Teacher + enum: + - "1403" + - title: Pastoral Carer + enum: + - "1404" + - title: Guidance Counsellor + enum: + - "1405" + - title: Careers Advisor + enum: + - "1406" + - title: Truancy Officer + enum: + - "1407" + - title: Sickbay Nurse + enum: + - "1408" + - title: Dental Nurse + enum: + - "1409" + - title: Hostel Manager / Matron + enum: + - "1410" + - title: Social Worker (In School) + enum: + - "1411" + - title: Teacher in Charge + enum: + - "1501" + - title: Coach + enum: + - "1502" + - title: Kāhui Ako Led Principal + enum: + - "2001" + - title: Across School Teacher + enum: + - " 2002" + - title: Kāhui Ako Support Facilitator + enum: + - "2101" + - title: Kāhui Ako Expert Partner + enum: + - "2102" + - title: Ministry - Learning Support + Facilitator + enum: + - "2103" + - title: Ministry - Strategic Advisor - + Māori + enum: + - "2104" + - title: Ministry - SAF + enum: + - "2105" + - title: DHB Staff + enum: + - "2106" + - title: Teacher Aide + enum: + - "1301" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Kāhui Ako within School Teacher + enum: + - "1208" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Finance Manager + enum: + - "1011" + CourseList: + description:

A list of the courses the academic department + manages.

+ type: object + required: + - Course + properties: + Course: + type: array + items: + $ref: "#/paths/~1AcademicDepartments/get/respon\ + ses/200/content/application~1json/schema/\ + properties/AcademicDepartments/properties\ + /AcademicDepartment/items/properties/Prov\ + ider" + SubjectAreaList: + description:

A list of the subject areas the academic + department manages.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZ Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication + Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural + Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication + (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + AcademicDepartments: + AcademicDepartment: + - AcademicDepartmentRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Name: Science Department + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StaffList: + StaffMember: + - RefId: 44FB63B4-CFEF-4820-8501-E7D1E54555CB + Name: Bobby Test + application/xml: + schema: + type: object + properties: + AcademicDepartments: + type: object + description: A List of AcademicDepartment objects + properties: + AcademicDepartment: + type: array + items: + $ref: "#/paths/~1AcademicDepartments/get/responses/200/co\ + ntent/application~1json/schema/properties/AcademicD\ + epartments/properties/AcademicDepartment/items" + example: >- + + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Science Department + + CA285746-359D-7510-1A8C-36432A901A16 + + + + 44FB63B4-CFEF-4820-8501-E7D1E54555CB + Bobby Test + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/AcademicDepartments/{AcademicDepartmentRefId}": + post: + tags: + - AcademicDepartment + summary: Default operation to create a single AcademicDepartment + parameters: + - name: AcademicDepartmentRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + AcademicDepartment.

+ required: true + schema: + type: string + operationId: createAcademicDepartment + requestBody: + description: CRUD operation on AcademicDepartment + content: + application/json: + schema: + type: object + properties: + AcademicDepartment: + $ref: "#/paths/~1AcademicDepartments/get/responses/200/content/ap\ + plication~1json/schema/properties/AcademicDepartments/prope\ + rties/AcademicDepartment/items" + example: + AcademicDepartment: + AcademicDepartmentRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Name: Science Department + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StaffList: + StaffMember: + - RefId: 44FB63B4-CFEF-4820-8501-E7D1E54555CB + Name: Bobby Test + application/xml: + schema: + type: object + properties: + AcademicDepartment: + $ref: "#/paths/~1AcademicDepartments/get/responses/200/content/ap\ + plication~1json/schema/properties/AcademicDepartments/prope\ + rties/AcademicDepartment/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Science Department + + CA285746-359D-7510-1A8C-36432A901A16 + + + + 44FB63B4-CFEF-4820-8501-E7D1E54555CB + Bobby Test + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - AcademicDepartment + summary: Default operation to update a single AcademicDepartment + parameters: + - name: AcademicDepartmentRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + AcademicDepartment.

+ required: true + schema: + type: string + operationId: updateAcademicDepartment + requestBody: + description: CRUD operation on AcademicDepartment + content: + application/json: + schema: + type: object + properties: + AcademicDepartment: + type: object + properties: + AcademicDepartmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + AcademicDepartmentLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Name: + type: string + description:

The name of the academic department.

+ Description: + type: string + description:

Free text description providing more detail about the + academic department.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1AcademicDepartments~1%7BAcademicDepartme\ + ntRefId%7D/put/requestBody/content/application~1jso\ + n/schema/properties/AcademicDepartment/properties/A\ + cademicDepartmentRefId" + LocalId: + $ref: "#/paths/~1AcademicDepartments~1%7BAcademicDepartme\ + ntRefId%7D/put/requestBody/content/application~1jso\ + n/schema/properties/AcademicDepartment/properties/A\ + cademicDepartmentLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + StaffList: + description:

A list of the staff members that belong to the + academic department.

+ type: object + properties: + StaffMember: + type: array + items: + description:

The individual staff member as a member of the + StaffList and their role.

+ type: object + properties: + Role: + type: string + title: Staff Role + description: >- +

Describes the role a staff member has at a + Provider or other EducationOrganisation.

+
    +
  • '1001' - Principal
    • +
  • '1002' - Deputy Principal
    • +
  • '1003' - Associate Principal
    • +
  • '1004' - Assistant Principal
    • +
  • '1005' - Principal's Nominee (NZQA)
    • +
  • '1006' - Enrolment Officer
    • +
  • '1007' - Timetabler
    • +
  • '1008' - Relief Coordinator
    • +
  • '1009' - Office Manager
    • +
  • '1010' - Office Assistant
    • +
  • '1012' - Finance Assistant
    • +
  • '1013' - IT Manager
    • +
plus 51 more value(s) at NZCodeSetsStaffRoleType + oneOf: + - title: Principal + enum: + - "1001" + - title: Deputy Principal + enum: + - "1002" + - title: Associate Principal + enum: + - "1003" + - title: Assistant Principal + enum: + - "1004" + - title: Principal's Nominee (NZQA) + enum: + - "1005" + - title: Enrolment Officer + enum: + - "1006" + - title: Timetabler + enum: + - "1007" + - title: Relief Coordinator + enum: + - "1008" + - title: Office Manager + enum: + - "1009" + - title: Office Assistant + enum: + - "1010" + - title: Finance Assistant + enum: + - "1012" + - title: IT Manager + enum: + - "1013" + - title: IT Assistant + enum: + - "1014" + - title: Head Librarian + enum: + - "1015" + - title: Assistant Librarian + enum: + - "1016" + - title: Board of Trustees Member (Staff) + enum: + - "1017" + - title: Board of Trustees Member (Parent) + enum: + - "1018" + - title: Head of Department + enum: + - "1101" + - title: Assistant Head of Department + enum: + - "1102" + - title: Technician + enum: + - "1103" + - title: Subject Teacher + enum: + - "1201" + - title: STP Coordinator + enum: + - "1302" + - title: Learning Support Coordinator + enum: + - "1303" + - title: Learning Support Staff + enum: + - "1304" + - title: SAC Coordinator + enum: + - "1305" + - title: Special Needs Coordinator (SENCO) + enum: + - "1306" + - title: Distance Education Coordinator + enum: + - "1307" + - title: Resource Teacher Literacy (RTLit) + enum: + - "1308" + - title: Resource Teacher Learning and Behaviour + (RTLB) + enum: + - "1309" + - title: Parent Help + enum: + - "1310" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homerrom Teacher + enum: + - "1403" + - title: Pastoral Carer + enum: + - "1404" + - title: Guidance Counsellor + enum: + - "1405" + - title: Careers Advisor + enum: + - "1406" + - title: Truancy Officer + enum: + - "1407" + - title: Sickbay Nurse + enum: + - "1408" + - title: Dental Nurse + enum: + - "1409" + - title: Hostel Manager / Matron + enum: + - "1410" + - title: Social Worker (In School) + enum: + - "1411" + - title: Teacher in Charge + enum: + - "1501" + - title: Coach + enum: + - "1502" + - title: Kāhui Ako Led Principal + enum: + - "2001" + - title: Across School Teacher + enum: + - " 2002" + - title: Kāhui Ako Support Facilitator + enum: + - "2101" + - title: Kāhui Ako Expert Partner + enum: + - "2102" + - title: Ministry - Learning Support Facilitator + enum: + - "2103" + - title: Ministry - Strategic Advisor - Māori + enum: + - "2104" + - title: Ministry - SAF + enum: + - "2105" + - title: DHB Staff + enum: + - "2106" + - title: Teacher Aide + enum: + - "1301" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Kāhui Ako within School Teacher + enum: + - "1208" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Finance Manager + enum: + - "1011" + CourseList: + description:

A list of the courses the academic department + manages.

+ type: object + properties: + Course: + type: array + items: + $ref: "#/paths/~1AcademicDepartments~1%7BAcademicDepart\ + mentRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/AcademicDepartment/proper\ + ties/Provider" + SubjectAreaList: + description:

A list of the subject areas the academic department + manages.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + AcademicDepartment: + AcademicDepartmentRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Name: Science Department + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StaffList: + StaffMember: + - RefId: 44FB63B4-CFEF-4820-8501-E7D1E54555CB + Name: Bobby Test + application/xml: + schema: + type: object + properties: + AcademicDepartment: + $ref: "#/paths/~1AcademicDepartments~1%7BAcademicDepartmentRefId%\ + 7D/put/requestBody/content/application~1json/schema/propert\ + ies/AcademicDepartment" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Science Department + + CA285746-359D-7510-1A8C-36432A901A16 + + + + 44FB63B4-CFEF-4820-8501-E7D1E54555CB + Bobby Test + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - AcademicDepartment + summary: Default operation to get a single AcademicDepartment + parameters: + - name: AcademicDepartmentRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + AcademicDepartment.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + AcademicDepartment: + $ref: "#/paths/~1AcademicDepartments/get/responses/200/content/\ + application~1json/schema/properties/AcademicDepartments/p\ + roperties/AcademicDepartment/items" + example: + AcademicDepartment: + AcademicDepartmentRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Name: Science Department + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StaffList: + StaffMember: + - RefId: 44FB63B4-CFEF-4820-8501-E7D1E54555CB + Name: Bobby Test + application/xml: + schema: + type: object + properties: + AcademicDepartment: + $ref: "#/paths/~1AcademicDepartments/get/responses/200/content/\ + application~1json/schema/properties/AcademicDepartments/p\ + roperties/AcademicDepartment/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Science Department + + CA285746-359D-7510-1A8C-36432A901A16 + + + + 44FB63B4-CFEF-4820-8501-E7D1E54555CB + Bobby Test + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - AcademicDepartment + summary: Default operation to delete a single AcademicDepartment + parameters: + - name: AcademicDepartmentRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + AcademicDepartment.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StaffPersonals: + get: + tags: + - StaffPersonal + summary: Default operation to get a list of all available StaffPersonals + description: Search the set of available StaffPersonals, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StaffPersonals: + type: object + description: A List of StaffPersonal objects + properties: + StaffPersonal: + type: array + items: + required: + - PersonInfo + type: object + properties: + StaffPersonalRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StaffPersonalLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + ESLPairwiseId: + $ref: "#/paths/~1StaffPersonals/get/responses/200/con\ + tent/application~1json/schema/properties/StaffP\ + ersonals/properties/StaffPersonal/items/propert\ + ies/StaffPersonalLocalId" + SchoolSMSUserId: + $ref: "#/paths/~1StaffPersonals/get/responses/200/con\ + tent/application~1json/schema/properties/StaffP\ + ersonals/properties/StaffPersonal/items/propert\ + ies/StaffPersonalLocalId" + PersonInfo: + description:

Personal Information

+ type: object + required: + - Name + properties: + Name: + description:

A name used by the person

+ type: object + properties: + Title: + type: string + description:

A title or prefix associated with the + name.

+ FamilyName: + type: string + description:

Also known as Last Name, although + some cultures may not present a family + name as the last name.

+ GivenName: + type: string + description:

Also known as First Name, although + some cultures may not present this name + as the first element in a name. May + contain a composite of all given + names.

+ MiddleName: + type: string + description:

Where more than one Given Name, these + may be combined in one composite field + or else populated in several elements. +

+ FamilyNameFirst: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, + unknown and not provided values.

+
    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PreferredFamilyName: + type: string + description:

A preferred version of the Family + Name. Note:A name cannot have both a + Preferred Family and Preferred Given + Name within the same Name structure – + only one of these fields should be + populated. If a person does have both a + Preferred Family and Preferred Given + Name then this must be populated as a + separate Name of type ‘Preferred’.

+ PreferredFamilyNameFirst: + $ref: "#/paths/~1StaffPersonals/get/responses\ + /200/content/application~1json/schema/p\ + roperties/StaffPersonals/properties/Sta\ + ffPersonal/items/properties/PersonInfo/\ + properties/Name/properties/FamilyNameFi\ + rst" + PreferredGivenName: + type: string + description: "

A preferred version of the Given + Name. Note: A name cannot have both a + Preferred Family and Preferred Given + Name within the same Name structure – + only one of these fields should be + populated. If a person does have both a + Preferred Family and Preferred Given + Name then this must be populated as a + separate Name of type ‘Preferred’.

" + Suffix: + type: string + description:

Textual suffix like PHD, JP, BSc.

+ FullName: + type: string + description:

A combination of all name elements as + one composite text element

+ Type: + type: string + title: Name Usage Type + description: >- +

A standardised method of describing + the usage of a name by a person. Where a + person has more than one current name, + the usage type indicates which name may + be used according to the purpose.

+

Code values are based on SIF + Australia 3.4.

    +
  • 'PRF' - Preferred Name
    • +
  • 'FON' - Foreign Official Name
    • +
  • 'PRV' - Previous name
    • +
  • 'AKA' - Also Known As
    • +
  • 'BTH' - Name at Birth
    • +
  • 'LGL' - Legal Name
    • +
+ oneOf: + - title: Preferred Name + description:

The name by which an individual + prefers to be known and + addressed.

Only usage type + applicable for student name usage + (other types are not supported by + NSI).

+ enum: + - PRF + - title: Foreign Official Name + description:

Included for future usage in NZ, + especially for tertiary + students.

+ enum: + - FON + - title: Previous name + enum: + - PRV + - title: Also Known As + description: AKA or Alias + enum: + - AKA + - title: Name at Birth + enum: + - BTH + - title: Legal Name + description:

Legal Name or Official Name as + defined by the organisation which + collects it (legal name is not + defined in this standard)

+ enum: + - LGL + IsVerified: + $ref: "#/paths/~1StaffPersonals/get/responses\ + /200/content/application~1json/schema/p\ + roperties/StaffPersonals/properties/Sta\ + ffPersonal/items/properties/PersonInfo/\ + properties/Name/properties/FamilyNameFi\ + rst" + OtherNameList: + description:

Previous, alternate or other names or + aliases associated with the person.

+ type: object + required: + - Name + properties: + Name: + type: array + items: + description:

Extension of BaseNameType including + name verification data

+ type: object + properties: + Verification: + description:

The verification event that + verified the person's name.

+ type: object + required: + - IsConfirmed + - Source + properties: + Source: + type: string + title: Verification Source + description: >- +

Records the source of the + identity or eligibility + verification, that has been + made. Mostly it is merely a + record of the kind of document + that has been presented; but + occasionally it is down to + Principal or Ministry + discretion / approval.

+
    +
  • 'NZBIR' - NZ Birth Certificate
    • +
  • 'NZBCO' - NZ Birth Certificate (with confirmation of NZ Citizen by birth)
    • +
  • 'NZPAS' - NZ Passport
    • +
  • 'NZCIT' - NZ Citizenship Certificate
    • +
  • 'BIRCE' - Birth Certificate (COK, TKL, NIU)
    • +
  • 'BCCON' - Birth Certificate (COK, TKL, NIU) (with confirmation of NZ Citizen by birth)
    • +
  • 'CENAT' - Certification of Naturalisation (COK, TKL, NIU)
    • +
  • 'CAREG' - Certification of Registration (COK, TKL, NIU)
    • +
  • 'LETCO' - Letter of Confirmation (COK, TKL, NIU)
    • +
  • 'OTHPA' - Other Passport with NZ residence class Visa
    • +
  • 'AUSPA' - Australian Passport
    • +
  • 'VISDO' - Visa Domestic
    • +
plus 3 more value(s) at NZCodeSetsVerificationSourceType + oneOf: + - title: NZ Birth Certificate + description: Applies if the child was + born before 1 Jan 2006 + enum: + - NZBIR + - title: NZ Birth Certificate (with + confirmation of NZ Citizen + by birth) + description: Applies if the child was + born on or after 1 Jan + 2006 + enum: + - NZBCO + - title: NZ Passport + description: Including COK, TKL or NIU. + (Current or Expired) + enum: + - NZPAS + - title: NZ Citizenship Certificate + enum: + - NZCIT + - title: Birth Certificate (COK, + TKL, NIU) + description: If the child was born + before 1 Jan 2006 + enum: + - BIRCE + - title: Birth Certificate (COK, + TKL, NIU) (with + confirmation of NZ Citizen + by birth) + description: Applies if the child was + born on or after 1 Jan + 2006. + enum: + - BCCON + - title: Certification of + Naturalisation (COK, TKL, + NIU) + enum: + - CENAT + - title: Certification of + Registration (COK, TKL, + NIU) + enum: + - CAREG + - title: Letter of Confirmation + (COK, TKL, NIU) + enum: + - LETCO + - title: Other Passport with NZ + residence class Visa + description: Or other evidence of NZ + residency + enum: + - OTHPA + - title: Australian Passport + description: (Current or Expired) + enum: + - AUSPA + - title: Visa Domestic + enum: + - VISDO + - title: Visa with conditions of + study + enum: + - VISST + - title: Principal Discretion + enum: + - PRINC + - title: MoE Approval + enum: + - MOEAP + DocumentSerialNumber: + type: string + description:

The serial number on the + document that was used to + verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the + document that was used to + verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification + has been confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took + place.

+ Provider: + description:

A reference to another SIF + Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StaffPersonals\ + /get/responses/200/conten\ + t/application~1json/schem\ + a/properties/StaffPersona\ + ls/properties/StaffPerson\ + al/items/properties/Staff\ + PersonalRefId" + LocalId: + $ref: "#/paths/~1StaffPersonals\ + /get/responses/200/conten\ + t/application~1json/schem\ + a/properties/StaffPersona\ + ls/properties/StaffPerson\ + al/items/properties/Staff\ + PersonalLocalId" + Name: + type: string + description:

The normal descriptive + name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid + SIF DataObject names, to + be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation + that operates within + the education sector; + but doesn’t provide + education services. + enum: + - Organisation + - title: Provider + description: A recognised provider + of education services + such as ECE Service, + School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised + relationship between + two providers of + education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined + course that Students + enrol in, and may be + assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or + other award granted by + a national body, + professional + association or other + interested party. The + Credential describes + an award that is made + to the learner at the + successful completion + of a particular + learning programme. + eg: NCEA Level 1; + University Entrance; + NCEA Level 2 + Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, + contact and + demographic + information relating + to a staff member, who + might be a teacher or + other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of + a Staff member to a + particular Role at a + Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the + personal information + related to the + student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the + personal information + about a person who is + a part of a Student's + whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between + a person who is a part + of a Student's whānau + and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s + association with an + education provider for + the purpose of + receiving educational + services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a + particular class or + other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about + the attendance spans + for a single student + at a single provider + during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information + about a particular + assignment or other + assessment task, to be + undertaken by one or + more Students at some + time. Defines the task + separately from each + student's attempting + the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's + registration for an + assessment task they + are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's + attempt at a + particular assessment + task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result + achieved by a single + student at a + particular assessment + task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student + gaining an Attainment + e.g. NCEA + Qualification, + Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the + outcome and follow ups + generated by a + WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a + student's interests + and academic, career + and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information + on a co-curricular or + extra-curricular + activity in which a + student participates + during a given school + year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information + pertaining to a + student's + participation in + learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress + and achievement + reports provided for a + student. Used in + technology centres the + host provider, to + report on student + progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + VerifiedName: + description:

The verified name of the person.

+ type: object + properties: + Verification: + description:

The verification event that verified + the person's name.

+ type: object + required: + - IsConfirmed + - Source + properties: + Source: + $ref: "#/paths/~1StaffPersonals/get/respo\ + nses/200/content/application~1json/\ + schema/properties/StaffPersonals/pr\ + operties/StaffPersonal/items/proper\ + ties/PersonInfo/properties/OtherNam\ + eList/properties/Name/items/propert\ + ies/Verification/properties/Source" + DocumentSerialNumber: + type: string + description:

The serial number on the document + that was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document + that was used to verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has + been confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StaffPersonals/get/respo\ + nses/200/content/application~1json/\ + schema/properties/StaffPersonals/pr\ + operties/StaffPersonal/items/proper\ + ties/PersonInfo/properties/OtherNam\ + eList/properties/Name/items/propert\ + ies/Verification/properties/Provide\ + r" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + Demographics: + description:

Details of the person’s demographic + properties

+ type: object + properties: + BirthDate: + type: string + format: date + description:

The person's date of birth.

+ DateOfDeath: + type: string + format: date + description:

The person's date of death.

+ PlaceOfBirth: + type: string + description:

The person's place of birth - like + village, town, city etc.

+ CountryOfBirth: + type: string + title: 3166 Country + description: >- +

A country is a geopolitical entity + recognised by the New Zealand + government. The term country may + include

  • Independent + countries recognised by the New Zealand + Government
  • Units that are + recognised geographic areas
    • +
  • administrative subdivisions of the + United Kingdom
  • overseas + dependencies, external territories of + independent countries.
+

Conforms to the International + Standard ISO 3166 Codes for the + Representation of Names of Countries and + their Subdivisions (ISO 3166-1:2013). + Education adopts the alpha-3 + representation of this standard.

+
    +
  • 'ABW' - Aruba
    • +
  • 'AFG' - Afghanistan
    • +
  • 'AGO' - Angola
    • +
  • 'AIA' - Anguilla
    • +
  • 'ALA' - Åland Islands
    • +
  • 'ALB' - Albania
    • +
  • 'AND' - Andorra
    • +
  • 'ARE' - United Arab Emirates
    • +
  • 'ARG' - Argentina
    • +
  • 'ARM' - Armenia
    • +
  • 'ASM' - American Samoa
    • +
  • 'ATA' - Antarctica
    • +
plus 237 more value(s) at ISO3166CountryType + oneOf: + - title: Aruba + enum: + - ABW + - title: Afghanistan + enum: + - AFG + - title: Angola + enum: + - AGO + - title: Anguilla + enum: + - AIA + - title: Åland Islands + enum: + - ALA + - title: Albania + enum: + - ALB + - title: Andorra + enum: + - AND + - title: United Arab Emirates + enum: + - ARE + - title: Argentina + enum: + - ARG + - title: Armenia + enum: + - ARM + - title: American Samoa + enum: + - ASM + - title: Antarctica + enum: + - ATA + - title: French Southern Territories + enum: + - ATF + - title: Antigua and Barbuda + enum: + - ATG + - title: Australia + enum: + - AUS + - title: Austria + enum: + - AUT + - title: Azerbaijan + enum: + - AZE + - title: Burundi + enum: + - BDI + - title: Belgium + enum: + - BEL + - title: Benin + enum: + - BEN + - title: Bonaire, Sint Eustatius and Saba + enum: + - BES + - title: Burkina Faso + enum: + - BFA + - title: Bangladesh + enum: + - BGD + - title: Bulgaria + enum: + - BGR + - title: Bahrain + enum: + - BHR + - title: Bahamas + enum: + - BHS + - title: Bosnia and Herzegovina + enum: + - BIH + - title: Saint Barthélemy + enum: + - BLM + - title: Belarus + enum: + - BLR + - title: Belize + enum: + - BLZ + - title: Bermuda + enum: + - BMU + - title: Bolivia, Plurinational State of + enum: + - BOL + - title: Brazil + enum: + - BRA + - title: Barbados + enum: + - BRB + - title: Brunei Darussalam + enum: + - BRN + - title: Bhutan + enum: + - BTN + - title: Bouvet Island + enum: + - BVT + - title: Botswana + enum: + - BWA + - title: Central African Republic + enum: + - CAF + - title: Canada + enum: + - CAN + - title: Cocos (Keeling) Islands + enum: + - CCK + - title: Switzerland + enum: + - CHE + - title: Chile + enum: + - CHL + - title: China + enum: + - CHN + - title: Côte d'Ivoire + enum: + - CIV + - title: Cameroon + enum: + - CMR + - title: Congo, the Democratic Republic of the + enum: + - COD + - title: Congo + enum: + - COG + - title: Cook Islands + enum: + - COK + - title: Colombia + enum: + - COL + - title: Comoros + enum: + - COM + - title: Cabo Verde + enum: + - CPV + - title: Costa Rica + enum: + - CRI + - title: Cuba + enum: + - CUB + - title: Curaçao + enum: + - CUW + - title: Christmas Island + enum: + - CXR + - title: Cayman Islands + enum: + - CYM + - title: Cyprus + enum: + - CYP + - title: Czechia + enum: + - CZE + - title: Germany + enum: + - DEU + - title: Djibouti + enum: + - DJI + - title: Dominica + enum: + - DMA + - title: Denmark + enum: + - DNK + - title: Dominican Republic + enum: + - DOM + - title: Algeria + enum: + - DZA + - title: Ecuador + enum: + - ECU + - title: Egypt + enum: + - EGY + - title: Eritrea + enum: + - ERI + - title: Western Sahara + enum: + - ESH + - title: Spain + enum: + - ESP + - title: Estonia + enum: + - EST + - title: Ethiopia + enum: + - ETH + - title: Finland + enum: + - FIN + - title: Fiji + enum: + - FJI + - title: Falkland Islands (Malvinas) + enum: + - FLK + - title: France + enum: + - FRA + - title: Faroe Islands + enum: + - FRO + - title: Micronesia, Federated States of + enum: + - FSM + - title: Gabon + enum: + - GAB + - title: United Kingdom + enum: + - GBR + - title: Georgia + enum: + - GEO + - title: Guernsey + enum: + - GGY + - title: Ghana + enum: + - GHA + - title: Gibraltar + enum: + - GIB + - title: Guinea + enum: + - GIN + - title: Guadeloupe + enum: + - GLP + - title: Gambia + enum: + - GMB + - title: Guinea-Bissau + enum: + - GNB + - title: Equatorial Guinea + enum: + - GNQ + - title: Greece + enum: + - GRC + - title: Grenada + enum: + - GRD + - title: Greenland + enum: + - GRL + - title: Guatemala + enum: + - GTM + - title: French Guiana + enum: + - GUF + - title: Guam + enum: + - GUM + - title: Guyana + enum: + - GUY + - title: Hong Kong + enum: + - HKG + - title: Heard Island and McDonald Islands + enum: + - HMD + - title: Honduras + enum: + - HND + - title: Croatia + enum: + - HRV + - title: Haiti + enum: + - HTI + - title: Hungary + enum: + - HUN + - title: Indonesia + enum: + - IDN + - title: Isle of Man + enum: + - IMN + - title: India + enum: + - IND + - title: British Indian Ocean Territory + enum: + - IOT + - title: Ireland + enum: + - IRL + - title: Iran, Islamic Republic of + enum: + - IRN + - title: Iraq + enum: + - IRQ + - title: Iceland + enum: + - ISL + - title: Israel + enum: + - ISR + - title: Italy + enum: + - ITA + - title: Jamaica + enum: + - JAM + - title: Jersey + enum: + - JEY + - title: Jordan + enum: + - JOR + - title: Japan + enum: + - JPN + - title: Kazakhstan + enum: + - KAZ + - title: Kenya + enum: + - KEN + - title: Kyrgyzstan + enum: + - KGZ + - title: Cambodia + enum: + - KHM + - title: Kiribati + enum: + - KIR + - title: Saint Kitts and Nevis + enum: + - KNA + - title: Korea, Republic of + enum: + - KOR + - title: Kuwait + enum: + - KWT + - title: Lao People's Democratic Republic + enum: + - LAO + - title: Lebanon + enum: + - LBN + - title: Liberia + enum: + - LBR + - title: Libya + enum: + - LBY + - title: Saint Lucia + enum: + - LCA + - title: Liechtenstein + enum: + - LIE + - title: Sri Lanka + enum: + - LKA + - title: Lesotho + enum: + - LSO + - title: Lithuania + enum: + - LTU + - title: Luxembourg + enum: + - LUX + - title: Latvia + enum: + - LVA + - title: Macao + enum: + - MAC + - title: Saint Martin (French part) + enum: + - MAF + - title: Morocco + enum: + - MAR + - title: Monaco + enum: + - MCO + - title: Moldova, Republic of + enum: + - MDA + - title: Madagascar + enum: + - MDG + - title: Maldives + enum: + - MDV + - title: Mexico + enum: + - MEX + - title: Marshall Islands + enum: + - MHL + - title: Macedonia, the former Yugoslav + Republic of + enum: + - MKD + - title: Mali + enum: + - MLI + - title: Malta + enum: + - MLT + - title: Myanmar + enum: + - MMR + - title: Montenegro + enum: + - MNE + - title: Mongolia + enum: + - MNG + - title: Northern Mariana Islands + enum: + - MNP + - title: Mozambique + enum: + - MOZ + - title: Mauritania + enum: + - MRT + - title: Montserrat + enum: + - MSR + - title: Martinique + enum: + - MTQ + - title: Mauritius + enum: + - MUS + - title: Malawi + enum: + - MWI + - title: Malaysia + enum: + - MYS + - title: Mayotte + enum: + - MYT + - title: Namibia + enum: + - NAM + - title: New Caledonia + enum: + - NCL + - title: Niger + enum: + - NER + - title: Norfolk Island + enum: + - NFK + - title: Nigeria + enum: + - NGA + - title: Nicaragua + enum: + - NIC + - title: Niue + enum: + - NIU + - title: Netherlands + enum: + - NLD + - title: Norway + enum: + - NOR + - title: Nepal + enum: + - NPL + - title: Nauru + enum: + - NRU + - title: New Zealand + enum: + - NZL + - title: Oman + enum: + - OMN + - title: Pakistan + enum: + - PAK + - title: Panama + enum: + - PAN + - title: Pitcairn + enum: + - PCN + - title: Peru + enum: + - PER + - title: Philippines + enum: + - PHL + - title: Palau + enum: + - PLW + - title: Papua New Guinea + enum: + - PNG + - title: Poland + enum: + - POL + - title: Puerto Rico + enum: + - PRI + - title: Korea, Democratic People's Republic + of + enum: + - PRK + - title: Portugal + enum: + - PRT + - title: Paraguay + enum: + - PRY + - title: Palestine, State of + enum: + - PSE + - title: French Polynesia + enum: + - PYF + - title: Qatar + enum: + - QAT + - title: Réunion + enum: + - REU + - title: Romania + enum: + - ROU + - title: Russian Federation + enum: + - RUS + - title: Rwanda + enum: + - RWA + - title: Saudi Arabia + enum: + - SAU + - title: Sudan + enum: + - SDN + - title: Senegal + enum: + - SEN + - title: Singapore + enum: + - SGP + - title: South Georgia and the South Sandwich + Islands + enum: + - SGS + - title: Saint Helena, Ascension and Tristan + da Cunha + enum: + - SHN + - title: Svalbard and Jan Mayen + enum: + - SJM + - title: Solomon Islands + enum: + - SLB + - title: Sierra Leone + enum: + - SLE + - title: El Salvador + enum: + - SLV + - title: San Marino + enum: + - SMR + - title: Somalia + enum: + - SOM + - title: Saint Pierre and Miquelon + enum: + - SPM + - title: Serbia + enum: + - SRB + - title: South Sudan + enum: + - SSD + - title: Sao Tome and Principe + enum: + - STP + - title: Suriname + enum: + - SUR + - title: Slovakia + enum: + - SVK + - title: Slovenia + enum: + - SVN + - title: Sweden + enum: + - SWE + - title: Swaziland + enum: + - SWZ + - title: Sint Maarten (Dutch part) + enum: + - SXM + - title: Seychelles + enum: + - SYC + - title: Syrian Arab Republic + enum: + - SYR + - title: Turks and Caicos Islands + enum: + - TCA + - title: Chad + enum: + - TCD + - title: Togo + enum: + - TGO + - title: Thailand + enum: + - THA + - title: Tajikistan + enum: + - TJK + - title: Tokelau + enum: + - TKL + - title: Turkmenistan + enum: + - TKM + - title: Timor-Leste + enum: + - TLS + - title: Tonga + enum: + - TON + - title: Trinidad and Tobago + enum: + - TTO + - title: Tunisia + enum: + - TUN + - title: Turkey + enum: + - TUR + - title: Tuvalu + enum: + - TUV + - title: Taiwan, Province of China + enum: + - TWN + - title: Tanzania, United Republic of + enum: + - TZA + - title: Uganda + enum: + - UGA + - title: Ukraine + enum: + - UKR + - title: United States Minor Outlying Islands + enum: + - UMI + - title: Uruguay + enum: + - URY + - title: United States of America + enum: + - USA + - title: Uzbekistan + enum: + - UZB + - title: Holy See + enum: + - VAT + - title: Saint Vincent and the Grenadines + enum: + - VCT + - title: Venezuela, Bolivarian Republic of + enum: + - VEN + - title: Virgin Islands, British + enum: + - VGB + - title: Virgin Islands, U.S. + enum: + - VIR + - title: Viet Nam + enum: + - VNM + - title: Vanuatu + enum: + - VUT + - title: Wallis and Futuna + enum: + - WLF + - title: Samoa + enum: + - WSM + - title: Yemen + enum: + - YEM + - title: South Africa + enum: + - ZAF + - title: Zambia + enum: + - ZMB + - title: Zimbabwe + enum: + - ZWE + CitizenshipList: + type: object + required: + - Country + properties: + Country: + type: array + items: + $ref: "#/paths/~1StaffPersonals/get/res\ + ponses/200/content/application~1j\ + son/schema/properties/StaffPerson\ + als/properties/StaffPersonal/item\ + s/properties/PersonInfo/propertie\ + s/Demographics/properties/Country\ + OfBirth" + CitizenshipStatus: + type: string + title: Citizenship Status + description: >- +

The citizenship or residency status + of a person, principally recorded in + order to determine eligibility for + education services hence limited to + indicating New Zealand, Australian or + Other residency.

Based on SIF + Australia + AUCodeSetsAustralianCitizenshipStatusType

+
    +
  • 'AUCI' - Australian citizen
    • +
  • 'NZCI' - NZ citizen
    • +
  • 'OTOV' - Other overseas
    • +
  • 'NZRE' - NZ resident
    • +
  • 'NOPR' - Not provided
    • +
+ oneOf: + - title: Australian citizen + enum: + - AUCI + - title: NZ citizen + enum: + - NZCI + - title: Other overseas + description: Indicates a residency other than NZ + or Australia + enum: + - OTOV + - title: NZ resident + description: Includes Australian residents + classified as NZ resident once + arrived in NZ + enum: + - NZRE + - title: Not provided + enum: + - NOPR + CitizenshipVerification: + description:

The verification event that verified + the residency status of the person. + Absence of a verification event + indicates that the residency was not + verified against an identity document. +

+ type: object + required: + - IsConfirmed + - Source + properties: + Source: + $ref: "#/paths/~1StaffPersonals/get/respo\ + nses/200/content/application~1json/\ + schema/properties/StaffPersonals/pr\ + operties/StaffPersonal/items/proper\ + ties/PersonInfo/properties/OtherNam\ + eList/properties/Name/items/propert\ + ies/Verification/properties/Source" + DocumentSerialNumber: + type: string + description:

The serial number on the document + that was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document + that was used to verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has + been confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StaffPersonals/get/respo\ + nses/200/content/application~1json/\ + schema/properties/StaffPersonals/pr\ + operties/StaffPersonal/items/proper\ + ties/PersonInfo/properties/OtherNam\ + eList/properties/Name/items/propert\ + ies/Verification/properties/Provide\ + r" + Gender: + type: string + title: Gender + description: >- +

A Person may identify as having a + Gender (or Gender Identity). Biological + sex and sexual orientation are related + but different concepts. Sourced from + Statistics NZ Standard for Gender + Identity

    +
  • '1' - Male - Tāne
    • +
  • '2' - Female - Wahine
    • +
  • '3' - Gender Diverse - Ira tāngata kōwhiri kore
    • +
  • '31' - Transgender Male to Female - Whakawahine
    • +
  • '32' - Transgender Female to Male - Tangata ira tāne
    • +
  • '9' - Not Willing to Disclose
    • +
+ oneOf: + - title*: + en: Male + mi: Tāne + enum: + - "1" + - title*: + en: Female + mi: Wahine + enum: + - "2" + - title*: + en: Gender Diverse + mi: Ira tāngata kōwhiri kore + description: But not further defined + enum: + - "3" + - title*: + en: Transgender Male to Female + mi: Whakawahine + description: '"Can be rolled up to 3:Gender + Diverse"' + enum: + - "31" + - title*: + en: Transgender Female to Male + mi: Tangata ira tāne + description: '"Can be rolled up to 3:Gender + Diverse"' + enum: + - "32" + - title*: + en: Not Willing to Disclose + enum: + - "9" + LanguageList: + description: List of languages an individual uses to + communicate. + type: object + required: + - Language + properties: + Language: + type: array + items: + description:

A language that an individual + uses to communicate.

+ type: object + required: + - Code + properties: + Code: + type: string + title: Language + description: >- +

Language refers to + recognised human communication + systems, typically oral and/or + written. Sourced from + Statistics NZ - Language + Standard Classification 1999 + v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not further + defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not + elsewhere classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not further + defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not + elsewhere classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere + classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere + classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere + classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further + defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere + classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere + classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere + classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further + defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not elsewhere + classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere + classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further + defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere + classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere + classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not + further defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not + elsewhere classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further + defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere + classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further + defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere + classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further + defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere + classified + enum: + - NZS15199 + - title: Central-Eastern + Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not + further defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not + elsewhere classified + enum: + - NZS16199 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further + defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not elsewhere + classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western Malayo-Polynesian + not further defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western Malayo-Polynesian + not elsewhere classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further + defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere + classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere + classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere + classified + enum: + - NZS18399 + - title: Niger-Congo + (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere + classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not + further defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not + elsewhere classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not + further defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not + elsewhere classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not + elsewhere classified + enum: + - NZS219 + - title: Language Isolates not + elsewhere classified + enum: + - NZS21999 + - title: Miscellaneous Language + Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further + defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere + classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous + Languages + enum: + - NZS229 + - title: Other Miscellaneous + Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not + further defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not + elsewhere classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not further + defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not + elsewhere classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + Usage: + type: string + title: Language Usage + description: >- +

A standardised method of + describing the usage of a + language by a person, + potentially indicating + capability and preference for + the language.

    +
  • 'FL' - First Language
    • +
  • 'SL' - Secondary Language
    • +
  • 'SH' - Spoken At Home
    • +
+ oneOf: + - title: First Language + enum: + - FL + - title: Secondary Language + enum: + - SL + - title: Spoken At Home + enum: + - SH + Dialect: + type: string + description:

Specific dialect of a + person's language.

+ ProficiencyList: + description:

A list of the person's + proficiency in the language in + regards to speaking, reading + and writing.

+ type: object + required: + - Proficiency + properties: + Proficiency: + type: array + items: + description:

The person's + proficiency in the + language in regards to + speaking, reading and + writing.

+ type: object + required: + - Level + - Type + properties: + Level: + type: string + title: Language Proficiency + Level + description: >- +

The language + proficiency + level.

    +
  • 'NO' - None
    • +
  • 'BE' - Beginner
    • +
  • 'IN' - Intermediate
    • +
  • 'AD' - Advanced
    • +
+ oneOf: + - title: None + enum: + - NO + - title: Beginner + enum: + - BE + - title: Intermediate + enum: + - IN + - title: Advanced + enum: + - AD + Type: + type: string + title: Language Proficiency + Type + description: >- +

Code set denoting + a type of language + proficiency, e.g. + speaking, writing + reading.

    +
  • 'SP' - Speaking
    • +
  • 'RE' - Reading
    • +
  • 'WR' - Writing
    • +
+ oneOf: + - title: Speaking + enum: + - SP + - title: Reading + enum: + - RE + - title: Writing + enum: + - WR + CountryArrivalDate: + type: string + format: date + description: Date the person first arrived in the + country. + EthnicityList: + description:

One or more ethnic groups with which + the person identifies.

+ type: object + required: + - Ethnicity + properties: + Ethnicity: + type: array + items: + description:

An ethnic group with which the + person identifies, and if there is + more than one, their order of + preference.

+ type: object + required: + - Code + properties: + PreferenceOrderNumber: + type: integer + description:

The order of preference for + the person's ethnicity.

+ Code: + type: string + title: Ethnicity + description: >- +

Ethnicity is the ethnic + group or groups that people + identify with or feel they + belong to. Ethnicity is a + measure of cultural + affiliation, as opposed to + race, ancestry, nationality or + citizenship. Ethnicity is self + perceived and people can + belong to more than one ethnic + group.

The permissible + values consists of any value + from the Statistics NZ - + Ethnicity New Zealand Standard + Classification 2005 v2.0.0 + Depending on usage, ethnicity + may be defined at levels 1 to + 4.

    +
  • '1' - European
    • +
  • '10' - European nfd
    • +
  • '100' - European nfd
    • +
  • '10000' - European nfd
    • +
  • '11' - New Zealand European
    • +
  • '111' - New Zealand European
    • +
  • '11111' - New Zealand European
    • +
  • '12' - Other European
    • +
  • '121' - British and Irish
    • +
  • '12100' - British nfd
    • +
  • '12111' - Celtic nfd
    • +
  • '12112' - Channel Islander
    • +
plus 250 more value(s) at NZCodeSetsEthnicityType + oneOf: + - title: European + enum: + - "1" + - title: European nfd + enum: + - "10" + - title: European nfd + enum: + - "100" + - title: European nfd + enum: + - "10000" + - title: New Zealand European + enum: + - "11" + - title: New Zealand European + enum: + - "111" + - title: New Zealand European + enum: + - "11111" + - title: Other European + enum: + - "12" + - title: British and Irish + enum: + - "121" + - title: British nfd + enum: + - "12100" + - title: Celtic nfd + enum: + - "12111" + - title: Channel Islander + enum: + - "12112" + - title: Cornish + enum: + - "12113" + - title: English + enum: + - "12114" + - title: Irish + enum: + - "12116" + - title: Manx + enum: + - "12117" + - title: Scottish + enum: + - "12119" + - title: Welsh + enum: + - "12121" + - title: British nec + enum: + - "12199" + - title: Dutch + enum: + - "122" + - title: Dutch + enum: + - "12211" + - title: Greek + enum: + - "123" + - title: Greek + enum: + - "12311" + - title: Polish + enum: + - "124" + - title: Polish + enum: + - "12411" + - title: South Slav + enum: + - "125" + - title: South Slav nfd + enum: + - "12500" + - title: Croatian + enum: + - "12511" + - title: Dalmatian + enum: + - "12512" + - title: Macedonian + enum: + - "12513" + - title: Serbian + enum: + - "12514" + - title: Slovenian + enum: + - "12515" + - title: Bosnian + enum: + - "12516" + - title: South Slav nec + enum: + - "12599" + - title: Italian + enum: + - "126" + - title: Italian + enum: + - "12611" + - title: German + enum: + - "127" + - title: German + enum: + - "12711" + - title: Australian + enum: + - "128" + - title: Australian + enum: + - "12811" + - title: Other European + enum: + - "129" + - title: Albanian + enum: + - "12911" + - title: Armenian + enum: + - "12912" + - title: Austrian + enum: + - "12913" + - title: Belgian + enum: + - "12914" + - title: Bulgarian + enum: + - "12915" + - title: Belorussian + enum: + - "12916" + - title: Cypriot nfd + enum: + - "12918" + - title: Czech + enum: + - "12919" + - title: Danish + enum: + - "12920" + - title: Estonian + enum: + - "12921" + - title: Finnish + enum: + - "12922" + - title: Flemish + enum: + - "12923" + - title: French + enum: + - "12924" + - title: Hungarian + enum: + - "12926" + - title: Icelandic + enum: + - "12927" + - title: Latvian + enum: + - "12928" + - title: Lithuanian + enum: + - "12929" + - title: Maltese + enum: + - "12930" + - title: Norwegian + enum: + - "12931" + - title: Portuguese + enum: + - "12932" + - title: Romanian + enum: + - "12933" + - title: Gypsy + enum: + - "12934" + - title: Russian + enum: + - "12935" + - title: Slavic + enum: + - "12937" + - title: Slovak + enum: + - "12938" + - title: Spanish + enum: + - "12939" + - title: Swedish + enum: + - "12940" + - title: Swiss + enum: + - "12941" + - title: Ukrainian + enum: + - "12942" + - title: American + enum: + - "12943" + - title: Canadian + enum: + - "12945" + - title: New Caledonian + enum: + - "12947" + - title: South African European + enum: + - "12948" + - title: Afrikaner + enum: + - "12949" + - title: Zimbabwean European + enum: + - "12950" + - title: European nec + enum: + - "12999" + - title: Māori + enum: + - "2" + - title: Māori + enum: + - "21" + - title: Māori + enum: + - "211" + - title: Māori + enum: + - "21111" + - title: Pacific Peoples + enum: + - "3" + - title: Pacific Peoples nfd + enum: + - "30" + - title: Pacific Peoples nfd + enum: + - "300" + - title: Pacific Peoples nfd + enum: + - "30000" + - title: Samoan + enum: + - "31" + - title: Samoan + enum: + - "311" + - title: Samoan + enum: + - "31111" + - title: Cook Islands Maori + enum: + - "32" + - title: Cook Islands Maori + enum: + - "321" + - title: Cook Islands Maori + enum: + - "32100" + - title: Tongan + enum: + - "33" + - title: Tongan + enum: + - "331" + - title: Tongan + enum: + - "33111" + - title: Niuean + enum: + - "34" + - title: Niuean + enum: + - "341" + - title: Niuean + enum: + - "34111" + - title: Tokelauan + enum: + - "35" + - title: Tokelauan + enum: + - "351" + - title: Tokelauan + enum: + - "35111" + - title: Fijian + enum: + - "36" + - title: Fijian + enum: + - "361" + - title: Fijian + enum: + - "36111" + - title: Other Pacific Peoples + enum: + - "37" + - title: Other Pacific Peoples + enum: + - "371" + - title: Indigenous Australian + enum: + - "37112" + - title: Hawaiian + enum: + - "37122" + - title: Kiribati + enum: + - "37124" + - title: Nauruan + enum: + - "37130" + - title: Papua New Guinean + enum: + - "37135" + - title: Pitcairn Islander + enum: + - "37137" + - title: Rotuman + enum: + - "37138" + - title: Tahitian + enum: + - "37140" + - title: Solomon Islander + enum: + - "37141" + - title: Tuvaluan + enum: + - "37144" + - title: Ni Vanuatu + enum: + - "37145" + - title: Pacific Peoples nec + enum: + - "37199" + - title: Asian + enum: + - "4" + - title: Asian nfd + enum: + - "40" + - title: Asian nfd + enum: + - "400" + - title: Asian nfd + enum: + - "40000" + - title: South East Asian + enum: + - "41" + - title: South East Asian nfd + enum: + - "410" + - title: South East Asian nfd + enum: + - "41000" + - title: Filipino + enum: + - "411" + - title: Filipino + enum: + - "41111" + - title: Cambodian + enum: + - "412" + - title: Cambodian + enum: + - "41211" + - title: Vietnamese + enum: + - "413" + - title: Vietnamese + enum: + - "41311" + - title: Other Southeast Asian + enum: + - "414" + - title: Burmese + enum: + - "41411" + - title: Indonesian + enum: + - "41412" + - title: Lao + enum: + - "41413" + - title: Malay + enum: + - "41414" + - title: Thai + enum: + - "41415" + - title: Karen + enum: + - "41416" + - title: Chin + enum: + - "41417" + - title: Southeast Asian nec + enum: + - "41499" + - title: Chinese + enum: + - "42" + - title: Chinese + enum: + - "421" + - title: Chinese nfd + enum: + - "42100" + - title: Hong Kong Chinese + enum: + - "42111" + - title: Cambodian Chinese + enum: + - "42112" + - title: Malaysian Chinese + enum: + - "42113" + - title: Singaporean Chinese + enum: + - "42114" + - title: Vietnamese Chinese + enum: + - "42115" + - title: Taiwanese + enum: + - "42116" + - title: Chinese nec + enum: + - "42199" + - title: Indian + enum: + - "43" + - title: Indian + enum: + - "431" + - title: Indian nfd + enum: + - "43100" + - title: Bengali + enum: + - "43111" + - title: Fijian Indian + enum: + - "43112" + - title: Indian Tamil + enum: + - "43114" + - title: Punjabi + enum: + - "43115" + - title: Sikh + enum: + - "43116" + - title: Anglo Indian + enum: + - "43117" + - title: Malaysian Indian + enum: + - "43118" + - title: South African Indian + enum: + - "43119" + - title: Indian nec + enum: + - "43199" + - title: Other Asian + enum: + - "44" + - title: Sri Lankan + enum: + - "441" + - title: Sri Lankan nfd + enum: + - "44100" + - title: Sinhalese + enum: + - "44111" + - title: Sri Lankan Tamil + enum: + - "44112" + - title: Sri Lankan nec + enum: + - "44199" + - title: Japanese + enum: + - "442" + - title: Japanese + enum: + - "44211" + - title: Korean + enum: + - "443" + - title: Korean + enum: + - "44311" + - title: Other Asian + enum: + - "444" + - title: Afghani + enum: + - "44411" + - title: Bangladeshi + enum: + - "44412" + - title: Nepalese + enum: + - "44413" + - title: Pakistani + enum: + - "44414" + - title: Tibetan + enum: + - "44415" + - title: Eurasian + enum: + - "44416" + - title: Bhutanese + enum: + - "44417" + - title: Maldivian + enum: + - "44418" + - title: Mongolian + enum: + - "44419" + - title: Asian nec + enum: + - "44499" + - title: Middle Eastern/Latin + American/African + enum: + - "5" + - title: Middle Eastern + enum: + - "51" + - title: Middle Eastern + enum: + - "511" + - title: Middle Eastern nfd + enum: + - "51100" + - title: Algerian + enum: + - "51111" + - title: Arab + enum: + - "51112" + - title: Assyrian + enum: + - "51113" + - title: Egyptian + enum: + - "51114" + - title: Iranian/Persian + enum: + - "51115" + - title: Iraqi + enum: + - "51116" + - title: Israeli/Jewish + enum: + - "51117" + - title: Jordanian + enum: + - "51118" + - title: Kurd + enum: + - "51119" + - title: Lebanese + enum: + - "51120" + - title: Moroccan + enum: + - "51122" + - title: Palestinian + enum: + - "51124" + - title: Syrian + enum: + - "51125" + - title: Turkish + enum: + - "51127" + - title: Middle Eastern nec + enum: + - "51199" + - title: Latin American + enum: + - "52" + - title: Latin American + enum: + - "521" + - title: Latin American nfd + enum: + - "52100" + - title: Argentinian + enum: + - "52111" + - title: Bolivian + enum: + - "52112" + - title: Brazilian + enum: + - "52113" + - title: Chilean + enum: + - "52114" + - title: Colombian + enum: + - "52115" + - title: Ecuadorian + enum: + - "52118" + - title: Mexican + enum: + - "52123" + - title: Peruvian + enum: + - "52127" + - title: Puerto Rican + enum: + - "52128" + - title: Uruguayan + enum: + - "52129" + - title: Venezuelan + enum: + - "52130" + - title: Latin American nec + enum: + - "52199" + - title: African + enum: + - "53" + - title: African + enum: + - "531" + - title: African nfd + enum: + - "53100" + - title: Jamaican + enum: + - "53113" + - title: Kenyan + enum: + - "53114" + - title: Nigerian + enum: + - "53115" + - title: African American + enum: + - "53116" + - title: Caribbean + enum: + - "53118" + - title: Somali + enum: + - "53119" + - title: Eritrean + enum: + - "53120" + - title: Ethiopian + enum: + - "53121" + - title: Ghanaian + enum: + - "53122" + - title: Burundian + enum: + - "53123" + - title: Congolese + enum: + - "53124" + - title: Sudanese + enum: + - "53125" + - title: Zambian + enum: + - "53126" + - title: Other Zimbabwean + enum: + - "53127" + - title: African nec + enum: + - "53199" + - title: Other Ethnicity + enum: + - "6" + - title: Other Ethnicity + enum: + - "61" + - title: Other Ethnicity + enum: + - "611" + - title: Indigenous American + enum: + - "61113" + - title: Mauritian + enum: + - "61115" + - title: Seychellois + enum: + - "61116" + - title: Other South African + enum: + - "61117" + - title: New Zealander + enum: + - "61118" + - title: Other Ethnicity nec + enum: + - "61199" + - title: Residual Categories + enum: + - "9" + - title: Don't Know + enum: + - "94" + - title: Don't Know + enum: + - "944" + - title: Don't Know + enum: + - "94444" + - title: Refused to Answer + enum: + - "95" + - title: Refused to Answer + enum: + - "955" + - title: Refused to Answer + enum: + - "95555" + - title: Repeated Value + enum: + - "96" + - title: Repeated Value + enum: + - "966" + - title: Repeated Value + enum: + - "96666" + - title: Response Unidentifiable + enum: + - "97" + - title: Response Unidentifiable + enum: + - "977" + - title: Response Unidentifiable + enum: + - "97777" + - title: Response Outside Scope + enum: + - "98" + - title: Response Outside Scope + enum: + - "988" + - title: Response Outside Scope + enum: + - "98888" + - title: Not Stated + enum: + - "99" + - title: Not Stated + enum: + - "999" + - title: Not Stated + enum: + - "99999" + IwiAffiliationList: + description:

A list of one or more iwi with which + the person has an affiliation.

+ type: object + required: + - IwiAffiliation + properties: + IwiAffiliation: + type: array + items: + type: string + title: Iwi + description: >- +

An iwi, or Māori tribe, is one + of the largest kinship groupings + and is generally made up of + several hapū that are all + descended from a common ancestor. + Hapū are clusters of whānau where + the whānau is usually an extended + family grouping consisting of + children, parents, often + grandparents, and other closely + related kin.

Sourced from + Statistics NZ - Iwi and Iwi + related groups statistical + standard v1.0.0.0

    +
  • 'NZS01' - Te Tai Tokerau/Tāmaki-makaurau (Northland/Auckland) Region Iwi
    • +
  • 'NZS0101' - Te Aupōuri
    • +
  • 'NZS0102' - Ngāti Kahu
    • +
  • 'NZS0103' - Ngāti Kurī
    • +
  • 'NZS0104' - Ngāpuhi
    • +
  • 'NZS0105' - Ngāpuhi ki Whaingaroa-Ngāti Kahu ki Whaingaroa
    • +
  • 'NZS0106' - Te Rarawa
    • +
  • 'NZS0107' - Ngāi Takoto
    • +
  • 'NZS0108' - Ngāti Wai
    • +
  • 'NZS0109' - Ngāti Whātua (not Ōrākei or Kaipara)
    • +
  • 'NZS0110' - Te Kawerau ā Maki
    • +
  • 'NZS0111' - Te Uri-o-Hau
    • +
plus 183 more value(s) at NZCodeSetsIwiType + oneOf: + - title: Te Tai Tokerau/Tāmaki-makaurau + (Northland/Auckland) Region + Iwi + enum: + - NZS01 + - title: Te Aupōuri + enum: + - NZS0101 + - title: Ngāti Kahu + enum: + - NZS0102 + - title: Ngāti Kurī + enum: + - NZS0103 + - title: Ngāpuhi + enum: + - NZS0104 + - title: Ngāpuhi ki Whaingaroa-Ngāti + Kahu ki Whaingaroa + enum: + - NZS0105 + - title: Te Rarawa + enum: + - NZS0106 + - title: Ngāi Takoto + enum: + - NZS0107 + - title: Ngāti Wai + enum: + - NZS0108 + - title: Ngāti Whātua (not Ōrākei or + Kaipara) + enum: + - NZS0109 + - title: Te Kawerau ā Maki + enum: + - NZS0110 + - title: Te Uri-o-Hau + enum: + - NZS0111 + - title: Te Roroa + enum: + - NZS0112 + - title: Ngāti Whātua o Kaipara + enum: + - NZS0113 + - title: Ngāti Whātua o Ōrākei + enum: + - NZS0114 + - title: Ngāi Tai ki Tāmaki + enum: + - NZS0115 + - title: Ngāti Hine (Te Tai Tokerau) + enum: + - NZS0116 + - title: Te Paatu + enum: + - NZS0117 + - title: Ngāti Manuhiri + enum: + - NZS0118 + - title: Ngāti Rēhua + enum: + - NZS0119 + - title: Hauraki (Coromandel) Region Iwi + enum: + - NZS02 + - title: Ngāti Hako + enum: + - NZS0201 + - title: Ngāti Hei + enum: + - NZS0202 + - title: Ngāti Maru (Hauraki) + enum: + - NZS0203 + - title: Ngāti Paoa + enum: + - NZS0204 + - title: Patukirikiri + enum: + - NZS0205 + - title: Ngāti Porou ki Harataunga ki + Mataora + enum: + - NZS0206 + - title: Ngāti Pūkenga ki Waiau + enum: + - NZS0207 + - title: Ngāti Rāhiri Tumutumu + enum: + - NZS0208 + - title: Ngāti Tamaterā + enum: + - NZS0210 + - title: Ngāti Tara Tokanui + enum: + - NZS0211 + - title: Ngāti Whanaunga + enum: + - NZS0212 + - title: Waikato/Te Rohe Pōtae + (Waikato/King Country) Region + Iwi + enum: + - NZS03 + - title: Ngāti Haua (Waikato) + enum: + - NZS0301 + - title: Ngāti Maniapoto + enum: + - NZS0302 + - title: Raukawa (Waikato) + enum: + - NZS0303 + - title: Waikato + enum: + - NZS0304 + - title: Ngāti Te Ata + enum: + - NZS0305 + - title: Ngāti Hīkairo + enum: + - NZS0306 + - title: Rereahu + enum: + - NZS0307 + - title: Ngāti Tiipa + enum: + - NZS0308 + - title: Ngāti Korokī Kahukura + enum: + - NZS0309 + - title: Ngāti Tamaoho + enum: + - NZS0310 + - title: Te Ākitai-Waiohua + enum: + - NZS0311 + - title: Te Arawa/Taupō (Rotorua/Taupō) + Region Iwi + enum: + - NZS04 + - title: Ngāti Pikiao (Te Arawa) + enum: + - NZS0401 + - title: Ngāti Rangiteaorere (Te Arawa) + enum: + - NZS0402 + - title: Ngāti Rangitihi (Te Arawa) + enum: + - NZS0403 + - title: Ngāti Rangiwewehi (Te Arawa) + enum: + - NZS0404 + - title: Tapuika (Te Arawa) + enum: + - NZS0405 + - title: Ngāti Tarāwhai (Te Arawa) + enum: + - NZS0406 + - title: Tūhourangi (Te Arawa) + enum: + - NZS0407 + - title: Uenuku-Kōpako (Te Arawa) + enum: + - NZS0408 + - title: Waitaha (Te Arawa) + enum: + - NZS0409 + - title: Ngāti Whakaue (Te Arawa) + enum: + - NZS0410 + - title: Ngāti Tūwharetoa (ki Taupō) + enum: + - NZS0411 + - title: Ngāti Tahu-Ngāti Whaoa (Te + Arawa) + enum: + - NZS0412 + - title: Ngāti Mākino + enum: + - NZS0413 + - title: Ngāti Kearoa / Ngāti Tuarā + enum: + - NZS0414 + - title: Ngāti Rongomai (Te Arawa) + enum: + - NZS0415 + - title: Tauranga Moana/Mātaatua (Bay + of Plenty) Region Iwi + enum: + - NZS05 + - title: Ngāti Pūkenga + enum: + - NZS0501 + - title: Ngāi Te Rangi + enum: + - NZS0502 + - title: Ngāti Ranginui + enum: + - NZS0503 + - title: Ngāti Awa + enum: + - NZS0504 + - title: Ngāti Manawa + enum: + - NZS0505 + - title: Ngāi Tai (Tauranga + Moana/Mātaatua) + enum: + - NZS0506 + - title: Tūhoe + enum: + - NZS0507 + - title: Whakatōhea + enum: + - NZS0508 + - title: Te Whānau-ā-Apanui + enum: + - NZS0509 + - title: Ngāti Whare + enum: + - NZS0510 + - title: Ngā Pōtiki ā Tamapahore + enum: + - NZS0511 + - title: Te Upokorehe + enum: + - NZS0512 + - title: Ngāti Tūwharetoa ki Kawerau + enum: + - NZS0513 + - title: Te Tai Rāwhiti (East Coast) + Region Iwi + enum: + - NZS06 + - title: Ngāti Porou + enum: + - NZS0601 + - title: Te Aitanga-a-Māhaki + enum: + - NZS0602 + - title: Rongowhakaata + enum: + - NZS0603 + - title: Ngāi Tāmanuhiri + enum: + - NZS0604 + - title: Te Aitanga ā Hauiti + enum: + - NZS0605 + - title: Te Matau-a-Māui/Wairarapa + (Hawke's Bay/Wairarapa) Region + Iwi + enum: + - NZS07 + - title: Rongomaiwahine (Te Māhia) + enum: + - NZS0701 + - title: Ngāti Kahungunu ki Te Wairoa + enum: + - NZS0702 + - title: Ngāti Kahungunu ki Heretaunga + enum: + - NZS0703 + - title: Ngāti Kahungunu ki Wairarapa + enum: + - NZS0704 + - title: Rangitāne (Te + Matau-a-Māui/Hawke's + Bay/Wairarapa) + enum: + - NZS0706 + - title: Ngāti Kahungunu ki Te + Whanganui-a-Orotu + enum: + - NZS0707 + - title: Ngāti Kahungunu ki Tamatea + enum: + - NZS0708 + - title: Ngāti Kahungunu ki Tamakinui a + Rua + enum: + - NZS0709 + - title: Ngāti Pāhauwera + enum: + - NZS0710 + - title: Ngāti Rākaipaaka + enum: + - NZS0711 + - title: Ngāti Hineuru + enum: + - NZS0712 + - title: Maungaharuru Tangitū + enum: + - NZS0713 + - title: Rangitāne o Tamaki nui ā Rua + enum: + - NZS0714 + - title: Ngāti Ruapani ki Waikaremoana + enum: + - NZS0715 + - title: Te Hika o Pāpāuma + enum: + - NZS0716 + - title: Taranaki Region Iwi + enum: + - NZS08 + - title: Te Atiawa (Taranaki) + enum: + - NZS0801 + - title: Ngāti Maru (Taranaki) + enum: + - NZS0802 + - title: Ngāti Mutunga (Taranaki) + enum: + - NZS0803 + - title: Ngā Rauru + enum: + - NZS0804 + - title: Ngā Ruahine + enum: + - NZS0805 + - title: Ngāti Ruanui + enum: + - NZS0806 + - title: Ngāti Tama (Taranaki) + enum: + - NZS0807 + - title: Taranaki + enum: + - NZS0808 + - title: Tangāhoe + enum: + - NZS0809 + - title: Pakakohi + enum: + - NZS0810 + - title: Whanganui/Rangitīkei + (Wanganui/Rangitīkei) Region + Iwi + enum: + - NZS09 + - title: Ngāti Apa (Rangitīkei) + enum: + - NZS0901 + - title: Te Ati Haunui-a-Pāpārangi + enum: + - NZS0902 + - title: Ngāti Haua (Taumarunui) + enum: + - NZS0903 + - title: Ngāti Hauiti (Rangitīkei) + enum: + - NZS0904 + - title: Ngāti Whitikaupeka (Rangitīkei) + enum: + - NZS0905 + - title: Ngāi Te Ohuake (Rangitīkei) + enum: + - NZS0906 + - title: Ngāti Tamakōpiri (Rangitīkei) + enum: + - NZS0907 + - title: Ngāti Rangi (Ruapehu, + Whanganui) + enum: + - NZS0908 + - title: Uenuku (Ruapehu, Waimarino) + enum: + - NZS0909 + - title: Tamahaki (Ruapehu, Waimarino) + enum: + - NZS0910 + - title: Tamakana (Ruapehu, Waimarino) + enum: + - NZS0911 + - title: Manawatū/Horowhenua/Te + Whanganui-a-Tara + (Manawatū/Horowhenua/Wellington) + Region Iwi + enum: + - NZS10 + - title: Te Atiawa (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1001 + - title: Muaūpoko + enum: + - NZS1002 + - title: Rangitāne (Manawatū) + enum: + - NZS1003 + - title: Ngāti Raukawa + (Horowhenua/Manawatū) + enum: + - NZS1004 + - title: Ngāti Toarangatira (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1005 + - title: Te Atiawa ki Whakarongotai + enum: + - NZS1006 + - title: Ngāti Tama ki Te Upoko o Te + Ika (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1007 + - title: Ngāti Kauwhata + enum: + - NZS1008 + - title: Ngāti Tukorehe + enum: + - NZS1009 + - title: Te Waipounamu/Wharekauri + (South Island/Chatham Islands) + Region Iwi + enum: + - NZS11 + - title: Te Atiawa (Te Waipounamu/South + Island) + enum: + - NZS1101 + - title: Ngāti Koata + enum: + - NZS1102 + - title: Ngāti Kuia + enum: + - NZS1103 + - title: Kāti Māmoe + enum: + - NZS1104 + - title: Moriori + enum: + - NZS1105 + - title: Ngāti Mutunga + (Wharekauri/Chatham Islands) + enum: + - NZS1106 + - title: Rangitāne (Te Waipounamu/South + Island) + enum: + - NZS1107 + - title: Ngāti Rārua + enum: + - NZS1108 + - title: Ngāi Tahu / Kāi Tahu + enum: + - NZS1109 + - title: Ngāti Tama (Te + Waipounamu/South Island) + enum: + - NZS1110 + - title: Ngāti Toarangatira (Te + Waipounamu/South Island) + enum: + - NZS1111 + - title: Waitaha (Te Waipounamu/South + Island) + enum: + - NZS1112 + - title: Ngāti Apa ki Te Rā Tō + enum: + - NZS1113 + - title: Confederations and Waka, iwi + not named + enum: + - NZS20 + - title: Tainui, iwi not named + enum: + - NZS2001 + - title: Te Arawa, iwi not named + enum: + - NZS2002 + - title: Tākitimu, iwi not named + enum: + - NZS2003 + - title: Aotea, iwi not named + enum: + - NZS2004 + - title: Mātaatua, iwi not named + enum: + - NZS2005 + - title: Mahuru, iwi not named + enum: + - NZS2006 + - title: Māmari, iwi not named + enum: + - NZS2007 + - title: Ngātokimatawhaorua, iwi not + named + enum: + - NZS2008 + - title: Nukutere, iwi not named + enum: + - NZS2009 + - title: Tokomaru, iwi not named + enum: + - NZS2010 + - title: Kurahaupō, iwi not named + enum: + - NZS2011 + - title: Muriwhenua, iwi not named + enum: + - NZS2012 + - title: Hauraki / Pare Hauraki, iwi + not named + enum: + - NZS2013 + - title: Tūranganui a Kiwa, iwi not + named + enum: + - NZS2014 + - title: Te Tauihu o Te Waka a Māui, + iwi not named + enum: + - NZS2015 + - title: Tauranga Moana, iwi not named + enum: + - NZS2016 + - title: Horouta, iwi not named + enum: + - NZS2017 + - title: Mōkai Pātea, iwi not named + enum: + - NZS2018 + - title: Iwi named, region not known + enum: + - NZS21 + - title: Te Atiawa, region not known + enum: + - NZS2101 + - title: Ngāti Haua, region not known + enum: + - NZS2102 + - title: Ngāti Maru, region not known + enum: + - NZS2103 + - title: Ngāti Mutunga, region not known + enum: + - NZS2104 + - title: Rangitāne, region not known + enum: + - NZS2105 + - title: Ngāti Raukawa, region not known + enum: + - NZS2106 + - title: Ngāti Tama, region not known + enum: + - NZS2107 + - title: Ngāti Toa, region not known + enum: + - NZS2108 + - title: Waitaha, region not known + enum: + - NZS2109 + - title: Ngāti Apa, region not known + enum: + - NZS2110 + - title: Ngāi Tai, region not known + enum: + - NZS2111 + - title: Ngāti Kahungunu, region not + known + enum: + - NZS2112 + - title: Ngāti Tūwharetoa, region not + known + enum: + - NZS2113 + - title: Hapū affiliated to more than + one iwi + enum: + - NZS22 + - title: Hapū affiliated to more than + one iwi + enum: + - NZS2201 + - title: Region known, Iwi not named + enum: + - NZS23 + - title: Te Tai Tokerau/Tāmaki-makaurau + Region, Iwi not named + enum: + - NZS2301 + - title: Hauraki Region, Iwi not named + enum: + - NZS2302 + - title: Waikato/Te Rohe Pōtae Region, + Iwi not named + enum: + - NZS2303 + - title: Te Arawa/Taupō Region, Iwi not + named + enum: + - NZS2304 + - title: Tauranga Moana/Mātaatua + Region, Iwi not named + enum: + - NZS2305 + - title: Te Tai Rāwhiti Region, Iwi not + named + enum: + - NZS2306 + - title: Te Matau-a-Māui/Wairarapa + Region, Iwi not named + enum: + - NZS2307 + - title: Taranaki Region, Iwi not named + enum: + - NZS2308 + - title: Whanganui/Rangitīkei Region, + Iwi not named + enum: + - NZS2309 + - title: Manawatū/Horowhenua/Te + Whanganui-a-Tara Region, Iwi + not named + enum: + - NZS2310 + - title: Te Waipounamu/Wharekauri + Region, Iwi not named + enum: + - NZS2311 + - title: Don't Know + enum: + - NZS44 + - title: Refused To Answer + enum: + - NZS55 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + ReligiousAffiliationList: + description:

A list of one or more religions with + which the person has an affiliation.

+ type: object + required: + - ReligiousAffiliation + properties: + ReligiousAffiliation: + type: array + items: + type: string + title: Religion + description: >- +

Religious affiliation is the + self-identified association of a + person with a religion, + denomination or sub-denominational + religious group.

Sourced + from Statistics NZ - Religious + Affiliation 1999 v1.0.0.0

    +
  • 'NZS0' - No Religion
    • +
  • 'NZS1' - Buddhist
    • +
  • 'NZS101' - Buddhist
    • +
  • 'NZS10101' - Zen Buddhist
    • +
  • 'NZS10199' - Buddhist nec
    • +
  • 'NZS2' - Christian
    • +
  • 'NZS201' - Adventist
    • +
  • 'NZS20101' - Christadelphian
    • +
  • 'NZS20102' - Seventh Day Adventist
    • +
  • 'NZS20103' - Worldwide Church of God
    • +
  • 'NZS20199' - Adventist nec
    • +
  • 'NZS202' - Anglican
    • +
plus 117 more value(s) at NZCodeSetsReligionType + oneOf: + - title: No Religion + enum: + - NZS0 + - title: Buddhist + enum: + - NZS1 + - title: Buddhist + enum: + - NZS101 + - title: Zen Buddhist + enum: + - NZS10101 + - title: Buddhist nec + enum: + - NZS10199 + - title: Christian + enum: + - NZS2 + - title: Adventist + enum: + - NZS201 + - title: Christadelphian + enum: + - NZS20101 + - title: Seventh Day Adventist + enum: + - NZS20102 + - title: Worldwide Church of God + enum: + - NZS20103 + - title: Adventist nec + enum: + - NZS20199 + - title: Anglican + enum: + - NZS202 + - title: Asian Christian + enum: + - NZS203 + - title: Chinese Christian + enum: + - NZS20301 + - title: Korean Christian + enum: + - NZS20302 + - title: Baptist + enum: + - NZS204 + - title: Bible Baptist + enum: + - NZS20401 + - title: Independent Baptist + enum: + - NZS20402 + - title: Reformed Baptist + enum: + - NZS20403 + - title: Baptist nec + enum: + - NZS20499 + - title: Brethren + enum: + - NZS205 + - title: Exclusive Brethren + enum: + - NZS20501 + - title: Open Brethren + enum: + - NZS20502 + - title: Plymouth Brethren + enum: + - NZS20503 + - title: Brethren nec + enum: + - NZS20599 + - title: Catholic + enum: + - NZS206 + - title: Roman Catholic + enum: + - NZS20601 + - title: Catholic nec + enum: + - NZS20699 + - title: Church of Christ and + Associated Churches of Christ + enum: + - NZS207 + - title: Associated Churches of Christ + enum: + - NZS20701 + - title: Other Church of Christ and + Churches of Christ nec + enum: + - NZS20799 + - title: Evangelical, Born Again and + Fundamentalist + enum: + - NZS208 + - title: Evangelical + enum: + - NZS20801 + - title: Born Again + enum: + - NZS20802 + - title: Fundamentalist + enum: + - NZS20803 + - title: Independent Evangelical + Churches + enum: + - NZS20804 + - title: Jehovah's Witnesses + enum: + - NZS209 + - title: Jehovah's Witnesses + enum: + - NZS20901 + - title: Latter-day Saints + enum: + - NZS210 + - title: Lutheran + enum: + - NZS211 + - title: Methodist + enum: + - NZS212 + - title: Tongan Methodist + enum: + - NZS21201 + - title: Methodist nec + enum: + - NZS21299 + - title: Orthodox + enum: + - NZS213 + - title: Assyrian Orthodox + enum: + - NZS21301 + - title: Coptic Orthodox + enum: + - NZS21302 + - title: Greek Orthodox + enum: + - NZS21303 + - title: Russian Orthodox + enum: + - NZS21304 + - title: Serbian Orthodox + enum: + - NZS21305 + - title: Orthodox nec + enum: + - NZS21399 + - title: Pentecostal + enum: + - NZS214 + - title: Apostolic Church of New Zealand + enum: + - NZS21401 + - title: Assemblies of God + enum: + - NZS21402 + - title: Christian Fellowship + enum: + - NZS21403 + - title: Christian Outreach + enum: + - NZS21404 + - title: Christian Revival Crusade + enum: + - NZS21405 + - title: Elim + enum: + - NZS21406 + - title: Full Gospel + enum: + - NZS21407 + - title: Independent Pentecostal + enum: + - NZS21408 + - title: New Life Centres + enum: + - NZS21409 + - title: Revival Centres + enum: + - NZS21410 + - title: United Pentecostal + enum: + - NZS21411 + - title: Vineyard Christian Fellowship + enum: + - NZS21412 + - title: Pentecostal nec + enum: + - NZS21499 + - title: Presbyterian, Congregational + and Reformed + enum: + - NZS215 + - title: Presbyterian + enum: + - NZS21501 + - title: Congregational + enum: + - NZS21502 + - title: Cook Island Congregational + enum: + - NZS21503 + - title: Samoan Congregational + enum: + - NZS21504 + - title: Reformed + enum: + - NZS21505 + - title: Protestant + enum: + - NZS216 + - title: Salvation Army + enum: + - NZS217 + - title: Uniting/Union Church and + Ecumenical + enum: + - NZS218 + - title: Uniting/Union Church + enum: + - NZS21801 + - title: Ecumenical + enum: + - NZS21802 + - title: Other Christian + enum: + - NZS299 + - title: Christian and Missionary + Alliance + enum: + - NZS29901 + - title: Christian Science + enum: + - NZS29902 + - title: Church of God + enum: + - NZS29903 + - title: Commonwealth Covenant Church + enum: + - NZS29904 + - title: Liberal Catholic + enum: + - NZS29905 + - title: Metropolitan + enum: + - NZS29906 + - title: Nazarene + enum: + - NZS29907 + - title: Religious Society of Friends + (Quaker) + enum: + - NZS29908 + - title: Unitarian + enum: + - NZS29909 + - title: Hindu + enum: + - NZS3 + - title: Hare Krishna + enum: + - NZS30101 + - title: Yoga + enum: + - NZS30102 + - title: Islam/Muslim + enum: + - NZS4 + - title: Sufi + enum: + - NZS40101 + - title: Judaism/Jewish + enum: + - NZS5 + - title: Māori Christian + enum: + - NZS6 + - title: Ratana + enum: + - NZS601 + - title: Ringatū + enum: + - NZS602 + - title: Other Māori Christian + enum: + - NZS609 + - title: Spiritualism and New Age + Religions + enum: + - NZS7 + - title: Church of Scientology + enum: + - NZS701 + - title: Nature and Earth Based + Religions + enum: + - NZS702 + - title: Animist + enum: + - NZS70201 + - title: Druid + enum: + - NZS70202 + - title: Pantheist + enum: + - NZS70203 + - title: Wiccan + enum: + - NZS70204 + - title: Satanism + enum: + - NZS703 + - title: Spiritualist + enum: + - NZS704 + - title: Other New Age Religions + enum: + - NZS709 + - title: Rastafarianism + enum: + - NZS70901 + - title: Other Religions + enum: + - NZS8 + - title: Baha'i + enum: + - NZS801 + - title: Chinese Religions + enum: + - NZS802 + - title: Confucianism + enum: + - NZS80201 + - title: Taoism + enum: + - NZS80202 + - title: Jainism + enum: + - NZS803 + - title: Japanese Religion + enum: + - NZS804 + - title: Mahikari + enum: + - NZS80401 + - title: Shinto + enum: + - NZS80402 + - title: Tenrikyo + enum: + - NZS80403 + - title: Māori Religion + enum: + - NZS805 + - title: Hauhau + enum: + - NZS80501 + - title: Sikh + enum: + - NZS806 + - title: Theism + enum: + - NZS807 + - title: Zoroastrian + enum: + - NZS808 + - title: Other Religions + enum: + - NZS809 + - title: Unification Church (Moonist) + enum: + - NZS80901 + - title: Other Religions nec + enum: + - NZS80999 + - title: Don't Know + enum: + - NZS944 + - title: Object to answering + enum: + - NZS955 + - title: Religion Unidentifiable + enum: + - NZS977 + - title: Response Outside Scope + enum: + - NZS988 + - title: Not Stated + enum: + - NZS999 + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + AddressList: + description: The person's address(es) - one or more + addresses + type: object + required: + - Address + properties: + Address: + type: array + items: + description:

This element contains address + data.

+ type: object + required: + - Street + properties: + Type: + type: string + title: Address Type + description: >- +

Address type allows an address + to be categorised according to its + component structure. Address type + can be used to build processing + rules for validating, managing and + presenting addresses. Address type + is independent of the use of the + address by any party. To describe + how a party may use an address + (residence, billing, term address + etc) see AddressRoleType

    +
  • 'TH' - Thoroughfare
    • +
  • 'RU' - Rural Post Delivery
    • +
  • 'DE' - Delivery Service
    • +
  • 'WA' - Water
    • +
  • 'FO' - Foreign Address
    • +
+ oneOf: + - title: Thoroughfare + description: "\"

Also called 'Street' + addresses, The most general, + and widely used type of + address, and can contain the + widest variety of + components

In general a + thoroughfare address will + include components for a + number, a roadname, and a + locality.

They cannot + contain any of the components + specific to a delivery + service, rural post delivery, + or water address.

These + addresses are used to find a + location.

Example: 30 - + 40 Lambton Quay, Wellington, + 6165

\"" + enum: + - TH + - title: Rural Post Delivery + description: '"

Defined by New Zealand + Post, these addresses are + assigned by NZ Post for + customers who purchase a rural + delivery service (mail and + also other goods).

They + will have the same number and + roadname components as the + street address, and may have + the same region component.

+

They do not have a + component that identifies the + locality the address is + within. The locality and city + or town components are + replaced by components that + identify the rural delivery + route (RD number), and the + town from which the rural + delivery route starts and + finishes (the mail town). Only + addresses of this class can + contain these components.

+

Example: 121 + Waitaha Road, RD 1, Ross, + 7885

"' + enum: + - RU + - title: Delivery Service + description: '"

Defined by New Zealand + Post, and used exclusively for + NZ Post services other than + standard mail delivery. + Addresses in this class + include PO Box, Private Bag, + and Counter Delivery + addresses.

+ Example: Private Bag + 2345, Auckland, 1142

"' + enum: + - DE + - title: Water + description: '"

Where properties have no + road access, but do have + access to water frontage + (coastline or riverbank or + lakefront), a water address + uses the name of a water + feature (for example, islands, + rivers, bays, or + peninsulas).

+ Example: 235 Lochmara + Bay, Queen Charlotte Sound, + Marlborough Sounds

"' + enum: + - WA + - title: Foreign Address + description: '"

A foreign address + identifies a location outside + of New Zealand.

+ Example: + Rudolf-Diesel-Strasse 14, + 54595 Prüm, Germany

"' + enum: + - FO + Role: + type: string + title: Address Role + description: >- +

A standardised description of + the role or usage of an address by + a party (person or organisation). + Where a party has more than one + address, this provides context for + deciding which address to use.

+
    +
  • 'PHY' - Physical Address
    • +
  • 'POS' - Postal Address
    • +
+ oneOf: + - title: Physical Address + description: Applies to addresses + associated with persons + enum: + - PHY + - title: Postal Address + description: Applies to addresses + associated with persons or + organisations + enum: + - POS + Street: + description:

The street element is a complex + element and breaks the street down + into several parts. (Allow for PO + Box here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' part of + rural addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only + applicable if a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid + x,y coordinates and converted to + Latitude and Longitude values per + the World Geodetic System 1984 + (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes + north of the equator are + positive, latitudes south of + the equator are negative [ISO + 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes + east of the Prime Meridian in + Greenwich are positive, + longitudes west of the Prime + Meridian are negative. The + 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

+

The list may contain exactly + one StatisticalArea element for + each of the following spatial unit + types:

  • Ward
    • +
  • Urban Area
  • Census + Area Unit
  • Māori + Electorate
  • Mesh + Block
  • General + Electorate
  • Territorial + Authority
  • Local Board + (Auckland Only)
  • Regional + Council
+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical + area defined by Statistics + New Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + type: string + title: Spatial Unit Type + description: >- +

A classification of + geographical boundaries + or statistical areas as + defined by Statistics + NZ’s geographic + hierarchy.

    +
  • 'AE' - Area Unit
    • +
  • 'GE' - General Electoral District
    • +
  • 'CB' - Community Board
    • +
  • 'ME' - Māori Electoral District
    • +
  • 'MB' - Mesh Block
    • +
  • 'RC' - Regional Council
    • +
  • 'TA' - Territorial Authority
    • +
  • 'UA' - Urban Area
    • +
  • 'WA' - Ward
    • +
+ oneOf: + - title: Area Unit + description:

Area units are + aggregations of + meshblocks. They are + non–administrative + areas that are in + between meshblocks + and territorial + authorities in size. + Area units must + either define or + aggregate to define, + regional councils, + territorial + authorities and + urban areas.

+ Statistics NZ + Classification of + Area Unit 2013 + v1.0.0 + enum: + - AE + - title: General Electoral + District + description:

The general + electoral districts + as constituted under + the Electoral Act + 1993.

Statistics + NZ General Electoral + District 2014 v1.0.0 + enum: + - GE + - title: Community Board + description:

(aka Local Board + within Auckland) + Local boards provide + governance at the + local level within + Auckland Council. + They enable + democratic decision + making by, and on + behalf of + communities within + the local board + area.

Statistics + NZ Community Board + 2013 v1.0.0 + enum: + - CB + - title: Māori Electoral + District + description:

Māori electoral + districts are the + voting districts for + parliamentary + elections for people + who choose to be on + the Māori Electoral + Roll.

Statistics + NZ Māori Electoral + District 2014 v1.0.0 + enum: + - ME + - title: Mesh Block + description:

A meshblock is + the smallest + geographic unit for + which statistical + data is collected + and processed by + Statistics New + Zealand.

A + meshblock is defined + by a geographic + area, which can vary + in size from part of + a city block to a + large area of rural + land. Each meshblock + borders on another + to form a network + covering all of New + Zealand, including + coasts and inlets + and extending out to + the 200-mile + economic zone.

+ Statistics NZ + Statistical Standard + for Meshblock 2013 + v1.0.0 + enum: + - MB + - title: Regional Council + description:

The top tier of + local government in + New Zealand, defined + by the Local + Government Act 2002, + which requires the + boundaries of + regions to conform + as far as possible + to one or more water + catchments. When + determining regional + boundaries, the + Local Government + Commission gave + consideration to + regional communities + of interest when + selecting water + catchments to be + included in a + region. It also + considered factors + such as natural + resource management, + land use planning + and environmental + matters.

+ Statistics NZ + Regional Council + 2013 v1.0.0 + enum: + - RC + - title: Territorial Authority + description:

The second tier + of local government + in New Zealand, + defined under the + Local Government Act + 2002 as a city + council or district + council. There are + 67 territorial + authorities + consisting of 12 + city councils, 53 + districts, Auckland + Council, and Chatham + Islands Council.

+ Statistics NZ + Territorial + Authority 2013 + v1.0.0 + enum: + - TA + - title: Urban Area + description: '"

Urban Areas are + statistically + defined areas with + no administrative or + legal basis. There + is a three part + hierarchical + sub-division of + urban areas into: + main urban areas, + secondary urban + areas, minor urban + areas. Together the + populations in main, + secondary and minor + urban areas comprise + the statistically + defined urban + population of New + Zealand. The urban + area classification + is designed to + identify + concentrated urban + or semi-urban + settlements without + the distortions of + administrative + boundaries.

+ Statistics NZ Urban + Area 2013 v2.0.0"' + enum: + - UA + - title: Ward + description:

Wards are defined + under the Local + Electoral Act 2001 + and result from the + division, for + electoral purposes, + of the district of a + territorial + authority. The ward + system was designed + to allow for the + recognition of + communities within a + district and to + increase community + involvement in the + local government + system.

+ Statistics NZ Ward + 2013 v1.0.0 + enum: + - WA + Code: + type: string + description:

A valid value defined + by the nominated spatial + unit type, defined by + Statistics New Zealand + in one of the following + statistical area + defintion standards:

+
Area Unit
+
Statistics NZ + Classification of Area + Unit 2017 v1.0.0
+
General Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community Board
+
Statistics NZ + Community Board (codes + 07601 - 07621) 2018 + v1.0.0
Māori + Electoral District
+
Statistics NZ Māori + Electoral District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard for + Meshblock 2018 + v1.0.0
Regional + Council
+
Statistics NZ + Regional Council 2018 + v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority + 2018 v1.0.0
+
Urban Area
+
Statistics NZ Urban + Area 2018 v1.0.0
+
Ward
+
Statistics NZ Ward + 2018 v1.0.0
+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + EmailList: + description:

The person's e-mail address(es) - one or + more emails.

+ type: object + required: + - Email + properties: + Email: + type: array + items: + description:

This element represents an e-mail + address of one of a number of types + and occurs in objects such as + StudentPersonal, StaffPersonal, + StudentContactPersonal, etc.

+ type: object + required: + - Address + properties: + Type: + type: string + title: Email Type + description: >- +

A standardised method of + describing an electronic mail + address used as contact method by + a party. Where a party has more + than one email address, this may + provide context for deciding which + email address to use.

    +
  • 'PRIM' - Primary
    • +
  • 'WORK' - Work
    • +
  • 'PERS' - Personal
    • +
  • 'ALT1' - Alternate 1
    • +
  • 'ALT2' - Alternate 2
    • +
  • 'ALT3' - Alternate 3
    • +
  • 'ALT4' - Alternate 4
    • +
+ oneOf: + - title: Primary + description: Applicable to organisations, + eg schools + enum: + - PRIM + - title: Work + description: Only used for persons + enum: + - WORK + - title: Personal + description: Only used for persons + enum: + - PERS + - title: Alternate 1 + enum: + - ALT1 + - title: Alternate 2 + enum: + - ALT2 + - title: Alternate 3 + enum: + - ALT3 + - title: Alternate 4 + enum: + - ALT4 + Address: + type: string + description:

The actual email address.

+ PhoneNumberList: + description:

The person's phone number(s) - one or + more phone numbers.

+ type: object + required: + - PhoneNumber + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone + number and occurs within objects such + as StudentPersonal, StaffPersonal, + etc.

+ type: object + required: + - Number + properties: + Type: + type: string + title: Telephone Number Type + description: >- +

A standardised method of + describing a telecommunications + device used as contact method by a + party. Where a party has more than + one phone number, this may provide + context for deciding which number + to use.

    +
  • 'MAI' - Main Telephone Number
    • +
  • 'FAX' - Facsimile Number
    • +
  • 'HTE' - Home Telephone Number
    • +
  • 'HMO' - Home Mobile
    • +
  • 'MOB' - Mobile
    • +
  • 'WMO' - Work Mobile
    • +
  • 'WTE' - Work Telephone Number
    • +
+ oneOf: + - title: Main Telephone Number + enum: + - MAI + - title: Facsimile Number + enum: + - FAX + - title: Home Telephone Number + description: Person usage only + enum: + - HTE + - title: Home Mobile + description: Person usage only + enum: + - HMO + - title: Mobile + enum: + - MOB + - title: Work Mobile + enum: + - WMO + - title: Work Telephone Number + enum: + - WTE + Number: + type: string + description: "

Phone number. Free-form, but + typical New Zealand formats + include:

  • (0##) + ###-####
  • ###-####
    • +
  • +##### ### ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1StaffPersonals/get/res\ + ponses/200/content/application~1j\ + son/schema/properties/StaffPerson\ + als/properties/StaffPersonal/item\ + s/properties/PersonInfo/propertie\ + s/Name/properties/FamilyNameFirst" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + HouseholdContactInfoList: + description:

The person's household/s contact + information. A list of one or more + household’s contact information.

+ type: object + required: + - HouseholdContactInfo + properties: + HouseholdContactInfo: + type: array + items: + description:

Common element used to supply + information about a particular + household a person is a member of.

+ type: object + properties: + PreferenceNumber: + type: integer + description:

Priority of Household Contact + in relation to this Person.

+ HouseholdContactId: + $ref: "#/paths/~1StaffPersonals/get/res\ + ponses/200/content/application~1j\ + son/schema/properties/StaffPerson\ + als/properties/StaffPersonal/item\ + s/properties/StaffPersonalLocalId" + HouseholdSalutation: + type: string + description:

Salutation to be used in + addressing this household.

+ AddressList: + description:

A list of Address elements.

+ type: object + required: + - Address + properties: + Address: + type: array + items: + description:

This element contains + address data.

+ type: object + required: + - Street + properties: + Type: + $ref: "#/paths/~1StaffPersona\ + ls/get/responses/200/co\ + ntent/application~1json\ + /schema/properties/Staf\ + fPersonals/properties/S\ + taffPersonal/items/prop\ + erties/PersonInfo/prope\ + rties/AddressList/prope\ + rties/Address/items/pro\ + perties/Type" + Role: + $ref: "#/paths/~1StaffPersona\ + ls/get/responses/200/co\ + ntent/application~1json\ + /schema/properties/Staf\ + fPersonals/properties/S\ + taffPersonal/items/prop\ + erties/PersonInfo/prope\ + rties/AddressList/prope\ + rties/Address/items/pro\ + perties/Role" + Street: + description:

The street element is + a complex element and + breaks the street down + into several parts. + (Allow for PO Box + here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line + 1.

+ Line2: + type: string + description:

Address line + 2.

+ Line3: + type: string + description:

Address line + 3.

+ Suburb: + type: string + description:

The suburb part of + urban addresses, or the + 'RD No' part of rural + addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province + code. StateTerritory + Code only applicable if + a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal + code.

+ GridLocation: + description:

The latitude & + longitude of the + location. Grid location + values are derived from + New Zealand Map Grid x,y + coordinates and + converted to Latitude + and Longitude values per + the World Geodetic + System 1984 (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in + decimal degrees.

+

Latitudes north + of the equator are + positive, latitudes + south of the equator + are negative [ISO + 6709].

+ Longitude: + description:

Longitude in + decimal degrees.

+

Longitudes east + of the Prime + Meridian in + Greenwich are + positive, longitudes + west of the Prime + Meridian are + negative. The 180th + meridian is + negative. [ISO + 6709]

+ StatisticalAreaList: + description:

A list of Statistical + Areas containing the + location.

The + list may contain exactly + one StatisticalArea + element for each of the + following spatial unit + types:

    +
  • Ward
  • Urban + Area
  • Census + Area Unit
  • Māori + Electorate
  • Mesh + Block
  • General + Electorate
    • +
  • Territorial + Authority
  • Local + Board (Auckland + Only)
  • Regional + Council
+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular + statistical area + defined by + Statistics New + Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + $ref: "#/paths/~1St\ + affPersonals/get/re\ + sponses/200/content\ + /application~1json/\ + schema/properties/S\ + taffPersonals/prope\ + rties/StaffPersonal\ + /items/properties/P\ + ersonInfo/propertie\ + s/AddressList/prope\ + rties/Address/items\ + /properties/Statist\ + icalAreaList/proper\ + ties/StatisticalAre\ + a/items/properties/\ + SpatialUnitType" + Code: + type: string + description:

A valid + value defined by the + nominated spatial + unit type, defined + by Statistics New + Zealand in one of + the following + statistical area + defintion + standards:

+
Area Unit
+
Statistics NZ + Classification of + Area Unit 2017 + v1.0.0
+
General + Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community + Board
+
Statistics NZ + Community Board + (codes 07601 - + 07621) 2018 + v1.0.0
+
Māori Electoral + District
+
Statistics NZ + Māori Electoral + District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard + for Meshblock 2018 + v1.0.0
+
Regional + Council
+
Statistics NZ + Regional Council + 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial + Authority 2018 + v1.0.0
+
Urban Area
+
Statistics NZ + Urban Area 2018 + v1.0.0
+
Ward
+
Statistics NZ + Ward 2018 + v1.0.0
+ EmailList: + description:

List of Email elements.

+ type: object + required: + - Email + properties: + Email: + type: array + items: + description:

This element represents + an e-mail address of one of + a number of types and occurs + in objects such as + StudentPersonal, + StaffPersonal, + StudentContactPersonal, etc. +

+ type: object + required: + - Address + properties: + Type: + $ref: "#/paths/~1StaffPersona\ + ls/get/responses/200/co\ + ntent/application~1json\ + /schema/properties/Staf\ + fPersonals/properties/S\ + taffPersonal/items/prop\ + erties/PersonInfo/prope\ + rties/EmailList/propert\ + ies/Email/items/propert\ + ies/Type" + Address: + type: string + description:

The actual email + address.

+ PhoneNumberList: + description:

List of PhoneNumber + elements.

+ type: object + required: + - PhoneNumber + properties: + PhoneNumber: + type: array + items: + description:

This element represents a + phone number and occurs + within objects such as + StudentPersonal, + StaffPersonal, etc.

+ type: object + required: + - Number + properties: + Type: + $ref: "#/paths/~1StaffPersona\ + ls/get/responses/200/co\ + ntent/application~1json\ + /schema/properties/Staf\ + fPersonals/properties/S\ + taffPersonal/items/prop\ + erties/PersonInfo/prope\ + rties/PhoneNumberList/p\ + roperties/PhoneNumber/i\ + tems/properties/Type" + Number: + type: string + description: "

Phone number. + Free-form, but typical + New Zealand formats + include:

    +
  • (0##) ###-####
    • +
  • ###-####
    • +
  • +##### ### ####
    • +
" + Extension: + type: string + description:

Phone number + extension.

+ ListedStatus: + $ref: "#/paths/~1StaffPersona\ + ls/get/responses/200/co\ + ntent/application~1json\ + /schema/properties/Staf\ + fPersonals/properties/S\ + taffPersonal/items/prop\ + erties/PersonInfo/prope\ + rties/Name/properties/F\ + amilyNameFirst" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StaffPersonals: + StaffPersonal: + - StaffPersonalRefId: D3E34F41-9D75-101A-8C3D-00AA001A1652 + PersonInfo: + Name: + FamilyName: Smith + GivenName: Fred + FullName: Fred Smith + Type: LGL + IsVerified: Y + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + Suburb: RD 1 + City: Hogsmeade + PostalCode: 5780 + EmailList: + Email: + - Type: ALT1 + Address: fsmith@yahoo.com + - Type: PRIM + Address: freddy@gmail.com + PhoneNumberList: + PhoneNumber: + - Type: WTE + Number: 03 9637-2289 + Extension: 72289 + - Type: HTE + Number: 0437-765-234 + application/xml: + schema: + type: object + properties: + StaffPersonals: + type: object + description: A List of StaffPersonal objects + properties: + StaffPersonal: + type: array + items: + $ref: "#/paths/~1StaffPersonals/get/responses/200/content\ + /application~1json/schema/properties/StaffPersonals\ + /properties/StaffPersonal/items" + example: >- + + + D3E34F41-9D75-101A-8C3D-00AA001A1652 + + + Smith + Fred + Fred Smith + LGL + Y + + +
+ TH + PHY + + The Enchanted Wood + 533 Hogwart's Way + + RD 1 + Hogsmeade + 5780 +
+ + + + ALT1 + fsmith@yahoo.com + + + PRIM + freddy@gmail.com + + + + + WTE + 03 9637-2289 + 72289 + + + HTE + 0437-765-234 + + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StaffPersonals/{StaffPersonalRefId}": + post: + tags: + - StaffPersonal + summary: Default operation to create a single StaffPersonal + parameters: + - name: StaffPersonalRefId + in: path + description:

The GUID of the staff member.

+ required: true + schema: + type: string + operationId: createStaffPersonal + requestBody: + description: CRUD operation on StaffPersonal + content: + application/json: + schema: + type: object + properties: + StaffPersonal: + $ref: "#/paths/~1StaffPersonals/get/responses/200/content/applica\ + tion~1json/schema/properties/StaffPersonals/properties/Staf\ + fPersonal/items" + example: + StaffPersonal: + StaffPersonalRefId: D3E34F41-9D75-101A-8C3D-00AA001A1652 + PersonInfo: + Name: + FamilyName: Smith + GivenName: Fred + FullName: Fred Smith + Type: LGL + IsVerified: Y + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + Suburb: RD 1 + City: Hogsmeade + PostalCode: 5780 + EmailList: + Email: + - Type: ALT1 + Address: fsmith@yahoo.com + - Type: PRIM + Address: freddy@gmail.com + PhoneNumberList: + PhoneNumber: + - Type: WTE + Number: 03 9637-2289 + Extension: 72289 + - Type: HTE + Number: 0437-765-234 + application/xml: + schema: + type: object + properties: + StaffPersonal: + $ref: "#/paths/~1StaffPersonals/get/responses/200/content/applica\ + tion~1json/schema/properties/StaffPersonals/properties/Staf\ + fPersonal/items" + example: >- + + D3E34F41-9D75-101A-8C3D-00AA001A1652 + + + Smith + Fred + Fred Smith + LGL + Y + + +
+ TH + PHY + + The Enchanted Wood + 533 Hogwart's Way + + RD 1 + Hogsmeade + 5780 +
+ + + + ALT1 + fsmith@yahoo.com + + + PRIM + freddy@gmail.com + + + + + WTE + 03 9637-2289 + 72289 + + + HTE + 0437-765-234 + + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StaffPersonal + summary: Default operation to update a single StaffPersonal + parameters: + - name: StaffPersonalRefId + in: path + description:

The GUID of the staff member.

+ required: true + schema: + type: string + operationId: updateStaffPersonal + requestBody: + description: CRUD operation on StaffPersonal + content: + application/json: + schema: + type: object + properties: + StaffPersonal: + type: object + properties: + StaffPersonalRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StaffPersonalLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + ESLPairwiseId: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPersonalRefId%7D/put\ + /requestBody/content/application~1json/schema/propertie\ + s/StaffPersonal/properties/StaffPersonalLocalId" + SchoolSMSUserId: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPersonalRefId%7D/put\ + /requestBody/content/application~1json/schema/propertie\ + s/StaffPersonal/properties/StaffPersonalLocalId" + PersonInfo: + description:

Personal Information

+ type: object + properties: + Name: + description:

A name used by the person

+ type: object + properties: + Title: + type: string + description:

A title or prefix associated with the + name.

+ FamilyName: + type: string + description:

Also known as Last Name, although some + cultures may not present a family name as the + last name.

+ GivenName: + type: string + description:

Also known as First Name, although some + cultures may not present this name as the first + element in a name. May contain a composite of + all given names.

+ MiddleName: + type: string + description:

Where more than one Given Name, these may be + combined in one composite field or else + populated in several elements.

+ FamilyNameFirst: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PreferredFamilyName: + type: string + description:

A preferred version of the Family Name. + Note:A name cannot have both a Preferred Family + and Preferred Given Name within the same Name + structure – only one of these fields should be + populated. If a person does have both a + Preferred Family and Preferred Given Name then + this must be populated as a separate Name of + type ‘Preferred’.

+ PreferredFamilyNameFirst: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPersonalRefI\ + d%7D/put/requestBody/content/application~1json/\ + schema/properties/StaffPersonal/properties/Pers\ + onInfo/properties/Name/properties/FamilyNameFir\ + st" + PreferredGivenName: + type: string + description: "

A preferred version of the Given Name. Note: + A name cannot have both a Preferred Family and + Preferred Given Name within the same Name + structure – only one of these fields should be + populated. If a person does have both a + Preferred Family and Preferred Given Name then + this must be populated as a separate Name of + type ‘Preferred’.

" + Suffix: + type: string + description:

Textual suffix like PHD, JP, BSc.

+ FullName: + type: string + description:

A combination of all name elements as one + composite text element

+ Type: + type: string + title: Name Usage Type + description: >- +

A standardised method of describing the usage + of a name by a person. Where a person has more + than one current name, the usage type indicates + which name may be used according to the + purpose.

Code values are based on SIF + Australia 3.4.

    +
  • 'PRF' - Preferred Name
    • +
  • 'FON' - Foreign Official Name
    • +
  • 'PRV' - Previous name
    • +
  • 'AKA' - Also Known As
    • +
  • 'BTH' - Name at Birth
    • +
  • 'LGL' - Legal Name
    • +
+ oneOf: + - title: Preferred Name + description:

The name by which an individual prefers + to be known and addressed.

Only usage + type applicable for student name usage + (other types are not supported by NSI).

+ enum: + - PRF + - title: Foreign Official Name + description:

Included for future usage in NZ, + especially for tertiary students.

+ enum: + - FON + - title: Previous name + enum: + - PRV + - title: Also Known As + description: AKA or Alias + enum: + - AKA + - title: Name at Birth + enum: + - BTH + - title: Legal Name + description:

Legal Name or Official Name as defined by + the organisation which collects it (legal + name is not defined in this standard)

+ enum: + - LGL + IsVerified: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPersonalRefI\ + d%7D/put/requestBody/content/application~1json/\ + schema/properties/StaffPersonal/properties/Pers\ + onInfo/properties/Name/properties/FamilyNameFir\ + st" + OtherNameList: + description:

Previous, alternate or other names or aliases + associated with the person.

+ type: object + properties: + Name: + type: array + items: + description:

Extension of BaseNameType including name + verification data

+ type: object + properties: + Verification: + description:

The verification event that verified + the person's name.

+ type: object + properties: + Source: + type: string + title: Verification Source + description: >- +

Records the source of the identity + or eligibility verification, that has + been made. Mostly it is merely a + record of the kind of document that + has been presented; but occasionally + it is down to Principal or Ministry + discretion / approval.

    +
  • 'NZBIR' - NZ Birth Certificate
    • +
  • 'NZBCO' - NZ Birth Certificate (with confirmation of NZ Citizen by birth)
    • +
  • 'NZPAS' - NZ Passport
    • +
  • 'NZCIT' - NZ Citizenship Certificate
    • +
  • 'BIRCE' - Birth Certificate (COK, TKL, NIU)
    • +
  • 'BCCON' - Birth Certificate (COK, TKL, NIU) (with confirmation of NZ Citizen by birth)
    • +
  • 'CENAT' - Certification of Naturalisation (COK, TKL, NIU)
    • +
  • 'CAREG' - Certification of Registration (COK, TKL, NIU)
    • +
  • 'LETCO' - Letter of Confirmation (COK, TKL, NIU)
    • +
  • 'OTHPA' - Other Passport with NZ residence class Visa
    • +
  • 'AUSPA' - Australian Passport
    • +
  • 'VISDO' - Visa Domestic
    • +
plus 3 more value(s) at NZCodeSetsVerificationSourceType + oneOf: + - title: NZ Birth Certificate + description: Applies if the child was born + before 1 Jan 2006 + enum: + - NZBIR + - title: NZ Birth Certificate (with + confirmation of NZ Citizen by + birth) + description: Applies if the child was born on + or after 1 Jan 2006 + enum: + - NZBCO + - title: NZ Passport + description: Including COK, TKL or NIU. + (Current or Expired) + enum: + - NZPAS + - title: NZ Citizenship Certificate + enum: + - NZCIT + - title: Birth Certificate (COK, TKL, NIU) + description: If the child was born before 1 Jan + 2006 + enum: + - BIRCE + - title: Birth Certificate (COK, TKL, NIU) + (with confirmation of NZ Citizen + by birth) + description: Applies if the child was born on + or after 1 Jan 2006. + enum: + - BCCON + - title: Certification of Naturalisation + (COK, TKL, NIU) + enum: + - CENAT + - title: Certification of Registration + (COK, TKL, NIU) + enum: + - CAREG + - title: Letter of Confirmation (COK, TKL, + NIU) + enum: + - LETCO + - title: Other Passport with NZ residence + class Visa + description: Or other evidence of NZ residency + enum: + - OTHPA + - title: Australian Passport + description: (Current or Expired) + enum: + - AUSPA + - title: Visa Domestic + enum: + - VISDO + - title: Visa with conditions of study + enum: + - VISST + - title: Principal Discretion + enum: + - PRINC + - title: MoE Approval + enum: + - MOEAP + DocumentSerialNumber: + type: string + description:

The serial number on the document + that was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document + that was used to verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has been + confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + description:

A reference to another SIF Data + Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StaffPersonals~1%7BSta\ + ffPersonalRefId%7D/put/requestBod\ + y/content/application~1json/schem\ + a/properties/StaffPersonal/proper\ + ties/StaffPersonalRefId" + LocalId: + $ref: "#/paths/~1StaffPersonals~1%7BSta\ + ffPersonalRefId%7D/put/requestBod\ + y/content/application~1json/schem\ + a/properties/StaffPersonal/proper\ + ties/StaffPersonalLocalId" + Name: + type: string + description:

The normal descriptive name of + the referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF + DataObject names, to be included + in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that + operates within the education + sector; but doesn’t provide + education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of + education services such as ECE + Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship + between two providers of + education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that + Students enrol in, and may be + assessed for, and achieve + passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other + award granted by a national + body, professional association + or other interested party. The + Credential describes an award + that is made to the learner at + the successful completion of a + particular learning programme. + eg: NCEA Level 1; University + Entrance; NCEA Level 2 + Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information + relating to a staff member, + who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff + member to a particular Role at + a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal + information related to the + student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal + information about a person who + is a part of a Student's + whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a + person who is a part of a + Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with + an education provider for the + purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class + or other group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the + attendance spans for a single + student at a single provider + during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a + particular assignment or other + assessment task, to be + undertaken by one or more + Students at some time. Defines + the task separately from each + student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for + an assessment task they are + intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt + at a particular assessment + task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by + a single student at a + particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an + Attainment e.g. NCEA + Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and + follow ups generated by a + WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's + interests and academic, career + and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a + co-curricular or + extra-curricular activity in + which a student participates + during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information + pertaining to a student's + participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and + achievement reports provided + for a student. Used in + technology centres the host + provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + VerifiedName: + description:

The verified name of the person.

+ type: object + properties: + Verification: + description:

The verification event that verified the + person's name.

+ type: object + properties: + Source: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPersonal\ + RefId%7D/put/requestBody/content/applicatio\ + n~1json/schema/properties/StaffPersonal/pro\ + perties/PersonInfo/properties/OtherNameList\ + /properties/Name/items/properties/Verificat\ + ion/properties/Source" + DocumentSerialNumber: + type: string + description:

The serial number on the document that + was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document that was + used to verify the name or birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has been + confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPersonal\ + RefId%7D/put/requestBody/content/applicatio\ + n~1json/schema/properties/StaffPersonal/pro\ + perties/PersonInfo/properties/OtherNameList\ + /properties/Name/items/properties/Verificat\ + ion/properties/Provider" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + Demographics: + description:

Details of the person’s demographic properties

+ type: object + properties: + BirthDate: + type: string + format: date + description:

The person's date of birth.

+ DateOfDeath: + type: string + format: date + description:

The person's date of death.

+ PlaceOfBirth: + type: string + description:

The person's place of birth - like village, + town, city etc.

+ CountryOfBirth: + type: string + title: 3166 Country + description: >- +

A country is a geopolitical entity recognised + by the New Zealand government. The term country + may include

  • Independent countries + recognised by the New Zealand Government
    • +
  • Units that are recognised geographic + areas
  • administrative subdivisions of + the United Kingdom
  • overseas + dependencies, external territories of + independent countries.

Conforms to + the International Standard ISO 3166 Codes for + the Representation of Names of Countries and + their Subdivisions (ISO 3166-1:2013). Education + adopts the alpha-3 representation of this + standard.

    +
  • 'ABW' - Aruba
    • +
  • 'AFG' - Afghanistan
    • +
  • 'AGO' - Angola
    • +
  • 'AIA' - Anguilla
    • +
  • 'ALA' - Åland Islands
    • +
  • 'ALB' - Albania
    • +
  • 'AND' - Andorra
    • +
  • 'ARE' - United Arab Emirates
    • +
  • 'ARG' - Argentina
    • +
  • 'ARM' - Armenia
    • +
  • 'ASM' - American Samoa
    • +
  • 'ATA' - Antarctica
    • +
plus 237 more value(s) at ISO3166CountryType + oneOf: + - title: Aruba + enum: + - ABW + - title: Afghanistan + enum: + - AFG + - title: Angola + enum: + - AGO + - title: Anguilla + enum: + - AIA + - title: Åland Islands + enum: + - ALA + - title: Albania + enum: + - ALB + - title: Andorra + enum: + - AND + - title: United Arab Emirates + enum: + - ARE + - title: Argentina + enum: + - ARG + - title: Armenia + enum: + - ARM + - title: American Samoa + enum: + - ASM + - title: Antarctica + enum: + - ATA + - title: French Southern Territories + enum: + - ATF + - title: Antigua and Barbuda + enum: + - ATG + - title: Australia + enum: + - AUS + - title: Austria + enum: + - AUT + - title: Azerbaijan + enum: + - AZE + - title: Burundi + enum: + - BDI + - title: Belgium + enum: + - BEL + - title: Benin + enum: + - BEN + - title: Bonaire, Sint Eustatius and Saba + enum: + - BES + - title: Burkina Faso + enum: + - BFA + - title: Bangladesh + enum: + - BGD + - title: Bulgaria + enum: + - BGR + - title: Bahrain + enum: + - BHR + - title: Bahamas + enum: + - BHS + - title: Bosnia and Herzegovina + enum: + - BIH + - title: Saint Barthélemy + enum: + - BLM + - title: Belarus + enum: + - BLR + - title: Belize + enum: + - BLZ + - title: Bermuda + enum: + - BMU + - title: Bolivia, Plurinational State of + enum: + - BOL + - title: Brazil + enum: + - BRA + - title: Barbados + enum: + - BRB + - title: Brunei Darussalam + enum: + - BRN + - title: Bhutan + enum: + - BTN + - title: Bouvet Island + enum: + - BVT + - title: Botswana + enum: + - BWA + - title: Central African Republic + enum: + - CAF + - title: Canada + enum: + - CAN + - title: Cocos (Keeling) Islands + enum: + - CCK + - title: Switzerland + enum: + - CHE + - title: Chile + enum: + - CHL + - title: China + enum: + - CHN + - title: Côte d'Ivoire + enum: + - CIV + - title: Cameroon + enum: + - CMR + - title: Congo, the Democratic Republic of the + enum: + - COD + - title: Congo + enum: + - COG + - title: Cook Islands + enum: + - COK + - title: Colombia + enum: + - COL + - title: Comoros + enum: + - COM + - title: Cabo Verde + enum: + - CPV + - title: Costa Rica + enum: + - CRI + - title: Cuba + enum: + - CUB + - title: Curaçao + enum: + - CUW + - title: Christmas Island + enum: + - CXR + - title: Cayman Islands + enum: + - CYM + - title: Cyprus + enum: + - CYP + - title: Czechia + enum: + - CZE + - title: Germany + enum: + - DEU + - title: Djibouti + enum: + - DJI + - title: Dominica + enum: + - DMA + - title: Denmark + enum: + - DNK + - title: Dominican Republic + enum: + - DOM + - title: Algeria + enum: + - DZA + - title: Ecuador + enum: + - ECU + - title: Egypt + enum: + - EGY + - title: Eritrea + enum: + - ERI + - title: Western Sahara + enum: + - ESH + - title: Spain + enum: + - ESP + - title: Estonia + enum: + - EST + - title: Ethiopia + enum: + - ETH + - title: Finland + enum: + - FIN + - title: Fiji + enum: + - FJI + - title: Falkland Islands (Malvinas) + enum: + - FLK + - title: France + enum: + - FRA + - title: Faroe Islands + enum: + - FRO + - title: Micronesia, Federated States of + enum: + - FSM + - title: Gabon + enum: + - GAB + - title: United Kingdom + enum: + - GBR + - title: Georgia + enum: + - GEO + - title: Guernsey + enum: + - GGY + - title: Ghana + enum: + - GHA + - title: Gibraltar + enum: + - GIB + - title: Guinea + enum: + - GIN + - title: Guadeloupe + enum: + - GLP + - title: Gambia + enum: + - GMB + - title: Guinea-Bissau + enum: + - GNB + - title: Equatorial Guinea + enum: + - GNQ + - title: Greece + enum: + - GRC + - title: Grenada + enum: + - GRD + - title: Greenland + enum: + - GRL + - title: Guatemala + enum: + - GTM + - title: French Guiana + enum: + - GUF + - title: Guam + enum: + - GUM + - title: Guyana + enum: + - GUY + - title: Hong Kong + enum: + - HKG + - title: Heard Island and McDonald Islands + enum: + - HMD + - title: Honduras + enum: + - HND + - title: Croatia + enum: + - HRV + - title: Haiti + enum: + - HTI + - title: Hungary + enum: + - HUN + - title: Indonesia + enum: + - IDN + - title: Isle of Man + enum: + - IMN + - title: India + enum: + - IND + - title: British Indian Ocean Territory + enum: + - IOT + - title: Ireland + enum: + - IRL + - title: Iran, Islamic Republic of + enum: + - IRN + - title: Iraq + enum: + - IRQ + - title: Iceland + enum: + - ISL + - title: Israel + enum: + - ISR + - title: Italy + enum: + - ITA + - title: Jamaica + enum: + - JAM + - title: Jersey + enum: + - JEY + - title: Jordan + enum: + - JOR + - title: Japan + enum: + - JPN + - title: Kazakhstan + enum: + - KAZ + - title: Kenya + enum: + - KEN + - title: Kyrgyzstan + enum: + - KGZ + - title: Cambodia + enum: + - KHM + - title: Kiribati + enum: + - KIR + - title: Saint Kitts and Nevis + enum: + - KNA + - title: Korea, Republic of + enum: + - KOR + - title: Kuwait + enum: + - KWT + - title: Lao People's Democratic Republic + enum: + - LAO + - title: Lebanon + enum: + - LBN + - title: Liberia + enum: + - LBR + - title: Libya + enum: + - LBY + - title: Saint Lucia + enum: + - LCA + - title: Liechtenstein + enum: + - LIE + - title: Sri Lanka + enum: + - LKA + - title: Lesotho + enum: + - LSO + - title: Lithuania + enum: + - LTU + - title: Luxembourg + enum: + - LUX + - title: Latvia + enum: + - LVA + - title: Macao + enum: + - MAC + - title: Saint Martin (French part) + enum: + - MAF + - title: Morocco + enum: + - MAR + - title: Monaco + enum: + - MCO + - title: Moldova, Republic of + enum: + - MDA + - title: Madagascar + enum: + - MDG + - title: Maldives + enum: + - MDV + - title: Mexico + enum: + - MEX + - title: Marshall Islands + enum: + - MHL + - title: Macedonia, the former Yugoslav Republic of + enum: + - MKD + - title: Mali + enum: + - MLI + - title: Malta + enum: + - MLT + - title: Myanmar + enum: + - MMR + - title: Montenegro + enum: + - MNE + - title: Mongolia + enum: + - MNG + - title: Northern Mariana Islands + enum: + - MNP + - title: Mozambique + enum: + - MOZ + - title: Mauritania + enum: + - MRT + - title: Montserrat + enum: + - MSR + - title: Martinique + enum: + - MTQ + - title: Mauritius + enum: + - MUS + - title: Malawi + enum: + - MWI + - title: Malaysia + enum: + - MYS + - title: Mayotte + enum: + - MYT + - title: Namibia + enum: + - NAM + - title: New Caledonia + enum: + - NCL + - title: Niger + enum: + - NER + - title: Norfolk Island + enum: + - NFK + - title: Nigeria + enum: + - NGA + - title: Nicaragua + enum: + - NIC + - title: Niue + enum: + - NIU + - title: Netherlands + enum: + - NLD + - title: Norway + enum: + - NOR + - title: Nepal + enum: + - NPL + - title: Nauru + enum: + - NRU + - title: New Zealand + enum: + - NZL + - title: Oman + enum: + - OMN + - title: Pakistan + enum: + - PAK + - title: Panama + enum: + - PAN + - title: Pitcairn + enum: + - PCN + - title: Peru + enum: + - PER + - title: Philippines + enum: + - PHL + - title: Palau + enum: + - PLW + - title: Papua New Guinea + enum: + - PNG + - title: Poland + enum: + - POL + - title: Puerto Rico + enum: + - PRI + - title: Korea, Democratic People's Republic of + enum: + - PRK + - title: Portugal + enum: + - PRT + - title: Paraguay + enum: + - PRY + - title: Palestine, State of + enum: + - PSE + - title: French Polynesia + enum: + - PYF + - title: Qatar + enum: + - QAT + - title: Réunion + enum: + - REU + - title: Romania + enum: + - ROU + - title: Russian Federation + enum: + - RUS + - title: Rwanda + enum: + - RWA + - title: Saudi Arabia + enum: + - SAU + - title: Sudan + enum: + - SDN + - title: Senegal + enum: + - SEN + - title: Singapore + enum: + - SGP + - title: South Georgia and the South Sandwich Islands + enum: + - SGS + - title: Saint Helena, Ascension and Tristan da Cunha + enum: + - SHN + - title: Svalbard and Jan Mayen + enum: + - SJM + - title: Solomon Islands + enum: + - SLB + - title: Sierra Leone + enum: + - SLE + - title: El Salvador + enum: + - SLV + - title: San Marino + enum: + - SMR + - title: Somalia + enum: + - SOM + - title: Saint Pierre and Miquelon + enum: + - SPM + - title: Serbia + enum: + - SRB + - title: South Sudan + enum: + - SSD + - title: Sao Tome and Principe + enum: + - STP + - title: Suriname + enum: + - SUR + - title: Slovakia + enum: + - SVK + - title: Slovenia + enum: + - SVN + - title: Sweden + enum: + - SWE + - title: Swaziland + enum: + - SWZ + - title: Sint Maarten (Dutch part) + enum: + - SXM + - title: Seychelles + enum: + - SYC + - title: Syrian Arab Republic + enum: + - SYR + - title: Turks and Caicos Islands + enum: + - TCA + - title: Chad + enum: + - TCD + - title: Togo + enum: + - TGO + - title: Thailand + enum: + - THA + - title: Tajikistan + enum: + - TJK + - title: Tokelau + enum: + - TKL + - title: Turkmenistan + enum: + - TKM + - title: Timor-Leste + enum: + - TLS + - title: Tonga + enum: + - TON + - title: Trinidad and Tobago + enum: + - TTO + - title: Tunisia + enum: + - TUN + - title: Turkey + enum: + - TUR + - title: Tuvalu + enum: + - TUV + - title: Taiwan, Province of China + enum: + - TWN + - title: Tanzania, United Republic of + enum: + - TZA + - title: Uganda + enum: + - UGA + - title: Ukraine + enum: + - UKR + - title: United States Minor Outlying Islands + enum: + - UMI + - title: Uruguay + enum: + - URY + - title: United States of America + enum: + - USA + - title: Uzbekistan + enum: + - UZB + - title: Holy See + enum: + - VAT + - title: Saint Vincent and the Grenadines + enum: + - VCT + - title: Venezuela, Bolivarian Republic of + enum: + - VEN + - title: Virgin Islands, British + enum: + - VGB + - title: Virgin Islands, U.S. + enum: + - VIR + - title: Viet Nam + enum: + - VNM + - title: Vanuatu + enum: + - VUT + - title: Wallis and Futuna + enum: + - WLF + - title: Samoa + enum: + - WSM + - title: Yemen + enum: + - YEM + - title: South Africa + enum: + - ZAF + - title: Zambia + enum: + - ZMB + - title: Zimbabwe + enum: + - ZWE + CitizenshipList: + type: object + properties: + Country: + type: array + items: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPerson\ + alRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StaffPerson\ + al/properties/PersonInfo/properties/Demog\ + raphics/properties/CountryOfBirth" + CitizenshipStatus: + type: string + title: Citizenship Status + description: >- +

The citizenship or residency status of a + person, principally recorded in order to + determine eligibility for education services + hence limited to indicating New Zealand, + Australian or Other residency.

Based on + SIF Australia + AUCodeSetsAustralianCitizenshipStatusType

+
    +
  • 'AUCI' - Australian citizen
    • +
  • 'NZCI' - NZ citizen
    • +
  • 'OTOV' - Other overseas
    • +
  • 'NZRE' - NZ resident
    • +
  • 'NOPR' - Not provided
    • +
+ oneOf: + - title: Australian citizen + enum: + - AUCI + - title: NZ citizen + enum: + - NZCI + - title: Other overseas + description: Indicates a residency other than NZ or + Australia + enum: + - OTOV + - title: NZ resident + description: Includes Australian residents classified as + NZ resident once arrived in NZ + enum: + - NZRE + - title: Not provided + enum: + - NOPR + CitizenshipVerification: + description:

The verification event that verified the + residency status of the person. Absence of a + verification event indicates that the residency + was not verified against an identity document. +

+ type: object + properties: + Source: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPersonal\ + RefId%7D/put/requestBody/content/applicatio\ + n~1json/schema/properties/StaffPersonal/pro\ + perties/PersonInfo/properties/OtherNameList\ + /properties/Name/items/properties/Verificat\ + ion/properties/Source" + DocumentSerialNumber: + type: string + description:

The serial number on the document that + was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document that was + used to verify the name or birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has been + confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPersonal\ + RefId%7D/put/requestBody/content/applicatio\ + n~1json/schema/properties/StaffPersonal/pro\ + perties/PersonInfo/properties/OtherNameList\ + /properties/Name/items/properties/Verificat\ + ion/properties/Provider" + Gender: + type: string + title: Gender + description: >- +

A Person may identify as having a Gender (or + Gender Identity). Biological sex and sexual + orientation are related but different concepts. + Sourced from Statistics NZ Standard for Gender + Identity

    +
  • '1' - Male - Tāne
    • +
  • '2' - Female - Wahine
    • +
  • '3' - Gender Diverse - Ira tāngata kōwhiri kore
    • +
  • '31' - Transgender Male to Female - Whakawahine
    • +
  • '32' - Transgender Female to Male - Tangata ira tāne
    • +
  • '9' - Not Willing to Disclose
    • +
+ oneOf: + - title*: + en: Male + mi: Tāne + enum: + - "1" + - title*: + en: Female + mi: Wahine + enum: + - "2" + - title*: + en: Gender Diverse + mi: Ira tāngata kōwhiri kore + description: But not further defined + enum: + - "3" + - title*: + en: Transgender Male to Female + mi: Whakawahine + description: '"Can be rolled up to 3:Gender Diverse"' + enum: + - "31" + - title*: + en: Transgender Female to Male + mi: Tangata ira tāne + description: '"Can be rolled up to 3:Gender Diverse"' + enum: + - "32" + - title*: + en: Not Willing to Disclose + enum: + - "9" + LanguageList: + description: List of languages an individual uses to + communicate. + type: object + properties: + Language: + type: array + items: + description:

A language that an individual uses to + communicate.

+ type: object + properties: + Code: + type: string + title: Language + description: >- +

Language refers to recognised human + communication systems, typically oral + and/or written. Sourced from + Statistics NZ - Language Standard + Classification 1999 v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not further defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not elsewhere + classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not further defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not elsewhere + classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not elsewhere + classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not further + defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not elsewhere + classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere classified + enum: + - NZS15199 + - title: Central-Eastern Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not further defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not elsewhere + classified + enum: + - NZS16199 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not elsewhere + classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western Malayo-Polynesian not + further defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western Malayo-Polynesian not + elsewhere classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere classified + enum: + - NZS18399 + - title: Niger-Congo (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not further + defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not elsewhere + classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not further + defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not elsewhere + classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not elsewhere + classified + enum: + - NZS219 + - title: Language Isolates not elsewhere + classified + enum: + - NZS21999 + - title: Miscellaneous Language Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous Languages + enum: + - NZS229 + - title: Other Miscellaneous Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not further + defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not elsewhere + classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not further defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not elsewhere + classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + Usage: + type: string + title: Language Usage + description: >- +

A standardised method of describing + the usage of a language by a person, + potentially indicating capability and + preference for the language.

    +
  • 'FL' - First Language
    • +
  • 'SL' - Secondary Language
    • +
  • 'SH' - Spoken At Home
    • +
+ oneOf: + - title: First Language + enum: + - FL + - title: Secondary Language + enum: + - SL + - title: Spoken At Home + enum: + - SH + Dialect: + type: string + description:

Specific dialect of a person's + language.

+ ProficiencyList: + description:

A list of the person's proficiency + in the language in regards to + speaking, reading and writing.

+ type: object + properties: + Proficiency: + type: array + items: + description:

The person's proficiency in + the language in regards to + speaking, reading and + writing.

+ type: object + properties: + Level: + type: string + title: Language Proficiency Level + description: >- +

The language proficiency + level.

    +
  • 'NO' - None
    • +
  • 'BE' - Beginner
    • +
  • 'IN' - Intermediate
    • +
  • 'AD' - Advanced
    • +
+ oneOf: + - title: None + enum: + - NO + - title: Beginner + enum: + - BE + - title: Intermediate + enum: + - IN + - title: Advanced + enum: + - AD + Type: + type: string + title: Language Proficiency Type + description: >- +

Code set denoting a type + of language proficiency, + e.g. speaking, writing + reading.

    +
  • 'SP' - Speaking
    • +
  • 'RE' - Reading
    • +
  • 'WR' - Writing
    • +
+ oneOf: + - title: Speaking + enum: + - SP + - title: Reading + enum: + - RE + - title: Writing + enum: + - WR + CountryArrivalDate: + type: string + format: date + description: Date the person first arrived in the country. + EthnicityList: + description:

One or more ethnic groups with which the + person identifies.

+ type: object + properties: + Ethnicity: + type: array + items: + description:

An ethnic group with which the person + identifies, and if there is more than one, + their order of preference.

+ type: object + properties: + PreferenceOrderNumber: + type: integer + description:

The order of preference for the + person's ethnicity.

+ Code: + type: string + title: Ethnicity + description: >- +

Ethnicity is the ethnic group or + groups that people identify with or + feel they belong to. Ethnicity is a + measure of cultural affiliation, as + opposed to race, ancestry, nationality + or citizenship. Ethnicity is self + perceived and people can belong to + more than one ethnic group.

The + permissible values consists of any + value from the Statistics NZ - + Ethnicity New Zealand Standard + Classification 2005 v2.0.0 Depending + on usage, ethnicity may be defined at + levels 1 to 4.

    +
  • '1' - European
    • +
  • '10' - European nfd
    • +
  • '100' - European nfd
    • +
  • '10000' - European nfd
    • +
  • '11' - New Zealand European
    • +
  • '111' - New Zealand European
    • +
  • '11111' - New Zealand European
    • +
  • '12' - Other European
    • +
  • '121' - British and Irish
    • +
  • '12100' - British nfd
    • +
  • '12111' - Celtic nfd
    • +
  • '12112' - Channel Islander
    • +
plus 250 more value(s) at NZCodeSetsEthnicityType + oneOf: + - title: European + enum: + - "1" + - title: European nfd + enum: + - "10" + - title: European nfd + enum: + - "100" + - title: European nfd + enum: + - "10000" + - title: New Zealand European + enum: + - "11" + - title: New Zealand European + enum: + - "111" + - title: New Zealand European + enum: + - "11111" + - title: Other European + enum: + - "12" + - title: British and Irish + enum: + - "121" + - title: British nfd + enum: + - "12100" + - title: Celtic nfd + enum: + - "12111" + - title: Channel Islander + enum: + - "12112" + - title: Cornish + enum: + - "12113" + - title: English + enum: + - "12114" + - title: Irish + enum: + - "12116" + - title: Manx + enum: + - "12117" + - title: Scottish + enum: + - "12119" + - title: Welsh + enum: + - "12121" + - title: British nec + enum: + - "12199" + - title: Dutch + enum: + - "122" + - title: Dutch + enum: + - "12211" + - title: Greek + enum: + - "123" + - title: Greek + enum: + - "12311" + - title: Polish + enum: + - "124" + - title: Polish + enum: + - "12411" + - title: South Slav + enum: + - "125" + - title: South Slav nfd + enum: + - "12500" + - title: Croatian + enum: + - "12511" + - title: Dalmatian + enum: + - "12512" + - title: Macedonian + enum: + - "12513" + - title: Serbian + enum: + - "12514" + - title: Slovenian + enum: + - "12515" + - title: Bosnian + enum: + - "12516" + - title: South Slav nec + enum: + - "12599" + - title: Italian + enum: + - "126" + - title: Italian + enum: + - "12611" + - title: German + enum: + - "127" + - title: German + enum: + - "12711" + - title: Australian + enum: + - "128" + - title: Australian + enum: + - "12811" + - title: Other European + enum: + - "129" + - title: Albanian + enum: + - "12911" + - title: Armenian + enum: + - "12912" + - title: Austrian + enum: + - "12913" + - title: Belgian + enum: + - "12914" + - title: Bulgarian + enum: + - "12915" + - title: Belorussian + enum: + - "12916" + - title: Cypriot nfd + enum: + - "12918" + - title: Czech + enum: + - "12919" + - title: Danish + enum: + - "12920" + - title: Estonian + enum: + - "12921" + - title: Finnish + enum: + - "12922" + - title: Flemish + enum: + - "12923" + - title: French + enum: + - "12924" + - title: Hungarian + enum: + - "12926" + - title: Icelandic + enum: + - "12927" + - title: Latvian + enum: + - "12928" + - title: Lithuanian + enum: + - "12929" + - title: Maltese + enum: + - "12930" + - title: Norwegian + enum: + - "12931" + - title: Portuguese + enum: + - "12932" + - title: Romanian + enum: + - "12933" + - title: Gypsy + enum: + - "12934" + - title: Russian + enum: + - "12935" + - title: Slavic + enum: + - "12937" + - title: Slovak + enum: + - "12938" + - title: Spanish + enum: + - "12939" + - title: Swedish + enum: + - "12940" + - title: Swiss + enum: + - "12941" + - title: Ukrainian + enum: + - "12942" + - title: American + enum: + - "12943" + - title: Canadian + enum: + - "12945" + - title: New Caledonian + enum: + - "12947" + - title: South African European + enum: + - "12948" + - title: Afrikaner + enum: + - "12949" + - title: Zimbabwean European + enum: + - "12950" + - title: European nec + enum: + - "12999" + - title: Māori + enum: + - "2" + - title: Māori + enum: + - "21" + - title: Māori + enum: + - "211" + - title: Māori + enum: + - "21111" + - title: Pacific Peoples + enum: + - "3" + - title: Pacific Peoples nfd + enum: + - "30" + - title: Pacific Peoples nfd + enum: + - "300" + - title: Pacific Peoples nfd + enum: + - "30000" + - title: Samoan + enum: + - "31" + - title: Samoan + enum: + - "311" + - title: Samoan + enum: + - "31111" + - title: Cook Islands Maori + enum: + - "32" + - title: Cook Islands Maori + enum: + - "321" + - title: Cook Islands Maori + enum: + - "32100" + - title: Tongan + enum: + - "33" + - title: Tongan + enum: + - "331" + - title: Tongan + enum: + - "33111" + - title: Niuean + enum: + - "34" + - title: Niuean + enum: + - "341" + - title: Niuean + enum: + - "34111" + - title: Tokelauan + enum: + - "35" + - title: Tokelauan + enum: + - "351" + - title: Tokelauan + enum: + - "35111" + - title: Fijian + enum: + - "36" + - title: Fijian + enum: + - "361" + - title: Fijian + enum: + - "36111" + - title: Other Pacific Peoples + enum: + - "37" + - title: Other Pacific Peoples + enum: + - "371" + - title: Indigenous Australian + enum: + - "37112" + - title: Hawaiian + enum: + - "37122" + - title: Kiribati + enum: + - "37124" + - title: Nauruan + enum: + - "37130" + - title: Papua New Guinean + enum: + - "37135" + - title: Pitcairn Islander + enum: + - "37137" + - title: Rotuman + enum: + - "37138" + - title: Tahitian + enum: + - "37140" + - title: Solomon Islander + enum: + - "37141" + - title: Tuvaluan + enum: + - "37144" + - title: Ni Vanuatu + enum: + - "37145" + - title: Pacific Peoples nec + enum: + - "37199" + - title: Asian + enum: + - "4" + - title: Asian nfd + enum: + - "40" + - title: Asian nfd + enum: + - "400" + - title: Asian nfd + enum: + - "40000" + - title: South East Asian + enum: + - "41" + - title: South East Asian nfd + enum: + - "410" + - title: South East Asian nfd + enum: + - "41000" + - title: Filipino + enum: + - "411" + - title: Filipino + enum: + - "41111" + - title: Cambodian + enum: + - "412" + - title: Cambodian + enum: + - "41211" + - title: Vietnamese + enum: + - "413" + - title: Vietnamese + enum: + - "41311" + - title: Other Southeast Asian + enum: + - "414" + - title: Burmese + enum: + - "41411" + - title: Indonesian + enum: + - "41412" + - title: Lao + enum: + - "41413" + - title: Malay + enum: + - "41414" + - title: Thai + enum: + - "41415" + - title: Karen + enum: + - "41416" + - title: Chin + enum: + - "41417" + - title: Southeast Asian nec + enum: + - "41499" + - title: Chinese + enum: + - "42" + - title: Chinese + enum: + - "421" + - title: Chinese nfd + enum: + - "42100" + - title: Hong Kong Chinese + enum: + - "42111" + - title: Cambodian Chinese + enum: + - "42112" + - title: Malaysian Chinese + enum: + - "42113" + - title: Singaporean Chinese + enum: + - "42114" + - title: Vietnamese Chinese + enum: + - "42115" + - title: Taiwanese + enum: + - "42116" + - title: Chinese nec + enum: + - "42199" + - title: Indian + enum: + - "43" + - title: Indian + enum: + - "431" + - title: Indian nfd + enum: + - "43100" + - title: Bengali + enum: + - "43111" + - title: Fijian Indian + enum: + - "43112" + - title: Indian Tamil + enum: + - "43114" + - title: Punjabi + enum: + - "43115" + - title: Sikh + enum: + - "43116" + - title: Anglo Indian + enum: + - "43117" + - title: Malaysian Indian + enum: + - "43118" + - title: South African Indian + enum: + - "43119" + - title: Indian nec + enum: + - "43199" + - title: Other Asian + enum: + - "44" + - title: Sri Lankan + enum: + - "441" + - title: Sri Lankan nfd + enum: + - "44100" + - title: Sinhalese + enum: + - "44111" + - title: Sri Lankan Tamil + enum: + - "44112" + - title: Sri Lankan nec + enum: + - "44199" + - title: Japanese + enum: + - "442" + - title: Japanese + enum: + - "44211" + - title: Korean + enum: + - "443" + - title: Korean + enum: + - "44311" + - title: Other Asian + enum: + - "444" + - title: Afghani + enum: + - "44411" + - title: Bangladeshi + enum: + - "44412" + - title: Nepalese + enum: + - "44413" + - title: Pakistani + enum: + - "44414" + - title: Tibetan + enum: + - "44415" + - title: Eurasian + enum: + - "44416" + - title: Bhutanese + enum: + - "44417" + - title: Maldivian + enum: + - "44418" + - title: Mongolian + enum: + - "44419" + - title: Asian nec + enum: + - "44499" + - title: Middle Eastern/Latin + American/African + enum: + - "5" + - title: Middle Eastern + enum: + - "51" + - title: Middle Eastern + enum: + - "511" + - title: Middle Eastern nfd + enum: + - "51100" + - title: Algerian + enum: + - "51111" + - title: Arab + enum: + - "51112" + - title: Assyrian + enum: + - "51113" + - title: Egyptian + enum: + - "51114" + - title: Iranian/Persian + enum: + - "51115" + - title: Iraqi + enum: + - "51116" + - title: Israeli/Jewish + enum: + - "51117" + - title: Jordanian + enum: + - "51118" + - title: Kurd + enum: + - "51119" + - title: Lebanese + enum: + - "51120" + - title: Moroccan + enum: + - "51122" + - title: Palestinian + enum: + - "51124" + - title: Syrian + enum: + - "51125" + - title: Turkish + enum: + - "51127" + - title: Middle Eastern nec + enum: + - "51199" + - title: Latin American + enum: + - "52" + - title: Latin American + enum: + - "521" + - title: Latin American nfd + enum: + - "52100" + - title: Argentinian + enum: + - "52111" + - title: Bolivian + enum: + - "52112" + - title: Brazilian + enum: + - "52113" + - title: Chilean + enum: + - "52114" + - title: Colombian + enum: + - "52115" + - title: Ecuadorian + enum: + - "52118" + - title: Mexican + enum: + - "52123" + - title: Peruvian + enum: + - "52127" + - title: Puerto Rican + enum: + - "52128" + - title: Uruguayan + enum: + - "52129" + - title: Venezuelan + enum: + - "52130" + - title: Latin American nec + enum: + - "52199" + - title: African + enum: + - "53" + - title: African + enum: + - "531" + - title: African nfd + enum: + - "53100" + - title: Jamaican + enum: + - "53113" + - title: Kenyan + enum: + - "53114" + - title: Nigerian + enum: + - "53115" + - title: African American + enum: + - "53116" + - title: Caribbean + enum: + - "53118" + - title: Somali + enum: + - "53119" + - title: Eritrean + enum: + - "53120" + - title: Ethiopian + enum: + - "53121" + - title: Ghanaian + enum: + - "53122" + - title: Burundian + enum: + - "53123" + - title: Congolese + enum: + - "53124" + - title: Sudanese + enum: + - "53125" + - title: Zambian + enum: + - "53126" + - title: Other Zimbabwean + enum: + - "53127" + - title: African nec + enum: + - "53199" + - title: Other Ethnicity + enum: + - "6" + - title: Other Ethnicity + enum: + - "61" + - title: Other Ethnicity + enum: + - "611" + - title: Indigenous American + enum: + - "61113" + - title: Mauritian + enum: + - "61115" + - title: Seychellois + enum: + - "61116" + - title: Other South African + enum: + - "61117" + - title: New Zealander + enum: + - "61118" + - title: Other Ethnicity nec + enum: + - "61199" + - title: Residual Categories + enum: + - "9" + - title: Don't Know + enum: + - "94" + - title: Don't Know + enum: + - "944" + - title: Don't Know + enum: + - "94444" + - title: Refused to Answer + enum: + - "95" + - title: Refused to Answer + enum: + - "955" + - title: Refused to Answer + enum: + - "95555" + - title: Repeated Value + enum: + - "96" + - title: Repeated Value + enum: + - "966" + - title: Repeated Value + enum: + - "96666" + - title: Response Unidentifiable + enum: + - "97" + - title: Response Unidentifiable + enum: + - "977" + - title: Response Unidentifiable + enum: + - "97777" + - title: Response Outside Scope + enum: + - "98" + - title: Response Outside Scope + enum: + - "988" + - title: Response Outside Scope + enum: + - "98888" + - title: Not Stated + enum: + - "99" + - title: Not Stated + enum: + - "999" + - title: Not Stated + enum: + - "99999" + IwiAffiliationList: + description:

A list of one or more iwi with which the + person has an affiliation.

+ type: object + properties: + IwiAffiliation: + type: array + items: + type: string + title: Iwi + description: >- +

An iwi, or Māori tribe, is one of the + largest kinship groupings and is generally + made up of several hapū that are all + descended from a common ancestor. Hapū are + clusters of whānau where the whānau is + usually an extended family grouping + consisting of children, parents, often + grandparents, and other closely related + kin.

Sourced from Statistics NZ - + Iwi and Iwi related groups statistical + standard v1.0.0.0

    +
  • 'NZS01' - Te Tai Tokerau/Tāmaki-makaurau (Northland/Auckland) Region Iwi
    • +
  • 'NZS0101' - Te Aupōuri
    • +
  • 'NZS0102' - Ngāti Kahu
    • +
  • 'NZS0103' - Ngāti Kurī
    • +
  • 'NZS0104' - Ngāpuhi
    • +
  • 'NZS0105' - Ngāpuhi ki Whaingaroa-Ngāti Kahu ki Whaingaroa
    • +
  • 'NZS0106' - Te Rarawa
    • +
  • 'NZS0107' - Ngāi Takoto
    • +
  • 'NZS0108' - Ngāti Wai
    • +
  • 'NZS0109' - Ngāti Whātua (not Ōrākei or Kaipara)
    • +
  • 'NZS0110' - Te Kawerau ā Maki
    • +
  • 'NZS0111' - Te Uri-o-Hau
    • +
plus 183 more value(s) at NZCodeSetsIwiType + oneOf: + - title: Te Tai Tokerau/Tāmaki-makaurau + (Northland/Auckland) Region Iwi + enum: + - NZS01 + - title: Te Aupōuri + enum: + - NZS0101 + - title: Ngāti Kahu + enum: + - NZS0102 + - title: Ngāti Kurī + enum: + - NZS0103 + - title: Ngāpuhi + enum: + - NZS0104 + - title: Ngāpuhi ki Whaingaroa-Ngāti Kahu ki + Whaingaroa + enum: + - NZS0105 + - title: Te Rarawa + enum: + - NZS0106 + - title: Ngāi Takoto + enum: + - NZS0107 + - title: Ngāti Wai + enum: + - NZS0108 + - title: Ngāti Whātua (not Ōrākei or Kaipara) + enum: + - NZS0109 + - title: Te Kawerau ā Maki + enum: + - NZS0110 + - title: Te Uri-o-Hau + enum: + - NZS0111 + - title: Te Roroa + enum: + - NZS0112 + - title: Ngāti Whātua o Kaipara + enum: + - NZS0113 + - title: Ngāti Whātua o Ōrākei + enum: + - NZS0114 + - title: Ngāi Tai ki Tāmaki + enum: + - NZS0115 + - title: Ngāti Hine (Te Tai Tokerau) + enum: + - NZS0116 + - title: Te Paatu + enum: + - NZS0117 + - title: Ngāti Manuhiri + enum: + - NZS0118 + - title: Ngāti Rēhua + enum: + - NZS0119 + - title: Hauraki (Coromandel) Region Iwi + enum: + - NZS02 + - title: Ngāti Hako + enum: + - NZS0201 + - title: Ngāti Hei + enum: + - NZS0202 + - title: Ngāti Maru (Hauraki) + enum: + - NZS0203 + - title: Ngāti Paoa + enum: + - NZS0204 + - title: Patukirikiri + enum: + - NZS0205 + - title: Ngāti Porou ki Harataunga ki Mataora + enum: + - NZS0206 + - title: Ngāti Pūkenga ki Waiau + enum: + - NZS0207 + - title: Ngāti Rāhiri Tumutumu + enum: + - NZS0208 + - title: Ngāti Tamaterā + enum: + - NZS0210 + - title: Ngāti Tara Tokanui + enum: + - NZS0211 + - title: Ngāti Whanaunga + enum: + - NZS0212 + - title: Waikato/Te Rohe Pōtae (Waikato/King + Country) Region Iwi + enum: + - NZS03 + - title: Ngāti Haua (Waikato) + enum: + - NZS0301 + - title: Ngāti Maniapoto + enum: + - NZS0302 + - title: Raukawa (Waikato) + enum: + - NZS0303 + - title: Waikato + enum: + - NZS0304 + - title: Ngāti Te Ata + enum: + - NZS0305 + - title: Ngāti Hīkairo + enum: + - NZS0306 + - title: Rereahu + enum: + - NZS0307 + - title: Ngāti Tiipa + enum: + - NZS0308 + - title: Ngāti Korokī Kahukura + enum: + - NZS0309 + - title: Ngāti Tamaoho + enum: + - NZS0310 + - title: Te Ākitai-Waiohua + enum: + - NZS0311 + - title: Te Arawa/Taupō (Rotorua/Taupō) Region + Iwi + enum: + - NZS04 + - title: Ngāti Pikiao (Te Arawa) + enum: + - NZS0401 + - title: Ngāti Rangiteaorere (Te Arawa) + enum: + - NZS0402 + - title: Ngāti Rangitihi (Te Arawa) + enum: + - NZS0403 + - title: Ngāti Rangiwewehi (Te Arawa) + enum: + - NZS0404 + - title: Tapuika (Te Arawa) + enum: + - NZS0405 + - title: Ngāti Tarāwhai (Te Arawa) + enum: + - NZS0406 + - title: Tūhourangi (Te Arawa) + enum: + - NZS0407 + - title: Uenuku-Kōpako (Te Arawa) + enum: + - NZS0408 + - title: Waitaha (Te Arawa) + enum: + - NZS0409 + - title: Ngāti Whakaue (Te Arawa) + enum: + - NZS0410 + - title: Ngāti Tūwharetoa (ki Taupō) + enum: + - NZS0411 + - title: Ngāti Tahu-Ngāti Whaoa (Te Arawa) + enum: + - NZS0412 + - title: Ngāti Mākino + enum: + - NZS0413 + - title: Ngāti Kearoa / Ngāti Tuarā + enum: + - NZS0414 + - title: Ngāti Rongomai (Te Arawa) + enum: + - NZS0415 + - title: Tauranga Moana/Mātaatua (Bay of + Plenty) Region Iwi + enum: + - NZS05 + - title: Ngāti Pūkenga + enum: + - NZS0501 + - title: Ngāi Te Rangi + enum: + - NZS0502 + - title: Ngāti Ranginui + enum: + - NZS0503 + - title: Ngāti Awa + enum: + - NZS0504 + - title: Ngāti Manawa + enum: + - NZS0505 + - title: Ngāi Tai (Tauranga Moana/Mātaatua) + enum: + - NZS0506 + - title: Tūhoe + enum: + - NZS0507 + - title: Whakatōhea + enum: + - NZS0508 + - title: Te Whānau-ā-Apanui + enum: + - NZS0509 + - title: Ngāti Whare + enum: + - NZS0510 + - title: Ngā Pōtiki ā Tamapahore + enum: + - NZS0511 + - title: Te Upokorehe + enum: + - NZS0512 + - title: Ngāti Tūwharetoa ki Kawerau + enum: + - NZS0513 + - title: Te Tai Rāwhiti (East Coast) Region Iwi + enum: + - NZS06 + - title: Ngāti Porou + enum: + - NZS0601 + - title: Te Aitanga-a-Māhaki + enum: + - NZS0602 + - title: Rongowhakaata + enum: + - NZS0603 + - title: Ngāi Tāmanuhiri + enum: + - NZS0604 + - title: Te Aitanga ā Hauiti + enum: + - NZS0605 + - title: Te Matau-a-Māui/Wairarapa (Hawke's + Bay/Wairarapa) Region Iwi + enum: + - NZS07 + - title: Rongomaiwahine (Te Māhia) + enum: + - NZS0701 + - title: Ngāti Kahungunu ki Te Wairoa + enum: + - NZS0702 + - title: Ngāti Kahungunu ki Heretaunga + enum: + - NZS0703 + - title: Ngāti Kahungunu ki Wairarapa + enum: + - NZS0704 + - title: Rangitāne (Te Matau-a-Māui/Hawke's + Bay/Wairarapa) + enum: + - NZS0706 + - title: Ngāti Kahungunu ki Te Whanganui-a-Orotu + enum: + - NZS0707 + - title: Ngāti Kahungunu ki Tamatea + enum: + - NZS0708 + - title: Ngāti Kahungunu ki Tamakinui a Rua + enum: + - NZS0709 + - title: Ngāti Pāhauwera + enum: + - NZS0710 + - title: Ngāti Rākaipaaka + enum: + - NZS0711 + - title: Ngāti Hineuru + enum: + - NZS0712 + - title: Maungaharuru Tangitū + enum: + - NZS0713 + - title: Rangitāne o Tamaki nui ā Rua + enum: + - NZS0714 + - title: Ngāti Ruapani ki Waikaremoana + enum: + - NZS0715 + - title: Te Hika o Pāpāuma + enum: + - NZS0716 + - title: Taranaki Region Iwi + enum: + - NZS08 + - title: Te Atiawa (Taranaki) + enum: + - NZS0801 + - title: Ngāti Maru (Taranaki) + enum: + - NZS0802 + - title: Ngāti Mutunga (Taranaki) + enum: + - NZS0803 + - title: Ngā Rauru + enum: + - NZS0804 + - title: Ngā Ruahine + enum: + - NZS0805 + - title: Ngāti Ruanui + enum: + - NZS0806 + - title: Ngāti Tama (Taranaki) + enum: + - NZS0807 + - title: Taranaki + enum: + - NZS0808 + - title: Tangāhoe + enum: + - NZS0809 + - title: Pakakohi + enum: + - NZS0810 + - title: Whanganui/Rangitīkei + (Wanganui/Rangitīkei) Region Iwi + enum: + - NZS09 + - title: Ngāti Apa (Rangitīkei) + enum: + - NZS0901 + - title: Te Ati Haunui-a-Pāpārangi + enum: + - NZS0902 + - title: Ngāti Haua (Taumarunui) + enum: + - NZS0903 + - title: Ngāti Hauiti (Rangitīkei) + enum: + - NZS0904 + - title: Ngāti Whitikaupeka (Rangitīkei) + enum: + - NZS0905 + - title: Ngāi Te Ohuake (Rangitīkei) + enum: + - NZS0906 + - title: Ngāti Tamakōpiri (Rangitīkei) + enum: + - NZS0907 + - title: Ngāti Rangi (Ruapehu, Whanganui) + enum: + - NZS0908 + - title: Uenuku (Ruapehu, Waimarino) + enum: + - NZS0909 + - title: Tamahaki (Ruapehu, Waimarino) + enum: + - NZS0910 + - title: Tamakana (Ruapehu, Waimarino) + enum: + - NZS0911 + - title: Manawatū/Horowhenua/Te + Whanganui-a-Tara + (Manawatū/Horowhenua/Wellington) + Region Iwi + enum: + - NZS10 + - title: Te Atiawa (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1001 + - title: Muaūpoko + enum: + - NZS1002 + - title: Rangitāne (Manawatū) + enum: + - NZS1003 + - title: Ngāti Raukawa (Horowhenua/Manawatū) + enum: + - NZS1004 + - title: Ngāti Toarangatira (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1005 + - title: Te Atiawa ki Whakarongotai + enum: + - NZS1006 + - title: Ngāti Tama ki Te Upoko o Te Ika (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1007 + - title: Ngāti Kauwhata + enum: + - NZS1008 + - title: Ngāti Tukorehe + enum: + - NZS1009 + - title: Te Waipounamu/Wharekauri (South + Island/Chatham Islands) Region Iwi + enum: + - NZS11 + - title: Te Atiawa (Te Waipounamu/South Island) + enum: + - NZS1101 + - title: Ngāti Koata + enum: + - NZS1102 + - title: Ngāti Kuia + enum: + - NZS1103 + - title: Kāti Māmoe + enum: + - NZS1104 + - title: Moriori + enum: + - NZS1105 + - title: Ngāti Mutunga (Wharekauri/Chatham + Islands) + enum: + - NZS1106 + - title: Rangitāne (Te Waipounamu/South Island) + enum: + - NZS1107 + - title: Ngāti Rārua + enum: + - NZS1108 + - title: Ngāi Tahu / Kāi Tahu + enum: + - NZS1109 + - title: Ngāti Tama (Te Waipounamu/South Island) + enum: + - NZS1110 + - title: Ngāti Toarangatira (Te + Waipounamu/South Island) + enum: + - NZS1111 + - title: Waitaha (Te Waipounamu/South Island) + enum: + - NZS1112 + - title: Ngāti Apa ki Te Rā Tō + enum: + - NZS1113 + - title: Confederations and Waka, iwi not named + enum: + - NZS20 + - title: Tainui, iwi not named + enum: + - NZS2001 + - title: Te Arawa, iwi not named + enum: + - NZS2002 + - title: Tākitimu, iwi not named + enum: + - NZS2003 + - title: Aotea, iwi not named + enum: + - NZS2004 + - title: Mātaatua, iwi not named + enum: + - NZS2005 + - title: Mahuru, iwi not named + enum: + - NZS2006 + - title: Māmari, iwi not named + enum: + - NZS2007 + - title: Ngātokimatawhaorua, iwi not named + enum: + - NZS2008 + - title: Nukutere, iwi not named + enum: + - NZS2009 + - title: Tokomaru, iwi not named + enum: + - NZS2010 + - title: Kurahaupō, iwi not named + enum: + - NZS2011 + - title: Muriwhenua, iwi not named + enum: + - NZS2012 + - title: Hauraki / Pare Hauraki, iwi not named + enum: + - NZS2013 + - title: Tūranganui a Kiwa, iwi not named + enum: + - NZS2014 + - title: Te Tauihu o Te Waka a Māui, iwi not + named + enum: + - NZS2015 + - title: Tauranga Moana, iwi not named + enum: + - NZS2016 + - title: Horouta, iwi not named + enum: + - NZS2017 + - title: Mōkai Pātea, iwi not named + enum: + - NZS2018 + - title: Iwi named, region not known + enum: + - NZS21 + - title: Te Atiawa, region not known + enum: + - NZS2101 + - title: Ngāti Haua, region not known + enum: + - NZS2102 + - title: Ngāti Maru, region not known + enum: + - NZS2103 + - title: Ngāti Mutunga, region not known + enum: + - NZS2104 + - title: Rangitāne, region not known + enum: + - NZS2105 + - title: Ngāti Raukawa, region not known + enum: + - NZS2106 + - title: Ngāti Tama, region not known + enum: + - NZS2107 + - title: Ngāti Toa, region not known + enum: + - NZS2108 + - title: Waitaha, region not known + enum: + - NZS2109 + - title: Ngāti Apa, region not known + enum: + - NZS2110 + - title: Ngāi Tai, region not known + enum: + - NZS2111 + - title: Ngāti Kahungunu, region not known + enum: + - NZS2112 + - title: Ngāti Tūwharetoa, region not known + enum: + - NZS2113 + - title: Hapū affiliated to more than one iwi + enum: + - NZS22 + - title: Hapū affiliated to more than one iwi + enum: + - NZS2201 + - title: Region known, Iwi not named + enum: + - NZS23 + - title: Te Tai Tokerau/Tāmaki-makaurau Region, + Iwi not named + enum: + - NZS2301 + - title: Hauraki Region, Iwi not named + enum: + - NZS2302 + - title: Waikato/Te Rohe Pōtae Region, Iwi not + named + enum: + - NZS2303 + - title: Te Arawa/Taupō Region, Iwi not named + enum: + - NZS2304 + - title: Tauranga Moana/Mātaatua Region, Iwi + not named + enum: + - NZS2305 + - title: Te Tai Rāwhiti Region, Iwi not named + enum: + - NZS2306 + - title: Te Matau-a-Māui/Wairarapa Region, Iwi + not named + enum: + - NZS2307 + - title: Taranaki Region, Iwi not named + enum: + - NZS2308 + - title: Whanganui/Rangitīkei Region, Iwi not + named + enum: + - NZS2309 + - title: Manawatū/Horowhenua/Te + Whanganui-a-Tara Region, Iwi not named + enum: + - NZS2310 + - title: Te Waipounamu/Wharekauri Region, Iwi + not named + enum: + - NZS2311 + - title: Don't Know + enum: + - NZS44 + - title: Refused To Answer + enum: + - NZS55 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + ReligiousAffiliationList: + description:

A list of one or more religions with which + the person has an affiliation.

+ type: object + properties: + ReligiousAffiliation: + type: array + items: + type: string + title: Religion + description: >- +

Religious affiliation is the + self-identified association of a person + with a religion, denomination or + sub-denominational religious group.

+

Sourced from Statistics NZ - Religious + Affiliation 1999 v1.0.0.0

    +
  • 'NZS0' - No Religion
    • +
  • 'NZS1' - Buddhist
    • +
  • 'NZS101' - Buddhist
    • +
  • 'NZS10101' - Zen Buddhist
    • +
  • 'NZS10199' - Buddhist nec
    • +
  • 'NZS2' - Christian
    • +
  • 'NZS201' - Adventist
    • +
  • 'NZS20101' - Christadelphian
    • +
  • 'NZS20102' - Seventh Day Adventist
    • +
  • 'NZS20103' - Worldwide Church of God
    • +
  • 'NZS20199' - Adventist nec
    • +
  • 'NZS202' - Anglican
    • +
plus 117 more value(s) at NZCodeSetsReligionType + oneOf: + - title: No Religion + enum: + - NZS0 + - title: Buddhist + enum: + - NZS1 + - title: Buddhist + enum: + - NZS101 + - title: Zen Buddhist + enum: + - NZS10101 + - title: Buddhist nec + enum: + - NZS10199 + - title: Christian + enum: + - NZS2 + - title: Adventist + enum: + - NZS201 + - title: Christadelphian + enum: + - NZS20101 + - title: Seventh Day Adventist + enum: + - NZS20102 + - title: Worldwide Church of God + enum: + - NZS20103 + - title: Adventist nec + enum: + - NZS20199 + - title: Anglican + enum: + - NZS202 + - title: Asian Christian + enum: + - NZS203 + - title: Chinese Christian + enum: + - NZS20301 + - title: Korean Christian + enum: + - NZS20302 + - title: Baptist + enum: + - NZS204 + - title: Bible Baptist + enum: + - NZS20401 + - title: Independent Baptist + enum: + - NZS20402 + - title: Reformed Baptist + enum: + - NZS20403 + - title: Baptist nec + enum: + - NZS20499 + - title: Brethren + enum: + - NZS205 + - title: Exclusive Brethren + enum: + - NZS20501 + - title: Open Brethren + enum: + - NZS20502 + - title: Plymouth Brethren + enum: + - NZS20503 + - title: Brethren nec + enum: + - NZS20599 + - title: Catholic + enum: + - NZS206 + - title: Roman Catholic + enum: + - NZS20601 + - title: Catholic nec + enum: + - NZS20699 + - title: Church of Christ and Associated + Churches of Christ + enum: + - NZS207 + - title: Associated Churches of Christ + enum: + - NZS20701 + - title: Other Church of Christ and Churches of + Christ nec + enum: + - NZS20799 + - title: Evangelical, Born Again and + Fundamentalist + enum: + - NZS208 + - title: Evangelical + enum: + - NZS20801 + - title: Born Again + enum: + - NZS20802 + - title: Fundamentalist + enum: + - NZS20803 + - title: Independent Evangelical Churches + enum: + - NZS20804 + - title: Jehovah's Witnesses + enum: + - NZS209 + - title: Jehovah's Witnesses + enum: + - NZS20901 + - title: Latter-day Saints + enum: + - NZS210 + - title: Lutheran + enum: + - NZS211 + - title: Methodist + enum: + - NZS212 + - title: Tongan Methodist + enum: + - NZS21201 + - title: Methodist nec + enum: + - NZS21299 + - title: Orthodox + enum: + - NZS213 + - title: Assyrian Orthodox + enum: + - NZS21301 + - title: Coptic Orthodox + enum: + - NZS21302 + - title: Greek Orthodox + enum: + - NZS21303 + - title: Russian Orthodox + enum: + - NZS21304 + - title: Serbian Orthodox + enum: + - NZS21305 + - title: Orthodox nec + enum: + - NZS21399 + - title: Pentecostal + enum: + - NZS214 + - title: Apostolic Church of New Zealand + enum: + - NZS21401 + - title: Assemblies of God + enum: + - NZS21402 + - title: Christian Fellowship + enum: + - NZS21403 + - title: Christian Outreach + enum: + - NZS21404 + - title: Christian Revival Crusade + enum: + - NZS21405 + - title: Elim + enum: + - NZS21406 + - title: Full Gospel + enum: + - NZS21407 + - title: Independent Pentecostal + enum: + - NZS21408 + - title: New Life Centres + enum: + - NZS21409 + - title: Revival Centres + enum: + - NZS21410 + - title: United Pentecostal + enum: + - NZS21411 + - title: Vineyard Christian Fellowship + enum: + - NZS21412 + - title: Pentecostal nec + enum: + - NZS21499 + - title: Presbyterian, Congregational and + Reformed + enum: + - NZS215 + - title: Presbyterian + enum: + - NZS21501 + - title: Congregational + enum: + - NZS21502 + - title: Cook Island Congregational + enum: + - NZS21503 + - title: Samoan Congregational + enum: + - NZS21504 + - title: Reformed + enum: + - NZS21505 + - title: Protestant + enum: + - NZS216 + - title: Salvation Army + enum: + - NZS217 + - title: Uniting/Union Church and Ecumenical + enum: + - NZS218 + - title: Uniting/Union Church + enum: + - NZS21801 + - title: Ecumenical + enum: + - NZS21802 + - title: Other Christian + enum: + - NZS299 + - title: Christian and Missionary Alliance + enum: + - NZS29901 + - title: Christian Science + enum: + - NZS29902 + - title: Church of God + enum: + - NZS29903 + - title: Commonwealth Covenant Church + enum: + - NZS29904 + - title: Liberal Catholic + enum: + - NZS29905 + - title: Metropolitan + enum: + - NZS29906 + - title: Nazarene + enum: + - NZS29907 + - title: Religious Society of Friends (Quaker) + enum: + - NZS29908 + - title: Unitarian + enum: + - NZS29909 + - title: Hindu + enum: + - NZS3 + - title: Hare Krishna + enum: + - NZS30101 + - title: Yoga + enum: + - NZS30102 + - title: Islam/Muslim + enum: + - NZS4 + - title: Sufi + enum: + - NZS40101 + - title: Judaism/Jewish + enum: + - NZS5 + - title: Māori Christian + enum: + - NZS6 + - title: Ratana + enum: + - NZS601 + - title: Ringatū + enum: + - NZS602 + - title: Other Māori Christian + enum: + - NZS609 + - title: Spiritualism and New Age Religions + enum: + - NZS7 + - title: Church of Scientology + enum: + - NZS701 + - title: Nature and Earth Based Religions + enum: + - NZS702 + - title: Animist + enum: + - NZS70201 + - title: Druid + enum: + - NZS70202 + - title: Pantheist + enum: + - NZS70203 + - title: Wiccan + enum: + - NZS70204 + - title: Satanism + enum: + - NZS703 + - title: Spiritualist + enum: + - NZS704 + - title: Other New Age Religions + enum: + - NZS709 + - title: Rastafarianism + enum: + - NZS70901 + - title: Other Religions + enum: + - NZS8 + - title: Baha'i + enum: + - NZS801 + - title: Chinese Religions + enum: + - NZS802 + - title: Confucianism + enum: + - NZS80201 + - title: Taoism + enum: + - NZS80202 + - title: Jainism + enum: + - NZS803 + - title: Japanese Religion + enum: + - NZS804 + - title: Mahikari + enum: + - NZS80401 + - title: Shinto + enum: + - NZS80402 + - title: Tenrikyo + enum: + - NZS80403 + - title: Māori Religion + enum: + - NZS805 + - title: Hauhau + enum: + - NZS80501 + - title: Sikh + enum: + - NZS806 + - title: Theism + enum: + - NZS807 + - title: Zoroastrian + enum: + - NZS808 + - title: Other Religions + enum: + - NZS809 + - title: Unification Church (Moonist) + enum: + - NZS80901 + - title: Other Religions nec + enum: + - NZS80999 + - title: Don't Know + enum: + - NZS944 + - title: Object to answering + enum: + - NZS955 + - title: Religion Unidentifiable + enum: + - NZS977 + - title: Response Outside Scope + enum: + - NZS988 + - title: Not Stated + enum: + - NZS999 + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + AddressList: + description: The person's address(es) - one or more addresses + type: object + properties: + Address: + type: array + items: + description:

This element contains address data.

+ type: object + properties: + Type: + type: string + title: Address Type + description: >- +

Address type allows an address to be + categorised according to its component + structure. Address type can be used to + build processing rules for validating, + managing and presenting addresses. Address + type is independent of the use of the + address by any party. To describe how a + party may use an address (residence, + billing, term address etc) see + AddressRoleType

    +
  • 'TH' - Thoroughfare
    • +
  • 'RU' - Rural Post Delivery
    • +
  • 'DE' - Delivery Service
    • +
  • 'WA' - Water
    • +
  • 'FO' - Foreign Address
    • +
+ oneOf: + - title: Thoroughfare + description: "\"

Also called 'Street' addresses, + The most general, and widely used type + of address, and can contain the widest + variety of components

In + general a thoroughfare address will + include components for a number, a + roadname, and a locality.

They + cannot contain any of the components + specific to a delivery service, rural + post delivery, or water address.

+

These addresses are used to find a + location.

Example: 30 - 40 + Lambton Quay, Wellington, 6165

\"" + enum: + - TH + - title: Rural Post Delivery + description: '"

Defined by New Zealand Post, + these addresses are assigned by NZ + Post for customers who purchase a + rural delivery service (mail and also + other goods).

They will have + the same number and roadname + components as the street address, and + may have the same region + component.

They do not have a + component that identifies the locality + the address is within. The locality + and city or town components are + replaced by components that identify + the rural delivery route (RD number), + and the town from which the rural + delivery route starts and finishes + (the mail town). Only addresses of + this class can contain these + components.

Example: + 121 Waitaha Road, RD 1, Ross, + 7885

"' + enum: + - RU + - title: Delivery Service + description: '"

Defined by New Zealand Post, and + used exclusively for NZ Post services + other than standard mail delivery. + Addresses in this class include PO + Box, Private Bag, and Counter Delivery + addresses.

Example: + Private Bag 2345, Auckland, 1142

"' + enum: + - DE + - title: Water + description: '"

Where properties have no road + access, but do have access to water + frontage (coastline or riverbank or + lakefront), a water address uses the + name of a water feature (for example, + islands, rivers, bays, or + peninsulas).

Example: + 235 Lochmara Bay, Queen Charlotte + Sound, Marlborough Sounds

"' + enum: + - WA + - title: Foreign Address + description: '"

A foreign address identifies a + location outside of New Zealand.

+

Example: + Rudolf-Diesel-Strasse 14, 54595 Prüm, + Germany

"' + enum: + - FO + Role: + type: string + title: Address Role + description: >- +

A standardised description of the role + or usage of an address by a party (person + or organisation). Where a party has more + than one address, this provides context + for deciding which address to use.

+
    +
  • 'PHY' - Physical Address
    • +
  • 'POS' - Postal Address
    • +
+ oneOf: + - title: Physical Address + description: Applies to addresses associated with + persons + enum: + - PHY + - title: Postal Address + description: Applies to addresses associated with + persons or organisations + enum: + - POS + Street: + description:

The street element is a complex element + and breaks the street down into several + parts. (Allow for PO Box here)

+ type: object + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban addresses, or + the 'RD No' part of rural addresses

+ City: + type: string + description:

The city part of the address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only applicable if a + non-New Zealand Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are derived + from New Zealand Map Grid x,y coordinates + and converted to Latitude and Longitude + values per the World Geodetic System 1984 + (G1762)

+ type: object + properties: + Latitude: + description:

Latitude in decimal degrees.

+

Latitudes north of the equator are + positive, latitudes south of the + equator are negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal degrees.

+

Longitudes east of the Prime + Meridian in Greenwich are positive, + longitudes west of the Prime Meridian + are negative. The 180th meridian is + negative. [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas containing + the location.

The list may contain + exactly one StatisticalArea element for + each of the following spatial unit + types:

  • Ward
  • Urban + Area
  • Census Area Unit
    • +
  • Māori Electorate
  • Mesh + Block
  • General Electorate
    • +
  • Territorial Authority
  • Local + Board (Auckland Only)
  • Regional + Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area + defined by Statistics New + Zealand.

+ type: object + properties: + SpatialUnitType: + type: string + title: Spatial Unit Type + description: >- +

A classification of + geographical boundaries or + statistical areas as defined by + Statistics NZ’s geographic + hierarchy.

    +
  • 'AE' - Area Unit
    • +
  • 'GE' - General Electoral District
    • +
  • 'CB' - Community Board
    • +
  • 'ME' - Māori Electoral District
    • +
  • 'MB' - Mesh Block
    • +
  • 'RC' - Regional Council
    • +
  • 'TA' - Territorial Authority
    • +
  • 'UA' - Urban Area
    • +
  • 'WA' - Ward
    • +
+ oneOf: + - title: Area Unit + description:

Area units are + aggregations of meshblocks. + They are non–administrative + areas that are in between + meshblocks and territorial + authorities in size. Area + units must either define or + aggregate to define, + regional councils, + territorial authorities and + urban areas.

Statistics + NZ Classification of Area + Unit 2013 v1.0.0 + enum: + - AE + - title: General Electoral District + description:

The general electoral + districts as constituted + under the Electoral Act + 1993.

Statistics NZ + General Electoral District + 2014 v1.0.0 + enum: + - GE + - title: Community Board + description:

(aka Local Board within + Auckland) Local boards + provide governance at the + local level within Auckland + Council. They enable + democratic decision making + by, and on behalf of + communities within the local + board area.

Statistics + NZ Community Board 2013 + v1.0.0 + enum: + - CB + - title: Māori Electoral District + description:

Māori electoral districts + are the voting districts for + parliamentary elections for + people who choose to be on + the Māori Electoral + Roll.

Statistics NZ + Māori Electoral District + 2014 v1.0.0 + enum: + - ME + - title: Mesh Block + description:

A meshblock is the + smallest geographic unit for + which statistical data is + collected and processed by + Statistics New Zealand.

+

A meshblock is defined by + a geographic area, which can + vary in size from part of a + city block to a large area + of rural land. Each + meshblock borders on another + to form a network covering + all of New Zealand, + including coasts and inlets + and extending out to the + 200-mile economic zone.

+ Statistics NZ Statistical + Standard for Meshblock 2013 + v1.0.0 + enum: + - MB + - title: Regional Council + description:

The top tier of local + government in New Zealand, + defined by the Local + Government Act 2002, which + requires the boundaries of + regions to conform as far as + possible to one or more + water catchments. When + determining regional + boundaries, the Local + Government Commission gave + consideration to regional + communities of interest when + selecting water catchments + to be included in a region. + It also considered factors + such as natural resource + management, land use + planning and environmental + matters.

Statistics NZ + Regional Council 2013 v1.0.0 + enum: + - RC + - title: Territorial Authority + description:

The second tier of local + government in New Zealand, + defined under the Local + Government Act 2002 as a + city council or district + council. There are 67 + territorial authorities + consisting of 12 city + councils, 53 districts, + Auckland Council, and + Chatham Islands Council.

+ Statistics NZ Territorial + Authority 2013 v1.0.0 + enum: + - TA + - title: Urban Area + description: '"

Urban Areas are + statistically defined areas + with no administrative or + legal basis. There is a + three part hierarchical + sub-division of urban areas + into: main urban areas, + secondary urban areas, minor + urban areas. Together the + populations in main, + secondary and minor urban + areas comprise the + statistically defined urban + population of New Zealand. + The urban area + classification is designed + to identify concentrated + urban or semi-urban + settlements without the + distortions of + administrative + boundaries.

Statistics + NZ Urban Area 2013 v2.0.0"' + enum: + - UA + - title: Ward + description:

Wards are defined under + the Local Electoral Act 2001 + and result from the + division, for electoral + purposes, of the district of + a territorial authority. The + ward system was designed to + allow for the recognition of + communities within a + district and to increase + community involvement in the + local government system.

+ Statistics NZ Ward 2013 + v1.0.0 + enum: + - WA + Code: + type: string + description:

A valid value defined by the + nominated spatial unit type, + defined by Statistics New + Zealand in one of the following + statistical area defintion + standards:

Area + Unit
Statistics NZ + Classification of Area Unit 2017 + v1.0.0
General + Electoral District
+
Statistics NZ General + Electoral District 2014 + v1.0.0
Community + Board
Statistics NZ + Community Board (codes 07601 - + 07621) 2018 v1.0.0
+
Māori Electoral + District
Statistics NZ + Māori Electoral District 2014 + v1.0.0
Mesh Block
+
Statistics NZ Statistical + Standard for Meshblock 2018 + v1.0.0
Regional + Council
Statistics NZ + Regional Council 2018 + v1.0.0
Territorial + Authority
Statistics NZ + Territorial Authority 2018 + v1.0.0
Urban Area
+
Statistics NZ Urban Area + 2018 v1.0.0
Ward
+
Statistics NZ Ward 2018 + v1.0.0
+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + EmailList: + description:

The person's e-mail address(es) - one or more + emails.

+ type: object + properties: + Email: + type: array + items: + description:

This element represents an e-mail address + of one of a number of types and occurs in + objects such as StudentPersonal, + StaffPersonal, StudentContactPersonal, etc. +

+ type: object + properties: + Type: + type: string + title: Email Type + description: >- +

A standardised method of describing an + electronic mail address used as contact + method by a party. Where a party has more + than one email address, this may provide + context for deciding which email address + to use.

    +
  • 'PRIM' - Primary
    • +
  • 'WORK' - Work
    • +
  • 'PERS' - Personal
    • +
  • 'ALT1' - Alternate 1
    • +
  • 'ALT2' - Alternate 2
    • +
  • 'ALT3' - Alternate 3
    • +
  • 'ALT4' - Alternate 4
    • +
+ oneOf: + - title: Primary + description: Applicable to organisations, eg schools + enum: + - PRIM + - title: Work + description: Only used for persons + enum: + - WORK + - title: Personal + description: Only used for persons + enum: + - PERS + - title: Alternate 1 + enum: + - ALT1 + - title: Alternate 2 + enum: + - ALT2 + - title: Alternate 3 + enum: + - ALT3 + - title: Alternate 4 + enum: + - ALT4 + Address: + type: string + description:

The actual email address.

+ PhoneNumberList: + description:

The person's phone number(s) - one or more phone + numbers.

+ type: object + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone number and + occurs within objects such as StudentPersonal, + StaffPersonal, etc.

+ type: object + properties: + Type: + type: string + title: Telephone Number Type + description: >- +

A standardised method of describing a + telecommunications device used as contact + method by a party. Where a party has more + than one phone number, this may provide + context for deciding which number to + use.

    +
  • 'MAI' - Main Telephone Number
    • +
  • 'FAX' - Facsimile Number
    • +
  • 'HTE' - Home Telephone Number
    • +
  • 'HMO' - Home Mobile
    • +
  • 'MOB' - Mobile
    • +
  • 'WMO' - Work Mobile
    • +
  • 'WTE' - Work Telephone Number
    • +
+ oneOf: + - title: Main Telephone Number + enum: + - MAI + - title: Facsimile Number + enum: + - FAX + - title: Home Telephone Number + description: Person usage only + enum: + - HTE + - title: Home Mobile + description: Person usage only + enum: + - HMO + - title: Mobile + enum: + - MOB + - title: Work Mobile + enum: + - WMO + - title: Work Telephone Number + enum: + - WTE + Number: + type: string + description: "

Phone number. Free-form, but typical + New Zealand formats include:

    +
  • (0##) ###-####
  • ###-####
    • +
  • +##### ### ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPerson\ + alRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StaffPerson\ + al/properties/PersonInfo/properties/Name/\ + properties/FamilyNameFirst" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + HouseholdContactInfoList: + description:

The person's household/s contact information. A + list of one or more household’s contact + information.

+ type: object + properties: + HouseholdContactInfo: + type: array + items: + description:

Common element used to supply information + about a particular household a person is a + member of.

+ type: object + properties: + PreferenceNumber: + type: integer + description:

Priority of Household Contact in + relation to this Person.

+ HouseholdContactId: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPerson\ + alRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StaffPerson\ + al/properties/StaffPersonalLocalId" + HouseholdSalutation: + type: string + description:

Salutation to be used in addressing + this household.

+ AddressList: + description:

A list of Address elements.

+ type: object + properties: + Address: + type: array + items: + description:

This element contains address + data.

+ type: object + properties: + Type: + $ref: "#/paths/~1StaffPersonals~1%7BS\ + taffPersonalRefId%7D/put/reques\ + tBody/content/application~1json\ + /schema/properties/StaffPersona\ + l/properties/PersonInfo/propert\ + ies/AddressList/properties/Addr\ + ess/items/properties/Type" + Role: + $ref: "#/paths/~1StaffPersonals~1%7BS\ + taffPersonalRefId%7D/put/reques\ + tBody/content/application~1json\ + /schema/properties/StaffPersona\ + l/properties/PersonInfo/propert\ + ies/AddressList/properties/Addr\ + ess/items/properties/Role" + Street: + description:

The street element is a + complex element and breaks the + street down into several parts. + (Allow for PO Box here)

+ type: object + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' part + of rural addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only + applicable if a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of + the location. Grid location + values are derived from New + Zealand Map Grid x,y coordinates + and converted to Latitude and + Longitude values per the World + Geodetic System 1984 (G1762) +

+ type: object + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes + north of the equator are + positive, latitudes south of + the equator are negative + [ISO 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes + east of the Prime Meridian + in Greenwich are positive, + longitudes west of the Prime + Meridian are negative. The + 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

+

The list may contain exactly + one StatisticalArea element for + each of the following spatial + unit types:

    +
  • Ward
  • Urban + Area
  • Census Area + Unit
  • Māori + Electorate
  • Mesh + Block
  • General + Electorate
  • Territorial + Authority
  • Local Board + (Auckland Only)
    • +
  • Regional Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular + statistical area defined + by Statistics New + Zealand.

+ type: object + properties: + SpatialUnitType: + $ref: "#/paths/~1StaffPerso\ + nals~1%7BStaffPersona\ + lRefId%7D/put/request\ + Body/content/applicat\ + ion~1json/schema/prop\ + erties/StaffPersonal/\ + properties/PersonInfo\ + /properties/AddressLi\ + st/properties/Address\ + /items/properties/Sta\ + tisticalAreaList/prop\ + erties/StatisticalAre\ + a/items/properties/Sp\ + atialUnitType" + Code: + type: string + description:

A valid value + defined by the + nominated spatial unit + type, defined by + Statistics New Zealand + in one of the + following statistical + area defintion + standards:

+
Area Unit
+
Statistics NZ + Classification of Area + Unit 2017 v1.0.0
+
General Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community + Board
+
Statistics NZ + Community Board (codes + 07601 - 07621) 2018 + v1.0.0
Māori + Electoral + District
+
Statistics NZ + Māori Electoral + District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard + for Meshblock 2018 + v1.0.0
+
Regional + Council
+
Statistics NZ + Regional Council 2018 + v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority + 2018 v1.0.0
+
Urban Area
+
Statistics NZ + Urban Area 2018 + v1.0.0
+
Ward
+
Statistics NZ Ward + 2018 v1.0.0
+ EmailList: + description:

List of Email elements.

+ type: object + properties: + Email: + type: array + items: + description:

This element represents an + e-mail address of one of a number of + types and occurs in objects such as + StudentPersonal, StaffPersonal, + StudentContactPersonal, etc.

+ type: object + properties: + Type: + $ref: "#/paths/~1StaffPersonals~1%7BS\ + taffPersonalRefId%7D/put/reques\ + tBody/content/application~1json\ + /schema/properties/StaffPersona\ + l/properties/PersonInfo/propert\ + ies/EmailList/properties/Email/\ + items/properties/Type" + Address: + type: string + description:

The actual email address.

+ PhoneNumberList: + description:

List of PhoneNumber elements.

+ type: object + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone + number and occurs within objects + such as StudentPersonal, + StaffPersonal, etc.

+ type: object + properties: + Type: + $ref: "#/paths/~1StaffPersonals~1%7BS\ + taffPersonalRefId%7D/put/reques\ + tBody/content/application~1json\ + /schema/properties/StaffPersona\ + l/properties/PersonInfo/propert\ + ies/PhoneNumberList/properties/\ + PhoneNumber/items/properties/Ty\ + pe" + Number: + type: string + description: "

Phone number. Free-form, but + typical New Zealand formats + include:

  • (0##) + ###-####
  • ###-####
    • +
  • +##### ### ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1StaffPersonals~1%7BS\ + taffPersonalRefId%7D/put/reques\ + tBody/content/application~1json\ + /schema/properties/StaffPersona\ + l/properties/PersonInfo/propert\ + ies/Name/properties/FamilyNameF\ + irst" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StaffPersonal: + StaffPersonalRefId: D3E34F41-9D75-101A-8C3D-00AA001A1652 + PersonInfo: + Name: + FamilyName: Smith + GivenName: Fred + FullName: Fred Smith + Type: LGL + IsVerified: Y + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + Suburb: RD 1 + City: Hogsmeade + PostalCode: 5780 + EmailList: + Email: + - Type: ALT1 + Address: fsmith@yahoo.com + - Type: PRIM + Address: freddy@gmail.com + PhoneNumberList: + PhoneNumber: + - Type: WTE + Number: 03 9637-2289 + Extension: 72289 + - Type: HTE + Number: 0437-765-234 + application/xml: + schema: + type: object + properties: + StaffPersonal: + $ref: "#/paths/~1StaffPersonals~1%7BStaffPersonalRefId%7D/put/req\ + uestBody/content/application~1json/schema/properties/StaffP\ + ersonal" + example: >- + + D3E34F41-9D75-101A-8C3D-00AA001A1652 + + + Smith + Fred + Fred Smith + LGL + Y + + +
+ TH + PHY + + The Enchanted Wood + 533 Hogwart's Way + + RD 1 + Hogsmeade + 5780 +
+ + + + ALT1 + fsmith@yahoo.com + + + PRIM + freddy@gmail.com + + + + + WTE + 03 9637-2289 + 72289 + + + HTE + 0437-765-234 + + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StaffPersonal + summary: Default operation to get a single StaffPersonal + parameters: + - name: StaffPersonalRefId + in: path + description:

The GUID of the staff member.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StaffPersonal: + $ref: "#/paths/~1StaffPersonals/get/responses/200/content/appli\ + cation~1json/schema/properties/StaffPersonals/properties/\ + StaffPersonal/items" + example: + StaffPersonal: + StaffPersonalRefId: D3E34F41-9D75-101A-8C3D-00AA001A1652 + PersonInfo: + Name: + FamilyName: Smith + GivenName: Fred + FullName: Fred Smith + Type: LGL + IsVerified: Y + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + Suburb: RD 1 + City: Hogsmeade + PostalCode: 5780 + EmailList: + Email: + - Type: ALT1 + Address: fsmith@yahoo.com + - Type: PRIM + Address: freddy@gmail.com + PhoneNumberList: + PhoneNumber: + - Type: WTE + Number: 03 9637-2289 + Extension: 72289 + - Type: HTE + Number: 0437-765-234 + application/xml: + schema: + type: object + properties: + StaffPersonal: + $ref: "#/paths/~1StaffPersonals/get/responses/200/content/appli\ + cation~1json/schema/properties/StaffPersonals/properties/\ + StaffPersonal/items" + example: >- + + D3E34F41-9D75-101A-8C3D-00AA001A1652 + + + Smith + Fred + Fred Smith + LGL + Y + + +
+ TH + PHY + + The Enchanted Wood + 533 Hogwart's Way + + RD 1 + Hogsmeade + 5780 +
+ + + + ALT1 + fsmith@yahoo.com + + + PRIM + freddy@gmail.com + + + + + WTE + 03 9637-2289 + 72289 + + + HTE + 0437-765-234 + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StaffPersonal + summary: Default operation to delete a single StaffPersonal + parameters: + - name: StaffPersonalRefId + in: path + description:

The GUID of the staff member.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StaffAssignments: + get: + tags: + - StaffAssignment + summary: Default operation to get a list of all available StaffAssignments + description: Search the set of available StaffAssignments, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StaffAssignments: + type: object + description: A List of StaffAssignment objects + properties: + StaffAssignment: + type: array + items: + required: + - AssignedLocation + - CasualReliefTeacher + - EmploymentStatus + - StaffMember + - StartDate + type: object + properties: + StaffAssignmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StaffAssignmentLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + StaffMember: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StaffAssignments/get/responses/2\ + 00/content/application~1json/schema/propert\ + ies/StaffAssignments/properties/StaffAssign\ + ment/items/properties/StaffAssignmentRefId" + LocalId: + $ref: "#/paths/~1StaffAssignments/get/responses/2\ + 00/content/application~1json/schema/propert\ + ies/StaffAssignments/properties/StaffAssign\ + ment/items/properties/StaffAssignmentLocalI\ + d" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + AssignedLocation: + $ref: "#/paths/~1StaffAssignments/get/responses/200/c\ + ontent/application~1json/schema/properties/Staf\ + fAssignments/properties/StaffAssignment/items/p\ + roperties/StaffMember" + Description: + type: string + description:

Short description of the staff member's + assignment to the provider.

+ StaffRoleList: + description:

The list of roles the StaffMember has in + relation to all students at the assigned + location.

+ type: object + required: + - StaffRole + properties: + StaffRole: + type: array + items: + description:

A list of roles that are assigned to + the staff member.

+ type: object + required: + - Role + - StartDate + properties: + Role: + type: string + title: Staff Role + description: >- +

Describes the role a staff member + has at a Provider or other + EducationOrganisation.

    +
  • '1001' - Principal
    • +
  • '1002' - Deputy Principal
    • +
  • '1003' - Associate Principal
    • +
  • '1004' - Assistant Principal
    • +
  • '1005' - Principal's Nominee (NZQA)
    • +
  • '1006' - Enrolment Officer
    • +
  • '1007' - Timetabler
    • +
  • '1008' - Relief Coordinator
    • +
  • '1009' - Office Manager
    • +
  • '1010' - Office Assistant
    • +
  • '1012' - Finance Assistant
    • +
  • '1013' - IT Manager
    • +
plus 51 more value(s) at NZCodeSetsStaffRoleType + oneOf: + - title: Principal + enum: + - "1001" + - title: Deputy Principal + enum: + - "1002" + - title: Associate Principal + enum: + - "1003" + - title: Assistant Principal + enum: + - "1004" + - title: Principal's Nominee (NZQA) + enum: + - "1005" + - title: Enrolment Officer + enum: + - "1006" + - title: Timetabler + enum: + - "1007" + - title: Relief Coordinator + enum: + - "1008" + - title: Office Manager + enum: + - "1009" + - title: Office Assistant + enum: + - "1010" + - title: Finance Assistant + enum: + - "1012" + - title: IT Manager + enum: + - "1013" + - title: IT Assistant + enum: + - "1014" + - title: Head Librarian + enum: + - "1015" + - title: Assistant Librarian + enum: + - "1016" + - title: Board of Trustees Member (Staff) + enum: + - "1017" + - title: Board of Trustees Member (Parent) + enum: + - "1018" + - title: Head of Department + enum: + - "1101" + - title: Assistant Head of Department + enum: + - "1102" + - title: Technician + enum: + - "1103" + - title: Subject Teacher + enum: + - "1201" + - title: STP Coordinator + enum: + - "1302" + - title: Learning Support Coordinator + enum: + - "1303" + - title: Learning Support Staff + enum: + - "1304" + - title: SAC Coordinator + enum: + - "1305" + - title: Special Needs Coordinator (SENCO) + enum: + - "1306" + - title: Distance Education Coordinator + enum: + - "1307" + - title: Resource Teacher Literacy (RTLit) + enum: + - "1308" + - title: Resource Teacher Learning and + Behaviour (RTLB) + enum: + - "1309" + - title: Parent Help + enum: + - "1310" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homerrom Teacher + enum: + - "1403" + - title: Pastoral Carer + enum: + - "1404" + - title: Guidance Counsellor + enum: + - "1405" + - title: Careers Advisor + enum: + - "1406" + - title: Truancy Officer + enum: + - "1407" + - title: Sickbay Nurse + enum: + - "1408" + - title: Dental Nurse + enum: + - "1409" + - title: Hostel Manager / Matron + enum: + - "1410" + - title: Social Worker (In School) + enum: + - "1411" + - title: Teacher in Charge + enum: + - "1501" + - title: Coach + enum: + - "1502" + - title: Kāhui Ako Led Principal + enum: + - "2001" + - title: Across School Teacher + enum: + - " 2002" + - title: Kāhui Ako Support Facilitator + enum: + - "2101" + - title: Kāhui Ako Expert Partner + enum: + - "2102" + - title: Ministry - Learning Support + Facilitator + enum: + - "2103" + - title: Ministry - Strategic Advisor - + Māori + enum: + - "2104" + - title: Ministry - SAF + enum: + - "2105" + - title: DHB Staff + enum: + - "2106" + - title: Teacher Aide + enum: + - "1301" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Kāhui Ako within School Teacher + enum: + - "1208" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Finance Manager + enum: + - "1011" + StartDate: + type: string + format: date + description:

The date from which (inclusive) the + role was assigned to the staff + member.

+ EndDate: + type: string + format: date + description:

The date after which the role is no + longer assigned to the staff + member.

+ StartDate: + type: string + format: date + description:

This is the date from which the staff + assignment is valid (inclusive).

+ EndDate: + type: string + format: date + description:

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.

+ CasualReliefTeacher: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + EmploymentStatus: + type: string + title: Staff Status + description: >- +

Describes the status of a staff member's + assignment at a Provider or other + EducationOrganisation.

    +
  • 'A' - Active
    • +
  • 'I' - Inactive
    • +
  • 'S' - Suspended
    • +
  • 'O' - On Leave
    • +
+ oneOf: + - title: Active + enum: + - A + - title: Inactive + enum: + - I + - title: Suspended + enum: + - S + - title: On Leave + enum: + - O + StaffSubjectList: + description:

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.

+ type: object + required: + - StaffSubject + properties: + StaffSubject: + type: array + items: + description:

This element contains Staff subjects + they are eligible to teach together with + the teaching preference.

+ type: object + required: + - Code + properties: + PreferenceNumber: + type: integer + description:

Priority of Subject to Teach.

+ Code: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas + defined by the NZ Curriculum and Te + Marautanga o Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - title: German + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - GERM + - title: Indonesian + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - INDO + - title: Japanese + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - JAPA + - title: French + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - FREN + - title: English (Remedial) + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - REME + - title: English + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - ENGL + - title: Cook Island Maori + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - COOK + - title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + enum: + - COMM + - title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + enum: + - CHIN + - title: Korean + enum: + - KORE + - title: Latin + enum: + - LATI + - title: Niuean + enum: + - NIUE + - title: Other Languages + enum: + - OLAN + - title: Pacific Language Studies + enum: + - PLAN + - title: Russian + enum: + - RUSS + - title: Samoan + enum: + - SAMO + - title: Spanish + enum: + - SPAN + - title: Te Reo Māori + enum: + - MAOR + - title: Te Reo Rangatira + enum: + - RANG + - title: Tokelauan + enum: + - TOKE + - title: Tongan + enum: + - TONG + - title: English as a Second Language + enum: + - ENSL + - title: Mathematics + enum: + - MATH + - title: Mathematics with Calculus + enum: + - MATC + - title: Mathematics with Statistics + enum: + - MATS + - title: Mathematics (Remedial) + enum: + - REMM + - title: Accounting + enum: + - ACCO + - title: Science + enum: + - SCIE + - title: Agriculture / Horticulture + enum: + - AGHO + - title: Biology / Biological Science + enum: + - BIOL + - title: Chemsitry + enum: + - CHEM + - title: Earth Science / Astronomy + enum: + - EAAS + - title: Human Biology + enum: + - HUMB + - title: Physics + enum: + - PHYS + - title: Technology + enum: + - TECN + - title: Biotechnology + enum: + - BITE + - title: Computer Science / Programming + enum: + - COSC + - title: Computer Studies + enum: + - COMP + - title: Design, Drawing and Graphics + enum: + - DEST + - title: Electronics and Control + enum: + - ELTE + - title: Food Technology + enum: + - FOTE + - title: Graphics + enum: + - GRAP + - title: Information and Communication + Technology + enum: + - INTE + - title: Materials Technology + enum: + - MTEC + - title: Structures and Mechanisms + enum: + - STME + - title: Test and Information Management + enum: + - TIMA + - title: Textiles / Clothing + enum: + - CLTX + - title: The Arts + enum: + - ARTA + - title: Art Design + enum: + - ARTD + - title: Art History + enum: + - ARTH + - title: Dancing + enum: + - DANC + - title: Drama + enum: + - DRAM + - title: Music / Music Studies + enum: + - MUSC + - title: Music Practical / Performance + enum: + - MUSP + - title: Painting + enum: + - ARPA + - title: Performing Arts + enum: + - APER + - title: Photography + enum: + - ARTP + - title: Printmaking + enum: + - ARPR + - title: Sculpture + enum: + - ARTS + - title: Visial Arts + enum: + - ARTC + - title: Social Studies + enum: + - SOST + - title: Classics / Classical Studies + enum: + - CLST + - title: Community Studies + enum: + - CMTY + - title: Economics + enum: + - ECON + - title: Environmental Sustainability + enum: + - SENV + - title: Geography + enum: + - GEOG + - title: History + enum: + - HIST + - title: Language and Cultural Studies + enum: + - LACU + - title: Māori Studies + enum: + - MAOS + - title: Media Studies + enum: + - MEST + - title: Other Social Sciences + enum: + - SOSC + - title: Health and Physical Education + enum: + - HEPH + - title: Health + enum: + - HEED + - title: Home Economics + enum: + - HOME + - title: Outdoor Education + enum: + - OUED + - title: Physical Education + enum: + - PHED + - title: Sports Studies + enum: + - SPOR + - title: Commerce Related + enum: + - BUSS + - title: Defence + enum: + - DEFE + - title: Equestrian + enum: + - EQUE + - title: Farming + enum: + - FARM + - title: Fishing + enum: + - FISH + - title: Forestry + enum: + - FOTY + - title: Industrial Trades + enum: + - INTR + - title: Integrated Studies + enum: + - INTS + - title: Legal / Law Related Studies + enum: + - LAWS + - title: Life Skills / Personal Development + enum: + - LIFE + - title: Religious Education / Studies + enum: + - REST + - title: Remedial Studies + enum: + - REMS + - title: Secondary Tertiary Programme + enum: + - STPR + - title: Service Trades + enum: + - SETR + - title: Special Needs Programme + enum: + - SPPR + - title: Study Skills + enum: + - STDY + - title: Transition / Pre-Employment + enum: + - TRAN + - title: Travel, Hospitality, Tourism + enum: + - THTR + YearLevels: + description:

Staff assignment to this particular + subject area / learning area applies + only for students enrolled in a + particular set of year levels. e.g. + "Asst. Head of Dept (Maths, Jnr)" + could ony be responsible for Students + in year levels 9 & 10, who are + learning Mathematics.

+ type: object + required: + - YearLevel + properties: + YearLevel: + type: array + items: + type: string + title: Year Level Code + description: >- +

Year Level defines the values + that are valid for describing + Funding Year Level and Current + Year Level for a student + enrolment.

Current Year + Level indicates the year level + of the student’s class cohort + and the level at which the + student spends most of their + time at school. While a student + may be enrolled in subjects at + varying instructional year + levels, in relation to the + student enrolment this value + represents the year level at + which the student is considered + to be predominantly taught.

+

Funding Year Level measures + the actual number of years that + the student has attended a + school. It provides the Ministry + with a method of counting + students for funding purposes + which is independent of the way + schools are organised or the + particular programme of study + that a student may undertake. + Funding Year Level for most + students is based on the date + they first started school.

+

School Year Level is used to + indicate the instructional year + levels offered by a school, i.e. + those years for which student + enrolments may be accepted.

+
    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year + Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this + code indicates Year 14 and + above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year + Level + enum: + - "15" + YearLevels: + description:

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.

+ type: object + required: + - YearLevel + properties: + YearLevel: + type: array + items: + $ref: "#/paths/~1StaffAssignments/get/responses\ + /200/content/application~1json/schema/pro\ + perties/StaffAssignments/properties/Staff\ + Assignment/items/properties/StaffSubjectL\ + ist/properties/StaffSubject/items/propert\ + ies/YearLevels/properties/YearLevel/items" + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StaffAssignments: + StaffAssignment: + - StaffAssignmentRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + StaffMember: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1651 + AssignedLocation: + RefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + LocalId: "203" + Name: Wellington College + ObjectType: Provider + Description: Senior English Teacher + StaffRoleList: + StaffRole: + Role: + - "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 + application/xml: + schema: + type: object + properties: + StaffAssignments: + type: object + description: A List of StaffAssignment objects + properties: + StaffAssignment: + type: array + items: + $ref: "#/paths/~1StaffAssignments/get/responses/200/conte\ + nt/application~1json/schema/properties/StaffAssignm\ + ents/properties/StaffAssignment/items" + example: >- + + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + D3E34B35-9D75-101A-8C3D-00AA001A1651 + + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 203 + Wellington College + Provider + + Senior English Teacher + + + 1102 + + + 2000-09-05 + 2001-06-25 + N + A + + + 1 + ENGL + + 11 + 12 + 13 + + + + 2 + HIST + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StaffAssignments/{StaffAssignmentRefId}": + post: + tags: + - StaffAssignment + summary: Default operation to create a single StaffAssignment + parameters: + - name: StaffAssignmentRefId + in: path + description:

The GUID that uniquely identifies a particular staff + assignment.

+ required: true + schema: + type: string + operationId: createStaffAssignment + requestBody: + description: CRUD operation on StaffAssignment + content: + application/json: + schema: + type: object + properties: + StaffAssignment: + $ref: "#/paths/~1StaffAssignments/get/responses/200/content/appli\ + cation~1json/schema/properties/StaffAssignments/properties/\ + StaffAssignment/items" + example: + StaffAssignment: + StaffAssignmentRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + StaffMember: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1651 + AssignedLocation: + RefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + LocalId: "203" + Name: Wellington College + ObjectType: Provider + Description: Senior English Teacher + StaffRoleList: + StaffRole: + Role: + - "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 + application/xml: + schema: + type: object + properties: + StaffAssignment: + $ref: "#/paths/~1StaffAssignments/get/responses/200/content/appli\ + cation~1json/schema/properties/StaffAssignments/properties/\ + StaffAssignment/items" + example: >- + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + D3E34B35-9D75-101A-8C3D-00AA001A1651 + + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 203 + Wellington College + Provider + + Senior English Teacher + + + 1102 + + + 2000-09-05 + 2001-06-25 + N + A + + + 1 + ENGL + + 11 + 12 + 13 + + + + 2 + HIST + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StaffAssignment + summary: Default operation to update a single StaffAssignment + parameters: + - name: StaffAssignmentRefId + in: path + description:

The GUID that uniquely identifies a particular staff + assignment.

+ required: true + schema: + type: string + operationId: updateStaffAssignment + requestBody: + description: CRUD operation on StaffAssignment + content: + application/json: + schema: + type: object + properties: + StaffAssignment: + type: object + properties: + StaffAssignmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StaffAssignmentLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + StaffMember: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StaffAssignments~1%7BStaffAssignmentRefI\ + d%7D/put/requestBody/content/application~1json/sche\ + ma/properties/StaffAssignment/properties/StaffAssig\ + nmentRefId" + LocalId: + $ref: "#/paths/~1StaffAssignments~1%7BStaffAssignmentRefI\ + d%7D/put/requestBody/content/application~1json/sche\ + ma/properties/StaffAssignment/properties/StaffAssig\ + nmentLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + AssignedLocation: + $ref: "#/paths/~1StaffAssignments~1%7BStaffAssignmentRefId%7D\ + /put/requestBody/content/application~1json/schema/prope\ + rties/StaffAssignment/properties/StaffMember" + Description: + type: string + description:

Short description of the staff member's assignment to + the provider.

+ StaffRoleList: + description:

The list of roles the StaffMember has in relation to + all students at the assigned location.

+ type: object + properties: + StaffRole: + type: array + items: + description:

A list of roles that are assigned to the staff + member.

+ type: object + properties: + Role: + type: string + title: Staff Role + description: >- +

Describes the role a staff member has at a + Provider or other EducationOrganisation.

+
    +
  • '1001' - Principal
    • +
  • '1002' - Deputy Principal
    • +
  • '1003' - Associate Principal
    • +
  • '1004' - Assistant Principal
    • +
  • '1005' - Principal's Nominee (NZQA)
    • +
  • '1006' - Enrolment Officer
    • +
  • '1007' - Timetabler
    • +
  • '1008' - Relief Coordinator
    • +
  • '1009' - Office Manager
    • +
  • '1010' - Office Assistant
    • +
  • '1012' - Finance Assistant
    • +
  • '1013' - IT Manager
    • +
plus 51 more value(s) at NZCodeSetsStaffRoleType + oneOf: + - title: Principal + enum: + - "1001" + - title: Deputy Principal + enum: + - "1002" + - title: Associate Principal + enum: + - "1003" + - title: Assistant Principal + enum: + - "1004" + - title: Principal's Nominee (NZQA) + enum: + - "1005" + - title: Enrolment Officer + enum: + - "1006" + - title: Timetabler + enum: + - "1007" + - title: Relief Coordinator + enum: + - "1008" + - title: Office Manager + enum: + - "1009" + - title: Office Assistant + enum: + - "1010" + - title: Finance Assistant + enum: + - "1012" + - title: IT Manager + enum: + - "1013" + - title: IT Assistant + enum: + - "1014" + - title: Head Librarian + enum: + - "1015" + - title: Assistant Librarian + enum: + - "1016" + - title: Board of Trustees Member (Staff) + enum: + - "1017" + - title: Board of Trustees Member (Parent) + enum: + - "1018" + - title: Head of Department + enum: + - "1101" + - title: Assistant Head of Department + enum: + - "1102" + - title: Technician + enum: + - "1103" + - title: Subject Teacher + enum: + - "1201" + - title: STP Coordinator + enum: + - "1302" + - title: Learning Support Coordinator + enum: + - "1303" + - title: Learning Support Staff + enum: + - "1304" + - title: SAC Coordinator + enum: + - "1305" + - title: Special Needs Coordinator (SENCO) + enum: + - "1306" + - title: Distance Education Coordinator + enum: + - "1307" + - title: Resource Teacher Literacy (RTLit) + enum: + - "1308" + - title: Resource Teacher Learning and Behaviour + (RTLB) + enum: + - "1309" + - title: Parent Help + enum: + - "1310" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homerrom Teacher + enum: + - "1403" + - title: Pastoral Carer + enum: + - "1404" + - title: Guidance Counsellor + enum: + - "1405" + - title: Careers Advisor + enum: + - "1406" + - title: Truancy Officer + enum: + - "1407" + - title: Sickbay Nurse + enum: + - "1408" + - title: Dental Nurse + enum: + - "1409" + - title: Hostel Manager / Matron + enum: + - "1410" + - title: Social Worker (In School) + enum: + - "1411" + - title: Teacher in Charge + enum: + - "1501" + - title: Coach + enum: + - "1502" + - title: Kāhui Ako Led Principal + enum: + - "2001" + - title: Across School Teacher + enum: + - " 2002" + - title: Kāhui Ako Support Facilitator + enum: + - "2101" + - title: Kāhui Ako Expert Partner + enum: + - "2102" + - title: Ministry - Learning Support Facilitator + enum: + - "2103" + - title: Ministry - Strategic Advisor - Māori + enum: + - "2104" + - title: Ministry - SAF + enum: + - "2105" + - title: DHB Staff + enum: + - "2106" + - title: Teacher Aide + enum: + - "1301" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Kāhui Ako within School Teacher + enum: + - "1208" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Finance Manager + enum: + - "1011" + StartDate: + type: string + format: date + description:

The date from which (inclusive) the role + was assigned to the staff member.

+ EndDate: + type: string + format: date + description:

The date after which the role is no longer + assigned to the staff member.

+ StartDate: + type: string + format: date + description:

This is the date from which the staff assignment is + valid (inclusive).

+ EndDate: + type: string + format: date + description:

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.

+ CasualReliefTeacher: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + EmploymentStatus: + type: string + title: Staff Status + description: >- +

Describes the status of a staff member's assignment + at a Provider or other EducationOrganisation.

    +
  • 'A' - Active
    • +
  • 'I' - Inactive
    • +
  • 'S' - Suspended
    • +
  • 'O' - On Leave
    • +
+ oneOf: + - title: Active + enum: + - A + - title: Inactive + enum: + - I + - title: Suspended + enum: + - S + - title: On Leave + enum: + - O + StaffSubjectList: + description:

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.

+ type: object + properties: + StaffSubject: + type: array + items: + description:

This element contains Staff subjects they are + eligible to teach together with the teaching + preference.

+ type: object + properties: + PreferenceNumber: + type: integer + description:

Priority of Subject to Teach.

+ Code: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - GERM + - title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - INDO + - title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - JAPA + - title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - FREN + - title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - REME + - title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - ENGL + - title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - COOK + - title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + enum: + - COMM + - title: Chinese + description: Applicable to Te Marautanga o Aotearoa + enum: + - CHIN + - title: Korean + enum: + - KORE + - title: Latin + enum: + - LATI + - title: Niuean + enum: + - NIUE + - title: Other Languages + enum: + - OLAN + - title: Pacific Language Studies + enum: + - PLAN + - title: Russian + enum: + - RUSS + - title: Samoan + enum: + - SAMO + - title: Spanish + enum: + - SPAN + - title: Te Reo Māori + enum: + - MAOR + - title: Te Reo Rangatira + enum: + - RANG + - title: Tokelauan + enum: + - TOKE + - title: Tongan + enum: + - TONG + - title: English as a Second Language + enum: + - ENSL + - title: Mathematics + enum: + - MATH + - title: Mathematics with Calculus + enum: + - MATC + - title: Mathematics with Statistics + enum: + - MATS + - title: Mathematics (Remedial) + enum: + - REMM + - title: Accounting + enum: + - ACCO + - title: Science + enum: + - SCIE + - title: Agriculture / Horticulture + enum: + - AGHO + - title: Biology / Biological Science + enum: + - BIOL + - title: Chemsitry + enum: + - CHEM + - title: Earth Science / Astronomy + enum: + - EAAS + - title: Human Biology + enum: + - HUMB + - title: Physics + enum: + - PHYS + - title: Technology + enum: + - TECN + - title: Biotechnology + enum: + - BITE + - title: Computer Science / Programming + enum: + - COSC + - title: Computer Studies + enum: + - COMP + - title: Design, Drawing and Graphics + enum: + - DEST + - title: Electronics and Control + enum: + - ELTE + - title: Food Technology + enum: + - FOTE + - title: Graphics + enum: + - GRAP + - title: Information and Communication Technology + enum: + - INTE + - title: Materials Technology + enum: + - MTEC + - title: Structures and Mechanisms + enum: + - STME + - title: Test and Information Management + enum: + - TIMA + - title: Textiles / Clothing + enum: + - CLTX + - title: The Arts + enum: + - ARTA + - title: Art Design + enum: + - ARTD + - title: Art History + enum: + - ARTH + - title: Dancing + enum: + - DANC + - title: Drama + enum: + - DRAM + - title: Music / Music Studies + enum: + - MUSC + - title: Music Practical / Performance + enum: + - MUSP + - title: Painting + enum: + - ARPA + - title: Performing Arts + enum: + - APER + - title: Photography + enum: + - ARTP + - title: Printmaking + enum: + - ARPR + - title: Sculpture + enum: + - ARTS + - title: Visial Arts + enum: + - ARTC + - title: Social Studies + enum: + - SOST + - title: Classics / Classical Studies + enum: + - CLST + - title: Community Studies + enum: + - CMTY + - title: Economics + enum: + - ECON + - title: Environmental Sustainability + enum: + - SENV + - title: Geography + enum: + - GEOG + - title: History + enum: + - HIST + - title: Language and Cultural Studies + enum: + - LACU + - title: Māori Studies + enum: + - MAOS + - title: Media Studies + enum: + - MEST + - title: Other Social Sciences + enum: + - SOSC + - title: Health and Physical Education + enum: + - HEPH + - title: Health + enum: + - HEED + - title: Home Economics + enum: + - HOME + - title: Outdoor Education + enum: + - OUED + - title: Physical Education + enum: + - PHED + - title: Sports Studies + enum: + - SPOR + - title: Commerce Related + enum: + - BUSS + - title: Defence + enum: + - DEFE + - title: Equestrian + enum: + - EQUE + - title: Farming + enum: + - FARM + - title: Fishing + enum: + - FISH + - title: Forestry + enum: + - FOTY + - title: Industrial Trades + enum: + - INTR + - title: Integrated Studies + enum: + - INTS + - title: Legal / Law Related Studies + enum: + - LAWS + - title: Life Skills / Personal Development + enum: + - LIFE + - title: Religious Education / Studies + enum: + - REST + - title: Remedial Studies + enum: + - REMS + - title: Secondary Tertiary Programme + enum: + - STPR + - title: Service Trades + enum: + - SETR + - title: Special Needs Programme + enum: + - SPPR + - title: Study Skills + enum: + - STDY + - title: Transition / Pre-Employment + enum: + - TRAN + - title: Travel, Hospitality, Tourism + enum: + - THTR + YearLevels: + description:

Staff assignment to this particular subject + area / learning area applies only for students + enrolled in a particular set of year levels. + e.g. "Asst. Head of Dept (Maths, Jnr)" could + ony be responsible for Students in year levels + 9 & 10, who are learning Mathematics.

+ type: object + properties: + YearLevel: + type: array + items: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that + are valid for describing Funding Year + Level and Current Year Level for a + student enrolment.

Current Year + Level indicates the year level of the + student’s class cohort and the level at + which the student spends most of their + time at school. While a student may be + enrolled in subjects at varying + instructional year levels, in relation + to the student enrolment this value + represents the year level at which the + student is considered to be + predominantly taught.

Funding + Year Level measures the actual number of + years that the student has attended a + school. It provides the Ministry with a + method of counting students for funding + purposes which is independent of the way + schools are organised or the particular + programme of study that a student may + undertake. Funding Year Level for most + students is based on the date they first + started school.

School Year Level + is used to indicate the instructional + year levels offered by a school, i.e. + those years for which student enrolments + may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code + indicates Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + YearLevels: + description:

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.

+ type: object + properties: + YearLevel: + type: array + items: + $ref: "#/paths/~1StaffAssignments~1%7BStaffAssignmentRe\ + fId%7D/put/requestBody/content/application~1json/\ + schema/properties/StaffAssignment/properties/Staf\ + fSubjectList/properties/StaffSubject/items/proper\ + ties/YearLevels/properties/YearLevel/items" + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StaffAssignment: + StaffAssignmentRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + StaffMember: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1651 + AssignedLocation: + RefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + LocalId: "203" + Name: Wellington College + ObjectType: Provider + Description: Senior English Teacher + StaffRoleList: + StaffRole: + Role: + - "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 + application/xml: + schema: + type: object + properties: + StaffAssignment: + $ref: "#/paths/~1StaffAssignments~1%7BStaffAssignmentRefId%7D/put\ + /requestBody/content/application~1json/schema/properties/St\ + affAssignment" + example: >- + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + D3E34B35-9D75-101A-8C3D-00AA001A1651 + + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 203 + Wellington College + Provider + + Senior English Teacher + + + 1102 + + + 2000-09-05 + 2001-06-25 + N + A + + + 1 + ENGL + + 11 + 12 + 13 + + + + 2 + HIST + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StaffAssignment + summary: Default operation to get a single StaffAssignment + parameters: + - name: StaffAssignmentRefId + in: path + description:

The GUID that uniquely identifies a particular staff + assignment.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StaffAssignment: + $ref: "#/paths/~1StaffAssignments/get/responses/200/content/app\ + lication~1json/schema/properties/StaffAssignments/propert\ + ies/StaffAssignment/items" + example: + StaffAssignment: + StaffAssignmentRefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + StaffMember: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1651 + AssignedLocation: + RefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + LocalId: "203" + Name: Wellington College + ObjectType: Provider + Description: Senior English Teacher + StaffRoleList: + StaffRole: + Role: + - "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 + application/xml: + schema: + type: object + properties: + StaffAssignment: + $ref: "#/paths/~1StaffAssignments/get/responses/200/content/app\ + lication~1json/schema/properties/StaffAssignments/propert\ + ies/StaffAssignment/items" + example: >- + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + D3E34B35-9D75-101A-8C3D-00AA001A1651 + + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 203 + Wellington College + Provider + + Senior English Teacher + + + 1102 + + + 2000-09-05 + 2001-06-25 + N + A + + + 1 + ENGL + + 11 + 12 + 13 + + + + 2 + HIST + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StaffAssignment + summary: Default operation to delete a single StaffAssignment + parameters: + - name: StaffAssignmentRefId + in: path + description:

The GUID that uniquely identifies a particular staff + assignment.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StaffTeachingGroupAssignments: + get: + tags: + - StaffTeachingGroupAssignment + summary: Default operation to get a list of all available + StaffTeachingGroupAssignments + description: Search the set of available StaffTeachingGroupAssignments, according to + the search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StaffTeachingGroupAssignments: + type: object + description: A List of StaffTeachingGroupAssignment objects + properties: + StaffTeachingGroupAssignment: + type: array + items: + required: + - Provider + - Role + - StaffMember + - StartDate + - TeachingGroup + type: object + properties: + StaffTeachingGroupAssignmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StaffTeachingGroupAssignmentLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + StaffMember: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StaffTeachingGroupAssignments/ge\ + t/responses/200/content/application~1json/s\ + chema/properties/StaffTeachingGroupAssignme\ + nts/properties/StaffTeachingGroupAssignment\ + /items/properties/StaffTeachingGroupAssignm\ + entRefId" + LocalId: + $ref: "#/paths/~1StaffTeachingGroupAssignments/ge\ + t/responses/200/content/application~1json/s\ + chema/properties/StaffTeachingGroupAssignme\ + nts/properties/StaffTeachingGroupAssignment\ + /items/properties/StaffTeachingGroupAssignm\ + entLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StaffTeachingGroupAssignments/get/re\ + sponses/200/content/application~1json/schema/pr\ + operties/StaffTeachingGroupAssignments/properti\ + es/StaffTeachingGroupAssignment/items/propertie\ + s/StaffMember" + TeachingGroup: + $ref: "#/paths/~1StaffTeachingGroupAssignments/get/re\ + sponses/200/content/application~1json/schema/pr\ + operties/StaffTeachingGroupAssignments/properti\ + es/StaffTeachingGroupAssignment/items/propertie\ + s/StaffMember" + Role: + type: string + title: Staff Teaching Group Role + description: >- +

Code set denoting the role the staff member + is performing within the teaching group, e.g. + Teacher, Teacher Aide, Student Teacher.

    +
  • '1201' - Subject Teacher
    • +
  • '1202' - Subject Release Teacher
    • +
  • '1203' - Subject Relief Teacher
    • +
  • '1204' - Subject Tutor
    • +
  • '1205' - Classroom Teacher
    • +
  • '1206' - Classroom Release Teacher
    • +
  • '1207' - Classroom Relief Teacher
    • +
  • '1209' - Itinerant Subject Teacher
    • +
  • '1210' - Itinerant Subject Tutor
    • +
  • '1211' - Specialist Classroom Teacher
    • +
  • '1401' - Homeroom Teacher
    • +
  • '1402' - Release Homeroom Teacher
    • +
plus 2 more value(s) at NZCodeSetsStaffTeachingGroupRoleType + oneOf: + - title: Subject Teacher + enum: + - "1201" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release Teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homeroom Teacher + enum: + - "1403" + - title: Teacher Aide + enum: + - "1301" + StartDate: + type: string + format: date + description:

This is the date from which the staff + assignment is valid (inclusive).

+ EndDate: + type: string + format: date + description:

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.

+ description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StaffTeachingGroupAssignments: + StaffTeachingGroupAssignment: + - StaffTeachingGroupAssignmentRefId: 92828e71-c702-4944-841e-761203142ccd + StaffMember: + RefId: 6c12f5ae-ca86-40e2-b252-593154c8b967 + Provider: + RefId: f91cd380-2e14-43ef-b181-aedccea399f9 + 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 + application/xml: + schema: + type: object + properties: + StaffTeachingGroupAssignments: + type: object + description: A List of StaffTeachingGroupAssignment objects + properties: + StaffTeachingGroupAssignment: + type: array + items: + $ref: "#/paths/~1StaffTeachingGroupAssignments/get/respon\ + ses/200/content/application~1json/schema/properties\ + /StaffTeachingGroupAssignments/properties/StaffTeac\ + hingGroupAssignment/items" + example: >- + + + 92828e71-c702-4944-841e-761203142ccd + + 6c12f5ae-ca86-40e2-b252-593154c8b967 + + + f91cd380-2e14-43ef-b181-aedccea399f9 + + + edc3ac19-264f-4734-b75b-6d56fbf84a18 + 11FrenA + Year 11 French, Stream A + + 1201 + 2000-09-05 + 2001-06-25 + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StaffTeachingGroupAssignments/{StaffTeachingGroupAssignmentRefId}": + post: + tags: + - StaffTeachingGroupAssignment + summary: Default operation to create a single StaffTeachingGroupAssignment + parameters: + - name: StaffTeachingGroupAssignmentRefId + in: path + description:

The GUID that uniquely identifies a particular staff teaching + group assignment.

+ required: true + schema: + type: string + operationId: createStaffTeachingGroupAssignment + requestBody: + description: CRUD operation on StaffTeachingGroupAssignment + content: + application/json: + schema: + type: object + properties: + StaffTeachingGroupAssignment: + $ref: "#/paths/~1StaffTeachingGroupAssignments/get/responses/200/\ + content/application~1json/schema/properties/StaffTeachingGr\ + oupAssignments/properties/StaffTeachingGroupAssignment/item\ + s" + example: + StaffTeachingGroupAssignment: + StaffTeachingGroupAssignmentRefId: 92828e71-c702-4944-841e-761203142ccd + StaffMember: + RefId: 6c12f5ae-ca86-40e2-b252-593154c8b967 + Provider: + RefId: f91cd380-2e14-43ef-b181-aedccea399f9 + 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 + application/xml: + schema: + type: object + properties: + StaffTeachingGroupAssignment: + $ref: "#/paths/~1StaffTeachingGroupAssignments/get/responses/200/\ + content/application~1json/schema/properties/StaffTeachingGr\ + oupAssignments/properties/StaffTeachingGroupAssignment/item\ + s" + example: >- + + 92828e71-c702-4944-841e-761203142ccd + + 6c12f5ae-ca86-40e2-b252-593154c8b967 + + + f91cd380-2e14-43ef-b181-aedccea399f9 + + + edc3ac19-264f-4734-b75b-6d56fbf84a18 + 11FrenA + Year 11 French, Stream A + + 1201 + 2000-09-05 + 2001-06-25 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StaffTeachingGroupAssignment + summary: Default operation to update a single StaffTeachingGroupAssignment + parameters: + - name: StaffTeachingGroupAssignmentRefId + in: path + description:

The GUID that uniquely identifies a particular staff teaching + group assignment.

+ required: true + schema: + type: string + operationId: updateStaffTeachingGroupAssignment + requestBody: + description: CRUD operation on StaffTeachingGroupAssignment + content: + application/json: + schema: + type: object + properties: + StaffTeachingGroupAssignment: + type: object + properties: + StaffTeachingGroupAssignmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StaffTeachingGroupAssignmentLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + StaffMember: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StaffTeachingGroupAssignments~1%7BStaffT\ + eachingGroupAssignmentRefId%7D/put/requestBody/cont\ + ent/application~1json/schema/properties/StaffTeachi\ + ngGroupAssignment/properties/StaffTeachingGroupAssi\ + gnmentRefId" + LocalId: + $ref: "#/paths/~1StaffTeachingGroupAssignments~1%7BStaffT\ + eachingGroupAssignmentRefId%7D/put/requestBody/cont\ + ent/application~1json/schema/properties/StaffTeachi\ + ngGroupAssignment/properties/StaffTeachingGroupAssi\ + gnmentLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StaffTeachingGroupAssignments~1%7BStaffTeach\ + ingGroupAssignmentRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/StaffTeachingGroupAssig\ + nment/properties/StaffMember" + TeachingGroup: + $ref: "#/paths/~1StaffTeachingGroupAssignments~1%7BStaffTeach\ + ingGroupAssignmentRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/StaffTeachingGroupAssig\ + nment/properties/StaffMember" + Role: + type: string + title: Staff Teaching Group Role + description: >- +

Code set denoting the role the staff member is + performing within the teaching group, e.g. Teacher, + Teacher Aide, Student Teacher.

    +
  • '1201' - Subject Teacher
    • +
  • '1202' - Subject Release Teacher
    • +
  • '1203' - Subject Relief Teacher
    • +
  • '1204' - Subject Tutor
    • +
  • '1205' - Classroom Teacher
    • +
  • '1206' - Classroom Release Teacher
    • +
  • '1207' - Classroom Relief Teacher
    • +
  • '1209' - Itinerant Subject Teacher
    • +
  • '1210' - Itinerant Subject Tutor
    • +
  • '1211' - Specialist Classroom Teacher
    • +
  • '1401' - Homeroom Teacher
    • +
  • '1402' - Release Homeroom Teacher
    • +
plus 2 more value(s) at NZCodeSetsStaffTeachingGroupRoleType + oneOf: + - title: Subject Teacher + enum: + - "1201" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release Teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homeroom Teacher + enum: + - "1403" + - title: Teacher Aide + enum: + - "1301" + StartDate: + type: string + format: date + description:

This is the date from which the staff assignment is + valid (inclusive).

+ EndDate: + type: string + format: date + description:

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.

+ description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StaffTeachingGroupAssignment: + StaffTeachingGroupAssignmentRefId: 92828e71-c702-4944-841e-761203142ccd + StaffMember: + RefId: 6c12f5ae-ca86-40e2-b252-593154c8b967 + Provider: + RefId: f91cd380-2e14-43ef-b181-aedccea399f9 + 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 + application/xml: + schema: + type: object + properties: + StaffTeachingGroupAssignment: + $ref: "#/paths/~1StaffTeachingGroupAssignments~1%7BStaffTeachingG\ + roupAssignmentRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/StaffTeachingGroupAssignment" + example: >- + + 92828e71-c702-4944-841e-761203142ccd + + 6c12f5ae-ca86-40e2-b252-593154c8b967 + + + f91cd380-2e14-43ef-b181-aedccea399f9 + + + edc3ac19-264f-4734-b75b-6d56fbf84a18 + 11FrenA + Year 11 French, Stream A + + 1201 + 2000-09-05 + 2001-06-25 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StaffTeachingGroupAssignment + summary: Default operation to get a single StaffTeachingGroupAssignment + parameters: + - name: StaffTeachingGroupAssignmentRefId + in: path + description:

The GUID that uniquely identifies a particular staff teaching + group assignment.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StaffTeachingGroupAssignment: + $ref: "#/paths/~1StaffTeachingGroupAssignments/get/responses/20\ + 0/content/application~1json/schema/properties/StaffTeachi\ + ngGroupAssignments/properties/StaffTeachingGroupAssignmen\ + t/items" + example: + StaffTeachingGroupAssignment: + StaffTeachingGroupAssignmentRefId: 92828e71-c702-4944-841e-761203142ccd + StaffMember: + RefId: 6c12f5ae-ca86-40e2-b252-593154c8b967 + Provider: + RefId: f91cd380-2e14-43ef-b181-aedccea399f9 + 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 + application/xml: + schema: + type: object + properties: + StaffTeachingGroupAssignment: + $ref: "#/paths/~1StaffTeachingGroupAssignments/get/responses/20\ + 0/content/application~1json/schema/properties/StaffTeachi\ + ngGroupAssignments/properties/StaffTeachingGroupAssignmen\ + t/items" + example: >- + + 92828e71-c702-4944-841e-761203142ccd + + 6c12f5ae-ca86-40e2-b252-593154c8b967 + + + f91cd380-2e14-43ef-b181-aedccea399f9 + + + edc3ac19-264f-4734-b75b-6d56fbf84a18 + 11FrenA + Year 11 French, Stream A + + 1201 + 2000-09-05 + 2001-06-25 + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StaffTeachingGroupAssignment + summary: Default operation to delete a single StaffTeachingGroupAssignment + parameters: + - name: StaffTeachingGroupAssignmentRefId + in: path + description:

The GUID that uniquely identifies a particular staff teaching + group assignment.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentPersonals: + get: + tags: + - StudentPersonal + summary: Default operation to get a list of all available StudentPersonals + description: Search the set of available StudentPersonals, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentPersonals: + type: object + description: A List of StudentPersonal objects + properties: + StudentPersonal: + type: array + items: + required: + - NationalStudentNumber + - PersonInfo + type: object + properties: + StudentPersonalRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentPersonalLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + NationalStudentNumber: + description:

The unique identifier allocated to every + student in New Zealand, also known as the + NSN.

+ FirstNZSchoolingDate: + type: string + format: date + description:

The date a student first ever started + schooling in New Zealand. This field is used to + establish most students’ Funding Year Level.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + EarlyChildhoodEducation: + description:

The type of early childhood education the + student received before enrolling in their first + school.

+ type: object + properties: + Type: + type: string + title: Early Childhood Education Type + description: >- +

The type of early childhood education the + student received.

    +
  • 'EKR' - Kohanga Reo
    • +
  • 'EPC' - Playcentre
    • +
  • 'EKE' - Kindergarden or Education and Care
    • +
  • 'EHB' - Home Based Service
    • +
  • 'EPG' - Playgroup or Pacific Islands EC Group
    • +
  • 'ECO' - The Correspondence School - Te Aho o Te Kura Pounamu
    • +
  • 'EOS' - Attended, but only outside New Zealand
    • +
  • 'ETU' - Attended, but don't know what type of service
    • +
  • 'ENA' - Did not attend
    • +
  • 'EUN' - Unable to establish if attended or not
    • +
+ oneOf: + - title: Kohanga Reo + enum: + - EKR + - title: Playcentre + enum: + - EPC + - title: Kindergarden or Education and Care + enum: + - EKE + - title: Home Based Service + enum: + - EHB + - title: Playgroup or Pacific Islands EC Group + enum: + - EPG + - title: The Correspondence School - Te Aho o Te + Kura Pounamu + enum: + - ECO + - title: Attended, but only outside New Zealand + enum: + - EOS + - title: Attended, but don't know what type of + service + enum: + - ETU + - title: Did not attend + enum: + - ENA + - title: Unable to establish if attended or not + enum: + - EUN + HoursAttended: + type: integer + description:

The total number of hours of early + childhood education attended, prior to + enrolling in their first school.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + PersonInfo: + description:

Personal Information

+ type: object + required: + - Name + properties: + Name: + description:

A name used by the person

+ type: object + properties: + Title: + type: string + description:

A title or prefix associated with the + name.

+ FamilyName: + type: string + description:

Also known as Last Name, although + some cultures may not present a family + name as the last name.

+ GivenName: + type: string + description:

Also known as First Name, although + some cultures may not present this name + as the first element in a name. May + contain a composite of all given + names.

+ MiddleName: + type: string + description:

Where more than one Given Name, these + may be combined in one composite field + or else populated in several elements. +

+ FamilyNameFirst: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, + unknown and not provided values.

+
    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PreferredFamilyName: + type: string + description:

A preferred version of the Family + Name. Note:A name cannot have both a + Preferred Family and Preferred Given + Name within the same Name structure – + only one of these fields should be + populated. If a person does have both a + Preferred Family and Preferred Given + Name then this must be populated as a + separate Name of type ‘Preferred’.

+ PreferredFamilyNameFirst: + $ref: "#/paths/~1StudentPersonals/get/respons\ + es/200/content/application~1json/schema\ + /properties/StudentPersonals/properties\ + /StudentPersonal/items/properties/Perso\ + nInfo/properties/Name/properties/Family\ + NameFirst" + PreferredGivenName: + type: string + description: "

A preferred version of the Given + Name. Note: A name cannot have both a + Preferred Family and Preferred Given + Name within the same Name structure – + only one of these fields should be + populated. If a person does have both a + Preferred Family and Preferred Given + Name then this must be populated as a + separate Name of type ‘Preferred’.

" + Suffix: + type: string + description:

Textual suffix like PHD, JP, BSc.

+ FullName: + type: string + description:

A combination of all name elements as + one composite text element

+ Type: + type: string + title: Name Usage Type + description: >- +

A standardised method of describing + the usage of a name by a person. Where a + person has more than one current name, + the usage type indicates which name may + be used according to the purpose.

+

Code values are based on SIF + Australia 3.4.

    +
  • 'PRF' - Preferred Name
    • +
  • 'FON' - Foreign Official Name
    • +
  • 'PRV' - Previous name
    • +
  • 'AKA' - Also Known As
    • +
  • 'BTH' - Name at Birth
    • +
  • 'LGL' - Legal Name
    • +
+ oneOf: + - title: Preferred Name + description:

The name by which an individual + prefers to be known and + addressed.

Only usage type + applicable for student name usage + (other types are not supported by + NSI).

+ enum: + - PRF + - title: Foreign Official Name + description:

Included for future usage in NZ, + especially for tertiary + students.

+ enum: + - FON + - title: Previous name + enum: + - PRV + - title: Also Known As + description: AKA or Alias + enum: + - AKA + - title: Name at Birth + enum: + - BTH + - title: Legal Name + description:

Legal Name or Official Name as + defined by the organisation which + collects it (legal name is not + defined in this standard)

+ enum: + - LGL + IsVerified: + $ref: "#/paths/~1StudentPersonals/get/respons\ + es/200/content/application~1json/schema\ + /properties/StudentPersonals/properties\ + /StudentPersonal/items/properties/Perso\ + nInfo/properties/Name/properties/Family\ + NameFirst" + OtherNameList: + description:

Previous, alternate or other names or + aliases associated with the person.

+ type: object + required: + - Name + properties: + Name: + type: array + items: + description:

Extension of BaseNameType including + name verification data

+ type: object + properties: + Verification: + description:

The verification event that + verified the person's name.

+ type: object + required: + - IsConfirmed + - Source + properties: + Source: + type: string + title: Verification Source + description: >- +

Records the source of the + identity or eligibility + verification, that has been + made. Mostly it is merely a + record of the kind of document + that has been presented; but + occasionally it is down to + Principal or Ministry + discretion / approval.

+
    +
  • 'NZBIR' - NZ Birth Certificate
    • +
  • 'NZBCO' - NZ Birth Certificate (with confirmation of NZ Citizen by birth)
    • +
  • 'NZPAS' - NZ Passport
    • +
  • 'NZCIT' - NZ Citizenship Certificate
    • +
  • 'BIRCE' - Birth Certificate (COK, TKL, NIU)
    • +
  • 'BCCON' - Birth Certificate (COK, TKL, NIU) (with confirmation of NZ Citizen by birth)
    • +
  • 'CENAT' - Certification of Naturalisation (COK, TKL, NIU)
    • +
  • 'CAREG' - Certification of Registration (COK, TKL, NIU)
    • +
  • 'LETCO' - Letter of Confirmation (COK, TKL, NIU)
    • +
  • 'OTHPA' - Other Passport with NZ residence class Visa
    • +
  • 'AUSPA' - Australian Passport
    • +
  • 'VISDO' - Visa Domestic
    • +
plus 3 more value(s) at NZCodeSetsVerificationSourceType + oneOf: + - title: NZ Birth Certificate + description: Applies if the child was + born before 1 Jan 2006 + enum: + - NZBIR + - title: NZ Birth Certificate (with + confirmation of NZ Citizen + by birth) + description: Applies if the child was + born on or after 1 Jan + 2006 + enum: + - NZBCO + - title: NZ Passport + description: Including COK, TKL or NIU. + (Current or Expired) + enum: + - NZPAS + - title: NZ Citizenship Certificate + enum: + - NZCIT + - title: Birth Certificate (COK, + TKL, NIU) + description: If the child was born + before 1 Jan 2006 + enum: + - BIRCE + - title: Birth Certificate (COK, + TKL, NIU) (with + confirmation of NZ Citizen + by birth) + description: Applies if the child was + born on or after 1 Jan + 2006. + enum: + - BCCON + - title: Certification of + Naturalisation (COK, TKL, + NIU) + enum: + - CENAT + - title: Certification of + Registration (COK, TKL, + NIU) + enum: + - CAREG + - title: Letter of Confirmation + (COK, TKL, NIU) + enum: + - LETCO + - title: Other Passport with NZ + residence class Visa + description: Or other evidence of NZ + residency + enum: + - OTHPA + - title: Australian Passport + description: (Current or Expired) + enum: + - AUSPA + - title: Visa Domestic + enum: + - VISDO + - title: Visa with conditions of + study + enum: + - VISST + - title: Principal Discretion + enum: + - PRINC + - title: MoE Approval + enum: + - MOEAP + DocumentSerialNumber: + type: string + description:

The serial number on the + document that was used to + verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the + document that was used to + verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification + has been confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took + place.

+ Provider: + description:

A reference to another SIF + Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentPersona\ + ls/get/responses/200/cont\ + ent/application~1json/sch\ + ema/properties/StudentPer\ + sonals/properties/Student\ + Personal/items/properties\ + /StudentPersonalRefId" + LocalId: + $ref: "#/paths/~1StudentPersona\ + ls/get/responses/200/cont\ + ent/application~1json/sch\ + ema/properties/StudentPer\ + sonals/properties/Student\ + Personal/items/properties\ + /StudentPersonalLocalId" + Name: + type: string + description:

The normal descriptive + name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid + SIF DataObject names, to + be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation + that operates within + the education sector; + but doesn’t provide + education services. + enum: + - Organisation + - title: Provider + description: A recognised provider + of education services + such as ECE Service, + School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised + relationship between + two providers of + education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined + course that Students + enrol in, and may be + assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or + other award granted by + a national body, + professional + association or other + interested party. The + Credential describes + an award that is made + to the learner at the + successful completion + of a particular + learning programme. + eg: NCEA Level 1; + University Entrance; + NCEA Level 2 + Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, + contact and + demographic + information relating + to a staff member, who + might be a teacher or + other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of + a Staff member to a + particular Role at a + Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the + personal information + related to the + student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the + personal information + about a person who is + a part of a Student's + whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between + a person who is a part + of a Student's whānau + and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s + association with an + education provider for + the purpose of + receiving educational + services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a + particular class or + other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about + the attendance spans + for a single student + at a single provider + during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information + about a particular + assignment or other + assessment task, to be + undertaken by one or + more Students at some + time. Defines the task + separately from each + student's attempting + the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's + registration for an + assessment task they + are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's + attempt at a + particular assessment + task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result + achieved by a single + student at a + particular assessment + task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student + gaining an Attainment + e.g. NCEA + Qualification, + Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the + outcome and follow ups + generated by a + WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a + student's interests + and academic, career + and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information + on a co-curricular or + extra-curricular + activity in which a + student participates + during a given school + year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information + pertaining to a + student's + participation in + learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress + and achievement + reports provided for a + student. Used in + technology centres the + host provider, to + report on student + progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + VerifiedName: + description:

The verified name of the person.

+ type: object + properties: + Verification: + description:

The verification event that verified + the person's name.

+ type: object + required: + - IsConfirmed + - Source + properties: + Source: + $ref: "#/paths/~1StudentPersonals/get/res\ + ponses/200/content/application~1jso\ + n/schema/properties/StudentPersonal\ + s/properties/StudentPersonal/items/\ + properties/PersonInfo/properties/Ot\ + herNameList/properties/Name/items/p\ + roperties/Verification/properties/S\ + ource" + DocumentSerialNumber: + type: string + description:

The serial number on the document + that was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document + that was used to verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has + been confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StudentPersonals/get/res\ + ponses/200/content/application~1jso\ + n/schema/properties/StudentPersonal\ + s/properties/StudentPersonal/items/\ + properties/PersonInfo/properties/Ot\ + herNameList/properties/Name/items/p\ + roperties/Verification/properties/P\ + rovider" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + Demographics: + description:

Details of the person’s demographic + properties

+ type: object + properties: + BirthDate: + type: string + format: date + description:

The person's date of birth.

+ DateOfDeath: + type: string + format: date + description:

The person's date of death.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + PlaceOfBirth: + type: string + description:

The person's place of birth - like + village, town, city etc.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + CountryOfBirth: + type: string + title: 3166 Country + description: >- +

A country is a geopolitical entity + recognised by the New Zealand + government. The term country may + include

  • Independent + countries recognised by the New Zealand + Government
  • Units that are + recognised geographic areas
    • +
  • administrative subdivisions of the + United Kingdom
  • overseas + dependencies, external territories of + independent countries.
+

Conforms to the International + Standard ISO 3166 Codes for the + Representation of Names of Countries and + their Subdivisions (ISO 3166-1:2013). + Education adopts the alpha-3 + representation of this standard.

+
    +
  • 'ABW' - Aruba
    • +
  • 'AFG' - Afghanistan
    • +
  • 'AGO' - Angola
    • +
  • 'AIA' - Anguilla
    • +
  • 'ALA' - Åland Islands
    • +
  • 'ALB' - Albania
    • +
  • 'AND' - Andorra
    • +
  • 'ARE' - United Arab Emirates
    • +
  • 'ARG' - Argentina
    • +
  • 'ARM' - Armenia
    • +
  • 'ASM' - American Samoa
    • +
  • 'ATA' - Antarctica
    • +
plus 237 more value(s) at ISO3166CountryType + oneOf: + - title: Aruba + enum: + - ABW + - title: Afghanistan + enum: + - AFG + - title: Angola + enum: + - AGO + - title: Anguilla + enum: + - AIA + - title: Åland Islands + enum: + - ALA + - title: Albania + enum: + - ALB + - title: Andorra + enum: + - AND + - title: United Arab Emirates + enum: + - ARE + - title: Argentina + enum: + - ARG + - title: Armenia + enum: + - ARM + - title: American Samoa + enum: + - ASM + - title: Antarctica + enum: + - ATA + - title: French Southern Territories + enum: + - ATF + - title: Antigua and Barbuda + enum: + - ATG + - title: Australia + enum: + - AUS + - title: Austria + enum: + - AUT + - title: Azerbaijan + enum: + - AZE + - title: Burundi + enum: + - BDI + - title: Belgium + enum: + - BEL + - title: Benin + enum: + - BEN + - title: Bonaire, Sint Eustatius and Saba + enum: + - BES + - title: Burkina Faso + enum: + - BFA + - title: Bangladesh + enum: + - BGD + - title: Bulgaria + enum: + - BGR + - title: Bahrain + enum: + - BHR + - title: Bahamas + enum: + - BHS + - title: Bosnia and Herzegovina + enum: + - BIH + - title: Saint Barthélemy + enum: + - BLM + - title: Belarus + enum: + - BLR + - title: Belize + enum: + - BLZ + - title: Bermuda + enum: + - BMU + - title: Bolivia, Plurinational State of + enum: + - BOL + - title: Brazil + enum: + - BRA + - title: Barbados + enum: + - BRB + - title: Brunei Darussalam + enum: + - BRN + - title: Bhutan + enum: + - BTN + - title: Bouvet Island + enum: + - BVT + - title: Botswana + enum: + - BWA + - title: Central African Republic + enum: + - CAF + - title: Canada + enum: + - CAN + - title: Cocos (Keeling) Islands + enum: + - CCK + - title: Switzerland + enum: + - CHE + - title: Chile + enum: + - CHL + - title: China + enum: + - CHN + - title: Côte d'Ivoire + enum: + - CIV + - title: Cameroon + enum: + - CMR + - title: Congo, the Democratic Republic of the + enum: + - COD + - title: Congo + enum: + - COG + - title: Cook Islands + enum: + - COK + - title: Colombia + enum: + - COL + - title: Comoros + enum: + - COM + - title: Cabo Verde + enum: + - CPV + - title: Costa Rica + enum: + - CRI + - title: Cuba + enum: + - CUB + - title: Curaçao + enum: + - CUW + - title: Christmas Island + enum: + - CXR + - title: Cayman Islands + enum: + - CYM + - title: Cyprus + enum: + - CYP + - title: Czechia + enum: + - CZE + - title: Germany + enum: + - DEU + - title: Djibouti + enum: + - DJI + - title: Dominica + enum: + - DMA + - title: Denmark + enum: + - DNK + - title: Dominican Republic + enum: + - DOM + - title: Algeria + enum: + - DZA + - title: Ecuador + enum: + - ECU + - title: Egypt + enum: + - EGY + - title: Eritrea + enum: + - ERI + - title: Western Sahara + enum: + - ESH + - title: Spain + enum: + - ESP + - title: Estonia + enum: + - EST + - title: Ethiopia + enum: + - ETH + - title: Finland + enum: + - FIN + - title: Fiji + enum: + - FJI + - title: Falkland Islands (Malvinas) + enum: + - FLK + - title: France + enum: + - FRA + - title: Faroe Islands + enum: + - FRO + - title: Micronesia, Federated States of + enum: + - FSM + - title: Gabon + enum: + - GAB + - title: United Kingdom + enum: + - GBR + - title: Georgia + enum: + - GEO + - title: Guernsey + enum: + - GGY + - title: Ghana + enum: + - GHA + - title: Gibraltar + enum: + - GIB + - title: Guinea + enum: + - GIN + - title: Guadeloupe + enum: + - GLP + - title: Gambia + enum: + - GMB + - title: Guinea-Bissau + enum: + - GNB + - title: Equatorial Guinea + enum: + - GNQ + - title: Greece + enum: + - GRC + - title: Grenada + enum: + - GRD + - title: Greenland + enum: + - GRL + - title: Guatemala + enum: + - GTM + - title: French Guiana + enum: + - GUF + - title: Guam + enum: + - GUM + - title: Guyana + enum: + - GUY + - title: Hong Kong + enum: + - HKG + - title: Heard Island and McDonald Islands + enum: + - HMD + - title: Honduras + enum: + - HND + - title: Croatia + enum: + - HRV + - title: Haiti + enum: + - HTI + - title: Hungary + enum: + - HUN + - title: Indonesia + enum: + - IDN + - title: Isle of Man + enum: + - IMN + - title: India + enum: + - IND + - title: British Indian Ocean Territory + enum: + - IOT + - title: Ireland + enum: + - IRL + - title: Iran, Islamic Republic of + enum: + - IRN + - title: Iraq + enum: + - IRQ + - title: Iceland + enum: + - ISL + - title: Israel + enum: + - ISR + - title: Italy + enum: + - ITA + - title: Jamaica + enum: + - JAM + - title: Jersey + enum: + - JEY + - title: Jordan + enum: + - JOR + - title: Japan + enum: + - JPN + - title: Kazakhstan + enum: + - KAZ + - title: Kenya + enum: + - KEN + - title: Kyrgyzstan + enum: + - KGZ + - title: Cambodia + enum: + - KHM + - title: Kiribati + enum: + - KIR + - title: Saint Kitts and Nevis + enum: + - KNA + - title: Korea, Republic of + enum: + - KOR + - title: Kuwait + enum: + - KWT + - title: Lao People's Democratic Republic + enum: + - LAO + - title: Lebanon + enum: + - LBN + - title: Liberia + enum: + - LBR + - title: Libya + enum: + - LBY + - title: Saint Lucia + enum: + - LCA + - title: Liechtenstein + enum: + - LIE + - title: Sri Lanka + enum: + - LKA + - title: Lesotho + enum: + - LSO + - title: Lithuania + enum: + - LTU + - title: Luxembourg + enum: + - LUX + - title: Latvia + enum: + - LVA + - title: Macao + enum: + - MAC + - title: Saint Martin (French part) + enum: + - MAF + - title: Morocco + enum: + - MAR + - title: Monaco + enum: + - MCO + - title: Moldova, Republic of + enum: + - MDA + - title: Madagascar + enum: + - MDG + - title: Maldives + enum: + - MDV + - title: Mexico + enum: + - MEX + - title: Marshall Islands + enum: + - MHL + - title: Macedonia, the former Yugoslav + Republic of + enum: + - MKD + - title: Mali + enum: + - MLI + - title: Malta + enum: + - MLT + - title: Myanmar + enum: + - MMR + - title: Montenegro + enum: + - MNE + - title: Mongolia + enum: + - MNG + - title: Northern Mariana Islands + enum: + - MNP + - title: Mozambique + enum: + - MOZ + - title: Mauritania + enum: + - MRT + - title: Montserrat + enum: + - MSR + - title: Martinique + enum: + - MTQ + - title: Mauritius + enum: + - MUS + - title: Malawi + enum: + - MWI + - title: Malaysia + enum: + - MYS + - title: Mayotte + enum: + - MYT + - title: Namibia + enum: + - NAM + - title: New Caledonia + enum: + - NCL + - title: Niger + enum: + - NER + - title: Norfolk Island + enum: + - NFK + - title: Nigeria + enum: + - NGA + - title: Nicaragua + enum: + - NIC + - title: Niue + enum: + - NIU + - title: Netherlands + enum: + - NLD + - title: Norway + enum: + - NOR + - title: Nepal + enum: + - NPL + - title: Nauru + enum: + - NRU + - title: New Zealand + enum: + - NZL + - title: Oman + enum: + - OMN + - title: Pakistan + enum: + - PAK + - title: Panama + enum: + - PAN + - title: Pitcairn + enum: + - PCN + - title: Peru + enum: + - PER + - title: Philippines + enum: + - PHL + - title: Palau + enum: + - PLW + - title: Papua New Guinea + enum: + - PNG + - title: Poland + enum: + - POL + - title: Puerto Rico + enum: + - PRI + - title: Korea, Democratic People's Republic + of + enum: + - PRK + - title: Portugal + enum: + - PRT + - title: Paraguay + enum: + - PRY + - title: Palestine, State of + enum: + - PSE + - title: French Polynesia + enum: + - PYF + - title: Qatar + enum: + - QAT + - title: Réunion + enum: + - REU + - title: Romania + enum: + - ROU + - title: Russian Federation + enum: + - RUS + - title: Rwanda + enum: + - RWA + - title: Saudi Arabia + enum: + - SAU + - title: Sudan + enum: + - SDN + - title: Senegal + enum: + - SEN + - title: Singapore + enum: + - SGP + - title: South Georgia and the South Sandwich + Islands + enum: + - SGS + - title: Saint Helena, Ascension and Tristan + da Cunha + enum: + - SHN + - title: Svalbard and Jan Mayen + enum: + - SJM + - title: Solomon Islands + enum: + - SLB + - title: Sierra Leone + enum: + - SLE + - title: El Salvador + enum: + - SLV + - title: San Marino + enum: + - SMR + - title: Somalia + enum: + - SOM + - title: Saint Pierre and Miquelon + enum: + - SPM + - title: Serbia + enum: + - SRB + - title: South Sudan + enum: + - SSD + - title: Sao Tome and Principe + enum: + - STP + - title: Suriname + enum: + - SUR + - title: Slovakia + enum: + - SVK + - title: Slovenia + enum: + - SVN + - title: Sweden + enum: + - SWE + - title: Swaziland + enum: + - SWZ + - title: Sint Maarten (Dutch part) + enum: + - SXM + - title: Seychelles + enum: + - SYC + - title: Syrian Arab Republic + enum: + - SYR + - title: Turks and Caicos Islands + enum: + - TCA + - title: Chad + enum: + - TCD + - title: Togo + enum: + - TGO + - title: Thailand + enum: + - THA + - title: Tajikistan + enum: + - TJK + - title: Tokelau + enum: + - TKL + - title: Turkmenistan + enum: + - TKM + - title: Timor-Leste + enum: + - TLS + - title: Tonga + enum: + - TON + - title: Trinidad and Tobago + enum: + - TTO + - title: Tunisia + enum: + - TUN + - title: Turkey + enum: + - TUR + - title: Tuvalu + enum: + - TUV + - title: Taiwan, Province of China + enum: + - TWN + - title: Tanzania, United Republic of + enum: + - TZA + - title: Uganda + enum: + - UGA + - title: Ukraine + enum: + - UKR + - title: United States Minor Outlying Islands + enum: + - UMI + - title: Uruguay + enum: + - URY + - title: United States of America + enum: + - USA + - title: Uzbekistan + enum: + - UZB + - title: Holy See + enum: + - VAT + - title: Saint Vincent and the Grenadines + enum: + - VCT + - title: Venezuela, Bolivarian Republic of + enum: + - VEN + - title: Virgin Islands, British + enum: + - VGB + - title: Virgin Islands, U.S. + enum: + - VIR + - title: Viet Nam + enum: + - VNM + - title: Vanuatu + enum: + - VUT + - title: Wallis and Futuna + enum: + - WLF + - title: Samoa + enum: + - WSM + - title: Yemen + enum: + - YEM + - title: South Africa + enum: + - ZAF + - title: Zambia + enum: + - ZMB + - title: Zimbabwe + enum: + - ZWE + CitizenshipList: + type: object + required: + - Country + properties: + Country: + type: array + items: + $ref: "#/paths/~1StudentPersonals/get/r\ + esponses/200/content/application~\ + 1json/schema/properties/StudentPe\ + rsonals/properties/StudentPersona\ + l/items/properties/PersonInfo/pro\ + perties/Demographics/properties/C\ + ountryOfBirth" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + CitizenshipStatus: + type: string + title: Citizenship Status + description: >- +

The citizenship or residency status + of a person, principally recorded in + order to determine eligibility for + education services hence limited to + indicating New Zealand, Australian or + Other residency.

Based on SIF + Australia + AUCodeSetsAustralianCitizenshipStatusType

+
    +
  • 'AUCI' - Australian citizen
    • +
  • 'NZCI' - NZ citizen
    • +
  • 'OTOV' - Other overseas
    • +
  • 'NZRE' - NZ resident
    • +
  • 'NOPR' - Not provided
    • +
+ oneOf: + - title: Australian citizen + enum: + - AUCI + - title: NZ citizen + enum: + - NZCI + - title: Other overseas + description: Indicates a residency other than NZ + or Australia + enum: + - OTOV + - title: NZ resident + description: Includes Australian residents + classified as NZ resident once + arrived in NZ + enum: + - NZRE + - title: Not provided + enum: + - NOPR + CitizenshipVerification: + description:

The verification event that verified + the residency status of the person. + Absence of a verification event + indicates that the residency was not + verified against an identity document. +

+ type: object + required: + - IsConfirmed + - Source + properties: + Source: + $ref: "#/paths/~1StudentPersonals/get/res\ + ponses/200/content/application~1jso\ + n/schema/properties/StudentPersonal\ + s/properties/StudentPersonal/items/\ + properties/PersonInfo/properties/Ot\ + herNameList/properties/Name/items/p\ + roperties/Verification/properties/S\ + ource" + DocumentSerialNumber: + type: string + description:

The serial number on the document + that was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document + that was used to verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has + been confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StudentPersonals/get/res\ + ponses/200/content/application~1jso\ + n/schema/properties/StudentPersonal\ + s/properties/StudentPersonal/items/\ + properties/PersonInfo/properties/Ot\ + herNameList/properties/Name/items/p\ + roperties/Verification/properties/P\ + rovider" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + Gender: + type: string + title: Gender + description: >- +

A Person may identify as having a + Gender (or Gender Identity). Biological + sex and sexual orientation are related + but different concepts. Sourced from + Statistics NZ Standard for Gender + Identity

    +
  • '1' - Male - Tāne
    • +
  • '2' - Female - Wahine
    • +
  • '3' - Gender Diverse - Ira tāngata kōwhiri kore
    • +
  • '31' - Transgender Male to Female - Whakawahine
    • +
  • '32' - Transgender Female to Male - Tangata ira tāne
    • +
  • '9' - Not Willing to Disclose
    • +
+ oneOf: + - title*: + en: Male + mi: Tāne + enum: + - "1" + - title*: + en: Female + mi: Wahine + enum: + - "2" + - title*: + en: Gender Diverse + mi: Ira tāngata kōwhiri kore + description: But not further defined + enum: + - "3" + - title*: + en: Transgender Male to Female + mi: Whakawahine + description: '"Can be rolled up to 3:Gender + Diverse"' + enum: + - "31" + - title*: + en: Transgender Female to Male + mi: Tangata ira tāne + description: '"Can be rolled up to 3:Gender + Diverse"' + enum: + - "32" + - title*: + en: Not Willing to Disclose + enum: + - "9" + LanguageList: + description: List of languages an individual uses to + communicate. + type: object + required: + - Language + properties: + Language: + type: array + items: + description:

A language that an individual + uses to communicate.

+ type: object + required: + - Code + properties: + Code: + type: string + title: Language + description: >- +

Language refers to + recognised human communication + systems, typically oral and/or + written. Sourced from + Statistics NZ - Language + Standard Classification 1999 + v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not further + defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not + elsewhere classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not further + defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not + elsewhere classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere + classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere + classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere + classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further + defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere + classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere + classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere + classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further + defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not elsewhere + classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere + classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further + defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere + classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere + classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not + further defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not + elsewhere classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further + defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere + classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further + defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere + classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further + defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere + classified + enum: + - NZS15199 + - title: Central-Eastern + Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not + further defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not + elsewhere classified + enum: + - NZS16199 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further + defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not elsewhere + classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western Malayo-Polynesian + not further defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western Malayo-Polynesian + not elsewhere classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further + defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere + classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere + classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere + classified + enum: + - NZS18399 + - title: Niger-Congo + (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere + classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not + further defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not + elsewhere classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not + further defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not + elsewhere classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not + elsewhere classified + enum: + - NZS219 + - title: Language Isolates not + elsewhere classified + enum: + - NZS21999 + - title: Miscellaneous Language + Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further + defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere + classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous + Languages + enum: + - NZS229 + - title: Other Miscellaneous + Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not + further defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not + elsewhere classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not further + defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not + elsewhere classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + Usage: + type: string + title: Language Usage + description: >- +

A standardised method of + describing the usage of a + language by a person, + potentially indicating + capability and preference for + the language.

    +
  • 'FL' - First Language
    • +
  • 'SL' - Secondary Language
    • +
  • 'SH' - Spoken At Home
    • +
+ oneOf: + - title: First Language + enum: + - FL + - title: Secondary Language + enum: + - SL + - title: Spoken At Home + enum: + - SH + Dialect: + type: string + description:

Specific dialect of a + person's language.

+ ProficiencyList: + description:

A list of the person's + proficiency in the language in + regards to speaking, reading + and writing.

+ type: object + required: + - Proficiency + properties: + Proficiency: + type: array + items: + description:

The person's + proficiency in the + language in regards to + speaking, reading and + writing.

+ type: object + required: + - Level + - Type + properties: + Level: + type: string + title: Language Proficiency + Level + description: >- +

The language + proficiency + level.

    +
  • 'NO' - None
    • +
  • 'BE' - Beginner
    • +
  • 'IN' - Intermediate
    • +
  • 'AD' - Advanced
    • +
+ oneOf: + - title: None + enum: + - NO + - title: Beginner + enum: + - BE + - title: Intermediate + enum: + - IN + - title: Advanced + enum: + - AD + Type: + type: string + title: Language Proficiency + Type + description: >- +

Code set denoting + a type of language + proficiency, e.g. + speaking, writing + reading.

    +
  • 'SP' - Speaking
    • +
  • 'RE' - Reading
    • +
  • 'WR' - Writing
    • +
+ oneOf: + - title: Speaking + enum: + - SP + - title: Reading + enum: + - RE + - title: Writing + enum: + - WR + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + CountryArrivalDate: + type: string + format: date + description: Date the person first arrived in the + country. + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + EthnicityList: + description:

One or more ethnic groups with which + the person identifies.

+ type: object + required: + - Ethnicity + properties: + Ethnicity: + type: array + items: + description:

An ethnic group with which the + person identifies, and if there is + more than one, their order of + preference.

+ type: object + required: + - Code + properties: + PreferenceOrderNumber: + type: integer + description:

The order of preference for + the person's ethnicity.

+ Code: + type: string + title: Ethnicity + description: >- +

Ethnicity is the ethnic + group or groups that people + identify with or feel they + belong to. Ethnicity is a + measure of cultural + affiliation, as opposed to + race, ancestry, nationality or + citizenship. Ethnicity is self + perceived and people can + belong to more than one ethnic + group.

The permissible + values consists of any value + from the Statistics NZ - + Ethnicity New Zealand Standard + Classification 2005 v2.0.0 + Depending on usage, ethnicity + may be defined at levels 1 to + 4.

    +
  • '1' - European
    • +
  • '10' - European nfd
    • +
  • '100' - European nfd
    • +
  • '10000' - European nfd
    • +
  • '11' - New Zealand European
    • +
  • '111' - New Zealand European
    • +
  • '11111' - New Zealand European
    • +
  • '12' - Other European
    • +
  • '121' - British and Irish
    • +
  • '12100' - British nfd
    • +
  • '12111' - Celtic nfd
    • +
  • '12112' - Channel Islander
    • +
plus 250 more value(s) at NZCodeSetsEthnicityType + oneOf: + - title: European + enum: + - "1" + - title: European nfd + enum: + - "10" + - title: European nfd + enum: + - "100" + - title: European nfd + enum: + - "10000" + - title: New Zealand European + enum: + - "11" + - title: New Zealand European + enum: + - "111" + - title: New Zealand European + enum: + - "11111" + - title: Other European + enum: + - "12" + - title: British and Irish + enum: + - "121" + - title: British nfd + enum: + - "12100" + - title: Celtic nfd + enum: + - "12111" + - title: Channel Islander + enum: + - "12112" + - title: Cornish + enum: + - "12113" + - title: English + enum: + - "12114" + - title: Irish + enum: + - "12116" + - title: Manx + enum: + - "12117" + - title: Scottish + enum: + - "12119" + - title: Welsh + enum: + - "12121" + - title: British nec + enum: + - "12199" + - title: Dutch + enum: + - "122" + - title: Dutch + enum: + - "12211" + - title: Greek + enum: + - "123" + - title: Greek + enum: + - "12311" + - title: Polish + enum: + - "124" + - title: Polish + enum: + - "12411" + - title: South Slav + enum: + - "125" + - title: South Slav nfd + enum: + - "12500" + - title: Croatian + enum: + - "12511" + - title: Dalmatian + enum: + - "12512" + - title: Macedonian + enum: + - "12513" + - title: Serbian + enum: + - "12514" + - title: Slovenian + enum: + - "12515" + - title: Bosnian + enum: + - "12516" + - title: South Slav nec + enum: + - "12599" + - title: Italian + enum: + - "126" + - title: Italian + enum: + - "12611" + - title: German + enum: + - "127" + - title: German + enum: + - "12711" + - title: Australian + enum: + - "128" + - title: Australian + enum: + - "12811" + - title: Other European + enum: + - "129" + - title: Albanian + enum: + - "12911" + - title: Armenian + enum: + - "12912" + - title: Austrian + enum: + - "12913" + - title: Belgian + enum: + - "12914" + - title: Bulgarian + enum: + - "12915" + - title: Belorussian + enum: + - "12916" + - title: Cypriot nfd + enum: + - "12918" + - title: Czech + enum: + - "12919" + - title: Danish + enum: + - "12920" + - title: Estonian + enum: + - "12921" + - title: Finnish + enum: + - "12922" + - title: Flemish + enum: + - "12923" + - title: French + enum: + - "12924" + - title: Hungarian + enum: + - "12926" + - title: Icelandic + enum: + - "12927" + - title: Latvian + enum: + - "12928" + - title: Lithuanian + enum: + - "12929" + - title: Maltese + enum: + - "12930" + - title: Norwegian + enum: + - "12931" + - title: Portuguese + enum: + - "12932" + - title: Romanian + enum: + - "12933" + - title: Gypsy + enum: + - "12934" + - title: Russian + enum: + - "12935" + - title: Slavic + enum: + - "12937" + - title: Slovak + enum: + - "12938" + - title: Spanish + enum: + - "12939" + - title: Swedish + enum: + - "12940" + - title: Swiss + enum: + - "12941" + - title: Ukrainian + enum: + - "12942" + - title: American + enum: + - "12943" + - title: Canadian + enum: + - "12945" + - title: New Caledonian + enum: + - "12947" + - title: South African European + enum: + - "12948" + - title: Afrikaner + enum: + - "12949" + - title: Zimbabwean European + enum: + - "12950" + - title: European nec + enum: + - "12999" + - title: Māori + enum: + - "2" + - title: Māori + enum: + - "21" + - title: Māori + enum: + - "211" + - title: Māori + enum: + - "21111" + - title: Pacific Peoples + enum: + - "3" + - title: Pacific Peoples nfd + enum: + - "30" + - title: Pacific Peoples nfd + enum: + - "300" + - title: Pacific Peoples nfd + enum: + - "30000" + - title: Samoan + enum: + - "31" + - title: Samoan + enum: + - "311" + - title: Samoan + enum: + - "31111" + - title: Cook Islands Maori + enum: + - "32" + - title: Cook Islands Maori + enum: + - "321" + - title: Cook Islands Maori + enum: + - "32100" + - title: Tongan + enum: + - "33" + - title: Tongan + enum: + - "331" + - title: Tongan + enum: + - "33111" + - title: Niuean + enum: + - "34" + - title: Niuean + enum: + - "341" + - title: Niuean + enum: + - "34111" + - title: Tokelauan + enum: + - "35" + - title: Tokelauan + enum: + - "351" + - title: Tokelauan + enum: + - "35111" + - title: Fijian + enum: + - "36" + - title: Fijian + enum: + - "361" + - title: Fijian + enum: + - "36111" + - title: Other Pacific Peoples + enum: + - "37" + - title: Other Pacific Peoples + enum: + - "371" + - title: Indigenous Australian + enum: + - "37112" + - title: Hawaiian + enum: + - "37122" + - title: Kiribati + enum: + - "37124" + - title: Nauruan + enum: + - "37130" + - title: Papua New Guinean + enum: + - "37135" + - title: Pitcairn Islander + enum: + - "37137" + - title: Rotuman + enum: + - "37138" + - title: Tahitian + enum: + - "37140" + - title: Solomon Islander + enum: + - "37141" + - title: Tuvaluan + enum: + - "37144" + - title: Ni Vanuatu + enum: + - "37145" + - title: Pacific Peoples nec + enum: + - "37199" + - title: Asian + enum: + - "4" + - title: Asian nfd + enum: + - "40" + - title: Asian nfd + enum: + - "400" + - title: Asian nfd + enum: + - "40000" + - title: South East Asian + enum: + - "41" + - title: South East Asian nfd + enum: + - "410" + - title: South East Asian nfd + enum: + - "41000" + - title: Filipino + enum: + - "411" + - title: Filipino + enum: + - "41111" + - title: Cambodian + enum: + - "412" + - title: Cambodian + enum: + - "41211" + - title: Vietnamese + enum: + - "413" + - title: Vietnamese + enum: + - "41311" + - title: Other Southeast Asian + enum: + - "414" + - title: Burmese + enum: + - "41411" + - title: Indonesian + enum: + - "41412" + - title: Lao + enum: + - "41413" + - title: Malay + enum: + - "41414" + - title: Thai + enum: + - "41415" + - title: Karen + enum: + - "41416" + - title: Chin + enum: + - "41417" + - title: Southeast Asian nec + enum: + - "41499" + - title: Chinese + enum: + - "42" + - title: Chinese + enum: + - "421" + - title: Chinese nfd + enum: + - "42100" + - title: Hong Kong Chinese + enum: + - "42111" + - title: Cambodian Chinese + enum: + - "42112" + - title: Malaysian Chinese + enum: + - "42113" + - title: Singaporean Chinese + enum: + - "42114" + - title: Vietnamese Chinese + enum: + - "42115" + - title: Taiwanese + enum: + - "42116" + - title: Chinese nec + enum: + - "42199" + - title: Indian + enum: + - "43" + - title: Indian + enum: + - "431" + - title: Indian nfd + enum: + - "43100" + - title: Bengali + enum: + - "43111" + - title: Fijian Indian + enum: + - "43112" + - title: Indian Tamil + enum: + - "43114" + - title: Punjabi + enum: + - "43115" + - title: Sikh + enum: + - "43116" + - title: Anglo Indian + enum: + - "43117" + - title: Malaysian Indian + enum: + - "43118" + - title: South African Indian + enum: + - "43119" + - title: Indian nec + enum: + - "43199" + - title: Other Asian + enum: + - "44" + - title: Sri Lankan + enum: + - "441" + - title: Sri Lankan nfd + enum: + - "44100" + - title: Sinhalese + enum: + - "44111" + - title: Sri Lankan Tamil + enum: + - "44112" + - title: Sri Lankan nec + enum: + - "44199" + - title: Japanese + enum: + - "442" + - title: Japanese + enum: + - "44211" + - title: Korean + enum: + - "443" + - title: Korean + enum: + - "44311" + - title: Other Asian + enum: + - "444" + - title: Afghani + enum: + - "44411" + - title: Bangladeshi + enum: + - "44412" + - title: Nepalese + enum: + - "44413" + - title: Pakistani + enum: + - "44414" + - title: Tibetan + enum: + - "44415" + - title: Eurasian + enum: + - "44416" + - title: Bhutanese + enum: + - "44417" + - title: Maldivian + enum: + - "44418" + - title: Mongolian + enum: + - "44419" + - title: Asian nec + enum: + - "44499" + - title: Middle Eastern/Latin + American/African + enum: + - "5" + - title: Middle Eastern + enum: + - "51" + - title: Middle Eastern + enum: + - "511" + - title: Middle Eastern nfd + enum: + - "51100" + - title: Algerian + enum: + - "51111" + - title: Arab + enum: + - "51112" + - title: Assyrian + enum: + - "51113" + - title: Egyptian + enum: + - "51114" + - title: Iranian/Persian + enum: + - "51115" + - title: Iraqi + enum: + - "51116" + - title: Israeli/Jewish + enum: + - "51117" + - title: Jordanian + enum: + - "51118" + - title: Kurd + enum: + - "51119" + - title: Lebanese + enum: + - "51120" + - title: Moroccan + enum: + - "51122" + - title: Palestinian + enum: + - "51124" + - title: Syrian + enum: + - "51125" + - title: Turkish + enum: + - "51127" + - title: Middle Eastern nec + enum: + - "51199" + - title: Latin American + enum: + - "52" + - title: Latin American + enum: + - "521" + - title: Latin American nfd + enum: + - "52100" + - title: Argentinian + enum: + - "52111" + - title: Bolivian + enum: + - "52112" + - title: Brazilian + enum: + - "52113" + - title: Chilean + enum: + - "52114" + - title: Colombian + enum: + - "52115" + - title: Ecuadorian + enum: + - "52118" + - title: Mexican + enum: + - "52123" + - title: Peruvian + enum: + - "52127" + - title: Puerto Rican + enum: + - "52128" + - title: Uruguayan + enum: + - "52129" + - title: Venezuelan + enum: + - "52130" + - title: Latin American nec + enum: + - "52199" + - title: African + enum: + - "53" + - title: African + enum: + - "531" + - title: African nfd + enum: + - "53100" + - title: Jamaican + enum: + - "53113" + - title: Kenyan + enum: + - "53114" + - title: Nigerian + enum: + - "53115" + - title: African American + enum: + - "53116" + - title: Caribbean + enum: + - "53118" + - title: Somali + enum: + - "53119" + - title: Eritrean + enum: + - "53120" + - title: Ethiopian + enum: + - "53121" + - title: Ghanaian + enum: + - "53122" + - title: Burundian + enum: + - "53123" + - title: Congolese + enum: + - "53124" + - title: Sudanese + enum: + - "53125" + - title: Zambian + enum: + - "53126" + - title: Other Zimbabwean + enum: + - "53127" + - title: African nec + enum: + - "53199" + - title: Other Ethnicity + enum: + - "6" + - title: Other Ethnicity + enum: + - "61" + - title: Other Ethnicity + enum: + - "611" + - title: Indigenous American + enum: + - "61113" + - title: Mauritian + enum: + - "61115" + - title: Seychellois + enum: + - "61116" + - title: Other South African + enum: + - "61117" + - title: New Zealander + enum: + - "61118" + - title: Other Ethnicity nec + enum: + - "61199" + - title: Residual Categories + enum: + - "9" + - title: Don't Know + enum: + - "94" + - title: Don't Know + enum: + - "944" + - title: Don't Know + enum: + - "94444" + - title: Refused to Answer + enum: + - "95" + - title: Refused to Answer + enum: + - "955" + - title: Refused to Answer + enum: + - "95555" + - title: Repeated Value + enum: + - "96" + - title: Repeated Value + enum: + - "966" + - title: Repeated Value + enum: + - "96666" + - title: Response Unidentifiable + enum: + - "97" + - title: Response Unidentifiable + enum: + - "977" + - title: Response Unidentifiable + enum: + - "97777" + - title: Response Outside Scope + enum: + - "98" + - title: Response Outside Scope + enum: + - "988" + - title: Response Outside Scope + enum: + - "98888" + - title: Not Stated + enum: + - "99" + - title: Not Stated + enum: + - "999" + - title: Not Stated + enum: + - "99999" + IwiAffiliationList: + description:

A list of one or more iwi with which + the person has an affiliation.

+ type: object + required: + - IwiAffiliation + properties: + IwiAffiliation: + type: array + items: + type: string + title: Iwi + description: >- +

An iwi, or Māori tribe, is one + of the largest kinship groupings + and is generally made up of + several hapū that are all + descended from a common ancestor. + Hapū are clusters of whānau where + the whānau is usually an extended + family grouping consisting of + children, parents, often + grandparents, and other closely + related kin.

Sourced from + Statistics NZ - Iwi and Iwi + related groups statistical + standard v1.0.0.0

    +
  • 'NZS01' - Te Tai Tokerau/Tāmaki-makaurau (Northland/Auckland) Region Iwi
    • +
  • 'NZS0101' - Te Aupōuri
    • +
  • 'NZS0102' - Ngāti Kahu
    • +
  • 'NZS0103' - Ngāti Kurī
    • +
  • 'NZS0104' - Ngāpuhi
    • +
  • 'NZS0105' - Ngāpuhi ki Whaingaroa-Ngāti Kahu ki Whaingaroa
    • +
  • 'NZS0106' - Te Rarawa
    • +
  • 'NZS0107' - Ngāi Takoto
    • +
  • 'NZS0108' - Ngāti Wai
    • +
  • 'NZS0109' - Ngāti Whātua (not Ōrākei or Kaipara)
    • +
  • 'NZS0110' - Te Kawerau ā Maki
    • +
  • 'NZS0111' - Te Uri-o-Hau
    • +
plus 183 more value(s) at NZCodeSetsIwiType + oneOf: + - title: Te Tai Tokerau/Tāmaki-makaurau + (Northland/Auckland) Region + Iwi + enum: + - NZS01 + - title: Te Aupōuri + enum: + - NZS0101 + - title: Ngāti Kahu + enum: + - NZS0102 + - title: Ngāti Kurī + enum: + - NZS0103 + - title: Ngāpuhi + enum: + - NZS0104 + - title: Ngāpuhi ki Whaingaroa-Ngāti + Kahu ki Whaingaroa + enum: + - NZS0105 + - title: Te Rarawa + enum: + - NZS0106 + - title: Ngāi Takoto + enum: + - NZS0107 + - title: Ngāti Wai + enum: + - NZS0108 + - title: Ngāti Whātua (not Ōrākei or + Kaipara) + enum: + - NZS0109 + - title: Te Kawerau ā Maki + enum: + - NZS0110 + - title: Te Uri-o-Hau + enum: + - NZS0111 + - title: Te Roroa + enum: + - NZS0112 + - title: Ngāti Whātua o Kaipara + enum: + - NZS0113 + - title: Ngāti Whātua o Ōrākei + enum: + - NZS0114 + - title: Ngāi Tai ki Tāmaki + enum: + - NZS0115 + - title: Ngāti Hine (Te Tai Tokerau) + enum: + - NZS0116 + - title: Te Paatu + enum: + - NZS0117 + - title: Ngāti Manuhiri + enum: + - NZS0118 + - title: Ngāti Rēhua + enum: + - NZS0119 + - title: Hauraki (Coromandel) Region Iwi + enum: + - NZS02 + - title: Ngāti Hako + enum: + - NZS0201 + - title: Ngāti Hei + enum: + - NZS0202 + - title: Ngāti Maru (Hauraki) + enum: + - NZS0203 + - title: Ngāti Paoa + enum: + - NZS0204 + - title: Patukirikiri + enum: + - NZS0205 + - title: Ngāti Porou ki Harataunga ki + Mataora + enum: + - NZS0206 + - title: Ngāti Pūkenga ki Waiau + enum: + - NZS0207 + - title: Ngāti Rāhiri Tumutumu + enum: + - NZS0208 + - title: Ngāti Tamaterā + enum: + - NZS0210 + - title: Ngāti Tara Tokanui + enum: + - NZS0211 + - title: Ngāti Whanaunga + enum: + - NZS0212 + - title: Waikato/Te Rohe Pōtae + (Waikato/King Country) Region + Iwi + enum: + - NZS03 + - title: Ngāti Haua (Waikato) + enum: + - NZS0301 + - title: Ngāti Maniapoto + enum: + - NZS0302 + - title: Raukawa (Waikato) + enum: + - NZS0303 + - title: Waikato + enum: + - NZS0304 + - title: Ngāti Te Ata + enum: + - NZS0305 + - title: Ngāti Hīkairo + enum: + - NZS0306 + - title: Rereahu + enum: + - NZS0307 + - title: Ngāti Tiipa + enum: + - NZS0308 + - title: Ngāti Korokī Kahukura + enum: + - NZS0309 + - title: Ngāti Tamaoho + enum: + - NZS0310 + - title: Te Ākitai-Waiohua + enum: + - NZS0311 + - title: Te Arawa/Taupō (Rotorua/Taupō) + Region Iwi + enum: + - NZS04 + - title: Ngāti Pikiao (Te Arawa) + enum: + - NZS0401 + - title: Ngāti Rangiteaorere (Te Arawa) + enum: + - NZS0402 + - title: Ngāti Rangitihi (Te Arawa) + enum: + - NZS0403 + - title: Ngāti Rangiwewehi (Te Arawa) + enum: + - NZS0404 + - title: Tapuika (Te Arawa) + enum: + - NZS0405 + - title: Ngāti Tarāwhai (Te Arawa) + enum: + - NZS0406 + - title: Tūhourangi (Te Arawa) + enum: + - NZS0407 + - title: Uenuku-Kōpako (Te Arawa) + enum: + - NZS0408 + - title: Waitaha (Te Arawa) + enum: + - NZS0409 + - title: Ngāti Whakaue (Te Arawa) + enum: + - NZS0410 + - title: Ngāti Tūwharetoa (ki Taupō) + enum: + - NZS0411 + - title: Ngāti Tahu-Ngāti Whaoa (Te + Arawa) + enum: + - NZS0412 + - title: Ngāti Mākino + enum: + - NZS0413 + - title: Ngāti Kearoa / Ngāti Tuarā + enum: + - NZS0414 + - title: Ngāti Rongomai (Te Arawa) + enum: + - NZS0415 + - title: Tauranga Moana/Mātaatua (Bay + of Plenty) Region Iwi + enum: + - NZS05 + - title: Ngāti Pūkenga + enum: + - NZS0501 + - title: Ngāi Te Rangi + enum: + - NZS0502 + - title: Ngāti Ranginui + enum: + - NZS0503 + - title: Ngāti Awa + enum: + - NZS0504 + - title: Ngāti Manawa + enum: + - NZS0505 + - title: Ngāi Tai (Tauranga + Moana/Mātaatua) + enum: + - NZS0506 + - title: Tūhoe + enum: + - NZS0507 + - title: Whakatōhea + enum: + - NZS0508 + - title: Te Whānau-ā-Apanui + enum: + - NZS0509 + - title: Ngāti Whare + enum: + - NZS0510 + - title: Ngā Pōtiki ā Tamapahore + enum: + - NZS0511 + - title: Te Upokorehe + enum: + - NZS0512 + - title: Ngāti Tūwharetoa ki Kawerau + enum: + - NZS0513 + - title: Te Tai Rāwhiti (East Coast) + Region Iwi + enum: + - NZS06 + - title: Ngāti Porou + enum: + - NZS0601 + - title: Te Aitanga-a-Māhaki + enum: + - NZS0602 + - title: Rongowhakaata + enum: + - NZS0603 + - title: Ngāi Tāmanuhiri + enum: + - NZS0604 + - title: Te Aitanga ā Hauiti + enum: + - NZS0605 + - title: Te Matau-a-Māui/Wairarapa + (Hawke's Bay/Wairarapa) Region + Iwi + enum: + - NZS07 + - title: Rongomaiwahine (Te Māhia) + enum: + - NZS0701 + - title: Ngāti Kahungunu ki Te Wairoa + enum: + - NZS0702 + - title: Ngāti Kahungunu ki Heretaunga + enum: + - NZS0703 + - title: Ngāti Kahungunu ki Wairarapa + enum: + - NZS0704 + - title: Rangitāne (Te + Matau-a-Māui/Hawke's + Bay/Wairarapa) + enum: + - NZS0706 + - title: Ngāti Kahungunu ki Te + Whanganui-a-Orotu + enum: + - NZS0707 + - title: Ngāti Kahungunu ki Tamatea + enum: + - NZS0708 + - title: Ngāti Kahungunu ki Tamakinui a + Rua + enum: + - NZS0709 + - title: Ngāti Pāhauwera + enum: + - NZS0710 + - title: Ngāti Rākaipaaka + enum: + - NZS0711 + - title: Ngāti Hineuru + enum: + - NZS0712 + - title: Maungaharuru Tangitū + enum: + - NZS0713 + - title: Rangitāne o Tamaki nui ā Rua + enum: + - NZS0714 + - title: Ngāti Ruapani ki Waikaremoana + enum: + - NZS0715 + - title: Te Hika o Pāpāuma + enum: + - NZS0716 + - title: Taranaki Region Iwi + enum: + - NZS08 + - title: Te Atiawa (Taranaki) + enum: + - NZS0801 + - title: Ngāti Maru (Taranaki) + enum: + - NZS0802 + - title: Ngāti Mutunga (Taranaki) + enum: + - NZS0803 + - title: Ngā Rauru + enum: + - NZS0804 + - title: Ngā Ruahine + enum: + - NZS0805 + - title: Ngāti Ruanui + enum: + - NZS0806 + - title: Ngāti Tama (Taranaki) + enum: + - NZS0807 + - title: Taranaki + enum: + - NZS0808 + - title: Tangāhoe + enum: + - NZS0809 + - title: Pakakohi + enum: + - NZS0810 + - title: Whanganui/Rangitīkei + (Wanganui/Rangitīkei) Region + Iwi + enum: + - NZS09 + - title: Ngāti Apa (Rangitīkei) + enum: + - NZS0901 + - title: Te Ati Haunui-a-Pāpārangi + enum: + - NZS0902 + - title: Ngāti Haua (Taumarunui) + enum: + - NZS0903 + - title: Ngāti Hauiti (Rangitīkei) + enum: + - NZS0904 + - title: Ngāti Whitikaupeka (Rangitīkei) + enum: + - NZS0905 + - title: Ngāi Te Ohuake (Rangitīkei) + enum: + - NZS0906 + - title: Ngāti Tamakōpiri (Rangitīkei) + enum: + - NZS0907 + - title: Ngāti Rangi (Ruapehu, + Whanganui) + enum: + - NZS0908 + - title: Uenuku (Ruapehu, Waimarino) + enum: + - NZS0909 + - title: Tamahaki (Ruapehu, Waimarino) + enum: + - NZS0910 + - title: Tamakana (Ruapehu, Waimarino) + enum: + - NZS0911 + - title: Manawatū/Horowhenua/Te + Whanganui-a-Tara + (Manawatū/Horowhenua/Wellington) + Region Iwi + enum: + - NZS10 + - title: Te Atiawa (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1001 + - title: Muaūpoko + enum: + - NZS1002 + - title: Rangitāne (Manawatū) + enum: + - NZS1003 + - title: Ngāti Raukawa + (Horowhenua/Manawatū) + enum: + - NZS1004 + - title: Ngāti Toarangatira (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1005 + - title: Te Atiawa ki Whakarongotai + enum: + - NZS1006 + - title: Ngāti Tama ki Te Upoko o Te + Ika (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1007 + - title: Ngāti Kauwhata + enum: + - NZS1008 + - title: Ngāti Tukorehe + enum: + - NZS1009 + - title: Te Waipounamu/Wharekauri + (South Island/Chatham Islands) + Region Iwi + enum: + - NZS11 + - title: Te Atiawa (Te Waipounamu/South + Island) + enum: + - NZS1101 + - title: Ngāti Koata + enum: + - NZS1102 + - title: Ngāti Kuia + enum: + - NZS1103 + - title: Kāti Māmoe + enum: + - NZS1104 + - title: Moriori + enum: + - NZS1105 + - title: Ngāti Mutunga + (Wharekauri/Chatham Islands) + enum: + - NZS1106 + - title: Rangitāne (Te Waipounamu/South + Island) + enum: + - NZS1107 + - title: Ngāti Rārua + enum: + - NZS1108 + - title: Ngāi Tahu / Kāi Tahu + enum: + - NZS1109 + - title: Ngāti Tama (Te + Waipounamu/South Island) + enum: + - NZS1110 + - title: Ngāti Toarangatira (Te + Waipounamu/South Island) + enum: + - NZS1111 + - title: Waitaha (Te Waipounamu/South + Island) + enum: + - NZS1112 + - title: Ngāti Apa ki Te Rā Tō + enum: + - NZS1113 + - title: Confederations and Waka, iwi + not named + enum: + - NZS20 + - title: Tainui, iwi not named + enum: + - NZS2001 + - title: Te Arawa, iwi not named + enum: + - NZS2002 + - title: Tākitimu, iwi not named + enum: + - NZS2003 + - title: Aotea, iwi not named + enum: + - NZS2004 + - title: Mātaatua, iwi not named + enum: + - NZS2005 + - title: Mahuru, iwi not named + enum: + - NZS2006 + - title: Māmari, iwi not named + enum: + - NZS2007 + - title: Ngātokimatawhaorua, iwi not + named + enum: + - NZS2008 + - title: Nukutere, iwi not named + enum: + - NZS2009 + - title: Tokomaru, iwi not named + enum: + - NZS2010 + - title: Kurahaupō, iwi not named + enum: + - NZS2011 + - title: Muriwhenua, iwi not named + enum: + - NZS2012 + - title: Hauraki / Pare Hauraki, iwi + not named + enum: + - NZS2013 + - title: Tūranganui a Kiwa, iwi not + named + enum: + - NZS2014 + - title: Te Tauihu o Te Waka a Māui, + iwi not named + enum: + - NZS2015 + - title: Tauranga Moana, iwi not named + enum: + - NZS2016 + - title: Horouta, iwi not named + enum: + - NZS2017 + - title: Mōkai Pātea, iwi not named + enum: + - NZS2018 + - title: Iwi named, region not known + enum: + - NZS21 + - title: Te Atiawa, region not known + enum: + - NZS2101 + - title: Ngāti Haua, region not known + enum: + - NZS2102 + - title: Ngāti Maru, region not known + enum: + - NZS2103 + - title: Ngāti Mutunga, region not known + enum: + - NZS2104 + - title: Rangitāne, region not known + enum: + - NZS2105 + - title: Ngāti Raukawa, region not known + enum: + - NZS2106 + - title: Ngāti Tama, region not known + enum: + - NZS2107 + - title: Ngāti Toa, region not known + enum: + - NZS2108 + - title: Waitaha, region not known + enum: + - NZS2109 + - title: Ngāti Apa, region not known + enum: + - NZS2110 + - title: Ngāi Tai, region not known + enum: + - NZS2111 + - title: Ngāti Kahungunu, region not + known + enum: + - NZS2112 + - title: Ngāti Tūwharetoa, region not + known + enum: + - NZS2113 + - title: Hapū affiliated to more than + one iwi + enum: + - NZS22 + - title: Hapū affiliated to more than + one iwi + enum: + - NZS2201 + - title: Region known, Iwi not named + enum: + - NZS23 + - title: Te Tai Tokerau/Tāmaki-makaurau + Region, Iwi not named + enum: + - NZS2301 + - title: Hauraki Region, Iwi not named + enum: + - NZS2302 + - title: Waikato/Te Rohe Pōtae Region, + Iwi not named + enum: + - NZS2303 + - title: Te Arawa/Taupō Region, Iwi not + named + enum: + - NZS2304 + - title: Tauranga Moana/Mātaatua + Region, Iwi not named + enum: + - NZS2305 + - title: Te Tai Rāwhiti Region, Iwi not + named + enum: + - NZS2306 + - title: Te Matau-a-Māui/Wairarapa + Region, Iwi not named + enum: + - NZS2307 + - title: Taranaki Region, Iwi not named + enum: + - NZS2308 + - title: Whanganui/Rangitīkei Region, + Iwi not named + enum: + - NZS2309 + - title: Manawatū/Horowhenua/Te + Whanganui-a-Tara Region, Iwi + not named + enum: + - NZS2310 + - title: Te Waipounamu/Wharekauri + Region, Iwi not named + enum: + - NZS2311 + - title: Don't Know + enum: + - NZS44 + - title: Refused To Answer + enum: + - NZS55 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + ReligiousAffiliationList: + description:

A list of one or more religions with + which the person has an affiliation.

+ type: object + required: + - ReligiousAffiliation + properties: + ReligiousAffiliation: + type: array + items: + type: string + title: Religion + description: >- +

Religious affiliation is the + self-identified association of a + person with a religion, + denomination or sub-denominational + religious group.

Sourced + from Statistics NZ - Religious + Affiliation 1999 v1.0.0.0

    +
  • 'NZS0' - No Religion
    • +
  • 'NZS1' - Buddhist
    • +
  • 'NZS101' - Buddhist
    • +
  • 'NZS10101' - Zen Buddhist
    • +
  • 'NZS10199' - Buddhist nec
    • +
  • 'NZS2' - Christian
    • +
  • 'NZS201' - Adventist
    • +
  • 'NZS20101' - Christadelphian
    • +
  • 'NZS20102' - Seventh Day Adventist
    • +
  • 'NZS20103' - Worldwide Church of God
    • +
  • 'NZS20199' - Adventist nec
    • +
  • 'NZS202' - Anglican
    • +
plus 117 more value(s) at NZCodeSetsReligionType + oneOf: + - title: No Religion + enum: + - NZS0 + - title: Buddhist + enum: + - NZS1 + - title: Buddhist + enum: + - NZS101 + - title: Zen Buddhist + enum: + - NZS10101 + - title: Buddhist nec + enum: + - NZS10199 + - title: Christian + enum: + - NZS2 + - title: Adventist + enum: + - NZS201 + - title: Christadelphian + enum: + - NZS20101 + - title: Seventh Day Adventist + enum: + - NZS20102 + - title: Worldwide Church of God + enum: + - NZS20103 + - title: Adventist nec + enum: + - NZS20199 + - title: Anglican + enum: + - NZS202 + - title: Asian Christian + enum: + - NZS203 + - title: Chinese Christian + enum: + - NZS20301 + - title: Korean Christian + enum: + - NZS20302 + - title: Baptist + enum: + - NZS204 + - title: Bible Baptist + enum: + - NZS20401 + - title: Independent Baptist + enum: + - NZS20402 + - title: Reformed Baptist + enum: + - NZS20403 + - title: Baptist nec + enum: + - NZS20499 + - title: Brethren + enum: + - NZS205 + - title: Exclusive Brethren + enum: + - NZS20501 + - title: Open Brethren + enum: + - NZS20502 + - title: Plymouth Brethren + enum: + - NZS20503 + - title: Brethren nec + enum: + - NZS20599 + - title: Catholic + enum: + - NZS206 + - title: Roman Catholic + enum: + - NZS20601 + - title: Catholic nec + enum: + - NZS20699 + - title: Church of Christ and + Associated Churches of Christ + enum: + - NZS207 + - title: Associated Churches of Christ + enum: + - NZS20701 + - title: Other Church of Christ and + Churches of Christ nec + enum: + - NZS20799 + - title: Evangelical, Born Again and + Fundamentalist + enum: + - NZS208 + - title: Evangelical + enum: + - NZS20801 + - title: Born Again + enum: + - NZS20802 + - title: Fundamentalist + enum: + - NZS20803 + - title: Independent Evangelical + Churches + enum: + - NZS20804 + - title: Jehovah's Witnesses + enum: + - NZS209 + - title: Jehovah's Witnesses + enum: + - NZS20901 + - title: Latter-day Saints + enum: + - NZS210 + - title: Lutheran + enum: + - NZS211 + - title: Methodist + enum: + - NZS212 + - title: Tongan Methodist + enum: + - NZS21201 + - title: Methodist nec + enum: + - NZS21299 + - title: Orthodox + enum: + - NZS213 + - title: Assyrian Orthodox + enum: + - NZS21301 + - title: Coptic Orthodox + enum: + - NZS21302 + - title: Greek Orthodox + enum: + - NZS21303 + - title: Russian Orthodox + enum: + - NZS21304 + - title: Serbian Orthodox + enum: + - NZS21305 + - title: Orthodox nec + enum: + - NZS21399 + - title: Pentecostal + enum: + - NZS214 + - title: Apostolic Church of New Zealand + enum: + - NZS21401 + - title: Assemblies of God + enum: + - NZS21402 + - title: Christian Fellowship + enum: + - NZS21403 + - title: Christian Outreach + enum: + - NZS21404 + - title: Christian Revival Crusade + enum: + - NZS21405 + - title: Elim + enum: + - NZS21406 + - title: Full Gospel + enum: + - NZS21407 + - title: Independent Pentecostal + enum: + - NZS21408 + - title: New Life Centres + enum: + - NZS21409 + - title: Revival Centres + enum: + - NZS21410 + - title: United Pentecostal + enum: + - NZS21411 + - title: Vineyard Christian Fellowship + enum: + - NZS21412 + - title: Pentecostal nec + enum: + - NZS21499 + - title: Presbyterian, Congregational + and Reformed + enum: + - NZS215 + - title: Presbyterian + enum: + - NZS21501 + - title: Congregational + enum: + - NZS21502 + - title: Cook Island Congregational + enum: + - NZS21503 + - title: Samoan Congregational + enum: + - NZS21504 + - title: Reformed + enum: + - NZS21505 + - title: Protestant + enum: + - NZS216 + - title: Salvation Army + enum: + - NZS217 + - title: Uniting/Union Church and + Ecumenical + enum: + - NZS218 + - title: Uniting/Union Church + enum: + - NZS21801 + - title: Ecumenical + enum: + - NZS21802 + - title: Other Christian + enum: + - NZS299 + - title: Christian and Missionary + Alliance + enum: + - NZS29901 + - title: Christian Science + enum: + - NZS29902 + - title: Church of God + enum: + - NZS29903 + - title: Commonwealth Covenant Church + enum: + - NZS29904 + - title: Liberal Catholic + enum: + - NZS29905 + - title: Metropolitan + enum: + - NZS29906 + - title: Nazarene + enum: + - NZS29907 + - title: Religious Society of Friends + (Quaker) + enum: + - NZS29908 + - title: Unitarian + enum: + - NZS29909 + - title: Hindu + enum: + - NZS3 + - title: Hare Krishna + enum: + - NZS30101 + - title: Yoga + enum: + - NZS30102 + - title: Islam/Muslim + enum: + - NZS4 + - title: Sufi + enum: + - NZS40101 + - title: Judaism/Jewish + enum: + - NZS5 + - title: Māori Christian + enum: + - NZS6 + - title: Ratana + enum: + - NZS601 + - title: Ringatū + enum: + - NZS602 + - title: Other Māori Christian + enum: + - NZS609 + - title: Spiritualism and New Age + Religions + enum: + - NZS7 + - title: Church of Scientology + enum: + - NZS701 + - title: Nature and Earth Based + Religions + enum: + - NZS702 + - title: Animist + enum: + - NZS70201 + - title: Druid + enum: + - NZS70202 + - title: Pantheist + enum: + - NZS70203 + - title: Wiccan + enum: + - NZS70204 + - title: Satanism + enum: + - NZS703 + - title: Spiritualist + enum: + - NZS704 + - title: Other New Age Religions + enum: + - NZS709 + - title: Rastafarianism + enum: + - NZS70901 + - title: Other Religions + enum: + - NZS8 + - title: Baha'i + enum: + - NZS801 + - title: Chinese Religions + enum: + - NZS802 + - title: Confucianism + enum: + - NZS80201 + - title: Taoism + enum: + - NZS80202 + - title: Jainism + enum: + - NZS803 + - title: Japanese Religion + enum: + - NZS804 + - title: Mahikari + enum: + - NZS80401 + - title: Shinto + enum: + - NZS80402 + - title: Tenrikyo + enum: + - NZS80403 + - title: Māori Religion + enum: + - NZS805 + - title: Hauhau + enum: + - NZS80501 + - title: Sikh + enum: + - NZS806 + - title: Theism + enum: + - NZS807 + - title: Zoroastrian + enum: + - NZS808 + - title: Other Religions + enum: + - NZS809 + - title: Unification Church (Moonist) + enum: + - NZS80901 + - title: Other Religions nec + enum: + - NZS80999 + - title: Don't Know + enum: + - NZS944 + - title: Object to answering + enum: + - NZS955 + - title: Religion Unidentifiable + enum: + - NZS977 + - title: Response Outside Scope + enum: + - NZS988 + - title: Not Stated + enum: + - NZS999 + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + AddressList: + description: The person's address(es) - one or more + addresses + type: object + required: + - Address + properties: + Address: + type: array + items: + description:

This element contains address + data.

+ type: object + required: + - Street + properties: + Type: + type: string + title: Address Type + description: >- +

Address type allows an address + to be categorised according to its + component structure. Address type + can be used to build processing + rules for validating, managing and + presenting addresses. Address type + is independent of the use of the + address by any party. To describe + how a party may use an address + (residence, billing, term address + etc) see AddressRoleType

    +
  • 'TH' - Thoroughfare
    • +
  • 'RU' - Rural Post Delivery
    • +
  • 'DE' - Delivery Service
    • +
  • 'WA' - Water
    • +
  • 'FO' - Foreign Address
    • +
+ oneOf: + - title: Thoroughfare + description: "\"

Also called 'Street' + addresses, The most general, + and widely used type of + address, and can contain the + widest variety of + components

In general a + thoroughfare address will + include components for a + number, a roadname, and a + locality.

They cannot + contain any of the components + specific to a delivery + service, rural post delivery, + or water address.

These + addresses are used to find a + location.

Example: 30 - + 40 Lambton Quay, Wellington, + 6165

\"" + enum: + - TH + - title: Rural Post Delivery + description: '"

Defined by New Zealand + Post, these addresses are + assigned by NZ Post for + customers who purchase a rural + delivery service (mail and + also other goods).

They + will have the same number and + roadname components as the + street address, and may have + the same region component.

+

They do not have a + component that identifies the + locality the address is + within. The locality and city + or town components are + replaced by components that + identify the rural delivery + route (RD number), and the + town from which the rural + delivery route starts and + finishes (the mail town). Only + addresses of this class can + contain these components.

+

Example: 121 + Waitaha Road, RD 1, Ross, + 7885

"' + enum: + - RU + - title: Delivery Service + description: '"

Defined by New Zealand + Post, and used exclusively for + NZ Post services other than + standard mail delivery. + Addresses in this class + include PO Box, Private Bag, + and Counter Delivery + addresses.

+ Example: Private Bag + 2345, Auckland, 1142

"' + enum: + - DE + - title: Water + description: '"

Where properties have no + road access, but do have + access to water frontage + (coastline or riverbank or + lakefront), a water address + uses the name of a water + feature (for example, islands, + rivers, bays, or + peninsulas).

+ Example: 235 Lochmara + Bay, Queen Charlotte Sound, + Marlborough Sounds

"' + enum: + - WA + - title: Foreign Address + description: '"

A foreign address + identifies a location outside + of New Zealand.

+ Example: + Rudolf-Diesel-Strasse 14, + 54595 Prüm, Germany

"' + enum: + - FO + Role: + type: string + title: Address Role + description: >- +

A standardised description of + the role or usage of an address by + a party (person or organisation). + Where a party has more than one + address, this provides context for + deciding which address to use.

+
    +
  • 'PHY' - Physical Address
    • +
  • 'POS' - Postal Address
    • +
+ oneOf: + - title: Physical Address + description: Applies to addresses + associated with persons + enum: + - PHY + - title: Postal Address + description: Applies to addresses + associated with persons or + organisations + enum: + - POS + Street: + description:

The street element is a complex + element and breaks the street down + into several parts. (Allow for PO + Box here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' part of + rural addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only + applicable if a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid + x,y coordinates and converted to + Latitude and Longitude values per + the World Geodetic System 1984 + (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes + north of the equator are + positive, latitudes south of + the equator are negative [ISO + 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes + east of the Prime Meridian in + Greenwich are positive, + longitudes west of the Prime + Meridian are negative. The + 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

+

The list may contain exactly + one StatisticalArea element for + each of the following spatial unit + types:

  • Ward
    • +
  • Urban Area
  • Census + Area Unit
  • Māori + Electorate
  • Mesh + Block
  • General + Electorate
  • Territorial + Authority
  • Local Board + (Auckland Only)
  • Regional + Council
+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical + area defined by Statistics + New Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + type: string + title: Spatial Unit Type + description: >- +

A classification of + geographical boundaries + or statistical areas as + defined by Statistics + NZ’s geographic + hierarchy.

    +
  • 'AE' - Area Unit
    • +
  • 'GE' - General Electoral District
    • +
  • 'CB' - Community Board
    • +
  • 'ME' - Māori Electoral District
    • +
  • 'MB' - Mesh Block
    • +
  • 'RC' - Regional Council
    • +
  • 'TA' - Territorial Authority
    • +
  • 'UA' - Urban Area
    • +
  • 'WA' - Ward
    • +
+ oneOf: + - title: Area Unit + description:

Area units are + aggregations of + meshblocks. They are + non–administrative + areas that are in + between meshblocks + and territorial + authorities in size. + Area units must + either define or + aggregate to define, + regional councils, + territorial + authorities and + urban areas.

+ Statistics NZ + Classification of + Area Unit 2013 + v1.0.0 + enum: + - AE + - title: General Electoral + District + description:

The general + electoral districts + as constituted under + the Electoral Act + 1993.

Statistics + NZ General Electoral + District 2014 v1.0.0 + enum: + - GE + - title: Community Board + description:

(aka Local Board + within Auckland) + Local boards provide + governance at the + local level within + Auckland Council. + They enable + democratic decision + making by, and on + behalf of + communities within + the local board + area.

Statistics + NZ Community Board + 2013 v1.0.0 + enum: + - CB + - title: Māori Electoral + District + description:

Māori electoral + districts are the + voting districts for + parliamentary + elections for people + who choose to be on + the Māori Electoral + Roll.

Statistics + NZ Māori Electoral + District 2014 v1.0.0 + enum: + - ME + - title: Mesh Block + description:

A meshblock is + the smallest + geographic unit for + which statistical + data is collected + and processed by + Statistics New + Zealand.

A + meshblock is defined + by a geographic + area, which can vary + in size from part of + a city block to a + large area of rural + land. Each meshblock + borders on another + to form a network + covering all of New + Zealand, including + coasts and inlets + and extending out to + the 200-mile + economic zone.

+ Statistics NZ + Statistical Standard + for Meshblock 2013 + v1.0.0 + enum: + - MB + - title: Regional Council + description:

The top tier of + local government in + New Zealand, defined + by the Local + Government Act 2002, + which requires the + boundaries of + regions to conform + as far as possible + to one or more water + catchments. When + determining regional + boundaries, the + Local Government + Commission gave + consideration to + regional communities + of interest when + selecting water + catchments to be + included in a + region. It also + considered factors + such as natural + resource management, + land use planning + and environmental + matters.

+ Statistics NZ + Regional Council + 2013 v1.0.0 + enum: + - RC + - title: Territorial Authority + description:

The second tier + of local government + in New Zealand, + defined under the + Local Government Act + 2002 as a city + council or district + council. There are + 67 territorial + authorities + consisting of 12 + city councils, 53 + districts, Auckland + Council, and Chatham + Islands Council.

+ Statistics NZ + Territorial + Authority 2013 + v1.0.0 + enum: + - TA + - title: Urban Area + description: '"

Urban Areas are + statistically + defined areas with + no administrative or + legal basis. There + is a three part + hierarchical + sub-division of + urban areas into: + main urban areas, + secondary urban + areas, minor urban + areas. Together the + populations in main, + secondary and minor + urban areas comprise + the statistically + defined urban + population of New + Zealand. The urban + area classification + is designed to + identify + concentrated urban + or semi-urban + settlements without + the distortions of + administrative + boundaries.

+ Statistics NZ Urban + Area 2013 v2.0.0"' + enum: + - UA + - title: Ward + description:

Wards are defined + under the Local + Electoral Act 2001 + and result from the + division, for + electoral purposes, + of the district of a + territorial + authority. The ward + system was designed + to allow for the + recognition of + communities within a + district and to + increase community + involvement in the + local government + system.

+ Statistics NZ Ward + 2013 v1.0.0 + enum: + - WA + Code: + type: string + description:

A valid value defined + by the nominated spatial + unit type, defined by + Statistics New Zealand + in one of the following + statistical area + defintion standards:

+
Area Unit
+
Statistics NZ + Classification of Area + Unit 2017 v1.0.0
+
General Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community Board
+
Statistics NZ + Community Board (codes + 07601 - 07621) 2018 + v1.0.0
Māori + Electoral District
+
Statistics NZ Māori + Electoral District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard for + Meshblock 2018 + v1.0.0
Regional + Council
+
Statistics NZ + Regional Council 2018 + v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority + 2018 v1.0.0
+
Urban Area
+
Statistics NZ Urban + Area 2018 v1.0.0
+
Ward
+
Statistics NZ Ward + 2018 v1.0.0
+ EmailList: + description:

The person's e-mail address(es) - one or + more emails.

+ type: object + required: + - Email + properties: + Email: + type: array + items: + description:

This element represents an e-mail + address of one of a number of types + and occurs in objects such as + StudentPersonal, StaffPersonal, + StudentContactPersonal, etc.

+ type: object + required: + - Address + properties: + Type: + type: string + title: Email Type + description: >- +

A standardised method of + describing an electronic mail + address used as contact method by + a party. Where a party has more + than one email address, this may + provide context for deciding which + email address to use.

    +
  • 'PRIM' - Primary
    • +
  • 'WORK' - Work
    • +
  • 'PERS' - Personal
    • +
  • 'ALT1' - Alternate 1
    • +
  • 'ALT2' - Alternate 2
    • +
  • 'ALT3' - Alternate 3
    • +
  • 'ALT4' - Alternate 4
    • +
+ oneOf: + - title: Primary + description: Applicable to organisations, + eg schools + enum: + - PRIM + - title: Work + description: Only used for persons + enum: + - WORK + - title: Personal + description: Only used for persons + enum: + - PERS + - title: Alternate 1 + enum: + - ALT1 + - title: Alternate 2 + enum: + - ALT2 + - title: Alternate 3 + enum: + - ALT3 + - title: Alternate 4 + enum: + - ALT4 + Address: + type: string + description:

The actual email address.

+ PhoneNumberList: + description:

The person's phone number(s) - one or + more phone numbers.

+ type: object + required: + - PhoneNumber + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone + number and occurs within objects such + as StudentPersonal, StaffPersonal, + etc.

+ type: object + required: + - Number + properties: + Type: + type: string + title: Telephone Number Type + description: >- +

A standardised method of + describing a telecommunications + device used as contact method by a + party. Where a party has more than + one phone number, this may provide + context for deciding which number + to use.

    +
  • 'MAI' - Main Telephone Number
    • +
  • 'FAX' - Facsimile Number
    • +
  • 'HTE' - Home Telephone Number
    • +
  • 'HMO' - Home Mobile
    • +
  • 'MOB' - Mobile
    • +
  • 'WMO' - Work Mobile
    • +
  • 'WTE' - Work Telephone Number
    • +
+ oneOf: + - title: Main Telephone Number + enum: + - MAI + - title: Facsimile Number + enum: + - FAX + - title: Home Telephone Number + description: Person usage only + enum: + - HTE + - title: Home Mobile + description: Person usage only + enum: + - HMO + - title: Mobile + enum: + - MOB + - title: Work Mobile + enum: + - WMO + - title: Work Telephone Number + enum: + - WTE + Number: + type: string + description: "

Phone number. Free-form, but + typical New Zealand formats + include:

  • (0##) + ###-####
  • ###-####
    • +
  • +##### ### ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1StudentPersonals/get/r\ + esponses/200/content/application~\ + 1json/schema/properties/StudentPe\ + rsonals/properties/StudentPersona\ + l/items/properties/PersonInfo/pro\ + perties/Name/properties/FamilyNam\ + eFirst" + HouseholdContactInfoList: + description:

The person's household/s contact + information. A list of one or more + household’s contact information.

+ type: object + required: + - HouseholdContactInfo + properties: + HouseholdContactInfo: + type: array + items: + description:

Common element used to supply + information about a particular + household a person is a member of.

+ type: object + properties: + PreferenceNumber: + type: integer + description:

Priority of Household Contact + in relation to this Person.

+ HouseholdContactId: + $ref: "#/paths/~1StudentPersonals/get/r\ + esponses/200/content/application~\ + 1json/schema/properties/StudentPe\ + rsonals/properties/StudentPersona\ + l/items/properties/StudentPersona\ + lLocalId" + HouseholdSalutation: + type: string + description:

Salutation to be used in + addressing this household.

+ AddressList: + description:

A list of Address elements.

+ type: object + required: + - Address + properties: + Address: + type: array + items: + description:

This element contains + address data.

+ type: object + required: + - Street + properties: + Type: + $ref: "#/paths/~1StudentPerso\ + nals/get/responses/200/\ + content/application~1js\ + on/schema/properties/St\ + udentPersonals/properti\ + es/StudentPersonal/item\ + s/properties/PersonInfo\ + /properties/AddressList\ + /properties/Address/ite\ + ms/properties/Type" + Role: + $ref: "#/paths/~1StudentPerso\ + nals/get/responses/200/\ + content/application~1js\ + on/schema/properties/St\ + udentPersonals/properti\ + es/StudentPersonal/item\ + s/properties/PersonInfo\ + /properties/AddressList\ + /properties/Address/ite\ + ms/properties/Role" + Street: + description:

The street element is + a complex element and + breaks the street down + into several parts. + (Allow for PO Box + here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line + 1.

+ Line2: + type: string + description:

Address line + 2.

+ Line3: + type: string + description:

Address line + 3.

+ Suburb: + type: string + description:

The suburb part of + urban addresses, or the + 'RD No' part of rural + addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province + code. StateTerritory + Code only applicable if + a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal + code.

+ GridLocation: + description:

The latitude & + longitude of the + location. Grid location + values are derived from + New Zealand Map Grid x,y + coordinates and + converted to Latitude + and Longitude values per + the World Geodetic + System 1984 (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in + decimal degrees.

+

Latitudes north + of the equator are + positive, latitudes + south of the equator + are negative [ISO + 6709].

+ Longitude: + description:

Longitude in + decimal degrees.

+

Longitudes east + of the Prime + Meridian in + Greenwich are + positive, longitudes + west of the Prime + Meridian are + negative. The 180th + meridian is + negative. [ISO + 6709]

+ StatisticalAreaList: + description:

A list of Statistical + Areas containing the + location.

The + list may contain exactly + one StatisticalArea + element for each of the + following spatial unit + types:

    +
  • Ward
  • Urban + Area
  • Census + Area Unit
  • Māori + Electorate
  • Mesh + Block
  • General + Electorate
    • +
  • Territorial + Authority
  • Local + Board (Auckland + Only)
  • Regional + Council
+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular + statistical area + defined by + Statistics New + Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + $ref: "#/paths/~1St\ + udentPersonals/get/\ + responses/200/conte\ + nt/application~1jso\ + n/schema/properties\ + /StudentPersonals/p\ + roperties/StudentPe\ + rsonal/items/proper\ + ties/PersonInfo/pro\ + perties/AddressList\ + /properties/Address\ + /items/properties/S\ + tatisticalAreaList/\ + properties/Statisti\ + calArea/items/prope\ + rties/SpatialUnitTy\ + pe" + Code: + type: string + description:

A valid + value defined by the + nominated spatial + unit type, defined + by Statistics New + Zealand in one of + the following + statistical area + defintion + standards:

+
Area Unit
+
Statistics NZ + Classification of + Area Unit 2017 + v1.0.0
+
General + Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community + Board
+
Statistics NZ + Community Board + (codes 07601 - + 07621) 2018 + v1.0.0
+
Māori Electoral + District
+
Statistics NZ + Māori Electoral + District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard + for Meshblock 2018 + v1.0.0
+
Regional + Council
+
Statistics NZ + Regional Council + 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial + Authority 2018 + v1.0.0
+
Urban Area
+
Statistics NZ + Urban Area 2018 + v1.0.0
+
Ward
+
Statistics NZ + Ward 2018 + v1.0.0
+ EmailList: + description:

List of Email elements.

+ type: object + required: + - Email + properties: + Email: + type: array + items: + description:

This element represents + an e-mail address of one of + a number of types and occurs + in objects such as + StudentPersonal, + StaffPersonal, + StudentContactPersonal, etc. +

+ type: object + required: + - Address + properties: + Type: + $ref: "#/paths/~1StudentPerso\ + nals/get/responses/200/\ + content/application~1js\ + on/schema/properties/St\ + udentPersonals/properti\ + es/StudentPersonal/item\ + s/properties/PersonInfo\ + /properties/EmailList/p\ + roperties/Email/items/p\ + roperties/Type" + Address: + type: string + description:

The actual email + address.

+ PhoneNumberList: + description:

List of PhoneNumber + elements.

+ type: object + required: + - PhoneNumber + properties: + PhoneNumber: + type: array + items: + description:

This element represents a + phone number and occurs + within objects such as + StudentPersonal, + StaffPersonal, etc.

+ type: object + required: + - Number + properties: + Type: + $ref: "#/paths/~1StudentPerso\ + nals/get/responses/200/\ + content/application~1js\ + on/schema/properties/St\ + udentPersonals/properti\ + es/StudentPersonal/item\ + s/properties/PersonInfo\ + /properties/PhoneNumber\ + List/properties/PhoneNu\ + mber/items/properties/T\ + ype" + Number: + type: string + description: "

Phone number. + Free-form, but typical + New Zealand formats + include:

    +
  • (0##) ###-####
    • +
  • ###-####
    • +
  • +##### ### ####
    • +
" + Extension: + type: string + description:

Phone number + extension.

+ ListedStatus: + $ref: "#/paths/~1StudentPerso\ + nals/get/responses/200/\ + content/application~1js\ + on/schema/properties/St\ + udentPersonals/properti\ + es/StudentPersonal/item\ + s/properties/PersonInfo\ + /properties/Name/proper\ + ties/FamilyNameFirst" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + description: Contains all the personal information related to the + student. + x-accessControl: + create: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + read: + - 1001 + - 1306 + - 2101 + - 2103 + - 2401 + - 2403 + update: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentPersonals: + 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 + 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: + IwiAffiliation: + - NZS0702 + - NZS0601 + ReligiousAffiliationList: + ReligiousAffiliation: + - NZS212 + - NZS215 + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + - Type: RU + Role: PHY + Street: + Line1: 1175 Lake Ferry Rd + Suburb: RD 1 + City: Martinborough + EmailList: + Email: + - Type: PRIM + Address: hagrid@gmail.com + PhoneNumberList: + PhoneNumber: + Type: MOB + Number: (021) 300 999 + HouseholdContactInfoList: + HouseholdContactInfo: + - PreferenceNumber: 1 + HouseholdContactId: 7d5c3f5c-d89c-4551-9442-6b008207986e + AddressList: + Address: + - Type: DE + Role: POS + Street: + Line1: P O Box 81 + City: Martinborough + PostalCode: "5781" + "{\n \"Email\": { \"Type\": \"PRIM\", \"Address\": \"hagrid@gmail.com\" }\n}": null + PhoneNumberList: + PhoneNumber: + Type: MOB + Number: (021) 300 999 + application/xml: + schema: + type: object + properties: + StudentPersonals: + type: object + description: A List of StudentPersonal objects + properties: + StudentPersonal: + type: array + items: + $ref: "#/paths/~1StudentPersonals/get/responses/200/conte\ + nt/application~1json/schema/properties/StudentPerso\ + nals/properties/StudentPersonal/items" + example: >- + + + 7C834EA9-EDA1-2090-347F-83297E1C290C + S1234567 + 2234523 + 1996-05-04 + + + Hagrid + Rubeus + Rubeus Hagrid + LGL + N + + + + Anderson + Samuel + Samuel Anderson + AKA + Y + + NZPAS + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + + + Rowinski + Sam + Sam Rowinski + PRF + N + + + + 1990-09-26 + Dunedin + ZAF + + NZL + ZAF + + NZCI + + NZPAS + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + 2 + + + NZS01110 + FL + + + AD + SP + + + + + NZS01112 + SL + + + BE + SP + + + + + + + 1 + 111 + + + 1 + 211 + + + + NZS0702 + NZS0601 + + + NZS212 + NZS215 + + + +
+ TH + PHY + + The Enchanted Wood + 533 Hogwart's Way + + Hogsmead + 7733 +
+
+ RU + PHY + + 1175 Lake Ferry Rd + + RD 1 + Martinborough +
+ + + + PRIM + hagrid@gmail.com + + + + + MOB + (021) 300 999 + + + + + 1 + 7d5c3f5c-d89c-4551-9442-6b008207986e + +
+ DE + POS + + P O Box 81 + + Martinborough + 5781 +
+ + + + PRIM + hagrid@gmail.com + + + + + MOB + (021) 300 999 + + + + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentPersonals/{StudentPersonalRefId}": + post: + tags: + - StudentPersonal + summary: Default operation to create a single StudentPersonal + parameters: + - name: StudentPersonalRefId + in: path + description:

The GUID of the student.

+ required: true + schema: + type: string + operationId: createStudentPersonal + requestBody: + description: CRUD operation on StudentPersonal + content: + application/json: + schema: + type: object + properties: + StudentPersonal: + $ref: "#/paths/~1StudentPersonals/get/responses/200/content/appli\ + cation~1json/schema/properties/StudentPersonals/properties/\ + StudentPersonal/items" + example: + 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 + 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: + IwiAffiliation: + - NZS0702 + - NZS0601 + ReligiousAffiliationList: + ReligiousAffiliation: + - NZS212 + - NZS215 + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + - Type: RU + Role: PHY + Street: + Line1: 1175 Lake Ferry Rd + Suburb: RD 1 + City: Martinborough + EmailList: + Email: + - Type: PRIM + Address: hagrid@gmail.com + PhoneNumberList: + PhoneNumber: + Type: MOB + Number: (021) 300 999 + HouseholdContactInfoList: + HouseholdContactInfo: + - PreferenceNumber: 1 + HouseholdContactId: 7d5c3f5c-d89c-4551-9442-6b008207986e + AddressList: + Address: + - Type: DE + Role: POS + Street: + Line1: P O Box 81 + City: Martinborough + PostalCode: "5781" + "{\n \"Email\": { \"Type\": \"PRIM\", \"Address\": \"hagrid@gmail.com\" }\n}": null + PhoneNumberList: + PhoneNumber: + Type: MOB + Number: (021) 300 999 + application/xml: + schema: + type: object + properties: + StudentPersonal: + $ref: "#/paths/~1StudentPersonals/get/responses/200/content/appli\ + cation~1json/schema/properties/StudentPersonals/properties/\ + StudentPersonal/items" + example: >- + + 7C834EA9-EDA1-2090-347F-83297E1C290C + S1234567 + 2234523 + 1996-05-04 + + + Hagrid + Rubeus + Rubeus Hagrid + LGL + N + + + + Anderson + Samuel + Samuel Anderson + AKA + Y + + NZPAS + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + + + Rowinski + Sam + Sam Rowinski + PRF + N + + + + 1990-09-26 + Dunedin + ZAF + + NZL + ZAF + + NZCI + + NZPAS + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + 2 + + + NZS01110 + FL + + + AD + SP + + + + + NZS01112 + SL + + + BE + SP + + + + + + + 1 + 111 + + + 1 + 211 + + + + NZS0702 + NZS0601 + + + NZS212 + NZS215 + + + +
+ TH + PHY + + The Enchanted Wood + 533 Hogwart's Way + + Hogsmead + 7733 +
+
+ RU + PHY + + 1175 Lake Ferry Rd + + RD 1 + Martinborough +
+ + + + PRIM + hagrid@gmail.com + + + + + MOB + (021) 300 999 + + + + + 1 + 7d5c3f5c-d89c-4551-9442-6b008207986e + +
+ DE + POS + + P O Box 81 + + Martinborough + 5781 +
+ + + + PRIM + hagrid@gmail.com + + + + + MOB + (021) 300 999 + + + + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentPersonal + summary: Default operation to update a single StudentPersonal + parameters: + - name: StudentPersonalRefId + in: path + description:

The GUID of the student.

+ required: true + schema: + type: string + operationId: updateStudentPersonal + requestBody: + description: CRUD operation on StudentPersonal + content: + application/json: + schema: + type: object + properties: + StudentPersonal: + type: object + properties: + StudentPersonalRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentPersonalLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + NationalStudentNumber: + description:

The unique identifier allocated to every student in + New Zealand, also known as the NSN.

+ FirstNZSchoolingDate: + type: string + format: date + description:

The date a student first ever started schooling in + New Zealand. This field is used to establish most + students’ Funding Year Level.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + EarlyChildhoodEducation: + description:

The type of early childhood education the student + received before enrolling in their first school.

+ type: object + properties: + Type: + type: string + title: Early Childhood Education Type + description: >- +

The type of early childhood education the student + received.

    +
  • 'EKR' - Kohanga Reo
    • +
  • 'EPC' - Playcentre
    • +
  • 'EKE' - Kindergarden or Education and Care
    • +
  • 'EHB' - Home Based Service
    • +
  • 'EPG' - Playgroup or Pacific Islands EC Group
    • +
  • 'ECO' - The Correspondence School - Te Aho o Te Kura Pounamu
    • +
  • 'EOS' - Attended, but only outside New Zealand
    • +
  • 'ETU' - Attended, but don't know what type of service
    • +
  • 'ENA' - Did not attend
    • +
  • 'EUN' - Unable to establish if attended or not
    • +
+ oneOf: + - title: Kohanga Reo + enum: + - EKR + - title: Playcentre + enum: + - EPC + - title: Kindergarden or Education and Care + enum: + - EKE + - title: Home Based Service + enum: + - EHB + - title: Playgroup or Pacific Islands EC Group + enum: + - EPG + - title: The Correspondence School - Te Aho o Te Kura + Pounamu + enum: + - ECO + - title: Attended, but only outside New Zealand + enum: + - EOS + - title: Attended, but don't know what type of service + enum: + - ETU + - title: Did not attend + enum: + - ENA + - title: Unable to establish if attended or not + enum: + - EUN + HoursAttended: + type: integer + description:

The total number of hours of early childhood + education attended, prior to enrolling in their + first school.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + PersonInfo: + description:

Personal Information

+ type: object + properties: + Name: + description:

A name used by the person

+ type: object + properties: + Title: + type: string + description:

A title or prefix associated with the + name.

+ FamilyName: + type: string + description:

Also known as Last Name, although some + cultures may not present a family name as the + last name.

+ GivenName: + type: string + description:

Also known as First Name, although some + cultures may not present this name as the first + element in a name. May contain a composite of + all given names.

+ MiddleName: + type: string + description:

Where more than one Given Name, these may be + combined in one composite field or else + populated in several elements.

+ FamilyNameFirst: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PreferredFamilyName: + type: string + description:

A preferred version of the Family Name. + Note:A name cannot have both a Preferred Family + and Preferred Given Name within the same Name + structure – only one of these fields should be + populated. If a person does have both a + Preferred Family and Preferred Given Name then + this must be populated as a separate Name of + type ‘Preferred’.

+ PreferredFamilyNameFirst: + $ref: "#/paths/~1StudentPersonals~1%7BStudentPersonal\ + RefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/StudentPersonal/propertie\ + s/PersonInfo/properties/Name/properties/FamilyN\ + ameFirst" + PreferredGivenName: + type: string + description: "

A preferred version of the Given Name. Note: + A name cannot have both a Preferred Family and + Preferred Given Name within the same Name + structure – only one of these fields should be + populated. If a person does have both a + Preferred Family and Preferred Given Name then + this must be populated as a separate Name of + type ‘Preferred’.

" + Suffix: + type: string + description:

Textual suffix like PHD, JP, BSc.

+ FullName: + type: string + description:

A combination of all name elements as one + composite text element

+ Type: + type: string + title: Name Usage Type + description: >- +

A standardised method of describing the usage + of a name by a person. Where a person has more + than one current name, the usage type indicates + which name may be used according to the + purpose.

Code values are based on SIF + Australia 3.4.

    +
  • 'PRF' - Preferred Name
    • +
  • 'FON' - Foreign Official Name
    • +
  • 'PRV' - Previous name
    • +
  • 'AKA' - Also Known As
    • +
  • 'BTH' - Name at Birth
    • +
  • 'LGL' - Legal Name
    • +
+ oneOf: + - title: Preferred Name + description:

The name by which an individual prefers + to be known and addressed.

Only usage + type applicable for student name usage + (other types are not supported by NSI).

+ enum: + - PRF + - title: Foreign Official Name + description:

Included for future usage in NZ, + especially for tertiary students.

+ enum: + - FON + - title: Previous name + enum: + - PRV + - title: Also Known As + description: AKA or Alias + enum: + - AKA + - title: Name at Birth + enum: + - BTH + - title: Legal Name + description:

Legal Name or Official Name as defined by + the organisation which collects it (legal + name is not defined in this standard)

+ enum: + - LGL + IsVerified: + $ref: "#/paths/~1StudentPersonals~1%7BStudentPersonal\ + RefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/StudentPersonal/propertie\ + s/PersonInfo/properties/Name/properties/FamilyN\ + ameFirst" + OtherNameList: + description:

Previous, alternate or other names or aliases + associated with the person.

+ type: object + properties: + Name: + type: array + items: + description:

Extension of BaseNameType including name + verification data

+ type: object + properties: + Verification: + description:

The verification event that verified + the person's name.

+ type: object + properties: + Source: + type: string + title: Verification Source + description: >- +

Records the source of the identity + or eligibility verification, that has + been made. Mostly it is merely a + record of the kind of document that + has been presented; but occasionally + it is down to Principal or Ministry + discretion / approval.

    +
  • 'NZBIR' - NZ Birth Certificate
    • +
  • 'NZBCO' - NZ Birth Certificate (with confirmation of NZ Citizen by birth)
    • +
  • 'NZPAS' - NZ Passport
    • +
  • 'NZCIT' - NZ Citizenship Certificate
    • +
  • 'BIRCE' - Birth Certificate (COK, TKL, NIU)
    • +
  • 'BCCON' - Birth Certificate (COK, TKL, NIU) (with confirmation of NZ Citizen by birth)
    • +
  • 'CENAT' - Certification of Naturalisation (COK, TKL, NIU)
    • +
  • 'CAREG' - Certification of Registration (COK, TKL, NIU)
    • +
  • 'LETCO' - Letter of Confirmation (COK, TKL, NIU)
    • +
  • 'OTHPA' - Other Passport with NZ residence class Visa
    • +
  • 'AUSPA' - Australian Passport
    • +
  • 'VISDO' - Visa Domestic
    • +
plus 3 more value(s) at NZCodeSetsVerificationSourceType + oneOf: + - title: NZ Birth Certificate + description: Applies if the child was born + before 1 Jan 2006 + enum: + - NZBIR + - title: NZ Birth Certificate (with + confirmation of NZ Citizen by + birth) + description: Applies if the child was born on + or after 1 Jan 2006 + enum: + - NZBCO + - title: NZ Passport + description: Including COK, TKL or NIU. + (Current or Expired) + enum: + - NZPAS + - title: NZ Citizenship Certificate + enum: + - NZCIT + - title: Birth Certificate (COK, TKL, NIU) + description: If the child was born before 1 Jan + 2006 + enum: + - BIRCE + - title: Birth Certificate (COK, TKL, NIU) + (with confirmation of NZ Citizen + by birth) + description: Applies if the child was born on + or after 1 Jan 2006. + enum: + - BCCON + - title: Certification of Naturalisation + (COK, TKL, NIU) + enum: + - CENAT + - title: Certification of Registration + (COK, TKL, NIU) + enum: + - CAREG + - title: Letter of Confirmation (COK, TKL, + NIU) + enum: + - LETCO + - title: Other Passport with NZ residence + class Visa + description: Or other evidence of NZ residency + enum: + - OTHPA + - title: Australian Passport + description: (Current or Expired) + enum: + - AUSPA + - title: Visa Domestic + enum: + - VISDO + - title: Visa with conditions of study + enum: + - VISST + - title: Principal Discretion + enum: + - PRINC + - title: MoE Approval + enum: + - MOEAP + DocumentSerialNumber: + type: string + description:

The serial number on the document + that was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document + that was used to verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has been + confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + description:

A reference to another SIF Data + Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentPersonals~1%7BS\ + tudentPersonalRefId%7D/put/reques\ + tBody/content/application~1json/s\ + chema/properties/StudentPersonal/\ + properties/StudentPersonalRefId" + LocalId: + $ref: "#/paths/~1StudentPersonals~1%7BS\ + tudentPersonalRefId%7D/put/reques\ + tBody/content/application~1json/s\ + chema/properties/StudentPersonal/\ + properties/StudentPersonalLocalId" + Name: + type: string + description:

The normal descriptive name of + the referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF + DataObject names, to be included + in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that + operates within the education + sector; but doesn’t provide + education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of + education services such as ECE + Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship + between two providers of + education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that + Students enrol in, and may be + assessed for, and achieve + passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other + award granted by a national + body, professional association + or other interested party. The + Credential describes an award + that is made to the learner at + the successful completion of a + particular learning programme. + eg: NCEA Level 1; University + Entrance; NCEA Level 2 + Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information + relating to a staff member, + who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff + member to a particular Role at + a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal + information related to the + student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal + information about a person who + is a part of a Student's + whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a + person who is a part of a + Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with + an education provider for the + purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class + or other group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the + attendance spans for a single + student at a single provider + during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a + particular assignment or other + assessment task, to be + undertaken by one or more + Students at some time. Defines + the task separately from each + student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for + an assessment task they are + intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt + at a particular assessment + task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by + a single student at a + particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an + Attainment e.g. NCEA + Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and + follow ups generated by a + WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's + interests and academic, career + and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a + co-curricular or + extra-curricular activity in + which a student participates + during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information + pertaining to a student's + participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and + achievement reports provided + for a student. Used in + technology centres the host + provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + VerifiedName: + description:

The verified name of the person.

+ type: object + properties: + Verification: + description:

The verification event that verified the + person's name.

+ type: object + properties: + Source: + $ref: "#/paths/~1StudentPersonals~1%7BStudentPers\ + onalRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StudentPerson\ + al/properties/PersonInfo/properties/OtherNa\ + meList/properties/Name/items/properties/Ver\ + ification/properties/Source" + DocumentSerialNumber: + type: string + description:

The serial number on the document that + was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document that was + used to verify the name or birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has been + confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StudentPersonals~1%7BStudentPers\ + onalRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StudentPerson\ + al/properties/PersonInfo/properties/OtherNa\ + meList/properties/Name/items/properties/Ver\ + ification/properties/Provider" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + Demographics: + description:

Details of the person’s demographic properties

+ type: object + properties: + BirthDate: + type: string + format: date + description:

The person's date of birth.

+ DateOfDeath: + type: string + format: date + description:

The person's date of death.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + PlaceOfBirth: + type: string + description:

The person's place of birth - like village, + town, city etc.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + CountryOfBirth: + type: string + title: 3166 Country + description: >- +

A country is a geopolitical entity recognised + by the New Zealand government. The term country + may include

  • Independent countries + recognised by the New Zealand Government
    • +
  • Units that are recognised geographic + areas
  • administrative subdivisions of + the United Kingdom
  • overseas + dependencies, external territories of + independent countries.

Conforms to + the International Standard ISO 3166 Codes for + the Representation of Names of Countries and + their Subdivisions (ISO 3166-1:2013). Education + adopts the alpha-3 representation of this + standard.

    +
  • 'ABW' - Aruba
    • +
  • 'AFG' - Afghanistan
    • +
  • 'AGO' - Angola
    • +
  • 'AIA' - Anguilla
    • +
  • 'ALA' - Åland Islands
    • +
  • 'ALB' - Albania
    • +
  • 'AND' - Andorra
    • +
  • 'ARE' - United Arab Emirates
    • +
  • 'ARG' - Argentina
    • +
  • 'ARM' - Armenia
    • +
  • 'ASM' - American Samoa
    • +
  • 'ATA' - Antarctica
    • +
plus 237 more value(s) at ISO3166CountryType + oneOf: + - title: Aruba + enum: + - ABW + - title: Afghanistan + enum: + - AFG + - title: Angola + enum: + - AGO + - title: Anguilla + enum: + - AIA + - title: Åland Islands + enum: + - ALA + - title: Albania + enum: + - ALB + - title: Andorra + enum: + - AND + - title: United Arab Emirates + enum: + - ARE + - title: Argentina + enum: + - ARG + - title: Armenia + enum: + - ARM + - title: American Samoa + enum: + - ASM + - title: Antarctica + enum: + - ATA + - title: French Southern Territories + enum: + - ATF + - title: Antigua and Barbuda + enum: + - ATG + - title: Australia + enum: + - AUS + - title: Austria + enum: + - AUT + - title: Azerbaijan + enum: + - AZE + - title: Burundi + enum: + - BDI + - title: Belgium + enum: + - BEL + - title: Benin + enum: + - BEN + - title: Bonaire, Sint Eustatius and Saba + enum: + - BES + - title: Burkina Faso + enum: + - BFA + - title: Bangladesh + enum: + - BGD + - title: Bulgaria + enum: + - BGR + - title: Bahrain + enum: + - BHR + - title: Bahamas + enum: + - BHS + - title: Bosnia and Herzegovina + enum: + - BIH + - title: Saint Barthélemy + enum: + - BLM + - title: Belarus + enum: + - BLR + - title: Belize + enum: + - BLZ + - title: Bermuda + enum: + - BMU + - title: Bolivia, Plurinational State of + enum: + - BOL + - title: Brazil + enum: + - BRA + - title: Barbados + enum: + - BRB + - title: Brunei Darussalam + enum: + - BRN + - title: Bhutan + enum: + - BTN + - title: Bouvet Island + enum: + - BVT + - title: Botswana + enum: + - BWA + - title: Central African Republic + enum: + - CAF + - title: Canada + enum: + - CAN + - title: Cocos (Keeling) Islands + enum: + - CCK + - title: Switzerland + enum: + - CHE + - title: Chile + enum: + - CHL + - title: China + enum: + - CHN + - title: Côte d'Ivoire + enum: + - CIV + - title: Cameroon + enum: + - CMR + - title: Congo, the Democratic Republic of the + enum: + - COD + - title: Congo + enum: + - COG + - title: Cook Islands + enum: + - COK + - title: Colombia + enum: + - COL + - title: Comoros + enum: + - COM + - title: Cabo Verde + enum: + - CPV + - title: Costa Rica + enum: + - CRI + - title: Cuba + enum: + - CUB + - title: Curaçao + enum: + - CUW + - title: Christmas Island + enum: + - CXR + - title: Cayman Islands + enum: + - CYM + - title: Cyprus + enum: + - CYP + - title: Czechia + enum: + - CZE + - title: Germany + enum: + - DEU + - title: Djibouti + enum: + - DJI + - title: Dominica + enum: + - DMA + - title: Denmark + enum: + - DNK + - title: Dominican Republic + enum: + - DOM + - title: Algeria + enum: + - DZA + - title: Ecuador + enum: + - ECU + - title: Egypt + enum: + - EGY + - title: Eritrea + enum: + - ERI + - title: Western Sahara + enum: + - ESH + - title: Spain + enum: + - ESP + - title: Estonia + enum: + - EST + - title: Ethiopia + enum: + - ETH + - title: Finland + enum: + - FIN + - title: Fiji + enum: + - FJI + - title: Falkland Islands (Malvinas) + enum: + - FLK + - title: France + enum: + - FRA + - title: Faroe Islands + enum: + - FRO + - title: Micronesia, Federated States of + enum: + - FSM + - title: Gabon + enum: + - GAB + - title: United Kingdom + enum: + - GBR + - title: Georgia + enum: + - GEO + - title: Guernsey + enum: + - GGY + - title: Ghana + enum: + - GHA + - title: Gibraltar + enum: + - GIB + - title: Guinea + enum: + - GIN + - title: Guadeloupe + enum: + - GLP + - title: Gambia + enum: + - GMB + - title: Guinea-Bissau + enum: + - GNB + - title: Equatorial Guinea + enum: + - GNQ + - title: Greece + enum: + - GRC + - title: Grenada + enum: + - GRD + - title: Greenland + enum: + - GRL + - title: Guatemala + enum: + - GTM + - title: French Guiana + enum: + - GUF + - title: Guam + enum: + - GUM + - title: Guyana + enum: + - GUY + - title: Hong Kong + enum: + - HKG + - title: Heard Island and McDonald Islands + enum: + - HMD + - title: Honduras + enum: + - HND + - title: Croatia + enum: + - HRV + - title: Haiti + enum: + - HTI + - title: Hungary + enum: + - HUN + - title: Indonesia + enum: + - IDN + - title: Isle of Man + enum: + - IMN + - title: India + enum: + - IND + - title: British Indian Ocean Territory + enum: + - IOT + - title: Ireland + enum: + - IRL + - title: Iran, Islamic Republic of + enum: + - IRN + - title: Iraq + enum: + - IRQ + - title: Iceland + enum: + - ISL + - title: Israel + enum: + - ISR + - title: Italy + enum: + - ITA + - title: Jamaica + enum: + - JAM + - title: Jersey + enum: + - JEY + - title: Jordan + enum: + - JOR + - title: Japan + enum: + - JPN + - title: Kazakhstan + enum: + - KAZ + - title: Kenya + enum: + - KEN + - title: Kyrgyzstan + enum: + - KGZ + - title: Cambodia + enum: + - KHM + - title: Kiribati + enum: + - KIR + - title: Saint Kitts and Nevis + enum: + - KNA + - title: Korea, Republic of + enum: + - KOR + - title: Kuwait + enum: + - KWT + - title: Lao People's Democratic Republic + enum: + - LAO + - title: Lebanon + enum: + - LBN + - title: Liberia + enum: + - LBR + - title: Libya + enum: + - LBY + - title: Saint Lucia + enum: + - LCA + - title: Liechtenstein + enum: + - LIE + - title: Sri Lanka + enum: + - LKA + - title: Lesotho + enum: + - LSO + - title: Lithuania + enum: + - LTU + - title: Luxembourg + enum: + - LUX + - title: Latvia + enum: + - LVA + - title: Macao + enum: + - MAC + - title: Saint Martin (French part) + enum: + - MAF + - title: Morocco + enum: + - MAR + - title: Monaco + enum: + - MCO + - title: Moldova, Republic of + enum: + - MDA + - title: Madagascar + enum: + - MDG + - title: Maldives + enum: + - MDV + - title: Mexico + enum: + - MEX + - title: Marshall Islands + enum: + - MHL + - title: Macedonia, the former Yugoslav Republic of + enum: + - MKD + - title: Mali + enum: + - MLI + - title: Malta + enum: + - MLT + - title: Myanmar + enum: + - MMR + - title: Montenegro + enum: + - MNE + - title: Mongolia + enum: + - MNG + - title: Northern Mariana Islands + enum: + - MNP + - title: Mozambique + enum: + - MOZ + - title: Mauritania + enum: + - MRT + - title: Montserrat + enum: + - MSR + - title: Martinique + enum: + - MTQ + - title: Mauritius + enum: + - MUS + - title: Malawi + enum: + - MWI + - title: Malaysia + enum: + - MYS + - title: Mayotte + enum: + - MYT + - title: Namibia + enum: + - NAM + - title: New Caledonia + enum: + - NCL + - title: Niger + enum: + - NER + - title: Norfolk Island + enum: + - NFK + - title: Nigeria + enum: + - NGA + - title: Nicaragua + enum: + - NIC + - title: Niue + enum: + - NIU + - title: Netherlands + enum: + - NLD + - title: Norway + enum: + - NOR + - title: Nepal + enum: + - NPL + - title: Nauru + enum: + - NRU + - title: New Zealand + enum: + - NZL + - title: Oman + enum: + - OMN + - title: Pakistan + enum: + - PAK + - title: Panama + enum: + - PAN + - title: Pitcairn + enum: + - PCN + - title: Peru + enum: + - PER + - title: Philippines + enum: + - PHL + - title: Palau + enum: + - PLW + - title: Papua New Guinea + enum: + - PNG + - title: Poland + enum: + - POL + - title: Puerto Rico + enum: + - PRI + - title: Korea, Democratic People's Republic of + enum: + - PRK + - title: Portugal + enum: + - PRT + - title: Paraguay + enum: + - PRY + - title: Palestine, State of + enum: + - PSE + - title: French Polynesia + enum: + - PYF + - title: Qatar + enum: + - QAT + - title: Réunion + enum: + - REU + - title: Romania + enum: + - ROU + - title: Russian Federation + enum: + - RUS + - title: Rwanda + enum: + - RWA + - title: Saudi Arabia + enum: + - SAU + - title: Sudan + enum: + - SDN + - title: Senegal + enum: + - SEN + - title: Singapore + enum: + - SGP + - title: South Georgia and the South Sandwich Islands + enum: + - SGS + - title: Saint Helena, Ascension and Tristan da Cunha + enum: + - SHN + - title: Svalbard and Jan Mayen + enum: + - SJM + - title: Solomon Islands + enum: + - SLB + - title: Sierra Leone + enum: + - SLE + - title: El Salvador + enum: + - SLV + - title: San Marino + enum: + - SMR + - title: Somalia + enum: + - SOM + - title: Saint Pierre and Miquelon + enum: + - SPM + - title: Serbia + enum: + - SRB + - title: South Sudan + enum: + - SSD + - title: Sao Tome and Principe + enum: + - STP + - title: Suriname + enum: + - SUR + - title: Slovakia + enum: + - SVK + - title: Slovenia + enum: + - SVN + - title: Sweden + enum: + - SWE + - title: Swaziland + enum: + - SWZ + - title: Sint Maarten (Dutch part) + enum: + - SXM + - title: Seychelles + enum: + - SYC + - title: Syrian Arab Republic + enum: + - SYR + - title: Turks and Caicos Islands + enum: + - TCA + - title: Chad + enum: + - TCD + - title: Togo + enum: + - TGO + - title: Thailand + enum: + - THA + - title: Tajikistan + enum: + - TJK + - title: Tokelau + enum: + - TKL + - title: Turkmenistan + enum: + - TKM + - title: Timor-Leste + enum: + - TLS + - title: Tonga + enum: + - TON + - title: Trinidad and Tobago + enum: + - TTO + - title: Tunisia + enum: + - TUN + - title: Turkey + enum: + - TUR + - title: Tuvalu + enum: + - TUV + - title: Taiwan, Province of China + enum: + - TWN + - title: Tanzania, United Republic of + enum: + - TZA + - title: Uganda + enum: + - UGA + - title: Ukraine + enum: + - UKR + - title: United States Minor Outlying Islands + enum: + - UMI + - title: Uruguay + enum: + - URY + - title: United States of America + enum: + - USA + - title: Uzbekistan + enum: + - UZB + - title: Holy See + enum: + - VAT + - title: Saint Vincent and the Grenadines + enum: + - VCT + - title: Venezuela, Bolivarian Republic of + enum: + - VEN + - title: Virgin Islands, British + enum: + - VGB + - title: Virgin Islands, U.S. + enum: + - VIR + - title: Viet Nam + enum: + - VNM + - title: Vanuatu + enum: + - VUT + - title: Wallis and Futuna + enum: + - WLF + - title: Samoa + enum: + - WSM + - title: Yemen + enum: + - YEM + - title: South Africa + enum: + - ZAF + - title: Zambia + enum: + - ZMB + - title: Zimbabwe + enum: + - ZWE + CitizenshipList: + type: object + properties: + Country: + type: array + items: + $ref: "#/paths/~1StudentPersonals~1%7BStudentPe\ + rsonalRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/Student\ + Personal/properties/PersonInfo/properties\ + /Demographics/properties/CountryOfBirth" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + CitizenshipStatus: + type: string + title: Citizenship Status + description: >- +

The citizenship or residency status of a + person, principally recorded in order to + determine eligibility for education services + hence limited to indicating New Zealand, + Australian or Other residency.

Based on + SIF Australia + AUCodeSetsAustralianCitizenshipStatusType

+
    +
  • 'AUCI' - Australian citizen
    • +
  • 'NZCI' - NZ citizen
    • +
  • 'OTOV' - Other overseas
    • +
  • 'NZRE' - NZ resident
    • +
  • 'NOPR' - Not provided
    • +
+ oneOf: + - title: Australian citizen + enum: + - AUCI + - title: NZ citizen + enum: + - NZCI + - title: Other overseas + description: Indicates a residency other than NZ or + Australia + enum: + - OTOV + - title: NZ resident + description: Includes Australian residents classified as + NZ resident once arrived in NZ + enum: + - NZRE + - title: Not provided + enum: + - NOPR + CitizenshipVerification: + description:

The verification event that verified the + residency status of the person. Absence of a + verification event indicates that the residency + was not verified against an identity document. +

+ type: object + properties: + Source: + $ref: "#/paths/~1StudentPersonals~1%7BStudentPers\ + onalRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StudentPerson\ + al/properties/PersonInfo/properties/OtherNa\ + meList/properties/Name/items/properties/Ver\ + ification/properties/Source" + DocumentSerialNumber: + type: string + description:

The serial number on the document that + was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document that was + used to verify the name or birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has been + confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StudentPersonals~1%7BStudentPers\ + onalRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StudentPerson\ + al/properties/PersonInfo/properties/OtherNa\ + meList/properties/Name/items/properties/Ver\ + ification/properties/Provider" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + Gender: + type: string + title: Gender + description: >- +

A Person may identify as having a Gender (or + Gender Identity). Biological sex and sexual + orientation are related but different concepts. + Sourced from Statistics NZ Standard for Gender + Identity

    +
  • '1' - Male - Tāne
    • +
  • '2' - Female - Wahine
    • +
  • '3' - Gender Diverse - Ira tāngata kōwhiri kore
    • +
  • '31' - Transgender Male to Female - Whakawahine
    • +
  • '32' - Transgender Female to Male - Tangata ira tāne
    • +
  • '9' - Not Willing to Disclose
    • +
+ oneOf: + - title*: + en: Male + mi: Tāne + enum: + - "1" + - title*: + en: Female + mi: Wahine + enum: + - "2" + - title*: + en: Gender Diverse + mi: Ira tāngata kōwhiri kore + description: But not further defined + enum: + - "3" + - title*: + en: Transgender Male to Female + mi: Whakawahine + description: '"Can be rolled up to 3:Gender Diverse"' + enum: + - "31" + - title*: + en: Transgender Female to Male + mi: Tangata ira tāne + description: '"Can be rolled up to 3:Gender Diverse"' + enum: + - "32" + - title*: + en: Not Willing to Disclose + enum: + - "9" + LanguageList: + description: List of languages an individual uses to + communicate. + type: object + properties: + Language: + type: array + items: + description:

A language that an individual uses to + communicate.

+ type: object + properties: + Code: + type: string + title: Language + description: >- +

Language refers to recognised human + communication systems, typically oral + and/or written. Sourced from + Statistics NZ - Language Standard + Classification 1999 v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not further defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not elsewhere + classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not further defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not elsewhere + classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not elsewhere + classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not further + defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not elsewhere + classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere classified + enum: + - NZS15199 + - title: Central-Eastern Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not further defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not elsewhere + classified + enum: + - NZS16199 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not elsewhere + classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western Malayo-Polynesian not + further defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western Malayo-Polynesian not + elsewhere classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere classified + enum: + - NZS18399 + - title: Niger-Congo (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not further + defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not elsewhere + classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not further + defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not elsewhere + classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not elsewhere + classified + enum: + - NZS219 + - title: Language Isolates not elsewhere + classified + enum: + - NZS21999 + - title: Miscellaneous Language Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous Languages + enum: + - NZS229 + - title: Other Miscellaneous Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not further + defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not elsewhere + classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not further defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not elsewhere + classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + Usage: + type: string + title: Language Usage + description: >- +

A standardised method of describing + the usage of a language by a person, + potentially indicating capability and + preference for the language.

    +
  • 'FL' - First Language
    • +
  • 'SL' - Secondary Language
    • +
  • 'SH' - Spoken At Home
    • +
+ oneOf: + - title: First Language + enum: + - FL + - title: Secondary Language + enum: + - SL + - title: Spoken At Home + enum: + - SH + Dialect: + type: string + description:

Specific dialect of a person's + language.

+ ProficiencyList: + description:

A list of the person's proficiency + in the language in regards to + speaking, reading and writing.

+ type: object + properties: + Proficiency: + type: array + items: + description:

The person's proficiency in + the language in regards to + speaking, reading and + writing.

+ type: object + properties: + Level: + type: string + title: Language Proficiency Level + description: >- +

The language proficiency + level.

    +
  • 'NO' - None
    • +
  • 'BE' - Beginner
    • +
  • 'IN' - Intermediate
    • +
  • 'AD' - Advanced
    • +
+ oneOf: + - title: None + enum: + - NO + - title: Beginner + enum: + - BE + - title: Intermediate + enum: + - IN + - title: Advanced + enum: + - AD + Type: + type: string + title: Language Proficiency Type + description: >- +

Code set denoting a type + of language proficiency, + e.g. speaking, writing + reading.

    +
  • 'SP' - Speaking
    • +
  • 'RE' - Reading
    • +
  • 'WR' - Writing
    • +
+ oneOf: + - title: Speaking + enum: + - SP + - title: Reading + enum: + - RE + - title: Writing + enum: + - WR + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + CountryArrivalDate: + type: string + format: date + description: Date the person first arrived in the country. + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + EthnicityList: + description:

One or more ethnic groups with which the + person identifies.

+ type: object + properties: + Ethnicity: + type: array + items: + description:

An ethnic group with which the person + identifies, and if there is more than one, + their order of preference.

+ type: object + properties: + PreferenceOrderNumber: + type: integer + description:

The order of preference for the + person's ethnicity.

+ Code: + type: string + title: Ethnicity + description: >- +

Ethnicity is the ethnic group or + groups that people identify with or + feel they belong to. Ethnicity is a + measure of cultural affiliation, as + opposed to race, ancestry, nationality + or citizenship. Ethnicity is self + perceived and people can belong to + more than one ethnic group.

The + permissible values consists of any + value from the Statistics NZ - + Ethnicity New Zealand Standard + Classification 2005 v2.0.0 Depending + on usage, ethnicity may be defined at + levels 1 to 4.

    +
  • '1' - European
    • +
  • '10' - European nfd
    • +
  • '100' - European nfd
    • +
  • '10000' - European nfd
    • +
  • '11' - New Zealand European
    • +
  • '111' - New Zealand European
    • +
  • '11111' - New Zealand European
    • +
  • '12' - Other European
    • +
  • '121' - British and Irish
    • +
  • '12100' - British nfd
    • +
  • '12111' - Celtic nfd
    • +
  • '12112' - Channel Islander
    • +
plus 250 more value(s) at NZCodeSetsEthnicityType + oneOf: + - title: European + enum: + - "1" + - title: European nfd + enum: + - "10" + - title: European nfd + enum: + - "100" + - title: European nfd + enum: + - "10000" + - title: New Zealand European + enum: + - "11" + - title: New Zealand European + enum: + - "111" + - title: New Zealand European + enum: + - "11111" + - title: Other European + enum: + - "12" + - title: British and Irish + enum: + - "121" + - title: British nfd + enum: + - "12100" + - title: Celtic nfd + enum: + - "12111" + - title: Channel Islander + enum: + - "12112" + - title: Cornish + enum: + - "12113" + - title: English + enum: + - "12114" + - title: Irish + enum: + - "12116" + - title: Manx + enum: + - "12117" + - title: Scottish + enum: + - "12119" + - title: Welsh + enum: + - "12121" + - title: British nec + enum: + - "12199" + - title: Dutch + enum: + - "122" + - title: Dutch + enum: + - "12211" + - title: Greek + enum: + - "123" + - title: Greek + enum: + - "12311" + - title: Polish + enum: + - "124" + - title: Polish + enum: + - "12411" + - title: South Slav + enum: + - "125" + - title: South Slav nfd + enum: + - "12500" + - title: Croatian + enum: + - "12511" + - title: Dalmatian + enum: + - "12512" + - title: Macedonian + enum: + - "12513" + - title: Serbian + enum: + - "12514" + - title: Slovenian + enum: + - "12515" + - title: Bosnian + enum: + - "12516" + - title: South Slav nec + enum: + - "12599" + - title: Italian + enum: + - "126" + - title: Italian + enum: + - "12611" + - title: German + enum: + - "127" + - title: German + enum: + - "12711" + - title: Australian + enum: + - "128" + - title: Australian + enum: + - "12811" + - title: Other European + enum: + - "129" + - title: Albanian + enum: + - "12911" + - title: Armenian + enum: + - "12912" + - title: Austrian + enum: + - "12913" + - title: Belgian + enum: + - "12914" + - title: Bulgarian + enum: + - "12915" + - title: Belorussian + enum: + - "12916" + - title: Cypriot nfd + enum: + - "12918" + - title: Czech + enum: + - "12919" + - title: Danish + enum: + - "12920" + - title: Estonian + enum: + - "12921" + - title: Finnish + enum: + - "12922" + - title: Flemish + enum: + - "12923" + - title: French + enum: + - "12924" + - title: Hungarian + enum: + - "12926" + - title: Icelandic + enum: + - "12927" + - title: Latvian + enum: + - "12928" + - title: Lithuanian + enum: + - "12929" + - title: Maltese + enum: + - "12930" + - title: Norwegian + enum: + - "12931" + - title: Portuguese + enum: + - "12932" + - title: Romanian + enum: + - "12933" + - title: Gypsy + enum: + - "12934" + - title: Russian + enum: + - "12935" + - title: Slavic + enum: + - "12937" + - title: Slovak + enum: + - "12938" + - title: Spanish + enum: + - "12939" + - title: Swedish + enum: + - "12940" + - title: Swiss + enum: + - "12941" + - title: Ukrainian + enum: + - "12942" + - title: American + enum: + - "12943" + - title: Canadian + enum: + - "12945" + - title: New Caledonian + enum: + - "12947" + - title: South African European + enum: + - "12948" + - title: Afrikaner + enum: + - "12949" + - title: Zimbabwean European + enum: + - "12950" + - title: European nec + enum: + - "12999" + - title: Māori + enum: + - "2" + - title: Māori + enum: + - "21" + - title: Māori + enum: + - "211" + - title: Māori + enum: + - "21111" + - title: Pacific Peoples + enum: + - "3" + - title: Pacific Peoples nfd + enum: + - "30" + - title: Pacific Peoples nfd + enum: + - "300" + - title: Pacific Peoples nfd + enum: + - "30000" + - title: Samoan + enum: + - "31" + - title: Samoan + enum: + - "311" + - title: Samoan + enum: + - "31111" + - title: Cook Islands Maori + enum: + - "32" + - title: Cook Islands Maori + enum: + - "321" + - title: Cook Islands Maori + enum: + - "32100" + - title: Tongan + enum: + - "33" + - title: Tongan + enum: + - "331" + - title: Tongan + enum: + - "33111" + - title: Niuean + enum: + - "34" + - title: Niuean + enum: + - "341" + - title: Niuean + enum: + - "34111" + - title: Tokelauan + enum: + - "35" + - title: Tokelauan + enum: + - "351" + - title: Tokelauan + enum: + - "35111" + - title: Fijian + enum: + - "36" + - title: Fijian + enum: + - "361" + - title: Fijian + enum: + - "36111" + - title: Other Pacific Peoples + enum: + - "37" + - title: Other Pacific Peoples + enum: + - "371" + - title: Indigenous Australian + enum: + - "37112" + - title: Hawaiian + enum: + - "37122" + - title: Kiribati + enum: + - "37124" + - title: Nauruan + enum: + - "37130" + - title: Papua New Guinean + enum: + - "37135" + - title: Pitcairn Islander + enum: + - "37137" + - title: Rotuman + enum: + - "37138" + - title: Tahitian + enum: + - "37140" + - title: Solomon Islander + enum: + - "37141" + - title: Tuvaluan + enum: + - "37144" + - title: Ni Vanuatu + enum: + - "37145" + - title: Pacific Peoples nec + enum: + - "37199" + - title: Asian + enum: + - "4" + - title: Asian nfd + enum: + - "40" + - title: Asian nfd + enum: + - "400" + - title: Asian nfd + enum: + - "40000" + - title: South East Asian + enum: + - "41" + - title: South East Asian nfd + enum: + - "410" + - title: South East Asian nfd + enum: + - "41000" + - title: Filipino + enum: + - "411" + - title: Filipino + enum: + - "41111" + - title: Cambodian + enum: + - "412" + - title: Cambodian + enum: + - "41211" + - title: Vietnamese + enum: + - "413" + - title: Vietnamese + enum: + - "41311" + - title: Other Southeast Asian + enum: + - "414" + - title: Burmese + enum: + - "41411" + - title: Indonesian + enum: + - "41412" + - title: Lao + enum: + - "41413" + - title: Malay + enum: + - "41414" + - title: Thai + enum: + - "41415" + - title: Karen + enum: + - "41416" + - title: Chin + enum: + - "41417" + - title: Southeast Asian nec + enum: + - "41499" + - title: Chinese + enum: + - "42" + - title: Chinese + enum: + - "421" + - title: Chinese nfd + enum: + - "42100" + - title: Hong Kong Chinese + enum: + - "42111" + - title: Cambodian Chinese + enum: + - "42112" + - title: Malaysian Chinese + enum: + - "42113" + - title: Singaporean Chinese + enum: + - "42114" + - title: Vietnamese Chinese + enum: + - "42115" + - title: Taiwanese + enum: + - "42116" + - title: Chinese nec + enum: + - "42199" + - title: Indian + enum: + - "43" + - title: Indian + enum: + - "431" + - title: Indian nfd + enum: + - "43100" + - title: Bengali + enum: + - "43111" + - title: Fijian Indian + enum: + - "43112" + - title: Indian Tamil + enum: + - "43114" + - title: Punjabi + enum: + - "43115" + - title: Sikh + enum: + - "43116" + - title: Anglo Indian + enum: + - "43117" + - title: Malaysian Indian + enum: + - "43118" + - title: South African Indian + enum: + - "43119" + - title: Indian nec + enum: + - "43199" + - title: Other Asian + enum: + - "44" + - title: Sri Lankan + enum: + - "441" + - title: Sri Lankan nfd + enum: + - "44100" + - title: Sinhalese + enum: + - "44111" + - title: Sri Lankan Tamil + enum: + - "44112" + - title: Sri Lankan nec + enum: + - "44199" + - title: Japanese + enum: + - "442" + - title: Japanese + enum: + - "44211" + - title: Korean + enum: + - "443" + - title: Korean + enum: + - "44311" + - title: Other Asian + enum: + - "444" + - title: Afghani + enum: + - "44411" + - title: Bangladeshi + enum: + - "44412" + - title: Nepalese + enum: + - "44413" + - title: Pakistani + enum: + - "44414" + - title: Tibetan + enum: + - "44415" + - title: Eurasian + enum: + - "44416" + - title: Bhutanese + enum: + - "44417" + - title: Maldivian + enum: + - "44418" + - title: Mongolian + enum: + - "44419" + - title: Asian nec + enum: + - "44499" + - title: Middle Eastern/Latin + American/African + enum: + - "5" + - title: Middle Eastern + enum: + - "51" + - title: Middle Eastern + enum: + - "511" + - title: Middle Eastern nfd + enum: + - "51100" + - title: Algerian + enum: + - "51111" + - title: Arab + enum: + - "51112" + - title: Assyrian + enum: + - "51113" + - title: Egyptian + enum: + - "51114" + - title: Iranian/Persian + enum: + - "51115" + - title: Iraqi + enum: + - "51116" + - title: Israeli/Jewish + enum: + - "51117" + - title: Jordanian + enum: + - "51118" + - title: Kurd + enum: + - "51119" + - title: Lebanese + enum: + - "51120" + - title: Moroccan + enum: + - "51122" + - title: Palestinian + enum: + - "51124" + - title: Syrian + enum: + - "51125" + - title: Turkish + enum: + - "51127" + - title: Middle Eastern nec + enum: + - "51199" + - title: Latin American + enum: + - "52" + - title: Latin American + enum: + - "521" + - title: Latin American nfd + enum: + - "52100" + - title: Argentinian + enum: + - "52111" + - title: Bolivian + enum: + - "52112" + - title: Brazilian + enum: + - "52113" + - title: Chilean + enum: + - "52114" + - title: Colombian + enum: + - "52115" + - title: Ecuadorian + enum: + - "52118" + - title: Mexican + enum: + - "52123" + - title: Peruvian + enum: + - "52127" + - title: Puerto Rican + enum: + - "52128" + - title: Uruguayan + enum: + - "52129" + - title: Venezuelan + enum: + - "52130" + - title: Latin American nec + enum: + - "52199" + - title: African + enum: + - "53" + - title: African + enum: + - "531" + - title: African nfd + enum: + - "53100" + - title: Jamaican + enum: + - "53113" + - title: Kenyan + enum: + - "53114" + - title: Nigerian + enum: + - "53115" + - title: African American + enum: + - "53116" + - title: Caribbean + enum: + - "53118" + - title: Somali + enum: + - "53119" + - title: Eritrean + enum: + - "53120" + - title: Ethiopian + enum: + - "53121" + - title: Ghanaian + enum: + - "53122" + - title: Burundian + enum: + - "53123" + - title: Congolese + enum: + - "53124" + - title: Sudanese + enum: + - "53125" + - title: Zambian + enum: + - "53126" + - title: Other Zimbabwean + enum: + - "53127" + - title: African nec + enum: + - "53199" + - title: Other Ethnicity + enum: + - "6" + - title: Other Ethnicity + enum: + - "61" + - title: Other Ethnicity + enum: + - "611" + - title: Indigenous American + enum: + - "61113" + - title: Mauritian + enum: + - "61115" + - title: Seychellois + enum: + - "61116" + - title: Other South African + enum: + - "61117" + - title: New Zealander + enum: + - "61118" + - title: Other Ethnicity nec + enum: + - "61199" + - title: Residual Categories + enum: + - "9" + - title: Don't Know + enum: + - "94" + - title: Don't Know + enum: + - "944" + - title: Don't Know + enum: + - "94444" + - title: Refused to Answer + enum: + - "95" + - title: Refused to Answer + enum: + - "955" + - title: Refused to Answer + enum: + - "95555" + - title: Repeated Value + enum: + - "96" + - title: Repeated Value + enum: + - "966" + - title: Repeated Value + enum: + - "96666" + - title: Response Unidentifiable + enum: + - "97" + - title: Response Unidentifiable + enum: + - "977" + - title: Response Unidentifiable + enum: + - "97777" + - title: Response Outside Scope + enum: + - "98" + - title: Response Outside Scope + enum: + - "988" + - title: Response Outside Scope + enum: + - "98888" + - title: Not Stated + enum: + - "99" + - title: Not Stated + enum: + - "999" + - title: Not Stated + enum: + - "99999" + IwiAffiliationList: + description:

A list of one or more iwi with which the + person has an affiliation.

+ type: object + properties: + IwiAffiliation: + type: array + items: + type: string + title: Iwi + description: >- +

An iwi, or Māori tribe, is one of the + largest kinship groupings and is generally + made up of several hapū that are all + descended from a common ancestor. Hapū are + clusters of whānau where the whānau is + usually an extended family grouping + consisting of children, parents, often + grandparents, and other closely related + kin.

Sourced from Statistics NZ - + Iwi and Iwi related groups statistical + standard v1.0.0.0

    +
  • 'NZS01' - Te Tai Tokerau/Tāmaki-makaurau (Northland/Auckland) Region Iwi
    • +
  • 'NZS0101' - Te Aupōuri
    • +
  • 'NZS0102' - Ngāti Kahu
    • +
  • 'NZS0103' - Ngāti Kurī
    • +
  • 'NZS0104' - Ngāpuhi
    • +
  • 'NZS0105' - Ngāpuhi ki Whaingaroa-Ngāti Kahu ki Whaingaroa
    • +
  • 'NZS0106' - Te Rarawa
    • +
  • 'NZS0107' - Ngāi Takoto
    • +
  • 'NZS0108' - Ngāti Wai
    • +
  • 'NZS0109' - Ngāti Whātua (not Ōrākei or Kaipara)
    • +
  • 'NZS0110' - Te Kawerau ā Maki
    • +
  • 'NZS0111' - Te Uri-o-Hau
    • +
plus 183 more value(s) at NZCodeSetsIwiType + oneOf: + - title: Te Tai Tokerau/Tāmaki-makaurau + (Northland/Auckland) Region Iwi + enum: + - NZS01 + - title: Te Aupōuri + enum: + - NZS0101 + - title: Ngāti Kahu + enum: + - NZS0102 + - title: Ngāti Kurī + enum: + - NZS0103 + - title: Ngāpuhi + enum: + - NZS0104 + - title: Ngāpuhi ki Whaingaroa-Ngāti Kahu ki + Whaingaroa + enum: + - NZS0105 + - title: Te Rarawa + enum: + - NZS0106 + - title: Ngāi Takoto + enum: + - NZS0107 + - title: Ngāti Wai + enum: + - NZS0108 + - title: Ngāti Whātua (not Ōrākei or Kaipara) + enum: + - NZS0109 + - title: Te Kawerau ā Maki + enum: + - NZS0110 + - title: Te Uri-o-Hau + enum: + - NZS0111 + - title: Te Roroa + enum: + - NZS0112 + - title: Ngāti Whātua o Kaipara + enum: + - NZS0113 + - title: Ngāti Whātua o Ōrākei + enum: + - NZS0114 + - title: Ngāi Tai ki Tāmaki + enum: + - NZS0115 + - title: Ngāti Hine (Te Tai Tokerau) + enum: + - NZS0116 + - title: Te Paatu + enum: + - NZS0117 + - title: Ngāti Manuhiri + enum: + - NZS0118 + - title: Ngāti Rēhua + enum: + - NZS0119 + - title: Hauraki (Coromandel) Region Iwi + enum: + - NZS02 + - title: Ngāti Hako + enum: + - NZS0201 + - title: Ngāti Hei + enum: + - NZS0202 + - title: Ngāti Maru (Hauraki) + enum: + - NZS0203 + - title: Ngāti Paoa + enum: + - NZS0204 + - title: Patukirikiri + enum: + - NZS0205 + - title: Ngāti Porou ki Harataunga ki Mataora + enum: + - NZS0206 + - title: Ngāti Pūkenga ki Waiau + enum: + - NZS0207 + - title: Ngāti Rāhiri Tumutumu + enum: + - NZS0208 + - title: Ngāti Tamaterā + enum: + - NZS0210 + - title: Ngāti Tara Tokanui + enum: + - NZS0211 + - title: Ngāti Whanaunga + enum: + - NZS0212 + - title: Waikato/Te Rohe Pōtae (Waikato/King + Country) Region Iwi + enum: + - NZS03 + - title: Ngāti Haua (Waikato) + enum: + - NZS0301 + - title: Ngāti Maniapoto + enum: + - NZS0302 + - title: Raukawa (Waikato) + enum: + - NZS0303 + - title: Waikato + enum: + - NZS0304 + - title: Ngāti Te Ata + enum: + - NZS0305 + - title: Ngāti Hīkairo + enum: + - NZS0306 + - title: Rereahu + enum: + - NZS0307 + - title: Ngāti Tiipa + enum: + - NZS0308 + - title: Ngāti Korokī Kahukura + enum: + - NZS0309 + - title: Ngāti Tamaoho + enum: + - NZS0310 + - title: Te Ākitai-Waiohua + enum: + - NZS0311 + - title: Te Arawa/Taupō (Rotorua/Taupō) Region + Iwi + enum: + - NZS04 + - title: Ngāti Pikiao (Te Arawa) + enum: + - NZS0401 + - title: Ngāti Rangiteaorere (Te Arawa) + enum: + - NZS0402 + - title: Ngāti Rangitihi (Te Arawa) + enum: + - NZS0403 + - title: Ngāti Rangiwewehi (Te Arawa) + enum: + - NZS0404 + - title: Tapuika (Te Arawa) + enum: + - NZS0405 + - title: Ngāti Tarāwhai (Te Arawa) + enum: + - NZS0406 + - title: Tūhourangi (Te Arawa) + enum: + - NZS0407 + - title: Uenuku-Kōpako (Te Arawa) + enum: + - NZS0408 + - title: Waitaha (Te Arawa) + enum: + - NZS0409 + - title: Ngāti Whakaue (Te Arawa) + enum: + - NZS0410 + - title: Ngāti Tūwharetoa (ki Taupō) + enum: + - NZS0411 + - title: Ngāti Tahu-Ngāti Whaoa (Te Arawa) + enum: + - NZS0412 + - title: Ngāti Mākino + enum: + - NZS0413 + - title: Ngāti Kearoa / Ngāti Tuarā + enum: + - NZS0414 + - title: Ngāti Rongomai (Te Arawa) + enum: + - NZS0415 + - title: Tauranga Moana/Mātaatua (Bay of + Plenty) Region Iwi + enum: + - NZS05 + - title: Ngāti Pūkenga + enum: + - NZS0501 + - title: Ngāi Te Rangi + enum: + - NZS0502 + - title: Ngāti Ranginui + enum: + - NZS0503 + - title: Ngāti Awa + enum: + - NZS0504 + - title: Ngāti Manawa + enum: + - NZS0505 + - title: Ngāi Tai (Tauranga Moana/Mātaatua) + enum: + - NZS0506 + - title: Tūhoe + enum: + - NZS0507 + - title: Whakatōhea + enum: + - NZS0508 + - title: Te Whānau-ā-Apanui + enum: + - NZS0509 + - title: Ngāti Whare + enum: + - NZS0510 + - title: Ngā Pōtiki ā Tamapahore + enum: + - NZS0511 + - title: Te Upokorehe + enum: + - NZS0512 + - title: Ngāti Tūwharetoa ki Kawerau + enum: + - NZS0513 + - title: Te Tai Rāwhiti (East Coast) Region Iwi + enum: + - NZS06 + - title: Ngāti Porou + enum: + - NZS0601 + - title: Te Aitanga-a-Māhaki + enum: + - NZS0602 + - title: Rongowhakaata + enum: + - NZS0603 + - title: Ngāi Tāmanuhiri + enum: + - NZS0604 + - title: Te Aitanga ā Hauiti + enum: + - NZS0605 + - title: Te Matau-a-Māui/Wairarapa (Hawke's + Bay/Wairarapa) Region Iwi + enum: + - NZS07 + - title: Rongomaiwahine (Te Māhia) + enum: + - NZS0701 + - title: Ngāti Kahungunu ki Te Wairoa + enum: + - NZS0702 + - title: Ngāti Kahungunu ki Heretaunga + enum: + - NZS0703 + - title: Ngāti Kahungunu ki Wairarapa + enum: + - NZS0704 + - title: Rangitāne (Te Matau-a-Māui/Hawke's + Bay/Wairarapa) + enum: + - NZS0706 + - title: Ngāti Kahungunu ki Te Whanganui-a-Orotu + enum: + - NZS0707 + - title: Ngāti Kahungunu ki Tamatea + enum: + - NZS0708 + - title: Ngāti Kahungunu ki Tamakinui a Rua + enum: + - NZS0709 + - title: Ngāti Pāhauwera + enum: + - NZS0710 + - title: Ngāti Rākaipaaka + enum: + - NZS0711 + - title: Ngāti Hineuru + enum: + - NZS0712 + - title: Maungaharuru Tangitū + enum: + - NZS0713 + - title: Rangitāne o Tamaki nui ā Rua + enum: + - NZS0714 + - title: Ngāti Ruapani ki Waikaremoana + enum: + - NZS0715 + - title: Te Hika o Pāpāuma + enum: + - NZS0716 + - title: Taranaki Region Iwi + enum: + - NZS08 + - title: Te Atiawa (Taranaki) + enum: + - NZS0801 + - title: Ngāti Maru (Taranaki) + enum: + - NZS0802 + - title: Ngāti Mutunga (Taranaki) + enum: + - NZS0803 + - title: Ngā Rauru + enum: + - NZS0804 + - title: Ngā Ruahine + enum: + - NZS0805 + - title: Ngāti Ruanui + enum: + - NZS0806 + - title: Ngāti Tama (Taranaki) + enum: + - NZS0807 + - title: Taranaki + enum: + - NZS0808 + - title: Tangāhoe + enum: + - NZS0809 + - title: Pakakohi + enum: + - NZS0810 + - title: Whanganui/Rangitīkei + (Wanganui/Rangitīkei) Region Iwi + enum: + - NZS09 + - title: Ngāti Apa (Rangitīkei) + enum: + - NZS0901 + - title: Te Ati Haunui-a-Pāpārangi + enum: + - NZS0902 + - title: Ngāti Haua (Taumarunui) + enum: + - NZS0903 + - title: Ngāti Hauiti (Rangitīkei) + enum: + - NZS0904 + - title: Ngāti Whitikaupeka (Rangitīkei) + enum: + - NZS0905 + - title: Ngāi Te Ohuake (Rangitīkei) + enum: + - NZS0906 + - title: Ngāti Tamakōpiri (Rangitīkei) + enum: + - NZS0907 + - title: Ngāti Rangi (Ruapehu, Whanganui) + enum: + - NZS0908 + - title: Uenuku (Ruapehu, Waimarino) + enum: + - NZS0909 + - title: Tamahaki (Ruapehu, Waimarino) + enum: + - NZS0910 + - title: Tamakana (Ruapehu, Waimarino) + enum: + - NZS0911 + - title: Manawatū/Horowhenua/Te + Whanganui-a-Tara + (Manawatū/Horowhenua/Wellington) + Region Iwi + enum: + - NZS10 + - title: Te Atiawa (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1001 + - title: Muaūpoko + enum: + - NZS1002 + - title: Rangitāne (Manawatū) + enum: + - NZS1003 + - title: Ngāti Raukawa (Horowhenua/Manawatū) + enum: + - NZS1004 + - title: Ngāti Toarangatira (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1005 + - title: Te Atiawa ki Whakarongotai + enum: + - NZS1006 + - title: Ngāti Tama ki Te Upoko o Te Ika (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1007 + - title: Ngāti Kauwhata + enum: + - NZS1008 + - title: Ngāti Tukorehe + enum: + - NZS1009 + - title: Te Waipounamu/Wharekauri (South + Island/Chatham Islands) Region Iwi + enum: + - NZS11 + - title: Te Atiawa (Te Waipounamu/South Island) + enum: + - NZS1101 + - title: Ngāti Koata + enum: + - NZS1102 + - title: Ngāti Kuia + enum: + - NZS1103 + - title: Kāti Māmoe + enum: + - NZS1104 + - title: Moriori + enum: + - NZS1105 + - title: Ngāti Mutunga (Wharekauri/Chatham + Islands) + enum: + - NZS1106 + - title: Rangitāne (Te Waipounamu/South Island) + enum: + - NZS1107 + - title: Ngāti Rārua + enum: + - NZS1108 + - title: Ngāi Tahu / Kāi Tahu + enum: + - NZS1109 + - title: Ngāti Tama (Te Waipounamu/South Island) + enum: + - NZS1110 + - title: Ngāti Toarangatira (Te + Waipounamu/South Island) + enum: + - NZS1111 + - title: Waitaha (Te Waipounamu/South Island) + enum: + - NZS1112 + - title: Ngāti Apa ki Te Rā Tō + enum: + - NZS1113 + - title: Confederations and Waka, iwi not named + enum: + - NZS20 + - title: Tainui, iwi not named + enum: + - NZS2001 + - title: Te Arawa, iwi not named + enum: + - NZS2002 + - title: Tākitimu, iwi not named + enum: + - NZS2003 + - title: Aotea, iwi not named + enum: + - NZS2004 + - title: Mātaatua, iwi not named + enum: + - NZS2005 + - title: Mahuru, iwi not named + enum: + - NZS2006 + - title: Māmari, iwi not named + enum: + - NZS2007 + - title: Ngātokimatawhaorua, iwi not named + enum: + - NZS2008 + - title: Nukutere, iwi not named + enum: + - NZS2009 + - title: Tokomaru, iwi not named + enum: + - NZS2010 + - title: Kurahaupō, iwi not named + enum: + - NZS2011 + - title: Muriwhenua, iwi not named + enum: + - NZS2012 + - title: Hauraki / Pare Hauraki, iwi not named + enum: + - NZS2013 + - title: Tūranganui a Kiwa, iwi not named + enum: + - NZS2014 + - title: Te Tauihu o Te Waka a Māui, iwi not + named + enum: + - NZS2015 + - title: Tauranga Moana, iwi not named + enum: + - NZS2016 + - title: Horouta, iwi not named + enum: + - NZS2017 + - title: Mōkai Pātea, iwi not named + enum: + - NZS2018 + - title: Iwi named, region not known + enum: + - NZS21 + - title: Te Atiawa, region not known + enum: + - NZS2101 + - title: Ngāti Haua, region not known + enum: + - NZS2102 + - title: Ngāti Maru, region not known + enum: + - NZS2103 + - title: Ngāti Mutunga, region not known + enum: + - NZS2104 + - title: Rangitāne, region not known + enum: + - NZS2105 + - title: Ngāti Raukawa, region not known + enum: + - NZS2106 + - title: Ngāti Tama, region not known + enum: + - NZS2107 + - title: Ngāti Toa, region not known + enum: + - NZS2108 + - title: Waitaha, region not known + enum: + - NZS2109 + - title: Ngāti Apa, region not known + enum: + - NZS2110 + - title: Ngāi Tai, region not known + enum: + - NZS2111 + - title: Ngāti Kahungunu, region not known + enum: + - NZS2112 + - title: Ngāti Tūwharetoa, region not known + enum: + - NZS2113 + - title: Hapū affiliated to more than one iwi + enum: + - NZS22 + - title: Hapū affiliated to more than one iwi + enum: + - NZS2201 + - title: Region known, Iwi not named + enum: + - NZS23 + - title: Te Tai Tokerau/Tāmaki-makaurau Region, + Iwi not named + enum: + - NZS2301 + - title: Hauraki Region, Iwi not named + enum: + - NZS2302 + - title: Waikato/Te Rohe Pōtae Region, Iwi not + named + enum: + - NZS2303 + - title: Te Arawa/Taupō Region, Iwi not named + enum: + - NZS2304 + - title: Tauranga Moana/Mātaatua Region, Iwi + not named + enum: + - NZS2305 + - title: Te Tai Rāwhiti Region, Iwi not named + enum: + - NZS2306 + - title: Te Matau-a-Māui/Wairarapa Region, Iwi + not named + enum: + - NZS2307 + - title: Taranaki Region, Iwi not named + enum: + - NZS2308 + - title: Whanganui/Rangitīkei Region, Iwi not + named + enum: + - NZS2309 + - title: Manawatū/Horowhenua/Te + Whanganui-a-Tara Region, Iwi not named + enum: + - NZS2310 + - title: Te Waipounamu/Wharekauri Region, Iwi + not named + enum: + - NZS2311 + - title: Don't Know + enum: + - NZS44 + - title: Refused To Answer + enum: + - NZS55 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + ReligiousAffiliationList: + description:

A list of one or more religions with which + the person has an affiliation.

+ type: object + properties: + ReligiousAffiliation: + type: array + items: + type: string + title: Religion + description: >- +

Religious affiliation is the + self-identified association of a person + with a religion, denomination or + sub-denominational religious group.

+

Sourced from Statistics NZ - Religious + Affiliation 1999 v1.0.0.0

    +
  • 'NZS0' - No Religion
    • +
  • 'NZS1' - Buddhist
    • +
  • 'NZS101' - Buddhist
    • +
  • 'NZS10101' - Zen Buddhist
    • +
  • 'NZS10199' - Buddhist nec
    • +
  • 'NZS2' - Christian
    • +
  • 'NZS201' - Adventist
    • +
  • 'NZS20101' - Christadelphian
    • +
  • 'NZS20102' - Seventh Day Adventist
    • +
  • 'NZS20103' - Worldwide Church of God
    • +
  • 'NZS20199' - Adventist nec
    • +
  • 'NZS202' - Anglican
    • +
plus 117 more value(s) at NZCodeSetsReligionType + oneOf: + - title: No Religion + enum: + - NZS0 + - title: Buddhist + enum: + - NZS1 + - title: Buddhist + enum: + - NZS101 + - title: Zen Buddhist + enum: + - NZS10101 + - title: Buddhist nec + enum: + - NZS10199 + - title: Christian + enum: + - NZS2 + - title: Adventist + enum: + - NZS201 + - title: Christadelphian + enum: + - NZS20101 + - title: Seventh Day Adventist + enum: + - NZS20102 + - title: Worldwide Church of God + enum: + - NZS20103 + - title: Adventist nec + enum: + - NZS20199 + - title: Anglican + enum: + - NZS202 + - title: Asian Christian + enum: + - NZS203 + - title: Chinese Christian + enum: + - NZS20301 + - title: Korean Christian + enum: + - NZS20302 + - title: Baptist + enum: + - NZS204 + - title: Bible Baptist + enum: + - NZS20401 + - title: Independent Baptist + enum: + - NZS20402 + - title: Reformed Baptist + enum: + - NZS20403 + - title: Baptist nec + enum: + - NZS20499 + - title: Brethren + enum: + - NZS205 + - title: Exclusive Brethren + enum: + - NZS20501 + - title: Open Brethren + enum: + - NZS20502 + - title: Plymouth Brethren + enum: + - NZS20503 + - title: Brethren nec + enum: + - NZS20599 + - title: Catholic + enum: + - NZS206 + - title: Roman Catholic + enum: + - NZS20601 + - title: Catholic nec + enum: + - NZS20699 + - title: Church of Christ and Associated + Churches of Christ + enum: + - NZS207 + - title: Associated Churches of Christ + enum: + - NZS20701 + - title: Other Church of Christ and Churches of + Christ nec + enum: + - NZS20799 + - title: Evangelical, Born Again and + Fundamentalist + enum: + - NZS208 + - title: Evangelical + enum: + - NZS20801 + - title: Born Again + enum: + - NZS20802 + - title: Fundamentalist + enum: + - NZS20803 + - title: Independent Evangelical Churches + enum: + - NZS20804 + - title: Jehovah's Witnesses + enum: + - NZS209 + - title: Jehovah's Witnesses + enum: + - NZS20901 + - title: Latter-day Saints + enum: + - NZS210 + - title: Lutheran + enum: + - NZS211 + - title: Methodist + enum: + - NZS212 + - title: Tongan Methodist + enum: + - NZS21201 + - title: Methodist nec + enum: + - NZS21299 + - title: Orthodox + enum: + - NZS213 + - title: Assyrian Orthodox + enum: + - NZS21301 + - title: Coptic Orthodox + enum: + - NZS21302 + - title: Greek Orthodox + enum: + - NZS21303 + - title: Russian Orthodox + enum: + - NZS21304 + - title: Serbian Orthodox + enum: + - NZS21305 + - title: Orthodox nec + enum: + - NZS21399 + - title: Pentecostal + enum: + - NZS214 + - title: Apostolic Church of New Zealand + enum: + - NZS21401 + - title: Assemblies of God + enum: + - NZS21402 + - title: Christian Fellowship + enum: + - NZS21403 + - title: Christian Outreach + enum: + - NZS21404 + - title: Christian Revival Crusade + enum: + - NZS21405 + - title: Elim + enum: + - NZS21406 + - title: Full Gospel + enum: + - NZS21407 + - title: Independent Pentecostal + enum: + - NZS21408 + - title: New Life Centres + enum: + - NZS21409 + - title: Revival Centres + enum: + - NZS21410 + - title: United Pentecostal + enum: + - NZS21411 + - title: Vineyard Christian Fellowship + enum: + - NZS21412 + - title: Pentecostal nec + enum: + - NZS21499 + - title: Presbyterian, Congregational and + Reformed + enum: + - NZS215 + - title: Presbyterian + enum: + - NZS21501 + - title: Congregational + enum: + - NZS21502 + - title: Cook Island Congregational + enum: + - NZS21503 + - title: Samoan Congregational + enum: + - NZS21504 + - title: Reformed + enum: + - NZS21505 + - title: Protestant + enum: + - NZS216 + - title: Salvation Army + enum: + - NZS217 + - title: Uniting/Union Church and Ecumenical + enum: + - NZS218 + - title: Uniting/Union Church + enum: + - NZS21801 + - title: Ecumenical + enum: + - NZS21802 + - title: Other Christian + enum: + - NZS299 + - title: Christian and Missionary Alliance + enum: + - NZS29901 + - title: Christian Science + enum: + - NZS29902 + - title: Church of God + enum: + - NZS29903 + - title: Commonwealth Covenant Church + enum: + - NZS29904 + - title: Liberal Catholic + enum: + - NZS29905 + - title: Metropolitan + enum: + - NZS29906 + - title: Nazarene + enum: + - NZS29907 + - title: Religious Society of Friends (Quaker) + enum: + - NZS29908 + - title: Unitarian + enum: + - NZS29909 + - title: Hindu + enum: + - NZS3 + - title: Hare Krishna + enum: + - NZS30101 + - title: Yoga + enum: + - NZS30102 + - title: Islam/Muslim + enum: + - NZS4 + - title: Sufi + enum: + - NZS40101 + - title: Judaism/Jewish + enum: + - NZS5 + - title: Māori Christian + enum: + - NZS6 + - title: Ratana + enum: + - NZS601 + - title: Ringatū + enum: + - NZS602 + - title: Other Māori Christian + enum: + - NZS609 + - title: Spiritualism and New Age Religions + enum: + - NZS7 + - title: Church of Scientology + enum: + - NZS701 + - title: Nature and Earth Based Religions + enum: + - NZS702 + - title: Animist + enum: + - NZS70201 + - title: Druid + enum: + - NZS70202 + - title: Pantheist + enum: + - NZS70203 + - title: Wiccan + enum: + - NZS70204 + - title: Satanism + enum: + - NZS703 + - title: Spiritualist + enum: + - NZS704 + - title: Other New Age Religions + enum: + - NZS709 + - title: Rastafarianism + enum: + - NZS70901 + - title: Other Religions + enum: + - NZS8 + - title: Baha'i + enum: + - NZS801 + - title: Chinese Religions + enum: + - NZS802 + - title: Confucianism + enum: + - NZS80201 + - title: Taoism + enum: + - NZS80202 + - title: Jainism + enum: + - NZS803 + - title: Japanese Religion + enum: + - NZS804 + - title: Mahikari + enum: + - NZS80401 + - title: Shinto + enum: + - NZS80402 + - title: Tenrikyo + enum: + - NZS80403 + - title: Māori Religion + enum: + - NZS805 + - title: Hauhau + enum: + - NZS80501 + - title: Sikh + enum: + - NZS806 + - title: Theism + enum: + - NZS807 + - title: Zoroastrian + enum: + - NZS808 + - title: Other Religions + enum: + - NZS809 + - title: Unification Church (Moonist) + enum: + - NZS80901 + - title: Other Religions nec + enum: + - NZS80999 + - title: Don't Know + enum: + - NZS944 + - title: Object to answering + enum: + - NZS955 + - title: Religion Unidentifiable + enum: + - NZS977 + - title: Response Outside Scope + enum: + - NZS988 + - title: Not Stated + enum: + - NZS999 + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + AddressList: + description: The person's address(es) - one or more addresses + type: object + properties: + Address: + type: array + items: + description:

This element contains address data.

+ type: object + properties: + Type: + type: string + title: Address Type + description: >- +

Address type allows an address to be + categorised according to its component + structure. Address type can be used to + build processing rules for validating, + managing and presenting addresses. Address + type is independent of the use of the + address by any party. To describe how a + party may use an address (residence, + billing, term address etc) see + AddressRoleType

    +
  • 'TH' - Thoroughfare
    • +
  • 'RU' - Rural Post Delivery
    • +
  • 'DE' - Delivery Service
    • +
  • 'WA' - Water
    • +
  • 'FO' - Foreign Address
    • +
+ oneOf: + - title: Thoroughfare + description: "\"

Also called 'Street' addresses, + The most general, and widely used type + of address, and can contain the widest + variety of components

In + general a thoroughfare address will + include components for a number, a + roadname, and a locality.

They + cannot contain any of the components + specific to a delivery service, rural + post delivery, or water address.

+

These addresses are used to find a + location.

Example: 30 - 40 + Lambton Quay, Wellington, 6165

\"" + enum: + - TH + - title: Rural Post Delivery + description: '"

Defined by New Zealand Post, + these addresses are assigned by NZ + Post for customers who purchase a + rural delivery service (mail and also + other goods).

They will have + the same number and roadname + components as the street address, and + may have the same region + component.

They do not have a + component that identifies the locality + the address is within. The locality + and city or town components are + replaced by components that identify + the rural delivery route (RD number), + and the town from which the rural + delivery route starts and finishes + (the mail town). Only addresses of + this class can contain these + components.

Example: + 121 Waitaha Road, RD 1, Ross, + 7885

"' + enum: + - RU + - title: Delivery Service + description: '"

Defined by New Zealand Post, and + used exclusively for NZ Post services + other than standard mail delivery. + Addresses in this class include PO + Box, Private Bag, and Counter Delivery + addresses.

Example: + Private Bag 2345, Auckland, 1142

"' + enum: + - DE + - title: Water + description: '"

Where properties have no road + access, but do have access to water + frontage (coastline or riverbank or + lakefront), a water address uses the + name of a water feature (for example, + islands, rivers, bays, or + peninsulas).

Example: + 235 Lochmara Bay, Queen Charlotte + Sound, Marlborough Sounds

"' + enum: + - WA + - title: Foreign Address + description: '"

A foreign address identifies a + location outside of New Zealand.

+

Example: + Rudolf-Diesel-Strasse 14, 54595 Prüm, + Germany

"' + enum: + - FO + Role: + type: string + title: Address Role + description: >- +

A standardised description of the role + or usage of an address by a party (person + or organisation). Where a party has more + than one address, this provides context + for deciding which address to use.

+
    +
  • 'PHY' - Physical Address
    • +
  • 'POS' - Postal Address
    • +
+ oneOf: + - title: Physical Address + description: Applies to addresses associated with + persons + enum: + - PHY + - title: Postal Address + description: Applies to addresses associated with + persons or organisations + enum: + - POS + Street: + description:

The street element is a complex element + and breaks the street down into several + parts. (Allow for PO Box here)

+ type: object + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban addresses, or + the 'RD No' part of rural addresses

+ City: + type: string + description:

The city part of the address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only applicable if a + non-New Zealand Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are derived + from New Zealand Map Grid x,y coordinates + and converted to Latitude and Longitude + values per the World Geodetic System 1984 + (G1762)

+ type: object + properties: + Latitude: + description:

Latitude in decimal degrees.

+

Latitudes north of the equator are + positive, latitudes south of the + equator are negative [ISO 6709].

+ Longitude: + description:

Longitude in decimal degrees.

+

Longitudes east of the Prime + Meridian in Greenwich are positive, + longitudes west of the Prime Meridian + are negative. The 180th meridian is + negative. [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas containing + the location.

The list may contain + exactly one StatisticalArea element for + each of the following spatial unit + types:

  • Ward
  • Urban + Area
  • Census Area Unit
    • +
  • Māori Electorate
  • Mesh + Block
  • General Electorate
    • +
  • Territorial Authority
  • Local + Board (Auckland Only)
  • Regional + Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical area + defined by Statistics New + Zealand.

+ type: object + properties: + SpatialUnitType: + type: string + title: Spatial Unit Type + description: >- +

A classification of + geographical boundaries or + statistical areas as defined by + Statistics NZ’s geographic + hierarchy.

    +
  • 'AE' - Area Unit
    • +
  • 'GE' - General Electoral District
    • +
  • 'CB' - Community Board
    • +
  • 'ME' - Māori Electoral District
    • +
  • 'MB' - Mesh Block
    • +
  • 'RC' - Regional Council
    • +
  • 'TA' - Territorial Authority
    • +
  • 'UA' - Urban Area
    • +
  • 'WA' - Ward
    • +
+ oneOf: + - title: Area Unit + description:

Area units are + aggregations of meshblocks. + They are non–administrative + areas that are in between + meshblocks and territorial + authorities in size. Area + units must either define or + aggregate to define, + regional councils, + territorial authorities and + urban areas.

Statistics + NZ Classification of Area + Unit 2013 v1.0.0 + enum: + - AE + - title: General Electoral District + description:

The general electoral + districts as constituted + under the Electoral Act + 1993.

Statistics NZ + General Electoral District + 2014 v1.0.0 + enum: + - GE + - title: Community Board + description:

(aka Local Board within + Auckland) Local boards + provide governance at the + local level within Auckland + Council. They enable + democratic decision making + by, and on behalf of + communities within the local + board area.

Statistics + NZ Community Board 2013 + v1.0.0 + enum: + - CB + - title: Māori Electoral District + description:

Māori electoral districts + are the voting districts for + parliamentary elections for + people who choose to be on + the Māori Electoral + Roll.

Statistics NZ + Māori Electoral District + 2014 v1.0.0 + enum: + - ME + - title: Mesh Block + description:

A meshblock is the + smallest geographic unit for + which statistical data is + collected and processed by + Statistics New Zealand.

+

A meshblock is defined by + a geographic area, which can + vary in size from part of a + city block to a large area + of rural land. Each + meshblock borders on another + to form a network covering + all of New Zealand, + including coasts and inlets + and extending out to the + 200-mile economic zone.

+ Statistics NZ Statistical + Standard for Meshblock 2013 + v1.0.0 + enum: + - MB + - title: Regional Council + description:

The top tier of local + government in New Zealand, + defined by the Local + Government Act 2002, which + requires the boundaries of + regions to conform as far as + possible to one or more + water catchments. When + determining regional + boundaries, the Local + Government Commission gave + consideration to regional + communities of interest when + selecting water catchments + to be included in a region. + It also considered factors + such as natural resource + management, land use + planning and environmental + matters.

Statistics NZ + Regional Council 2013 v1.0.0 + enum: + - RC + - title: Territorial Authority + description:

The second tier of local + government in New Zealand, + defined under the Local + Government Act 2002 as a + city council or district + council. There are 67 + territorial authorities + consisting of 12 city + councils, 53 districts, + Auckland Council, and + Chatham Islands Council.

+ Statistics NZ Territorial + Authority 2013 v1.0.0 + enum: + - TA + - title: Urban Area + description: '"

Urban Areas are + statistically defined areas + with no administrative or + legal basis. There is a + three part hierarchical + sub-division of urban areas + into: main urban areas, + secondary urban areas, minor + urban areas. Together the + populations in main, + secondary and minor urban + areas comprise the + statistically defined urban + population of New Zealand. + The urban area + classification is designed + to identify concentrated + urban or semi-urban + settlements without the + distortions of + administrative + boundaries.

Statistics + NZ Urban Area 2013 v2.0.0"' + enum: + - UA + - title: Ward + description:

Wards are defined under + the Local Electoral Act 2001 + and result from the + division, for electoral + purposes, of the district of + a territorial authority. The + ward system was designed to + allow for the recognition of + communities within a + district and to increase + community involvement in the + local government system.

+ Statistics NZ Ward 2013 + v1.0.0 + enum: + - WA + Code: + type: string + description:

A valid value defined by the + nominated spatial unit type, + defined by Statistics New + Zealand in one of the following + statistical area defintion + standards:

Area + Unit
Statistics NZ + Classification of Area Unit 2017 + v1.0.0
General + Electoral District
+
Statistics NZ General + Electoral District 2014 + v1.0.0
Community + Board
Statistics NZ + Community Board (codes 07601 - + 07621) 2018 v1.0.0
+
Māori Electoral + District
Statistics NZ + Māori Electoral District 2014 + v1.0.0
Mesh Block
+
Statistics NZ Statistical + Standard for Meshblock 2018 + v1.0.0
Regional + Council
Statistics NZ + Regional Council 2018 + v1.0.0
Territorial + Authority
Statistics NZ + Territorial Authority 2018 + v1.0.0
Urban Area
+
Statistics NZ Urban Area + 2018 v1.0.0
Ward
+
Statistics NZ Ward 2018 + v1.0.0
+ EmailList: + description:

The person's e-mail address(es) - one or more + emails.

+ type: object + properties: + Email: + type: array + items: + description:

This element represents an e-mail address + of one of a number of types and occurs in + objects such as StudentPersonal, + StaffPersonal, StudentContactPersonal, etc. +

+ type: object + properties: + Type: + type: string + title: Email Type + description: >- +

A standardised method of describing an + electronic mail address used as contact + method by a party. Where a party has more + than one email address, this may provide + context for deciding which email address + to use.

    +
  • 'PRIM' - Primary
    • +
  • 'WORK' - Work
    • +
  • 'PERS' - Personal
    • +
  • 'ALT1' - Alternate 1
    • +
  • 'ALT2' - Alternate 2
    • +
  • 'ALT3' - Alternate 3
    • +
  • 'ALT4' - Alternate 4
    • +
+ oneOf: + - title: Primary + description: Applicable to organisations, eg schools + enum: + - PRIM + - title: Work + description: Only used for persons + enum: + - WORK + - title: Personal + description: Only used for persons + enum: + - PERS + - title: Alternate 1 + enum: + - ALT1 + - title: Alternate 2 + enum: + - ALT2 + - title: Alternate 3 + enum: + - ALT3 + - title: Alternate 4 + enum: + - ALT4 + Address: + type: string + description:

The actual email address.

+ PhoneNumberList: + description:

The person's phone number(s) - one or more phone + numbers.

+ type: object + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone number and + occurs within objects such as StudentPersonal, + StaffPersonal, etc.

+ type: object + properties: + Type: + type: string + title: Telephone Number Type + description: >- +

A standardised method of describing a + telecommunications device used as contact + method by a party. Where a party has more + than one phone number, this may provide + context for deciding which number to + use.

    +
  • 'MAI' - Main Telephone Number
    • +
  • 'FAX' - Facsimile Number
    • +
  • 'HTE' - Home Telephone Number
    • +
  • 'HMO' - Home Mobile
    • +
  • 'MOB' - Mobile
    • +
  • 'WMO' - Work Mobile
    • +
  • 'WTE' - Work Telephone Number
    • +
+ oneOf: + - title: Main Telephone Number + enum: + - MAI + - title: Facsimile Number + enum: + - FAX + - title: Home Telephone Number + description: Person usage only + enum: + - HTE + - title: Home Mobile + description: Person usage only + enum: + - HMO + - title: Mobile + enum: + - MOB + - title: Work Mobile + enum: + - WMO + - title: Work Telephone Number + enum: + - WTE + Number: + type: string + description: "

Phone number. Free-form, but typical + New Zealand formats include:

    +
  • (0##) ###-####
  • ###-####
    • +
  • +##### ### ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1StudentPersonals~1%7BStudentPe\ + rsonalRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/Student\ + Personal/properties/PersonInfo/properties\ + /Name/properties/FamilyNameFirst" + HouseholdContactInfoList: + description:

The person's household/s contact information. A + list of one or more household’s contact + information.

+ type: object + properties: + HouseholdContactInfo: + type: array + items: + description:

Common element used to supply information + about a particular household a person is a + member of.

+ type: object + properties: + PreferenceNumber: + type: integer + description:

Priority of Household Contact in + relation to this Person.

+ HouseholdContactId: + $ref: "#/paths/~1StudentPersonals~1%7BStudentPe\ + rsonalRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/Student\ + Personal/properties/StudentPersonalLocalI\ + d" + HouseholdSalutation: + type: string + description:

Salutation to be used in addressing + this household.

+ AddressList: + description:

A list of Address elements.

+ type: object + properties: + Address: + type: array + items: + description:

This element contains address + data.

+ type: object + properties: + Type: + $ref: "#/paths/~1StudentPersonals~1%7\ + BStudentPersonalRefId%7D/put/re\ + questBody/content/application~1\ + json/schema/properties/StudentP\ + ersonal/properties/PersonInfo/p\ + roperties/AddressList/propertie\ + s/Address/items/properties/Type" + Role: + $ref: "#/paths/~1StudentPersonals~1%7\ + BStudentPersonalRefId%7D/put/re\ + questBody/content/application~1\ + json/schema/properties/StudentP\ + ersonal/properties/PersonInfo/p\ + roperties/AddressList/propertie\ + s/Address/items/properties/Role" + Street: + description:

The street element is a + complex element and breaks the + street down into several parts. + (Allow for PO Box here)

+ type: object + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' part + of rural addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only + applicable if a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of + the location. Grid location + values are derived from New + Zealand Map Grid x,y coordinates + and converted to Latitude and + Longitude values per the World + Geodetic System 1984 (G1762) +

+ type: object + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes + north of the equator are + positive, latitudes south of + the equator are negative + [ISO 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes + east of the Prime Meridian + in Greenwich are positive, + longitudes west of the Prime + Meridian are negative. The + 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

+

The list may contain exactly + one StatisticalArea element for + each of the following spatial + unit types:

    +
  • Ward
  • Urban + Area
  • Census Area + Unit
  • Māori + Electorate
  • Mesh + Block
  • General + Electorate
  • Territorial + Authority
  • Local Board + (Auckland Only)
    • +
  • Regional Council
+ type: object + properties: + StatisticalArea: + type: array + items: + description:

A particular + statistical area defined + by Statistics New + Zealand.

+ type: object + properties: + SpatialUnitType: + $ref: "#/paths/~1StudentPer\ + sonals~1%7BStudentPer\ + sonalRefId%7D/put/req\ + uestBody/content/appl\ + ication~1json/schema/\ + properties/StudentPer\ + sonal/properties/Pers\ + onInfo/properties/Add\ + ressList/properties/A\ + ddress/items/properti\ + es/StatisticalAreaLis\ + t/properties/Statisti\ + calArea/items/propert\ + ies/SpatialUnitType" + Code: + type: string + description:

A valid value + defined by the + nominated spatial unit + type, defined by + Statistics New Zealand + in one of the + following statistical + area defintion + standards:

+
Area Unit
+
Statistics NZ + Classification of Area + Unit 2017 v1.0.0
+
General Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community + Board
+
Statistics NZ + Community Board (codes + 07601 - 07621) 2018 + v1.0.0
Māori + Electoral + District
+
Statistics NZ + Māori Electoral + District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard + for Meshblock 2018 + v1.0.0
+
Regional + Council
+
Statistics NZ + Regional Council 2018 + v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority + 2018 v1.0.0
+
Urban Area
+
Statistics NZ + Urban Area 2018 + v1.0.0
+
Ward
+
Statistics NZ Ward + 2018 v1.0.0
+ EmailList: + description:

List of Email elements.

+ type: object + properties: + Email: + type: array + items: + description:

This element represents an + e-mail address of one of a number of + types and occurs in objects such as + StudentPersonal, StaffPersonal, + StudentContactPersonal, etc.

+ type: object + properties: + Type: + $ref: "#/paths/~1StudentPersonals~1%7\ + BStudentPersonalRefId%7D/put/re\ + questBody/content/application~1\ + json/schema/properties/StudentP\ + ersonal/properties/PersonInfo/p\ + roperties/EmailList/properties/\ + Email/items/properties/Type" + Address: + type: string + description:

The actual email address.

+ PhoneNumberList: + description:

List of PhoneNumber elements.

+ type: object + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone + number and occurs within objects + such as StudentPersonal, + StaffPersonal, etc.

+ type: object + properties: + Type: + $ref: "#/paths/~1StudentPersonals~1%7\ + BStudentPersonalRefId%7D/put/re\ + questBody/content/application~1\ + json/schema/properties/StudentP\ + ersonal/properties/PersonInfo/p\ + roperties/PhoneNumberList/prope\ + rties/PhoneNumber/items/propert\ + ies/Type" + Number: + type: string + description: "

Phone number. Free-form, but + typical New Zealand formats + include:

  • (0##) + ###-####
  • ###-####
    • +
  • +##### ### ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1StudentPersonals~1%7\ + BStudentPersonalRefId%7D/put/re\ + questBody/content/application~1\ + json/schema/properties/StudentP\ + ersonal/properties/PersonInfo/p\ + roperties/Name/properties/Famil\ + yNameFirst" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + description: Contains all the personal information related to the student. + x-accessControl: + create: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + read: + - 1001 + - 1306 + - 2101 + - 2103 + - 2401 + - 2403 + update: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + 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 + 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: + IwiAffiliation: + - NZS0702 + - NZS0601 + ReligiousAffiliationList: + ReligiousAffiliation: + - NZS212 + - NZS215 + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + - Type: RU + Role: PHY + Street: + Line1: 1175 Lake Ferry Rd + Suburb: RD 1 + City: Martinborough + EmailList: + Email: + - Type: PRIM + Address: hagrid@gmail.com + PhoneNumberList: + PhoneNumber: + Type: MOB + Number: (021) 300 999 + HouseholdContactInfoList: + HouseholdContactInfo: + - PreferenceNumber: 1 + HouseholdContactId: 7d5c3f5c-d89c-4551-9442-6b008207986e + AddressList: + Address: + - Type: DE + Role: POS + Street: + Line1: P O Box 81 + City: Martinborough + PostalCode: "5781" + "{\n \"Email\": { \"Type\": \"PRIM\", \"Address\": \"hagrid@gmail.com\" }\n}": null + PhoneNumberList: + PhoneNumber: + Type: MOB + Number: (021) 300 999 + application/xml: + schema: + type: object + properties: + StudentPersonal: + $ref: "#/paths/~1StudentPersonals~1%7BStudentPersonalRefId%7D/put\ + /requestBody/content/application~1json/schema/properties/St\ + udentPersonal" + example: >- + + 7C834EA9-EDA1-2090-347F-83297E1C290C + S1234567 + 2234523 + 1996-05-04 + + + Hagrid + Rubeus + Rubeus Hagrid + LGL + N + + + + Anderson + Samuel + Samuel Anderson + AKA + Y + + NZPAS + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + + + Rowinski + Sam + Sam Rowinski + PRF + N + + + + 1990-09-26 + Dunedin + ZAF + + NZL + ZAF + + NZCI + + NZPAS + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + 2 + + + NZS01110 + FL + + + AD + SP + + + + + NZS01112 + SL + + + BE + SP + + + + + + + 1 + 111 + + + 1 + 211 + + + + NZS0702 + NZS0601 + + + NZS212 + NZS215 + + + +
+ TH + PHY + + The Enchanted Wood + 533 Hogwart's Way + + Hogsmead + 7733 +
+
+ RU + PHY + + 1175 Lake Ferry Rd + + RD 1 + Martinborough +
+ + + + PRIM + hagrid@gmail.com + + + + + MOB + (021) 300 999 + + + + + 1 + 7d5c3f5c-d89c-4551-9442-6b008207986e + +
+ DE + POS + + P O Box 81 + + Martinborough + 5781 +
+ + + + PRIM + hagrid@gmail.com + + + + + MOB + (021) 300 999 + + + + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentPersonal + summary: Default operation to get a single StudentPersonal + parameters: + - name: StudentPersonalRefId + in: path + description:

The GUID of the student.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentPersonal: + $ref: "#/paths/~1StudentPersonals/get/responses/200/content/app\ + lication~1json/schema/properties/StudentPersonals/propert\ + ies/StudentPersonal/items" + example: + 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 + 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: + IwiAffiliation: + - NZS0702 + - NZS0601 + ReligiousAffiliationList: + ReligiousAffiliation: + - NZS212 + - NZS215 + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + - Type: RU + Role: PHY + Street: + Line1: 1175 Lake Ferry Rd + Suburb: RD 1 + City: Martinborough + EmailList: + Email: + - Type: PRIM + Address: hagrid@gmail.com + PhoneNumberList: + PhoneNumber: + Type: MOB + Number: (021) 300 999 + HouseholdContactInfoList: + HouseholdContactInfo: + - PreferenceNumber: 1 + HouseholdContactId: 7d5c3f5c-d89c-4551-9442-6b008207986e + AddressList: + Address: + - Type: DE + Role: POS + Street: + Line1: P O Box 81 + City: Martinborough + PostalCode: "5781" + "{\n \"Email\": { \"Type\": \"PRIM\", \"Address\": \"hagrid@gmail.com\" }\n}": null + PhoneNumberList: + PhoneNumber: + Type: MOB + Number: (021) 300 999 + application/xml: + schema: + type: object + properties: + StudentPersonal: + $ref: "#/paths/~1StudentPersonals/get/responses/200/content/app\ + lication~1json/schema/properties/StudentPersonals/propert\ + ies/StudentPersonal/items" + example: >- + + 7C834EA9-EDA1-2090-347F-83297E1C290C + S1234567 + 2234523 + 1996-05-04 + + + Hagrid + Rubeus + Rubeus Hagrid + LGL + N + + + + Anderson + Samuel + Samuel Anderson + AKA + Y + + NZPAS + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + + + Rowinski + Sam + Sam Rowinski + PRF + N + + + + 1990-09-26 + Dunedin + ZAF + + NZL + ZAF + + NZCI + + NZPAS + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + 2 + + + NZS01110 + FL + + + AD + SP + + + + + NZS01112 + SL + + + BE + SP + + + + + + + 1 + 111 + + + 1 + 211 + + + + NZS0702 + NZS0601 + + + NZS212 + NZS215 + + + +
+ TH + PHY + + The Enchanted Wood + 533 Hogwart's Way + + Hogsmead + 7733 +
+
+ RU + PHY + + 1175 Lake Ferry Rd + + RD 1 + Martinborough +
+ + + + PRIM + hagrid@gmail.com + + + + + MOB + (021) 300 999 + + + + + 1 + 7d5c3f5c-d89c-4551-9442-6b008207986e + +
+ DE + POS + + P O Box 81 + + Martinborough + 5781 +
+ + + + PRIM + hagrid@gmail.com + + + + + MOB + (021) 300 999 + + + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentPersonal + summary: Default operation to delete a single StudentPersonal + parameters: + - name: StudentPersonalRefId + in: path + description:

The GUID of the student.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentContactPersonals: + get: + tags: + - StudentContactPersonal + summary: Default operation to get a list of all available StudentContactPersonals + description: Search the set of available StudentContactPersonals, according to the + search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentContactPersonals: + type: object + description: A List of StudentContactPersonal objects + properties: + StudentContactPersonal: + type: array + items: + required: + - PersonInfo + type: object + properties: + StudentContactPersonalRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentContactPersonalLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + HasBOTVote: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PersonInfo: + description:

Personal Information collected about the + StudentContact, when that contact is a member of + the Student's whānau.

+ type: object + required: + - Name + properties: + Name: + description:

A name used by the person

+ type: object + properties: + Title: + type: string + description:

A title or prefix associated with the + name.

+ FamilyName: + type: string + description:

Also known as Last Name, although + some cultures may not present a family + name as the last name.

+ GivenName: + type: string + description:

Also known as First Name, although + some cultures may not present this name + as the first element in a name. May + contain a composite of all given + names.

+ MiddleName: + type: string + description:

Where more than one Given Name, these + may be combined in one composite field + or else populated in several elements. +

+ FamilyNameFirst: + $ref: "#/paths/~1StudentContactPersonals/get/\ + responses/200/content/application~1json\ + /schema/properties/StudentContactPerson\ + als/properties/StudentContactPersonal/i\ + tems/properties/HasBOTVote" + PreferredFamilyName: + type: string + description:

A preferred version of the Family + Name. Note:A name cannot have both a + Preferred Family and Preferred Given + Name within the same Name structure – + only one of these fields should be + populated. If a person does have both a + Preferred Family and Preferred Given + Name then this must be populated as a + separate Name of type ‘Preferred’.

+ PreferredFamilyNameFirst: + $ref: "#/paths/~1StudentContactPersonals/get/\ + responses/200/content/application~1json\ + /schema/properties/StudentContactPerson\ + als/properties/StudentContactPersonal/i\ + tems/properties/HasBOTVote" + PreferredGivenName: + type: string + description: "

A preferred version of the Given + Name. Note: A name cannot have both a + Preferred Family and Preferred Given + Name within the same Name structure – + only one of these fields should be + populated. If a person does have both a + Preferred Family and Preferred Given + Name then this must be populated as a + separate Name of type ‘Preferred’.

" + Suffix: + type: string + description:

Textual suffix like PHD, JP, BSc.

+ FullName: + type: string + description:

A combination of all name elements as + one composite text element

+ Type: + type: string + title: Name Usage Type + description: >- +

A standardised method of describing + the usage of a name by a person. Where a + person has more than one current name, + the usage type indicates which name may + be used according to the purpose.

+

Code values are based on SIF + Australia 3.4.

    +
  • 'PRF' - Preferred Name
    • +
  • 'FON' - Foreign Official Name
    • +
  • 'PRV' - Previous name
    • +
  • 'AKA' - Also Known As
    • +
  • 'BTH' - Name at Birth
    • +
  • 'LGL' - Legal Name
    • +
+ oneOf: + - title: Preferred Name + description:

The name by which an individual + prefers to be known and + addressed.

Only usage type + applicable for student name usage + (other types are not supported by + NSI).

+ enum: + - PRF + - title: Foreign Official Name + description:

Included for future usage in NZ, + especially for tertiary + students.

+ enum: + - FON + - title: Previous name + enum: + - PRV + - title: Also Known As + description: AKA or Alias + enum: + - AKA + - title: Name at Birth + enum: + - BTH + - title: Legal Name + description:

Legal Name or Official Name as + defined by the organisation which + collects it (legal name is not + defined in this standard)

+ enum: + - LGL + IsVerified: + $ref: "#/paths/~1StudentContactPersonals/get/\ + responses/200/content/application~1json\ + /schema/properties/StudentContactPerson\ + als/properties/StudentContactPersonal/i\ + tems/properties/HasBOTVote" + OtherNameList: + description:

Previous, alternate or other names or + aliases associated with the person.

+ type: object + required: + - Name + properties: + Name: + type: array + items: + description:

Extension of BaseNameType including + name verification data

+ type: object + properties: + Verification: + description:

The verification event that + verified the person's name.

+ type: object + required: + - IsConfirmed + - Source + properties: + Source: + type: string + title: Verification Source + description: >- +

Records the source of the + identity or eligibility + verification, that has been + made. Mostly it is merely a + record of the kind of document + that has been presented; but + occasionally it is down to + Principal or Ministry + discretion / approval.

+
    +
  • 'NZBIR' - NZ Birth Certificate
    • +
  • 'NZBCO' - NZ Birth Certificate (with confirmation of NZ Citizen by birth)
    • +
  • 'NZPAS' - NZ Passport
    • +
  • 'NZCIT' - NZ Citizenship Certificate
    • +
  • 'BIRCE' - Birth Certificate (COK, TKL, NIU)
    • +
  • 'BCCON' - Birth Certificate (COK, TKL, NIU) (with confirmation of NZ Citizen by birth)
    • +
  • 'CENAT' - Certification of Naturalisation (COK, TKL, NIU)
    • +
  • 'CAREG' - Certification of Registration (COK, TKL, NIU)
    • +
  • 'LETCO' - Letter of Confirmation (COK, TKL, NIU)
    • +
  • 'OTHPA' - Other Passport with NZ residence class Visa
    • +
  • 'AUSPA' - Australian Passport
    • +
  • 'VISDO' - Visa Domestic
    • +
plus 3 more value(s) at NZCodeSetsVerificationSourceType + oneOf: + - title: NZ Birth Certificate + description: Applies if the child was + born before 1 Jan 2006 + enum: + - NZBIR + - title: NZ Birth Certificate (with + confirmation of NZ Citizen + by birth) + description: Applies if the child was + born on or after 1 Jan + 2006 + enum: + - NZBCO + - title: NZ Passport + description: Including COK, TKL or NIU. + (Current or Expired) + enum: + - NZPAS + - title: NZ Citizenship Certificate + enum: + - NZCIT + - title: Birth Certificate (COK, + TKL, NIU) + description: If the child was born + before 1 Jan 2006 + enum: + - BIRCE + - title: Birth Certificate (COK, + TKL, NIU) (with + confirmation of NZ Citizen + by birth) + description: Applies if the child was + born on or after 1 Jan + 2006. + enum: + - BCCON + - title: Certification of + Naturalisation (COK, TKL, + NIU) + enum: + - CENAT + - title: Certification of + Registration (COK, TKL, + NIU) + enum: + - CAREG + - title: Letter of Confirmation + (COK, TKL, NIU) + enum: + - LETCO + - title: Other Passport with NZ + residence class Visa + description: Or other evidence of NZ + residency + enum: + - OTHPA + - title: Australian Passport + description: (Current or Expired) + enum: + - AUSPA + - title: Visa Domestic + enum: + - VISDO + - title: Visa with conditions of + study + enum: + - VISST + - title: Principal Discretion + enum: + - PRINC + - title: MoE Approval + enum: + - MOEAP + DocumentSerialNumber: + type: string + description:

The serial number on the + document that was used to + verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the + document that was used to + verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification + has been confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took + place.

+ Provider: + description:

A reference to another SIF + Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentContact\ + Personals/get/responses/2\ + 00/content/application~1j\ + son/schema/properties/Stu\ + dentContactPersonals/prop\ + erties/StudentContactPers\ + onal/items/properties/Stu\ + dentContactPersonalRefId" + LocalId: + $ref: "#/paths/~1StudentContact\ + Personals/get/responses/2\ + 00/content/application~1j\ + son/schema/properties/Stu\ + dentContactPersonals/prop\ + erties/StudentContactPers\ + onal/items/properties/Stu\ + dentContactPersonalLocalI\ + d" + Name: + type: string + description:

The normal descriptive + name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid + SIF DataObject names, to + be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation + that operates within + the education sector; + but doesn’t provide + education services. + enum: + - Organisation + - title: Provider + description: A recognised provider + of education services + such as ECE Service, + School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised + relationship between + two providers of + education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined + course that Students + enrol in, and may be + assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or + other award granted by + a national body, + professional + association or other + interested party. The + Credential describes + an award that is made + to the learner at the + successful completion + of a particular + learning programme. + eg: NCEA Level 1; + University Entrance; + NCEA Level 2 + Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, + contact and + demographic + information relating + to a staff member, who + might be a teacher or + other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of + a Staff member to a + particular Role at a + Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the + personal information + related to the + student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the + personal information + about a person who is + a part of a Student's + whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between + a person who is a part + of a Student's whānau + and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s + association with an + education provider for + the purpose of + receiving educational + services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a + particular class or + other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about + the attendance spans + for a single student + at a single provider + during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information + about a particular + assignment or other + assessment task, to be + undertaken by one or + more Students at some + time. Defines the task + separately from each + student's attempting + the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's + registration for an + assessment task they + are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's + attempt at a + particular assessment + task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result + achieved by a single + student at a + particular assessment + task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student + gaining an Attainment + e.g. NCEA + Qualification, + Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the + outcome and follow ups + generated by a + WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a + student's interests + and academic, career + and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information + on a co-curricular or + extra-curricular + activity in which a + student participates + during a given school + year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information + pertaining to a + student's + participation in + learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress + and achievement + reports provided for a + student. Used in + technology centres the + host provider, to + report on student + progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + VerifiedName: + description:

The verified name of the person.

+ type: object + properties: + Verification: + description:

The verification event that verified + the person's name.

+ type: object + required: + - IsConfirmed + - Source + properties: + Source: + $ref: "#/paths/~1StudentContactPersonals/\ + get/responses/200/content/applicati\ + on~1json/schema/properties/StudentC\ + ontactPersonals/properties/StudentC\ + ontactPersonal/items/properties/Per\ + sonInfo/properties/OtherNameList/pr\ + operties/Name/items/properties/Veri\ + fication/properties/Source" + DocumentSerialNumber: + type: string + description:

The serial number on the document + that was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document + that was used to verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has + been confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StudentContactPersonals/\ + get/responses/200/content/applicati\ + on~1json/schema/properties/StudentC\ + ontactPersonals/properties/StudentC\ + ontactPersonal/items/properties/Per\ + sonInfo/properties/OtherNameList/pr\ + operties/Name/items/properties/Veri\ + fication/properties/Provider" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + Demographics: + description:

Details of the person’s demographic + properties

+ type: object + properties: + BirthDate: + type: string + format: date + description:

The person's date of birth.

+ DateOfDeath: + type: string + format: date + description:

The person's date of death.

+ PlaceOfBirth: + type: string + description:

The person's place of birth - like + village, town, city etc.

+ CountryOfBirth: + type: string + title: 3166 Country + description: >- +

A country is a geopolitical entity + recognised by the New Zealand + government. The term country may + include

  • Independent + countries recognised by the New Zealand + Government
  • Units that are + recognised geographic areas
    • +
  • administrative subdivisions of the + United Kingdom
  • overseas + dependencies, external territories of + independent countries.
+

Conforms to the International + Standard ISO 3166 Codes for the + Representation of Names of Countries and + their Subdivisions (ISO 3166-1:2013). + Education adopts the alpha-3 + representation of this standard.

+
    +
  • 'ABW' - Aruba
    • +
  • 'AFG' - Afghanistan
    • +
  • 'AGO' - Angola
    • +
  • 'AIA' - Anguilla
    • +
  • 'ALA' - Åland Islands
    • +
  • 'ALB' - Albania
    • +
  • 'AND' - Andorra
    • +
  • 'ARE' - United Arab Emirates
    • +
  • 'ARG' - Argentina
    • +
  • 'ARM' - Armenia
    • +
  • 'ASM' - American Samoa
    • +
  • 'ATA' - Antarctica
    • +
plus 237 more value(s) at ISO3166CountryType + oneOf: + - title: Aruba + enum: + - ABW + - title: Afghanistan + enum: + - AFG + - title: Angola + enum: + - AGO + - title: Anguilla + enum: + - AIA + - title: Åland Islands + enum: + - ALA + - title: Albania + enum: + - ALB + - title: Andorra + enum: + - AND + - title: United Arab Emirates + enum: + - ARE + - title: Argentina + enum: + - ARG + - title: Armenia + enum: + - ARM + - title: American Samoa + enum: + - ASM + - title: Antarctica + enum: + - ATA + - title: French Southern Territories + enum: + - ATF + - title: Antigua and Barbuda + enum: + - ATG + - title: Australia + enum: + - AUS + - title: Austria + enum: + - AUT + - title: Azerbaijan + enum: + - AZE + - title: Burundi + enum: + - BDI + - title: Belgium + enum: + - BEL + - title: Benin + enum: + - BEN + - title: Bonaire, Sint Eustatius and Saba + enum: + - BES + - title: Burkina Faso + enum: + - BFA + - title: Bangladesh + enum: + - BGD + - title: Bulgaria + enum: + - BGR + - title: Bahrain + enum: + - BHR + - title: Bahamas + enum: + - BHS + - title: Bosnia and Herzegovina + enum: + - BIH + - title: Saint Barthélemy + enum: + - BLM + - title: Belarus + enum: + - BLR + - title: Belize + enum: + - BLZ + - title: Bermuda + enum: + - BMU + - title: Bolivia, Plurinational State of + enum: + - BOL + - title: Brazil + enum: + - BRA + - title: Barbados + enum: + - BRB + - title: Brunei Darussalam + enum: + - BRN + - title: Bhutan + enum: + - BTN + - title: Bouvet Island + enum: + - BVT + - title: Botswana + enum: + - BWA + - title: Central African Republic + enum: + - CAF + - title: Canada + enum: + - CAN + - title: Cocos (Keeling) Islands + enum: + - CCK + - title: Switzerland + enum: + - CHE + - title: Chile + enum: + - CHL + - title: China + enum: + - CHN + - title: Côte d'Ivoire + enum: + - CIV + - title: Cameroon + enum: + - CMR + - title: Congo, the Democratic Republic of the + enum: + - COD + - title: Congo + enum: + - COG + - title: Cook Islands + enum: + - COK + - title: Colombia + enum: + - COL + - title: Comoros + enum: + - COM + - title: Cabo Verde + enum: + - CPV + - title: Costa Rica + enum: + - CRI + - title: Cuba + enum: + - CUB + - title: Curaçao + enum: + - CUW + - title: Christmas Island + enum: + - CXR + - title: Cayman Islands + enum: + - CYM + - title: Cyprus + enum: + - CYP + - title: Czechia + enum: + - CZE + - title: Germany + enum: + - DEU + - title: Djibouti + enum: + - DJI + - title: Dominica + enum: + - DMA + - title: Denmark + enum: + - DNK + - title: Dominican Republic + enum: + - DOM + - title: Algeria + enum: + - DZA + - title: Ecuador + enum: + - ECU + - title: Egypt + enum: + - EGY + - title: Eritrea + enum: + - ERI + - title: Western Sahara + enum: + - ESH + - title: Spain + enum: + - ESP + - title: Estonia + enum: + - EST + - title: Ethiopia + enum: + - ETH + - title: Finland + enum: + - FIN + - title: Fiji + enum: + - FJI + - title: Falkland Islands (Malvinas) + enum: + - FLK + - title: France + enum: + - FRA + - title: Faroe Islands + enum: + - FRO + - title: Micronesia, Federated States of + enum: + - FSM + - title: Gabon + enum: + - GAB + - title: United Kingdom + enum: + - GBR + - title: Georgia + enum: + - GEO + - title: Guernsey + enum: + - GGY + - title: Ghana + enum: + - GHA + - title: Gibraltar + enum: + - GIB + - title: Guinea + enum: + - GIN + - title: Guadeloupe + enum: + - GLP + - title: Gambia + enum: + - GMB + - title: Guinea-Bissau + enum: + - GNB + - title: Equatorial Guinea + enum: + - GNQ + - title: Greece + enum: + - GRC + - title: Grenada + enum: + - GRD + - title: Greenland + enum: + - GRL + - title: Guatemala + enum: + - GTM + - title: French Guiana + enum: + - GUF + - title: Guam + enum: + - GUM + - title: Guyana + enum: + - GUY + - title: Hong Kong + enum: + - HKG + - title: Heard Island and McDonald Islands + enum: + - HMD + - title: Honduras + enum: + - HND + - title: Croatia + enum: + - HRV + - title: Haiti + enum: + - HTI + - title: Hungary + enum: + - HUN + - title: Indonesia + enum: + - IDN + - title: Isle of Man + enum: + - IMN + - title: India + enum: + - IND + - title: British Indian Ocean Territory + enum: + - IOT + - title: Ireland + enum: + - IRL + - title: Iran, Islamic Republic of + enum: + - IRN + - title: Iraq + enum: + - IRQ + - title: Iceland + enum: + - ISL + - title: Israel + enum: + - ISR + - title: Italy + enum: + - ITA + - title: Jamaica + enum: + - JAM + - title: Jersey + enum: + - JEY + - title: Jordan + enum: + - JOR + - title: Japan + enum: + - JPN + - title: Kazakhstan + enum: + - KAZ + - title: Kenya + enum: + - KEN + - title: Kyrgyzstan + enum: + - KGZ + - title: Cambodia + enum: + - KHM + - title: Kiribati + enum: + - KIR + - title: Saint Kitts and Nevis + enum: + - KNA + - title: Korea, Republic of + enum: + - KOR + - title: Kuwait + enum: + - KWT + - title: Lao People's Democratic Republic + enum: + - LAO + - title: Lebanon + enum: + - LBN + - title: Liberia + enum: + - LBR + - title: Libya + enum: + - LBY + - title: Saint Lucia + enum: + - LCA + - title: Liechtenstein + enum: + - LIE + - title: Sri Lanka + enum: + - LKA + - title: Lesotho + enum: + - LSO + - title: Lithuania + enum: + - LTU + - title: Luxembourg + enum: + - LUX + - title: Latvia + enum: + - LVA + - title: Macao + enum: + - MAC + - title: Saint Martin (French part) + enum: + - MAF + - title: Morocco + enum: + - MAR + - title: Monaco + enum: + - MCO + - title: Moldova, Republic of + enum: + - MDA + - title: Madagascar + enum: + - MDG + - title: Maldives + enum: + - MDV + - title: Mexico + enum: + - MEX + - title: Marshall Islands + enum: + - MHL + - title: Macedonia, the former Yugoslav + Republic of + enum: + - MKD + - title: Mali + enum: + - MLI + - title: Malta + enum: + - MLT + - title: Myanmar + enum: + - MMR + - title: Montenegro + enum: + - MNE + - title: Mongolia + enum: + - MNG + - title: Northern Mariana Islands + enum: + - MNP + - title: Mozambique + enum: + - MOZ + - title: Mauritania + enum: + - MRT + - title: Montserrat + enum: + - MSR + - title: Martinique + enum: + - MTQ + - title: Mauritius + enum: + - MUS + - title: Malawi + enum: + - MWI + - title: Malaysia + enum: + - MYS + - title: Mayotte + enum: + - MYT + - title: Namibia + enum: + - NAM + - title: New Caledonia + enum: + - NCL + - title: Niger + enum: + - NER + - title: Norfolk Island + enum: + - NFK + - title: Nigeria + enum: + - NGA + - title: Nicaragua + enum: + - NIC + - title: Niue + enum: + - NIU + - title: Netherlands + enum: + - NLD + - title: Norway + enum: + - NOR + - title: Nepal + enum: + - NPL + - title: Nauru + enum: + - NRU + - title: New Zealand + enum: + - NZL + - title: Oman + enum: + - OMN + - title: Pakistan + enum: + - PAK + - title: Panama + enum: + - PAN + - title: Pitcairn + enum: + - PCN + - title: Peru + enum: + - PER + - title: Philippines + enum: + - PHL + - title: Palau + enum: + - PLW + - title: Papua New Guinea + enum: + - PNG + - title: Poland + enum: + - POL + - title: Puerto Rico + enum: + - PRI + - title: Korea, Democratic People's Republic + of + enum: + - PRK + - title: Portugal + enum: + - PRT + - title: Paraguay + enum: + - PRY + - title: Palestine, State of + enum: + - PSE + - title: French Polynesia + enum: + - PYF + - title: Qatar + enum: + - QAT + - title: Réunion + enum: + - REU + - title: Romania + enum: + - ROU + - title: Russian Federation + enum: + - RUS + - title: Rwanda + enum: + - RWA + - title: Saudi Arabia + enum: + - SAU + - title: Sudan + enum: + - SDN + - title: Senegal + enum: + - SEN + - title: Singapore + enum: + - SGP + - title: South Georgia and the South Sandwich + Islands + enum: + - SGS + - title: Saint Helena, Ascension and Tristan + da Cunha + enum: + - SHN + - title: Svalbard and Jan Mayen + enum: + - SJM + - title: Solomon Islands + enum: + - SLB + - title: Sierra Leone + enum: + - SLE + - title: El Salvador + enum: + - SLV + - title: San Marino + enum: + - SMR + - title: Somalia + enum: + - SOM + - title: Saint Pierre and Miquelon + enum: + - SPM + - title: Serbia + enum: + - SRB + - title: South Sudan + enum: + - SSD + - title: Sao Tome and Principe + enum: + - STP + - title: Suriname + enum: + - SUR + - title: Slovakia + enum: + - SVK + - title: Slovenia + enum: + - SVN + - title: Sweden + enum: + - SWE + - title: Swaziland + enum: + - SWZ + - title: Sint Maarten (Dutch part) + enum: + - SXM + - title: Seychelles + enum: + - SYC + - title: Syrian Arab Republic + enum: + - SYR + - title: Turks and Caicos Islands + enum: + - TCA + - title: Chad + enum: + - TCD + - title: Togo + enum: + - TGO + - title: Thailand + enum: + - THA + - title: Tajikistan + enum: + - TJK + - title: Tokelau + enum: + - TKL + - title: Turkmenistan + enum: + - TKM + - title: Timor-Leste + enum: + - TLS + - title: Tonga + enum: + - TON + - title: Trinidad and Tobago + enum: + - TTO + - title: Tunisia + enum: + - TUN + - title: Turkey + enum: + - TUR + - title: Tuvalu + enum: + - TUV + - title: Taiwan, Province of China + enum: + - TWN + - title: Tanzania, United Republic of + enum: + - TZA + - title: Uganda + enum: + - UGA + - title: Ukraine + enum: + - UKR + - title: United States Minor Outlying Islands + enum: + - UMI + - title: Uruguay + enum: + - URY + - title: United States of America + enum: + - USA + - title: Uzbekistan + enum: + - UZB + - title: Holy See + enum: + - VAT + - title: Saint Vincent and the Grenadines + enum: + - VCT + - title: Venezuela, Bolivarian Republic of + enum: + - VEN + - title: Virgin Islands, British + enum: + - VGB + - title: Virgin Islands, U.S. + enum: + - VIR + - title: Viet Nam + enum: + - VNM + - title: Vanuatu + enum: + - VUT + - title: Wallis and Futuna + enum: + - WLF + - title: Samoa + enum: + - WSM + - title: Yemen + enum: + - YEM + - title: South Africa + enum: + - ZAF + - title: Zambia + enum: + - ZMB + - title: Zimbabwe + enum: + - ZWE + CitizenshipList: + type: object + required: + - Country + properties: + Country: + type: array + items: + $ref: "#/paths/~1StudentContactPersonal\ + s/get/responses/200/content/appli\ + cation~1json/schema/properties/St\ + udentContactPersonals/properties/\ + StudentContactPersonal/items/prop\ + erties/PersonInfo/properties/Demo\ + graphics/properties/CountryOfBirt\ + h" + CitizenshipStatus: + type: string + title: Citizenship Status + description: >- +

The citizenship or residency status + of a person, principally recorded in + order to determine eligibility for + education services hence limited to + indicating New Zealand, Australian or + Other residency.

Based on SIF + Australia + AUCodeSetsAustralianCitizenshipStatusType

+
    +
  • 'AUCI' - Australian citizen
    • +
  • 'NZCI' - NZ citizen
    • +
  • 'OTOV' - Other overseas
    • +
  • 'NZRE' - NZ resident
    • +
  • 'NOPR' - Not provided
    • +
+ oneOf: + - title: Australian citizen + enum: + - AUCI + - title: NZ citizen + enum: + - NZCI + - title: Other overseas + description: Indicates a residency other than NZ + or Australia + enum: + - OTOV + - title: NZ resident + description: Includes Australian residents + classified as NZ resident once + arrived in NZ + enum: + - NZRE + - title: Not provided + enum: + - NOPR + CitizenshipVerification: + description:

The verification event that verified + the residency status of the person. + Absence of a verification event + indicates that the residency was not + verified against an identity document. +

+ type: object + required: + - IsConfirmed + - Source + properties: + Source: + $ref: "#/paths/~1StudentContactPersonals/\ + get/responses/200/content/applicati\ + on~1json/schema/properties/StudentC\ + ontactPersonals/properties/StudentC\ + ontactPersonal/items/properties/Per\ + sonInfo/properties/OtherNameList/pr\ + operties/Name/items/properties/Veri\ + fication/properties/Source" + DocumentSerialNumber: + type: string + description:

The serial number on the document + that was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document + that was used to verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has + been confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StudentContactPersonals/\ + get/responses/200/content/applicati\ + on~1json/schema/properties/StudentC\ + ontactPersonals/properties/StudentC\ + ontactPersonal/items/properties/Per\ + sonInfo/properties/OtherNameList/pr\ + operties/Name/items/properties/Veri\ + fication/properties/Provider" + Gender: + type: string + title: Gender + description: >- +

A Person may identify as having a + Gender (or Gender Identity). Biological + sex and sexual orientation are related + but different concepts. Sourced from + Statistics NZ Standard for Gender + Identity

    +
  • '1' - Male - Tāne
    • +
  • '2' - Female - Wahine
    • +
  • '3' - Gender Diverse - Ira tāngata kōwhiri kore
    • +
  • '31' - Transgender Male to Female - Whakawahine
    • +
  • '32' - Transgender Female to Male - Tangata ira tāne
    • +
  • '9' - Not Willing to Disclose
    • +
+ oneOf: + - title*: + en: Male + mi: Tāne + enum: + - "1" + - title*: + en: Female + mi: Wahine + enum: + - "2" + - title*: + en: Gender Diverse + mi: Ira tāngata kōwhiri kore + description: But not further defined + enum: + - "3" + - title*: + en: Transgender Male to Female + mi: Whakawahine + description: '"Can be rolled up to 3:Gender + Diverse"' + enum: + - "31" + - title*: + en: Transgender Female to Male + mi: Tangata ira tāne + description: '"Can be rolled up to 3:Gender + Diverse"' + enum: + - "32" + - title*: + en: Not Willing to Disclose + enum: + - "9" + LanguageList: + description: List of languages an individual uses to + communicate. + type: object + required: + - Language + properties: + Language: + type: array + items: + description:

A language that an individual + uses to communicate.

+ type: object + required: + - Code + properties: + Code: + type: string + title: Language + description: >- +

Language refers to + recognised human communication + systems, typically oral and/or + written. Sourced from + Statistics NZ - Language + Standard Classification 1999 + v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not further + defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not + elsewhere classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not further + defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not + elsewhere classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere + classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere + classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere + classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further + defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere + classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere + classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere + classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further + defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not elsewhere + classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere + classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further + defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere + classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere + classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not + further defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not + elsewhere classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further + defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere + classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further + defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere + classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further + defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere + classified + enum: + - NZS15199 + - title: Central-Eastern + Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not + further defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not + elsewhere classified + enum: + - NZS16199 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further + defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not elsewhere + classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western Malayo-Polynesian + not further defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western Malayo-Polynesian + not elsewhere classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further + defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere + classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere + classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere + classified + enum: + - NZS18399 + - title: Niger-Congo + (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere + classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not + further defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not + elsewhere classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not + further defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not + elsewhere classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not + elsewhere classified + enum: + - NZS219 + - title: Language Isolates not + elsewhere classified + enum: + - NZS21999 + - title: Miscellaneous Language + Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further + defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere + classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous + Languages + enum: + - NZS229 + - title: Other Miscellaneous + Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not + further defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not + elsewhere classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not further + defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not + elsewhere classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + Usage: + type: string + title: Language Usage + description: >- +

A standardised method of + describing the usage of a + language by a person, + potentially indicating + capability and preference for + the language.

    +
  • 'FL' - First Language
    • +
  • 'SL' - Secondary Language
    • +
  • 'SH' - Spoken At Home
    • +
+ oneOf: + - title: First Language + enum: + - FL + - title: Secondary Language + enum: + - SL + - title: Spoken At Home + enum: + - SH + Dialect: + type: string + description:

Specific dialect of a + person's language.

+ ProficiencyList: + description:

A list of the person's + proficiency in the language in + regards to speaking, reading + and writing.

+ type: object + required: + - Proficiency + properties: + Proficiency: + type: array + items: + description:

The person's + proficiency in the + language in regards to + speaking, reading and + writing.

+ type: object + required: + - Level + - Type + properties: + Level: + type: string + title: Language Proficiency + Level + description: >- +

The language + proficiency + level.

    +
  • 'NO' - None
    • +
  • 'BE' - Beginner
    • +
  • 'IN' - Intermediate
    • +
  • 'AD' - Advanced
    • +
+ oneOf: + - title: None + enum: + - NO + - title: Beginner + enum: + - BE + - title: Intermediate + enum: + - IN + - title: Advanced + enum: + - AD + Type: + type: string + title: Language Proficiency + Type + description: >- +

Code set denoting + a type of language + proficiency, e.g. + speaking, writing + reading.

    +
  • 'SP' - Speaking
    • +
  • 'RE' - Reading
    • +
  • 'WR' - Writing
    • +
+ oneOf: + - title: Speaking + enum: + - SP + - title: Reading + enum: + - RE + - title: Writing + enum: + - WR + CountryArrivalDate: + type: string + format: date + description: Date the person first arrived in the + country. + EthnicityList: + description:

One or more ethnic groups with which + the person identifies.

+ type: object + required: + - Ethnicity + properties: + Ethnicity: + type: array + items: + description:

An ethnic group with which the + person identifies, and if there is + more than one, their order of + preference.

+ type: object + required: + - Code + properties: + PreferenceOrderNumber: + type: integer + description:

The order of preference for + the person's ethnicity.

+ Code: + type: string + title: Ethnicity + description: >- +

Ethnicity is the ethnic + group or groups that people + identify with or feel they + belong to. Ethnicity is a + measure of cultural + affiliation, as opposed to + race, ancestry, nationality or + citizenship. Ethnicity is self + perceived and people can + belong to more than one ethnic + group.

The permissible + values consists of any value + from the Statistics NZ - + Ethnicity New Zealand Standard + Classification 2005 v2.0.0 + Depending on usage, ethnicity + may be defined at levels 1 to + 4.

    +
  • '1' - European
    • +
  • '10' - European nfd
    • +
  • '100' - European nfd
    • +
  • '10000' - European nfd
    • +
  • '11' - New Zealand European
    • +
  • '111' - New Zealand European
    • +
  • '11111' - New Zealand European
    • +
  • '12' - Other European
    • +
  • '121' - British and Irish
    • +
  • '12100' - British nfd
    • +
  • '12111' - Celtic nfd
    • +
  • '12112' - Channel Islander
    • +
plus 250 more value(s) at NZCodeSetsEthnicityType + oneOf: + - title: European + enum: + - "1" + - title: European nfd + enum: + - "10" + - title: European nfd + enum: + - "100" + - title: European nfd + enum: + - "10000" + - title: New Zealand European + enum: + - "11" + - title: New Zealand European + enum: + - "111" + - title: New Zealand European + enum: + - "11111" + - title: Other European + enum: + - "12" + - title: British and Irish + enum: + - "121" + - title: British nfd + enum: + - "12100" + - title: Celtic nfd + enum: + - "12111" + - title: Channel Islander + enum: + - "12112" + - title: Cornish + enum: + - "12113" + - title: English + enum: + - "12114" + - title: Irish + enum: + - "12116" + - title: Manx + enum: + - "12117" + - title: Scottish + enum: + - "12119" + - title: Welsh + enum: + - "12121" + - title: British nec + enum: + - "12199" + - title: Dutch + enum: + - "122" + - title: Dutch + enum: + - "12211" + - title: Greek + enum: + - "123" + - title: Greek + enum: + - "12311" + - title: Polish + enum: + - "124" + - title: Polish + enum: + - "12411" + - title: South Slav + enum: + - "125" + - title: South Slav nfd + enum: + - "12500" + - title: Croatian + enum: + - "12511" + - title: Dalmatian + enum: + - "12512" + - title: Macedonian + enum: + - "12513" + - title: Serbian + enum: + - "12514" + - title: Slovenian + enum: + - "12515" + - title: Bosnian + enum: + - "12516" + - title: South Slav nec + enum: + - "12599" + - title: Italian + enum: + - "126" + - title: Italian + enum: + - "12611" + - title: German + enum: + - "127" + - title: German + enum: + - "12711" + - title: Australian + enum: + - "128" + - title: Australian + enum: + - "12811" + - title: Other European + enum: + - "129" + - title: Albanian + enum: + - "12911" + - title: Armenian + enum: + - "12912" + - title: Austrian + enum: + - "12913" + - title: Belgian + enum: + - "12914" + - title: Bulgarian + enum: + - "12915" + - title: Belorussian + enum: + - "12916" + - title: Cypriot nfd + enum: + - "12918" + - title: Czech + enum: + - "12919" + - title: Danish + enum: + - "12920" + - title: Estonian + enum: + - "12921" + - title: Finnish + enum: + - "12922" + - title: Flemish + enum: + - "12923" + - title: French + enum: + - "12924" + - title: Hungarian + enum: + - "12926" + - title: Icelandic + enum: + - "12927" + - title: Latvian + enum: + - "12928" + - title: Lithuanian + enum: + - "12929" + - title: Maltese + enum: + - "12930" + - title: Norwegian + enum: + - "12931" + - title: Portuguese + enum: + - "12932" + - title: Romanian + enum: + - "12933" + - title: Gypsy + enum: + - "12934" + - title: Russian + enum: + - "12935" + - title: Slavic + enum: + - "12937" + - title: Slovak + enum: + - "12938" + - title: Spanish + enum: + - "12939" + - title: Swedish + enum: + - "12940" + - title: Swiss + enum: + - "12941" + - title: Ukrainian + enum: + - "12942" + - title: American + enum: + - "12943" + - title: Canadian + enum: + - "12945" + - title: New Caledonian + enum: + - "12947" + - title: South African European + enum: + - "12948" + - title: Afrikaner + enum: + - "12949" + - title: Zimbabwean European + enum: + - "12950" + - title: European nec + enum: + - "12999" + - title: Māori + enum: + - "2" + - title: Māori + enum: + - "21" + - title: Māori + enum: + - "211" + - title: Māori + enum: + - "21111" + - title: Pacific Peoples + enum: + - "3" + - title: Pacific Peoples nfd + enum: + - "30" + - title: Pacific Peoples nfd + enum: + - "300" + - title: Pacific Peoples nfd + enum: + - "30000" + - title: Samoan + enum: + - "31" + - title: Samoan + enum: + - "311" + - title: Samoan + enum: + - "31111" + - title: Cook Islands Maori + enum: + - "32" + - title: Cook Islands Maori + enum: + - "321" + - title: Cook Islands Maori + enum: + - "32100" + - title: Tongan + enum: + - "33" + - title: Tongan + enum: + - "331" + - title: Tongan + enum: + - "33111" + - title: Niuean + enum: + - "34" + - title: Niuean + enum: + - "341" + - title: Niuean + enum: + - "34111" + - title: Tokelauan + enum: + - "35" + - title: Tokelauan + enum: + - "351" + - title: Tokelauan + enum: + - "35111" + - title: Fijian + enum: + - "36" + - title: Fijian + enum: + - "361" + - title: Fijian + enum: + - "36111" + - title: Other Pacific Peoples + enum: + - "37" + - title: Other Pacific Peoples + enum: + - "371" + - title: Indigenous Australian + enum: + - "37112" + - title: Hawaiian + enum: + - "37122" + - title: Kiribati + enum: + - "37124" + - title: Nauruan + enum: + - "37130" + - title: Papua New Guinean + enum: + - "37135" + - title: Pitcairn Islander + enum: + - "37137" + - title: Rotuman + enum: + - "37138" + - title: Tahitian + enum: + - "37140" + - title: Solomon Islander + enum: + - "37141" + - title: Tuvaluan + enum: + - "37144" + - title: Ni Vanuatu + enum: + - "37145" + - title: Pacific Peoples nec + enum: + - "37199" + - title: Asian + enum: + - "4" + - title: Asian nfd + enum: + - "40" + - title: Asian nfd + enum: + - "400" + - title: Asian nfd + enum: + - "40000" + - title: South East Asian + enum: + - "41" + - title: South East Asian nfd + enum: + - "410" + - title: South East Asian nfd + enum: + - "41000" + - title: Filipino + enum: + - "411" + - title: Filipino + enum: + - "41111" + - title: Cambodian + enum: + - "412" + - title: Cambodian + enum: + - "41211" + - title: Vietnamese + enum: + - "413" + - title: Vietnamese + enum: + - "41311" + - title: Other Southeast Asian + enum: + - "414" + - title: Burmese + enum: + - "41411" + - title: Indonesian + enum: + - "41412" + - title: Lao + enum: + - "41413" + - title: Malay + enum: + - "41414" + - title: Thai + enum: + - "41415" + - title: Karen + enum: + - "41416" + - title: Chin + enum: + - "41417" + - title: Southeast Asian nec + enum: + - "41499" + - title: Chinese + enum: + - "42" + - title: Chinese + enum: + - "421" + - title: Chinese nfd + enum: + - "42100" + - title: Hong Kong Chinese + enum: + - "42111" + - title: Cambodian Chinese + enum: + - "42112" + - title: Malaysian Chinese + enum: + - "42113" + - title: Singaporean Chinese + enum: + - "42114" + - title: Vietnamese Chinese + enum: + - "42115" + - title: Taiwanese + enum: + - "42116" + - title: Chinese nec + enum: + - "42199" + - title: Indian + enum: + - "43" + - title: Indian + enum: + - "431" + - title: Indian nfd + enum: + - "43100" + - title: Bengali + enum: + - "43111" + - title: Fijian Indian + enum: + - "43112" + - title: Indian Tamil + enum: + - "43114" + - title: Punjabi + enum: + - "43115" + - title: Sikh + enum: + - "43116" + - title: Anglo Indian + enum: + - "43117" + - title: Malaysian Indian + enum: + - "43118" + - title: South African Indian + enum: + - "43119" + - title: Indian nec + enum: + - "43199" + - title: Other Asian + enum: + - "44" + - title: Sri Lankan + enum: + - "441" + - title: Sri Lankan nfd + enum: + - "44100" + - title: Sinhalese + enum: + - "44111" + - title: Sri Lankan Tamil + enum: + - "44112" + - title: Sri Lankan nec + enum: + - "44199" + - title: Japanese + enum: + - "442" + - title: Japanese + enum: + - "44211" + - title: Korean + enum: + - "443" + - title: Korean + enum: + - "44311" + - title: Other Asian + enum: + - "444" + - title: Afghani + enum: + - "44411" + - title: Bangladeshi + enum: + - "44412" + - title: Nepalese + enum: + - "44413" + - title: Pakistani + enum: + - "44414" + - title: Tibetan + enum: + - "44415" + - title: Eurasian + enum: + - "44416" + - title: Bhutanese + enum: + - "44417" + - title: Maldivian + enum: + - "44418" + - title: Mongolian + enum: + - "44419" + - title: Asian nec + enum: + - "44499" + - title: Middle Eastern/Latin + American/African + enum: + - "5" + - title: Middle Eastern + enum: + - "51" + - title: Middle Eastern + enum: + - "511" + - title: Middle Eastern nfd + enum: + - "51100" + - title: Algerian + enum: + - "51111" + - title: Arab + enum: + - "51112" + - title: Assyrian + enum: + - "51113" + - title: Egyptian + enum: + - "51114" + - title: Iranian/Persian + enum: + - "51115" + - title: Iraqi + enum: + - "51116" + - title: Israeli/Jewish + enum: + - "51117" + - title: Jordanian + enum: + - "51118" + - title: Kurd + enum: + - "51119" + - title: Lebanese + enum: + - "51120" + - title: Moroccan + enum: + - "51122" + - title: Palestinian + enum: + - "51124" + - title: Syrian + enum: + - "51125" + - title: Turkish + enum: + - "51127" + - title: Middle Eastern nec + enum: + - "51199" + - title: Latin American + enum: + - "52" + - title: Latin American + enum: + - "521" + - title: Latin American nfd + enum: + - "52100" + - title: Argentinian + enum: + - "52111" + - title: Bolivian + enum: + - "52112" + - title: Brazilian + enum: + - "52113" + - title: Chilean + enum: + - "52114" + - title: Colombian + enum: + - "52115" + - title: Ecuadorian + enum: + - "52118" + - title: Mexican + enum: + - "52123" + - title: Peruvian + enum: + - "52127" + - title: Puerto Rican + enum: + - "52128" + - title: Uruguayan + enum: + - "52129" + - title: Venezuelan + enum: + - "52130" + - title: Latin American nec + enum: + - "52199" + - title: African + enum: + - "53" + - title: African + enum: + - "531" + - title: African nfd + enum: + - "53100" + - title: Jamaican + enum: + - "53113" + - title: Kenyan + enum: + - "53114" + - title: Nigerian + enum: + - "53115" + - title: African American + enum: + - "53116" + - title: Caribbean + enum: + - "53118" + - title: Somali + enum: + - "53119" + - title: Eritrean + enum: + - "53120" + - title: Ethiopian + enum: + - "53121" + - title: Ghanaian + enum: + - "53122" + - title: Burundian + enum: + - "53123" + - title: Congolese + enum: + - "53124" + - title: Sudanese + enum: + - "53125" + - title: Zambian + enum: + - "53126" + - title: Other Zimbabwean + enum: + - "53127" + - title: African nec + enum: + - "53199" + - title: Other Ethnicity + enum: + - "6" + - title: Other Ethnicity + enum: + - "61" + - title: Other Ethnicity + enum: + - "611" + - title: Indigenous American + enum: + - "61113" + - title: Mauritian + enum: + - "61115" + - title: Seychellois + enum: + - "61116" + - title: Other South African + enum: + - "61117" + - title: New Zealander + enum: + - "61118" + - title: Other Ethnicity nec + enum: + - "61199" + - title: Residual Categories + enum: + - "9" + - title: Don't Know + enum: + - "94" + - title: Don't Know + enum: + - "944" + - title: Don't Know + enum: + - "94444" + - title: Refused to Answer + enum: + - "95" + - title: Refused to Answer + enum: + - "955" + - title: Refused to Answer + enum: + - "95555" + - title: Repeated Value + enum: + - "96" + - title: Repeated Value + enum: + - "966" + - title: Repeated Value + enum: + - "96666" + - title: Response Unidentifiable + enum: + - "97" + - title: Response Unidentifiable + enum: + - "977" + - title: Response Unidentifiable + enum: + - "97777" + - title: Response Outside Scope + enum: + - "98" + - title: Response Outside Scope + enum: + - "988" + - title: Response Outside Scope + enum: + - "98888" + - title: Not Stated + enum: + - "99" + - title: Not Stated + enum: + - "999" + - title: Not Stated + enum: + - "99999" + IwiAffiliationList: + description:

A list of one or more iwi with which + the person has an affiliation.

+ type: object + required: + - IwiAffiliation + properties: + IwiAffiliation: + type: array + items: + type: string + title: Iwi + description: >- +

An iwi, or Māori tribe, is one + of the largest kinship groupings + and is generally made up of + several hapū that are all + descended from a common ancestor. + Hapū are clusters of whānau where + the whānau is usually an extended + family grouping consisting of + children, parents, often + grandparents, and other closely + related kin.

Sourced from + Statistics NZ - Iwi and Iwi + related groups statistical + standard v1.0.0.0

    +
  • 'NZS01' - Te Tai Tokerau/Tāmaki-makaurau (Northland/Auckland) Region Iwi
    • +
  • 'NZS0101' - Te Aupōuri
    • +
  • 'NZS0102' - Ngāti Kahu
    • +
  • 'NZS0103' - Ngāti Kurī
    • +
  • 'NZS0104' - Ngāpuhi
    • +
  • 'NZS0105' - Ngāpuhi ki Whaingaroa-Ngāti Kahu ki Whaingaroa
    • +
  • 'NZS0106' - Te Rarawa
    • +
  • 'NZS0107' - Ngāi Takoto
    • +
  • 'NZS0108' - Ngāti Wai
    • +
  • 'NZS0109' - Ngāti Whātua (not Ōrākei or Kaipara)
    • +
  • 'NZS0110' - Te Kawerau ā Maki
    • +
  • 'NZS0111' - Te Uri-o-Hau
    • +
plus 183 more value(s) at NZCodeSetsIwiType + oneOf: + - title: Te Tai Tokerau/Tāmaki-makaurau + (Northland/Auckland) Region + Iwi + enum: + - NZS01 + - title: Te Aupōuri + enum: + - NZS0101 + - title: Ngāti Kahu + enum: + - NZS0102 + - title: Ngāti Kurī + enum: + - NZS0103 + - title: Ngāpuhi + enum: + - NZS0104 + - title: Ngāpuhi ki Whaingaroa-Ngāti + Kahu ki Whaingaroa + enum: + - NZS0105 + - title: Te Rarawa + enum: + - NZS0106 + - title: Ngāi Takoto + enum: + - NZS0107 + - title: Ngāti Wai + enum: + - NZS0108 + - title: Ngāti Whātua (not Ōrākei or + Kaipara) + enum: + - NZS0109 + - title: Te Kawerau ā Maki + enum: + - NZS0110 + - title: Te Uri-o-Hau + enum: + - NZS0111 + - title: Te Roroa + enum: + - NZS0112 + - title: Ngāti Whātua o Kaipara + enum: + - NZS0113 + - title: Ngāti Whātua o Ōrākei + enum: + - NZS0114 + - title: Ngāi Tai ki Tāmaki + enum: + - NZS0115 + - title: Ngāti Hine (Te Tai Tokerau) + enum: + - NZS0116 + - title: Te Paatu + enum: + - NZS0117 + - title: Ngāti Manuhiri + enum: + - NZS0118 + - title: Ngāti Rēhua + enum: + - NZS0119 + - title: Hauraki (Coromandel) Region Iwi + enum: + - NZS02 + - title: Ngāti Hako + enum: + - NZS0201 + - title: Ngāti Hei + enum: + - NZS0202 + - title: Ngāti Maru (Hauraki) + enum: + - NZS0203 + - title: Ngāti Paoa + enum: + - NZS0204 + - title: Patukirikiri + enum: + - NZS0205 + - title: Ngāti Porou ki Harataunga ki + Mataora + enum: + - NZS0206 + - title: Ngāti Pūkenga ki Waiau + enum: + - NZS0207 + - title: Ngāti Rāhiri Tumutumu + enum: + - NZS0208 + - title: Ngāti Tamaterā + enum: + - NZS0210 + - title: Ngāti Tara Tokanui + enum: + - NZS0211 + - title: Ngāti Whanaunga + enum: + - NZS0212 + - title: Waikato/Te Rohe Pōtae + (Waikato/King Country) Region + Iwi + enum: + - NZS03 + - title: Ngāti Haua (Waikato) + enum: + - NZS0301 + - title: Ngāti Maniapoto + enum: + - NZS0302 + - title: Raukawa (Waikato) + enum: + - NZS0303 + - title: Waikato + enum: + - NZS0304 + - title: Ngāti Te Ata + enum: + - NZS0305 + - title: Ngāti Hīkairo + enum: + - NZS0306 + - title: Rereahu + enum: + - NZS0307 + - title: Ngāti Tiipa + enum: + - NZS0308 + - title: Ngāti Korokī Kahukura + enum: + - NZS0309 + - title: Ngāti Tamaoho + enum: + - NZS0310 + - title: Te Ākitai-Waiohua + enum: + - NZS0311 + - title: Te Arawa/Taupō (Rotorua/Taupō) + Region Iwi + enum: + - NZS04 + - title: Ngāti Pikiao (Te Arawa) + enum: + - NZS0401 + - title: Ngāti Rangiteaorere (Te Arawa) + enum: + - NZS0402 + - title: Ngāti Rangitihi (Te Arawa) + enum: + - NZS0403 + - title: Ngāti Rangiwewehi (Te Arawa) + enum: + - NZS0404 + - title: Tapuika (Te Arawa) + enum: + - NZS0405 + - title: Ngāti Tarāwhai (Te Arawa) + enum: + - NZS0406 + - title: Tūhourangi (Te Arawa) + enum: + - NZS0407 + - title: Uenuku-Kōpako (Te Arawa) + enum: + - NZS0408 + - title: Waitaha (Te Arawa) + enum: + - NZS0409 + - title: Ngāti Whakaue (Te Arawa) + enum: + - NZS0410 + - title: Ngāti Tūwharetoa (ki Taupō) + enum: + - NZS0411 + - title: Ngāti Tahu-Ngāti Whaoa (Te + Arawa) + enum: + - NZS0412 + - title: Ngāti Mākino + enum: + - NZS0413 + - title: Ngāti Kearoa / Ngāti Tuarā + enum: + - NZS0414 + - title: Ngāti Rongomai (Te Arawa) + enum: + - NZS0415 + - title: Tauranga Moana/Mātaatua (Bay + of Plenty) Region Iwi + enum: + - NZS05 + - title: Ngāti Pūkenga + enum: + - NZS0501 + - title: Ngāi Te Rangi + enum: + - NZS0502 + - title: Ngāti Ranginui + enum: + - NZS0503 + - title: Ngāti Awa + enum: + - NZS0504 + - title: Ngāti Manawa + enum: + - NZS0505 + - title: Ngāi Tai (Tauranga + Moana/Mātaatua) + enum: + - NZS0506 + - title: Tūhoe + enum: + - NZS0507 + - title: Whakatōhea + enum: + - NZS0508 + - title: Te Whānau-ā-Apanui + enum: + - NZS0509 + - title: Ngāti Whare + enum: + - NZS0510 + - title: Ngā Pōtiki ā Tamapahore + enum: + - NZS0511 + - title: Te Upokorehe + enum: + - NZS0512 + - title: Ngāti Tūwharetoa ki Kawerau + enum: + - NZS0513 + - title: Te Tai Rāwhiti (East Coast) + Region Iwi + enum: + - NZS06 + - title: Ngāti Porou + enum: + - NZS0601 + - title: Te Aitanga-a-Māhaki + enum: + - NZS0602 + - title: Rongowhakaata + enum: + - NZS0603 + - title: Ngāi Tāmanuhiri + enum: + - NZS0604 + - title: Te Aitanga ā Hauiti + enum: + - NZS0605 + - title: Te Matau-a-Māui/Wairarapa + (Hawke's Bay/Wairarapa) Region + Iwi + enum: + - NZS07 + - title: Rongomaiwahine (Te Māhia) + enum: + - NZS0701 + - title: Ngāti Kahungunu ki Te Wairoa + enum: + - NZS0702 + - title: Ngāti Kahungunu ki Heretaunga + enum: + - NZS0703 + - title: Ngāti Kahungunu ki Wairarapa + enum: + - NZS0704 + - title: Rangitāne (Te + Matau-a-Māui/Hawke's + Bay/Wairarapa) + enum: + - NZS0706 + - title: Ngāti Kahungunu ki Te + Whanganui-a-Orotu + enum: + - NZS0707 + - title: Ngāti Kahungunu ki Tamatea + enum: + - NZS0708 + - title: Ngāti Kahungunu ki Tamakinui a + Rua + enum: + - NZS0709 + - title: Ngāti Pāhauwera + enum: + - NZS0710 + - title: Ngāti Rākaipaaka + enum: + - NZS0711 + - title: Ngāti Hineuru + enum: + - NZS0712 + - title: Maungaharuru Tangitū + enum: + - NZS0713 + - title: Rangitāne o Tamaki nui ā Rua + enum: + - NZS0714 + - title: Ngāti Ruapani ki Waikaremoana + enum: + - NZS0715 + - title: Te Hika o Pāpāuma + enum: + - NZS0716 + - title: Taranaki Region Iwi + enum: + - NZS08 + - title: Te Atiawa (Taranaki) + enum: + - NZS0801 + - title: Ngāti Maru (Taranaki) + enum: + - NZS0802 + - title: Ngāti Mutunga (Taranaki) + enum: + - NZS0803 + - title: Ngā Rauru + enum: + - NZS0804 + - title: Ngā Ruahine + enum: + - NZS0805 + - title: Ngāti Ruanui + enum: + - NZS0806 + - title: Ngāti Tama (Taranaki) + enum: + - NZS0807 + - title: Taranaki + enum: + - NZS0808 + - title: Tangāhoe + enum: + - NZS0809 + - title: Pakakohi + enum: + - NZS0810 + - title: Whanganui/Rangitīkei + (Wanganui/Rangitīkei) Region + Iwi + enum: + - NZS09 + - title: Ngāti Apa (Rangitīkei) + enum: + - NZS0901 + - title: Te Ati Haunui-a-Pāpārangi + enum: + - NZS0902 + - title: Ngāti Haua (Taumarunui) + enum: + - NZS0903 + - title: Ngāti Hauiti (Rangitīkei) + enum: + - NZS0904 + - title: Ngāti Whitikaupeka (Rangitīkei) + enum: + - NZS0905 + - title: Ngāi Te Ohuake (Rangitīkei) + enum: + - NZS0906 + - title: Ngāti Tamakōpiri (Rangitīkei) + enum: + - NZS0907 + - title: Ngāti Rangi (Ruapehu, + Whanganui) + enum: + - NZS0908 + - title: Uenuku (Ruapehu, Waimarino) + enum: + - NZS0909 + - title: Tamahaki (Ruapehu, Waimarino) + enum: + - NZS0910 + - title: Tamakana (Ruapehu, Waimarino) + enum: + - NZS0911 + - title: Manawatū/Horowhenua/Te + Whanganui-a-Tara + (Manawatū/Horowhenua/Wellington) + Region Iwi + enum: + - NZS10 + - title: Te Atiawa (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1001 + - title: Muaūpoko + enum: + - NZS1002 + - title: Rangitāne (Manawatū) + enum: + - NZS1003 + - title: Ngāti Raukawa + (Horowhenua/Manawatū) + enum: + - NZS1004 + - title: Ngāti Toarangatira (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1005 + - title: Te Atiawa ki Whakarongotai + enum: + - NZS1006 + - title: Ngāti Tama ki Te Upoko o Te + Ika (Te + Whanganui-a-Tara/Wellington) + enum: + - NZS1007 + - title: Ngāti Kauwhata + enum: + - NZS1008 + - title: Ngāti Tukorehe + enum: + - NZS1009 + - title: Te Waipounamu/Wharekauri + (South Island/Chatham Islands) + Region Iwi + enum: + - NZS11 + - title: Te Atiawa (Te Waipounamu/South + Island) + enum: + - NZS1101 + - title: Ngāti Koata + enum: + - NZS1102 + - title: Ngāti Kuia + enum: + - NZS1103 + - title: Kāti Māmoe + enum: + - NZS1104 + - title: Moriori + enum: + - NZS1105 + - title: Ngāti Mutunga + (Wharekauri/Chatham Islands) + enum: + - NZS1106 + - title: Rangitāne (Te Waipounamu/South + Island) + enum: + - NZS1107 + - title: Ngāti Rārua + enum: + - NZS1108 + - title: Ngāi Tahu / Kāi Tahu + enum: + - NZS1109 + - title: Ngāti Tama (Te + Waipounamu/South Island) + enum: + - NZS1110 + - title: Ngāti Toarangatira (Te + Waipounamu/South Island) + enum: + - NZS1111 + - title: Waitaha (Te Waipounamu/South + Island) + enum: + - NZS1112 + - title: Ngāti Apa ki Te Rā Tō + enum: + - NZS1113 + - title: Confederations and Waka, iwi + not named + enum: + - NZS20 + - title: Tainui, iwi not named + enum: + - NZS2001 + - title: Te Arawa, iwi not named + enum: + - NZS2002 + - title: Tākitimu, iwi not named + enum: + - NZS2003 + - title: Aotea, iwi not named + enum: + - NZS2004 + - title: Mātaatua, iwi not named + enum: + - NZS2005 + - title: Mahuru, iwi not named + enum: + - NZS2006 + - title: Māmari, iwi not named + enum: + - NZS2007 + - title: Ngātokimatawhaorua, iwi not + named + enum: + - NZS2008 + - title: Nukutere, iwi not named + enum: + - NZS2009 + - title: Tokomaru, iwi not named + enum: + - NZS2010 + - title: Kurahaupō, iwi not named + enum: + - NZS2011 + - title: Muriwhenua, iwi not named + enum: + - NZS2012 + - title: Hauraki / Pare Hauraki, iwi + not named + enum: + - NZS2013 + - title: Tūranganui a Kiwa, iwi not + named + enum: + - NZS2014 + - title: Te Tauihu o Te Waka a Māui, + iwi not named + enum: + - NZS2015 + - title: Tauranga Moana, iwi not named + enum: + - NZS2016 + - title: Horouta, iwi not named + enum: + - NZS2017 + - title: Mōkai Pātea, iwi not named + enum: + - NZS2018 + - title: Iwi named, region not known + enum: + - NZS21 + - title: Te Atiawa, region not known + enum: + - NZS2101 + - title: Ngāti Haua, region not known + enum: + - NZS2102 + - title: Ngāti Maru, region not known + enum: + - NZS2103 + - title: Ngāti Mutunga, region not known + enum: + - NZS2104 + - title: Rangitāne, region not known + enum: + - NZS2105 + - title: Ngāti Raukawa, region not known + enum: + - NZS2106 + - title: Ngāti Tama, region not known + enum: + - NZS2107 + - title: Ngāti Toa, region not known + enum: + - NZS2108 + - title: Waitaha, region not known + enum: + - NZS2109 + - title: Ngāti Apa, region not known + enum: + - NZS2110 + - title: Ngāi Tai, region not known + enum: + - NZS2111 + - title: Ngāti Kahungunu, region not + known + enum: + - NZS2112 + - title: Ngāti Tūwharetoa, region not + known + enum: + - NZS2113 + - title: Hapū affiliated to more than + one iwi + enum: + - NZS22 + - title: Hapū affiliated to more than + one iwi + enum: + - NZS2201 + - title: Region known, Iwi not named + enum: + - NZS23 + - title: Te Tai Tokerau/Tāmaki-makaurau + Region, Iwi not named + enum: + - NZS2301 + - title: Hauraki Region, Iwi not named + enum: + - NZS2302 + - title: Waikato/Te Rohe Pōtae Region, + Iwi not named + enum: + - NZS2303 + - title: Te Arawa/Taupō Region, Iwi not + named + enum: + - NZS2304 + - title: Tauranga Moana/Mātaatua + Region, Iwi not named + enum: + - NZS2305 + - title: Te Tai Rāwhiti Region, Iwi not + named + enum: + - NZS2306 + - title: Te Matau-a-Māui/Wairarapa + Region, Iwi not named + enum: + - NZS2307 + - title: Taranaki Region, Iwi not named + enum: + - NZS2308 + - title: Whanganui/Rangitīkei Region, + Iwi not named + enum: + - NZS2309 + - title: Manawatū/Horowhenua/Te + Whanganui-a-Tara Region, Iwi + not named + enum: + - NZS2310 + - title: Te Waipounamu/Wharekauri + Region, Iwi not named + enum: + - NZS2311 + - title: Don't Know + enum: + - NZS44 + - title: Refused To Answer + enum: + - NZS55 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + ReligiousAffiliationList: + description:

A list of one or more religions with + which the person has an affiliation.

+ type: object + required: + - ReligiousAffiliation + properties: + ReligiousAffiliation: + type: array + items: + type: string + title: Religion + description: >- +

Religious affiliation is the + self-identified association of a + person with a religion, + denomination or sub-denominational + religious group.

Sourced + from Statistics NZ - Religious + Affiliation 1999 v1.0.0.0

    +
  • 'NZS0' - No Religion
    • +
  • 'NZS1' - Buddhist
    • +
  • 'NZS101' - Buddhist
    • +
  • 'NZS10101' - Zen Buddhist
    • +
  • 'NZS10199' - Buddhist nec
    • +
  • 'NZS2' - Christian
    • +
  • 'NZS201' - Adventist
    • +
  • 'NZS20101' - Christadelphian
    • +
  • 'NZS20102' - Seventh Day Adventist
    • +
  • 'NZS20103' - Worldwide Church of God
    • +
  • 'NZS20199' - Adventist nec
    • +
  • 'NZS202' - Anglican
    • +
plus 117 more value(s) at NZCodeSetsReligionType + oneOf: + - title: No Religion + enum: + - NZS0 + - title: Buddhist + enum: + - NZS1 + - title: Buddhist + enum: + - NZS101 + - title: Zen Buddhist + enum: + - NZS10101 + - title: Buddhist nec + enum: + - NZS10199 + - title: Christian + enum: + - NZS2 + - title: Adventist + enum: + - NZS201 + - title: Christadelphian + enum: + - NZS20101 + - title: Seventh Day Adventist + enum: + - NZS20102 + - title: Worldwide Church of God + enum: + - NZS20103 + - title: Adventist nec + enum: + - NZS20199 + - title: Anglican + enum: + - NZS202 + - title: Asian Christian + enum: + - NZS203 + - title: Chinese Christian + enum: + - NZS20301 + - title: Korean Christian + enum: + - NZS20302 + - title: Baptist + enum: + - NZS204 + - title: Bible Baptist + enum: + - NZS20401 + - title: Independent Baptist + enum: + - NZS20402 + - title: Reformed Baptist + enum: + - NZS20403 + - title: Baptist nec + enum: + - NZS20499 + - title: Brethren + enum: + - NZS205 + - title: Exclusive Brethren + enum: + - NZS20501 + - title: Open Brethren + enum: + - NZS20502 + - title: Plymouth Brethren + enum: + - NZS20503 + - title: Brethren nec + enum: + - NZS20599 + - title: Catholic + enum: + - NZS206 + - title: Roman Catholic + enum: + - NZS20601 + - title: Catholic nec + enum: + - NZS20699 + - title: Church of Christ and + Associated Churches of Christ + enum: + - NZS207 + - title: Associated Churches of Christ + enum: + - NZS20701 + - title: Other Church of Christ and + Churches of Christ nec + enum: + - NZS20799 + - title: Evangelical, Born Again and + Fundamentalist + enum: + - NZS208 + - title: Evangelical + enum: + - NZS20801 + - title: Born Again + enum: + - NZS20802 + - title: Fundamentalist + enum: + - NZS20803 + - title: Independent Evangelical + Churches + enum: + - NZS20804 + - title: Jehovah's Witnesses + enum: + - NZS209 + - title: Jehovah's Witnesses + enum: + - NZS20901 + - title: Latter-day Saints + enum: + - NZS210 + - title: Lutheran + enum: + - NZS211 + - title: Methodist + enum: + - NZS212 + - title: Tongan Methodist + enum: + - NZS21201 + - title: Methodist nec + enum: + - NZS21299 + - title: Orthodox + enum: + - NZS213 + - title: Assyrian Orthodox + enum: + - NZS21301 + - title: Coptic Orthodox + enum: + - NZS21302 + - title: Greek Orthodox + enum: + - NZS21303 + - title: Russian Orthodox + enum: + - NZS21304 + - title: Serbian Orthodox + enum: + - NZS21305 + - title: Orthodox nec + enum: + - NZS21399 + - title: Pentecostal + enum: + - NZS214 + - title: Apostolic Church of New Zealand + enum: + - NZS21401 + - title: Assemblies of God + enum: + - NZS21402 + - title: Christian Fellowship + enum: + - NZS21403 + - title: Christian Outreach + enum: + - NZS21404 + - title: Christian Revival Crusade + enum: + - NZS21405 + - title: Elim + enum: + - NZS21406 + - title: Full Gospel + enum: + - NZS21407 + - title: Independent Pentecostal + enum: + - NZS21408 + - title: New Life Centres + enum: + - NZS21409 + - title: Revival Centres + enum: + - NZS21410 + - title: United Pentecostal + enum: + - NZS21411 + - title: Vineyard Christian Fellowship + enum: + - NZS21412 + - title: Pentecostal nec + enum: + - NZS21499 + - title: Presbyterian, Congregational + and Reformed + enum: + - NZS215 + - title: Presbyterian + enum: + - NZS21501 + - title: Congregational + enum: + - NZS21502 + - title: Cook Island Congregational + enum: + - NZS21503 + - title: Samoan Congregational + enum: + - NZS21504 + - title: Reformed + enum: + - NZS21505 + - title: Protestant + enum: + - NZS216 + - title: Salvation Army + enum: + - NZS217 + - title: Uniting/Union Church and + Ecumenical + enum: + - NZS218 + - title: Uniting/Union Church + enum: + - NZS21801 + - title: Ecumenical + enum: + - NZS21802 + - title: Other Christian + enum: + - NZS299 + - title: Christian and Missionary + Alliance + enum: + - NZS29901 + - title: Christian Science + enum: + - NZS29902 + - title: Church of God + enum: + - NZS29903 + - title: Commonwealth Covenant Church + enum: + - NZS29904 + - title: Liberal Catholic + enum: + - NZS29905 + - title: Metropolitan + enum: + - NZS29906 + - title: Nazarene + enum: + - NZS29907 + - title: Religious Society of Friends + (Quaker) + enum: + - NZS29908 + - title: Unitarian + enum: + - NZS29909 + - title: Hindu + enum: + - NZS3 + - title: Hare Krishna + enum: + - NZS30101 + - title: Yoga + enum: + - NZS30102 + - title: Islam/Muslim + enum: + - NZS4 + - title: Sufi + enum: + - NZS40101 + - title: Judaism/Jewish + enum: + - NZS5 + - title: Māori Christian + enum: + - NZS6 + - title: Ratana + enum: + - NZS601 + - title: Ringatū + enum: + - NZS602 + - title: Other Māori Christian + enum: + - NZS609 + - title: Spiritualism and New Age + Religions + enum: + - NZS7 + - title: Church of Scientology + enum: + - NZS701 + - title: Nature and Earth Based + Religions + enum: + - NZS702 + - title: Animist + enum: + - NZS70201 + - title: Druid + enum: + - NZS70202 + - title: Pantheist + enum: + - NZS70203 + - title: Wiccan + enum: + - NZS70204 + - title: Satanism + enum: + - NZS703 + - title: Spiritualist + enum: + - NZS704 + - title: Other New Age Religions + enum: + - NZS709 + - title: Rastafarianism + enum: + - NZS70901 + - title: Other Religions + enum: + - NZS8 + - title: Baha'i + enum: + - NZS801 + - title: Chinese Religions + enum: + - NZS802 + - title: Confucianism + enum: + - NZS80201 + - title: Taoism + enum: + - NZS80202 + - title: Jainism + enum: + - NZS803 + - title: Japanese Religion + enum: + - NZS804 + - title: Mahikari + enum: + - NZS80401 + - title: Shinto + enum: + - NZS80402 + - title: Tenrikyo + enum: + - NZS80403 + - title: Māori Religion + enum: + - NZS805 + - title: Hauhau + enum: + - NZS80501 + - title: Sikh + enum: + - NZS806 + - title: Theism + enum: + - NZS807 + - title: Zoroastrian + enum: + - NZS808 + - title: Other Religions + enum: + - NZS809 + - title: Unification Church (Moonist) + enum: + - NZS80901 + - title: Other Religions nec + enum: + - NZS80999 + - title: Don't Know + enum: + - NZS944 + - title: Object to answering + enum: + - NZS955 + - title: Religion Unidentifiable + enum: + - NZS977 + - title: Response Outside Scope + enum: + - NZS988 + - title: Not Stated + enum: + - NZS999 + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + AddressList: + description: The person's address(es) - one or more + addresses + type: object + required: + - Address + properties: + Address: + type: array + items: + description:

This element contains address + data.

+ type: object + required: + - Street + properties: + Type: + type: string + title: Address Type + description: >- +

Address type allows an address + to be categorised according to its + component structure. Address type + can be used to build processing + rules for validating, managing and + presenting addresses. Address type + is independent of the use of the + address by any party. To describe + how a party may use an address + (residence, billing, term address + etc) see AddressRoleType

    +
  • 'TH' - Thoroughfare
    • +
  • 'RU' - Rural Post Delivery
    • +
  • 'DE' - Delivery Service
    • +
  • 'WA' - Water
    • +
  • 'FO' - Foreign Address
    • +
+ oneOf: + - title: Thoroughfare + description: "\"

Also called 'Street' + addresses, The most general, + and widely used type of + address, and can contain the + widest variety of + components

In general a + thoroughfare address will + include components for a + number, a roadname, and a + locality.

They cannot + contain any of the components + specific to a delivery + service, rural post delivery, + or water address.

These + addresses are used to find a + location.

Example: 30 - + 40 Lambton Quay, Wellington, + 6165

\"" + enum: + - TH + - title: Rural Post Delivery + description: '"

Defined by New Zealand + Post, these addresses are + assigned by NZ Post for + customers who purchase a rural + delivery service (mail and + also other goods).

They + will have the same number and + roadname components as the + street address, and may have + the same region component.

+

They do not have a + component that identifies the + locality the address is + within. The locality and city + or town components are + replaced by components that + identify the rural delivery + route (RD number), and the + town from which the rural + delivery route starts and + finishes (the mail town). Only + addresses of this class can + contain these components.

+

Example: 121 + Waitaha Road, RD 1, Ross, + 7885

"' + enum: + - RU + - title: Delivery Service + description: '"

Defined by New Zealand + Post, and used exclusively for + NZ Post services other than + standard mail delivery. + Addresses in this class + include PO Box, Private Bag, + and Counter Delivery + addresses.

+ Example: Private Bag + 2345, Auckland, 1142

"' + enum: + - DE + - title: Water + description: '"

Where properties have no + road access, but do have + access to water frontage + (coastline or riverbank or + lakefront), a water address + uses the name of a water + feature (for example, islands, + rivers, bays, or + peninsulas).

+ Example: 235 Lochmara + Bay, Queen Charlotte Sound, + Marlborough Sounds

"' + enum: + - WA + - title: Foreign Address + description: '"

A foreign address + identifies a location outside + of New Zealand.

+ Example: + Rudolf-Diesel-Strasse 14, + 54595 Prüm, Germany

"' + enum: + - FO + Role: + type: string + title: Address Role + description: >- +

A standardised description of + the role or usage of an address by + a party (person or organisation). + Where a party has more than one + address, this provides context for + deciding which address to use.

+
    +
  • 'PHY' - Physical Address
    • +
  • 'POS' - Postal Address
    • +
+ oneOf: + - title: Physical Address + description: Applies to addresses + associated with persons + enum: + - PHY + - title: Postal Address + description: Applies to addresses + associated with persons or + organisations + enum: + - POS + Street: + description:

The street element is a complex + element and breaks the street down + into several parts. (Allow for PO + Box here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line 1.

+ Line2: + type: string + description:

Address line 2.

+ Line3: + type: string + description:

Address line 3.

+ Suburb: + type: string + description:

The suburb part of urban + addresses, or the 'RD No' part of + rural addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province code. + StateTerritory Code only + applicable if a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal code.

+ GridLocation: + description:

The latitude & longitude of the + location. Grid location values are + derived from New Zealand Map Grid + x,y coordinates and converted to + Latitude and Longitude values per + the World Geodetic System 1984 + (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in decimal + degrees.

Latitudes + north of the equator are + positive, latitudes south of + the equator are negative [ISO + 6709].

+ Longitude: + description:

Longitude in decimal + degrees.

Longitudes + east of the Prime Meridian in + Greenwich are positive, + longitudes west of the Prime + Meridian are negative. The + 180th meridian is negative. + [ISO 6709]

+ StatisticalAreaList: + description:

A list of Statistical Areas + containing the location.

+

The list may contain exactly + one StatisticalArea element for + each of the following spatial unit + types:

  • Ward
    • +
  • Urban Area
  • Census + Area Unit
  • Māori + Electorate
  • Mesh + Block
  • General + Electorate
  • Territorial + Authority
  • Local Board + (Auckland Only)
  • Regional + Council
+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular statistical + area defined by Statistics + New Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + type: string + title: Spatial Unit Type + description: >- +

A classification of + geographical boundaries + or statistical areas as + defined by Statistics + NZ’s geographic + hierarchy.

    +
  • 'AE' - Area Unit
    • +
  • 'GE' - General Electoral District
    • +
  • 'CB' - Community Board
    • +
  • 'ME' - Māori Electoral District
    • +
  • 'MB' - Mesh Block
    • +
  • 'RC' - Regional Council
    • +
  • 'TA' - Territorial Authority
    • +
  • 'UA' - Urban Area
    • +
  • 'WA' - Ward
    • +
+ oneOf: + - title: Area Unit + description:

Area units are + aggregations of + meshblocks. They are + non–administrative + areas that are in + between meshblocks + and territorial + authorities in size. + Area units must + either define or + aggregate to define, + regional councils, + territorial + authorities and + urban areas.

+ Statistics NZ + Classification of + Area Unit 2013 + v1.0.0 + enum: + - AE + - title: General Electoral + District + description:

The general + electoral districts + as constituted under + the Electoral Act + 1993.

Statistics + NZ General Electoral + District 2014 v1.0.0 + enum: + - GE + - title: Community Board + description:

(aka Local Board + within Auckland) + Local boards provide + governance at the + local level within + Auckland Council. + They enable + democratic decision + making by, and on + behalf of + communities within + the local board + area.

Statistics + NZ Community Board + 2013 v1.0.0 + enum: + - CB + - title: Māori Electoral + District + description:

Māori electoral + districts are the + voting districts for + parliamentary + elections for people + who choose to be on + the Māori Electoral + Roll.

Statistics + NZ Māori Electoral + District 2014 v1.0.0 + enum: + - ME + - title: Mesh Block + description:

A meshblock is + the smallest + geographic unit for + which statistical + data is collected + and processed by + Statistics New + Zealand.

A + meshblock is defined + by a geographic + area, which can vary + in size from part of + a city block to a + large area of rural + land. Each meshblock + borders on another + to form a network + covering all of New + Zealand, including + coasts and inlets + and extending out to + the 200-mile + economic zone.

+ Statistics NZ + Statistical Standard + for Meshblock 2013 + v1.0.0 + enum: + - MB + - title: Regional Council + description:

The top tier of + local government in + New Zealand, defined + by the Local + Government Act 2002, + which requires the + boundaries of + regions to conform + as far as possible + to one or more water + catchments. When + determining regional + boundaries, the + Local Government + Commission gave + consideration to + regional communities + of interest when + selecting water + catchments to be + included in a + region. It also + considered factors + such as natural + resource management, + land use planning + and environmental + matters.

+ Statistics NZ + Regional Council + 2013 v1.0.0 + enum: + - RC + - title: Territorial Authority + description:

The second tier + of local government + in New Zealand, + defined under the + Local Government Act + 2002 as a city + council or district + council. There are + 67 territorial + authorities + consisting of 12 + city councils, 53 + districts, Auckland + Council, and Chatham + Islands Council.

+ Statistics NZ + Territorial + Authority 2013 + v1.0.0 + enum: + - TA + - title: Urban Area + description: '"

Urban Areas are + statistically + defined areas with + no administrative or + legal basis. There + is a three part + hierarchical + sub-division of + urban areas into: + main urban areas, + secondary urban + areas, minor urban + areas. Together the + populations in main, + secondary and minor + urban areas comprise + the statistically + defined urban + population of New + Zealand. The urban + area classification + is designed to + identify + concentrated urban + or semi-urban + settlements without + the distortions of + administrative + boundaries.

+ Statistics NZ Urban + Area 2013 v2.0.0"' + enum: + - UA + - title: Ward + description:

Wards are defined + under the Local + Electoral Act 2001 + and result from the + division, for + electoral purposes, + of the district of a + territorial + authority. The ward + system was designed + to allow for the + recognition of + communities within a + district and to + increase community + involvement in the + local government + system.

+ Statistics NZ Ward + 2013 v1.0.0 + enum: + - WA + Code: + type: string + description:

A valid value defined + by the nominated spatial + unit type, defined by + Statistics New Zealand + in one of the following + statistical area + defintion standards:

+
Area Unit
+
Statistics NZ + Classification of Area + Unit 2017 v1.0.0
+
General Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community Board
+
Statistics NZ + Community Board (codes + 07601 - 07621) 2018 + v1.0.0
Māori + Electoral District
+
Statistics NZ Māori + Electoral District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard for + Meshblock 2018 + v1.0.0
Regional + Council
+
Statistics NZ + Regional Council 2018 + v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial Authority + 2018 v1.0.0
+
Urban Area
+
Statistics NZ Urban + Area 2018 v1.0.0
+
Ward
+
Statistics NZ Ward + 2018 v1.0.0
+ EmailList: + description:

The person's e-mail address(es) - one or + more emails.

+ type: object + required: + - Email + properties: + Email: + type: array + items: + description:

This element represents an e-mail + address of one of a number of types + and occurs in objects such as + StudentPersonal, StaffPersonal, + StudentContactPersonal, etc.

+ type: object + required: + - Address + properties: + Type: + type: string + title: Email Type + description: >- +

A standardised method of + describing an electronic mail + address used as contact method by + a party. Where a party has more + than one email address, this may + provide context for deciding which + email address to use.

    +
  • 'PRIM' - Primary
    • +
  • 'WORK' - Work
    • +
  • 'PERS' - Personal
    • +
  • 'ALT1' - Alternate 1
    • +
  • 'ALT2' - Alternate 2
    • +
  • 'ALT3' - Alternate 3
    • +
  • 'ALT4' - Alternate 4
    • +
+ oneOf: + - title: Primary + description: Applicable to organisations, + eg schools + enum: + - PRIM + - title: Work + description: Only used for persons + enum: + - WORK + - title: Personal + description: Only used for persons + enum: + - PERS + - title: Alternate 1 + enum: + - ALT1 + - title: Alternate 2 + enum: + - ALT2 + - title: Alternate 3 + enum: + - ALT3 + - title: Alternate 4 + enum: + - ALT4 + Address: + type: string + description:

The actual email address.

+ PhoneNumberList: + description:

The person's phone number(s) - one or + more phone numbers.

+ type: object + required: + - PhoneNumber + properties: + PhoneNumber: + type: array + items: + description:

This element represents a phone + number and occurs within objects such + as StudentPersonal, StaffPersonal, + etc.

+ type: object + required: + - Number + properties: + Type: + type: string + title: Telephone Number Type + description: >- +

A standardised method of + describing a telecommunications + device used as contact method by a + party. Where a party has more than + one phone number, this may provide + context for deciding which number + to use.

    +
  • 'MAI' - Main Telephone Number
    • +
  • 'FAX' - Facsimile Number
    • +
  • 'HTE' - Home Telephone Number
    • +
  • 'HMO' - Home Mobile
    • +
  • 'MOB' - Mobile
    • +
  • 'WMO' - Work Mobile
    • +
  • 'WTE' - Work Telephone Number
    • +
+ oneOf: + - title: Main Telephone Number + enum: + - MAI + - title: Facsimile Number + enum: + - FAX + - title: Home Telephone Number + description: Person usage only + enum: + - HTE + - title: Home Mobile + description: Person usage only + enum: + - HMO + - title: Mobile + enum: + - MOB + - title: Work Mobile + enum: + - WMO + - title: Work Telephone Number + enum: + - WTE + Number: + type: string + description: "

Phone number. Free-form, but + typical New Zealand formats + include:

  • (0##) + ###-####
  • ###-####
    • +
  • +##### ### ####
" + Extension: + type: string + description:

Phone number extension.

+ ListedStatus: + $ref: "#/paths/~1StudentContactPersonal\ + s/get/responses/200/content/appli\ + cation~1json/schema/properties/St\ + udentContactPersonals/properties/\ + StudentContactPersonal/items/prop\ + erties/HasBOTVote" + HouseholdContactInfoList: + description:

The person's household/s contact + information. A list of one or more + household’s contact information.

+ type: object + required: + - HouseholdContactInfo + properties: + HouseholdContactInfo: + type: array + items: + description:

Common element used to supply + information about a particular + household a person is a member of.

+ type: object + properties: + PreferenceNumber: + type: integer + description:

Priority of Household Contact + in relation to this Person.

+ HouseholdContactId: + $ref: "#/paths/~1StudentContactPersonal\ + s/get/responses/200/content/appli\ + cation~1json/schema/properties/St\ + udentContactPersonals/properties/\ + StudentContactPersonal/items/prop\ + erties/StudentContactPersonalLoca\ + lId" + HouseholdSalutation: + type: string + description:

Salutation to be used in + addressing this household.

+ AddressList: + description:

A list of Address elements.

+ type: object + required: + - Address + properties: + Address: + type: array + items: + description:

This element contains + address data.

+ type: object + required: + - Street + properties: + Type: + $ref: "#/paths/~1StudentConta\ + ctPersonals/get/respons\ + es/200/content/applicat\ + ion~1json/schema/proper\ + ties/StudentContactPers\ + onals/properties/Studen\ + tContactPersonal/items/\ + properties/PersonInfo/p\ + roperties/AddressList/p\ + roperties/Address/items\ + /properties/Type" + Role: + $ref: "#/paths/~1StudentConta\ + ctPersonals/get/respons\ + es/200/content/applicat\ + ion~1json/schema/proper\ + ties/StudentContactPers\ + onals/properties/Studen\ + tContactPersonal/items/\ + properties/PersonInfo/p\ + roperties/AddressList/p\ + roperties/Address/items\ + /properties/Role" + Street: + description:

The street element is + a complex element and + breaks the street down + into several parts. + (Allow for PO Box + here)

+ type: object + required: + - Line1 + properties: + Line1: + type: string + description:

Address line + 1.

+ Line2: + type: string + description:

Address line + 2.

+ Line3: + type: string + description:

Address line + 3.

+ Suburb: + type: string + description:

The suburb part of + urban addresses, or the + 'RD No' part of rural + addresses

+ City: + type: string + description:

The city part of the + address.

+ StateProvince: + type: string + description:

The state or province + code. StateTerritory + Code only applicable if + a non-New Zealand + Address.

+ Country: + type: string + description:

The country code.

+ PostalCode: + type: string + description:

The ZIP/postal + code.

+ GridLocation: + description:

The latitude & + longitude of the + location. Grid location + values are derived from + New Zealand Map Grid x,y + coordinates and + converted to Latitude + and Longitude values per + the World Geodetic + System 1984 (G1762)

+ type: object + required: + - Latitude + - Longitude + properties: + Latitude: + description:

Latitude in + decimal degrees.

+

Latitudes north + of the equator are + positive, latitudes + south of the equator + are negative [ISO + 6709].

+ Longitude: + description:

Longitude in + decimal degrees.

+

Longitudes east + of the Prime + Meridian in + Greenwich are + positive, longitudes + west of the Prime + Meridian are + negative. The 180th + meridian is + negative. [ISO + 6709]

+ StatisticalAreaList: + description:

A list of Statistical + Areas containing the + location.

The + list may contain exactly + one StatisticalArea + element for each of the + following spatial unit + types:

    +
  • Ward
  • Urban + Area
  • Census + Area Unit
  • Māori + Electorate
  • Mesh + Block
  • General + Electorate
    • +
  • Territorial + Authority
  • Local + Board (Auckland + Only)
  • Regional + Council
+ type: object + required: + - StatisticalArea + properties: + StatisticalArea: + type: array + items: + description:

A particular + statistical area + defined by + Statistics New + Zealand.

+ type: object + required: + - Code + - SpatialUnitType + properties: + SpatialUnitType: + $ref: "#/paths/~1St\ + udentContactPersona\ + ls/get/responses/20\ + 0/content/applicati\ + on~1json/schema/pro\ + perties/StudentCont\ + actPersonals/proper\ + ties/StudentContact\ + Personal/items/prop\ + erties/PersonInfo/p\ + roperties/AddressLi\ + st/properties/Addre\ + ss/items/properties\ + /StatisticalAreaLis\ + t/properties/Statis\ + ticalArea/items/pro\ + perties/SpatialUnit\ + Type" + Code: + type: string + description:

A valid + value defined by the + nominated spatial + unit type, defined + by Statistics New + Zealand in one of + the following + statistical area + defintion + standards:

+
Area Unit
+
Statistics NZ + Classification of + Area Unit 2017 + v1.0.0
+
General + Electoral + District
+
Statistics NZ + General Electoral + District 2014 + v1.0.0
+
Community + Board
+
Statistics NZ + Community Board + (codes 07601 - + 07621) 2018 + v1.0.0
+
Māori Electoral + District
+
Statistics NZ + Māori Electoral + District 2014 + v1.0.0
Mesh + Block
+
Statistics NZ + Statistical Standard + for Meshblock 2018 + v1.0.0
+
Regional + Council
+
Statistics NZ + Regional Council + 2018 v1.0.0
+
Territorial + Authority
+
Statistics NZ + Territorial + Authority 2018 + v1.0.0
+
Urban Area
+
Statistics NZ + Urban Area 2018 + v1.0.0
+
Ward
+
Statistics NZ + Ward 2018 + v1.0.0
+ EmailList: + description:

List of Email elements.

+ type: object + required: + - Email + properties: + Email: + type: array + items: + description:

This element represents + an e-mail address of one of + a number of types and occurs + in objects such as + StudentPersonal, + StaffPersonal, + StudentContactPersonal, etc. +

+ type: object + required: + - Address + properties: + Type: + $ref: "#/paths/~1StudentConta\ + ctPersonals/get/respons\ + es/200/content/applicat\ + ion~1json/schema/proper\ + ties/StudentContactPers\ + onals/properties/Studen\ + tContactPersonal/items/\ + properties/PersonInfo/p\ + roperties/EmailList/pro\ + perties/Email/items/pro\ + perties/Type" + Address: + type: string + description:

The actual email + address.

+ PhoneNumberList: + description:

List of PhoneNumber + elements.

+ type: object + required: + - PhoneNumber + properties: + PhoneNumber: + type: array + items: + description:

This element represents a + phone number and occurs + within objects such as + StudentPersonal, + StaffPersonal, etc.

+ type: object + required: + - Number + properties: + Type: + $ref: "#/paths/~1StudentConta\ + ctPersonals/get/respons\ + es/200/content/applicat\ + ion~1json/schema/proper\ + ties/StudentContactPers\ + onals/properties/Studen\ + tContactPersonal/items/\ + properties/PersonInfo/p\ + roperties/PhoneNumberLi\ + st/properties/PhoneNumb\ + er/items/properties/Typ\ + e" + Number: + type: string + description: "

Phone number. + Free-form, but typical + New Zealand formats + include:

    +
  • (0##) ###-####
    • +
  • ###-####
    • +
  • +##### ### ####
    • +
" + Extension: + type: string + description:

Phone number + extension.

+ ListedStatus: + $ref: "#/paths/~1StudentConta\ + ctPersonals/get/respons\ + es/200/content/applicat\ + ion~1json/schema/proper\ + ties/StudentContactPers\ + onals/properties/Studen\ + tContactPersonal/items/\ + properties/HasBOTVote" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + HealthcareServiceInfo: + description:

Information about the StudentContact, when + that contact is a healthcare service. Details + about the actual healthcare pratitioner are kept + in the PersonInfo fields.

+ type: object + required: + - OrganisationName + - OrganisationPhoneNum + - Type + properties: + OrganisationName: + type: string + description: "

The name of the healthcare service, eg: + 'Martinborough Health Centre'

" + OrganisationPhoneNum: + type: string + description:

The name phone number of the healthcare + service

+ Notes: + type: string + description:

Who at the healthservice is the Student's + regular e.g. 'Dr Phillips'

+ Type: + type: string + title: Healthcare Service Type + description: >- +

Code denoting the type of healthcare + service provided by a StudentContact.

+
    +
  • 'DOC' - Doctor
    • +
  • 'DEN' - Dentist
    • +
  • 'THE' - Therapist
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Doctor + enum: + - DOC + - title: Dentist + enum: + - DEN + - title: Therapist + enum: + - THE + - title: Other + enum: + - OTH + description: Information about a Student's whānau member. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StudentContactPersonals: + StudentContactPersonal: + - StudentContactPersonalRefId: 7C834EA9-EDA1-2090-347F-83297E1C290F + StudentContactPersonalLocalId: P1234567 + HasBOTVote: N + PersonInfo: + Name: + FamilyName: Hagrid + GivenName: Fridwulfa + FullName: Fridwulfa Hagrid + Type: LGL + AddressList: + Address: + - Type: TH + Role: PHY + Street: + Line1: The Enchanted Wood + Line2: 533 Hogwart's Way + City: Hogsmead + PostalCode: "7733" + - Type: RU + Role: PHY + Street: + Line1: 1175 Lake Ferry Rd + Suburb: RD 1 + City: Martinborough + EmailList: + Email: + - Type: PRIM + Address: ridwulfa@gmail.com + PhoneNumberList: + PhoneNumber: + Type: MOB + Number: (021) 300 999 + HouseholdContactInfoList: + HouseholdContactInfo: + - PreferenceNumber: 1 + HouseholdContactId: 7d5c3f5c-d89c-4551-9442-6b008207986e + AddressList: + Address: + - Type: DE + Role: POS + Street: + Line1: P O Box 81 + City: Martinborough + PostalCode: "5781" + "{\n \"Email\": { \"Type\": \"WORK\", \"Address\": \"ridwulfa@gmail.com\" }\n}": null + PhoneNumberList: + PhoneNumber: + Type: MOB + Number: (021) 300 999 + application/xml: + schema: + type: object + properties: + StudentContactPersonals: + type: object + description: A List of StudentContactPersonal objects + properties: + StudentContactPersonal: + type: array + items: + $ref: "#/paths/~1StudentContactPersonals/get/responses/20\ + 0/content/application~1json/schema/properties/Stude\ + ntContactPersonals/properties/StudentContactPersona\ + l/items" + example: >- + + + 7C834EA9-EDA1-2090-347F-83297E1C290F + P1234567 + N + + + Hagrid + Fridwulfa + Fridwulfa Hagrid + LGL + + +
+ TH + PHY + + The Enchanted Wood + 533 Hogwart's Way + + Hogsmead + 7733 +
+
+ RU + PHY + + 1175 Lake Ferry Rd + + RD 1 + Martinborough +
+ + + + PRIM + ridwulfa@gmail.com + + + + + MOB + (021) 300 999 + + + + + 1 + 7d5c3f5c-d89c-4551-9442-6b008207986e + +
+ DE + POS + + P O Box 81 + + Martinborough + 5781 +
+ + + + WORK + ridwulfa@gmail.com + + + + + MOB + (021) 300 999 + + + + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentContactPersonals/{StudentContactPersonalRefId}": {} + /StudentContactRelationships: + get: + tags: + - StudentContactRelationship + summary: Default operation to get a list of all available + StudentContactRelationships + description: Search the set of available StudentContactRelationships according to the + search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentContactRelationships: + type: object + description: A List of StudentContactRelationship objects + properties: + StudentContactRelationship: + type: array + items: + required: + - Provider + - Relationship + - Student + - StudentContact + type: object + properties: + StudentContactRelationshipRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentContactRelationshipLocalID: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/StudentContactRelationshipRefId" + LocalId: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/StudentContactRelationshipLocal\ + ID" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + StudentContact: + $ref: "#/paths/~1StudentContactRelationships/get/resp\ + onses/200/content/application~1json/schema/prop\ + erties/StudentContactRelationships/properties/S\ + tudentContactRelationship/items/properties/Stud\ + ent" + Provider: + $ref: "#/paths/~1StudentContactRelationships/get/resp\ + onses/200/content/application~1json/schema/prop\ + erties/StudentContactRelationships/properties/S\ + tudentContactRelationship/items/properties/Stud\ + ent" + Relationship: + description:

Defines the relationship of the contact to + the student.

+ type: object + required: + - Code + properties: + Code: + type: string + title: Relationship To Student + description: >- +

A standardised method of describing the + personal relationship between two persons. + Such a relationship arises from two persons + belonging to the same family or closer + community or as a consequence of sharing + living arrangements.

    +
  • 'FAT' - Father
    • +
  • 'UNC' - Uncle
    • +
  • 'LEG' - Legal Guardian
    • +
  • 'HOS' - Host Family
    • +
  • 'BRO' - Brother
    • +
  • 'FRI' - Family Friend
    • +
  • 'SIS' - Sister
    • +
  • 'OTH' - Other
    • +
  • 'MOT' - Mother
    • +
  • 'GRM' - Grandmother
    • +
  • 'AUN' - Aunt
    • +
  • 'STF' - Stepfather
    • +
plus 4 more value(s) at NZCodeSetsRelationshipToStudentType + oneOf: + - title: Father + enum: + - FAT + - title: Uncle + enum: + - UNC + - title: Legal Guardian + enum: + - LEG + - title: Host Family + enum: + - HOS + - title: Brother + enum: + - BRO + - title: Family Friend + enum: + - FRI + - title: Sister + enum: + - SIS + - title: Other + description: Please Specify + enum: + - OTH + - title: Mother + enum: + - MOT + - title: Grandmother + enum: + - GRM + - title: Aunt + enum: + - AUN + - title: Stepfather + enum: + - STF + - title: Not provided + enum: + - NOT + - title: Grandfather + enum: + - GRF + - title: Stepmother + enum: + - STM + - title: Whāngai Parent + enum: + - WHA + OtherTypeDescription: + type: string + description:

A free text description of relationship + type, where Relationship To Student Type is + set to ‘Other’, eg ‘Au-pair’, + ‘Neighbour’

+ LanguageUsed: + type: string + title: Language + description: >- +

Language refers to recognised human + communication systems, typically oral and/or + written. Sourced from Statistics NZ - Language + Standard Classification 1999 v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not further defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not elsewhere classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not further defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not elsewhere classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not elsewhere classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not further defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not elsewhere classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere classified + enum: + - NZS15199 + - title: Central-Eastern Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not further defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not elsewhere classified + enum: + - NZS16199 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not elsewhere classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western Malayo-Polynesian not further defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western Malayo-Polynesian not elsewhere + classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere classified + enum: + - NZS18399 + - title: Niger-Congo (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not further defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not elsewhere classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not further defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not elsewhere classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not elsewhere classified + enum: + - NZS219 + - title: Language Isolates not elsewhere classified + enum: + - NZS21999 + - title: Miscellaneous Language Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous Languages + enum: + - NZS229 + - title: Other Miscellaneous Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not further defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not elsewhere classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not further defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not elsewhere classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + HouseholdList: + description:

A list of one or more household identifiers + indicating the households associated with this + relationship.

+ type: object + required: + - HouseholdId + properties: + HouseholdId: + type: array + items: + $ref: "#/paths/~1StudentContactRelationships/ge\ + t/responses/200/content/application~1json\ + /schema/properties/StudentContactRelation\ + ships/properties/StudentContactRelationsh\ + ip/items/properties/StudentContactRelatio\ + nshipLocalID" + ContactFlags: + description:

Contains characteristics of the contact + person's role with the Student. At least one of + the flags must be populated with a 'Yes' + value.

+ type: object + properties: + ParentLegalGuardian: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown + and not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PickupRights: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + LivesWith: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + AccessToRecords: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + ReceivesAssessmentReport: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + EmergencyContact: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + CivilDefenceEmergencyContact: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + DisciplinaryContact: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + AttendanceContact: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + PrimaryCareProvider: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + FeesBilling: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + FeesAccess: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + FamilyMail: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + CourtOrder: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + HealthContact: + $ref: "#/paths/~1StudentContactRelationships/get/\ + responses/200/content/application~1json/sch\ + ema/properties/StudentContactRelationships/\ + properties/StudentContactRelationship/items\ + /properties/ContactFlags/properties/ParentL\ + egalGuardian" + ContactSequence: + type: integer + description:

Number indicating the order in which the + student contact should be contacted.

+ description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StudentContactRelationships: + StudentContactRelationship: + - StudentContactRelationshipRefId: 7572B261-0947-583A-463D-BB345291B332 + Student: + RefId: DEE34B35-9D75-101A-8C3D-00AA001A1652 + StudentContact: + RefId: 6472B261-0947-583A-463D-BB345291B001 + Provider: + RefId: 4661c4c8-fd03-4fc6-8af7-5084338494db + Relationship: + Code: LEG + HouseholdList: + HouseholdId: + - FamilyA + - FamilyB + ContactFlags: + ParentLegalGuardian: Y + PickupRights: Y + LivesWith: N + AccessToRecords: U + ReceivesAssessmentReport: Y + EmergencyContact: Y + CivilDefenceEmergencyContact: N + DisciplinaryContact: N + AttendanceContact: N + PrimaryCareProvider: U + FeesBilling: Y + FamilyMail: Y + CourtOrder: N + ContactSequence: 1 + application/xml: + schema: + type: object + properties: + StudentContactRelationships: + type: object + description: A List of StudentContactRelationship objects + properties: + StudentContactRelationship: + type: array + items: + $ref: "#/paths/~1StudentContactRelationships/get/response\ + s/200/content/application~1json/schema/properties/S\ + tudentContactRelationships/properties/StudentContac\ + tRelationship/items" + example: >- + + + 7572B261-0947-583A-463D-BB345291B332 + + DEE34B35-9D75-101A-8C3D-00AA001A1652 + + + 6472B261-0947-583A-463D-BB345291B001 + + + 4661c4c8-fd03-4fc6-8af7-5084338494db + + + LEG + + + FamilyA + FamilyB + + + Y + Y + N + U + Y + Y + N + N + N + U + Y + Y + N + + 1 + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentContactRelationships/{StudentContactRelationshipRefId}": + post: + tags: + - StudentContactRelationship + summary: Default operation to create a single StudentContactRelationship + parameters: + - name: StudentContactRelationshipRefId + in: path + description:

The SIF GUID for the student contact relationship.

+ required: true + schema: + type: string + operationId: createStudentContactRelationship + requestBody: + description: CRUD operation on StudentContactRelationship + content: + application/json: + schema: + type: object + properties: + StudentContactRelationship: + $ref: "#/paths/~1StudentContactRelationships/get/responses/200/co\ + ntent/application~1json/schema/properties/StudentContactRel\ + ationships/properties/StudentContactRelationship/items" + example: + StudentContactRelationship: + StudentContactRelationshipRefId: 7572B261-0947-583A-463D-BB345291B332 + Student: + RefId: DEE34B35-9D75-101A-8C3D-00AA001A1652 + StudentContact: + RefId: 6472B261-0947-583A-463D-BB345291B001 + Provider: + RefId: 4661c4c8-fd03-4fc6-8af7-5084338494db + Relationship: + Code: LEG + HouseholdList: + HouseholdId: + - FamilyA + - FamilyB + ContactFlags: + ParentLegalGuardian: Y + PickupRights: Y + LivesWith: N + AccessToRecords: U + ReceivesAssessmentReport: Y + EmergencyContact: Y + CivilDefenceEmergencyContact: N + DisciplinaryContact: N + AttendanceContact: N + PrimaryCareProvider: U + FeesBilling: Y + FamilyMail: Y + CourtOrder: N + ContactSequence: 1 + application/xml: + schema: + type: object + properties: + StudentContactRelationship: + $ref: "#/paths/~1StudentContactRelationships/get/responses/200/co\ + ntent/application~1json/schema/properties/StudentContactRel\ + ationships/properties/StudentContactRelationship/items" + example: >- + + 7572B261-0947-583A-463D-BB345291B332 + + DEE34B35-9D75-101A-8C3D-00AA001A1652 + + + 6472B261-0947-583A-463D-BB345291B001 + + + 4661c4c8-fd03-4fc6-8af7-5084338494db + + + LEG + + + FamilyA + FamilyB + + + Y + Y + N + U + Y + Y + N + N + N + U + Y + Y + N + + 1 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentContactRelationship + summary: Default operation to update a single StudentContactRelationship + parameters: + - name: StudentContactRelationshipRefId + in: path + description:

The SIF GUID for the student contact relationship.

+ required: true + schema: + type: string + operationId: updateStudentContactRelationship + requestBody: + description: CRUD operation on StudentContactRelationship + content: + application/json: + schema: + type: object + properties: + StudentContactRelationship: + type: object + properties: + StudentContactRelationshipRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentContactRelationshipLocalID: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/StudentContactRelationshipRe\ + fId" + LocalId: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/StudentContactRelationshipLo\ + calID" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + StudentContact: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentConta\ + ctRelationshipRefId%7D/put/requestBody/content/applicat\ + ion~1json/schema/properties/StudentContactRelationship/\ + properties/Student" + Provider: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentConta\ + ctRelationshipRefId%7D/put/requestBody/content/applicat\ + ion~1json/schema/properties/StudentContactRelationship/\ + properties/Student" + Relationship: + description:

Defines the relationship of the contact to the + student.

+ type: object + properties: + Code: + type: string + title: Relationship To Student + description: >- +

A standardised method of describing the personal + relationship between two persons. Such a + relationship arises from two persons belonging to + the same family or closer community or as a + consequence of sharing living arrangements.

    +
  • 'FAT' - Father
    • +
  • 'UNC' - Uncle
    • +
  • 'LEG' - Legal Guardian
    • +
  • 'HOS' - Host Family
    • +
  • 'BRO' - Brother
    • +
  • 'FRI' - Family Friend
    • +
  • 'SIS' - Sister
    • +
  • 'OTH' - Other
    • +
  • 'MOT' - Mother
    • +
  • 'GRM' - Grandmother
    • +
  • 'AUN' - Aunt
    • +
  • 'STF' - Stepfather
    • +
plus 4 more value(s) at NZCodeSetsRelationshipToStudentType + oneOf: + - title: Father + enum: + - FAT + - title: Uncle + enum: + - UNC + - title: Legal Guardian + enum: + - LEG + - title: Host Family + enum: + - HOS + - title: Brother + enum: + - BRO + - title: Family Friend + enum: + - FRI + - title: Sister + enum: + - SIS + - title: Other + description: Please Specify + enum: + - OTH + - title: Mother + enum: + - MOT + - title: Grandmother + enum: + - GRM + - title: Aunt + enum: + - AUN + - title: Stepfather + enum: + - STF + - title: Not provided + enum: + - NOT + - title: Grandfather + enum: + - GRF + - title: Stepmother + enum: + - STM + - title: Whāngai Parent + enum: + - WHA + OtherTypeDescription: + type: string + description:

A free text description of relationship type, + where Relationship To Student Type is set to + ‘Other’, eg ‘Au-pair’, ‘Neighbour’

+ LanguageUsed: + type: string + title: Language + description: >- +

Language refers to recognised human communication + systems, typically oral and/or written. Sourced from + Statistics NZ - Language Standard Classification 1999 + v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not further defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not elsewhere classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not further defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not elsewhere classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not elsewhere classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not further defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not elsewhere classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere classified + enum: + - NZS15199 + - title: Central-Eastern Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not further defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not elsewhere classified + enum: + - NZS16199 + - title: Solomon Islands Languages (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands Languages (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not elsewhere classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western Malayo-Polynesian not further defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western Malayo-Polynesian not elsewhere classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere classified + enum: + - NZS18399 + - title: Niger-Congo (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not further defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not elsewhere classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not further defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not elsewhere classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not elsewhere classified + enum: + - NZS219 + - title: Language Isolates not elsewhere classified + enum: + - NZS21999 + - title: Miscellaneous Language Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous Languages + enum: + - NZS229 + - title: Other Miscellaneous Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not further defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not elsewhere classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not further defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not elsewhere classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + HouseholdList: + description:

A list of one or more household identifiers + indicating the households associated with this + relationship.

+ type: object + properties: + HouseholdId: + type: array + items: + $ref: "#/paths/~1StudentContactRelationships~1%7BStuden\ + tContactRelationshipRefId%7D/put/requestBody/cont\ + ent/application~1json/schema/properties/StudentCo\ + ntactRelationship/properties/StudentContactRelati\ + onshipLocalID" + ContactFlags: + description:

Contains characteristics of the contact person's role + with the Student. At least one of the flags must be + populated with a 'Yes' value.

+ type: object + properties: + ParentLegalGuardian: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PickupRights: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + LivesWith: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + AccessToRecords: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + ReceivesAssessmentReport: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + EmergencyContact: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + CivilDefenceEmergencyContact: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + DisciplinaryContact: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + AttendanceContact: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + PrimaryCareProvider: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + FeesBilling: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + FeesAccess: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + FamilyMail: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + CourtOrder: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + HealthContact: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentC\ + ontactRelationshipRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentContactR\ + elationship/properties/ContactFlags/properties/Pare\ + ntLegalGuardian" + ContactSequence: + type: integer + description:

Number indicating the order in which the student + contact should be contacted.

+ description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StudentContactRelationship: + StudentContactRelationshipRefId: 7572B261-0947-583A-463D-BB345291B332 + Student: + RefId: DEE34B35-9D75-101A-8C3D-00AA001A1652 + StudentContact: + RefId: 6472B261-0947-583A-463D-BB345291B001 + Provider: + RefId: 4661c4c8-fd03-4fc6-8af7-5084338494db + Relationship: + Code: LEG + HouseholdList: + HouseholdId: + - FamilyA + - FamilyB + ContactFlags: + ParentLegalGuardian: Y + PickupRights: Y + LivesWith: N + AccessToRecords: U + ReceivesAssessmentReport: Y + EmergencyContact: Y + CivilDefenceEmergencyContact: N + DisciplinaryContact: N + AttendanceContact: N + PrimaryCareProvider: U + FeesBilling: Y + FamilyMail: Y + CourtOrder: N + ContactSequence: 1 + application/xml: + schema: + type: object + properties: + StudentContactRelationship: + $ref: "#/paths/~1StudentContactRelationships~1%7BStudentContactRe\ + lationshipRefId%7D/put/requestBody/content/application~1jso\ + n/schema/properties/StudentContactRelationship" + example: >- + + 7572B261-0947-583A-463D-BB345291B332 + + DEE34B35-9D75-101A-8C3D-00AA001A1652 + + + 6472B261-0947-583A-463D-BB345291B001 + + + 4661c4c8-fd03-4fc6-8af7-5084338494db + + + LEG + + + FamilyA + FamilyB + + + Y + Y + N + U + Y + Y + N + N + N + U + Y + Y + N + + 1 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentContactRelationship + summary: Default operation to get a single StudentContactRelationship + parameters: + - name: StudentContactRelationshipRefId + in: path + description:

The SIF GUID for the student contact relationship.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentContactRelationship: + $ref: "#/paths/~1StudentContactRelationships/get/responses/200/\ + content/application~1json/schema/properties/StudentContac\ + tRelationships/properties/StudentContactRelationship/item\ + s" + example: + StudentContactRelationship: + StudentContactRelationshipRefId: 7572B261-0947-583A-463D-BB345291B332 + Student: + RefId: DEE34B35-9D75-101A-8C3D-00AA001A1652 + StudentContact: + RefId: 6472B261-0947-583A-463D-BB345291B001 + Provider: + RefId: 4661c4c8-fd03-4fc6-8af7-5084338494db + Relationship: + Code: LEG + HouseholdList: + HouseholdId: + - FamilyA + - FamilyB + ContactFlags: + ParentLegalGuardian: Y + PickupRights: Y + LivesWith: N + AccessToRecords: U + ReceivesAssessmentReport: Y + EmergencyContact: Y + CivilDefenceEmergencyContact: N + DisciplinaryContact: N + AttendanceContact: N + PrimaryCareProvider: U + FeesBilling: Y + FamilyMail: Y + CourtOrder: N + ContactSequence: 1 + application/xml: + schema: + type: object + properties: + StudentContactRelationship: + $ref: "#/paths/~1StudentContactRelationships/get/responses/200/\ + content/application~1json/schema/properties/StudentContac\ + tRelationships/properties/StudentContactRelationship/item\ + s" + example: >- + + 7572B261-0947-583A-463D-BB345291B332 + + DEE34B35-9D75-101A-8C3D-00AA001A1652 + + + 6472B261-0947-583A-463D-BB345291B001 + + + 4661c4c8-fd03-4fc6-8af7-5084338494db + + + LEG + + + FamilyA + FamilyB + + + Y + Y + N + U + Y + Y + N + N + N + U + Y + Y + N + + 1 + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentContactRelationship + summary: Default operation to delete a single StudentContactRelationship + parameters: + - name: StudentContactRelationshipRefId + in: path + description:

The SIF GUID for the student contact relationship.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /Documents: + get: + tags: + - Document + summary: Default operation to get a list of all available Documents + description: Search the set of available Documents, according to the search criteria + in the URL parameters. Returns the first 20 objects located; with SIF + defined navigation headers, indicating how to retrieve subsequent sets + of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + Documents: + type: object + description: A List of Document objects + properties: + Document: + type: array + items: + required: + - DocumentTitle + - Provider + type: object + properties: + DocumentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + DocumentLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1Documents/get/responses/200/cont\ + ent/application~1json/schema/properties/Doc\ + uments/properties/Document/items/properties\ + /DocumentRefId" + LocalId: + $ref: "#/paths/~1Documents/get/responses/200/cont\ + ent/application~1json/schema/properties/Doc\ + uments/properties/Document/items/properties\ + /DocumentLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Location: + type: string + description:

Location of Documentation.

+ DocumentTitle: + type: string + description:

Document's full title.

+ DocumentDescription: + type: string + description:

What the document is and how it is related to + the Student.

+ AddedDateTime: + type: string + format: date + description:

The date the document was added at the source + system.

+ ReviewDate: + type: string + format: date + description:

Document Review Date.

+ URL: + type: string + format: uri + description:

URL if known.

+ NoteText: + type: string + description:

If the type of document is 'Note' then this + is populated with the free text that makes up + the note.

+ RelatedToList: + description:

A list of objects that this document relates + to, e.g. a Wellbeing Response or Characteristic, + Physical Restraint.

+ type: object + required: + - RelatedTo + properties: + RelatedTo: + type: array + items: + $ref: "#/paths/~1Documents/get/responses/200/co\ + ntent/application~1json/schema/properties\ + /Documents/properties/Document/items/prop\ + erties/Provider" + DocumentClassification: + type: string + title: Document Classification + description: >- +

Standard codes denoting the classification of + the Document.

    +
  • 'IC' - In-Confidence
    • +
  • 'SE' - Sensitive
    • +
  • 'NC' - Not Classified
    • +
+ oneOf: + - title: In-Confidence + enum: + - IC + - title: Sensitive + enum: + - SE + - title: Not Classified + enum: + - NC + DocumentType: + type: string + title: Document Type + description: >- +

Standard codes denoting the type of + Document.

    +
  • 'IBP' - Individualised Behavioural Plan
    • +
  • 'IEP' - Individualised Education Plan
    • +
  • 'MED' - Medical
    • +
  • 'ATT' - Attendance
    • +
  • 'BEH' - Behavioural
    • +
  • 'SNE' - Special Needs
    • +
  • 'ACA' - Academic
    • +
  • 'LEG' - Legal
    • +
  • 'OTH' - Other
    • +
  • 'PHO' - Photo
    • +
  • 'MEA' - Media
    • +
  • 'DOC' - Document
    • +
plus 1 more value(s) at NZCodeSetsDocumentTypeType + oneOf: + - title: Individualised Behavioural Plan + enum: + - IBP + - title: Individualised Education Plan + enum: + - IEP + - title: Medical + enum: + - MED + - title: Attendance + enum: + - ATT + - title: Behavioural + enum: + - BEH + - title: Special Needs + enum: + - SNE + - title: Academic + enum: + - ACA + - title: Legal + enum: + - LEG + - title: Other + enum: + - OTH + - title: Photo + enum: + - PHO + - title: Media + enum: + - MEA + - title: Document + enum: + - DOC + - title: Note + enum: + - NOT + PersonDocumentRoleList: + description:

The list of people associated to a document + and their role in relation to it, e.g. author, + owner, reviewer, subject of.

+ type: object + required: + - PersonDocumentRole + properties: + PersonDocumentRole: + type: array + items: + description:

A person associated to a document and + their role in relation to it, e.g. author, + owner, reviewer, subject of.

+ type: object + required: + - ObjectType + properties: + Role: + type: string + title: Document Role + description: >- +

A code set denoting the role a + person performs in relation to a + document and their role in relation to + it, e.g. author, owner, reviewer, + subject of.

    +
  • 'OW' - Owner
    • +
  • 'AU' - Author
    • +
  • 'RE' - Reviewer
    • +
  • 'SU' - Subject Of
    • +
  • 'AD' - Added By
    • +
+ oneOf: + - title: Owner + enum: + - OW + - title: Author + enum: + - AU + - title: Reviewer + enum: + - RE + - title: Subject Of + enum: + - SU + - title: Added By + enum: + - AD + description:

Location and meta-data of a document, including + evidentiary documents, personalised plans, and + action plans.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2101 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + Documents: + Document: + - DocumentRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + DocumentDescription: Timmy McGannaway's IEP for 2019 + URL: http://somehost.co.nz/docs/ghf12312 + DocumentType: IEP + PersonDocumentRoleList: + PersonDocumentRole: + - RefId: 17c9b7aa-bc34-435f-8bba-7e337891f53b + ObjectType: StudentPersonal + Role: SU + - RefId: 2a288f40-c3fb-4d9c-857e-0e562f3f5dde + ObjectType: StaffPersonal + Role: AU + application/xml: + schema: + type: object + properties: + Documents: + type: object + description: A List of Document objects + properties: + Document: + type: array + items: + $ref: "#/paths/~1Documents/get/responses/200/content/appl\ + ication~1json/schema/properties/Documents/propertie\ + s/Document/items" + example: >- + + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + Timmy McGannaway's IEP for 2019 + http://somehost.co.nz/docs/ghf12312 + IEP + + + 17c9b7aa-bc34-435f-8bba-7e337891f53b + StudentPersonal + SU + + + 2a288f40-c3fb-4d9c-857e-0e562f3f5dde + StaffPersonal + AU + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/Documents/{DocumentRefId}": + post: + tags: + - Document + summary: Default operation to create a single Document + parameters: + - name: DocumentRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Document.

+ required: true + schema: + type: string + operationId: createDocument + requestBody: + description: CRUD operation on Document + content: + application/json: + schema: + type: object + properties: + Document: + $ref: "#/paths/~1Documents/get/responses/200/content/application~\ + 1json/schema/properties/Documents/properties/Document/items" + example: + Document: + DocumentRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + DocumentDescription: Timmy McGannaway's IEP for 2019 + URL: http://somehost.co.nz/docs/ghf12312 + DocumentType: IEP + PersonDocumentRoleList: + PersonDocumentRole: + - RefId: 17c9b7aa-bc34-435f-8bba-7e337891f53b + ObjectType: StudentPersonal + Role: SU + - RefId: 2a288f40-c3fb-4d9c-857e-0e562f3f5dde + ObjectType: StaffPersonal + Role: AU + application/xml: + schema: + type: object + properties: + Document: + $ref: "#/paths/~1Documents/get/responses/200/content/application~\ + 1json/schema/properties/Documents/properties/Document/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + Timmy McGannaway's IEP for 2019 + http://somehost.co.nz/docs/ghf12312 + IEP + + + 17c9b7aa-bc34-435f-8bba-7e337891f53b + StudentPersonal + SU + + + 2a288f40-c3fb-4d9c-857e-0e562f3f5dde + StaffPersonal + AU + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - Document + summary: Default operation to update a single Document + parameters: + - name: DocumentRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Document.

+ required: true + schema: + type: string + operationId: updateDocument + requestBody: + description: CRUD operation on Document + content: + application/json: + schema: + type: object + properties: + Document: + type: object + properties: + DocumentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + DocumentLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1Documents~1%7BDocumentRefId%7D/put/reque\ + stBody/content/application~1json/schema/properties/\ + Document/properties/DocumentRefId" + LocalId: + $ref: "#/paths/~1Documents~1%7BDocumentRefId%7D/put/reque\ + stBody/content/application~1json/schema/properties/\ + Document/properties/DocumentLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Location: + type: string + description:

Location of Documentation.

+ DocumentTitle: + type: string + description:

Document's full title.

+ DocumentDescription: + type: string + description:

What the document is and how it is related to the + Student.

+ AddedDateTime: + type: string + format: date + description:

The date the document was added at the source + system.

+ ReviewDate: + type: string + format: date + description:

Document Review Date.

+ URL: + type: string + format: uri + description:

URL if known.

+ NoteText: + type: string + description:

If the type of document is 'Note' then this is + populated with the free text that makes up the note.

+ RelatedToList: + description:

A list of objects that this document relates to, e.g. + a Wellbeing Response or Characteristic, Physical + Restraint.

+ type: object + properties: + RelatedTo: + type: array + items: + $ref: "#/paths/~1Documents~1%7BDocumentRefId%7D/put/req\ + uestBody/content/application~1json/schema/propert\ + ies/Document/properties/Provider" + DocumentClassification: + type: string + title: Document Classification + description: >- +

Standard codes denoting the classification of the + Document.

    +
  • 'IC' - In-Confidence
    • +
  • 'SE' - Sensitive
    • +
  • 'NC' - Not Classified
    • +
+ oneOf: + - title: In-Confidence + enum: + - IC + - title: Sensitive + enum: + - SE + - title: Not Classified + enum: + - NC + DocumentType: + type: string + title: Document Type + description: >- +

Standard codes denoting the type of Document.

+
    +
  • 'IBP' - Individualised Behavioural Plan
    • +
  • 'IEP' - Individualised Education Plan
    • +
  • 'MED' - Medical
    • +
  • 'ATT' - Attendance
    • +
  • 'BEH' - Behavioural
    • +
  • 'SNE' - Special Needs
    • +
  • 'ACA' - Academic
    • +
  • 'LEG' - Legal
    • +
  • 'OTH' - Other
    • +
  • 'PHO' - Photo
    • +
  • 'MEA' - Media
    • +
  • 'DOC' - Document
    • +
plus 1 more value(s) at NZCodeSetsDocumentTypeType + oneOf: + - title: Individualised Behavioural Plan + enum: + - IBP + - title: Individualised Education Plan + enum: + - IEP + - title: Medical + enum: + - MED + - title: Attendance + enum: + - ATT + - title: Behavioural + enum: + - BEH + - title: Special Needs + enum: + - SNE + - title: Academic + enum: + - ACA + - title: Legal + enum: + - LEG + - title: Other + enum: + - OTH + - title: Photo + enum: + - PHO + - title: Media + enum: + - MEA + - title: Document + enum: + - DOC + - title: Note + enum: + - NOT + PersonDocumentRoleList: + description:

The list of people associated to a document and their + role in relation to it, e.g. author, owner, reviewer, + subject of.

+ type: object + properties: + PersonDocumentRole: + type: array + items: + description:

A person associated to a document and their + role in relation to it, e.g. author, owner, + reviewer, subject of.

+ type: object + properties: + Role: + type: string + title: Document Role + description: >- +

A code set denoting the role a person + performs in relation to a document and their + role in relation to it, e.g. author, owner, + reviewer, subject of.

    +
  • 'OW' - Owner
    • +
  • 'AU' - Author
    • +
  • 'RE' - Reviewer
    • +
  • 'SU' - Subject Of
    • +
  • 'AD' - Added By
    • +
+ oneOf: + - title: Owner + enum: + - OW + - title: Author + enum: + - AU + - title: Reviewer + enum: + - RE + - title: Subject Of + enum: + - SU + - title: Added By + enum: + - AD + description:

Location and meta-data of a document, including + evidentiary documents, personalised plans, and action + plans.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2101 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + Document: + DocumentRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + DocumentDescription: Timmy McGannaway's IEP for 2019 + URL: http://somehost.co.nz/docs/ghf12312 + DocumentType: IEP + PersonDocumentRoleList: + PersonDocumentRole: + - RefId: 17c9b7aa-bc34-435f-8bba-7e337891f53b + ObjectType: StudentPersonal + Role: SU + - RefId: 2a288f40-c3fb-4d9c-857e-0e562f3f5dde + ObjectType: StaffPersonal + Role: AU + application/xml: + schema: + type: object + properties: + Document: + $ref: "#/paths/~1Documents~1%7BDocumentRefId%7D/put/requestBody/c\ + ontent/application~1json/schema/properties/Document" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + Timmy McGannaway's IEP for 2019 + http://somehost.co.nz/docs/ghf12312 + IEP + + + 17c9b7aa-bc34-435f-8bba-7e337891f53b + StudentPersonal + SU + + + 2a288f40-c3fb-4d9c-857e-0e562f3f5dde + StaffPersonal + AU + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - Document + summary: Default operation to get a single Document + parameters: + - name: DocumentRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Document.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + Document: + $ref: "#/paths/~1Documents/get/responses/200/content/applicatio\ + n~1json/schema/properties/Documents/properties/Document/i\ + tems" + example: + Document: + DocumentRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + DocumentDescription: Timmy McGannaway's IEP for 2019 + URL: http://somehost.co.nz/docs/ghf12312 + DocumentType: IEP + PersonDocumentRoleList: + PersonDocumentRole: + - RefId: 17c9b7aa-bc34-435f-8bba-7e337891f53b + ObjectType: StudentPersonal + Role: SU + - RefId: 2a288f40-c3fb-4d9c-857e-0e562f3f5dde + ObjectType: StaffPersonal + Role: AU + application/xml: + schema: + type: object + properties: + Document: + $ref: "#/paths/~1Documents/get/responses/200/content/applicatio\ + n~1json/schema/properties/Documents/properties/Document/i\ + tems" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + Timmy McGannaway's IEP for 2019 + http://somehost.co.nz/docs/ghf12312 + IEP + + + 17c9b7aa-bc34-435f-8bba-7e337891f53b + StudentPersonal + SU + + + 2a288f40-c3fb-4d9c-857e-0e562f3f5dde + StaffPersonal + AU + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - Document + summary: Default operation to delete a single Document + parameters: + - name: DocumentRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Document.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentConsents: + get: + tags: + - StudentConsent + summary: Default operation to get a list of all available StudentConsents + description: Search the set of available StudentConsents, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentConsents: + type: object + description: A List of StudentConsent objects + properties: + StudentConsent: + type: array + items: + required: + - ConsentDate + - ConsentGiven + - ConsentTo + - Organisation + - Student + type: object + properties: + StudentConsentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentConsentLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentConsents/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/StudentConsents/properties/StudentConsen\ + t/items/properties/StudentConsentRefId" + LocalId: + $ref: "#/paths/~1StudentConsents/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/StudentConsents/properties/StudentConsen\ + t/items/properties/StudentConsentLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Organisation: + $ref: "#/paths/~1StudentConsents/get/responses/200/co\ + ntent/application~1json/schema/properties/Stude\ + ntConsents/properties/StudentConsent/items/prop\ + erties/Student" + StaffMember: + $ref: "#/paths/~1StudentConsents/get/responses/200/co\ + ntent/application~1json/schema/properties/Stude\ + ntConsents/properties/StudentConsent/items/prop\ + erties/Student" + ConsentTo: + type: string + title: Student Consent To + description: >- +

Code set denoting what the student is + consenting or not consenting to.

    +
  • 'PHT' - Share Photos
    • +
  • 'ART' - Share Art
    • +
  • 'WRI' - Share Writing
    • +
  • 'MED' - Medical Treatment
    • +
  • 'ADM' - Panadol
    • +
  • 'LSC' - Learning Support Community Register
    • +
  • 'LSP' - Learning Support Publish to Community Register
    • +
+ oneOf: + - title: Share Photos + description: To use and share photographs of the student + enum: + - PHT + - title: Share Art + enum: + - ART + - title: Share Writing + enum: + - WRI + - title: Medical Treatment + description: Seek medical treatment in an emergency when + the caregiver cannot be contacted + enum: + - MED + - title: Panadol + description: Administer Panadol + enum: + - ADM + - title: Learning Support Community Register + description: To be on the Learning Support Register + enum: + - LSC + - title: Learning Support Publish to Community + Register + description: To have content on the Learning Support + Community Register published to any school + groups the school is part of for analysis + e.g. a Kāhui Ako + enum: + - LSP + ConsentGiven: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + ConsentDate: + type: string + format: date + description:

The date the consent or no consent was + given.

+ ConsentRevokedDate: + type: string + format: date + description:

The date the consent ended, if it was + given.

+ RelatedObject: + $ref: "#/paths/~1StudentConsents/get/responses/200/co\ + ntent/application~1json/schema/properties/Stude\ + ntConsents/properties/StudentConsent/items/prop\ + erties/Student" + AdditionalInformation: + type: string + description:

Additional free text information provided + about the consent.

+ description: A record of Student's consent or non-consent to some + action taking place. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StudentConsents: + StudentConsent: + - StudentConsentRefId: 7C834EA9-EDA1-2090-347F-83297E1C290C + StudentConsentLocalId: S1234567 + application/xml: + schema: + type: object + properties: + StudentConsents: + type: object + description: A List of StudentConsent objects + properties: + StudentConsent: + type: array + items: + $ref: "#/paths/~1StudentConsents/get/responses/200/conten\ + t/application~1json/schema/properties/StudentConsen\ + ts/properties/StudentConsent/items" + example: >- + + + 7C834EA9-EDA1-2090-347F-83297E1C290C + S1234567 + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentConsents/{StudentConsentRefId}": + post: + tags: + - StudentConsent + summary: Default operation to create a single StudentConsent + parameters: + - name: StudentConsentRefId + in: path + description:

The GUID of the student consent.

+ required: true + schema: + type: string + operationId: createStudentConsent + requestBody: + description: CRUD operation on StudentConsent + content: + application/json: + schema: + type: object + properties: + StudentConsent: + $ref: "#/paths/~1StudentConsents/get/responses/200/content/applic\ + ation~1json/schema/properties/StudentConsents/properties/St\ + udentConsent/items" + example: + StudentConsent: + StudentConsentRefId: 7C834EA9-EDA1-2090-347F-83297E1C290C + StudentConsentLocalId: S1234567 + application/xml: + schema: + type: object + properties: + StudentConsent: + $ref: "#/paths/~1StudentConsents/get/responses/200/content/applic\ + ation~1json/schema/properties/StudentConsents/properties/St\ + udentConsent/items" + example: >- + + 7C834EA9-EDA1-2090-347F-83297E1C290C + S1234567 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentConsent + summary: Default operation to update a single StudentConsent + parameters: + - name: StudentConsentRefId + in: path + description:

The GUID of the student consent.

+ required: true + schema: + type: string + operationId: updateStudentConsent + requestBody: + description: CRUD operation on StudentConsent + content: + application/json: + schema: + type: object + properties: + StudentConsent: + type: object + properties: + StudentConsentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentConsentLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentConsents~1%7BStudentConsentRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/StudentConsent/properties/StudentConsen\ + tRefId" + LocalId: + $ref: "#/paths/~1StudentConsents~1%7BStudentConsentRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/StudentConsent/properties/StudentConsen\ + tLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Organisation: + $ref: "#/paths/~1StudentConsents~1%7BStudentConsentRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/StudentConsent/properties/Student" + StaffMember: + $ref: "#/paths/~1StudentConsents~1%7BStudentConsentRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/StudentConsent/properties/Student" + ConsentTo: + type: string + title: Student Consent To + description: >- +

Code set denoting what the student is consenting or + not consenting to.

    +
  • 'PHT' - Share Photos
    • +
  • 'ART' - Share Art
    • +
  • 'WRI' - Share Writing
    • +
  • 'MED' - Medical Treatment
    • +
  • 'ADM' - Panadol
    • +
  • 'LSC' - Learning Support Community Register
    • +
  • 'LSP' - Learning Support Publish to Community Register
    • +
+ oneOf: + - title: Share Photos + description: To use and share photographs of the student + enum: + - PHT + - title: Share Art + enum: + - ART + - title: Share Writing + enum: + - WRI + - title: Medical Treatment + description: Seek medical treatment in an emergency when the + caregiver cannot be contacted + enum: + - MED + - title: Panadol + description: Administer Panadol + enum: + - ADM + - title: Learning Support Community Register + description: To be on the Learning Support Register + enum: + - LSC + - title: Learning Support Publish to Community Register + description: To have content on the Learning Support Community + Register published to any school groups the school + is part of for analysis e.g. a Kāhui Ako + enum: + - LSP + ConsentGiven: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + ConsentDate: + type: string + format: date + description:

The date the consent or no consent was given.

+ ConsentRevokedDate: + type: string + format: date + description:

The date the consent ended, if it was given.

+ RelatedObject: + $ref: "#/paths/~1StudentConsents~1%7BStudentConsentRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/StudentConsent/properties/Student" + AdditionalInformation: + type: string + description:

Additional free text information provided about the + consent.

+ description: A record of Student's consent or non-consent to some action + taking place. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StudentConsent: + StudentConsentRefId: 7C834EA9-EDA1-2090-347F-83297E1C290C + StudentConsentLocalId: S1234567 + application/xml: + schema: + type: object + properties: + StudentConsent: + $ref: "#/paths/~1StudentConsents~1%7BStudentConsentRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/Stud\ + entConsent" + example: >- + + 7C834EA9-EDA1-2090-347F-83297E1C290C + S1234567 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentConsent + summary: Default operation to get a single StudentConsent + parameters: + - name: StudentConsentRefId + in: path + description:

The GUID of the student consent.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentConsent: + $ref: "#/paths/~1StudentConsents/get/responses/200/content/appl\ + ication~1json/schema/properties/StudentConsents/propertie\ + s/StudentConsent/items" + example: + StudentConsent: + StudentConsentRefId: 7C834EA9-EDA1-2090-347F-83297E1C290C + StudentConsentLocalId: S1234567 + application/xml: + schema: + type: object + properties: + StudentConsent: + $ref: "#/paths/~1StudentConsents/get/responses/200/content/appl\ + ication~1json/schema/properties/StudentConsents/propertie\ + s/StudentConsent/items" + example: >- + + 7C834EA9-EDA1-2090-347F-83297E1C290C + S1234567 + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentConsent + summary: Default operation to delete a single StudentConsent + parameters: + - name: StudentConsentRefId + in: path + description:

The GUID of the student consent.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /TeachingGroups: + get: + tags: + - TeachingGroup + summary: Default operation to get a list of all available TeachingGroups + description: Search the set of available TeachingGroups, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + TeachingGroups: + type: object + description: A List of TeachingGroup objects + properties: + TeachingGroup: + type: array + items: + required: + - Provider + - SchoolYear + - ShortName + type: object + properties: + TeachingGroupRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + TeachingGroupLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + ShortName: + type: string + description:

Short free format label that describes the + group.

+ LongName: + type: string + description:

Longer description if required.

+ GroupType: + type: string + title: Teaching Group Type + description: >- +

Provides the means of identifying the type of + group such as Roll class, Subject class or + Homeroom and allows systems to treat them + accordingly

    +
  • 'RC' - Roll Class
    • +
  • 'SC' - Subject Class
    • +
  • 'HR' - Home Room
    • +
+ oneOf: + - title: Roll Class + description: The TeachingGroup is a class only used for + taking daily attendance. + enum: + - RC + - title: Subject Class + description: The TeachingGroup is a class only used for + teaching. + enum: + - SC + - title: Home Room + description: The TeachingGroup is a class used for both + teaching and roll taking. + enum: + - HR + Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1TeachingGroups/get/responses/200\ + /content/application~1json/schema/propertie\ + s/TeachingGroups/properties/TeachingGroup/i\ + tems/properties/TeachingGroupRefId" + LocalId: + $ref: "#/paths/~1TeachingGroups/get/responses/200\ + /content/application~1json/schema/propertie\ + s/TeachingGroups/properties/TeachingGroup/i\ + tems/properties/TeachingGroupLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + TeachingProvider: + $ref: "#/paths/~1TeachingGroups/get/responses/200/con\ + tent/application~1json/schema/properties/Teachi\ + ngGroups/properties/TeachingGroup/items/propert\ + ies/Provider" + SchoolYear: + description:

The SchoolYear that the class represented by + the TeachingGroup is being taught.

+ BeginDate: + type: string + format: date + description:

The start date of the first Timetable that + the class represented by the TeachingGroup is + being taught in the nominated school year.

+ EndDate: + type: string + format: date + description:

The end date of the last Timetable that the + class represented by the TeachingGroup is being + taught in the nominated school year.

+ StudentList: + description:

List of Students in this Teaching Group

+ type: object + required: + - Student + properties: + Student: + type: array + items: + $ref: "#/paths/~1TeachingGroups/get/responses/2\ + 00/content/application~1json/schema/prope\ + rties/TeachingGroups/properties/TeachingG\ + roup/items/properties/Provider" + TeacherList: + description:

A List of staff associated with the group – + may or may not include the teacher timetabled in + the schedule.

+ type: object + required: + - StaffMember + properties: + StaffMember: + type: array + items: + description:

The individual staff member as a member + of the StaffList and their role.

+ type: object + required: + - ObjectType + - Role + properties: + Role: + type: string + title: Staff Role + description: >- +

Describes the role a staff member + has at a Provider or other + EducationOrganisation.

    +
  • '1001' - Principal
    • +
  • '1002' - Deputy Principal
    • +
  • '1003' - Associate Principal
    • +
  • '1004' - Assistant Principal
    • +
  • '1005' - Principal's Nominee (NZQA)
    • +
  • '1006' - Enrolment Officer
    • +
  • '1007' - Timetabler
    • +
  • '1008' - Relief Coordinator
    • +
  • '1009' - Office Manager
    • +
  • '1010' - Office Assistant
    • +
  • '1012' - Finance Assistant
    • +
  • '1013' - IT Manager
    • +
plus 51 more value(s) at NZCodeSetsStaffRoleType + oneOf: + - title: Principal + enum: + - "1001" + - title: Deputy Principal + enum: + - "1002" + - title: Associate Principal + enum: + - "1003" + - title: Assistant Principal + enum: + - "1004" + - title: Principal's Nominee (NZQA) + enum: + - "1005" + - title: Enrolment Officer + enum: + - "1006" + - title: Timetabler + enum: + - "1007" + - title: Relief Coordinator + enum: + - "1008" + - title: Office Manager + enum: + - "1009" + - title: Office Assistant + enum: + - "1010" + - title: Finance Assistant + enum: + - "1012" + - title: IT Manager + enum: + - "1013" + - title: IT Assistant + enum: + - "1014" + - title: Head Librarian + enum: + - "1015" + - title: Assistant Librarian + enum: + - "1016" + - title: Board of Trustees Member (Staff) + enum: + - "1017" + - title: Board of Trustees Member (Parent) + enum: + - "1018" + - title: Head of Department + enum: + - "1101" + - title: Assistant Head of Department + enum: + - "1102" + - title: Technician + enum: + - "1103" + - title: Subject Teacher + enum: + - "1201" + - title: STP Coordinator + enum: + - "1302" + - title: Learning Support Coordinator + enum: + - "1303" + - title: Learning Support Staff + enum: + - "1304" + - title: SAC Coordinator + enum: + - "1305" + - title: Special Needs Coordinator (SENCO) + enum: + - "1306" + - title: Distance Education Coordinator + enum: + - "1307" + - title: Resource Teacher Literacy (RTLit) + enum: + - "1308" + - title: Resource Teacher Learning and + Behaviour (RTLB) + enum: + - "1309" + - title: Parent Help + enum: + - "1310" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homerrom Teacher + enum: + - "1403" + - title: Pastoral Carer + enum: + - "1404" + - title: Guidance Counsellor + enum: + - "1405" + - title: Careers Advisor + enum: + - "1406" + - title: Truancy Officer + enum: + - "1407" + - title: Sickbay Nurse + enum: + - "1408" + - title: Dental Nurse + enum: + - "1409" + - title: Hostel Manager / Matron + enum: + - "1410" + - title: Social Worker (In School) + enum: + - "1411" + - title: Teacher in Charge + enum: + - "1501" + - title: Coach + enum: + - "1502" + - title: Kāhui Ako Led Principal + enum: + - "2001" + - title: Across School Teacher + enum: + - " 2002" + - title: Kāhui Ako Support Facilitator + enum: + - "2101" + - title: Kāhui Ako Expert Partner + enum: + - "2102" + - title: Ministry - Learning Support + Facilitator + enum: + - "2103" + - title: Ministry - Strategic Advisor - + Māori + enum: + - "2104" + - title: Ministry - SAF + enum: + - "2105" + - title: DHB Staff + enum: + - "2106" + - title: Teacher Aide + enum: + - "1301" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Kāhui Ako within School Teacher + enum: + - "1208" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Finance Manager + enum: + - "1011" + CourseList: + description:

List of generic references denoting the + Courses the TeachingGroup is being taught.

+ type: object + required: + - Course + properties: + Course: + type: array + items: + $ref: "#/paths/~1TeachingGroups/get/responses/2\ + 00/content/application~1json/schema/prope\ + rties/TeachingGroups/properties/TeachingG\ + roup/items/properties/Provider" + SubjectAreaList: + description:

List of codes denoting the Learning or + Subject Areas of the Course the TeachingGroup is + being taught.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZ Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication + Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural + Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication + (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + YearLevelList: + description: "

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.

" + type: object + required: + - YearLevel + properties: + YearLevel: + type: array + items: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are + valid for describing Funding Year Level + and Current Year Level for a student + enrolment.

Current Year Level + indicates the year level of the student’s + class cohort and the level at which the + student spends most of their time at + school. While a student may be enrolled in + subjects at varying instructional year + levels, in relation to the student + enrolment this value represents the year + level at which the student is considered + to be predominantly taught.

Funding + Year Level measures the actual number of + years that the student has attended a + school. It provides the Ministry with a + method of counting students for funding + purposes which is independent of the way + schools are organised or the particular + programme of study that a student may + undertake. Funding Year Level for most + students is based on the date they first + started school.

School Year Level + is used to indicate the instructional year + levels offered by a school, i.e. those + years for which student enrolments may be + accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code + indicates Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + TeachingGroups: + TeachingGroup: + - TeachingGroupRefId: 64A309DA-063A-2E35-B359-D75101A8C3D1 + TeachingGroupLocalId: 20087ASPN + ShortName: 7A SPN + LongName: Year 7A Maths - Space and Numbers + GroupType: SC + Provider: + RefId: 64A309DA-063A-2E35-B359-FACEA8C12312 + LocalId: 234 + SchoolYear: 2018 + BeginDate: 2018-02-04 + EndDate: 2018-12-05 + 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" + application/xml: + schema: + type: object + properties: + TeachingGroups: + type: object + description: A List of TeachingGroup objects + properties: + TeachingGroup: + type: array + items: + $ref: "#/paths/~1TeachingGroups/get/responses/200/content\ + /application~1json/schema/properties/TeachingGroups\ + /properties/TeachingGroup/items" + example: >- + + + 64A309DA-063A-2E35-B359-D75101A8C3D1 + 20087ASPN + 7A SPN + Year 7A Maths - Space and Numbers + SC + + 64A309DA-063A-2E35-B359-FACEA8C12312 + 234 + + 2018 + 2018-02-04 + 2018-12-05 + + + 9897466F-200E-4BC1-B9AE-D1507DA15CEF + SMI001 + Peter Smith + + + 7C834EA9-EDA1-2090-347F-83297E1C290D + SMI002 + Jennifer Smith + + + 7C834EA9-EDA1-2090-347F-83297E1C290E + SMI003 + Terence Smith + + + + + A8C3A2E3-5B35-9D75-101D-00AA001A0000 + SMI1 + Thomas Smith + 1001 + + + A8CCCCE3-5B35-9D75-101D-00AA001A0000 + LONG2 + Tamara Long + 1002 + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/TeachingGroups/{TeachingGroupRefId}": + post: + tags: + - TeachingGroup + summary: Default operation to create a single TeachingGroup + parameters: + - name: TeachingGroupRefId + in: path + description:

The GUID of the TeachingGroup

+ required: true + schema: + type: string + operationId: createTeachingGroup + requestBody: + description: CRUD operation on TeachingGroup + content: + application/json: + schema: + type: object + properties: + TeachingGroup: + $ref: "#/paths/~1TeachingGroups/get/responses/200/content/applica\ + tion~1json/schema/properties/TeachingGroups/properties/Teac\ + hingGroup/items" + example: + TeachingGroup: + TeachingGroupRefId: 64A309DA-063A-2E35-B359-D75101A8C3D1 + TeachingGroupLocalId: 20087ASPN + ShortName: 7A SPN + LongName: Year 7A Maths - Space and Numbers + GroupType: SC + Provider: + RefId: 64A309DA-063A-2E35-B359-FACEA8C12312 + LocalId: 234 + SchoolYear: 2018 + BeginDate: 2018-02-04 + EndDate: 2018-12-05 + 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" + application/xml: + schema: + type: object + properties: + TeachingGroup: + $ref: "#/paths/~1TeachingGroups/get/responses/200/content/applica\ + tion~1json/schema/properties/TeachingGroups/properties/Teac\ + hingGroup/items" + example: >- + + 64A309DA-063A-2E35-B359-D75101A8C3D1 + 20087ASPN + 7A SPN + Year 7A Maths - Space and Numbers + SC + + 64A309DA-063A-2E35-B359-FACEA8C12312 + 234 + + 2018 + 2018-02-04 + 2018-12-05 + + + 9897466F-200E-4BC1-B9AE-D1507DA15CEF + SMI001 + Peter Smith + + + 7C834EA9-EDA1-2090-347F-83297E1C290D + SMI002 + Jennifer Smith + + + 7C834EA9-EDA1-2090-347F-83297E1C290E + SMI003 + Terence Smith + + + + + A8C3A2E3-5B35-9D75-101D-00AA001A0000 + SMI1 + Thomas Smith + 1001 + + + A8CCCCE3-5B35-9D75-101D-00AA001A0000 + LONG2 + Tamara Long + 1002 + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - TeachingGroup + summary: Default operation to update a single TeachingGroup + parameters: + - name: TeachingGroupRefId + in: path + description:

The GUID of the TeachingGroup

+ required: true + schema: + type: string + operationId: updateTeachingGroup + requestBody: + description: CRUD operation on TeachingGroup + content: + application/json: + schema: + type: object + properties: + TeachingGroup: + type: object + properties: + TeachingGroupRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + TeachingGroupLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + ShortName: + type: string + description:

Short free format label that describes the group.

+ LongName: + type: string + description:

Longer description if required.

+ GroupType: + type: string + title: Teaching Group Type + description: >- +

Provides the means of identifying the type of group + such as Roll class, Subject class or Homeroom and allows + systems to treat them accordingly

    +
  • 'RC' - Roll Class
    • +
  • 'SC' - Subject Class
    • +
  • 'HR' - Home Room
    • +
+ oneOf: + - title: Roll Class + description: The TeachingGroup is a class only used for taking + daily attendance. + enum: + - RC + - title: Subject Class + description: The TeachingGroup is a class only used for teaching. + enum: + - SC + - title: Home Room + description: The TeachingGroup is a class used for both teaching + and roll taking. + enum: + - HR + Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1TeachingGroups~1%7BTeachingGroupRefId%7D\ + /put/requestBody/content/application~1json/schema/p\ + roperties/TeachingGroup/properties/TeachingGroupRef\ + Id" + LocalId: + $ref: "#/paths/~1TeachingGroups~1%7BTeachingGroupRefId%7D\ + /put/requestBody/content/application~1json/schema/p\ + roperties/TeachingGroup/properties/TeachingGroupLoc\ + alId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + TeachingProvider: + $ref: "#/paths/~1TeachingGroups~1%7BTeachingGroupRefId%7D/put\ + /requestBody/content/application~1json/schema/propertie\ + s/TeachingGroup/properties/Provider" + SchoolYear: + description:

The SchoolYear that the class represented by the + TeachingGroup is being taught.

+ BeginDate: + type: string + format: date + description:

The start date of the first Timetable that the class + represented by the TeachingGroup is being taught in the + nominated school year.

+ EndDate: + type: string + format: date + description:

The end date of the last Timetable that the class + represented by the TeachingGroup is being taught in the + nominated school year.

+ StudentList: + description:

List of Students in this Teaching Group

+ type: object + properties: + Student: + type: array + items: + $ref: "#/paths/~1TeachingGroups~1%7BTeachingGroupRefId%\ + 7D/put/requestBody/content/application~1json/sche\ + ma/properties/TeachingGroup/properties/Provider" + TeacherList: + description:

A List of staff associated with the group – may or + may not include the teacher timetabled in the + schedule.

+ type: object + properties: + StaffMember: + type: array + items: + description:

The individual staff member as a member of the + StaffList and their role.

+ type: object + properties: + Role: + type: string + title: Staff Role + description: >- +

Describes the role a staff member has at a + Provider or other EducationOrganisation.

+
    +
  • '1001' - Principal
    • +
  • '1002' - Deputy Principal
    • +
  • '1003' - Associate Principal
    • +
  • '1004' - Assistant Principal
    • +
  • '1005' - Principal's Nominee (NZQA)
    • +
  • '1006' - Enrolment Officer
    • +
  • '1007' - Timetabler
    • +
  • '1008' - Relief Coordinator
    • +
  • '1009' - Office Manager
    • +
  • '1010' - Office Assistant
    • +
  • '1012' - Finance Assistant
    • +
  • '1013' - IT Manager
    • +
plus 51 more value(s) at NZCodeSetsStaffRoleType + oneOf: + - title: Principal + enum: + - "1001" + - title: Deputy Principal + enum: + - "1002" + - title: Associate Principal + enum: + - "1003" + - title: Assistant Principal + enum: + - "1004" + - title: Principal's Nominee (NZQA) + enum: + - "1005" + - title: Enrolment Officer + enum: + - "1006" + - title: Timetabler + enum: + - "1007" + - title: Relief Coordinator + enum: + - "1008" + - title: Office Manager + enum: + - "1009" + - title: Office Assistant + enum: + - "1010" + - title: Finance Assistant + enum: + - "1012" + - title: IT Manager + enum: + - "1013" + - title: IT Assistant + enum: + - "1014" + - title: Head Librarian + enum: + - "1015" + - title: Assistant Librarian + enum: + - "1016" + - title: Board of Trustees Member (Staff) + enum: + - "1017" + - title: Board of Trustees Member (Parent) + enum: + - "1018" + - title: Head of Department + enum: + - "1101" + - title: Assistant Head of Department + enum: + - "1102" + - title: Technician + enum: + - "1103" + - title: Subject Teacher + enum: + - "1201" + - title: STP Coordinator + enum: + - "1302" + - title: Learning Support Coordinator + enum: + - "1303" + - title: Learning Support Staff + enum: + - "1304" + - title: SAC Coordinator + enum: + - "1305" + - title: Special Needs Coordinator (SENCO) + enum: + - "1306" + - title: Distance Education Coordinator + enum: + - "1307" + - title: Resource Teacher Literacy (RTLit) + enum: + - "1308" + - title: Resource Teacher Learning and Behaviour + (RTLB) + enum: + - "1309" + - title: Parent Help + enum: + - "1310" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homerrom Teacher + enum: + - "1403" + - title: Pastoral Carer + enum: + - "1404" + - title: Guidance Counsellor + enum: + - "1405" + - title: Careers Advisor + enum: + - "1406" + - title: Truancy Officer + enum: + - "1407" + - title: Sickbay Nurse + enum: + - "1408" + - title: Dental Nurse + enum: + - "1409" + - title: Hostel Manager / Matron + enum: + - "1410" + - title: Social Worker (In School) + enum: + - "1411" + - title: Teacher in Charge + enum: + - "1501" + - title: Coach + enum: + - "1502" + - title: Kāhui Ako Led Principal + enum: + - "2001" + - title: Across School Teacher + enum: + - " 2002" + - title: Kāhui Ako Support Facilitator + enum: + - "2101" + - title: Kāhui Ako Expert Partner + enum: + - "2102" + - title: Ministry - Learning Support Facilitator + enum: + - "2103" + - title: Ministry - Strategic Advisor - Māori + enum: + - "2104" + - title: Ministry - SAF + enum: + - "2105" + - title: DHB Staff + enum: + - "2106" + - title: Teacher Aide + enum: + - "1301" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Kāhui Ako within School Teacher + enum: + - "1208" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Finance Manager + enum: + - "1011" + CourseList: + description:

List of generic references denoting the Courses the + TeachingGroup is being taught.

+ type: object + properties: + Course: + type: array + items: + $ref: "#/paths/~1TeachingGroups~1%7BTeachingGroupRefId%\ + 7D/put/requestBody/content/application~1json/sche\ + ma/properties/TeachingGroup/properties/Provider" + SubjectAreaList: + description:

List of codes denoting the Learning or Subject Areas + of the Course the TeachingGroup is being taught.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + YearLevelList: + description: "

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.

" + type: object + properties: + YearLevel: + type: array + items: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid + for describing Funding Year Level and Current Year + Level for a student enrolment.

Current Year + Level indicates the year level of the student’s + class cohort and the level at which the student + spends most of their time at school. While a + student may be enrolled in subjects at varying + instructional year levels, in relation to the + student enrolment this value represents the year + level at which the student is considered to be + predominantly taught.

Funding Year Level + measures the actual number of years that the + student has attended a school. It provides the + Ministry with a method of counting students for + funding purposes which is independent of the way + schools are organised or the particular programme + of study that a student may undertake. Funding + Year Level for most students is based on the date + they first started school.

School Year + Level is used to indicate the instructional year + levels offered by a school, i.e. those years for + which student enrolments may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates + Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + TeachingGroup: + TeachingGroupRefId: 64A309DA-063A-2E35-B359-D75101A8C3D1 + TeachingGroupLocalId: 20087ASPN + ShortName: 7A SPN + LongName: Year 7A Maths - Space and Numbers + GroupType: SC + Provider: + RefId: 64A309DA-063A-2E35-B359-FACEA8C12312 + LocalId: 234 + SchoolYear: 2018 + BeginDate: 2018-02-04 + EndDate: 2018-12-05 + 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" + application/xml: + schema: + type: object + properties: + TeachingGroup: + $ref: "#/paths/~1TeachingGroups~1%7BTeachingGroupRefId%7D/put/req\ + uestBody/content/application~1json/schema/properties/Teachi\ + ngGroup" + example: >- + + 64A309DA-063A-2E35-B359-D75101A8C3D1 + 20087ASPN + 7A SPN + Year 7A Maths - Space and Numbers + SC + + 64A309DA-063A-2E35-B359-FACEA8C12312 + 234 + + 2018 + 2018-02-04 + 2018-12-05 + + + 9897466F-200E-4BC1-B9AE-D1507DA15CEF + SMI001 + Peter Smith + + + 7C834EA9-EDA1-2090-347F-83297E1C290D + SMI002 + Jennifer Smith + + + 7C834EA9-EDA1-2090-347F-83297E1C290E + SMI003 + Terence Smith + + + + + A8C3A2E3-5B35-9D75-101D-00AA001A0000 + SMI1 + Thomas Smith + 1001 + + + A8CCCCE3-5B35-9D75-101D-00AA001A0000 + LONG2 + Tamara Long + 1002 + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - TeachingGroup + summary: Default operation to get a single TeachingGroup + parameters: + - name: TeachingGroupRefId + in: path + description:

The GUID of the TeachingGroup

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + TeachingGroup: + $ref: "#/paths/~1TeachingGroups/get/responses/200/content/appli\ + cation~1json/schema/properties/TeachingGroups/properties/\ + TeachingGroup/items" + example: + TeachingGroup: + TeachingGroupRefId: 64A309DA-063A-2E35-B359-D75101A8C3D1 + TeachingGroupLocalId: 20087ASPN + ShortName: 7A SPN + LongName: Year 7A Maths - Space and Numbers + GroupType: SC + Provider: + RefId: 64A309DA-063A-2E35-B359-FACEA8C12312 + LocalId: 234 + SchoolYear: 2018 + BeginDate: 2018-02-04 + EndDate: 2018-12-05 + 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" + application/xml: + schema: + type: object + properties: + TeachingGroup: + $ref: "#/paths/~1TeachingGroups/get/responses/200/content/appli\ + cation~1json/schema/properties/TeachingGroups/properties/\ + TeachingGroup/items" + example: >- + + 64A309DA-063A-2E35-B359-D75101A8C3D1 + 20087ASPN + 7A SPN + Year 7A Maths - Space and Numbers + SC + + 64A309DA-063A-2E35-B359-FACEA8C12312 + 234 + + 2018 + 2018-02-04 + 2018-12-05 + + + 9897466F-200E-4BC1-B9AE-D1507DA15CEF + SMI001 + Peter Smith + + + 7C834EA9-EDA1-2090-347F-83297E1C290D + SMI002 + Jennifer Smith + + + 7C834EA9-EDA1-2090-347F-83297E1C290E + SMI003 + Terence Smith + + + + + A8C3A2E3-5B35-9D75-101D-00AA001A0000 + SMI1 + Thomas Smith + 1001 + + + A8CCCCE3-5B35-9D75-101D-00AA001A0000 + LONG2 + Tamara Long + 1002 + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - TeachingGroup + summary: Default operation to delete a single TeachingGroup + parameters: + - name: TeachingGroupRefId + in: path + description:

The GUID of the TeachingGroup

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /ProviderCourses: + get: + tags: + - ProviderCourse + summary: Default operation to get a list of all available ProviderCourses + description: Search the set of available ProviderCourses, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ProviderCourses: + type: object + description: A List of ProviderCourse objects + properties: + ProviderCourse: + type: array + items: + required: + - Curriculum + - Provider + - Title + type: object + properties: + ProviderCourseRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + ProviderCourseLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1ProviderCourses/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/ProviderCourses/properties/ProviderCours\ + e/items/properties/ProviderCourseRefId" + LocalId: + $ref: "#/paths/~1ProviderCourses/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/ProviderCourses/properties/ProviderCours\ + e/items/properties/ProviderCourseLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Curriculum: + type: string + title: Curriculum + description: >- +

Codes denoting the two curricula used in New + Zealand.

    +
  • 'NZC' - NZ Curriculum
    • +
  • 'TMA' - Te Marautanga o Aotearoa
    • +
  • 'ECE' - Te Whaariki
    • +
  • 'OTH' - Other Curriculum
    • +
+ oneOf: + - title: NZ Curriculum + enum: + - NZC + - title: Te Marautanga o Aotearoa + enum: + - TMA + - title: Te Whaariki + enum: + - ECE + - title: Other Curriculum + enum: + - OTH + SubjectAreaList: + description:

Subject matter areas covered by the + Course.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZ Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication + Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural + Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication + (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + YearLevelList: + description:

Year Levels covered by the Course.

+ type: object + required: + - YearLevel + properties: + YearLevel: + type: array + items: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are + valid for describing Funding Year Level + and Current Year Level for a student + enrolment.

Current Year Level + indicates the year level of the student’s + class cohort and the level at which the + student spends most of their time at + school. While a student may be enrolled in + subjects at varying instructional year + levels, in relation to the student + enrolment this value represents the year + level at which the student is considered + to be predominantly taught.

Funding + Year Level measures the actual number of + years that the student has attended a + school. It provides the Ministry with a + method of counting students for funding + purposes which is independent of the way + schools are organised or the particular + programme of study that a student may + undertake. Funding Year Level for most + students is based on the date they first + started school.

School Year Level + is used to indicate the instructional year + levels offered by a school, i.e. those + years for which student enrolments may be + accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code + indicates Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + Title: + type: string + description:

Title of the Course.

+ Description: + type: string + description:

Textual description of the Course.

+ Duration: + type: integer + description:

The number of weeks the course is taught + for.

+ Credits: + type: string + description:

The number of credits awarded upon Course + completion.

+ LanguageOfInstructionList: + description:

The language of instruction for the + Course.

+ type: object + required: + - Language + properties: + Language: + type: array + items: + description:

The number of hours per week the + Learner is taught in a specific language + during the enrolment.

+ type: object + required: + - Code + - LanguageOfInstructionType + - Level + properties: + Code: + type: string + title: Language + description: >- +

Language refers to recognised human + communication systems, typically oral + and/or written. Sourced from + Statistics NZ - Language Standard + Classification 1999 v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not further defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not elsewhere + classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not further defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not elsewhere + classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not elsewhere + classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not further + defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not elsewhere + classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere classified + enum: + - NZS15199 + - title: Central-Eastern Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not further defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not elsewhere + classified + enum: + - NZS16199 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not elsewhere + classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western Malayo-Polynesian not + further defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western Malayo-Polynesian not + elsewhere classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere classified + enum: + - NZS18399 + - title: Niger-Congo (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not further + defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not elsewhere + classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not further + defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not elsewhere + classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not elsewhere + classified + enum: + - NZS219 + - title: Language Isolates not elsewhere + classified + enum: + - NZS21999 + - title: Miscellaneous Language Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous Languages + enum: + - NZS229 + - title: Other Miscellaneous Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not further + defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not elsewhere + classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not further defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not elsewhere + classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + Level: + description:

The level of instruction that is + made in the selected language.

+ LearningStandardList: + description:

A list of ObjectReferences to + the LearningStandards covered by the Course.

+ type: object + required: + - LearningStandard + properties: + LearningStandard: + type: array + items: + $ref: "#/paths/~1ProviderCourses/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/ProviderCourses/properties/Provide\ + rCourse/items/properties/Provider" + CredentialList: + description:

A list of ObjectReferences to + the Credentials that may be gained by students + completing the course.

+ type: object + required: + - Credential + properties: + Credential: + type: array + items: + $ref: "#/paths/~1ProviderCourses/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/ProviderCourses/properties/Provide\ + rCourse/items/properties/Provider" + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ProviderCourses: + ProviderCourse: + - ProviderCourseRefId: 9D75101A-8C3D-00AA-001A-0000A2E35B35 + ProviderCourseLocalId: 12CHEM + Provider: + RefId: 101A8C3D-00AA-001A-0000-A2E35B359D75 + LocalId: 208 + 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: + - RefId: ac0871d9-6562-4209-ae86-face3661842b + LocalId: 91165-v2 + Name: Demonstrate understanding of the properties of + selected organic compounds + - RefId: ac0871d9-6562-4209-ae86-aabb3661842b + LocalId: 91166-v2 + Name: Demonstrate understanding of chemical reactivity + - RefId: ac0871d9-6562-4209-ae86-aabb3661842b + LocalId: 91167-v2 + Name: Demonstrate understanding of oxidation-reduction + application/xml: + schema: + type: object + properties: + ProviderCourses: + type: object + description: A List of ProviderCourse objects + properties: + ProviderCourse: + type: array + items: + $ref: "#/paths/~1ProviderCourses/get/responses/200/conten\ + t/application~1json/schema/properties/ProviderCours\ + es/properties/ProviderCourse/items" + example: >- + + + 9D75101A-8C3D-00AA-001A-0000A2E35B35 + 12CHEM + + 101A8C3D-00AA-001A-0000-A2E35B359D75 + 208 + + NZC + + CHEM + + + 12 + + Year 12 Chemistry + Organic & Inorganic Chemistry for NCEA Level 2 + 35 + 11 + + + NZS01112 + 1 + + + + + ac0871d9-6562-4209-ae86-face3661842b + 91165-v2 + Demonstrate understanding of the properties of selected organic compounds + + + ac0871d9-6562-4209-ae86-aabb3661842b + 91166-v2 + Demonstrate understanding of chemical reactivity + + + ac0871d9-6562-4209-ae86-aabb3661842b + 91167-v2 + Demonstrate understanding of oxidation-reduction + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/ProviderCourses/{ProviderCourseRefId}": + post: + tags: + - ProviderCourse + summary: Default operation to create a single ProviderCourse + parameters: + - name: ProviderCourseRefId + in: path + description:

The ID (GUID) that uniquely identifies the Provider defined + Course.

+ required: true + schema: + type: string + operationId: createProviderCourse + requestBody: + description: CRUD operation on ProviderCourse + content: + application/json: + schema: + type: object + properties: + ProviderCourse: + $ref: "#/paths/~1ProviderCourses/get/responses/200/content/applic\ + ation~1json/schema/properties/ProviderCourses/properties/Pr\ + oviderCourse/items" + example: + ProviderCourse: + ProviderCourseRefId: 9D75101A-8C3D-00AA-001A-0000A2E35B35 + ProviderCourseLocalId: 12CHEM + Provider: + RefId: 101A8C3D-00AA-001A-0000-A2E35B359D75 + LocalId: 208 + 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: + - RefId: ac0871d9-6562-4209-ae86-face3661842b + LocalId: 91165-v2 + Name: Demonstrate understanding of the properties of selected + organic compounds + - RefId: ac0871d9-6562-4209-ae86-aabb3661842b + LocalId: 91166-v2 + Name: Demonstrate understanding of chemical reactivity + - RefId: ac0871d9-6562-4209-ae86-aabb3661842b + LocalId: 91167-v2 + Name: Demonstrate understanding of oxidation-reduction + application/xml: + schema: + type: object + properties: + ProviderCourse: + $ref: "#/paths/~1ProviderCourses/get/responses/200/content/applic\ + ation~1json/schema/properties/ProviderCourses/properties/Pr\ + oviderCourse/items" + example: >- + + 9D75101A-8C3D-00AA-001A-0000A2E35B35 + 12CHEM + + 101A8C3D-00AA-001A-0000-A2E35B359D75 + 208 + + NZC + + CHEM + + + 12 + + Year 12 Chemistry + Organic & Inorganic Chemistry for NCEA Level 2 + 35 + 11 + + + NZS01112 + 1 + + + + + ac0871d9-6562-4209-ae86-face3661842b + 91165-v2 + Demonstrate understanding of the properties of selected organic compounds + + + ac0871d9-6562-4209-ae86-aabb3661842b + 91166-v2 + Demonstrate understanding of chemical reactivity + + + ac0871d9-6562-4209-ae86-aabb3661842b + 91167-v2 + Demonstrate understanding of oxidation-reduction + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - ProviderCourse + summary: Default operation to update a single ProviderCourse + parameters: + - name: ProviderCourseRefId + in: path + description:

The ID (GUID) that uniquely identifies the Provider defined + Course.

+ required: true + schema: + type: string + operationId: updateProviderCourse + requestBody: + description: CRUD operation on ProviderCourse + content: + application/json: + schema: + type: object + properties: + ProviderCourse: + type: object + properties: + ProviderCourseRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + ProviderCourseLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1ProviderCourses~1%7BProviderCourseRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/ProviderCourse/properties/ProviderCours\ + eRefId" + LocalId: + $ref: "#/paths/~1ProviderCourses~1%7BProviderCourseRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/ProviderCourse/properties/ProviderCours\ + eLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Curriculum: + type: string + title: Curriculum + description: >- +

Codes denoting the two curricula used in New Zealand. +

    +
  • 'NZC' - NZ Curriculum
    • +
  • 'TMA' - Te Marautanga o Aotearoa
    • +
  • 'ECE' - Te Whaariki
    • +
  • 'OTH' - Other Curriculum
    • +
+ oneOf: + - title: NZ Curriculum + enum: + - NZC + - title: Te Marautanga o Aotearoa + enum: + - TMA + - title: Te Whaariki + enum: + - ECE + - title: Other Curriculum + enum: + - OTH + SubjectAreaList: + description:

Subject matter areas covered by the Course.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + YearLevelList: + description:

Year Levels covered by the Course.

+ type: object + properties: + YearLevel: + type: array + items: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid + for describing Funding Year Level and Current Year + Level for a student enrolment.

Current Year + Level indicates the year level of the student’s + class cohort and the level at which the student + spends most of their time at school. While a + student may be enrolled in subjects at varying + instructional year levels, in relation to the + student enrolment this value represents the year + level at which the student is considered to be + predominantly taught.

Funding Year Level + measures the actual number of years that the + student has attended a school. It provides the + Ministry with a method of counting students for + funding purposes which is independent of the way + schools are organised or the particular programme + of study that a student may undertake. Funding + Year Level for most students is based on the date + they first started school.

School Year + Level is used to indicate the instructional year + levels offered by a school, i.e. those years for + which student enrolments may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates + Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + Title: + type: string + description:

Title of the Course.

+ Description: + type: string + description:

Textual description of the Course.

+ Duration: + type: integer + description:

The number of weeks the course is taught for.

+ Credits: + type: string + description:

The number of credits awarded upon Course + completion.

+ LanguageOfInstructionList: + description:

The language of instruction for the Course.

+ type: object + properties: + Language: + type: array + items: + description:

The number of hours per week the Learner is + taught in a specific language during the + enrolment.

+ type: object + properties: + Code: + type: string + title: Language + description: >- +

Language refers to recognised human + communication systems, typically oral and/or + written. Sourced from Statistics NZ - Language + Standard Classification 1999 v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not further defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not elsewhere classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not further defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not elsewhere classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not elsewhere classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not further defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not elsewhere classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere classified + enum: + - NZS15199 + - title: Central-Eastern Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not further defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not elsewhere classified + enum: + - NZS16199 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not elsewhere classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western Malayo-Polynesian not further + defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western Malayo-Polynesian not elsewhere + classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere classified + enum: + - NZS18399 + - title: Niger-Congo (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not further defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not elsewhere classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not further defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not elsewhere + classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not elsewhere classified + enum: + - NZS219 + - title: Language Isolates not elsewhere classified + enum: + - NZS21999 + - title: Miscellaneous Language Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous Languages + enum: + - NZS229 + - title: Other Miscellaneous Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not further defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not elsewhere + classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not further defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not elsewhere classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + Level: + description:

The level of instruction that is made in + the selected language.

+ LearningStandardList: + description:

A list of ObjectReferences to the + LearningStandards covered by the Course.

+ type: object + properties: + LearningStandard: + type: array + items: + $ref: "#/paths/~1ProviderCourses~1%7BProviderCourseRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/ProviderCourse/properties/Provide\ + r" + CredentialList: + description:

A list of ObjectReferences to the + Credentials that may be gained by students completing + the course.

+ type: object + properties: + Credential: + type: array + items: + $ref: "#/paths/~1ProviderCourses~1%7BProviderCourseRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/ProviderCourse/properties/Provide\ + r" + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ProviderCourse: + ProviderCourseRefId: 9D75101A-8C3D-00AA-001A-0000A2E35B35 + ProviderCourseLocalId: 12CHEM + Provider: + RefId: 101A8C3D-00AA-001A-0000-A2E35B359D75 + LocalId: 208 + 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: + - RefId: ac0871d9-6562-4209-ae86-face3661842b + LocalId: 91165-v2 + Name: Demonstrate understanding of the properties of selected + organic compounds + - RefId: ac0871d9-6562-4209-ae86-aabb3661842b + LocalId: 91166-v2 + Name: Demonstrate understanding of chemical reactivity + - RefId: ac0871d9-6562-4209-ae86-aabb3661842b + LocalId: 91167-v2 + Name: Demonstrate understanding of oxidation-reduction + application/xml: + schema: + type: object + properties: + ProviderCourse: + $ref: "#/paths/~1ProviderCourses~1%7BProviderCourseRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/Prov\ + iderCourse" + example: >- + + 9D75101A-8C3D-00AA-001A-0000A2E35B35 + 12CHEM + + 101A8C3D-00AA-001A-0000-A2E35B359D75 + 208 + + NZC + + CHEM + + + 12 + + Year 12 Chemistry + Organic & Inorganic Chemistry for NCEA Level 2 + 35 + 11 + + + NZS01112 + 1 + + + + + ac0871d9-6562-4209-ae86-face3661842b + 91165-v2 + Demonstrate understanding of the properties of selected organic compounds + + + ac0871d9-6562-4209-ae86-aabb3661842b + 91166-v2 + Demonstrate understanding of chemical reactivity + + + ac0871d9-6562-4209-ae86-aabb3661842b + 91167-v2 + Demonstrate understanding of oxidation-reduction + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - ProviderCourse + summary: Default operation to get a single ProviderCourse + parameters: + - name: ProviderCourseRefId + in: path + description:

The ID (GUID) that uniquely identifies the Provider defined + Course.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ProviderCourse: + $ref: "#/paths/~1ProviderCourses/get/responses/200/content/appl\ + ication~1json/schema/properties/ProviderCourses/propertie\ + s/ProviderCourse/items" + example: + ProviderCourse: + ProviderCourseRefId: 9D75101A-8C3D-00AA-001A-0000A2E35B35 + ProviderCourseLocalId: 12CHEM + Provider: + RefId: 101A8C3D-00AA-001A-0000-A2E35B359D75 + LocalId: 208 + 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: + - RefId: ac0871d9-6562-4209-ae86-face3661842b + LocalId: 91165-v2 + Name: Demonstrate understanding of the properties of + selected organic compounds + - RefId: ac0871d9-6562-4209-ae86-aabb3661842b + LocalId: 91166-v2 + Name: Demonstrate understanding of chemical reactivity + - RefId: ac0871d9-6562-4209-ae86-aabb3661842b + LocalId: 91167-v2 + Name: Demonstrate understanding of oxidation-reduction + application/xml: + schema: + type: object + properties: + ProviderCourse: + $ref: "#/paths/~1ProviderCourses/get/responses/200/content/appl\ + ication~1json/schema/properties/ProviderCourses/propertie\ + s/ProviderCourse/items" + example: >- + + 9D75101A-8C3D-00AA-001A-0000A2E35B35 + 12CHEM + + 101A8C3D-00AA-001A-0000-A2E35B359D75 + 208 + + NZC + + CHEM + + + 12 + + Year 12 Chemistry + Organic & Inorganic Chemistry for NCEA Level 2 + 35 + 11 + + + NZS01112 + 1 + + + + + ac0871d9-6562-4209-ae86-face3661842b + 91165-v2 + Demonstrate understanding of the properties of selected organic compounds + + + ac0871d9-6562-4209-ae86-aabb3661842b + 91166-v2 + Demonstrate understanding of chemical reactivity + + + ac0871d9-6562-4209-ae86-aabb3661842b + 91167-v2 + Demonstrate understanding of oxidation-reduction + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - ProviderCourse + summary: Default operation to delete a single ProviderCourse + parameters: + - name: ProviderCourseRefId + in: path + description:

The ID (GUID) that uniquely identifies the Provider defined + Course.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /LearningStandards: + get: + tags: + - LearningStandard + summary: Default operation to get a list of all available LearningStandards + description: Search the set of available LearningStandards, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + LearningStandards: + type: object + description: A List of LearningStandard objects + properties: + LearningStandard: + type: array + items: + required: + - SubjectAreaList + - Title + type: object + properties: + LearningStandardRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + LearningStandardLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Title: + type: string + description: '

The name of the LearningStandard. eg: + "Demonstrate understanding of chemical + reactivity"

' + VersionNo: + description:

The version number of the + LearningStandard.

+ Publisher: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1LearningStandards/get/responses/\ + 200/content/application~1json/schema/proper\ + ties/LearningStandards/properties/LearningS\ + tandard/items/properties/LearningStandardRe\ + fId" + LocalId: + $ref: "#/paths/~1LearningStandards/get/responses/\ + 200/content/application~1json/schema/proper\ + ties/LearningStandards/properties/LearningS\ + tandard/items/properties/LearningStandardLo\ + calId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + StandardType: + type: string + title: Learning Standard Type + description: >- +

Code set denoting the type of standard e.g., + unit standard, achievement standard.

    +
  • 'US' - Unit Standard
    • +
  • 'AS' - Achievement Standard
    • +
+ oneOf: + - title: Unit Standard + description:

Developed by Industry Training + Organisations or NZQA.

+ enum: + - US + - title: Achievement Standard + description:

Developed by MoE, derived from the + achievement objectives of the NZ Curriculum + or Te Marautanga o Aotearoa

+ enum: + - AS + Description: + type: string + description:

Description of the standards document.

+ SubjectAreaList: + description:

Which standard MoE Learning / Subject Areas + is this LearningStandard part of?

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZ Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication + Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural + Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication + (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + Status: + type: string + title: Learning Standard Status + description: >- +

A code denoting the status of the + LearningStandard throughout its life-cycle.

+
    +
  • 'CA' - Candidate
    • +
  • 'PU' - Published
    • +
  • 'SU' - Superceded
    • +
  • 'DI' - Discontinued
    • +
+ oneOf: + - title: Candidate + description:

The LearningStandard is being developed, + and is not yet ready for use in teaching and + assessment.

+ enum: + - CA + - title: Published + description:

The LearningStandard is available for use + in teaching and assessment.

+ enum: + - PU + - title: Superceded + description:

The LearningStandard has been superceded + (probably by a subsequent version of the + standard) but this version is still + available for use in teaching and + assessment.

+ enum: + - SU + - title: Discontinued + description:

The LearningStandard is no longer + available for use in teaching and + assessment.

+ enum: + - DI + PublicationDate: + type: string + format: date + description:

The date the publishing organization + published the standard.

+ SupercededDate: + type: string + format: date + description:

The date the publishing organization + superceded (or will supercede) the + LearningStandard. May be future dated.

+ DiscontinuedDate: + type: string + format: date + description:

The date the publishing organization + discontinued (or will discontinue) the + LearningStandard. May be future dated.

+ Credits: + description:

The number of course (or other qualification) + credits that will be achieved by passing this + LearningStandard.

+ Level: + description:

Where the publisher is NZQA, Which NCEA Level + applies to the LearningStandard?

+ AssessmentType: + type: string + title: Assessment Type + description: >- +

Standard codes denoting the type of + assessment the student is sitting for the + assessment task.

    +
  • 'INT' - Internal Exam/Assessment
    • +
  • 'EXT' - External Exam/Assessment
    • +
  • 'MOC' - Mock
    • +
  • 'POR' - Portfolio
    • +
  • 'PRA' - Practical
    • +
  • 'OTJ' - Overall Teacher Judgement
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Internal Exam/Assessment + enum: + - INT + - title: External Exam/Assessment + enum: + - EXT + - title: Mock + enum: + - MOC + - title: Portfolio + enum: + - POR + - title: Practical + enum: + - PRA + - title: Overall Teacher Judgement + enum: + - OTJ + - title: Other + enum: + - OTH + RelatedLearningStandardList: + description:

A list of related LearningStandard + references

+ type: object + required: + - RelatedLearningStandard + properties: + RelatedLearningStandard: + type: array + items: + description:

A member of a list of related + LearningStandard references.

+ type: object + required: + - ObjectType + - Relationship + properties: + Relationship: + type: string + title: Learning Standard Relationship Type + description: >- +

A code denoting the nature of the + relationship with another + LearningStandard

    +
  • 'PREDEC' - Predecessor
    • +
  • 'SUCCES' - Successor
    • +
  • 'PREREQ' - Prerequisite
    • +
  • 'UNKNWN' - Unknown
    • +
+ oneOf: + - title: Predecessor + description:

The related LearningStandard is + a predecessor to this + LearningStandard, and is + superceded by it.

+ enum: + - PREDEC + - title: Successor + description:

The related LearningStandard is + a successor to this + LearningStandard, and it + supercedes this + LearningStandard.

+ enum: + - SUCCES + - title: Prerequisite + description:

The related LearningStandard is + a prerequisite to this + LearningStandard, and students + should have completed the learning + in that LearningStandard before + embarking on the learning in this + one.

+ enum: + - PREREQ + - title: Unknown + description:

The precise nature of the + relationship between the two + LearningStandards not known, but + the fact that they are related is + known.

+ enum: + - UNKNWN + CredentialList: + description:

A list of Credentials that the learning + standard contributes to attaining.

+ type: object + required: + - Credential + properties: + Credential: + type: array + items: + $ref: "#/paths/~1LearningStandards/get/response\ + s/200/content/application~1json/schema/pr\ + operties/LearningStandards/properties/Lea\ + rningStandard/items/properties/Publisher" + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + LearningStandards: + LearningStandard: + - LearningStandardRefId: cedf9eae-4358-408d-af57-ec0ea1b0d210 + LearningStandardLocalId: 91165 + Title: Chemistry + 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 + application/xml: + schema: + type: object + properties: + LearningStandards: + type: object + description: A List of LearningStandard objects + properties: + LearningStandard: + type: array + items: + $ref: "#/paths/~1LearningStandards/get/responses/200/cont\ + ent/application~1json/schema/properties/LearningSta\ + ndards/properties/LearningStandard/items" + example: >- + + + cedf9eae-4358-408d-af57-ec0ea1b0d210 + 91165 + Chemistry + 2 + + cedf9eae-4358-408d-af57-ec0ea1b0d210 + + Demonstrate understanding of the properties of selected organic compounds + + CHEM + + PU + 4 + 2 + INT + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/LearningStandards/{LearningStandardRefId}": + post: + tags: + - LearningStandard + summary: Default operation to create a single LearningStandard + parameters: + - name: LearningStandardRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies the particular + version or edition of the Learning Standard.

+ required: true + schema: + type: string + operationId: createLearningStandard + requestBody: + description: CRUD operation on LearningStandard + content: + application/json: + schema: + type: object + properties: + LearningStandard: + $ref: "#/paths/~1LearningStandards/get/responses/200/content/appl\ + ication~1json/schema/properties/LearningStandards/propertie\ + s/LearningStandard/items" + example: + LearningStandard: + LearningStandardRefId: cedf9eae-4358-408d-af57-ec0ea1b0d210 + LearningStandardLocalId: 91165 + Title: Chemistry + 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 + application/xml: + schema: + type: object + properties: + LearningStandard: + $ref: "#/paths/~1LearningStandards/get/responses/200/content/appl\ + ication~1json/schema/properties/LearningStandards/propertie\ + s/LearningStandard/items" + example: >- + + cedf9eae-4358-408d-af57-ec0ea1b0d210 + 91165 + Chemistry + 2 + + cedf9eae-4358-408d-af57-ec0ea1b0d210 + + Demonstrate understanding of the properties of selected organic compounds + + CHEM + + PU + 4 + 2 + INT + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - LearningStandard + summary: Default operation to update a single LearningStandard + parameters: + - name: LearningStandardRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies the particular + version or edition of the Learning Standard.

+ required: true + schema: + type: string + operationId: updateLearningStandard + requestBody: + description: CRUD operation on LearningStandard + content: + application/json: + schema: + type: object + properties: + LearningStandard: + type: object + properties: + LearningStandardRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + LearningStandardLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Title: + type: string + description: '

The name of the LearningStandard. eg: "Demonstrate + understanding of chemical reactivity"

' + VersionNo: + description:

The version number of the LearningStandard.

+ Publisher: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1LearningStandards~1%7BLearningStandardRe\ + fId%7D/put/requestBody/content/application~1json/sc\ + hema/properties/LearningStandard/properties/Learnin\ + gStandardRefId" + LocalId: + $ref: "#/paths/~1LearningStandards~1%7BLearningStandardRe\ + fId%7D/put/requestBody/content/application~1json/sc\ + hema/properties/LearningStandard/properties/Learnin\ + gStandardLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + StandardType: + type: string + title: Learning Standard Type + description: >- +

Code set denoting the type of standard e.g., unit + standard, achievement standard.

    +
  • 'US' - Unit Standard
    • +
  • 'AS' - Achievement Standard
    • +
+ oneOf: + - title: Unit Standard + description:

Developed by Industry Training Organisations or + NZQA.

+ enum: + - US + - title: Achievement Standard + description:

Developed by MoE, derived from the achievement + objectives of the NZ Curriculum or Te Marautanga o + Aotearoa

+ enum: + - AS + Description: + type: string + description:

Description of the standards document.

+ SubjectAreaList: + description:

Which standard MoE Learning / Subject Areas is this + LearningStandard part of?

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + Status: + type: string + title: Learning Standard Status + description: >- +

A code denoting the status of the LearningStandard + throughout its life-cycle.

    +
  • 'CA' - Candidate
    • +
  • 'PU' - Published
    • +
  • 'SU' - Superceded
    • +
  • 'DI' - Discontinued
    • +
+ oneOf: + - title: Candidate + description:

The LearningStandard is being developed, and is + not yet ready for use in teaching and + assessment.

+ enum: + - CA + - title: Published + description:

The LearningStandard is available for use in + teaching and assessment.

+ enum: + - PU + - title: Superceded + description:

The LearningStandard has been superceded + (probably by a subsequent version of the standard) + but this version is still available for use in + teaching and assessment.

+ enum: + - SU + - title: Discontinued + description:

The LearningStandard is no longer available for + use in teaching and assessment.

+ enum: + - DI + PublicationDate: + type: string + format: date + description:

The date the publishing organization published the + standard.

+ SupercededDate: + type: string + format: date + description:

The date the publishing organization superceded (or + will supercede) the LearningStandard. May be future + dated.

+ DiscontinuedDate: + type: string + format: date + description:

The date the publishing organization discontinued (or + will discontinue) the LearningStandard. May be future + dated.

+ Credits: + description:

The number of course (or other qualification) credits + that will be achieved by passing this + LearningStandard.

+ Level: + description:

Where the publisher is NZQA, Which NCEA Level applies + to the LearningStandard?

+ AssessmentType: + type: string + title: Assessment Type + description: >- +

Standard codes denoting the type of assessment the + student is sitting for the assessment task.

    +
  • 'INT' - Internal Exam/Assessment
    • +
  • 'EXT' - External Exam/Assessment
    • +
  • 'MOC' - Mock
    • +
  • 'POR' - Portfolio
    • +
  • 'PRA' - Practical
    • +
  • 'OTJ' - Overall Teacher Judgement
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Internal Exam/Assessment + enum: + - INT + - title: External Exam/Assessment + enum: + - EXT + - title: Mock + enum: + - MOC + - title: Portfolio + enum: + - POR + - title: Practical + enum: + - PRA + - title: Overall Teacher Judgement + enum: + - OTJ + - title: Other + enum: + - OTH + RelatedLearningStandardList: + description:

A list of related LearningStandard references

+ type: object + properties: + RelatedLearningStandard: + type: array + items: + description:

A member of a list of related LearningStandard + references.

+ type: object + properties: + Relationship: + type: string + title: Learning Standard Relationship Type + description: >- +

A code denoting the nature of the + relationship with another LearningStandard

+
    +
  • 'PREDEC' - Predecessor
    • +
  • 'SUCCES' - Successor
    • +
  • 'PREREQ' - Prerequisite
    • +
  • 'UNKNWN' - Unknown
    • +
+ oneOf: + - title: Predecessor + description:

The related LearningStandard is a + predecessor to this LearningStandard, and + is superceded by it.

+ enum: + - PREDEC + - title: Successor + description:

The related LearningStandard is a + successor to this LearningStandard, and it + supercedes this LearningStandard.

+ enum: + - SUCCES + - title: Prerequisite + description:

The related LearningStandard is a + prerequisite to this LearningStandard, and + students should have completed the + learning in that LearningStandard before + embarking on the learning in this one.

+ enum: + - PREREQ + - title: Unknown + description:

The precise nature of the relationship + between the two LearningStandards not + known, but the fact that they are related + is known.

+ enum: + - UNKNWN + CredentialList: + description:

A list of Credentials that the learning standard + contributes to attaining.

+ type: object + properties: + Credential: + type: array + items: + $ref: "#/paths/~1LearningStandards~1%7BLearningStandard\ + RefId%7D/put/requestBody/content/application~1jso\ + n/schema/properties/LearningStandard/properties/P\ + ublisher" + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + LearningStandard: + LearningStandardRefId: cedf9eae-4358-408d-af57-ec0ea1b0d210 + LearningStandardLocalId: 91165 + Title: Chemistry + 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 + application/xml: + schema: + type: object + properties: + LearningStandard: + $ref: "#/paths/~1LearningStandards~1%7BLearningStandardRefId%7D/p\ + ut/requestBody/content/application~1json/schema/properties/\ + LearningStandard" + example: >- + + cedf9eae-4358-408d-af57-ec0ea1b0d210 + 91165 + Chemistry + 2 + + cedf9eae-4358-408d-af57-ec0ea1b0d210 + + Demonstrate understanding of the properties of selected organic compounds + + CHEM + + PU + 4 + 2 + INT + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - LearningStandard + summary: Default operation to get a single LearningStandard + parameters: + - name: LearningStandardRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies the particular + version or edition of the Learning Standard.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + LearningStandard: + $ref: "#/paths/~1LearningStandards/get/responses/200/content/ap\ + plication~1json/schema/properties/LearningStandards/prope\ + rties/LearningStandard/items" + example: + LearningStandard: + LearningStandardRefId: cedf9eae-4358-408d-af57-ec0ea1b0d210 + LearningStandardLocalId: 91165 + Title: Chemistry + 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 + application/xml: + schema: + type: object + properties: + LearningStandard: + $ref: "#/paths/~1LearningStandards/get/responses/200/content/ap\ + plication~1json/schema/properties/LearningStandards/prope\ + rties/LearningStandard/items" + example: >- + + cedf9eae-4358-408d-af57-ec0ea1b0d210 + 91165 + Chemistry + 2 + + cedf9eae-4358-408d-af57-ec0ea1b0d210 + + Demonstrate understanding of the properties of selected organic compounds + + CHEM + + PU + 4 + 2 + INT + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - LearningStandard + summary: Default operation to delete a single LearningStandard + parameters: + - name: LearningStandardRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies the particular + version or edition of the Learning Standard.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /Credentials: + get: + tags: + - Credential + summary: Default operation to get a list of all available Credentials + description: Search the set of available Credentials, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + Credentials: + type: object + description: A List of Credential objects + properties: + Credential: + type: array + items: + required: + - Status + - Title + type: object + properties: + CredentialRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + CredentialLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Title: + type: string + description: '

The name of the Credential. eg: "NCEA Level + 1"

' + VersionNo: + description:

The version number of the Credential.

+ Administrator: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1Credentials/get/responses/200/co\ + ntent/application~1json/schema/properties/C\ + redentials/properties/Credential/items/prop\ + erties/CredentialRefId" + LocalId: + $ref: "#/paths/~1Credentials/get/responses/200/co\ + ntent/application~1json/schema/properties/C\ + redentials/properties/Credential/items/prop\ + erties/CredentialLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Description: + type: string + description:

Description of the credential

+ SubjectAreaList: + description:

Which standard MoE Learning / Subject Areas + is this Credential part of?

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZ Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication + Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural + Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication + (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + Status: + type: string + title: Credential Status + description: >- +

A code denoting the status of the Credential + throughout its life-cycle.

    +
  • 'CA' - Candidate
    • +
  • 'PU' - Published
    • +
  • 'SU' - Superceded
    • +
  • 'DI' - Discontinued
    • +
+ oneOf: + - title: Candidate + description:

The Credential is being developed, and is + not yet available for granting as an + Attainment.

+ enum: + - CA + - title: Published + description:

The Credential is available for granting + as an Attainment

+ enum: + - PU + - title: Superceded + description:

The Credential has been superceded + (probably by a subsequent Credential) but + this version is still available for granting + as an Attainment.

+ enum: + - SU + - title: Discontinued + description:

The Credential is no longer available + granting as an Attainment

+ enum: + - DI + PublicationDate: + type: string + format: date + description:

This is the date that the administering + organization published the Credential.

+ SupercededDate: + type: string + format: date + description:

The date the administering organization + superceded (or will supercede) the Credential. + May be future dated.

+ DiscontinuedDate: + type: string + format: date + description:

The date the administering organization + discontinued (or will discontinue) the + Credential. May be future dated.

+ Credits: + description:

The number of course (or other qualification) + credits that will be achieved by attaining this + Credential.

+ Level: + type: string + description:

The level of the credential if applicable, + eg. 1,2 or 3 for NCEA levels

+ RelatedLearningStandardList: + description:

A list of related LearningStandard + references

+ type: object + required: + - RelatedLearningStandard + properties: + RelatedLearningStandard: + type: array + items: + description:

A member of a list of related + LearningStandard references.

+ type: object + required: + - ObjectType + - Relationship + properties: + Relationship: + type: string + title: Learning Standard Relationship Type + description: >- +

A code denoting the nature of the + relationship with another + LearningStandard

    +
  • 'PREDEC' - Predecessor
    • +
  • 'SUCCES' - Successor
    • +
  • 'PREREQ' - Prerequisite
    • +
  • 'UNKNWN' - Unknown
    • +
+ oneOf: + - title: Predecessor + description:

The related LearningStandard is + a predecessor to this + LearningStandard, and is + superceded by it.

+ enum: + - PREDEC + - title: Successor + description:

The related LearningStandard is + a successor to this + LearningStandard, and it + supercedes this + LearningStandard.

+ enum: + - SUCCES + - title: Prerequisite + description:

The related LearningStandard is + a prerequisite to this + LearningStandard, and students + should have completed the learning + in that LearningStandard before + embarking on the learning in this + one.

+ enum: + - PREREQ + - title: Unknown + description:

The precise nature of the + relationship between the two + LearningStandards not known, but + the fact that they are related is + known.

+ enum: + - UNKNWN + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + Credentials: + Credential: + - CredentialRefId: 2b560779-872b-4491-afd6-3c6bd5f1c8cc + CredentialLocalId: 91165 + 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" + application/xml: + schema: + type: object + properties: + Credentials: + type: object + description: A List of Credential objects + properties: + Credential: + type: array + items: + $ref: "#/paths/~1Credentials/get/responses/200/content/ap\ + plication~1json/schema/properties/Credentials/prope\ + rties/Credential/items" + example: >- + + + 2b560779-872b-4491-afd6-3c6bd5f1c8cc + 91165 + NCEA Level 2 - Endorsed with Merit + 2 + + 3d614c16-9046-47d1-87b5-51438590de15 + NZQA + + Achieved sufficient chemistry credits endorsed with merit + + CHEM + + PU + 4 + 2 + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/Credentials/{CredentialRefId}": + post: + tags: + - Credential + summary: Default operation to create a single Credential + parameters: + - name: CredentialRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies the particular + version or edition of the Credential.

+ required: true + schema: + type: string + operationId: createCredential + requestBody: + description: CRUD operation on Credential + content: + application/json: + schema: + type: object + properties: + Credential: + $ref: "#/paths/~1Credentials/get/responses/200/content/applicatio\ + n~1json/schema/properties/Credentials/properties/Credential\ + /items" + example: + Credential: + CredentialRefId: 2b560779-872b-4491-afd6-3c6bd5f1c8cc + CredentialLocalId: 91165 + 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" + application/xml: + schema: + type: object + properties: + Credential: + $ref: "#/paths/~1Credentials/get/responses/200/content/applicatio\ + n~1json/schema/properties/Credentials/properties/Credential\ + /items" + example: >- + + 2b560779-872b-4491-afd6-3c6bd5f1c8cc + 91165 + NCEA Level 2 - Endorsed with Merit + 2 + + 3d614c16-9046-47d1-87b5-51438590de15 + NZQA + + Achieved sufficient chemistry credits endorsed with merit + + CHEM + + PU + 4 + 2 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - Credential + summary: Default operation to update a single Credential + parameters: + - name: CredentialRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies the particular + version or edition of the Credential.

+ required: true + schema: + type: string + operationId: updateCredential + requestBody: + description: CRUD operation on Credential + content: + application/json: + schema: + type: object + properties: + Credential: + type: object + properties: + CredentialRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + CredentialLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Title: + type: string + description: '

The name of the Credential. eg: "NCEA Level 1"

' + VersionNo: + description:

The version number of the Credential.

+ Administrator: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1Credentials~1%7BCredentialRefId%7D/put/r\ + equestBody/content/application~1json/schema/propert\ + ies/Credential/properties/CredentialRefId" + LocalId: + $ref: "#/paths/~1Credentials~1%7BCredentialRefId%7D/put/r\ + equestBody/content/application~1json/schema/propert\ + ies/Credential/properties/CredentialLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Description: + type: string + description:

Description of the credential

+ SubjectAreaList: + description:

Which standard MoE Learning / Subject Areas is this + Credential part of?

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + Status: + type: string + title: Credential Status + description: >- +

A code denoting the status of the Credential + throughout its life-cycle.

    +
  • 'CA' - Candidate
    • +
  • 'PU' - Published
    • +
  • 'SU' - Superceded
    • +
  • 'DI' - Discontinued
    • +
+ oneOf: + - title: Candidate + description:

The Credential is being developed, and is not yet + available for granting as an Attainment.

+ enum: + - CA + - title: Published + description:

The Credential is available for granting as an + Attainment

+ enum: + - PU + - title: Superceded + description:

The Credential has been superceded (probably by a + subsequent Credential) but this version is still + available for granting as an Attainment.

+ enum: + - SU + - title: Discontinued + description:

The Credential is no longer available granting as + an Attainment

+ enum: + - DI + PublicationDate: + type: string + format: date + description:

This is the date that the administering organization + published the Credential.

+ SupercededDate: + type: string + format: date + description:

The date the administering organization superceded + (or will supercede) the Credential. May be future + dated.

+ DiscontinuedDate: + type: string + format: date + description:

The date the administering organization discontinued + (or will discontinue) the Credential. May be future + dated.

+ Credits: + description:

The number of course (or other qualification) credits + that will be achieved by attaining this Credential.

+ Level: + type: string + description:

The level of the credential if applicable, eg. 1,2 or + 3 for NCEA levels

+ RelatedLearningStandardList: + description:

A list of related LearningStandard references

+ type: object + properties: + RelatedLearningStandard: + type: array + items: + description:

A member of a list of related LearningStandard + references.

+ type: object + properties: + Relationship: + type: string + title: Learning Standard Relationship Type + description: >- +

A code denoting the nature of the + relationship with another LearningStandard

+
    +
  • 'PREDEC' - Predecessor
    • +
  • 'SUCCES' - Successor
    • +
  • 'PREREQ' - Prerequisite
    • +
  • 'UNKNWN' - Unknown
    • +
+ oneOf: + - title: Predecessor + description:

The related LearningStandard is a + predecessor to this LearningStandard, and + is superceded by it.

+ enum: + - PREDEC + - title: Successor + description:

The related LearningStandard is a + successor to this LearningStandard, and it + supercedes this LearningStandard.

+ enum: + - SUCCES + - title: Prerequisite + description:

The related LearningStandard is a + prerequisite to this LearningStandard, and + students should have completed the + learning in that LearningStandard before + embarking on the learning in this one.

+ enum: + - PREREQ + - title: Unknown + description:

The precise nature of the relationship + between the two LearningStandards not + known, but the fact that they are related + is known.

+ enum: + - UNKNWN + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + Credential: + CredentialRefId: 2b560779-872b-4491-afd6-3c6bd5f1c8cc + CredentialLocalId: 91165 + 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" + application/xml: + schema: + type: object + properties: + Credential: + $ref: "#/paths/~1Credentials~1%7BCredentialRefId%7D/put/requestBo\ + dy/content/application~1json/schema/properties/Credential" + example: >- + + 2b560779-872b-4491-afd6-3c6bd5f1c8cc + 91165 + NCEA Level 2 - Endorsed with Merit + 2 + + 3d614c16-9046-47d1-87b5-51438590de15 + NZQA + + Achieved sufficient chemistry credits endorsed with merit + + CHEM + + PU + 4 + 2 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - Credential + summary: Default operation to get a single Credential + parameters: + - name: CredentialRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies the particular + version or edition of the Credential.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + Credential: + $ref: "#/paths/~1Credentials/get/responses/200/content/applicat\ + ion~1json/schema/properties/Credentials/properties/Creden\ + tial/items" + example: + Credential: + CredentialRefId: 2b560779-872b-4491-afd6-3c6bd5f1c8cc + CredentialLocalId: 91165 + 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" + application/xml: + schema: + type: object + properties: + Credential: + $ref: "#/paths/~1Credentials/get/responses/200/content/applicat\ + ion~1json/schema/properties/Credentials/properties/Creden\ + tial/items" + example: >- + + 2b560779-872b-4491-afd6-3c6bd5f1c8cc + 91165 + NCEA Level 2 - Endorsed with Merit + 2 + + 3d614c16-9046-47d1-87b5-51438590de15 + NZQA + + Achieved sufficient chemistry credits endorsed with merit + + CHEM + + PU + 4 + 2 + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - Credential + summary: Default operation to delete a single Credential + parameters: + - name: CredentialRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies the particular + version or edition of the Credential.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentProviderEnrolments: + get: + tags: + - StudentProviderEnrolment + summary: Default operation to get a list of all available + StudentProviderEnrolments + description: Search the set of available StudentProviderEnrolments, according to the + search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentProviderEnrolments: + type: object + description: A List of StudentProviderEnrolment objects + properties: + StudentProviderEnrolment: + type: array + items: + required: + - EntryDate + - Provider + - Student + type: object + properties: + StudentProviderEnrolmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentProviderEnrolmentLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentProviderEnrolments/get/re\ + sponses/200/content/application~1json/schem\ + a/properties/StudentProviderEnrolments/prop\ + erties/StudentProviderEnrolment/items/prope\ + rties/StudentProviderEnrolmentRefId" + LocalId: + $ref: "#/paths/~1StudentProviderEnrolments/get/re\ + sponses/200/content/application~1json/schem\ + a/properties/StudentProviderEnrolments/prop\ + erties/StudentProviderEnrolment/items/prope\ + rties/StudentProviderEnrolmentLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentProviderEnrolments/get/respon\ + ses/200/content/application~1json/schema/proper\ + ties/StudentProviderEnrolments/properties/Stude\ + ntProviderEnrolment/items/properties/Student" + EntryDate: + type: string + format: date + description:

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.

+ ExitDate: + type: string + format: date + description:

The date of a student’s last attendance at + the provider.

+ Status: + type: string + title: Provider Enrolment Status + description: >- +

Records the status of a potentially + multi-year Provider enrolment, which goes + through a different life-cycle to the + single-year school enrolment.

    +
  • 'APP' - Application
    • +
  • 'ACC' - Accepted
    • +
  • 'CAN' - Cancelled
    • +
  • 'ACT' - Active
    • +
  • 'WIT' - Withdrawn
    • +
  • 'PEN' - Pending
    • +
+ oneOf: + - title: Application + description:

Student has applied to become a Student + at the Provider, this pre-enrolment has been + received, and is being processed by the + provider. It has not yet been accepted or + declined by the provider.

+ enum: + - APP + - title: Accepted + description:

The Provider has processed the + application, validated it against school + zoning rules, and other acceptance criteria. + The provider has accepted the enrolment and + will have a place for the Student if they + choose to take it up. Student has accepted + the enrolment and is expecting to take up + the enrolment at the agreed future date.

+ enum: + - ACC + - title: Cancelled + description:

The enrolment application has been + declined by the Provider, or discontinued by + the Student, prior to becoming an ACTIVE + enrolment.

+ enum: + - CAN + - title: Active + description:

The student has taken up the enrolment, + and has attended classes for the first + time.

+ enum: + - ACT + - title: Withdrawn + description: The Student has left the Provider, after the + enrolment was made ACTIVE + enum: + - WIT + - title: Pending + description:

The enrolment has been accepted by the + Provider, taken up by the Student, and the + student has attended their first day; but + the enrolment is unable to be set to ACTIVE, + because there is still an ACTIVE enrolment + for the student at a (previous) provider. + Once the blocking Provider has put their + enrolment to WITHDRAWN, this enrolment can + be moved to 'ACTIVE'.

+ enum: + - PEN + Exit: + description:

Details of the reasons, and interventions + leading up to the student's enrolment being + terminated.

+ type: object + required: + - ProviderExitType + - Reason + properties: + Reason: + type: string + title: Enrolment Exit Type + description: >- +

Enrolment Exit code, derived from code + set used in School Roll Returns.

    +
  • 'S' - Transferred to Another School in NZ
    • +
  • 'H' - Transferring to Home Schooling
    • +
  • 'O' - Gone Overseas
    • +
  • 'D' - Deceased
    • +
  • 'X' - Expulsion (for Students Aged Less Than 16)
    • +
  • 'L' - End of Schooling (for Students Aged 16 and Over Only)
    • +
  • 'E' - Granted Early Exemption (Applies to Those Less Than 16yrs Old)
    • +
  • 'K' - Exclusion (for Students Aged Less Than 16)
    • +
  • 'C' - Continuous Absence
    • +
  • 'J' - Eligibility Expired
    • +
  • 'P' - Caregiver Decision
    • +
+ oneOf: + - title: Transferred to Another School in NZ + description: Transferred to Another School in NZ + enum: + - S + - title: Transferring to Home Schooling + description: Transferred to Home Schooling + enum: + - H + - title: Gone Overseas + enum: + - O + - title: Deceased + enum: + - D + - title: Expulsion (for Students Aged Less Than + 16) + description: Only applies to students at least 16 + years old. + enum: + - X + - title: End of Schooling (for Students Aged 16 + and Over Only) + description: Only applies to students at least 16 + years old + enum: + - L + - title: Granted Early Exemption (Applies to + Those Less Than 16yrs Old) + description: Only applies to students less than 16 + years old + enum: + - E + - title: Exclusion (for Students Aged Less Than + 16) + description: Only applies to students less than 16 + years old + enum: + - K + - title: Continuous Absence + enum: + - C + - title: Eligibility Expired + enum: + - J + - title: Caregiver Decision + enum: + - P + PostSchoolActivity: + type: string + title: Post School Activity + description: >- +

The post school activity the student is + moving on to once they have exited the + school.

    +
  • 'ASC' - Another School
    • +
  • 'EMP' - Employment
    • +
  • 'IOT' - Institutes of Technology
    • +
  • 'MAI' - Modern Apprenticeships / Industry Training
    • +
  • 'PTR' - Private Training
    • +
  • 'TAC' - Trade Academies
    • +
  • 'UNI' - University
    • +
  • 'UNK' - Unknown
    • +
  • 'WAN' - Wananga
    • +
  • 'YGE' - Youth Guarantee
    • +
  • 'EFE' - Employment and Further Education / Training
    • +
  • 'FED' - Further Education or Training
    • +
plus 1 more value(s) at NZCodeSetsPostSchoolActivityType + oneOf: + - title: Another School + enum: + - ASC + - title: Employment + enum: + - EMP + - title: Institutes of Technology + enum: + - IOT + - title: Modern Apprenticeships / Industry + Training + enum: + - MAI + - title: Private Training + enum: + - PTR + - title: Trade Academies + enum: + - TAC + - title: University + enum: + - UNI + - title: Unknown + enum: + - UNK + - title: Wananga + enum: + - WAN + - title: Youth Guarantee + enum: + - YGE + - title: Employment and Further Education / + Training + enum: + - EFE + - title: Further Education or Training + enum: + - FED + - title: Other + enum: + - OTH + InterventionList: + description:

A list of references to Wellbeing Event, + Response & Appeal data objects, that record + the process of terminating a students + enrolment.

+ type: object + required: + - Intervention + properties: + Intervention: + type: array + items: + $ref: "#/paths/~1StudentProviderEnrolments/\ + get/responses/200/content/application\ + ~1json/schema/properties/StudentProvi\ + derEnrolments/properties/StudentProvi\ + derEnrolment/items/properties/Student" + PotentialDestinationSchool: + $ref: "#/paths/~1StudentProviderEnrolments/get/re\ + sponses/200/content/application~1json/schem\ + a/properties/StudentProviderEnrolments/prop\ + erties/StudentProviderEnrolment/items/prope\ + rties/Student" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + EarlyChildhoodEnrolment: + description:

Properties of an enrolment in an early + childhood service (WiP).

+ type: object + properties: + ECEType: + type: string + title: Early Childhood Education Type + description: >- +

The type of early childhood education the + student received.

    +
  • 'EKR' - Kohanga Reo
    • +
  • 'EPC' - Playcentre
    • +
  • 'EKE' - Kindergarden or Education and Care
    • +
  • 'EHB' - Home Based Service
    • +
  • 'EPG' - Playgroup or Pacific Islands EC Group
    • +
  • 'ECO' - The Correspondence School - Te Aho o Te Kura Pounamu
    • +
  • 'EOS' - Attended, but only outside New Zealand
    • +
  • 'ETU' - Attended, but don't know what type of service
    • +
  • 'ENA' - Did not attend
    • +
  • 'EUN' - Unable to establish if attended or not
    • +
+ oneOf: + - title: Kohanga Reo + enum: + - EKR + - title: Playcentre + enum: + - EPC + - title: Kindergarden or Education and Care + enum: + - EKE + - title: Home Based Service + enum: + - EHB + - title: Playgroup or Pacific Islands EC Group + enum: + - EPG + - title: The Correspondence School - Te Aho o Te + Kura Pounamu + enum: + - ECO + - title: Attended, but only outside New Zealand + enum: + - EOS + - title: Attended, but don't know what type of + service + enum: + - ETU + - title: Did not attend + enum: + - ENA + - title: Unable to establish if attended or not + enum: + - EUN + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + SchoolEnrolmentList: + description:

Properties of an enrolment in a school

+ type: object + required: + - SchoolEnrolment + properties: + SchoolEnrolment: + type: array + items: + description:

Defines information related to a + student's enrolment at a school education + Provider for a particular academic year + (or part thereof)

+ type: object + required: + - Curriculum + - CurriculumLevel + - MembershipType + properties: + SchoolCalendarYear: + description:

School year for which this + enrolment is applicable, expressed as + the four-digit year in which the + school year ends (eg 2018).

+ StartDate: + type: string + format: date + description:

The date the student started at + the school.

+ MembershipType: + type: string + title: School Enrolment Type + description: >- +

A type of student enrolment with a + school. Allows differentiation of + concurrent enrolments, eg base vs + other.

    +
  • 'BASE' - Base Enrolment
    • +
  • 'HOST' - Hosted Enrolment
    • +
  • 'REMO' - Remote/Distance Learning
    • +
+ oneOf: + - title: Base Enrolment + description:

The school that the student is + considered to be primarily + enrolled with, especially for the + purposes of reporting and Ministry + funding. Typically the student + will spend most of their school + time at this school.

+ enum: + - BASE + - title: Hosted Enrolment + description:

Indicates an enrolment that is + concurrent with the student's base + enrolment at another school.

+ enum: + - HOST + - title: Remote/Distance Learning + description:

Indicates an enrolment with a + school (typically Te Kura - The + Correspondence School) which + provides remote/distance learning; + this means that the student + remains at their base school (or + at home) for all classes covered + by this enrolment.

+ enum: + - REMO + YearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that + are valid for describing Funding Year + Level and Current Year Level for a + student enrolment.

Current Year + Level indicates the year level of the + student’s class cohort and the level + at which the student spends most of + their time at school. While a student + may be enrolled in subjects at varying + instructional year levels, in relation + to the student enrolment this value + represents the year level at which the + student is considered to be + predominantly taught.

Funding + Year Level measures the actual number + of years that the student has attended + a school. It provides the Ministry + with a method of counting students for + funding purposes which is independent + of the way schools are organised or + the particular programme of study that + a student may undertake. Funding Year + Level for most students is based on + the date they first started + school.

School Year Level is + used to indicate the instructional + year levels offered by a school, i.e. + those years for which student + enrolments may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code + indicates Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + EligibilityCriteria: + type: string + title: Eligibility Criteria + description: >- +

The criteria used to determine the + eligibility status of a student for + enrolment and MoE funding + purposes.

    +
  • 'NZC' - NZ Citizen (incl. TKL, COK, NIU)
    • +
  • 'AUC' - AU Citizen
    • +
  • 'NZR' - NZ Resident
    • +
  • 'IFP' - International Fee Paying
    • +
  • 'GAE' - Govt. Approved Exchange Scheme
    • +
  • 'DTB' - Domestic Time-bound
    • +
  • 'MOE' - MoE Approved
    • +
  • 'DAY' - 28 Day Waiver
    • +
  • 'EXT' - Extended 28 Day Waiver
    • +
+ oneOf: + - title: NZ Citizen (incl. TKL, COK, NIU) + enum: + - NZC + - title: AU Citizen + description: Includes Australian permanent + residents. + enum: + - AUC + - title: NZ Resident + enum: + - NZR + - title: International Fee Paying + enum: + - IFP + - title: Govt. Approved Exchange Scheme + enum: + - GAE + - title: Domestic Time-bound + enum: + - DTB + - title: MoE Approved + enum: + - MOE + - title: 28 Day Waiver + enum: + - DAY + - title: Extended 28 Day Waiver + enum: + - EXT + EligibilityVerification: + description:

Records how the Student's + eligibility to enrol / for funding was + verified by the school staff during + the enrolment process.

+ type: object + required: + - IsConfirmed + - Source + properties: + Source: + type: string + title: Verification Source + description: >- +

Records the source of the + identity or eligibility + verification, that has been made. + Mostly it is merely a record of + the kind of document that has been + presented; but occasionally it is + down to Principal or Ministry + discretion / approval.

    +
  • 'NZBIR' - NZ Birth Certificate
    • +
  • 'NZBCO' - NZ Birth Certificate (with confirmation of NZ Citizen by birth)
    • +
  • 'NZPAS' - NZ Passport
    • +
  • 'NZCIT' - NZ Citizenship Certificate
    • +
  • 'BIRCE' - Birth Certificate (COK, TKL, NIU)
    • +
  • 'BCCON' - Birth Certificate (COK, TKL, NIU) (with confirmation of NZ Citizen by birth)
    • +
  • 'CENAT' - Certification of Naturalisation (COK, TKL, NIU)
    • +
  • 'CAREG' - Certification of Registration (COK, TKL, NIU)
    • +
  • 'LETCO' - Letter of Confirmation (COK, TKL, NIU)
    • +
  • 'OTHPA' - Other Passport with NZ residence class Visa
    • +
  • 'AUSPA' - Australian Passport
    • +
  • 'VISDO' - Visa Domestic
    • +
plus 3 more value(s) at NZCodeSetsVerificationSourceType + oneOf: + - title: NZ Birth Certificate + description: Applies if the child was born + before 1 Jan 2006 + enum: + - NZBIR + - title: NZ Birth Certificate (with + confirmation of NZ Citizen by + birth) + description: Applies if the child was born + on or after 1 Jan 2006 + enum: + - NZBCO + - title: NZ Passport + description: Including COK, TKL or NIU. + (Current or Expired) + enum: + - NZPAS + - title: NZ Citizenship Certificate + enum: + - NZCIT + - title: Birth Certificate (COK, TKL, + NIU) + description: If the child was born before 1 + Jan 2006 + enum: + - BIRCE + - title: Birth Certificate (COK, TKL, + NIU) (with confirmation of NZ + Citizen by birth) + description: Applies if the child was born + on or after 1 Jan 2006. + enum: + - BCCON + - title: Certification of + Naturalisation (COK, TKL, NIU) + enum: + - CENAT + - title: Certification of Registration + (COK, TKL, NIU) + enum: + - CAREG + - title: Letter of Confirmation (COK, + TKL, NIU) + enum: + - LETCO + - title: Other Passport with NZ + residence class Visa + description: Or other evidence of NZ + residency + enum: + - OTHPA + - title: Australian Passport + description: (Current or Expired) + enum: + - AUSPA + - title: Visa Domestic + enum: + - VISDO + - title: Visa with conditions of study + enum: + - VISST + - title: Principal Discretion + enum: + - PRINC + - title: MoE Approval + enum: + - MOEAP + DocumentSerialNumber: + type: string + description:

The serial number on the + document that was used to verify + the name or birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document + that was used to verify the name + or birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has + been confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StudentProviderEnrolme\ + nts/get/responses/200/content/app\ + lication~1json/schema/properties/\ + StudentProviderEnrolments/propert\ + ies/StudentProviderEnrolment/item\ + s/properties/Student" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + FTE: + description:

Full-time equivalent numeric value + of the student's course load during + this enrollment, expressed in decimal + form, where 1.00 represents a + full-time enrolment.

+ FundingType: + type: string + title: Student Funding Type + description: >- +

Student classification for MoE + funding purposes.

Codes in this + list are hierarchical. Students can + only be allocated one TYPE code (even + though they may belong to more than + one of the groups listed below). To + allocate a code to an individual + student, start at the top of the list + and work down. Use the first code that + applies to the student.

    +
  • 'FF' - International Fee-Paying Student
    • +
  • 'AE' - Alternative Education Student
    • +
  • 'EX' - Exchange Student
    • +
  • 'NF' - Not Funded
    • +
  • 'RA' - Adult Student
    • +
  • 'AD' - Returning Adult Student
    • +
  • 'RE' - Regular Student
    • +
  • 'TPREOM' - Teen Parent Regular Student Over Maximum Roll
    • +
  • 'TPRAOM' - Teen Parent Adult Student Over Maximum Roll
    • +
  • 'TPAD' - Teen Parent Other Adult Student
    • +
  • 'TPRE' - Teen Parent Eligible and Enrolled Regular Student
    • +
  • 'TPRAE' - Teen Parent Enrolled Continuing Adult Student
    • +
plus 4 more value(s) at NZCodeSetsStudentFundingTypeType + oneOf: + - title: International Fee-Paying Student + description: An International student who meets + full tuition costs on their own or + from funds provided to them by + sponsors other than NZAID. + enum: + - FF + - title: Alternative Education Student + description: A student who is enrolled in an + Alternative Education programme, + for Funding Year Level they should + be reported only between Year 9 + and Year 13 (inclusive). + enum: + - AE + - title: Exchange Student + description: A student (and dependants) + studying in New Zealand under an + exchange programme approved by the + New Zealand Government. + enum: + - EX + - title: Not Funded + description: Code to be used for students + attending on Roll Count Day, but + not paying fee and not funded; + e.g. students with Eligibility + Criteria “28 Day Waiver” and + “Extended 28 Day Waiver”. + enum: + - NF + - title: Adult Student + description: '"A student who has continued at + school and is at least 19 on 1 + January of the Roll count year. + EXAMPLE: Roll count year = 2017 if + student is 19 years old on 1 + January 2017 their student type = + RA as there has not been a break + in the students learning cycle."' + enum: + - RA + - title: Returning Adult Student + description: '"A student who has returned to + school following a break of at + least 1 year and is at least 19 + years old on 1 January of the Roll + count year. EXAMPLE: Roll count + year = 2017 if student is 19 years + old on 1 Jan 2017 their student + type = AD if there has been a + break in their learning cycle."' + enum: + - AD + - title: Regular Student + description: A New Zealand student or a student + treated for funding and staffing + purposes as a New Zealand student + who is also not yet 19 years at 1 + Jan of the roll count year. This + includes students in general + classrooms and those in special + needs units. + enum: + - RE + - title: Teen Parent Regular Student Over + Maximum Roll + description: A regular student (i.e. a student + aged under 19 years at 1 January + of the roll count year) who meets + the eligibility criteria, but + whose enrolment would cause the + roll of the TPU to exceed the set + maximum. + enum: + - TPREOM + - title: Teen Parent Adult Student Over + Maximum Roll + description: An adult student who is enrolled + in a Teen Parent Unit (TPU) where + the enrolment at the TPU has + continued beyond the end of the + year in which the student reached + 19 years old. The enrolment of + this student causes the roll of + the TPU to exceed the set maximum. + enum: + - TPRAOM + - title: Teen Parent Other Adult Student + description: A student enrolling at the TPU as + an adult student (i.e. was at + least 19 on 1st January of the + year when they first enrolled at + the TPU), and who fits within the + TPU’s maximum roll. + enum: + - TPAD + - title: Teen Parent Eligible and Enrolled + Regular Student + description: A student who is enrolled in a + Teen Parent Unit (TPU) and is at + least 19 years old on 1 January of + the current year. These students + may continue to be enrolled in the + TPU after the end of the year in + which they turn 19, their Student + Type however will then be changed + to TPRAE – Teen Parent Enrolled + Continuing Adult Student. + enum: + - TPRE + - title: Teen Parent Enrolled Continuing + Adult Student + description: A student who is enrolled in a + Teen Parent Unit (TPU) where the + enrolment at the TPU has continued + beyond the end of the year in + which the student reached 19 years + old. + enum: + - TPRAE + - title: External Student + description: A student who attends this school + for some courses but is enrolled + at another school where a majority + of instruction occurs. + enum: + - EM + - title: Satellite Class Student + description: Student who is in a Satellite + class of a Special School. + enum: + - SA + - title: Not Attending + description: A student who is not attending the + school on the day of the roll + count and there is no + documentation to support their + absence from the school. + enum: + - NA + - title: Separately Funded + description: Student is enrolled in a + separately funded unit. + enum: + - SF + FundingYearLevel: + $ref: "#/paths/~1StudentProviderEnrolments/\ + get/responses/200/content/application\ + ~1json/schema/properties/StudentProvi\ + derEnrolments/properties/StudentProvi\ + derEnrolment/items/properties/SchoolE\ + nrolmentList/properties/SchoolEnrolme\ + nt/items/properties/YearLevel" + Curriculum: + type: string + title: Curriculum + description: >- +

Codes denoting the two curricula + used in New Zealand.

    +
  • 'NZC' - NZ Curriculum
    • +
  • 'TMA' - Te Marautanga o Aotearoa
    • +
  • 'ECE' - Te Whaariki
    • +
  • 'OTH' - Other Curriculum
    • +
+ oneOf: + - title: NZ Curriculum + enum: + - NZC + - title: Te Marautanga o Aotearoa + enum: + - TMA + - title: Te Whaariki + enum: + - ECE + - title: Other Curriculum + enum: + - OTH + CurriculumLevel: + type: integer + description:

Which level of the National + Curriculum (1-5) is the student + enrolling in?

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + LanguageOfInstructionList: + description:

How much instruction has the + student received in which + languages?

+ type: object + required: + - Language + properties: + Language: + type: array + items: + description:

The number of hours per week + the Learner is taught in a + specific language during the + enrolment.

+ type: object + required: + - Code + - LanguageOfInstructionType + - Level + properties: + Code: + type: string + title: Language + description: >- +

Language refers to + recognised human + communication systems, + typically oral and/or + written. Sourced from + Statistics NZ - Language + Standard Classification 1999 + v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not + further defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not + elsewhere classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not + further defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not + elsewhere classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further + defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere + classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further + defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere + classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further + defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere + classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further + defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere + classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further + defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere + classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further + defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere + classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further + defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not + elsewhere classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further + defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere + classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further + defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere + classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further + defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere + classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not + further defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not + elsewhere classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further + defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere + classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further + defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere + classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further + defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere + classified + enum: + - NZS15199 + - title: Central-Eastern + Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not + further defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not + elsewhere classified + enum: + - NZS16199 + - title: Solomon Islands + Languages + (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands + Languages + (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further + defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not + elsewhere classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western + Malayo-Polynesian not + further defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western + Malayo-Polynesian not + elsewhere classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further + defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere + classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further + defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere + classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further + defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere + classified + enum: + - NZS18399 + - title: Niger-Congo + (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere + classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not + further defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not + elsewhere classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not + further defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not + elsewhere classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not + elsewhere classified + enum: + - NZS219 + - title: Language Isolates not + elsewhere classified + enum: + - NZS21999 + - title: Miscellaneous Language + Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further + defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere + classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous + Languages + enum: + - NZS229 + - title: Other Miscellaneous + Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not + further defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not + elsewhere classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not + further defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not + elsewhere classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to + talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + Level: + description:

The level of instruction + that is made in the selected + language.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + TimeInImmersion: + type: integer + description:

The number of years the student has + been in Te Reo Māori immersion + education.

+ Section9Agreement: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, + unknown and not provided values.

+
    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + OngoingResourceScheme: + type: string + title: Ongoing Resource Scheme + description: >- +

Codes denoting the level of ORS + funding a student may receive.

+
    +
  • 'H' - High
    • +
  • 'V' - Very High
    • +
  • 'E' - Extension
    • +
+ oneOf: + - title: High + enum: + - H + - title: Very High + enum: + - V + - title: Extension + enum: + - E + SubjectChoiceList: + description:

Student’s choice of general + subjects and learning areas to be + studied during the school year. Not to + be confused with CourseChoiceList + which allows students to choose + specific courses.

+ type: object + required: + - StudentSubjectChoice + properties: + StudentSubjectChoice: + type: array + items: + description:

An individual Subject choice + that can be made, or has been + made by a Student.

+ type: object + required: + - Code + properties: + PreferenceNumber: + type: integer + description:

The student's preference + for this subject, with + respect to the other subject + choices in the list.

+ Code: + type: string + title: Subject Area + description: >- +

Codes denoting Subject + Areas defined by the NZ + Curriculum and Te Marautanga + o Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - title: German + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + enum: + - GERM + - title: Indonesian + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + enum: + - INDO + - title: Japanese + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + enum: + - JAPA + - title: French + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + enum: + - FREN + - title: English (Remedial) + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + enum: + - REME + - title: English + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + enum: + - ENGL + - title: Cook Island Maori + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + enum: + - COOK + - title: Communication Skills + description: Applicable to Te + Marautanga o Aotearoa + enum: + - COMM + - title: Chinese + description: Applicable to Te + Marautanga o Aotearoa + enum: + - CHIN + - title: Korean + enum: + - KORE + - title: Latin + enum: + - LATI + - title: Niuean + enum: + - NIUE + - title: Other Languages + enum: + - OLAN + - title: Pacific Language Studies + enum: + - PLAN + - title: Russian + enum: + - RUSS + - title: Samoan + enum: + - SAMO + - title: Spanish + enum: + - SPAN + - title: Te Reo Māori + enum: + - MAOR + - title: Te Reo Rangatira + enum: + - RANG + - title: Tokelauan + enum: + - TOKE + - title: Tongan + enum: + - TONG + - title: English as a Second + Language + enum: + - ENSL + - title: Mathematics + enum: + - MATH + - title: Mathematics with Calculus + enum: + - MATC + - title: Mathematics with + Statistics + enum: + - MATS + - title: Mathematics (Remedial) + enum: + - REMM + - title: Accounting + enum: + - ACCO + - title: Science + enum: + - SCIE + - title: Agriculture / + Horticulture + enum: + - AGHO + - title: Biology / Biological + Science + enum: + - BIOL + - title: Chemsitry + enum: + - CHEM + - title: Earth Science / Astronomy + enum: + - EAAS + - title: Human Biology + enum: + - HUMB + - title: Physics + enum: + - PHYS + - title: Technology + enum: + - TECN + - title: Biotechnology + enum: + - BITE + - title: Computer Science / + Programming + enum: + - COSC + - title: Computer Studies + enum: + - COMP + - title: Design, Drawing and + Graphics + enum: + - DEST + - title: Electronics and Control + enum: + - ELTE + - title: Food Technology + enum: + - FOTE + - title: Graphics + enum: + - GRAP + - title: Information and + Communication Technology + enum: + - INTE + - title: Materials Technology + enum: + - MTEC + - title: Structures and Mechanisms + enum: + - STME + - title: Test and Information + Management + enum: + - TIMA + - title: Textiles / Clothing + enum: + - CLTX + - title: The Arts + enum: + - ARTA + - title: Art Design + enum: + - ARTD + - title: Art History + enum: + - ARTH + - title: Dancing + enum: + - DANC + - title: Drama + enum: + - DRAM + - title: Music / Music Studies + enum: + - MUSC + - title: Music Practical / + Performance + enum: + - MUSP + - title: Painting + enum: + - ARPA + - title: Performing Arts + enum: + - APER + - title: Photography + enum: + - ARTP + - title: Printmaking + enum: + - ARPR + - title: Sculpture + enum: + - ARTS + - title: Visial Arts + enum: + - ARTC + - title: Social Studies + enum: + - SOST + - title: Classics / Classical + Studies + enum: + - CLST + - title: Community Studies + enum: + - CMTY + - title: Economics + enum: + - ECON + - title: Environmental + Sustainability + enum: + - SENV + - title: Geography + enum: + - GEOG + - title: History + enum: + - HIST + - title: Language and Cultural + Studies + enum: + - LACU + - title: Māori Studies + enum: + - MAOS + - title: Media Studies + enum: + - MEST + - title: Other Social Sciences + enum: + - SOSC + - title: Health and Physical + Education + enum: + - HEPH + - title: Health + enum: + - HEED + - title: Home Economics + enum: + - HOME + - title: Outdoor Education + enum: + - OUED + - title: Physical Education + enum: + - PHED + - title: Sports Studies + enum: + - SPOR + - title: Commerce Related + enum: + - BUSS + - title: Defence + enum: + - DEFE + - title: Equestrian + enum: + - EQUE + - title: Farming + enum: + - FARM + - title: Fishing + enum: + - FISH + - title: Forestry + enum: + - FOTY + - title: Industrial Trades + enum: + - INTR + - title: Integrated Studies + enum: + - INTS + - title: Legal / Law Related + Studies + enum: + - LAWS + - title: Life Skills / Personal + Development + enum: + - LIFE + - title: Religious Education / + Studies + enum: + - REST + - title: Remedial Studies + enum: + - REMS + - title: Secondary Tertiary + Programme + enum: + - STPR + - title: Service Trades + enum: + - SETR + - title: Special Needs Programme + enum: + - SPPR + - title: Study Skills + enum: + - STDY + - title: Transition / + Pre-Employment + enum: + - TRAN + - title: Travel, Hospitality, + Tourism + enum: + - THTR + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + CourseChoiceList: + description:

Student’s choice of courses to be + studied during the school year. Not to + be confused with SubjectChoiceList + which allows students to choose + general subjects and learning areas + rather than specific courses.

+ type: object + required: + - StudentCourseChoice + properties: + StudentCourseChoice: + type: array + items: + description:

An individual Course choice + that can be made, or has been + made by a Student.

+ type: object + required: + - Course + properties: + PreferenceNumber: + type: integer + description:

The student's preference + for this course, with + respect to the other course + choices in the list.

+ Course: + $ref: "#/paths/~1StudentProviderE\ + nrolments/get/responses/200\ + /content/application~1json/\ + schema/properties/StudentPr\ + oviderEnrolments/properties\ + /StudentProviderEnrolment/i\ + tems/properties/Student" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + CoEnrolment: + description:

Describes the student's enrolment + with their base school in the case + where this enrolment is not a base + school enrolment.

+ type: object + required: + - OtherProvider + properties: + OtherProvider: + $ref: "#/paths/~1StudentProviderEnrolme\ + nts/get/responses/200/content/app\ + lication~1json/schema/properties/\ + StudentProviderEnrolments/propert\ + ies/StudentProviderEnrolment/item\ + s/properties/Student" + CoEnrolmentType: + type: string + title: CoEnrolment Type + description: |- +

    +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Other + enum: + - OTH + BehaviouralKeyIssuesNote: + type: string + description:

Free text note of key + behavioural issues, made by the + client school in relation to the + student.

+ ClientSchoolConfidentialNote: + type: string + description:

Free text confidential note + made by the client school in + relation to the student.

+ GuardianConfidentialNote: + type: string + description:

Free text confidential note + made by the parents/caregivers of + the student.

+ InternationalEnrolment: + description:

Additional information collected + for international enrolments.

+ type: object + properties: + NZArrivalDate: + type: string + format: date + description:

The date the Student arrived in + New Zealand.

+ TuitionWeeklyFee: + description:

The amount paid by the Student + per Week (GST excl) as a tuition + fee.

+ ExchangeScheme: + type: string + title: Exchange Scheme + description: >- +

The type of exchange scheme for + student enrolment where the + Eligibility Criteria is "Student + on Government approved exchange + scheme" (5).

    +
  • 'AFS' - AFS Intercultural Programmes NZ Inc.
    • +
  • 'GSE' - NZ / German Student Exchange
    • +
  • 'IIU' - NZ Institute of International Understanding
    • +
  • 'RIN' - Rotary International NZ
    • +
  • 'STS' - STS High School Foundation
    • +
  • 'YFU' - YFU New Zealand Inc.
    • +
  • 'WYS' - World Youth Service Society (WYSS)
    • +
  • 'STA' - Student Exchange Australia New Zealand Ltd.
    • +
  • 'TAE' - Tahiti Exchange
    • +
  • 'NGE' - NZ - Germany Exchange - Düsseldorf
    • +
  • 'YED' - Your Education
    • +
  • 'NSE' - NZ Switzerland Exchange
    • +
plus 1 more value(s) at NZCodeSetsExchangeSchemeType + oneOf: + - title: AFS Intercultural Programmes + NZ Inc. + enum: + - AFS + - title: NZ / German Student Exchange + enum: + - GSE + - title: NZ Institute of International + Understanding + enum: + - IIU + - title: Rotary International NZ + enum: + - RIN + - title: STS High School Foundation + enum: + - STS + - title: YFU New Zealand Inc. + enum: + - YFU + - title: World Youth Service Society + (WYSS) + enum: + - WYS + - title: Student Exchange Australia New + Zealand Ltd. + enum: + - STA + - title: Tahiti Exchange + enum: + - TAE + - title: NZ - Germany Exchange - + Düsseldorf + enum: + - NGE + - title: Your Education + enum: + - YED + - title: NZ Switzerland Exchange + enum: + - NSE + - title: Exchange Agreement + enum: + - EXA + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + StudentConsentList: + description:

A list of student consent + information.

+ type: object + required: + - StudentConsent + properties: + StudentConsent: + type: array + items: + $ref: "#/paths/~1StudentProviderEnrol\ + ments/get/responses/200/content\ + /application~1json/schema/prope\ + rties/StudentProviderEnrolments\ + /properties/StudentProviderEnro\ + lment/items/properties/Student" + AcademicAttainmentGoalList: + description:

The academic attainment goals of + the student when they enrol, e.g. they + wish to achieve a certain + qualification.

+ type: object + required: + - AttainmentGoal + properties: + AttainmentGoal: + type: array + items: + $ref: "#/paths/~1StudentProviderEnrol\ + ments/get/responses/200/content\ + /application~1json/schema/prope\ + rties/StudentProviderEnrolments\ + /properties/StudentProviderEnro\ + lment/items/properties/Student" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + PreEnrolmentCancellation: + description:

Details of why the school + pre-enrolment was cancelled.

+ type: object + properties: + NotifiedDate: + type: string + format: date + description:

The date the Student was + notified of the cancellation of + the pre-enrolment.

+ CancellationMethod: + type: string + title: Pre Enrolment Exit Type + description: >- +

Code set denoting how the + student's pre-enrolment was + cancelled.

    +
  • 'A' - Automated
    • +
  • 'M' - Manual
    • +
+ oneOf: + - title: Automated + enum: + - A + - title: Manual + enum: + - M + CancellationReason: + type: string + title: Pre Enrolment Cancellation Reason + description: >- +

Code set denoting why the + student's pre-enrolment was + cancelled.

    +
  • 'SIE' - Student Incorrectly Enrolled
    • +
  • 'SDE' - Student Declined Enrolment
    • +
  • 'DEC' - Deceased
    • +
  • 'OTH' - Other - Please Specify
    • +
+ oneOf: + - title: Student Incorrectly Enrolled + enum: + - SIE + - title: Student Declined Enrolment + enum: + - SDE + - title: Deceased + enum: + - DEC + - title: Other - Please Specify + enum: + - OTH + CancellationReasonOtherDesc: + $ref: "#/paths/~1StudentProviderEnrolme\ + nts/get/responses/200/content/app\ + lication~1json/schema/properties/\ + StudentProviderEnrolments/propert\ + ies/StudentProviderEnrolment/item\ + s/properties/SchoolEnrolmentList/\ + properties/SchoolEnrolment/items/\ + properties/PreEnrolmentCancellati\ + on/properties/CancellationReason" + TertiaryEducationEnrolment: + description:

Properties of an enrolment in a Tertiary + Education service (WiP).

+ type: object + required: + - Type + properties: + Type: + type: string + description:

The type of tertiary education the + student is enrolling in.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + description:

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.

+ x-accessControl: + create: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + read: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + update: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentProviderEnrolments: + StudentProviderEnrolment: + - StudentProviderEnrolmentRefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + StudentProviderEnrolmentLocalId: 2004H102 + Student: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1652 + Provider: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1651 + EntryDate: 2018-01-29 + Status: WIT + SchoolEnrolmentList: + SchoolEnrolment: + 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 + FundingType: EX + FundingYearLevel: 1 + Curriculum: NZC + CurriculumLevel: 5 + InternationalEnrolment: + NZArrivalDate: 2018-05-02 + ExchangeScheme: STA + application/xml: + schema: + type: object + properties: + StudentProviderEnrolments: + type: object + description: A List of StudentProviderEnrolment objects + properties: + StudentProviderEnrolment: + type: array + items: + $ref: "#/paths/~1StudentProviderEnrolments/get/responses/\ + 200/content/application~1json/schema/properties/Stu\ + dentProviderEnrolments/properties/StudentProviderEn\ + rolment/items" + example: >- + + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 2004H102 + + d3e34b35-9d75-101a-8c3d-00aa001a1652 + + + d3e34b35-9d75-101a-8c3d-00aa001a1651 + + 2018-01-29 + WIT + + + 2018 + BASE + 11 + GAE + + AUSPA + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + 1.0 + EX + 1 + NZC + 5 + + 2018-05-02 + STA + + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentProviderEnrolments/{StudentProviderEnrolmentRefId}": + post: + tags: + - StudentProviderEnrolment + summary: Default operation to create a single StudentProviderEnrolment + parameters: + - name: StudentProviderEnrolmentRefId + in: path + description:

The SIF GUID for the student provider enrolment.

+ required: true + schema: + type: string + operationId: createStudentProviderEnrolment + requestBody: + description: CRUD operation on StudentProviderEnrolment + content: + application/json: + schema: + type: object + properties: + StudentProviderEnrolment: + $ref: "#/paths/~1StudentProviderEnrolments/get/responses/200/cont\ + ent/application~1json/schema/properties/StudentProviderEnro\ + lments/properties/StudentProviderEnrolment/items" + example: + StudentProviderEnrolment: + StudentProviderEnrolmentRefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + StudentProviderEnrolmentLocalId: 2004H102 + Student: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1652 + Provider: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1651 + EntryDate: 2018-01-29 + Status: WIT + SchoolEnrolmentList: + SchoolEnrolment: + 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 + FundingType: EX + FundingYearLevel: 1 + Curriculum: NZC + CurriculumLevel: 5 + InternationalEnrolment: + NZArrivalDate: 2018-05-02 + ExchangeScheme: STA + application/xml: + schema: + type: object + properties: + StudentProviderEnrolment: + $ref: "#/paths/~1StudentProviderEnrolments/get/responses/200/cont\ + ent/application~1json/schema/properties/StudentProviderEnro\ + lments/properties/StudentProviderEnrolment/items" + example: >- + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 2004H102 + + d3e34b35-9d75-101a-8c3d-00aa001a1652 + + + d3e34b35-9d75-101a-8c3d-00aa001a1651 + + 2018-01-29 + WIT + + + 2018 + BASE + 11 + GAE + + AUSPA + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + 1.0 + EX + 1 + NZC + 5 + + 2018-05-02 + STA + + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentProviderEnrolment + summary: Default operation to update a single StudentProviderEnrolment + parameters: + - name: StudentProviderEnrolmentRefId + in: path + description:

The SIF GUID for the student provider enrolment.

+ required: true + schema: + type: string + operationId: updateStudentProviderEnrolment + requestBody: + description: CRUD operation on StudentProviderEnrolment + content: + application/json: + schema: + type: object + properties: + StudentProviderEnrolment: + type: object + properties: + StudentProviderEnrolmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentProviderEnrolmentLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentProviderEnrolments~1%7BStudentPro\ + viderEnrolmentRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/StudentProviderEnro\ + lment/properties/StudentProviderEnrolmentRefId" + LocalId: + $ref: "#/paths/~1StudentProviderEnrolments~1%7BStudentPro\ + viderEnrolmentRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/StudentProviderEnro\ + lment/properties/StudentProviderEnrolmentLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentProviderEnrolments~1%7BStudentProvide\ + rEnrolmentRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/StudentProviderEnrolment/proper\ + ties/Student" + EntryDate: + type: string + format: date + description:

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.

+ ExitDate: + type: string + format: date + description:

The date of a student’s last attendance at the + provider.

+ Status: + type: string + title: Provider Enrolment Status + description: >- +

Records the status of a potentially multi-year + Provider enrolment, which goes through a different + life-cycle to the single-year school enrolment.

    +
  • 'APP' - Application
    • +
  • 'ACC' - Accepted
    • +
  • 'CAN' - Cancelled
    • +
  • 'ACT' - Active
    • +
  • 'WIT' - Withdrawn
    • +
  • 'PEN' - Pending
    • +
+ oneOf: + - title: Application + description:

Student has applied to become a Student at the + Provider, this pre-enrolment has been received, and + is being processed by the provider. It has not yet + been accepted or declined by the provider.

+ enum: + - APP + - title: Accepted + description:

The Provider has processed the application, + validated it against school zoning rules, and other + acceptance criteria. The provider has accepted the + enrolment and will have a place for the Student if + they choose to take it up. Student has accepted the + enrolment and is expecting to take up the enrolment + at the agreed future date.

+ enum: + - ACC + - title: Cancelled + description:

The enrolment application has been declined by + the Provider, or discontinued by the Student, prior + to becoming an ACTIVE enrolment.

+ enum: + - CAN + - title: Active + description:

The student has taken up the enrolment, and has + attended classes for the first time.

+ enum: + - ACT + - title: Withdrawn + description: The Student has left the Provider, after the + enrolment was made ACTIVE + enum: + - WIT + - title: Pending + description:

The enrolment has been accepted by the Provider, + taken up by the Student, and the student has + attended their first day; but the enrolment is + unable to be set to ACTIVE, because there is still + an ACTIVE enrolment for the student at a (previous) + provider. Once the blocking Provider has put their + enrolment to WITHDRAWN, this enrolment can be moved + to 'ACTIVE'.

+ enum: + - PEN + Exit: + description:

Details of the reasons, and interventions leading up + to the student's enrolment being terminated.

+ type: object + properties: + Reason: + type: string + title: Enrolment Exit Type + description: >- +

Enrolment Exit code, derived from code set used + in School Roll Returns.

    +
  • 'S' - Transferred to Another School in NZ
    • +
  • 'H' - Transferring to Home Schooling
    • +
  • 'O' - Gone Overseas
    • +
  • 'D' - Deceased
    • +
  • 'X' - Expulsion (for Students Aged Less Than 16)
    • +
  • 'L' - End of Schooling (for Students Aged 16 and Over Only)
    • +
  • 'E' - Granted Early Exemption (Applies to Those Less Than 16yrs Old)
    • +
  • 'K' - Exclusion (for Students Aged Less Than 16)
    • +
  • 'C' - Continuous Absence
    • +
  • 'J' - Eligibility Expired
    • +
  • 'P' - Caregiver Decision
    • +
+ oneOf: + - title: Transferred to Another School in NZ + description: Transferred to Another School in NZ + enum: + - S + - title: Transferring to Home Schooling + description: Transferred to Home Schooling + enum: + - H + - title: Gone Overseas + enum: + - O + - title: Deceased + enum: + - D + - title: Expulsion (for Students Aged Less Than 16) + description: Only applies to students at least 16 years old. + enum: + - X + - title: End of Schooling (for Students Aged 16 and Over + Only) + description: Only applies to students at least 16 years old + enum: + - L + - title: Granted Early Exemption (Applies to Those Less + Than 16yrs Old) + description: Only applies to students less than 16 years old + enum: + - E + - title: Exclusion (for Students Aged Less Than 16) + description: Only applies to students less than 16 years old + enum: + - K + - title: Continuous Absence + enum: + - C + - title: Eligibility Expired + enum: + - J + - title: Caregiver Decision + enum: + - P + PostSchoolActivity: + type: string + title: Post School Activity + description: >- +

The post school activity the student is moving on + to once they have exited the school.

    +
  • 'ASC' - Another School
    • +
  • 'EMP' - Employment
    • +
  • 'IOT' - Institutes of Technology
    • +
  • 'MAI' - Modern Apprenticeships / Industry Training
    • +
  • 'PTR' - Private Training
    • +
  • 'TAC' - Trade Academies
    • +
  • 'UNI' - University
    • +
  • 'UNK' - Unknown
    • +
  • 'WAN' - Wananga
    • +
  • 'YGE' - Youth Guarantee
    • +
  • 'EFE' - Employment and Further Education / Training
    • +
  • 'FED' - Further Education or Training
    • +
plus 1 more value(s) at NZCodeSetsPostSchoolActivityType + oneOf: + - title: Another School + enum: + - ASC + - title: Employment + enum: + - EMP + - title: Institutes of Technology + enum: + - IOT + - title: Modern Apprenticeships / Industry Training + enum: + - MAI + - title: Private Training + enum: + - PTR + - title: Trade Academies + enum: + - TAC + - title: University + enum: + - UNI + - title: Unknown + enum: + - UNK + - title: Wananga + enum: + - WAN + - title: Youth Guarantee + enum: + - YGE + - title: Employment and Further Education / Training + enum: + - EFE + - title: Further Education or Training + enum: + - FED + - title: Other + enum: + - OTH + InterventionList: + description:

A list of references to Wellbeing Event, Response + & Appeal data objects, that record the process of + terminating a students enrolment.

+ type: object + properties: + Intervention: + type: array + items: + $ref: "#/paths/~1StudentProviderEnrolments~1%7BStud\ + entProviderEnrolmentRefId%7D/put/requestBody/\ + content/application~1json/schema/properties/S\ + tudentProviderEnrolment/properties/Student" + PotentialDestinationSchool: + $ref: "#/paths/~1StudentProviderEnrolments~1%7BStudentPro\ + viderEnrolmentRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/StudentProviderEnro\ + lment/properties/Student" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + EarlyChildhoodEnrolment: + description:

Properties of an enrolment in an early childhood + service (WiP).

+ type: object + properties: + ECEType: + type: string + title: Early Childhood Education Type + description: >- +

The type of early childhood education the student + received.

    +
  • 'EKR' - Kohanga Reo
    • +
  • 'EPC' - Playcentre
    • +
  • 'EKE' - Kindergarden or Education and Care
    • +
  • 'EHB' - Home Based Service
    • +
  • 'EPG' - Playgroup or Pacific Islands EC Group
    • +
  • 'ECO' - The Correspondence School - Te Aho o Te Kura Pounamu
    • +
  • 'EOS' - Attended, but only outside New Zealand
    • +
  • 'ETU' - Attended, but don't know what type of service
    • +
  • 'ENA' - Did not attend
    • +
  • 'EUN' - Unable to establish if attended or not
    • +
+ oneOf: + - title: Kohanga Reo + enum: + - EKR + - title: Playcentre + enum: + - EPC + - title: Kindergarden or Education and Care + enum: + - EKE + - title: Home Based Service + enum: + - EHB + - title: Playgroup or Pacific Islands EC Group + enum: + - EPG + - title: The Correspondence School - Te Aho o Te Kura + Pounamu + enum: + - ECO + - title: Attended, but only outside New Zealand + enum: + - EOS + - title: Attended, but don't know what type of service + enum: + - ETU + - title: Did not attend + enum: + - ENA + - title: Unable to establish if attended or not + enum: + - EUN + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + SchoolEnrolmentList: + description:

Properties of an enrolment in a school

+ type: object + properties: + SchoolEnrolment: + type: array + items: + description:

Defines information related to a student's + enrolment at a school education Provider for a + particular academic year (or part thereof)

+ type: object + properties: + SchoolCalendarYear: + description:

School year for which this enrolment is + applicable, expressed as the four-digit year + in which the school year ends (eg 2018).

+ StartDate: + type: string + format: date + description:

The date the student started at the + school.

+ MembershipType: + type: string + title: School Enrolment Type + description: >- +

A type of student enrolment with a school. + Allows differentiation of concurrent + enrolments, eg base vs other.

    +
  • 'BASE' - Base Enrolment
    • +
  • 'HOST' - Hosted Enrolment
    • +
  • 'REMO' - Remote/Distance Learning
    • +
+ oneOf: + - title: Base Enrolment + description:

The school that the student is + considered to be primarily enrolled with, + especially for the purposes of reporting + and Ministry funding. Typically the + student will spend most of their school + time at this school.

+ enum: + - BASE + - title: Hosted Enrolment + description:

Indicates an enrolment that is + concurrent with the student's base + enrolment at another school.

+ enum: + - HOST + - title: Remote/Distance Learning + description:

Indicates an enrolment with a school + (typically Te Kura - The Correspondence + School) which provides remote/distance + learning; this means that the student + remains at their base school (or at home) + for all classes covered by this + enrolment.

+ enum: + - REMO + YearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are + valid for describing Funding Year Level and + Current Year Level for a student + enrolment.

Current Year Level indicates + the year level of the student’s class cohort + and the level at which the student spends most + of their time at school. While a student may + be enrolled in subjects at varying + instructional year levels, in relation to the + student enrolment this value represents the + year level at which the student is considered + to be predominantly taught.

Funding + Year Level measures the actual number of years + that the student has attended a school. It + provides the Ministry with a method of + counting students for funding purposes which + is independent of the way schools are + organised or the particular programme of study + that a student may undertake. Funding Year + Level for most students is based on the date + they first started school.

School Year + Level is used to indicate the instructional + year levels offered by a school, i.e. those + years for which student enrolments may be + accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates + Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + EligibilityCriteria: + type: string + title: Eligibility Criteria + description: >- +

The criteria used to determine the + eligibility status of a student for enrolment + and MoE funding purposes.

    +
  • 'NZC' - NZ Citizen (incl. TKL, COK, NIU)
    • +
  • 'AUC' - AU Citizen
    • +
  • 'NZR' - NZ Resident
    • +
  • 'IFP' - International Fee Paying
    • +
  • 'GAE' - Govt. Approved Exchange Scheme
    • +
  • 'DTB' - Domestic Time-bound
    • +
  • 'MOE' - MoE Approved
    • +
  • 'DAY' - 28 Day Waiver
    • +
  • 'EXT' - Extended 28 Day Waiver
    • +
+ oneOf: + - title: NZ Citizen (incl. TKL, COK, NIU) + enum: + - NZC + - title: AU Citizen + description: Includes Australian permanent residents. + enum: + - AUC + - title: NZ Resident + enum: + - NZR + - title: International Fee Paying + enum: + - IFP + - title: Govt. Approved Exchange Scheme + enum: + - GAE + - title: Domestic Time-bound + enum: + - DTB + - title: MoE Approved + enum: + - MOE + - title: 28 Day Waiver + enum: + - DAY + - title: Extended 28 Day Waiver + enum: + - EXT + EligibilityVerification: + description:

Records how the Student's eligibility to + enrol / for funding was verified by the school + staff during the enrolment process.

+ type: object + properties: + Source: + type: string + title: Verification Source + description: >- +

Records the source of the identity or + eligibility verification, that has been + made. Mostly it is merely a record of the + kind of document that has been presented; + but occasionally it is down to Principal + or Ministry discretion / approval.

+
    +
  • 'NZBIR' - NZ Birth Certificate
    • +
  • 'NZBCO' - NZ Birth Certificate (with confirmation of NZ Citizen by birth)
    • +
  • 'NZPAS' - NZ Passport
    • +
  • 'NZCIT' - NZ Citizenship Certificate
    • +
  • 'BIRCE' - Birth Certificate (COK, TKL, NIU)
    • +
  • 'BCCON' - Birth Certificate (COK, TKL, NIU) (with confirmation of NZ Citizen by birth)
    • +
  • 'CENAT' - Certification of Naturalisation (COK, TKL, NIU)
    • +
  • 'CAREG' - Certification of Registration (COK, TKL, NIU)
    • +
  • 'LETCO' - Letter of Confirmation (COK, TKL, NIU)
    • +
  • 'OTHPA' - Other Passport with NZ residence class Visa
    • +
  • 'AUSPA' - Australian Passport
    • +
  • 'VISDO' - Visa Domestic
    • +
plus 3 more value(s) at NZCodeSetsVerificationSourceType + oneOf: + - title: NZ Birth Certificate + description: Applies if the child was born before 1 + Jan 2006 + enum: + - NZBIR + - title: NZ Birth Certificate (with + confirmation of NZ Citizen by birth) + description: Applies if the child was born on or + after 1 Jan 2006 + enum: + - NZBCO + - title: NZ Passport + description: Including COK, TKL or NIU. (Current or + Expired) + enum: + - NZPAS + - title: NZ Citizenship Certificate + enum: + - NZCIT + - title: Birth Certificate (COK, TKL, NIU) + description: If the child was born before 1 Jan 2006 + enum: + - BIRCE + - title: Birth Certificate (COK, TKL, NIU) + (with confirmation of NZ Citizen by + birth) + description: Applies if the child was born on or + after 1 Jan 2006. + enum: + - BCCON + - title: Certification of Naturalisation (COK, + TKL, NIU) + enum: + - CENAT + - title: Certification of Registration (COK, + TKL, NIU) + enum: + - CAREG + - title: Letter of Confirmation (COK, TKL, NIU) + enum: + - LETCO + - title: Other Passport with NZ residence class + Visa + description: Or other evidence of NZ residency + enum: + - OTHPA + - title: Australian Passport + description: (Current or Expired) + enum: + - AUSPA + - title: Visa Domestic + enum: + - VISDO + - title: Visa with conditions of study + enum: + - VISST + - title: Principal Discretion + enum: + - PRINC + - title: MoE Approval + enum: + - MOEAP + DocumentSerialNumber: + type: string + description:

The serial number on the document that + was used to verify the name or + birthdate.

+ DocumentExpiryDate: + type: string + format: date + description:

The expiry date on the document that + was used to verify the name or + birthdate.

+ IsConfirmed: + type: boolean + description:

If true then verification has been + confirmed by MoE.

+ Timestamp: + description:

The date & time that the + VerificationEvent took place.

+ Provider: + $ref: "#/paths/~1StudentProviderEnrolments~1%7B\ + StudentProviderEnrolmentRefId%7D/put/requ\ + estBody/content/application~1json/schema/\ + properties/StudentProviderEnrolment/prope\ + rties/Student" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + FTE: + description:

Full-time equivalent numeric value of the + student's course load during this enrollment, + expressed in decimal form, where 1.00 + represents a full-time enrolment.

+ FundingType: + type: string + title: Student Funding Type + description: >- +

Student classification for MoE funding + purposes.

Codes in this list are + hierarchical. Students can only be allocated + one TYPE code (even though they may belong to + more than one of the groups listed below). To + allocate a code to an individual student, + start at the top of the list and work down. + Use the first code that applies to the + student.

    +
  • 'FF' - International Fee-Paying Student
    • +
  • 'AE' - Alternative Education Student
    • +
  • 'EX' - Exchange Student
    • +
  • 'NF' - Not Funded
    • +
  • 'RA' - Adult Student
    • +
  • 'AD' - Returning Adult Student
    • +
  • 'RE' - Regular Student
    • +
  • 'TPREOM' - Teen Parent Regular Student Over Maximum Roll
    • +
  • 'TPRAOM' - Teen Parent Adult Student Over Maximum Roll
    • +
  • 'TPAD' - Teen Parent Other Adult Student
    • +
  • 'TPRE' - Teen Parent Eligible and Enrolled Regular Student
    • +
  • 'TPRAE' - Teen Parent Enrolled Continuing Adult Student
    • +
plus 4 more value(s) at NZCodeSetsStudentFundingTypeType + oneOf: + - title: International Fee-Paying Student + description: An International student who meets full + tuition costs on their own or from funds + provided to them by sponsors other than + NZAID. + enum: + - FF + - title: Alternative Education Student + description: A student who is enrolled in an + Alternative Education programme, for + Funding Year Level they should be reported + only between Year 9 and Year 13 + (inclusive). + enum: + - AE + - title: Exchange Student + description: A student (and dependants) studying in New + Zealand under an exchange programme + approved by the New Zealand Government. + enum: + - EX + - title: Not Funded + description: Code to be used for students attending on + Roll Count Day, but not paying fee and not + funded; e.g. students with Eligibility + Criteria “28 Day Waiver” and “Extended 28 + Day Waiver”. + enum: + - NF + - title: Adult Student + description: '"A student who has continued at school + and is at least 19 on 1 January of the + Roll count year. EXAMPLE: Roll count year + = 2017 if student is 19 years old on 1 + January 2017 their student type = RA as + there has not been a break in the students + learning cycle."' + enum: + - RA + - title: Returning Adult Student + description: '"A student who has returned to school + following a break of at least 1 year and + is at least 19 years old on 1 January of + the Roll count year. EXAMPLE: Roll count + year = 2017 if student is 19 years old on + 1 Jan 2017 their student type = AD if + there has been a break in their learning + cycle."' + enum: + - AD + - title: Regular Student + description: A New Zealand student or a student treated + for funding and staffing purposes as a New + Zealand student who is also not yet 19 + years at 1 Jan of the roll count year. + This includes students in general + classrooms and those in special needs + units. + enum: + - RE + - title: Teen Parent Regular Student Over Maximum + Roll + description: A regular student (i.e. a student aged + under 19 years at 1 January of the roll + count year) who meets the eligibility + criteria, but whose enrolment would cause + the roll of the TPU to exceed the set + maximum. + enum: + - TPREOM + - title: Teen Parent Adult Student Over Maximum Roll + description: An adult student who is enrolled in a Teen + Parent Unit (TPU) where the enrolment at + the TPU has continued beyond the end of + the year in which the student reached 19 + years old. The enrolment of this student + causes the roll of the TPU to exceed the + set maximum. + enum: + - TPRAOM + - title: Teen Parent Other Adult Student + description: A student enrolling at the TPU as an adult + student (i.e. was at least 19 on 1st + January of the year when they first + enrolled at the TPU), and who fits within + the TPU’s maximum roll. + enum: + - TPAD + - title: Teen Parent Eligible and Enrolled Regular + Student + description: A student who is enrolled in a Teen Parent + Unit (TPU) and is at least 19 years old on + 1 January of the current year. These + students may continue to be enrolled in + the TPU after the end of the year in which + they turn 19, their Student Type however + will then be changed to TPRAE – Teen + Parent Enrolled Continuing Adult Student. + enum: + - TPRE + - title: Teen Parent Enrolled Continuing Adult + Student + description: A student who is enrolled in a Teen Parent + Unit (TPU) where the enrolment at the TPU + has continued beyond the end of the year + in which the student reached 19 years old. + enum: + - TPRAE + - title: External Student + description: A student who attends this school for some + courses but is enrolled at another school + where a majority of instruction occurs. + enum: + - EM + - title: Satellite Class Student + description: Student who is in a Satellite class of a + Special School. + enum: + - SA + - title: Not Attending + description: A student who is not attending the school + on the day of the roll count and there is + no documentation to support their absence + from the school. + enum: + - NA + - title: Separately Funded + description: Student is enrolled in a separately funded + unit. + enum: + - SF + FundingYearLevel: + $ref: "#/paths/~1StudentProviderEnrolments~1%7BStud\ + entProviderEnrolmentRefId%7D/put/requestBody/\ + content/application~1json/schema/properties/S\ + tudentProviderEnrolment/properties/SchoolEnro\ + lmentList/properties/SchoolEnrolment/items/pr\ + operties/YearLevel" + Curriculum: + type: string + title: Curriculum + description: >- +

Codes denoting the two curricula used in + New Zealand.

    +
  • 'NZC' - NZ Curriculum
    • +
  • 'TMA' - Te Marautanga o Aotearoa
    • +
  • 'ECE' - Te Whaariki
    • +
  • 'OTH' - Other Curriculum
    • +
+ oneOf: + - title: NZ Curriculum + enum: + - NZC + - title: Te Marautanga o Aotearoa + enum: + - TMA + - title: Te Whaariki + enum: + - ECE + - title: Other Curriculum + enum: + - OTH + CurriculumLevel: + type: integer + description:

Which level of the National Curriculum + (1-5) is the student enrolling in?

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + LanguageOfInstructionList: + description:

How much instruction has the student + received in which languages?

+ type: object + properties: + Language: + type: array + items: + description:

The number of hours per week the + Learner is taught in a specific language + during the enrolment.

+ type: object + properties: + Code: + type: string + title: Language + description: >- +

Language refers to recognised + human communication systems, + typically oral and/or written. + Sourced from Statistics NZ - + Language Standard Classification + 1999 v2.0.0

    +
  • 'NZS01' - Germanic
    • +
  • 'NZS011' - West Germanic
    • +
  • 'NZS01100' - West Germanic not further defined
    • +
  • 'NZS01110' - Afrikaans
    • +
  • 'NZS01111' - Dutch
    • +
  • 'NZS01112' - English
    • +
  • 'NZS01113' - German
    • +
  • 'NZS01114' - Friesian
    • +
  • 'NZS01115' - Yiddish
    • +
  • 'NZS01116' - Scots
    • +
  • 'NZS01199' - West Germanic not elsewhere classified
    • +
  • 'NZS012' - North Germanic
    • +
plus 252 more value(s) at NZCodeSetsLanguageType + oneOf: + - title: Germanic + enum: + - NZS01 + - title: West Germanic + enum: + - NZS011 + - title: West Germanic not further defined + enum: + - NZS01100 + - title: Afrikaans + enum: + - NZS01110 + - title: Dutch + enum: + - NZS01111 + - title: English + enum: + - NZS01112 + - title: German + enum: + - NZS01113 + - title: Friesian + enum: + - NZS01114 + - title: Yiddish + enum: + - NZS01115 + - title: Scots + enum: + - NZS01116 + - title: West Germanic not elsewhere + classified + enum: + - NZS01199 + - title: North Germanic + enum: + - NZS012 + - title: North Germanic not further + defined + enum: + - NZS01200 + - title: Danish + enum: + - NZS01210 + - title: Norwegian + enum: + - NZS01211 + - title: Swedish + enum: + - NZS01212 + - title: Icelandic + enum: + - NZS01213 + - title: North Germanic not elsewhere + classified + enum: + - NZS01299 + - title: Romance + enum: + - NZS02 + - title: Romance + enum: + - NZS021 + - title: Romance not further defined + enum: + - NZS02100 + - title: French + enum: + - NZS02110 + - title: Catalan + enum: + - NZS02111 + - title: Portuguese + enum: + - NZS02112 + - title: Spanish + enum: + - NZS02113 + - title: Italian + enum: + - NZS02114 + - title: Romanian + enum: + - NZS02115 + - title: Romance not elsewhere classified + enum: + - NZS02199 + - title: Greek + enum: + - NZS03 + - title: Greek + enum: + - NZS031 + - title: Greek + enum: + - NZS03110 + - title: Balto-Slavic + enum: + - NZS04 + - title: Baltic + enum: + - NZS041 + - title: Baltic not further defined + enum: + - NZS04100 + - title: Latvian + enum: + - NZS04110 + - title: Lithuanian + enum: + - NZS04111 + - title: Baltic not elsewhere classified + enum: + - NZS04199 + - title: Slavic + enum: + - NZS042 + - title: Slavic not further defined + enum: + - NZS04200 + - title: Belorussian + enum: + - NZS04210 + - title: Russian + enum: + - NZS04211 + - title: Ukrainian + enum: + - NZS04212 + - title: Bulgarian + enum: + - NZS04213 + - title: Macedonian + enum: + - NZS04214 + - title: Serbo-Croatian + enum: + - NZS04215 + - title: Slovene + enum: + - NZS04216 + - title: Czech + enum: + - NZS04217 + - title: Polish + enum: + - NZS04218 + - title: Slovak + enum: + - NZS04219 + - title: Slavic not elsewhere classified + enum: + - NZS04299 + - title: Albanian + enum: + - NZS05 + - title: Albanian + enum: + - NZS051 + - title: Albanian + enum: + - NZS05110 + - title: Armenian + enum: + - NZS06 + - title: Armenian + enum: + - NZS061 + - title: Armenian + enum: + - NZS06110 + - title: Indo-Aryan + enum: + - NZS07 + - title: Indo-Aryan + enum: + - NZS071 + - title: Indo-Aryan not further defined + enum: + - NZS07100 + - title: Hindi + enum: + - NZS07110 + - title: Urdu + enum: + - NZS07111 + - title: Fiji Hindi + enum: + - NZS07112 + - title: Bengali + enum: + - NZS07113 + - title: Oriya + enum: + - NZS07114 + - title: Nepalese + enum: + - NZS07115 + - title: Panjabi + enum: + - NZS07116 + - title: Sindhi + enum: + - NZS07117 + - title: Kashmiri + enum: + - NZS07118 + - title: Sinhala + enum: + - NZS07119 + - title: Gujarati + enum: + - NZS07120 + - title: Konkani + enum: + - NZS07121 + - title: Marathi + enum: + - NZS07122 + - title: Romani + enum: + - NZS07123 + - title: Indo-Aryan not elsewhere + classified + enum: + - NZS07199 + - title: Celtic + enum: + - NZS08 + - title: Celtic + enum: + - NZS081 + - title: Celtic not further defined + enum: + - NZS08100 + - title: Welsh + enum: + - NZS08110 + - title: Scottish Gaelic + enum: + - NZS08111 + - title: Irish + enum: + - NZS08112 + - title: Breton + enum: + - NZS08113 + - title: Celtic not elsewhere classified + enum: + - NZS08199 + - title: Iranian + enum: + - NZS09 + - title: Iranian + enum: + - NZS091 + - title: Iranian not further defined + enum: + - NZS09100 + - title: Persian + enum: + - NZS09110 + - title: Kurdish + enum: + - NZS09111 + - title: Pashto + enum: + - NZS09112 + - title: Iranian not elsewhere classified + enum: + - NZS09199 + - title: Turko-Altaic + enum: + - NZS10 + - title: Turko-Altaic + enum: + - NZS101 + - title: Turko-Altaic not further defined + enum: + - NZS10100 + - title: Turkish + enum: + - NZS10110 + - title: Azeri + enum: + - NZS10111 + - title: Turko-Altaic not elsewhere + classified + enum: + - NZS10199 + - title: Uralic + enum: + - NZS11 + - title: Uralic + enum: + - NZS111 + - title: Uralic not further defined + enum: + - NZS11100 + - title: Estonian + enum: + - NZS11110 + - title: Finnish + enum: + - NZS11111 + - title: Hungarian + enum: + - NZS11112 + - title: Uralic not elsewhere classified + enum: + - NZS11199 + - title: Dravidian + enum: + - NZS12 + - title: Dravidian + enum: + - NZS121 + - title: Dravidian not further defined + enum: + - NZS12100 + - title: Kannada + enum: + - NZS12110 + - title: Malayalam + enum: + - NZS12111 + - title: Tamil + enum: + - NZS12112 + - title: Telugu + enum: + - NZS12113 + - title: Dravidian not elsewhere + classified + enum: + - NZS12199 + - title: Sino-Tibeto-Burman + enum: + - NZS13 + - title: Sinitic + enum: + - NZS131 + - title: Sinitic not further defined + enum: + - NZS13100 + - title: Yue + enum: + - NZS13110 + - title: Hakka + enum: + - NZS13111 + - title: Min + enum: + - NZS13112 + - title: Northern Chinese + enum: + - NZS13113 + - title: Wu + enum: + - NZS13114 + - title: Tieu-Chow + enum: + - NZS13115 + - title: Sinitic not elsewhere classified + enum: + - NZS13199 + - title: Tibeto-Lolo-Burman + enum: + - NZS132 + - title: Tibeto-Lolo-Burman not further + defined + enum: + - NZS13200 + - title: Burmese + enum: + - NZS13210 + - title: Tibetan + enum: + - NZS13211 + - title: Tibeto-Lolo-Burman not elsewhere + classified + enum: + - NZS13299 + - title: Austroasiatic + enum: + - NZS14 + - title: Mon-Khmer + enum: + - NZS141 + - title: Mon-Khmer not further defined + enum: + - NZS14100 + - title: Khmer + enum: + - NZS14110 + - title: Mon-Khmer not elsewhere + classified + enum: + - NZS14199 + - title: Viet-Muong + enum: + - NZS142 + - title: Viet-Muong not further defined + enum: + - NZS14200 + - title: Vietnamese + enum: + - NZS14210 + - title: Viet-Muong not elsewhere + classified + enum: + - NZS14299 + - title: Tai-Kadai + enum: + - NZS15 + - title: Tai-Kadai + enum: + - NZS151 + - title: Tai-Kadai not further defined + enum: + - NZS15100 + - title: Lao + enum: + - NZS15110 + - title: Thai + enum: + - NZS15111 + - title: Shan + enum: + - NZS15112 + - title: Tai-Kadai not elsewhere + classified + enum: + - NZS15199 + - title: Central-Eastern Malayo-Polynesian + enum: + - NZS16 + - title: Central Pacific + enum: + - NZS161 + - title: Central Pacific not further + defined + enum: + - NZS16100 + - title: Māori + enum: + - NZS16110 + - title: Samoan + enum: + - NZS16111 + - title: Tongan + enum: + - NZS16112 + - title: Cook Islands Maori + enum: + - NZS16113 + - title: Niuean + enum: + - NZS16114 + - title: Tokelauan + enum: + - NZS16115 + - title: Tuvaluan + enum: + - NZS16116 + - title: Tahitian + enum: + - NZS16117 + - title: Pukapukan + enum: + - NZS16118 + - title: Fijian + enum: + - NZS16119 + - title: Rotuman + enum: + - NZS16120 + - title: Central Pacific not elsewhere + classified + enum: + - NZS16199 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS162 + - title: Solomon Islands Languages + (Non-Central-Pacific) + enum: + - NZS16210 + - title: Micronesian + enum: + - NZS163 + - title: Micronesian not further defined + enum: + - NZS16300 + - title: Kiribati + enum: + - NZS16310 + - title: Nauruan + enum: + - NZS16311 + - title: Micronesian not elsewhere + classified + enum: + - NZS16399 + - title: Vanuatu Languages + enum: + - NZS164 + - title: Vanuatu Languages + enum: + - NZS16410 + - title: Western Malayo-Polynesian + enum: + - NZS17 + - title: Western Malayo-Polynesian + enum: + - NZS171 + - title: Western Malayo-Polynesian not + further defined + enum: + - NZS17100 + - title: Bisayan + enum: + - NZS17110 + - title: Cebuano + enum: + - NZS17111 + - title: Ilokano + enum: + - NZS17112 + - title: Bahasa Indonesia + enum: + - NZS17113 + - title: Malaysian + enum: + - NZS17114 + - title: Tagalog + enum: + - NZS17115 + - title: Javanese + enum: + - NZS17116 + - title: Western Malayo-Polynesian not + elsewhere classified + enum: + - NZS17199 + - title: Afro-Asiatic + enum: + - NZS18 + - title: Cushitic + enum: + - NZS181 + - title: Cushitic not further defined + enum: + - NZS18100 + - title: Somali + enum: + - NZS18110 + - title: Cushitic not elsewhere classified + enum: + - NZS18199 + - title: Semitic + enum: + - NZS182 + - title: Semitic not further defined + enum: + - NZS18200 + - title: Assyrian + enum: + - NZS18210 + - title: Arabic + enum: + - NZS18211 + - title: Maltese + enum: + - NZS18212 + - title: Amharic + enum: + - NZS18213 + - title: Tigrinya + enum: + - NZS18214 + - title: Hebrew + enum: + - NZS18215 + - title: Semitic not elsewhere classified + enum: + - NZS18299 + - title: Chadic + enum: + - NZS183 + - title: Chadic not further defined + enum: + - NZS18300 + - title: Hausa + enum: + - NZS18310 + - title: Chadic not elsewhere classified + enum: + - NZS18399 + - title: Niger-Congo (Congo-Kordafanian) + enum: + - NZS19 + - title: Bantu languages + enum: + - NZS191 + - title: Bantu not further defined + enum: + - NZS19100 + - title: Swahili + enum: + - NZS19110 + - title: Yoruba + enum: + - NZS19111 + - title: Zulu + enum: + - NZS19112 + - title: Bantu, not elsewhere classified + enum: + - NZS19199 + - title: Other Niger-Congo + enum: + - NZS192 + - title: Other Niger-Congo not further + defined + enum: + - NZS19200 + - title: Fulani + enum: + - NZS19210 + - title: Other Niger-Congo not elsewhere + classified + enum: + - NZS19299 + - title: Pidgins and Creoles + enum: + - NZS20 + - title: Pidgins and Creoles + enum: + - NZS201 + - title: Pidgins and Creoles not further + defined + enum: + - NZS20100 + - title: Creole + enum: + - NZS20110 + - title: French Creole + enum: + - NZS20111 + - title: Pidgin English + enum: + - NZS20112 + - title: Neo Melanesian + enum: + - NZS20113 + - title: Mauritian Creole + enum: + - NZS20114 + - title: Tok Pisin + enum: + - NZS20115 + - title: Hindi Bat + enum: + - NZS20116 + - title: Solomon Islands Pidgin + enum: + - NZS20117 + - title: Bislama + enum: + - NZS20118 + - title: Pidgins and Creoles not + elsewhere classified + enum: + - NZS20199 + - title: Language Isolates + enum: + - NZS21 + - title: Japanese + enum: + - NZS211 + - title: Japanese + enum: + - NZS21110 + - title: Korean + enum: + - NZS212 + - title: Korean + enum: + - NZS21210 + - title: Basque + enum: + - NZS213 + - title: Basque + enum: + - NZS21310 + - title: Language Isolates not elsewhere + classified + enum: + - NZS219 + - title: Language Isolates not elsewhere + classified + enum: + - NZS21999 + - title: Miscellaneous Language Groupings + enum: + - NZS22 + - title: Papuan + enum: + - NZS221 + - title: Papuan + enum: + - NZS22110 + - title: Nilo-Saharan languages + enum: + - NZS222 + - title: Nilo-Saharan + enum: + - NZS22210 + - title: Miaow-Yao + enum: + - NZS223 + - title: Miaow-Yao + enum: + - NZS22310 + - title: Caucasian + enum: + - NZS224 + - title: Caucasian not further defined + enum: + - NZS22400 + - title: Georgian + enum: + - NZS22410 + - title: Caucasian not elsewhere + classified + enum: + - NZS22499 + - title: Australian + enum: + - NZS225 + - title: Australian + enum: + - NZS22510 + - title: Amerind + enum: + - NZS226 + - title: Amerind + enum: + - NZS22610 + - title: Other Miscellaneous Languages + enum: + - NZS229 + - title: Other Miscellaneous Languages + enum: + - NZS22910 + - title: Artificial Languages + enum: + - NZS23 + - title: Artificial Languages + enum: + - NZS231 + - title: Artificial Languages not further + defined + enum: + - NZS23100 + - title: Esperanto + enum: + - NZS23110 + - title: Artificial Languages not + elsewhere classified + enum: + - NZS23199 + - title: Sign Language + enum: + - NZS24 + - title: Sign Language + enum: + - NZS241 + - title: Sign Language not further defined + enum: + - NZS24100 + - title: New Zealand Sign Language + enum: + - NZS24110 + - title: Signed English + enum: + - NZS24111 + - title: American Sign Language + enum: + - NZS24112 + - title: Australian Sign Language + enum: + - NZS24113 + - title: British Sign Language + enum: + - NZS24114 + - title: Sign Language not elsewhere + classified + enum: + - NZS24199 + - title: Don't Know + enum: + - NZS44 + - title: Refused to Answer + enum: + - NZS55 + - title: None (eg too young to talk) + enum: + - NZS66 + - title: Response Unidentifiable + enum: + - NZS77 + - title: Response Outside Scope + enum: + - NZS88 + - title: Not Stated + enum: + - NZS99 + Level: + description:

The level of instruction that is + made in the selected language.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + TimeInImmersion: + type: integer + description:

The number of years the student has been in + Te Reo Māori immersion education.

+ Section9Agreement: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown + and not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + OngoingResourceScheme: + type: string + title: Ongoing Resource Scheme + description: >- +

Codes denoting the level of ORS funding a + student may receive.

    +
  • 'H' - High
    • +
  • 'V' - Very High
    • +
  • 'E' - Extension
    • +
+ oneOf: + - title: High + enum: + - H + - title: Very High + enum: + - V + - title: Extension + enum: + - E + SubjectChoiceList: + description:

Student’s choice of general subjects and + learning areas to be studied during the school + year. Not to be confused with CourseChoiceList + which allows students to choose specific + courses.

+ type: object + properties: + StudentSubjectChoice: + type: array + items: + description:

An individual Subject choice that can + be made, or has been made by a + Student.

+ type: object + properties: + PreferenceNumber: + type: integer + description:

The student's preference for this + subject, with respect to the other + subject choices in the list.

+ Code: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas + defined by the NZ Curriculum and Te + Marautanga o Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - title: German + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - GERM + - title: Indonesian + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - INDO + - title: Japanese + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - JAPA + - title: French + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - FREN + - title: English (Remedial) + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - REME + - title: English + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - ENGL + - title: Cook Island Maori + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - COOK + - title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + enum: + - COMM + - title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + enum: + - CHIN + - title: Korean + enum: + - KORE + - title: Latin + enum: + - LATI + - title: Niuean + enum: + - NIUE + - title: Other Languages + enum: + - OLAN + - title: Pacific Language Studies + enum: + - PLAN + - title: Russian + enum: + - RUSS + - title: Samoan + enum: + - SAMO + - title: Spanish + enum: + - SPAN + - title: Te Reo Māori + enum: + - MAOR + - title: Te Reo Rangatira + enum: + - RANG + - title: Tokelauan + enum: + - TOKE + - title: Tongan + enum: + - TONG + - title: English as a Second Language + enum: + - ENSL + - title: Mathematics + enum: + - MATH + - title: Mathematics with Calculus + enum: + - MATC + - title: Mathematics with Statistics + enum: + - MATS + - title: Mathematics (Remedial) + enum: + - REMM + - title: Accounting + enum: + - ACCO + - title: Science + enum: + - SCIE + - title: Agriculture / Horticulture + enum: + - AGHO + - title: Biology / Biological Science + enum: + - BIOL + - title: Chemsitry + enum: + - CHEM + - title: Earth Science / Astronomy + enum: + - EAAS + - title: Human Biology + enum: + - HUMB + - title: Physics + enum: + - PHYS + - title: Technology + enum: + - TECN + - title: Biotechnology + enum: + - BITE + - title: Computer Science / Programming + enum: + - COSC + - title: Computer Studies + enum: + - COMP + - title: Design, Drawing and Graphics + enum: + - DEST + - title: Electronics and Control + enum: + - ELTE + - title: Food Technology + enum: + - FOTE + - title: Graphics + enum: + - GRAP + - title: Information and Communication + Technology + enum: + - INTE + - title: Materials Technology + enum: + - MTEC + - title: Structures and Mechanisms + enum: + - STME + - title: Test and Information Management + enum: + - TIMA + - title: Textiles / Clothing + enum: + - CLTX + - title: The Arts + enum: + - ARTA + - title: Art Design + enum: + - ARTD + - title: Art History + enum: + - ARTH + - title: Dancing + enum: + - DANC + - title: Drama + enum: + - DRAM + - title: Music / Music Studies + enum: + - MUSC + - title: Music Practical / Performance + enum: + - MUSP + - title: Painting + enum: + - ARPA + - title: Performing Arts + enum: + - APER + - title: Photography + enum: + - ARTP + - title: Printmaking + enum: + - ARPR + - title: Sculpture + enum: + - ARTS + - title: Visial Arts + enum: + - ARTC + - title: Social Studies + enum: + - SOST + - title: Classics / Classical Studies + enum: + - CLST + - title: Community Studies + enum: + - CMTY + - title: Economics + enum: + - ECON + - title: Environmental Sustainability + enum: + - SENV + - title: Geography + enum: + - GEOG + - title: History + enum: + - HIST + - title: Language and Cultural Studies + enum: + - LACU + - title: Māori Studies + enum: + - MAOS + - title: Media Studies + enum: + - MEST + - title: Other Social Sciences + enum: + - SOSC + - title: Health and Physical Education + enum: + - HEPH + - title: Health + enum: + - HEED + - title: Home Economics + enum: + - HOME + - title: Outdoor Education + enum: + - OUED + - title: Physical Education + enum: + - PHED + - title: Sports Studies + enum: + - SPOR + - title: Commerce Related + enum: + - BUSS + - title: Defence + enum: + - DEFE + - title: Equestrian + enum: + - EQUE + - title: Farming + enum: + - FARM + - title: Fishing + enum: + - FISH + - title: Forestry + enum: + - FOTY + - title: Industrial Trades + enum: + - INTR + - title: Integrated Studies + enum: + - INTS + - title: Legal / Law Related Studies + enum: + - LAWS + - title: Life Skills / Personal + Development + enum: + - LIFE + - title: Religious Education / Studies + enum: + - REST + - title: Remedial Studies + enum: + - REMS + - title: Secondary Tertiary Programme + enum: + - STPR + - title: Service Trades + enum: + - SETR + - title: Special Needs Programme + enum: + - SPPR + - title: Study Skills + enum: + - STDY + - title: Transition / Pre-Employment + enum: + - TRAN + - title: Travel, Hospitality, Tourism + enum: + - THTR + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + CourseChoiceList: + description:

Student’s choice of courses to be studied + during the school year. Not to be confused + with SubjectChoiceList which allows students + to choose general subjects and learning areas + rather than specific courses.

+ type: object + properties: + StudentCourseChoice: + type: array + items: + description:

An individual Course choice that can + be made, or has been made by a + Student.

+ type: object + properties: + PreferenceNumber: + type: integer + description:

The student's preference for this + course, with respect to the other + course choices in the list.

+ Course: + $ref: "#/paths/~1StudentProviderEnrolment\ + s~1%7BStudentProviderEnrolmentRefId\ + %7D/put/requestBody/content/applica\ + tion~1json/schema/properties/Studen\ + tProviderEnrolment/properties/Stude\ + nt" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + CoEnrolment: + description:

Describes the student's enrolment with + their base school in the case where this + enrolment is not a base school enrolment.

+ type: object + properties: + OtherProvider: + $ref: "#/paths/~1StudentProviderEnrolments~1%7B\ + StudentProviderEnrolmentRefId%7D/put/requ\ + estBody/content/application~1json/schema/\ + properties/StudentProviderEnrolment/prope\ + rties/Student" + CoEnrolmentType: + type: string + title: CoEnrolment Type + description: |- +

    +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Other + enum: + - OTH + BehaviouralKeyIssuesNote: + type: string + description:

Free text note of key behavioural + issues, made by the client school in + relation to the student.

+ ClientSchoolConfidentialNote: + type: string + description:

Free text confidential note made by the + client school in relation to the + student.

+ GuardianConfidentialNote: + type: string + description:

Free text confidential note made by the + parents/caregivers of the student.

+ InternationalEnrolment: + description:

Additional information collected for + international enrolments.

+ type: object + properties: + NZArrivalDate: + type: string + format: date + description:

The date the Student arrived in New + Zealand.

+ TuitionWeeklyFee: + description:

The amount paid by the Student per Week + (GST excl) as a tuition fee.

+ ExchangeScheme: + type: string + title: Exchange Scheme + description: >- +

The type of exchange scheme for student + enrolment where the Eligibility Criteria + is "Student on Government approved + exchange scheme" (5).

    +
  • 'AFS' - AFS Intercultural Programmes NZ Inc.
    • +
  • 'GSE' - NZ / German Student Exchange
    • +
  • 'IIU' - NZ Institute of International Understanding
    • +
  • 'RIN' - Rotary International NZ
    • +
  • 'STS' - STS High School Foundation
    • +
  • 'YFU' - YFU New Zealand Inc.
    • +
  • 'WYS' - World Youth Service Society (WYSS)
    • +
  • 'STA' - Student Exchange Australia New Zealand Ltd.
    • +
  • 'TAE' - Tahiti Exchange
    • +
  • 'NGE' - NZ - Germany Exchange - Düsseldorf
    • +
  • 'YED' - Your Education
    • +
  • 'NSE' - NZ Switzerland Exchange
    • +
plus 1 more value(s) at NZCodeSetsExchangeSchemeType + oneOf: + - title: AFS Intercultural Programmes NZ Inc. + enum: + - AFS + - title: NZ / German Student Exchange + enum: + - GSE + - title: NZ Institute of International + Understanding + enum: + - IIU + - title: Rotary International NZ + enum: + - RIN + - title: STS High School Foundation + enum: + - STS + - title: YFU New Zealand Inc. + enum: + - YFU + - title: World Youth Service Society (WYSS) + enum: + - WYS + - title: Student Exchange Australia New Zealand + Ltd. + enum: + - STA + - title: Tahiti Exchange + enum: + - TAE + - title: NZ - Germany Exchange - Düsseldorf + enum: + - NGE + - title: Your Education + enum: + - YED + - title: NZ Switzerland Exchange + enum: + - NSE + - title: Exchange Agreement + enum: + - EXA + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + StudentConsentList: + description:

A list of student consent information.

+ type: object + properties: + StudentConsent: + type: array + items: + $ref: "#/paths/~1StudentProviderEnrolments~1%\ + 7BStudentProviderEnrolmentRefId%7D/put/\ + requestBody/content/application~1json/s\ + chema/properties/StudentProviderEnrolme\ + nt/properties/Student" + AcademicAttainmentGoalList: + description:

The academic attainment goals of the + student when they enrol, e.g. they wish to + achieve a certain qualification.

+ type: object + properties: + AttainmentGoal: + type: array + items: + $ref: "#/paths/~1StudentProviderEnrolments~1%\ + 7BStudentProviderEnrolmentRefId%7D/put/\ + requestBody/content/application~1json/s\ + chema/properties/StudentProviderEnrolme\ + nt/properties/Student" + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + PreEnrolmentCancellation: + description:

Details of why the school pre-enrolment was + cancelled.

+ type: object + properties: + NotifiedDate: + type: string + format: date + description:

The date the Student was notified of + the cancellation of the pre-enrolment.

+ CancellationMethod: + type: string + title: Pre Enrolment Exit Type + description: >- +

Code set denoting how the student's + pre-enrolment was cancelled.

    +
  • 'A' - Automated
    • +
  • 'M' - Manual
    • +
+ oneOf: + - title: Automated + enum: + - A + - title: Manual + enum: + - M + CancellationReason: + type: string + title: Pre Enrolment Cancellation Reason + description: >- +

Code set denoting why the student's + pre-enrolment was cancelled.

    +
  • 'SIE' - Student Incorrectly Enrolled
    • +
  • 'SDE' - Student Declined Enrolment
    • +
  • 'DEC' - Deceased
    • +
  • 'OTH' - Other - Please Specify
    • +
+ oneOf: + - title: Student Incorrectly Enrolled + enum: + - SIE + - title: Student Declined Enrolment + enum: + - SDE + - title: Deceased + enum: + - DEC + - title: Other - Please Specify + enum: + - OTH + CancellationReasonOtherDesc: + $ref: "#/paths/~1StudentProviderEnrolments~1%7B\ + StudentProviderEnrolmentRefId%7D/put/requ\ + estBody/content/application~1json/schema/\ + properties/StudentProviderEnrolment/prope\ + rties/SchoolEnrolmentList/properties/Scho\ + olEnrolment/items/properties/PreEnrolment\ + Cancellation/properties/CancellationReaso\ + n" + TertiaryEducationEnrolment: + description:

Properties of an enrolment in a Tertiary Education + service (WiP).

+ type: object + properties: + Type: + type: string + description:

The type of tertiary education the student is + enrolling in.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + description:

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.

+ x-accessControl: + create: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + read: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + update: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentProviderEnrolment: + StudentProviderEnrolmentRefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + StudentProviderEnrolmentLocalId: 2004H102 + Student: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1652 + Provider: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1651 + EntryDate: 2018-01-29 + Status: WIT + SchoolEnrolmentList: + SchoolEnrolment: + 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 + FundingType: EX + FundingYearLevel: 1 + Curriculum: NZC + CurriculumLevel: 5 + InternationalEnrolment: + NZArrivalDate: 2018-05-02 + ExchangeScheme: STA + application/xml: + schema: + type: object + properties: + StudentProviderEnrolment: + $ref: "#/paths/~1StudentProviderEnrolments~1%7BStudentProviderEnr\ + olmentRefId%7D/put/requestBody/content/application~1json/sc\ + hema/properties/StudentProviderEnrolment" + example: >- + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 2004H102 + + d3e34b35-9d75-101a-8c3d-00aa001a1652 + + + d3e34b35-9d75-101a-8c3d-00aa001a1651 + + 2018-01-29 + WIT + + + 2018 + BASE + 11 + GAE + + AUSPA + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + 1.0 + EX + 1 + NZC + 5 + + 2018-05-02 + STA + + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentProviderEnrolment + summary: Default operation to get a single StudentProviderEnrolment + parameters: + - name: StudentProviderEnrolmentRefId + in: path + description:

The SIF GUID for the student provider enrolment.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentProviderEnrolment: + $ref: "#/paths/~1StudentProviderEnrolments/get/responses/200/co\ + ntent/application~1json/schema/properties/StudentProvider\ + Enrolments/properties/StudentProviderEnrolment/items" + example: + StudentProviderEnrolment: + StudentProviderEnrolmentRefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + StudentProviderEnrolmentLocalId: 2004H102 + Student: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1652 + Provider: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1651 + EntryDate: 2018-01-29 + Status: WIT + SchoolEnrolmentList: + SchoolEnrolment: + 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 + FundingType: EX + FundingYearLevel: 1 + Curriculum: NZC + CurriculumLevel: 5 + InternationalEnrolment: + NZArrivalDate: 2018-05-02 + ExchangeScheme: STA + application/xml: + schema: + type: object + properties: + StudentProviderEnrolment: + $ref: "#/paths/~1StudentProviderEnrolments/get/responses/200/co\ + ntent/application~1json/schema/properties/StudentProvider\ + Enrolments/properties/StudentProviderEnrolment/items" + example: >- + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 2004H102 + + d3e34b35-9d75-101a-8c3d-00aa001a1652 + + + d3e34b35-9d75-101a-8c3d-00aa001a1651 + + 2018-01-29 + WIT + + + 2018 + BASE + 11 + GAE + + AUSPA + L905673 + 2019-03-30 + true + 2003-11-30T12:34:56.7 + + 822f6c83-2841-4a87-9ff9-49730951b3ba + + + 1.0 + EX + 1 + NZC + 5 + + 2018-05-02 + STA + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentProviderEnrolment + summary: Default operation to delete a single StudentProviderEnrolment + parameters: + - name: StudentProviderEnrolmentRefId + in: path + description:

The SIF GUID for the student provider enrolment.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentTeachingGroupEnrolments: + get: + tags: + - StudentTeachingGroupEnrolment + summary: Default operation to get a list of all available + StudentTeachingGroupEnrolments + description: Search the set of available StudentTeachingGroupEnrolments, according to + the search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentTeachingGroupEnrolments: + type: object + description: A List of StudentTeachingGroupEnrolment objects + properties: + StudentTeachingGroupEnrolment: + type: array + items: + required: + - Provider + - StartDate + - Student + - TeachingGroup + type: object + properties: + StudentTeachingGroupEnrolmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentTeachingGroupEnrolmentLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentTeachingGroupEnrolments/g\ + et/responses/200/content/application~1json/\ + schema/properties/StudentTeachingGroupEnrol\ + ments/properties/StudentTeachingGroupEnrolm\ + ent/items/properties/StudentTeachingGroupEn\ + rolmentRefId" + LocalId: + $ref: "#/paths/~1StudentTeachingGroupEnrolments/g\ + et/responses/200/content/application~1json/\ + schema/properties/StudentTeachingGroupEnrol\ + ments/properties/StudentTeachingGroupEnrolm\ + ent/items/properties/StudentTeachingGroupEn\ + rolmentLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentTeachingGroupEnrolments/get/r\ + esponses/200/content/application~1json/schema/p\ + roperties/StudentTeachingGroupEnrolments/proper\ + ties/StudentTeachingGroupEnrolment/items/proper\ + ties/Student" + TeachingGroup: + $ref: "#/paths/~1StudentTeachingGroupEnrolments/get/r\ + esponses/200/content/application~1json/schema/p\ + roperties/StudentTeachingGroupEnrolments/proper\ + ties/StudentTeachingGroupEnrolment/items/proper\ + ties/Student" + StartDate: + type: string + format: date + description:

The date the Student's enrolment in the + teaching group starts.

+ EndDate: + type: string + format: date + description:

The date of a student’s enrolment in the + teaching group ends.

+ description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentTeachingGroupEnrolments: + StudentTeachingGroupEnrolment: + - StudentTeachingGroupEnrolmentRefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + StudentTeachingGroupEnrolmentLocalId: 2004H102 + Student: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1652 + Provider: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1651 + TeachingGroup: + RefId: 93b9b77e-a23f-4acd-a65e-e26f1034317f + StartDate: 2018-01-29 + EndDate: 2018-12-05 + application/xml: + schema: + type: object + properties: + StudentTeachingGroupEnrolments: + type: object + description: A List of StudentTeachingGroupEnrolment objects + properties: + StudentTeachingGroupEnrolment: + type: array + items: + $ref: "#/paths/~1StudentTeachingGroupEnrolments/get/respo\ + nses/200/content/application~1json/schema/propertie\ + s/StudentTeachingGroupEnrolments/properties/Student\ + TeachingGroupEnrolment/items" + example: >- + + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 2004H102 + + d3e34b35-9d75-101a-8c3d-00aa001a1652 + + + d3e34b35-9d75-101a-8c3d-00aa001a1651 + + + 93b9b77e-a23f-4acd-a65e-e26f1034317f + + 2018-01-29 + 2018-12-05 + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentTeachingGroupEnrolments/{StudentTeachingGroupEnrolmentRefId}": + post: + tags: + - StudentTeachingGroupEnrolment + summary: Default operation to create a single StudentTeachingGroupEnrolment + parameters: + - name: StudentTeachingGroupEnrolmentRefId + in: path + description:

The SIF GUID for the student teaching group enrolment.

+ required: true + schema: + type: string + operationId: createStudentTeachingGroupEnrolment + requestBody: + description: CRUD operation on StudentTeachingGroupEnrolment + content: + application/json: + schema: + type: object + properties: + StudentTeachingGroupEnrolment: + $ref: "#/paths/~1StudentTeachingGroupEnrolments/get/responses/200\ + /content/application~1json/schema/properties/StudentTeachin\ + gGroupEnrolments/properties/StudentTeachingGroupEnrolment/i\ + tems" + example: + StudentTeachingGroupEnrolment: + StudentTeachingGroupEnrolmentRefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + StudentTeachingGroupEnrolmentLocalId: 2004H102 + Student: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1652 + Provider: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1651 + TeachingGroup: + RefId: 93b9b77e-a23f-4acd-a65e-e26f1034317f + StartDate: 2018-01-29 + EndDate: 2018-12-05 + application/xml: + schema: + type: object + properties: + StudentTeachingGroupEnrolment: + $ref: "#/paths/~1StudentTeachingGroupEnrolments/get/responses/200\ + /content/application~1json/schema/properties/StudentTeachin\ + gGroupEnrolments/properties/StudentTeachingGroupEnrolment/i\ + tems" + example: >- + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 2004H102 + + d3e34b35-9d75-101a-8c3d-00aa001a1652 + + + d3e34b35-9d75-101a-8c3d-00aa001a1651 + + + 93b9b77e-a23f-4acd-a65e-e26f1034317f + + 2018-01-29 + 2018-12-05 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentTeachingGroupEnrolment + summary: Default operation to update a single StudentTeachingGroupEnrolment + parameters: + - name: StudentTeachingGroupEnrolmentRefId + in: path + description:

The SIF GUID for the student teaching group enrolment.

+ required: true + schema: + type: string + operationId: updateStudentTeachingGroupEnrolment + requestBody: + description: CRUD operation on StudentTeachingGroupEnrolment + content: + application/json: + schema: + type: object + properties: + StudentTeachingGroupEnrolment: + type: object + properties: + StudentTeachingGroupEnrolmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentTeachingGroupEnrolmentLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentTeachingGroupEnrolments~1%7BStude\ + ntTeachingGroupEnrolmentRefId%7D/put/requestBody/co\ + ntent/application~1json/schema/properties/StudentTe\ + achingGroupEnrolment/properties/StudentTeachingGrou\ + pEnrolmentRefId" + LocalId: + $ref: "#/paths/~1StudentTeachingGroupEnrolments~1%7BStude\ + ntTeachingGroupEnrolmentRefId%7D/put/requestBody/co\ + ntent/application~1json/schema/properties/StudentTe\ + achingGroupEnrolment/properties/StudentTeachingGrou\ + pEnrolmentLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentTeachingGroupEnrolments~1%7BStudentTe\ + achingGroupEnrolmentRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/StudentTeachingGroupE\ + nrolment/properties/Student" + TeachingGroup: + $ref: "#/paths/~1StudentTeachingGroupEnrolments~1%7BStudentTe\ + achingGroupEnrolmentRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/StudentTeachingGroupE\ + nrolment/properties/Student" + StartDate: + type: string + format: date + description:

The date the Student's enrolment in the teaching + group starts.

+ EndDate: + type: string + format: date + description:

The date of a student’s enrolment in the teaching + group ends.

+ description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentTeachingGroupEnrolment: + StudentTeachingGroupEnrolmentRefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + StudentTeachingGroupEnrolmentLocalId: 2004H102 + Student: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1652 + Provider: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1651 + TeachingGroup: + RefId: 93b9b77e-a23f-4acd-a65e-e26f1034317f + StartDate: 2018-01-29 + EndDate: 2018-12-05 + application/xml: + schema: + type: object + properties: + StudentTeachingGroupEnrolment: + $ref: "#/paths/~1StudentTeachingGroupEnrolments~1%7BStudentTeachi\ + ngGroupEnrolmentRefId%7D/put/requestBody/content/applicatio\ + n~1json/schema/properties/StudentTeachingGroupEnrolment" + example: >- + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 2004H102 + + d3e34b35-9d75-101a-8c3d-00aa001a1652 + + + d3e34b35-9d75-101a-8c3d-00aa001a1651 + + + 93b9b77e-a23f-4acd-a65e-e26f1034317f + + 2018-01-29 + 2018-12-05 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentTeachingGroupEnrolment + summary: Default operation to get a single StudentTeachingGroupEnrolment + parameters: + - name: StudentTeachingGroupEnrolmentRefId + in: path + description:

The SIF GUID for the student teaching group enrolment.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentTeachingGroupEnrolment: + $ref: "#/paths/~1StudentTeachingGroupEnrolments/get/responses/2\ + 00/content/application~1json/schema/properties/StudentTea\ + chingGroupEnrolments/properties/StudentTeachingGroupEnrol\ + ment/items" + example: + StudentTeachingGroupEnrolment: + StudentTeachingGroupEnrolmentRefId: A8C3D3E3-4B35-9D75-101D-00AA001A1652 + StudentTeachingGroupEnrolmentLocalId: 2004H102 + Student: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1652 + Provider: + RefId: d3e34b35-9d75-101a-8c3d-00aa001a1651 + TeachingGroup: + RefId: 93b9b77e-a23f-4acd-a65e-e26f1034317f + StartDate: 2018-01-29 + EndDate: 2018-12-05 + application/xml: + schema: + type: object + properties: + StudentTeachingGroupEnrolment: + $ref: "#/paths/~1StudentTeachingGroupEnrolments/get/responses/2\ + 00/content/application~1json/schema/properties/StudentTea\ + chingGroupEnrolments/properties/StudentTeachingGroupEnrol\ + ment/items" + example: >- + + A8C3D3E3-4B35-9D75-101D-00AA001A1652 + 2004H102 + + d3e34b35-9d75-101a-8c3d-00aa001a1652 + + + d3e34b35-9d75-101a-8c3d-00aa001a1651 + + + 93b9b77e-a23f-4acd-a65e-e26f1034317f + + 2018-01-29 + 2018-12-05 + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentTeachingGroupEnrolment + summary: Default operation to delete a single StudentTeachingGroupEnrolment + parameters: + - name: StudentTeachingGroupEnrolmentRefId + in: path + description:

The SIF GUID for the student teaching group enrolment.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /Schedules: + get: + tags: + - Schedule + summary: Default operation to get a list of all available Schedules + description: Search the set of available Schedules, according to the search criteria + in the URL parameters. Returns the first 20 objects located; with SIF + defined navigation headers, indicating how to retrieve subsequent sets + of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + Schedules: + type: object + description: A List of Schedule objects + properties: + Schedule: + type: array + items: + required: + - AcademicDayList + - Provider + - ScheduleName + - StartDate + type: object + properties: + ScheduleRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + ScheduleLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + ScheduleName: + type: string + description:

The name of the schedule.

+ StartDate: + type: string + format: date + description:

The start date of the schedule.

+ EndDate: + type: string + format: date + description:

The end date of the schedule.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1Schedules/get/responses/200/cont\ + ent/application~1json/schema/properties/Sch\ + edules/properties/Schedule/items/properties\ + /ScheduleRefId" + LocalId: + $ref: "#/paths/~1Schedules/get/responses/200/cont\ + ent/application~1json/schema/properties/Sch\ + edules/properties/Schedule/items/properties\ + /ScheduleLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + AcademicDayList: + description:

A list of the academic days within this + schedule.

+ type: object + required: + - AcademicDay + properties: + AcademicDay: + type: array + items: + description:

An academic day that is part of this + schedule

+ type: object + required: + - AcademicDayType + - ObjectType + - PeriodList + properties: + BellSchedule: + $ref: "#/paths/~1Schedules/get/responses/20\ + 0/content/application~1json/schema/pr\ + operties/Schedules/properties/Schedul\ + e/items/properties/Provider" + PeriodList: + description:

A list of the periods that make up + this academic day, e.g. Period 1, + Period 2 etc.

+ type: object + required: + - Period + properties: + Period: + type: array + items: + $ref: "#/paths/~1Schedules/get/respon\ + ses/200/content/application~1js\ + on/schema/properties/Schedules/\ + properties/Schedule/items/prope\ + rties/Provider" + description: Provides information about a schedule for a provider. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + Schedules: + Schedule: + - ScheduleRefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + ScheduleLocalId: 2019a + ScheduleName: Scheule 2019a (Term 1) + StartDate: 2019-01-30 + EndDate: 2019-04-07 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + AcademicDayList: + AcademicDay: + - RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Schedule 2019a, Day A + 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 + - RefId: 337804c6-1247-4c0f-b288-e4aa28584aad + LocalId: 2019a-B + Name: Schedule 2019a, DayB + PeriodList: + Period: + - RefId: f6776718-4680-4cb7-b649-a84f9796905c + LocalId: 2019a-B1 + Name: Period 1 on Day B + - RefId: 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 + LocalId: 2019a-B2 + Name: Period 2 on Day B + application/xml: + schema: + type: object + properties: + Schedules: + type: object + description: A List of Schedule objects + properties: + Schedule: + type: array + items: + $ref: "#/paths/~1Schedules/get/responses/200/content/appl\ + ication~1json/schema/properties/Schedules/propertie\ + s/Schedule/items" + example: >- + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a + Scheule 2019a (Term 1) + 2019-01-30 + 2019-04-07 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Schedule 2019a, Day A + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + + + + 337804c6-1247-4c0f-b288-e4aa28584aad + 2019a-B + Schedule 2019a, DayB + + + f6776718-4680-4cb7-b649-a84f9796905c + 2019a-B1 + Period 1 on Day B + + + 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 + 2019a-B2 + Period 2 on Day B + + + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/Schedules/{ScheduleRefId}": + post: + tags: + - Schedule + summary: Default operation to create a single Schedule + parameters: + - name: ScheduleRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule.

+ required: true + schema: + type: string + operationId: createSchedule + requestBody: + description: CRUD operation on Schedule + content: + application/json: + schema: + type: object + properties: + Schedule: + $ref: "#/paths/~1Schedules/get/responses/200/content/application~\ + 1json/schema/properties/Schedules/properties/Schedule/items" + example: + Schedule: + ScheduleRefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + ScheduleLocalId: 2019a + ScheduleName: Scheule 2019a (Term 1) + StartDate: 2019-01-30 + EndDate: 2019-04-07 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + AcademicDayList: + AcademicDay: + - RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Schedule 2019a, Day A + 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 + - RefId: 337804c6-1247-4c0f-b288-e4aa28584aad + LocalId: 2019a-B + Name: Schedule 2019a, DayB + PeriodList: + Period: + - RefId: f6776718-4680-4cb7-b649-a84f9796905c + LocalId: 2019a-B1 + Name: Period 1 on Day B + - RefId: 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 + LocalId: 2019a-B2 + Name: Period 2 on Day B + application/xml: + schema: + type: object + properties: + Schedule: + $ref: "#/paths/~1Schedules/get/responses/200/content/application~\ + 1json/schema/properties/Schedules/properties/Schedule/items" + example: >- + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a + Scheule 2019a (Term 1) + 2019-01-30 + 2019-04-07 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Schedule 2019a, Day A + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + + + + 337804c6-1247-4c0f-b288-e4aa28584aad + 2019a-B + Schedule 2019a, DayB + + + f6776718-4680-4cb7-b649-a84f9796905c + 2019a-B1 + Period 1 on Day B + + + 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 + 2019a-B2 + Period 2 on Day B + + + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - Schedule + summary: Default operation to update a single Schedule + parameters: + - name: ScheduleRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule.

+ required: true + schema: + type: string + operationId: updateSchedule + requestBody: + description: CRUD operation on Schedule + content: + application/json: + schema: + type: object + properties: + Schedule: + type: object + properties: + ScheduleRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + ScheduleLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + ScheduleName: + type: string + description:

The name of the schedule.

+ StartDate: + type: string + format: date + description:

The start date of the schedule.

+ EndDate: + type: string + format: date + description:

The end date of the schedule.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1Schedules~1%7BScheduleRefId%7D/put/reque\ + stBody/content/application~1json/schema/properties/\ + Schedule/properties/ScheduleRefId" + LocalId: + $ref: "#/paths/~1Schedules~1%7BScheduleRefId%7D/put/reque\ + stBody/content/application~1json/schema/properties/\ + Schedule/properties/ScheduleLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + AcademicDayList: + description:

A list of the academic days within this schedule.

+ type: object + properties: + AcademicDay: + type: array + items: + description:

An academic day that is part of this + schedule

+ type: object + properties: + BellSchedule: + $ref: "#/paths/~1Schedules~1%7BScheduleRefId%7D/put\ + /requestBody/content/application~1json/schema\ + /properties/Schedule/properties/Provider" + PeriodList: + description:

A list of the periods that make up this + academic day, e.g. Period 1, Period 2 etc.

+ type: object + properties: + Period: + type: array + items: + $ref: "#/paths/~1Schedules~1%7BScheduleRefId%\ + 7D/put/requestBody/content/application~\ + 1json/schema/properties/Schedule/proper\ + ties/Provider" + description: Provides information about a schedule for a provider. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + Schedule: + ScheduleRefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + ScheduleLocalId: 2019a + ScheduleName: Scheule 2019a (Term 1) + StartDate: 2019-01-30 + EndDate: 2019-04-07 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + AcademicDayList: + AcademicDay: + - RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Schedule 2019a, Day A + 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 + - RefId: 337804c6-1247-4c0f-b288-e4aa28584aad + LocalId: 2019a-B + Name: Schedule 2019a, DayB + PeriodList: + Period: + - RefId: f6776718-4680-4cb7-b649-a84f9796905c + LocalId: 2019a-B1 + Name: Period 1 on Day B + - RefId: 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 + LocalId: 2019a-B2 + Name: Period 2 on Day B + application/xml: + schema: + type: object + properties: + Schedule: + $ref: "#/paths/~1Schedules~1%7BScheduleRefId%7D/put/requestBody/c\ + ontent/application~1json/schema/properties/Schedule" + example: >- + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a + Scheule 2019a (Term 1) + 2019-01-30 + 2019-04-07 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Schedule 2019a, Day A + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + + + + 337804c6-1247-4c0f-b288-e4aa28584aad + 2019a-B + Schedule 2019a, DayB + + + f6776718-4680-4cb7-b649-a84f9796905c + 2019a-B1 + Period 1 on Day B + + + 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 + 2019a-B2 + Period 2 on Day B + + + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - Schedule + summary: Default operation to get a single Schedule + parameters: + - name: ScheduleRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + Schedule: + $ref: "#/paths/~1Schedules/get/responses/200/content/applicatio\ + n~1json/schema/properties/Schedules/properties/Schedule/i\ + tems" + example: + Schedule: + ScheduleRefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + ScheduleLocalId: 2019a + ScheduleName: Scheule 2019a (Term 1) + StartDate: 2019-01-30 + EndDate: 2019-04-07 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + AcademicDayList: + AcademicDay: + - RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Schedule 2019a, Day A + 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 + - RefId: 337804c6-1247-4c0f-b288-e4aa28584aad + LocalId: 2019a-B + Name: Schedule 2019a, DayB + PeriodList: + Period: + - RefId: f6776718-4680-4cb7-b649-a84f9796905c + LocalId: 2019a-B1 + Name: Period 1 on Day B + - RefId: 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 + LocalId: 2019a-B2 + Name: Period 2 on Day B + application/xml: + schema: + type: object + properties: + Schedule: + $ref: "#/paths/~1Schedules/get/responses/200/content/applicatio\ + n~1json/schema/properties/Schedules/properties/Schedule/i\ + tems" + example: >- + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a + Scheule 2019a (Term 1) + 2019-01-30 + 2019-04-07 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Schedule 2019a, Day A + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + + + + 337804c6-1247-4c0f-b288-e4aa28584aad + 2019a-B + Schedule 2019a, DayB + + + f6776718-4680-4cb7-b649-a84f9796905c + 2019a-B1 + Period 1 on Day B + + + 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 + 2019a-B2 + Period 2 on Day B + + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - Schedule + summary: Default operation to delete a single Schedule + parameters: + - name: ScheduleRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /ScheduleAcademicDays: + get: + tags: + - ScheduleAcademicDay + summary: Default operation to get a list of all available ScheduleAcademicDays + description: Search the set of available ScheduleAcademicDays, according to the + search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ScheduleAcademicDays: + type: object + description: A List of ScheduleAcademicDay objects + properties: + ScheduleAcademicDay: + type: array + items: + required: + - AcademicDayName + - PeriodList + - Provider + - Schedule + type: object + properties: + ScheduleAcademicDayRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + ScheduleAcademicDayLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + AcademicDayName: + type: string + description:

The name of the Academic Day.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1ScheduleAcademicDays/get/respons\ + es/200/content/application~1json/schema/pro\ + perties/ScheduleAcademicDays/properties/Sch\ + eduleAcademicDay/items/properties/ScheduleA\ + cademicDayRefId" + LocalId: + $ref: "#/paths/~1ScheduleAcademicDays/get/respons\ + es/200/content/application~1json/schema/pro\ + perties/ScheduleAcademicDays/properties/Sch\ + eduleAcademicDay/items/properties/ScheduleA\ + cademicDayLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Schedule: + $ref: "#/paths/~1ScheduleAcademicDays/get/responses/2\ + 00/content/application~1json/schema/properties/\ + ScheduleAcademicDays/properties/ScheduleAcademi\ + cDay/items/properties/Provider" + BellSchedule: + $ref: "#/paths/~1ScheduleAcademicDays/get/responses/2\ + 00/content/application~1json/schema/properties/\ + ScheduleAcademicDays/properties/ScheduleAcademi\ + cDay/items/properties/Provider" + PeriodList: + description:

A list of periods that make up this academic + day, e.g. Period 1, Period 2 etc.

+ type: object + required: + - Period + properties: + Period: + type: array + items: + $ref: "#/paths/~1ScheduleAcademicDays/get/respo\ + nses/200/content/application~1json/schema\ + /properties/ScheduleAcademicDays/properti\ + es/ScheduleAcademicDay/items/properties/P\ + rovider" + description: An academic day that makes up all or part of a + schedule for a provider. An academic day represents + a structured day that reoccurs consistently e.g. Day + A has five periods that occurs Mon-Wed and Day B has + four periods and occurs Thurs-Fri. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ScheduleAcademicDays: + ScheduleAcademicDay: + - ScheduleAcademicDayRefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + ScheduleAcademicDayLocalId: 2019a-A + AcademicDayName: Scheule 2019a, Day A + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + Name: Scheule 2019a (Term 1) + BellSchedule: + RefId: 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Name: Schedule 2019a, Normal Bell Schedule + 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 + application/xml: + schema: + type: object + properties: + ScheduleAcademicDays: + type: object + description: A List of ScheduleAcademicDay objects + properties: + ScheduleAcademicDay: + type: array + items: + $ref: "#/paths/~1ScheduleAcademicDays/get/responses/200/c\ + ontent/application~1json/schema/properties/Schedule\ + AcademicDays/properties/ScheduleAcademicDay/items" + example: >- + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Schedule 2019a, Normal Bell Schedule + + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/ScheduleAcademicDays/{ScheduleAcademicDayRefId}": + post: + tags: + - ScheduleAcademicDay + summary: Default operation to create a single ScheduleAcademicDay + parameters: + - name: ScheduleAcademicDayRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Academic + Day.

+ required: true + schema: + type: string + operationId: createScheduleAcademicDay + requestBody: + description: CRUD operation on ScheduleAcademicDay + content: + application/json: + schema: + type: object + properties: + ScheduleAcademicDay: + $ref: "#/paths/~1ScheduleAcademicDays/get/responses/200/content/a\ + pplication~1json/schema/properties/ScheduleAcademicDays/pro\ + perties/ScheduleAcademicDay/items" + example: + ScheduleAcademicDay: + ScheduleAcademicDayRefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + ScheduleAcademicDayLocalId: 2019a-A + AcademicDayName: Scheule 2019a, Day A + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + Name: Scheule 2019a (Term 1) + BellSchedule: + RefId: 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Name: Schedule 2019a, Normal Bell Schedule + 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 + application/xml: + schema: + type: object + properties: + ScheduleAcademicDay: + $ref: "#/paths/~1ScheduleAcademicDays/get/responses/200/content/a\ + pplication~1json/schema/properties/ScheduleAcademicDays/pro\ + perties/ScheduleAcademicDay/items" + example: >- + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Schedule 2019a, Normal Bell Schedule + + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - ScheduleAcademicDay + summary: Default operation to update a single ScheduleAcademicDay + parameters: + - name: ScheduleAcademicDayRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Academic + Day.

+ required: true + schema: + type: string + operationId: updateScheduleAcademicDay + requestBody: + description: CRUD operation on ScheduleAcademicDay + content: + application/json: + schema: + type: object + properties: + ScheduleAcademicDay: + type: object + properties: + ScheduleAcademicDayRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + ScheduleAcademicDayLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + AcademicDayName: + type: string + description:

The name of the Academic Day.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1ScheduleAcademicDays~1%7BScheduleAcademi\ + cDayRefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/ScheduleAcademicDay/propertie\ + s/ScheduleAcademicDayRefId" + LocalId: + $ref: "#/paths/~1ScheduleAcademicDays~1%7BScheduleAcademi\ + cDayRefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/ScheduleAcademicDay/propertie\ + s/ScheduleAcademicDayLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Schedule: + $ref: "#/paths/~1ScheduleAcademicDays~1%7BScheduleAcademicDay\ + RefId%7D/put/requestBody/content/application~1json/sche\ + ma/properties/ScheduleAcademicDay/properties/Provider" + BellSchedule: + $ref: "#/paths/~1ScheduleAcademicDays~1%7BScheduleAcademicDay\ + RefId%7D/put/requestBody/content/application~1json/sche\ + ma/properties/ScheduleAcademicDay/properties/Provider" + PeriodList: + description:

A list of periods that make up this academic day, + e.g. Period 1, Period 2 etc.

+ type: object + properties: + Period: + type: array + items: + $ref: "#/paths/~1ScheduleAcademicDays~1%7BScheduleAcade\ + micDayRefId%7D/put/requestBody/content/applicatio\ + n~1json/schema/properties/ScheduleAcademicDay/pro\ + perties/Provider" + description: An academic day that makes up all or part of a schedule for + a provider. An academic day represents a structured day that + reoccurs consistently e.g. Day A has five periods that + occurs Mon-Wed and Day B has four periods and occurs + Thurs-Fri. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ScheduleAcademicDay: + ScheduleAcademicDayRefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + ScheduleAcademicDayLocalId: 2019a-A + AcademicDayName: Scheule 2019a, Day A + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + Name: Scheule 2019a (Term 1) + BellSchedule: + RefId: 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Name: Schedule 2019a, Normal Bell Schedule + 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 + application/xml: + schema: + type: object + properties: + ScheduleAcademicDay: + $ref: "#/paths/~1ScheduleAcademicDays~1%7BScheduleAcademicDayRefI\ + d%7D/put/requestBody/content/application~1json/schema/prope\ + rties/ScheduleAcademicDay" + example: >- + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Schedule 2019a, Normal Bell Schedule + + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - ScheduleAcademicDay + summary: Default operation to get a single ScheduleAcademicDay + parameters: + - name: ScheduleAcademicDayRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Academic + Day.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ScheduleAcademicDay: + $ref: "#/paths/~1ScheduleAcademicDays/get/responses/200/content\ + /application~1json/schema/properties/ScheduleAcademicDays\ + /properties/ScheduleAcademicDay/items" + example: + ScheduleAcademicDay: + ScheduleAcademicDayRefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + ScheduleAcademicDayLocalId: 2019a-A + AcademicDayName: Scheule 2019a, Day A + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + Name: Scheule 2019a (Term 1) + BellSchedule: + RefId: 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Name: Schedule 2019a, Normal Bell Schedule + 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 + application/xml: + schema: + type: object + properties: + ScheduleAcademicDay: + $ref: "#/paths/~1ScheduleAcademicDays/get/responses/200/content\ + /application~1json/schema/properties/ScheduleAcademicDays\ + /properties/ScheduleAcademicDay/items" + example: >- + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Schedule 2019a, Normal Bell Schedule + + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - ScheduleAcademicDay + summary: Default operation to delete a single ScheduleAcademicDay + parameters: + - name: ScheduleAcademicDayRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Academic + Day.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /SchedulePeriods: + get: + tags: + - SchedulePeriod + summary: Default operation to get a list of all available SchedulePeriods + description: Search the set of available SchedulePeriods, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + SchedulePeriods: + type: object + description: A List of SchedulePeriod objects + properties: + SchedulePeriod: + type: array + items: + required: + - AcademicDay + - PeriodName + - Provider + - Schedule + type: object + properties: + SchedulePeriodRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + SchedulePeriodLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + PeriodName: + type: string + description:

The name of the schedule period.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1SchedulePeriods/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/SchedulePeriods/properties/SchedulePerio\ + d/items/properties/SchedulePeriodRefId" + LocalId: + $ref: "#/paths/~1SchedulePeriods/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/SchedulePeriods/properties/SchedulePerio\ + d/items/properties/SchedulePeriodLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Schedule: + $ref: "#/paths/~1SchedulePeriods/get/responses/200/co\ + ntent/application~1json/schema/properties/Sched\ + ulePeriods/properties/SchedulePeriod/items/prop\ + erties/Provider" + AcademicDay: + $ref: "#/paths/~1SchedulePeriods/get/responses/200/co\ + ntent/application~1json/schema/properties/Sched\ + ulePeriods/properties/SchedulePeriod/items/prop\ + erties/Provider" + description: Defines the periods that take place within an + academic day + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + SchedulePeriods: + SchedulePeriod: + - SchedulePeriodRefId: 215f796c-67f7-4855-83dc-28ad9d002830 + SchedulePeriodLocalId: 2019a-A1 + PeriodName: Period 1 on Day A + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + LocalId: 2019a + Name: Scheule 2019a (Term 1) + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Schedule 2019a, Day A + application/xml: + schema: + type: object + properties: + SchedulePeriods: + type: object + description: A List of SchedulePeriod objects + properties: + SchedulePeriod: + type: array + items: + $ref: "#/paths/~1SchedulePeriods/get/responses/200/conten\ + t/application~1json/schema/properties/SchedulePerio\ + ds/properties/SchedulePeriod/items" + example: >- + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a + Scheule 2019a (Term 1) + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Schedule 2019a, Day A + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/SchedulePeriods/{SchedulePeriodRefId}": + post: + tags: + - SchedulePeriod + summary: Default operation to create a single SchedulePeriod + parameters: + - name: SchedulePeriodRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Period.

+ required: true + schema: + type: string + operationId: createSchedulePeriod + requestBody: + description: CRUD operation on SchedulePeriod + content: + application/json: + schema: + type: object + properties: + SchedulePeriod: + $ref: "#/paths/~1SchedulePeriods/get/responses/200/content/applic\ + ation~1json/schema/properties/SchedulePeriods/properties/Sc\ + hedulePeriod/items" + example: + SchedulePeriod: + SchedulePeriodRefId: 215f796c-67f7-4855-83dc-28ad9d002830 + SchedulePeriodLocalId: 2019a-A1 + PeriodName: Period 1 on Day A + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + LocalId: 2019a + Name: Scheule 2019a (Term 1) + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Schedule 2019a, Day A + application/xml: + schema: + type: object + properties: + SchedulePeriod: + $ref: "#/paths/~1SchedulePeriods/get/responses/200/content/applic\ + ation~1json/schema/properties/SchedulePeriods/properties/Sc\ + hedulePeriod/items" + example: >- + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a + Scheule 2019a (Term 1) + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Schedule 2019a, Day A + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - SchedulePeriod + summary: Default operation to update a single SchedulePeriod + parameters: + - name: SchedulePeriodRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Period.

+ required: true + schema: + type: string + operationId: updateSchedulePeriod + requestBody: + description: CRUD operation on SchedulePeriod + content: + application/json: + schema: + type: object + properties: + SchedulePeriod: + type: object + properties: + SchedulePeriodRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + SchedulePeriodLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + PeriodName: + type: string + description:

The name of the schedule period.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1SchedulePeriods~1%7BSchedulePeriodRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/SchedulePeriod/properties/SchedulePerio\ + dRefId" + LocalId: + $ref: "#/paths/~1SchedulePeriods~1%7BSchedulePeriodRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/SchedulePeriod/properties/SchedulePerio\ + dLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Schedule: + $ref: "#/paths/~1SchedulePeriods~1%7BSchedulePeriodRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/SchedulePeriod/properties/Provider" + AcademicDay: + $ref: "#/paths/~1SchedulePeriods~1%7BSchedulePeriodRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/SchedulePeriod/properties/Provider" + description: Defines the periods that take place within an academic day + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + SchedulePeriod: + SchedulePeriodRefId: 215f796c-67f7-4855-83dc-28ad9d002830 + SchedulePeriodLocalId: 2019a-A1 + PeriodName: Period 1 on Day A + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + LocalId: 2019a + Name: Scheule 2019a (Term 1) + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Schedule 2019a, Day A + application/xml: + schema: + type: object + properties: + SchedulePeriod: + $ref: "#/paths/~1SchedulePeriods~1%7BSchedulePeriodRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/Sche\ + dulePeriod" + example: >- + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a + Scheule 2019a (Term 1) + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Schedule 2019a, Day A + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - SchedulePeriod + summary: Default operation to get a single SchedulePeriod + parameters: + - name: SchedulePeriodRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Period.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + SchedulePeriod: + $ref: "#/paths/~1SchedulePeriods/get/responses/200/content/appl\ + ication~1json/schema/properties/SchedulePeriods/propertie\ + s/SchedulePeriod/items" + example: + SchedulePeriod: + SchedulePeriodRefId: 215f796c-67f7-4855-83dc-28ad9d002830 + SchedulePeriodLocalId: 2019a-A1 + PeriodName: Period 1 on Day A + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + LocalId: 2019a + Name: Scheule 2019a (Term 1) + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Schedule 2019a, Day A + application/xml: + schema: + type: object + properties: + SchedulePeriod: + $ref: "#/paths/~1SchedulePeriods/get/responses/200/content/appl\ + ication~1json/schema/properties/SchedulePeriods/propertie\ + s/SchedulePeriod/items" + example: >- + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a + Scheule 2019a (Term 1) + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Schedule 2019a, Day A + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - SchedulePeriod + summary: Default operation to delete a single SchedulePeriod + parameters: + - name: SchedulePeriodRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Period.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /BellSchedules: + get: + tags: + - BellSchedule + summary: Default operation to get a list of all available BellSchedules + description: Search the set of available BellSchedules, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + BellSchedules: + type: object + description: A List of BellSchedule objects + properties: + BellSchedule: + type: array + items: + required: + - BellScheduleName + - Provider + - Schedule + - SchedulePeriodList + type: object + properties: + BellScheduleRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + BellScheduleLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + BellScheduleName: + type: string + description:

The name of the Bell Schedule.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1BellSchedules/get/responses/200/\ + content/application~1json/schema/properties\ + /BellSchedules/properties/BellSchedule/item\ + s/properties/BellScheduleRefId" + LocalId: + $ref: "#/paths/~1BellSchedules/get/responses/200/\ + content/application~1json/schema/properties\ + /BellSchedules/properties/BellSchedule/item\ + s/properties/BellScheduleLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Schedule: + $ref: "#/paths/~1BellSchedules/get/responses/200/cont\ + ent/application~1json/schema/properties/BellSch\ + edules/properties/BellSchedule/items/properties\ + /Provider" + SchedulePeriodList: + description:

A list of periods that make up this academic + day, e.g. Period 1, Period 2 etc.

+ type: object + required: + - SchedulePeriodTime + properties: + SchedulePeriodTime: + type: array + items: + description:

The definition of a SchedulePeriod + start and end time, on a particular Bell + Schedule.

+ type: object + required: + - EndTime + - Period + - SchedulePeriodTimeType + - StartTime + properties: + Period: + $ref: "#/paths/~1BellSchedules/get/response\ + s/200/content/application~1json/schem\ + a/properties/BellSchedules/properties\ + /BellSchedule/items/properties/Provid\ + er" + StartTime: + description:

The time the period starts.

+ EndTime: + description:

The time the period ends.

+ description: Defines bell schedules, each of which is a + collection of periods within an academic day with + start and end times associated. These bell schedules + are assigned to calendar dates on which the school + is in session using ScheduleDate in order to specify + the school schedule on those dates. These bell + schedules should generally only be used to define + standard day types. Exception days (unless they + repeat multiple times and follow a common template) + are defined using ScheduleEvent and + ScheduleCustomDayEvent. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + BellSchedules: + BellSchedule: + - BellScheduleRefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + BellScheduleLocalId: 2019a-Normal + BellScheduleName: Schedule 2019a, Normal Bell Schedule + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + Name: Scheule 2019a (Term 1) + SchedulePeriodList: + SchedulePeriodTime: + - Period: + RefId: 215f796c-67f7-4855-83dc-28ad9d002830 + LocalId: 2019a-A1 + Name: Period 1 on Day A + StartTime: 08:45:00 + EndTime: 09:35:00 + - Period: + RefId: 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + LocalId: 2019a-A2 + Name: Period 2 on Day A + StartTime: 09:45:00 + EndTime: 10:35:00 + application/xml: + schema: + type: object + properties: + BellSchedules: + type: object + description: A List of BellSchedule objects + properties: + BellSchedule: + type: array + items: + $ref: "#/paths/~1BellSchedules/get/responses/200/content/\ + application~1json/schema/properties/BellSchedules/p\ + roperties/BellSchedule/items" + example: >- + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a-Normal + Schedule 2019a, Normal Bell Schedule + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + Scheule 2019a (Term 1) + + + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + 08:45:00 + 09:35:00 + + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + 09:45:00 + 10:35:00 + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/BellSchedules/{BellScheduleRefId}": + post: + tags: + - BellSchedule + summary: Default operation to create a single BellSchedule + parameters: + - name: BellScheduleRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Bell + Schedule.

+ required: true + schema: + type: string + operationId: createBellSchedule + requestBody: + description: CRUD operation on BellSchedule + content: + application/json: + schema: + type: object + properties: + BellSchedule: + $ref: "#/paths/~1BellSchedules/get/responses/200/content/applicat\ + ion~1json/schema/properties/BellSchedules/properties/BellSc\ + hedule/items" + example: + BellSchedule: + BellScheduleRefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + BellScheduleLocalId: 2019a-Normal + BellScheduleName: Schedule 2019a, Normal Bell Schedule + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + Name: Scheule 2019a (Term 1) + SchedulePeriodList: + SchedulePeriodTime: + - Period: + RefId: 215f796c-67f7-4855-83dc-28ad9d002830 + LocalId: 2019a-A1 + Name: Period 1 on Day A + StartTime: 08:45:00 + EndTime: 09:35:00 + - Period: + RefId: 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + LocalId: 2019a-A2 + Name: Period 2 on Day A + StartTime: 09:45:00 + EndTime: 10:35:00 + application/xml: + schema: + type: object + properties: + BellSchedule: + $ref: "#/paths/~1BellSchedules/get/responses/200/content/applicat\ + ion~1json/schema/properties/BellSchedules/properties/BellSc\ + hedule/items" + example: >- + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a-Normal + Schedule 2019a, Normal Bell Schedule + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + Scheule 2019a (Term 1) + + + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + 08:45:00 + 09:35:00 + + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + 09:45:00 + 10:35:00 + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - BellSchedule + summary: Default operation to update a single BellSchedule + parameters: + - name: BellScheduleRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Bell + Schedule.

+ required: true + schema: + type: string + operationId: updateBellSchedule + requestBody: + description: CRUD operation on BellSchedule + content: + application/json: + schema: + type: object + properties: + BellSchedule: + type: object + properties: + BellScheduleRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + BellScheduleLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + BellScheduleName: + type: string + description:

The name of the Bell Schedule.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1BellSchedules~1%7BBellScheduleRefId%7D/p\ + ut/requestBody/content/application~1json/schema/pro\ + perties/BellSchedule/properties/BellScheduleRefId" + LocalId: + $ref: "#/paths/~1BellSchedules~1%7BBellScheduleRefId%7D/p\ + ut/requestBody/content/application~1json/schema/pro\ + perties/BellSchedule/properties/BellScheduleLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Schedule: + $ref: "#/paths/~1BellSchedules~1%7BBellScheduleRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/\ + BellSchedule/properties/Provider" + SchedulePeriodList: + description:

A list of periods that make up this academic day, + e.g. Period 1, Period 2 etc.

+ type: object + properties: + SchedulePeriodTime: + type: array + items: + description:

The definition of a SchedulePeriod start and + end time, on a particular Bell Schedule.

+ type: object + properties: + Period: + $ref: "#/paths/~1BellSchedules~1%7BBellScheduleRefI\ + d%7D/put/requestBody/content/application~1jso\ + n/schema/properties/BellSchedule/properties/P\ + rovider" + StartTime: + description:

The time the period starts.

+ EndTime: + description:

The time the period ends.

+ description: Defines bell schedules, each of which is a collection of + periods within an academic day with start and end times + associated. These bell schedules are assigned to calendar + dates on which the school is in session using ScheduleDate + in order to specify the school schedule on those dates. + These bell schedules should generally only be used to define + standard day types. Exception days (unless they repeat + multiple times and follow a common template) are defined + using ScheduleEvent and ScheduleCustomDayEvent. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + BellSchedule: + BellScheduleRefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + BellScheduleLocalId: 2019a-Normal + BellScheduleName: Schedule 2019a, Normal Bell Schedule + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + Name: Scheule 2019a (Term 1) + SchedulePeriodList: + SchedulePeriodTime: + - Period: + RefId: 215f796c-67f7-4855-83dc-28ad9d002830 + LocalId: 2019a-A1 + Name: Period 1 on Day A + StartTime: 08:45:00 + EndTime: 09:35:00 + - Period: + RefId: 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + LocalId: 2019a-A2 + Name: Period 2 on Day A + StartTime: 09:45:00 + EndTime: 10:35:00 + application/xml: + schema: + type: object + properties: + BellSchedule: + $ref: "#/paths/~1BellSchedules~1%7BBellScheduleRefId%7D/put/reque\ + stBody/content/application~1json/schema/properties/BellSche\ + dule" + example: >- + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a-Normal + Schedule 2019a, Normal Bell Schedule + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + Scheule 2019a (Term 1) + + + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + 08:45:00 + 09:35:00 + + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + 09:45:00 + 10:35:00 + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - BellSchedule + summary: Default operation to get a single BellSchedule + parameters: + - name: BellScheduleRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Bell + Schedule.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + BellSchedule: + $ref: "#/paths/~1BellSchedules/get/responses/200/content/applic\ + ation~1json/schema/properties/BellSchedules/properties/Be\ + llSchedule/items" + example: + BellSchedule: + BellScheduleRefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + BellScheduleLocalId: 2019a-Normal + BellScheduleName: Schedule 2019a, Normal Bell Schedule + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Schedule: + Name: Scheule 2019a (Term 1) + SchedulePeriodList: + SchedulePeriodTime: + - Period: + RefId: 215f796c-67f7-4855-83dc-28ad9d002830 + LocalId: 2019a-A1 + Name: Period 1 on Day A + StartTime: 08:45:00 + EndTime: 09:35:00 + - Period: + RefId: 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + LocalId: 2019a-A2 + Name: Period 2 on Day A + StartTime: 09:45:00 + EndTime: 10:35:00 + application/xml: + schema: + type: object + properties: + BellSchedule: + $ref: "#/paths/~1BellSchedules/get/responses/200/content/applic\ + ation~1json/schema/properties/BellSchedules/properties/Be\ + llSchedule/items" + example: >- + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + 2019a-Normal + Schedule 2019a, Normal Bell Schedule + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + Scheule 2019a (Term 1) + + + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + 08:45:00 + 09:35:00 + + + + 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 + 2019a-A2 + Period 2 on Day A + + 09:45:00 + 10:35:00 + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - BellSchedule + summary: Default operation to delete a single BellSchedule + parameters: + - name: BellScheduleRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Bell + Schedule.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /ScheduleTerms: + get: + tags: + - ScheduleTerm + summary: Default operation to get a list of all available ScheduleTerms + description: Search the set of available ScheduleTerms, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ScheduleTerms: + type: object + description: A List of ScheduleTerm objects + properties: + ScheduleTerm: + type: array + items: + required: + - EndDate + - SchoolYear + - StartDate + - TermName + type: object + properties: + ScheduleTermRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + ScheduleTermLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + TermName: + type: string + description:

The name of the schedule term.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1ScheduleTerms/get/responses/200/\ + content/application~1json/schema/properties\ + /ScheduleTerms/properties/ScheduleTerm/item\ + s/properties/ScheduleTermRefId" + LocalId: + $ref: "#/paths/~1ScheduleTerms/get/responses/200/\ + content/application~1json/schema/properties\ + /ScheduleTerms/properties/ScheduleTerm/item\ + s/properties/ScheduleTermLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + SchoolYear: + description:

The school year the Term is part of.

+ StartDate: + type: string + format: date + description:

The start date of the term

+ EndDate: + type: string + format: date + description:

The end date of the term

+ description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ScheduleTerms: + ScheduleTerm: + - ScheduleTermRefId: eed03e3c-b088-4b69-bba7-b042f6f7a040 + ScheduleTermLocalId: 2019-1 + TermName: Term I of 2019 + StartDate: 2019-01-28 + EndDate: 2019-03-13 + application/xml: + schema: + type: object + properties: + ScheduleTerms: + type: object + description: A List of ScheduleTerm objects + properties: + ScheduleTerm: + type: array + items: + $ref: "#/paths/~1ScheduleTerms/get/responses/200/content/\ + application~1json/schema/properties/ScheduleTerms/p\ + roperties/ScheduleTerm/items" + example: >- + + + eed03e3c-b088-4b69-bba7-b042f6f7a040 + 2019-1 + Term I of 2019 + 2019-01-28 + 2019-03-13 + + + default: + description: Failed to retrieve object(s). + content: + application/json: + schema: + type: object + properties: + error: + $ref: "#/components/errors/query/content/application~1json/sche\ + ma/properties/error" + application/xml: + schema: + type: object + properties: + error: + $ref: "#/components/errors/query/content/application~1json/sche\ + ma/properties/error" + "/ScheduleTerms/{ScheduleTermRefId}": + post: + tags: + - ScheduleTerm + summary: Default operation to create a single ScheduleTerm + parameters: + - name: ScheduleTermRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Term.

+ required: true + schema: + type: string + operationId: createScheduleTerm + requestBody: + description: CRUD operation on ScheduleTerm + content: + application/json: + schema: + type: object + properties: + ScheduleTerm: + $ref: "#/paths/~1ScheduleTerms/get/responses/200/content/applicat\ + ion~1json/schema/properties/ScheduleTerms/properties/Schedu\ + leTerm/items" + example: + ScheduleTerm: + ScheduleTermRefId: eed03e3c-b088-4b69-bba7-b042f6f7a040 + ScheduleTermLocalId: 2019-1 + TermName: Term I of 2019 + StartDate: 2019-01-28 + EndDate: 2019-03-13 + application/xml: + schema: + type: object + properties: + ScheduleTerm: + $ref: "#/paths/~1ScheduleTerms/get/responses/200/content/applicat\ + ion~1json/schema/properties/ScheduleTerms/properties/Schedu\ + leTerm/items" + example: >- + + eed03e3c-b088-4b69-bba7-b042f6f7a040 + 2019-1 + Term I of 2019 + 2019-01-28 + 2019-03-13 + + responses: + "200": + description: Successfully created object(s). + content: + application/json: + schema: + $ref: "#/components/errors/create/content/application~1json/schema" + application/xml: + schema: + $ref: "#/components/errors/create/content/application~1json/schema" + default: + description: Failed to create object(s). + content: + application/json: + schema: + $ref: "#/components/errors/create/content/application~1json/schema" + application/xml: + schema: + $ref: "#/components/errors/create/content/application~1json/schema" + put: + tags: + - ScheduleTerm + summary: Default operation to update a single ScheduleTerm + parameters: + - name: ScheduleTermRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Term.

+ required: true + schema: + type: string + operationId: updateScheduleTerm + requestBody: + description: CRUD operation on ScheduleTerm + content: + application/json: + schema: + type: object + properties: + ScheduleTerm: + type: object + properties: + ScheduleTermRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + ScheduleTermLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + TermName: + type: string + description:

The name of the schedule term.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/p\ + ut/requestBody/content/application~1json/schema/pro\ + perties/ScheduleTerm/properties/ScheduleTermRefId" + LocalId: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/p\ + ut/requestBody/content/application~1json/schema/pro\ + perties/ScheduleTerm/properties/ScheduleTermLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + SchoolYear: + description:

The school year the Term is part of.

+ StartDate: + type: string + format: date + description:

The start date of the term

+ EndDate: + type: string + format: date + description:

The end date of the term

+ description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ScheduleTerm: + ScheduleTermRefId: eed03e3c-b088-4b69-bba7-b042f6f7a040 + ScheduleTermLocalId: 2019-1 + TermName: Term I of 2019 + StartDate: 2019-01-28 + EndDate: 2019-03-13 + application/xml: + schema: + type: object + properties: + ScheduleTerm: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/reque\ + stBody/content/application~1json/schema/properties/Schedule\ + Term" + example: >- + + eed03e3c-b088-4b69-bba7-b042f6f7a040 + 2019-1 + Term I of 2019 + 2019-01-28 + 2019-03-13 + + responses: + "200": + description: Successfully updated object(s). + content: + application/json: + schema: + $ref: "#/components/errors/update/content/application~1json/schema" + application/xml: + schema: + $ref: "#/components/errors/update/content/application~1json/schema" + default: + description: Failed to update object(s). + content: + application/json: + schema: + $ref: "#/components/errors/update/content/application~1json/schema" + application/xml: + schema: + $ref: "#/components/errors/update/content/application~1json/schema" + get: + tags: + - ScheduleTerm + summary: Default operation to get a single ScheduleTerm + parameters: + - name: ScheduleTermRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Term.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ScheduleTerm: + $ref: "#/paths/~1ScheduleTerms/get/responses/200/content/applic\ + ation~1json/schema/properties/ScheduleTerms/properties/Sc\ + heduleTerm/items" + example: + ScheduleTerm: + ScheduleTermRefId: eed03e3c-b088-4b69-bba7-b042f6f7a040 + ScheduleTermLocalId: 2019-1 + TermName: Term I of 2019 + StartDate: 2019-01-28 + EndDate: 2019-03-13 + application/xml: + schema: + type: object + properties: + ScheduleTerm: + $ref: "#/paths/~1ScheduleTerms/get/responses/200/content/applic\ + ation~1json/schema/properties/ScheduleTerms/properties/Sc\ + heduleTerm/items" + example: >- + + eed03e3c-b088-4b69-bba7-b042f6f7a040 + 2019-1 + Term I of 2019 + 2019-01-28 + 2019-03-13 + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - ScheduleTerm + summary: Default operation to delete a single ScheduleTerm + parameters: + - name: ScheduleTermRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Term.

+ required: true + schema: + type: string + responses: + "200": + description: Successfully deleted object(s). + content: + application/json: + schema: + $ref: "#/components/errors/delete/content/application~1json/schema" + application/xml: + schema: + $ref: "#/components/errors/delete/content/application~1json/schema" + default: + description: Failed to delete object(s). + content: + application/json: + schema: + $ref: "#/components/errors/delete/content/application~1json/schema" + application/xml: + schema: + $ref: "#/components/errors/delete/content/application~1json/schema" + /ScheduleHolidays: + get: + tags: + - ScheduleHoliday + summary: Default operation to get a list of all available ScheduleHolidays + description: Search the set of available ScheduleHoldiays, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ScheduleHolidays: + type: object + description: A List of ScheduleHoliday objects + properties: + ScheduleHoliday: + type: array + items: + required: + - AlwaysDisplayFlag + - HolidayDate + - HolidayName + type: object + properties: + ScheduleHolidayRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + ScheduleHolidayLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1ScheduleHolidays/get/responses/2\ + 00/content/application~1json/schema/propert\ + ies/ScheduleHolidays/properties/ScheduleHol\ + iday/items/properties/ScheduleHolidayRefId" + LocalId: + $ref: "#/paths/~1ScheduleHolidays/get/responses/2\ + 00/content/application~1json/schema/propert\ + ies/ScheduleHolidays/properties/ScheduleHol\ + iday/items/properties/ScheduleHolidayLocalI\ + d" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + HolidayDate: + type: string + format: date + description:

The date of the holiday

+ HolidayName: + type: string + description:

The name of the holiday.

+ HolidayLongName: + type: string + description:

The long description of the holiday, if there + is one.

+ AlwaysDisplayFlag: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ScheduleHolidays: + ScheduleHoliday: + - ScheduleHolidayRefId: 4e8387f0-faed-4eb5-84ef-2139da62133d + ScheduleHolidayLocalId: 2019-ANZAC + HolidayDate: 2019-04-25 + HolidayName: ANZAC Day + HolidayLongName: ANZAC Day, 2019 + AlwaysDisplayFlag: Y + application/xml: + schema: + type: object + properties: + ScheduleHolidays: + type: object + description: A List of ScheduleHoliday objects + properties: + ScheduleHoliday: + type: array + items: + $ref: "#/paths/~1ScheduleHolidays/get/responses/200/conte\ + nt/application~1json/schema/properties/ScheduleHoli\ + days/properties/ScheduleHoliday/items" + example: >- + + + 4e8387f0-faed-4eb5-84ef-2139da62133d + 2019-ANZAC + 2019-04-25 + ANZAC Day + ANZAC Day, 2019 + Y + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/ScheduleHolidays/{ScheduleHolidayRefId}": + post: + tags: + - ScheduleHoliday + summary: Default operation to create a single ScheduleHoliday + parameters: + - name: ScheduleHolidayRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Term.

+ required: true + schema: + type: string + operationId: createScheduleHoliday + requestBody: + description: CRUD operation on ScheduleHoliday + content: + application/json: + schema: + type: object + properties: + ScheduleHoliday: + $ref: "#/paths/~1ScheduleHolidays/get/responses/200/content/appli\ + cation~1json/schema/properties/ScheduleHolidays/properties/\ + ScheduleHoliday/items" + example: + ScheduleHoliday: + ScheduleHolidayRefId: 4e8387f0-faed-4eb5-84ef-2139da62133d + ScheduleHolidayLocalId: 2019-ANZAC + HolidayDate: 2019-04-25 + HolidayName: ANZAC Day + HolidayLongName: ANZAC Day, 2019 + AlwaysDisplayFlag: Y + application/xml: + schema: + type: object + properties: + ScheduleHoliday: + $ref: "#/paths/~1ScheduleHolidays/get/responses/200/content/appli\ + cation~1json/schema/properties/ScheduleHolidays/properties/\ + ScheduleHoliday/items" + example: >- + + 4e8387f0-faed-4eb5-84ef-2139da62133d + 2019-ANZAC + 2019-04-25 + ANZAC Day + ANZAC Day, 2019 + Y + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - ScheduleHoliday + summary: Default operation to update a single ScheduleHoliday + parameters: + - name: ScheduleHolidayRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Term.

+ required: true + schema: + type: string + operationId: updateScheduleHoliday + requestBody: + description: CRUD operation on ScheduleHoliday + content: + application/json: + schema: + type: object + properties: + ScheduleHoliday: + type: object + properties: + ScheduleHolidayRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + ScheduleHolidayLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1ScheduleHolidays~1%7BScheduleHolidayRefI\ + d%7D/put/requestBody/content/application~1json/sche\ + ma/properties/ScheduleHoliday/properties/ScheduleHo\ + lidayRefId" + LocalId: + $ref: "#/paths/~1ScheduleHolidays~1%7BScheduleHolidayRefI\ + d%7D/put/requestBody/content/application~1json/sche\ + ma/properties/ScheduleHoliday/properties/ScheduleHo\ + lidayLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + HolidayDate: + type: string + format: date + description:

The date of the holiday

+ HolidayName: + type: string + description:

The name of the holiday.

+ HolidayLongName: + type: string + description:

The long description of the holiday, if there is + one.

+ AlwaysDisplayFlag: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ScheduleHoliday: + ScheduleHolidayRefId: 4e8387f0-faed-4eb5-84ef-2139da62133d + ScheduleHolidayLocalId: 2019-ANZAC + HolidayDate: 2019-04-25 + HolidayName: ANZAC Day + HolidayLongName: ANZAC Day, 2019 + AlwaysDisplayFlag: Y + application/xml: + schema: + type: object + properties: + ScheduleHoliday: + $ref: "#/paths/~1ScheduleHolidays~1%7BScheduleHolidayRefId%7D/put\ + /requestBody/content/application~1json/schema/properties/Sc\ + heduleHoliday" + example: >- + + 4e8387f0-faed-4eb5-84ef-2139da62133d + 2019-ANZAC + 2019-04-25 + ANZAC Day + ANZAC Day, 2019 + Y + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - ScheduleHoliday + summary: Default operation to get a single ScheduleHoliday + parameters: + - name: ScheduleHolidayRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Term.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ScheduleHoliday: + $ref: "#/paths/~1ScheduleHolidays/get/responses/200/content/app\ + lication~1json/schema/properties/ScheduleHolidays/propert\ + ies/ScheduleHoliday/items" + example: + ScheduleHoliday: + ScheduleHolidayRefId: 4e8387f0-faed-4eb5-84ef-2139da62133d + ScheduleHolidayLocalId: 2019-ANZAC + HolidayDate: 2019-04-25 + HolidayName: ANZAC Day + HolidayLongName: ANZAC Day, 2019 + AlwaysDisplayFlag: Y + application/xml: + schema: + type: object + properties: + ScheduleHoliday: + $ref: "#/paths/~1ScheduleHolidays/get/responses/200/content/app\ + lication~1json/schema/properties/ScheduleHolidays/propert\ + ies/ScheduleHoliday/items" + example: >- + + 4e8387f0-faed-4eb5-84ef-2139da62133d + 2019-ANZAC + 2019-04-25 + ANZAC Day + ANZAC Day, 2019 + Y + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - ScheduleHoliday + summary: Default operation to delete a single ScheduleHoliday + parameters: + - name: ScheduleHolidayRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Term.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /ScheduleDates: + get: + tags: + - ScheduleDate + summary: Default operation to get a list of all available ScheduleDates + description: Search the set of available ScheduleDates, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ScheduleDates: + type: object + description: A List of ScheduleDate objects + properties: + ScheduleDate: + type: array + items: + required: + - AcademicDay + - CalendarDate + - Provider + - Schedule + type: object + properties: + ScheduleDateRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + ScheduleDateLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + CalendarDate: + type: string + description:

The actual date the school is in session.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1ScheduleDates/get/responses/200/\ + content/application~1json/schema/properties\ + /ScheduleDates/properties/ScheduleDate/item\ + s/properties/ScheduleDateRefId" + LocalId: + $ref: "#/paths/~1ScheduleDates/get/responses/200/\ + content/application~1json/schema/properties\ + /ScheduleDates/properties/ScheduleDate/item\ + s/properties/ScheduleDateLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Term: + $ref: "#/paths/~1ScheduleDates/get/responses/200/cont\ + ent/application~1json/schema/properties/Schedul\ + eDates/properties/ScheduleDate/items/properties\ + /Provider" + Schedule: + $ref: "#/paths/~1ScheduleDates/get/responses/200/cont\ + ent/application~1json/schema/properties/Schedul\ + eDates/properties/ScheduleDate/items/properties\ + /Provider" + AcademicDay: + $ref: "#/paths/~1ScheduleDates/get/responses/200/cont\ + ent/application~1json/schema/properties/Schedul\ + eDates/properties/ScheduleDate/items/properties\ + /Provider" + BellSchedule: + $ref: "#/paths/~1ScheduleDates/get/responses/200/cont\ + ent/application~1json/schema/properties/Schedul\ + eDates/properties/ScheduleDate/items/properties\ + /Provider" + TeachingGroupEventList: + description:

List of generic object references to the set + of TeachingGroupEvents that take place on this + calendar date.

+ type: object + required: + - Event + properties: + Event: + type: array + items: + $ref: "#/paths/~1ScheduleDates/get/responses/20\ + 0/content/application~1json/schema/proper\ + ties/ScheduleDates/properties/ScheduleDat\ + e/items/properties/Provider" + description: Provides information about the schedule that is + being followed on a specific calendar date at a + particular Provider, e.g. Academic Day A from the + Term 1 Schedule using the Periods and their start + and end times defined in Bell Schedule Day A. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ScheduleDates: + ScheduleDate: + - ScheduleDateRefId: 84c40f87-769d-46cc-8077-f5efb912e099 + ScheduleDateLocalId: 2019a-A-06 + CalendarDate: 2019-03-14 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Term: + RefId: 2f97ed99-7291-4b88-91c3-709be4308c63 + Name: Hogwarts High, Term I, 2019 + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + Name: Scheule 2019a (Term 1) + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Scheule 2019a, Day A + BellSchedule: + RefId: 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Name: Schedule 2019a, Normal Bell Schedule + application/xml: + schema: + type: object + properties: + ScheduleDates: + type: object + description: A List of ScheduleDate objects + properties: + ScheduleDate: + type: array + items: + $ref: "#/paths/~1ScheduleDates/get/responses/200/content/\ + application~1json/schema/properties/ScheduleDates/p\ + roperties/ScheduleDate/items" + example: >- + + + 84c40f87-769d-46cc-8077-f5efb912e099 + 2019a-A-06 + 2019-03-14 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + 2f97ed99-7291-4b88-91c3-709be4308c63 + Hogwarts High, Term I, 2019 + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + + 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Schedule 2019a, Normal Bell Schedule + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/ScheduleDates/{ScheduleDateRefId}": + post: + tags: + - ScheduleDate + summary: Default operation to create a single ScheduleDate + parameters: + - name: ScheduleDateRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Date.

+ required: true + schema: + type: string + operationId: createScheduleDate + requestBody: + description: CRUD operation on ScheduleDate + content: + application/json: + schema: + type: object + properties: + ScheduleDate: + $ref: "#/paths/~1ScheduleDates/get/responses/200/content/applicat\ + ion~1json/schema/properties/ScheduleDates/properties/Schedu\ + leDate/items" + example: + ScheduleDate: + ScheduleDateRefId: 84c40f87-769d-46cc-8077-f5efb912e099 + ScheduleDateLocalId: 2019a-A-06 + CalendarDate: 2019-03-14 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Term: + RefId: 2f97ed99-7291-4b88-91c3-709be4308c63 + Name: Hogwarts High, Term I, 2019 + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + Name: Scheule 2019a (Term 1) + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Scheule 2019a, Day A + BellSchedule: + RefId: 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Name: Schedule 2019a, Normal Bell Schedule + application/xml: + schema: + type: object + properties: + ScheduleDate: + $ref: "#/paths/~1ScheduleDates/get/responses/200/content/applicat\ + ion~1json/schema/properties/ScheduleDates/properties/Schedu\ + leDate/items" + example: >- + + 84c40f87-769d-46cc-8077-f5efb912e099 + 2019a-A-06 + 2019-03-14 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + 2f97ed99-7291-4b88-91c3-709be4308c63 + Hogwarts High, Term I, 2019 + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + + 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Schedule 2019a, Normal Bell Schedule + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - ScheduleDate + summary: Default operation to update a single ScheduleDate + parameters: + - name: ScheduleDateRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Date.

+ required: true + schema: + type: string + operationId: updateScheduleDate + requestBody: + description: CRUD operation on ScheduleDate + content: + application/json: + schema: + type: object + properties: + ScheduleDate: + type: object + properties: + ScheduleDateRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + ScheduleDateLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + CalendarDate: + type: string + description:

The actual date the school is in session.

+ Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1ScheduleDates~1%7BScheduleDateRefId%7D/p\ + ut/requestBody/content/application~1json/schema/pro\ + perties/ScheduleDate/properties/ScheduleDateRefId" + LocalId: + $ref: "#/paths/~1ScheduleDates~1%7BScheduleDateRefId%7D/p\ + ut/requestBody/content/application~1json/schema/pro\ + perties/ScheduleDate/properties/ScheduleDateLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Term: + $ref: "#/paths/~1ScheduleDates~1%7BScheduleDateRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/\ + ScheduleDate/properties/Provider" + Schedule: + $ref: "#/paths/~1ScheduleDates~1%7BScheduleDateRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/\ + ScheduleDate/properties/Provider" + AcademicDay: + $ref: "#/paths/~1ScheduleDates~1%7BScheduleDateRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/\ + ScheduleDate/properties/Provider" + BellSchedule: + $ref: "#/paths/~1ScheduleDates~1%7BScheduleDateRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/\ + ScheduleDate/properties/Provider" + TeachingGroupEventList: + description:

List of generic object references to the set of + TeachingGroupEvents that take place on this calendar + date.

+ type: object + properties: + Event: + type: array + items: + $ref: "#/paths/~1ScheduleDates~1%7BScheduleDateRefId%7D\ + /put/requestBody/content/application~1json/schema\ + /properties/ScheduleDate/properties/Provider" + description: Provides information about the schedule that is being + followed on a specific calendar date at a particular + Provider, e.g. Academic Day A from the Term 1 Schedule using + the Periods and their start and end times defined in Bell + Schedule Day A. + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ScheduleDate: + ScheduleDateRefId: 84c40f87-769d-46cc-8077-f5efb912e099 + ScheduleDateLocalId: 2019a-A-06 + CalendarDate: 2019-03-14 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Term: + RefId: 2f97ed99-7291-4b88-91c3-709be4308c63 + Name: Hogwarts High, Term I, 2019 + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + Name: Scheule 2019a (Term 1) + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Scheule 2019a, Day A + BellSchedule: + RefId: 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Name: Schedule 2019a, Normal Bell Schedule + application/xml: + schema: + type: object + properties: + ScheduleDate: + $ref: "#/paths/~1ScheduleDates~1%7BScheduleDateRefId%7D/put/reque\ + stBody/content/application~1json/schema/properties/Schedule\ + Date" + example: >- + + 84c40f87-769d-46cc-8077-f5efb912e099 + 2019a-A-06 + 2019-03-14 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + 2f97ed99-7291-4b88-91c3-709be4308c63 + Hogwarts High, Term I, 2019 + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + + 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Schedule 2019a, Normal Bell Schedule + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - ScheduleDate + summary: Default operation to get a single ScheduleDate + parameters: + - name: ScheduleDateRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Date.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ScheduleDate: + $ref: "#/paths/~1ScheduleDates/get/responses/200/content/applic\ + ation~1json/schema/properties/ScheduleDates/properties/Sc\ + heduleDate/items" + example: + ScheduleDate: + ScheduleDateRefId: 84c40f87-769d-46cc-8077-f5efb912e099 + ScheduleDateLocalId: 2019a-A-06 + CalendarDate: 2019-03-14 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + Term: + RefId: 2f97ed99-7291-4b88-91c3-709be4308c63 + Name: Hogwarts High, Term I, 2019 + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + Name: Scheule 2019a (Term 1) + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Scheule 2019a, Day A + BellSchedule: + RefId: 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Name: Schedule 2019a, Normal Bell Schedule + application/xml: + schema: + type: object + properties: + ScheduleDate: + $ref: "#/paths/~1ScheduleDates/get/responses/200/content/applic\ + ation~1json/schema/properties/ScheduleDates/properties/Sc\ + heduleDate/items" + example: >- + + 84c40f87-769d-46cc-8077-f5efb912e099 + 2019a-A-06 + 2019-03-14 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + 2f97ed99-7291-4b88-91c3-709be4308c63 + Hogwarts High, Term I, 2019 + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + + 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 + Schedule 2019a, Normal Bell Schedule + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - ScheduleDate + summary: Default operation to delete a single ScheduleDate + parameters: + - name: ScheduleDateRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Schedule + Date.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /TeachingGroupEvents: + get: + tags: + - TeachingGroupEvent + summary: Default operation to get a list of all available TeachingGroupEvents + description: Search the set of available TeachingGroupEvents, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + TeachingGroupEvents: + type: object + description: A List of TeachingGroupEvent objects + properties: + TeachingGroupEvent: + type: array + items: + required: + - Provider + - Schedule + - SchedulePeriod + - TeachingGroup + type: object + properties: + TeachingGroupEventRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + TeachingGroupEventLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1TeachingGroupEvents/get/response\ + s/200/content/application~1json/schema/prop\ + erties/TeachingGroupEvents/properties/Teach\ + ingGroupEvent/items/properties/TeachingGrou\ + pEventRefId" + LocalId: + $ref: "#/paths/~1TeachingGroupEvents/get/response\ + s/200/content/application~1json/schema/prop\ + erties/TeachingGroupEvents/properties/Teach\ + ingGroupEvent/items/properties/TeachingGrou\ + pEventLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + TeachingGroup: + $ref: "#/paths/~1TeachingGroupEvents/get/responses/20\ + 0/content/application~1json/schema/properties/T\ + eachingGroupEvents/properties/TeachingGroupEven\ + t/items/properties/Provider" + Schedule: + $ref: "#/paths/~1TeachingGroupEvents/get/responses/20\ + 0/content/application~1json/schema/properties/T\ + eachingGroupEvents/properties/TeachingGroupEven\ + t/items/properties/Provider" + SchedulePeriod: + $ref: "#/paths/~1TeachingGroupEvents/get/responses/20\ + 0/content/application~1json/schema/properties/T\ + eachingGroupEvents/properties/TeachingGroupEven\ + t/items/properties/Provider" + AcademicDay: + $ref: "#/paths/~1TeachingGroupEvents/get/responses/20\ + 0/content/application~1json/schema/properties/T\ + eachingGroupEvents/properties/TeachingGroupEven\ + t/items/properties/Provider" + RoomId: + type: string + description:

The Id of the room the teaching group is + meeting in.

+ RoomName: + type: string + description:

The name of the room the teaching group is + meeting in.

+ TakeAttendanceFlag: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + TeacherList: + description:

List of the teacher(s) teaching the class + during this timetable event.

+ type: object + required: + - StaffMember + properties: + StaffMember: + type: array + items: + description:

The individual staff member as a member + of the StaffList and their role.

+ type: object + required: + - ObjectType + - Role + properties: + Role: + type: string + title: Staff Role + description: >- +

Describes the role a staff member + has at a Provider or other + EducationOrganisation.

    +
  • '1001' - Principal
    • +
  • '1002' - Deputy Principal
    • +
  • '1003' - Associate Principal
    • +
  • '1004' - Assistant Principal
    • +
  • '1005' - Principal's Nominee (NZQA)
    • +
  • '1006' - Enrolment Officer
    • +
  • '1007' - Timetabler
    • +
  • '1008' - Relief Coordinator
    • +
  • '1009' - Office Manager
    • +
  • '1010' - Office Assistant
    • +
  • '1012' - Finance Assistant
    • +
  • '1013' - IT Manager
    • +
plus 51 more value(s) at NZCodeSetsStaffRoleType + oneOf: + - title: Principal + enum: + - "1001" + - title: Deputy Principal + enum: + - "1002" + - title: Associate Principal + enum: + - "1003" + - title: Assistant Principal + enum: + - "1004" + - title: Principal's Nominee (NZQA) + enum: + - "1005" + - title: Enrolment Officer + enum: + - "1006" + - title: Timetabler + enum: + - "1007" + - title: Relief Coordinator + enum: + - "1008" + - title: Office Manager + enum: + - "1009" + - title: Office Assistant + enum: + - "1010" + - title: Finance Assistant + enum: + - "1012" + - title: IT Manager + enum: + - "1013" + - title: IT Assistant + enum: + - "1014" + - title: Head Librarian + enum: + - "1015" + - title: Assistant Librarian + enum: + - "1016" + - title: Board of Trustees Member (Staff) + enum: + - "1017" + - title: Board of Trustees Member (Parent) + enum: + - "1018" + - title: Head of Department + enum: + - "1101" + - title: Assistant Head of Department + enum: + - "1102" + - title: Technician + enum: + - "1103" + - title: Subject Teacher + enum: + - "1201" + - title: STP Coordinator + enum: + - "1302" + - title: Learning Support Coordinator + enum: + - "1303" + - title: Learning Support Staff + enum: + - "1304" + - title: SAC Coordinator + enum: + - "1305" + - title: Special Needs Coordinator (SENCO) + enum: + - "1306" + - title: Distance Education Coordinator + enum: + - "1307" + - title: Resource Teacher Literacy (RTLit) + enum: + - "1308" + - title: Resource Teacher Learning and + Behaviour (RTLB) + enum: + - "1309" + - title: Parent Help + enum: + - "1310" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homerrom Teacher + enum: + - "1403" + - title: Pastoral Carer + enum: + - "1404" + - title: Guidance Counsellor + enum: + - "1405" + - title: Careers Advisor + enum: + - "1406" + - title: Truancy Officer + enum: + - "1407" + - title: Sickbay Nurse + enum: + - "1408" + - title: Dental Nurse + enum: + - "1409" + - title: Hostel Manager / Matron + enum: + - "1410" + - title: Social Worker (In School) + enum: + - "1411" + - title: Teacher in Charge + enum: + - "1501" + - title: Coach + enum: + - "1502" + - title: Kāhui Ako Led Principal + enum: + - "2001" + - title: Across School Teacher + enum: + - " 2002" + - title: Kāhui Ako Support Facilitator + enum: + - "2101" + - title: Kāhui Ako Expert Partner + enum: + - "2102" + - title: Ministry - Learning Support + Facilitator + enum: + - "2103" + - title: Ministry - Strategic Advisor - + Māori + enum: + - "2104" + - title: Ministry - SAF + enum: + - "2105" + - title: DHB Staff + enum: + - "2106" + - title: Teacher Aide + enum: + - "1301" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Kāhui Ako within School Teacher + enum: + - "1208" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Finance Manager + enum: + - "1011" + CourseList: + description:

The list of Courses that is being taught to + the teaching group at this event.

+ type: object + required: + - Course + properties: + Course: + type: array + items: + $ref: "#/paths/~1TeachingGroupEvents/get/respon\ + ses/200/content/application~1json/schema/\ + properties/TeachingGroupEvents/properties\ + /TeachingGroupEvent/items/properties/Prov\ + ider" + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + TeachingGroupEvents: + TeachingGroupEvent: + - TeachingGroupEventRefId: 9356909d-e46a-456a-a177-6a914af861ae + TeachingGroupEventLocalId: 20197A-SPN-1 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + 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) + SchedulePeriod: + RefId: 215f796c-67f7-4855-83dc-28ad9d002830 + LocalId: 2019a-A1 + Name: Period 1 on Day A + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Scheule 2019a, Day A + RoomId: TB202 + RoomName: Tower Block, Room 202 + TakeAttendanceFlag: Y + TeacherList: + StaffMember: + - RefId: A8C3A2E3-5B35-9D75-101D-00AA001A0000 + LocalId: SMI1 + Name: Thomas Smith + Role: "1001" + application/xml: + schema: + type: object + properties: + TeachingGroupEvents: + type: object + description: A List of TeachingGroupEvent objects + properties: + TeachingGroupEvent: + type: array + items: + $ref: "#/paths/~1TeachingGroupEvents/get/responses/200/co\ + ntent/application~1json/schema/properties/TeachingG\ + roupEvents/properties/TeachingGroupEvent/items" + example: >- + + + 9356909d-e46a-456a-a177-6a914af861ae + 20197A-SPN-1 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + 64a309da-063a-2e35-b359-d75101a8c3d1 + 20197ASPN + Year 7A Maths - Space and Numbers + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + TB202 + Tower Block, Room 202 + Y + + + A8C3A2E3-5B35-9D75-101D-00AA001A0000 + SMI1 + Thomas Smith + 1001 + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/TeachingGroupEvents/{TeachingGroupEventRefId}": + post: + tags: + - TeachingGroupEvent + summary: Default operation to create a single TeachingGroupEvent + parameters: + - name: TeachingGroupEventRefId + in: path + description:

The GUID of the TeachingGroupEvent

+ required: true + schema: + type: string + operationId: createTeachingGroupEvent + requestBody: + description: CRUD operation on TeachingGroupEvent + content: + application/json: + schema: + type: object + properties: + TeachingGroupEvent: + $ref: "#/paths/~1TeachingGroupEvents/get/responses/200/content/ap\ + plication~1json/schema/properties/TeachingGroupEvents/prope\ + rties/TeachingGroupEvent/items" + example: + TeachingGroupEvent: + TeachingGroupEventRefId: 9356909d-e46a-456a-a177-6a914af861ae + TeachingGroupEventLocalId: 20197A-SPN-1 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + 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) + SchedulePeriod: + RefId: 215f796c-67f7-4855-83dc-28ad9d002830 + LocalId: 2019a-A1 + Name: Period 1 on Day A + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Scheule 2019a, Day A + RoomId: TB202 + RoomName: Tower Block, Room 202 + TakeAttendanceFlag: Y + TeacherList: + StaffMember: + - RefId: A8C3A2E3-5B35-9D75-101D-00AA001A0000 + LocalId: SMI1 + Name: Thomas Smith + Role: "1001" + application/xml: + schema: + type: object + properties: + TeachingGroupEvent: + $ref: "#/paths/~1TeachingGroupEvents/get/responses/200/content/ap\ + plication~1json/schema/properties/TeachingGroupEvents/prope\ + rties/TeachingGroupEvent/items" + example: >- + + 9356909d-e46a-456a-a177-6a914af861ae + 20197A-SPN-1 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + 64a309da-063a-2e35-b359-d75101a8c3d1 + 20197ASPN + Year 7A Maths - Space and Numbers + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + TB202 + Tower Block, Room 202 + Y + + + A8C3A2E3-5B35-9D75-101D-00AA001A0000 + SMI1 + Thomas Smith + 1001 + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - TeachingGroupEvent + summary: Default operation to update a single TeachingGroupEvent + parameters: + - name: TeachingGroupEventRefId + in: path + description:

The GUID of the TeachingGroupEvent

+ required: true + schema: + type: string + operationId: updateTeachingGroupEvent + requestBody: + description: CRUD operation on TeachingGroupEvent + content: + application/json: + schema: + type: object + properties: + TeachingGroupEvent: + type: object + properties: + TeachingGroupEventRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + TeachingGroupEventLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1TeachingGroupEvents~1%7BTeachingGroupEve\ + ntRefId%7D/put/requestBody/content/application~1jso\ + n/schema/properties/TeachingGroupEvent/properties/T\ + eachingGroupEventRefId" + LocalId: + $ref: "#/paths/~1TeachingGroupEvents~1%7BTeachingGroupEve\ + ntRefId%7D/put/requestBody/content/application~1jso\ + n/schema/properties/TeachingGroupEvent/properties/T\ + eachingGroupEventLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + TeachingGroup: + $ref: "#/paths/~1TeachingGroupEvents~1%7BTeachingGroupEventRe\ + fId%7D/put/requestBody/content/application~1json/schema\ + /properties/TeachingGroupEvent/properties/Provider" + Schedule: + $ref: "#/paths/~1TeachingGroupEvents~1%7BTeachingGroupEventRe\ + fId%7D/put/requestBody/content/application~1json/schema\ + /properties/TeachingGroupEvent/properties/Provider" + SchedulePeriod: + $ref: "#/paths/~1TeachingGroupEvents~1%7BTeachingGroupEventRe\ + fId%7D/put/requestBody/content/application~1json/schema\ + /properties/TeachingGroupEvent/properties/Provider" + AcademicDay: + $ref: "#/paths/~1TeachingGroupEvents~1%7BTeachingGroupEventRe\ + fId%7D/put/requestBody/content/application~1json/schema\ + /properties/TeachingGroupEvent/properties/Provider" + RoomId: + type: string + description:

The Id of the room the teaching group is meeting + in.

+ RoomName: + type: string + description:

The name of the room the teaching group is meeting + in.

+ TakeAttendanceFlag: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + TeacherList: + description:

List of the teacher(s) teaching the class during this + timetable event.

+ type: object + properties: + StaffMember: + type: array + items: + description:

The individual staff member as a member of the + StaffList and their role.

+ type: object + properties: + Role: + type: string + title: Staff Role + description: >- +

Describes the role a staff member has at a + Provider or other EducationOrganisation.

+
    +
  • '1001' - Principal
    • +
  • '1002' - Deputy Principal
    • +
  • '1003' - Associate Principal
    • +
  • '1004' - Assistant Principal
    • +
  • '1005' - Principal's Nominee (NZQA)
    • +
  • '1006' - Enrolment Officer
    • +
  • '1007' - Timetabler
    • +
  • '1008' - Relief Coordinator
    • +
  • '1009' - Office Manager
    • +
  • '1010' - Office Assistant
    • +
  • '1012' - Finance Assistant
    • +
  • '1013' - IT Manager
    • +
plus 51 more value(s) at NZCodeSetsStaffRoleType + oneOf: + - title: Principal + enum: + - "1001" + - title: Deputy Principal + enum: + - "1002" + - title: Associate Principal + enum: + - "1003" + - title: Assistant Principal + enum: + - "1004" + - title: Principal's Nominee (NZQA) + enum: + - "1005" + - title: Enrolment Officer + enum: + - "1006" + - title: Timetabler + enum: + - "1007" + - title: Relief Coordinator + enum: + - "1008" + - title: Office Manager + enum: + - "1009" + - title: Office Assistant + enum: + - "1010" + - title: Finance Assistant + enum: + - "1012" + - title: IT Manager + enum: + - "1013" + - title: IT Assistant + enum: + - "1014" + - title: Head Librarian + enum: + - "1015" + - title: Assistant Librarian + enum: + - "1016" + - title: Board of Trustees Member (Staff) + enum: + - "1017" + - title: Board of Trustees Member (Parent) + enum: + - "1018" + - title: Head of Department + enum: + - "1101" + - title: Assistant Head of Department + enum: + - "1102" + - title: Technician + enum: + - "1103" + - title: Subject Teacher + enum: + - "1201" + - title: STP Coordinator + enum: + - "1302" + - title: Learning Support Coordinator + enum: + - "1303" + - title: Learning Support Staff + enum: + - "1304" + - title: SAC Coordinator + enum: + - "1305" + - title: Special Needs Coordinator (SENCO) + enum: + - "1306" + - title: Distance Education Coordinator + enum: + - "1307" + - title: Resource Teacher Literacy (RTLit) + enum: + - "1308" + - title: Resource Teacher Learning and Behaviour + (RTLB) + enum: + - "1309" + - title: Parent Help + enum: + - "1310" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homerrom Teacher + enum: + - "1403" + - title: Pastoral Carer + enum: + - "1404" + - title: Guidance Counsellor + enum: + - "1405" + - title: Careers Advisor + enum: + - "1406" + - title: Truancy Officer + enum: + - "1407" + - title: Sickbay Nurse + enum: + - "1408" + - title: Dental Nurse + enum: + - "1409" + - title: Hostel Manager / Matron + enum: + - "1410" + - title: Social Worker (In School) + enum: + - "1411" + - title: Teacher in Charge + enum: + - "1501" + - title: Coach + enum: + - "1502" + - title: Kāhui Ako Led Principal + enum: + - "2001" + - title: Across School Teacher + enum: + - " 2002" + - title: Kāhui Ako Support Facilitator + enum: + - "2101" + - title: Kāhui Ako Expert Partner + enum: + - "2102" + - title: Ministry - Learning Support Facilitator + enum: + - "2103" + - title: Ministry - Strategic Advisor - Māori + enum: + - "2104" + - title: Ministry - SAF + enum: + - "2105" + - title: DHB Staff + enum: + - "2106" + - title: Teacher Aide + enum: + - "1301" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Kāhui Ako within School Teacher + enum: + - "1208" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Finance Manager + enum: + - "1011" + CourseList: + description:

The list of Courses that is being taught to the + teaching group at this event.

+ type: object + properties: + Course: + type: array + items: + $ref: "#/paths/~1TeachingGroupEvents~1%7BTeachingGroupE\ + ventRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/TeachingGroupEvent/proper\ + ties/Provider" + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + TeachingGroupEvent: + TeachingGroupEventRefId: 9356909d-e46a-456a-a177-6a914af861ae + TeachingGroupEventLocalId: 20197A-SPN-1 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + 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) + SchedulePeriod: + RefId: 215f796c-67f7-4855-83dc-28ad9d002830 + LocalId: 2019a-A1 + Name: Period 1 on Day A + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Scheule 2019a, Day A + RoomId: TB202 + RoomName: Tower Block, Room 202 + TakeAttendanceFlag: Y + TeacherList: + StaffMember: + - RefId: A8C3A2E3-5B35-9D75-101D-00AA001A0000 + LocalId: SMI1 + Name: Thomas Smith + Role: "1001" + application/xml: + schema: + type: object + properties: + TeachingGroupEvent: + $ref: "#/paths/~1TeachingGroupEvents~1%7BTeachingGroupEventRefId%\ + 7D/put/requestBody/content/application~1json/schema/propert\ + ies/TeachingGroupEvent" + example: >- + + 9356909d-e46a-456a-a177-6a914af861ae + 20197A-SPN-1 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + 64a309da-063a-2e35-b359-d75101a8c3d1 + 20197ASPN + Year 7A Maths - Space and Numbers + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + TB202 + Tower Block, Room 202 + Y + + + A8C3A2E3-5B35-9D75-101D-00AA001A0000 + SMI1 + Thomas Smith + 1001 + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - TeachingGroupEvent + summary: Default operation to get a single TeachingGroupEvent + parameters: + - name: TeachingGroupEventRefId + in: path + description:

The GUID of the TeachingGroupEvent

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + TeachingGroupEvent: + $ref: "#/paths/~1TeachingGroupEvents/get/responses/200/content/\ + application~1json/schema/properties/TeachingGroupEvents/p\ + roperties/TeachingGroupEvent/items" + example: + TeachingGroupEvent: + TeachingGroupEventRefId: 9356909d-e46a-456a-a177-6a914af861ae + TeachingGroupEventLocalId: 20197A-SPN-1 + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + 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) + SchedulePeriod: + RefId: 215f796c-67f7-4855-83dc-28ad9d002830 + LocalId: 2019a-A1 + Name: Period 1 on Day A + AcademicDay: + RefId: 364f0aa5-49e2-434e-9c82-45770f4c71a9 + LocalId: 2019a-A + Name: Scheule 2019a, Day A + RoomId: TB202 + RoomName: Tower Block, Room 202 + TakeAttendanceFlag: Y + TeacherList: + StaffMember: + - RefId: A8C3A2E3-5B35-9D75-101D-00AA001A0000 + LocalId: SMI1 + Name: Thomas Smith + Role: "1001" + application/xml: + schema: + type: object + properties: + TeachingGroupEvent: + $ref: "#/paths/~1TeachingGroupEvents/get/responses/200/content/\ + application~1json/schema/properties/TeachingGroupEvents/p\ + roperties/TeachingGroupEvent/items" + example: >- + + 9356909d-e46a-456a-a177-6a914af861ae + 20197A-SPN-1 + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + + 64a309da-063a-2e35-b359-d75101a8c3d1 + 20197ASPN + Year 7A Maths - Space and Numbers + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Scheule 2019a (Term 1) + + + 215f796c-67f7-4855-83dc-28ad9d002830 + 2019a-A1 + Period 1 on Day A + + + 364f0aa5-49e2-434e-9c82-45770f4c71a9 + 2019a-A + Scheule 2019a, Day A + + TB202 + Tower Block, Room 202 + Y + + + A8C3A2E3-5B35-9D75-101D-00AA001A0000 + SMI1 + Thomas Smith + 1001 + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - TeachingGroupEvent + summary: Default operation to delete a single TeachingGroupEvent + parameters: + - name: TeachingGroupEventRefId + in: path + description:

The GUID of the TeachingGroupEvent

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /ScheduleEvents: + get: + tags: + - ScheduleEvent + summary: Default operation to get a list of all available ScheduleEvents + description: Search the set of available ScheduleEvents, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + ScheduleEvents: + type: object + description: A List of ScheduleEvent objects + properties: + ScheduleEvent: + type: array + items: + required: + - EventDate + - EventName + - Provider + - ScheduleEffect + type: object + properties: + ScheduleEventRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + ScheduleEventLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1ScheduleEvents/get/responses/200\ + /content/application~1json/schema/propertie\ + s/ScheduleEvents/properties/ScheduleEvent/i\ + tems/properties/ScheduleEventRefId" + LocalId: + $ref: "#/paths/~1ScheduleEvents/get/responses/200\ + /content/application~1json/schema/propertie\ + s/ScheduleEvents/properties/ScheduleEvent/i\ + tems/properties/ScheduleEventLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + EventDate: + type: string + format: date + description:

The start date of the event.

+ Duration: + type: integer + description:

The duration of the event. If only the + "EventDate" field is populated, the duration is + in days and if omitted defaults to 1 day; if the + "EventDate" and "EventTime" fields are both + populated, the duration is in seconds and if + omitted defaults to 3600 seconds (1 hour).

+ EventTime: + description:

The start time for the event, if required.

+ EventName: + type: string + description:

The name of the event.

+ Location: + type: string + description:

The name of location where the event will + occur.

+ ScheduleEffect: + type: string + title: Schedule Effect + description: >- +

Code set denoting the effect a ScheduleEvent + will have on the school's academic schedule. At + present, only full-day events (i.e. the + "EventDate" field is populated but "EventTime" + isn't) can have any effect other than + "noEffect".

    +
  • 'NOEFFECT' - No Effect
    • +
  • 'RENUMBER' - Renumber Days
    • +
  • 'INSERT' - Insert Day
    • +
  • 'DISPLACE' - Displace Day
    • +
  • 'ENDSCHEDULE' - End Schedule
    • +
  • 'PAUSESCHEDULE' - Pause Schedule
    • +
  • 'RESUMESCHEDULE' - Resume Schedule
    • +
  • 'CANCEL' - Cancel Day
    • +
  • 'STARTTERM' - Start Term
    • +
  • 'ADD' - Additional Day
    • +
  • 'CUSTOM' - Custom Day Schedule
    • +
+ oneOf: + - title: No Effect + description:

This event has no effect on the school + calendar.

+ enum: + - NOEFFECT + - title: Renumber Days + description:

This event causes the day rotation on the + school calendar to be renumbered, starting + with any academic days specified in + ScheduleDayList.

If any terms are + included in ScheduleTermList, those terms + are activated effective on the start date of + this event.

+ enum: + - RENUMBER + - title: Insert Day + description:

This event causes an insertion into the + normal academic day rotation of the school + calendar.

Any academic days and bell + schedules specified in ScheduleDayList and + BellScheduleList are scheduled for the + duration of this event, or school is + cancelled if ScheduleDayList is omitted.

+

After the event ends the academic day + rotation resumes from the point at which it + was interrupted. E.g. if it was Day 1 before + the event, then it will be Day 2 + afterwards.

+ enum: + - INSERT + - title: Displace Day + description:

This event causes a displacement in the + normal academic day rotation of the school + calendar.

Any academic days or bell + schedules specified in ScheduleDayList and + BellScheduleList are scheduled for the + duration of this event, or school is + cancelled if ScheduleDayList is omitted.

+

After the event ends the rotation resumes + from the point it would be at had the event + not occurred. E.g. if it was Day 1 before + the event, and the event duration was 1 day, + then it will be Day 3 afterwards; Day 2 is + overwritten by the event.

+ enum: + - DISPLACE + - title: End Schedule + description:

This event terminates the academic + schedule for any term(s) specified in + ScheduleTermList, which is required when + using this schedule effect.

Used to + terminate the academic day rotation prior to + the end of term; e.g. when the last week of + term is used for impromptu non-academic + activities.

Note that events take + effect at midnight on the start date, so the + designated term(s) do not occur on the + actual day of the endSchedule event (i.e. + the day prior to the event's start date is + the last day the term(s) are in + session).

+ enum: + - ENDSCHEDULE + - title: Pause Schedule + description:

Temporarily suspend the academic day + rotation until a subsequent "resumeSchedule" + event occurs.

+ enum: + - PAUSESCHEDULE + - title: Resume Schedule + description:

Resume an academic day rotation + previously suspended using + "pauseSchedule".

+ enum: + - RESUMESCHEDULE + - title: Cancel Day + description:

Cancel one or more academic days, + specified in ScheduleDayList, that would + normally occur on this date.

This is + generally used to partially cancel the + school schedule on a given calendar date. To + fully cancel school on date, use either the + "insert" or "displace" schedule effect.

+ enum: + - CANCEL + - title: Start Term + description:

Start one or more terms, specified in + ScheduleTermList, on this date without + changing the academic day rotation.

A + ScheduleTermList value is required when + using this schedule effect.

+ enum: + - STARTTERM + - title: Additional Day + description:

Set one or more additional academic days, + specified in ScheduleDayList to apply to + this calendar date in addition to those + normally applied to the academic day + rotation.

This can also be used to + schedule school on a day on which it would + not normally occur, such as a weekend.

+

As a convenience, RemoveScheduleDayList + specifies a set of academic days to be + removed from the calendar while this event + is in effect.

+ enum: + - ADD + - title: Custom Day Schedule + description: This event replaces the normal day rotation + for the event date with a custom set of + SchedulePeriods and bell times. + enum: + - CUSTOM + ScheduleList: + description:

List of the schedules within the provider + which the event will affect. If this event is to + affect the school's academic schedule this field + is required, otherwise it is optional.

+ type: object + required: + - Schedule + properties: + Schedule: + type: array + items: + $ref: "#/paths/~1ScheduleEvents/get/responses/2\ + 00/content/application~1json/schema/prope\ + rties/ScheduleEvents/properties/ScheduleE\ + vent/items/properties/Provider" + ScheduleDayList: + description:

A list of one or more academic days to be + applied to the school calendar for the duration + of this event.

+ type: object + required: + - ScheduleDay + properties: + ScheduleDay: + type: array + items: + $ref: "#/paths/~1ScheduleEvents/get/responses/2\ + 00/content/application~1json/schema/prope\ + rties/ScheduleEvents/properties/ScheduleE\ + vent/items/properties/Provider" + RemoveScheduleDayList: + description:

A list of one or more academic days to be + removed from the school calendar for the + duration of this event. Generally only operates + with a Schedule Effect of "add" or "custom".

+ type: object + required: + - ScheduleDay + properties: + ScheduleDay: + type: array + items: + $ref: "#/paths/~1ScheduleEvents/get/responses/2\ + 00/content/application~1json/schema/prope\ + rties/ScheduleEvents/properties/ScheduleE\ + vent/items/properties/Provider" + BellScheduleList: + description:

A list of one or more bell schedules to be + applied to the school calendar for the duration + of this event.

+ type: object + required: + - BellSchedule + properties: + BellSchedule: + type: array + items: + $ref: "#/paths/~1ScheduleEvents/get/responses/2\ + 00/content/application~1json/schema/prope\ + rties/ScheduleEvents/properties/ScheduleE\ + vent/items/properties/Provider" + RemoveBellScheduleList: + description:

A list of one or more bell schedules to be + removed from the school calendar for the + duration of this event. Generally only operates + with a Schedule Effect of "add" or "custom".

+ type: object + required: + - BellSchedule + properties: + BellSchedule: + type: array + items: + $ref: "#/paths/~1ScheduleEvents/get/responses/2\ + 00/content/application~1json/schema/prope\ + rties/ScheduleEvents/properties/ScheduleE\ + vent/items/properties/Provider" + ScheduleTermList: + description: "

A list of one or more terms to be affected + by this event. WARNING: Terms should only be + specified for events that affect the scheduling + of terms. Setting Terms on other event can have + a disruptive effect on the school schedule.

" + type: object + required: + - ScheduleTerm + properties: + ScheduleTerm: + type: array + items: + $ref: "#/paths/~1ScheduleEvents/get/responses/2\ + 00/content/application~1json/schema/prope\ + rties/ScheduleEvents/properties/ScheduleE\ + vent/items/properties/Provider" + CustomPeriodList: + description:

A list of generic object references to a set + of SchedulePeriods, along with their custom + start and end times, which are part of a + 'CUSTOM' ScheduleEvent.

Used in the + creation of "one off" events defined in + ScheduleEvent to have a custom set of + SchedulePeriods, each with custom start and end + times that don't match any particular bell + schedule.

Used for exception days in the + school schedule, such as assembly days or + activity days.

+ type: object + required: + - Period + properties: + Period: + type: array + items: + description:

Generic object reference to a single + SchedulePeriod, along with its custom + start and end times, which are part of a + 'CUSTOM' ScheduleEvent.

Used in the + creation of "one off" events defined in + ScheduleEvent to have a custom set of + SchedulePeriods, each with custom start + and end times that don't match any + particular bell schedule.

Used for + exception days in the school schedule, + such as assembly days or activity + days.

+ type: object + required: + - EndTime + - ObjectType + - StartTime + properties: + StartTime: + description:

The time the custom schedule period + starts.

+ EndTime: + description:

The time the custom schedule period + ends.

+ description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + ScheduleEvents: + ScheduleEvent: + - ScheduleEventRefId: c79e65df-0b11-4a97-9062-9fbd1c1a38e3 + ScheduleEventLocalId: evMarSlip + Provider: + RefId: ab987eeb-cf1d-4e62-aecd-96d942a12828 + Name: Hogwarts High + EventDate: 2019-03-14 + Duration: 1 + EventName: March Floods - School Closed - Slip Schedule + ScheduleEffect: INSERT + ScheduleList: + Schedule: + RefId: d2f4aea9-564f-4bdf-a18e-42a111a0602c + Name: Schedule 2019a (Term 1) + application/xml: + schema: + type: object + properties: + ScheduleEvents: + type: object + description: A List of ScheduleEvent objects + properties: + ScheduleEvent: + type: array + items: + $ref: "#/paths/~1ScheduleEvents/get/responses/200/content\ + /application~1json/schema/properties/ScheduleEvents\ + /properties/ScheduleEvent/items" + example: >- + + + c79e65df-0b11-4a97-9062-9fbd1c1a38e3 + evMarSlip + + ab987eeb-cf1d-4e62-aecd-96d942a12828 + Hogwarts High + + 2019-03-14 + 1 + March Floods - School Closed - Slip Schedule + INSERT + + + d2f4aea9-564f-4bdf-a18e-42a111a0602c + Schedule 2019a (Term 1) + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/ScheduleEvents/{ScheduleEventRefId}": + ? $ref 'paths/ScheduleEvent.yaml#/crud' + /StudentAttendanceSummarys: + get: + tags: + - StudentAttendanceSummary + summary: Default operation to get a list of all available + StudentAttendanceSummarys + description: Search the set of available StudentAttendanceSummaries, according to the + search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAttendanceSummarys: + type: object + description: A List of StudentAttendanceSummary objects + properties: + StudentAttendanceSummary: + type: array + items: + required: + - EndDate + - Provider + - SchoolCalendarYear + - StartDate + - Student + type: object + properties: + StudentAttendanceSummaryRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentAttendanceSummaryLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentAttendanceSummarys/get/re\ + sponses/200/content/application~1json/schem\ + a/properties/StudentAttendanceSummarys/prop\ + erties/StudentAttendanceSummary/items/prope\ + rties/StudentAttendanceSummaryRefId" + LocalId: + $ref: "#/paths/~1StudentAttendanceSummarys/get/re\ + sponses/200/content/application~1json/schem\ + a/properties/StudentAttendanceSummarys/prop\ + erties/StudentAttendanceSummary/items/prope\ + rties/StudentAttendanceSummaryLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentAttendanceSummarys/get/respon\ + ses/200/content/application~1json/schema/proper\ + ties/StudentAttendanceSummarys/properties/Stude\ + ntAttendanceSummary/items/properties/Student" + SchoolCalendarYear: + description:

School year for which the information is + applicable.

+ StartDate: + type: string + format: date + description:

Starting date of this attendance reporting + period.

+ EndDate: + type: string + format: date + description:

Ending date of this attendance reporting + period.

+ StartDay: + type: integer + description:

Number of the school day represented in + StartDate.

+ EndDay: + type: integer + description:

Number of the school day represented in + EndDate.

+ FTE: + description:

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.

+ AttendancePercentageHalfDays: + description:

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%.

+ AttendanceUnjustifiedHalfDays: + description:

The percentage of half days the student had + unjustified absences when school was in session + between the StartDate and EndDate, + inclusive.

+ HalfDaysYearPresent: + description:

The number of half days the student was + present when school was in session between the + StartDate and EndDate, inclusive.

+ HalfDaysYearAbsent: + description:

The number of half days the student was + absent when school was in session between the + StartDate and EndDate, inclusive.

+ HalfDaysYearJustified: + description:

The number of half days the student was + absent that were justified when school was in + session between the StartDate and EndDate, + inclusive.

+ HalfDaysYearTotal: + description:

The total number of half days.

+ HalfDaysYearIntermittantUnjustified: + description:

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.

+ HalfDaysYearPercentagePresent: + description:

The percentage of half days the student was + present when school was in session between the + StartDate and EndDate, inclusive.

+ HalfDaysYearUnjustified: + description:

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.

+ description:

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.

+ x-accessControl: + create: [] + read: + - 1001 + - 2401 + - 2403 + update: [] + delete: [] + aggregate: + - 2002 + - 2102 + example: + StudentAttendanceSummarys: + StudentAttendanceSummary: + - StudentAttendanceSummaryRefId: d3476fae-8647-384b-da24-31eda3583211 + Student: + RefId: 7c834ea9-eda1-2090-347f-83297e1c290c + Provider: + RefId: ca285746-359d-7510-1a8c-36432a901a16 + SchoolCalendarYear: 2015 + StartDate: 2014-08-30 + EndDate: 2015-06-10 + StartDay: 1 + EndDay: 180 + FTE: 1 + HalfDaysYearPresent: 178 + HalfDaysYearJustified: 2 + HalfDaysYearTotal: 2 + application/xml: + schema: + type: object + properties: + StudentAttendanceSummarys: + type: object + description: A List of StudentAttendanceSummary objects + properties: + StudentAttendanceSummary: + type: array + items: + $ref: "#/paths/~1StudentAttendanceSummarys/get/responses/\ + 200/content/application~1json/schema/properties/Stu\ + dentAttendanceSummarys/properties/StudentAttendance\ + Summary/items" + example: >- + + + d3476fae-8647-384b-da24-31eda3583211 + + 7c834ea9-eda1-2090-347f-83297e1c290c + + + ca285746-359d-7510-1a8c-36432a901a16 + + 2015 + 2014-08-30 + 2015-06-10 + 1 + 180 + 1.00 + 178 + 2 + 2 + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentAttendanceSummarys/{StudentAttendanceSummaryRefId}": + post: + tags: + - StudentAttendanceSummary + summary: Default operation to create a single StudentAttendanceSummary + parameters: + - name: StudentAttendanceSummaryRefId + in: path + description:

An ID (GUID) for this summary of attendance information being + reported on. This GUID would be used to form a REST URL.

+ required: true + schema: + type: string + operationId: createStudentAttendanceSummary + requestBody: + description: CRUD operation on StudentAttendanceSummary + content: + application/json: + schema: + type: object + properties: + StudentAttendanceSummary: + $ref: "#/paths/~1StudentAttendanceSummarys/get/responses/200/cont\ + ent/application~1json/schema/properties/StudentAttendanceSu\ + mmarys/properties/StudentAttendanceSummary/items" + example: + StudentAttendanceSummary: + StudentAttendanceSummaryRefId: d3476fae-8647-384b-da24-31eda3583211 + Student: + RefId: 7c834ea9-eda1-2090-347f-83297e1c290c + Provider: + RefId: ca285746-359d-7510-1a8c-36432a901a16 + SchoolCalendarYear: 2015 + StartDate: 2014-08-30 + EndDate: 2015-06-10 + StartDay: 1 + EndDay: 180 + FTE: 1 + HalfDaysYearPresent: 178 + HalfDaysYearJustified: 2 + HalfDaysYearTotal: 2 + application/xml: + schema: + type: object + properties: + StudentAttendanceSummary: + $ref: "#/paths/~1StudentAttendanceSummarys/get/responses/200/cont\ + ent/application~1json/schema/properties/StudentAttendanceSu\ + mmarys/properties/StudentAttendanceSummary/items" + example: >- + + d3476fae-8647-384b-da24-31eda3583211 + + 7c834ea9-eda1-2090-347f-83297e1c290c + + + ca285746-359d-7510-1a8c-36432a901a16 + + 2015 + 2014-08-30 + 2015-06-10 + 1 + 180 + 1.00 + 178 + 2 + 2 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentAttendanceSummary + summary: Default operation to update a single StudentAttendanceSummary + parameters: + - name: StudentAttendanceSummaryRefId + in: path + description:

An ID (GUID) for this summary of attendance information being + reported on. This GUID would be used to form a REST URL.

+ required: true + schema: + type: string + operationId: updateStudentAttendanceSummary + requestBody: + description: CRUD operation on StudentAttendanceSummary + content: + application/json: + schema: + type: object + properties: + StudentAttendanceSummary: + type: object + properties: + StudentAttendanceSummaryRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentAttendanceSummaryLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentAttendanceSummarys~1%7BStudentAtt\ + endanceSummaryRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/StudentAttendanceSu\ + mmary/properties/StudentAttendanceSummaryRefId" + LocalId: + $ref: "#/paths/~1StudentAttendanceSummarys~1%7BStudentAtt\ + endanceSummaryRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/StudentAttendanceSu\ + mmary/properties/StudentAttendanceSummaryLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentAttendanceSummarys~1%7BStudentAttenda\ + nceSummaryRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/StudentAttendanceSummary/proper\ + ties/Student" + SchoolCalendarYear: + description:

School year for which the information is + applicable.

+ StartDate: + type: string + format: date + description:

Starting date of this attendance reporting period.

+ EndDate: + type: string + format: date + description:

Ending date of this attendance reporting period.

+ StartDay: + type: integer + description:

Number of the school day represented in StartDate.

+ EndDay: + type: integer + description:

Number of the school day represented in EndDate.

+ FTE: + description:

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.

+ AttendancePercentageHalfDays: + description:

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%.

+ AttendanceUnjustifiedHalfDays: + description:

The percentage of half days the student had + unjustified absences when school was in session between + the StartDate and EndDate, inclusive.

+ HalfDaysYearPresent: + description:

The number of half days the student was present when + school was in session between the StartDate and EndDate, + inclusive.

+ HalfDaysYearAbsent: + description:

The number of half days the student was absent when + school was in session between the StartDate and EndDate, + inclusive.

+ HalfDaysYearJustified: + description:

The number of half days the student was absent that + were justified when school was in session between the + StartDate and EndDate, inclusive.

+ HalfDaysYearTotal: + description:

The total number of half days.

+ HalfDaysYearIntermittantUnjustified: + description:

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.

+ HalfDaysYearPercentagePresent: + description:

The percentage of half days the student was present + when school was in session between the StartDate and + EndDate, inclusive.

+ HalfDaysYearUnjustified: + description:

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.

+ description:

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.

+ x-accessControl: + create: [] + read: + - 1001 + - 2401 + - 2403 + update: [] + delete: [] + aggregate: + - 2002 + - 2102 + example: + StudentAttendanceSummary: + StudentAttendanceSummaryRefId: d3476fae-8647-384b-da24-31eda3583211 + Student: + RefId: 7c834ea9-eda1-2090-347f-83297e1c290c + Provider: + RefId: ca285746-359d-7510-1a8c-36432a901a16 + SchoolCalendarYear: 2015 + StartDate: 2014-08-30 + EndDate: 2015-06-10 + StartDay: 1 + EndDay: 180 + FTE: 1 + HalfDaysYearPresent: 178 + HalfDaysYearJustified: 2 + HalfDaysYearTotal: 2 + application/xml: + schema: + type: object + properties: + StudentAttendanceSummary: + $ref: "#/paths/~1StudentAttendanceSummarys~1%7BStudentAttendanceS\ + ummaryRefId%7D/put/requestBody/content/application~1json/sc\ + hema/properties/StudentAttendanceSummary" + example: >- + + d3476fae-8647-384b-da24-31eda3583211 + + 7c834ea9-eda1-2090-347f-83297e1c290c + + + ca285746-359d-7510-1a8c-36432a901a16 + + 2015 + 2014-08-30 + 2015-06-10 + 1 + 180 + 1.00 + 178 + 2 + 2 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentAttendanceSummary + summary: Default operation to get a single StudentAttendanceSummary + parameters: + - name: StudentAttendanceSummaryRefId + in: path + description:

An ID (GUID) for this summary of attendance information being + reported on. This GUID would be used to form a REST URL.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAttendanceSummary: + $ref: "#/paths/~1StudentAttendanceSummarys/get/responses/200/co\ + ntent/application~1json/schema/properties/StudentAttendan\ + ceSummarys/properties/StudentAttendanceSummary/items" + example: + StudentAttendanceSummary: + StudentAttendanceSummaryRefId: d3476fae-8647-384b-da24-31eda3583211 + Student: + RefId: 7c834ea9-eda1-2090-347f-83297e1c290c + Provider: + RefId: ca285746-359d-7510-1a8c-36432a901a16 + SchoolCalendarYear: 2015 + StartDate: 2014-08-30 + EndDate: 2015-06-10 + StartDay: 1 + EndDay: 180 + FTE: 1 + HalfDaysYearPresent: 178 + HalfDaysYearJustified: 2 + HalfDaysYearTotal: 2 + application/xml: + schema: + type: object + properties: + StudentAttendanceSummary: + $ref: "#/paths/~1StudentAttendanceSummarys/get/responses/200/co\ + ntent/application~1json/schema/properties/StudentAttendan\ + ceSummarys/properties/StudentAttendanceSummary/items" + example: >- + + d3476fae-8647-384b-da24-31eda3583211 + + 7c834ea9-eda1-2090-347f-83297e1c290c + + + ca285746-359d-7510-1a8c-36432a901a16 + + 2015 + 2014-08-30 + 2015-06-10 + 1 + 180 + 1.00 + 178 + 2 + 2 + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentAttendanceSummary + summary: Default operation to delete a single StudentAttendanceSummary + parameters: + - name: StudentAttendanceSummaryRefId + in: path + description:

An ID (GUID) for this summary of attendance information being + reported on. This GUID would be used to form a REST URL.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentAttendanceTimeLists: + get: + tags: + - StudentAttendanceTimeList + summary: Default operation to get a list of all available + StudentAttendanceTimeLists + description: Search the set of available StudentAttendanceTimeList records, according + to the search criteria in the URL parameters. Returns the first 20 + objects located; with SIF defined navigation headers, indicating how to + retrieve subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAttendanceTimeLists: + type: object + description: A List of StudentAttendanceTimeList objects + properties: + StudentAttendanceTimeList: + type: array + items: + required: + - Date + - Provider + - Student + type: object + properties: + StudentAttendanceTimeListRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentAttendanceTimeListLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentAttendanceTimeLists/get/r\ + esponses/200/content/application~1json/sche\ + ma/properties/StudentAttendanceTimeLists/pr\ + operties/StudentAttendanceTimeList/items/pr\ + operties/StudentAttendanceTimeListRefId" + LocalId: + $ref: "#/paths/~1StudentAttendanceTimeLists/get/r\ + esponses/200/content/application~1json/sche\ + ma/properties/StudentAttendanceTimeLists/pr\ + operties/StudentAttendanceTimeList/items/pr\ + operties/StudentAttendanceTimeListLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentAttendanceTimeLists/get/respo\ + nses/200/content/application~1json/schema/prope\ + rties/StudentAttendanceTimeLists/properties/Stu\ + dentAttendanceTimeList/items/properties/Student" + AttendanceTakenTime: + description:

The time the student's attendance was + taken.

+ Date: + type: string + format: date + description:

The calendar date to which this attendance + reporting period relates.

+ SchoolYear: + description:

The year for which the attendance record is + being made.

+ AttendanceTimeList: + description:

Breakdown of times that the student was + recorded as being present or absent from school + or class.

+ type: object + required: + - AttendanceTime + properties: + AttendanceTime: + type: array + items: + description:

Time span that the student entered or + returned to school

+ type: object + required: + - AttendanceCode + - AttendanceTimeType + - StartTime + properties: + AttendanceType: + type: string + description:

Nature of the attendance e.g. + 'Taken at Roll Call'

+ AttendanceCode: + type: string + title: Attendance Code + description: >- +

Code denoting presence, absence or + the reason for non-attendance at + school, or class.

    +
  • 'A' - Alternative Education
    • +
  • 'L' - Late to class
    • +
  • 'P' - Present
    • +
  • 'S' - Sickbay
    • +
  • 'D' - Medical appointment
    • +
  • 'I' - Internal school appointment
    • +
  • 'E' - Explained absence
    • +
  • 'M' - Medical absence
    • +
  • 'J' - Justified absence
    • +
  • 'T' - Truant
    • +
  • 'V' - Exam onsite
    • +
  • 'N' - Activity
    • +
plus 14 more value(s) at NZCodeSetsAttendanceCodeType + oneOf: + - title: Alternative Education + description: Attending Alternative Education + enum: + - A + - title: Late to class + enum: + - L + - title: Present + enum: + - P + - title: Sickbay + description: In Class + enum: + - S + - title: Medical appointment + description: Doctor or Dentist + enum: + - D + - title: Internal school appointment + description: Internal school appointment with + Dean, DP, sports administrator, + coach, attendance officer etc. + enum: + - I + - title: Explained absence + description: Absent with an explained but + unjustified reason + enum: + - E + - title: Medical absence + description: Absent due to short-term + illness/medical reasons + enum: + - M + - title: Justified absence + description: Reason for absence within school + policy + enum: + - J + - title: Truant + description: No information provided – or + throw-away explanation + enum: + - T + - title: Exam onsite + description: Examination or unsupervised study. + Student is on the school-site + enum: + - V + - title: Activity + description: Attending an on-site school + organised activity. + enum: + - N + - title: School trip/camp + description: Attending an off-site + school-organised activity such as + a trip/camp + enum: + - Q + - title: Work experience + enum: + - W + - title: Removed from class + description: Temporarily removed from regular + class (internal school student + isolation) + enum: + - R + - title: Exam leave + description: Unsupervised study, student is + off-site + enum: + - X + - title: Holiday + description: during term time + enum: + - G + - title: Justified Overseas + enum: + - O + - title: Teen Parent Unit + description: Attending Teen Parent Unit + enum: + - K + - title: Absent + description: Unknown reason for absence + enum: + - "?" + - title: Activity Centre + description: Attending Activity Centre + enum: + - Y + - title: Offsite + description: Attending offsite course/class + enum: + - F + - title: Health + description: Attending a Health Camp/Regional + Health School/Residential School + enum: + - H + - title: Justice + description: Involved in Justice Court + proceedings + enum: + - C + - title: Suspended + description: Stood down or suspended + enum: + - U + - title: STP + description: Secondary Tertiary Program + (including Trades Academies) + enum: + - Z + AttendanceStatus: + type: string + title: Attendance Status + description: >- +

Code denoting the status of the + attendance record: Excused, Unexcused, + Unknown, etc.

    +
  • 'EXC' - Excused
    • +
  • 'UNE' - Unexcused
    • +
  • 'UNK' - Unknown
    • +
  • 'NOT' - Not Applicable
    • +
+ oneOf: + - title: Excused + enum: + - EXC + - title: Unexcused + enum: + - UNE + - title: Unknown + enum: + - UNK + - title: Not Applicable + enum: + - NOT + StartTime: + description:

The start of this particular time + span.

+ EndTime: + description:

The end of this particular time + span.

+ DurationValue: + description:

The number of minutes the student + was present or absent.

+ AttendanceNote: + type: string + description:

Note related to this particular + time span.

+ PeriodAttendanceList: + description:

List of any period attendances that need to + be captured as part of a full list of student + attendance types. Reserved for future use with + TimeTableCell, Session or Scheduled Activity. +

+ type: object + required: + - PeriodAttendance + properties: + PeriodAttendance: + type: array + items: + description:

This container type allows recording of + period level attendance for a student.

+ type: object + required: + - AttendanceCode + - EndTime + - PeriodAttendanceType + - StartTime + properties: + AttendanceCode: + $ref: "#/paths/~1StudentAttendanceTimeLists\ + /get/responses/200/content/applicatio\ + n~1json/schema/properties/StudentAtte\ + ndanceTimeLists/properties/StudentAtt\ + endanceTimeList/items/properties/Atte\ + ndanceTimeList/properties/AttendanceT\ + ime/items/properties/AttendanceCode" + AttendanceStatus: + $ref: "#/paths/~1StudentAttendanceTimeLists\ + /get/responses/200/content/applicatio\ + n~1json/schema/properties/StudentAtte\ + ndanceTimeLists/properties/StudentAtt\ + endanceTimeList/items/properties/Atte\ + ndanceTimeList/properties/AttendanceT\ + ime/items/properties/AttendanceStatus" + TeachingGroupEvent: + $ref: "#/paths/~1StudentAttendanceTimeLists\ + /get/responses/200/content/applicatio\ + n~1json/schema/properties/StudentAtte\ + ndanceTimeLists/properties/StudentAtt\ + endanceTimeList/items/properties/Stud\ + ent" + StartTime: + description:

Optional Start Time of Curriculum + Session

+ EndTime: + description:

Optional End Time of Curriculum + Session

+ StudentTimeIn: + description:

The time the student entered or + returned to this class.

+ StudentTimeOut: + description:

The time the student left this + class.

+ SubjectAreaList: + description:

List of learning / subject areas + that apply to the period the + attendance record was taken for.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject + Areas defined by the NZ + Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ + Curriculum and Te + Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te + Marautanga o Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te + Marautanga o Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second + Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological + Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / + Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and + Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and + Communication Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information + Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / + Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical + Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental + Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural + Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical + Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal + Development + - const: REST + title: Religious Education / + Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary + Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, + Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject + Areas defined by the NZQA for + NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and + Horticultural Science + - const: AGRI + title: Agribusiness (Business + Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic + Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual + Communication (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for + Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + TeacherList: + description:

List of teachers

+ type: object + required: + - StaffMember + properties: + StaffMember: + type: array + items: + description:

The individual staff member + as a member of the StaffList and + their role.

+ type: object + required: + - ObjectType + - Role + properties: + Role: + type: string + title: Staff Role + description: >- +

Describes the role a + staff member has at a + Provider or other + EducationOrganisation.

+
    +
  • '1001' - Principal
    • +
  • '1002' - Deputy Principal
    • +
  • '1003' - Associate Principal
    • +
  • '1004' - Assistant Principal
    • +
  • '1005' - Principal's Nominee (NZQA)
    • +
  • '1006' - Enrolment Officer
    • +
  • '1007' - Timetabler
    • +
  • '1008' - Relief Coordinator
    • +
  • '1009' - Office Manager
    • +
  • '1010' - Office Assistant
    • +
  • '1012' - Finance Assistant
    • +
  • '1013' - IT Manager
    • +
plus 51 more value(s) at NZCodeSetsStaffRoleType + oneOf: + - title: Principal + enum: + - "1001" + - title: Deputy Principal + enum: + - "1002" + - title: Associate Principal + enum: + - "1003" + - title: Assistant Principal + enum: + - "1004" + - title: Principal's Nominee + (NZQA) + enum: + - "1005" + - title: Enrolment Officer + enum: + - "1006" + - title: Timetabler + enum: + - "1007" + - title: Relief Coordinator + enum: + - "1008" + - title: Office Manager + enum: + - "1009" + - title: Office Assistant + enum: + - "1010" + - title: Finance Assistant + enum: + - "1012" + - title: IT Manager + enum: + - "1013" + - title: IT Assistant + enum: + - "1014" + - title: Head Librarian + enum: + - "1015" + - title: Assistant Librarian + enum: + - "1016" + - title: Board of Trustees Member + (Staff) + enum: + - "1017" + - title: Board of Trustees Member + (Parent) + enum: + - "1018" + - title: Head of Department + enum: + - "1101" + - title: Assistant Head of + Department + enum: + - "1102" + - title: Technician + enum: + - "1103" + - title: Subject Teacher + enum: + - "1201" + - title: STP Coordinator + enum: + - "1302" + - title: Learning Support + Coordinator + enum: + - "1303" + - title: Learning Support Staff + enum: + - "1304" + - title: SAC Coordinator + enum: + - "1305" + - title: Special Needs + Coordinator (SENCO) + enum: + - "1306" + - title: Distance Education + Coordinator + enum: + - "1307" + - title: Resource Teacher + Literacy (RTLit) + enum: + - "1308" + - title: Resource Teacher + Learning and Behaviour + (RTLB) + enum: + - "1309" + - title: Parent Help + enum: + - "1310" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homerrom Teacher + enum: + - "1403" + - title: Pastoral Carer + enum: + - "1404" + - title: Guidance Counsellor + enum: + - "1405" + - title: Careers Advisor + enum: + - "1406" + - title: Truancy Officer + enum: + - "1407" + - title: Sickbay Nurse + enum: + - "1408" + - title: Dental Nurse + enum: + - "1409" + - title: Hostel Manager / Matron + enum: + - "1410" + - title: Social Worker (In School) + enum: + - "1411" + - title: Teacher in Charge + enum: + - "1501" + - title: Coach + enum: + - "1502" + - title: Kāhui Ako Led Principal + enum: + - "2001" + - title: Across School Teacher + enum: + - " 2002" + - title: Kāhui Ako Support + Facilitator + enum: + - "2101" + - title: Kāhui Ako Expert Partner + enum: + - "2102" + - title: Ministry - Learning + Support Facilitator + enum: + - "2103" + - title: Ministry - Strategic + Advisor - Māori + enum: + - "2104" + - title: Ministry - SAF + enum: + - "2105" + - title: DHB Staff + enum: + - "2106" + - title: Teacher Aide + enum: + - "1301" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Kāhui Ako within School + Teacher + enum: + - "1208" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom + Teacher + enum: + - "1211" + - title: Finance Manager + enum: + - "1011" + RoomList: + description:

List of rooms that apply to the + period the attendance record was taken + for.

+ type: object + required: + - RoomId + properties: + RoomId: + type: array + items: + $ref: "#/paths/~1StudentAttendanceTim\ + eLists/get/responses/200/conten\ + t/application~1json/schema/prop\ + erties/StudentAttendanceTimeLis\ + ts/properties/StudentAttendance\ + TimeList/items/properties/Stude\ + nt" + AttendanceNote: + type: string + description:

Note related to this particular + attendance.

+ PeriodName: + type: string + description:

The name of the period in this + curriculum session.

+ description: "

This object provides more detail about the + attendance spans for a single student during the + day: it provides more detailed information than the + single TimeIn and TimeOut elements in + StudentDailyAttendance.

" + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentAttendanceTimeLists: + StudentAttendanceTimeList: + - StudentAttendanceTimeListRefId: 45e9c39e-0e77-40b4-8ce7-6a6fa156249e + Student: + RefId: 7f11e3ed-3ac5-4673-9fdc-bcdbcd971811 + Provider: + RefId: e7c15fb4-48a6-4c11-b66f-fe93520444b6 + Date: 2018-06-26 + SchoolYear: 2018 + AttendanceTimeList: + AttendanceTime: + - AttendanceCode: E + AttendanceStatus: UNE + StartTime: 09:00:00 + EndTime: 10:30:00 + DurationValue: 90 + AttendanceNote: Explained absence, but unjustified, 9:00 to 10:30am + application/xml: + schema: + type: object + properties: + StudentAttendanceTimeLists: + type: object + description: A List of StudentAttendanceTimeList objects + properties: + StudentAttendanceTimeList: + type: array + items: + $ref: "#/paths/~1StudentAttendanceTimeLists/get/responses\ + /200/content/application~1json/schema/properties/St\ + udentAttendanceTimeLists/properties/StudentAttendan\ + ceTimeList/items" + example: >- + + + 45e9c39e-0e77-40b4-8ce7-6a6fa156249e + + 7f11e3ed-3ac5-4673-9fdc-bcdbcd971811 + + + e7c15fb4-48a6-4c11-b66f-fe93520444b6 + + 2018-06-26 + 2018 + + + E + UNE + 09:00:00 + 10:30:00 + 90 + Explained absence, but unjustified, 9:00 to 10:30am + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentAttendanceTimeLists/{StudentAttendanceTimeListRefId}": + post: + tags: + - StudentAttendanceTimeList + summary: Default operation to create a single StudentAttendanceTimeList + parameters: + - name: StudentAttendanceTimeListRefId + in: path + description: The ID (GUID) that uniquely identifies the attendance record. + required: true + schema: + type: string + operationId: createStudentAttendanceTimeList + requestBody: + description: CRUD operation on StudentAttendanceTimeList + content: + application/json: + schema: + type: object + properties: + StudentAttendanceTimeList: + $ref: "#/paths/~1StudentAttendanceTimeLists/get/responses/200/con\ + tent/application~1json/schema/properties/StudentAttendanceT\ + imeLists/properties/StudentAttendanceTimeList/items" + example: + StudentAttendanceTimeList: + StudentAttendanceTimeListRefId: 45e9c39e-0e77-40b4-8ce7-6a6fa156249e + Student: + RefId: 7f11e3ed-3ac5-4673-9fdc-bcdbcd971811 + Provider: + RefId: e7c15fb4-48a6-4c11-b66f-fe93520444b6 + Date: 2018-06-26 + SchoolYear: 2018 + AttendanceTimeList: + AttendanceTime: + - AttendanceCode: E + AttendanceStatus: UNE + StartTime: 09:00:00 + EndTime: 10:30:00 + DurationValue: 90 + AttendanceNote: Explained absence, but unjustified, 9:00 to 10:30am + application/xml: + schema: + type: object + properties: + StudentAttendanceTimeList: + $ref: "#/paths/~1StudentAttendanceTimeLists/get/responses/200/con\ + tent/application~1json/schema/properties/StudentAttendanceT\ + imeLists/properties/StudentAttendanceTimeList/items" + example: >- + + 45e9c39e-0e77-40b4-8ce7-6a6fa156249e + + 7f11e3ed-3ac5-4673-9fdc-bcdbcd971811 + + + e7c15fb4-48a6-4c11-b66f-fe93520444b6 + + 2018-06-26 + 2018 + + + E + UNE + 09:00:00 + 10:30:00 + 90 + Explained absence, but unjustified, 9:00 to 10:30am + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentAttendanceTimeList + summary: Default operation to update a single StudentAttendanceTimeList + parameters: + - name: StudentAttendanceTimeListRefId + in: path + description: The ID (GUID) that uniquely identifies the attendance record. + required: true + schema: + type: string + operationId: updateStudentAttendanceTimeList + requestBody: + description: CRUD operation on StudentAttendanceTimeList + content: + application/json: + schema: + type: object + properties: + StudentAttendanceTimeList: + type: object + properties: + StudentAttendanceTimeListRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentAttendanceTimeListLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentAttendanceTimeLists~1%7BStudentAt\ + tendanceTimeListRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/StudentAttendance\ + TimeList/properties/StudentAttendanceTimeListRefId" + LocalId: + $ref: "#/paths/~1StudentAttendanceTimeLists~1%7BStudentAt\ + tendanceTimeListRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/StudentAttendance\ + TimeList/properties/StudentAttendanceTimeListLocalI\ + d" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentAttendanceTimeLists~1%7BStudentAttend\ + anceTimeListRefId%7D/put/requestBody/content/applicatio\ + n~1json/schema/properties/StudentAttendanceTimeList/pro\ + perties/Student" + AttendanceTakenTime: + description:

The time the student's attendance was taken.

+ Date: + type: string + format: date + description:

The calendar date to which this attendance reporting + period relates.

+ SchoolYear: + description:

The year for which the attendance record is being + made.

+ AttendanceTimeList: + description:

Breakdown of times that the student was recorded as + being present or absent from school or class.

+ type: object + properties: + AttendanceTime: + type: array + items: + description:

Time span that the student entered or returned + to school

+ type: object + properties: + AttendanceType: + type: string + description:

Nature of the attendance e.g. 'Taken at + Roll Call'

+ AttendanceCode: + type: string + title: Attendance Code + description: >- +

Code denoting presence, absence or the + reason for non-attendance at school, or + class.

    +
  • 'A' - Alternative Education
    • +
  • 'L' - Late to class
    • +
  • 'P' - Present
    • +
  • 'S' - Sickbay
    • +
  • 'D' - Medical appointment
    • +
  • 'I' - Internal school appointment
    • +
  • 'E' - Explained absence
    • +
  • 'M' - Medical absence
    • +
  • 'J' - Justified absence
    • +
  • 'T' - Truant
    • +
  • 'V' - Exam onsite
    • +
  • 'N' - Activity
    • +
plus 14 more value(s) at NZCodeSetsAttendanceCodeType + oneOf: + - title: Alternative Education + description: Attending Alternative Education + enum: + - A + - title: Late to class + enum: + - L + - title: Present + enum: + - P + - title: Sickbay + description: In Class + enum: + - S + - title: Medical appointment + description: Doctor or Dentist + enum: + - D + - title: Internal school appointment + description: Internal school appointment with Dean, DP, + sports administrator, coach, attendance + officer etc. + enum: + - I + - title: Explained absence + description: Absent with an explained but unjustified + reason + enum: + - E + - title: Medical absence + description: Absent due to short-term illness/medical + reasons + enum: + - M + - title: Justified absence + description: Reason for absence within school policy + enum: + - J + - title: Truant + description: No information provided – or throw-away + explanation + enum: + - T + - title: Exam onsite + description: Examination or unsupervised study. Student + is on the school-site + enum: + - V + - title: Activity + description: Attending an on-site school organised + activity. + enum: + - N + - title: School trip/camp + description: Attending an off-site school-organised + activity such as a trip/camp + enum: + - Q + - title: Work experience + enum: + - W + - title: Removed from class + description: Temporarily removed from regular class + (internal school student isolation) + enum: + - R + - title: Exam leave + description: Unsupervised study, student is off-site + enum: + - X + - title: Holiday + description: during term time + enum: + - G + - title: Justified Overseas + enum: + - O + - title: Teen Parent Unit + description: Attending Teen Parent Unit + enum: + - K + - title: Absent + description: Unknown reason for absence + enum: + - "?" + - title: Activity Centre + description: Attending Activity Centre + enum: + - Y + - title: Offsite + description: Attending offsite course/class + enum: + - F + - title: Health + description: Attending a Health Camp/Regional Health + School/Residential School + enum: + - H + - title: Justice + description: Involved in Justice Court proceedings + enum: + - C + - title: Suspended + description: Stood down or suspended + enum: + - U + - title: STP + description: Secondary Tertiary Program (including + Trades Academies) + enum: + - Z + AttendanceStatus: + type: string + title: Attendance Status + description: >- +

Code denoting the status of the attendance + record: Excused, Unexcused, Unknown, etc.

+
    +
  • 'EXC' - Excused
    • +
  • 'UNE' - Unexcused
    • +
  • 'UNK' - Unknown
    • +
  • 'NOT' - Not Applicable
    • +
+ oneOf: + - title: Excused + enum: + - EXC + - title: Unexcused + enum: + - UNE + - title: Unknown + enum: + - UNK + - title: Not Applicable + enum: + - NOT + StartTime: + description:

The start of this particular time span.

+ EndTime: + description:

The end of this particular time span.

+ DurationValue: + description:

The number of minutes the student was + present or absent.

+ AttendanceNote: + type: string + description:

Note related to this particular time + span.

+ PeriodAttendanceList: + description:

List of any period attendances that need to be + captured as part of a full list of student attendance + types. Reserved for future use with TimeTableCell, + Session or Scheduled Activity.

+ type: object + properties: + PeriodAttendance: + type: array + items: + description:

This container type allows recording of period + level attendance for a student.

+ type: object + properties: + AttendanceCode: + $ref: "#/paths/~1StudentAttendanceTimeLists~1%7BStu\ + dentAttendanceTimeListRefId%7D/put/requestBod\ + y/content/application~1json/schema/properties\ + /StudentAttendanceTimeList/properties/Attenda\ + nceTimeList/properties/AttendanceTime/items/p\ + roperties/AttendanceCode" + AttendanceStatus: + $ref: "#/paths/~1StudentAttendanceTimeLists~1%7BStu\ + dentAttendanceTimeListRefId%7D/put/requestBod\ + y/content/application~1json/schema/properties\ + /StudentAttendanceTimeList/properties/Attenda\ + nceTimeList/properties/AttendanceTime/items/p\ + roperties/AttendanceStatus" + TeachingGroupEvent: + $ref: "#/paths/~1StudentAttendanceTimeLists~1%7BStu\ + dentAttendanceTimeListRefId%7D/put/requestBod\ + y/content/application~1json/schema/properties\ + /StudentAttendanceTimeList/properties/Student" + StartTime: + description:

Optional Start Time of Curriculum + Session

+ EndTime: + description:

Optional End Time of Curriculum Session

+ StudentTimeIn: + description:

The time the student entered or returned to + this class.

+ StudentTimeOut: + description:

The time the student left this class.

+ SubjectAreaList: + description:

List of learning / subject areas that apply + to the period the attendance record was taken + for.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas + defined by the NZ Curriculum and Te + Marautanga o Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication + Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas + defined by the NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural + Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication + (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + TeacherList: + description:

List of teachers

+ type: object + properties: + StaffMember: + type: array + items: + description:

The individual staff member as a + member of the StaffList and their + role.

+ type: object + properties: + Role: + type: string + title: Staff Role + description: >- +

Describes the role a staff member + has at a Provider or other + EducationOrganisation.

    +
  • '1001' - Principal
    • +
  • '1002' - Deputy Principal
    • +
  • '1003' - Associate Principal
    • +
  • '1004' - Assistant Principal
    • +
  • '1005' - Principal's Nominee (NZQA)
    • +
  • '1006' - Enrolment Officer
    • +
  • '1007' - Timetabler
    • +
  • '1008' - Relief Coordinator
    • +
  • '1009' - Office Manager
    • +
  • '1010' - Office Assistant
    • +
  • '1012' - Finance Assistant
    • +
  • '1013' - IT Manager
    • +
plus 51 more value(s) at NZCodeSetsStaffRoleType + oneOf: + - title: Principal + enum: + - "1001" + - title: Deputy Principal + enum: + - "1002" + - title: Associate Principal + enum: + - "1003" + - title: Assistant Principal + enum: + - "1004" + - title: Principal's Nominee (NZQA) + enum: + - "1005" + - title: Enrolment Officer + enum: + - "1006" + - title: Timetabler + enum: + - "1007" + - title: Relief Coordinator + enum: + - "1008" + - title: Office Manager + enum: + - "1009" + - title: Office Assistant + enum: + - "1010" + - title: Finance Assistant + enum: + - "1012" + - title: IT Manager + enum: + - "1013" + - title: IT Assistant + enum: + - "1014" + - title: Head Librarian + enum: + - "1015" + - title: Assistant Librarian + enum: + - "1016" + - title: Board of Trustees Member (Staff) + enum: + - "1017" + - title: Board of Trustees Member (Parent) + enum: + - "1018" + - title: Head of Department + enum: + - "1101" + - title: Assistant Head of Department + enum: + - "1102" + - title: Technician + enum: + - "1103" + - title: Subject Teacher + enum: + - "1201" + - title: STP Coordinator + enum: + - "1302" + - title: Learning Support Coordinator + enum: + - "1303" + - title: Learning Support Staff + enum: + - "1304" + - title: SAC Coordinator + enum: + - "1305" + - title: Special Needs Coordinator (SENCO) + enum: + - "1306" + - title: Distance Education Coordinator + enum: + - "1307" + - title: Resource Teacher Literacy (RTLit) + enum: + - "1308" + - title: Resource Teacher Learning and + Behaviour (RTLB) + enum: + - "1309" + - title: Parent Help + enum: + - "1310" + - title: Homeroom Teacher + enum: + - "1401" + - title: Release Homeroom Teacher + enum: + - "1402" + - title: Relief Homerrom Teacher + enum: + - "1403" + - title: Pastoral Carer + enum: + - "1404" + - title: Guidance Counsellor + enum: + - "1405" + - title: Careers Advisor + enum: + - "1406" + - title: Truancy Officer + enum: + - "1407" + - title: Sickbay Nurse + enum: + - "1408" + - title: Dental Nurse + enum: + - "1409" + - title: Hostel Manager / Matron + enum: + - "1410" + - title: Social Worker (In School) + enum: + - "1411" + - title: Teacher in Charge + enum: + - "1501" + - title: Coach + enum: + - "1502" + - title: Kāhui Ako Led Principal + enum: + - "2001" + - title: Across School Teacher + enum: + - " 2002" + - title: Kāhui Ako Support Facilitator + enum: + - "2101" + - title: Kāhui Ako Expert Partner + enum: + - "2102" + - title: Ministry - Learning Support + Facilitator + enum: + - "2103" + - title: Ministry - Strategic Advisor - + Māori + enum: + - "2104" + - title: Ministry - SAF + enum: + - "2105" + - title: DHB Staff + enum: + - "2106" + - title: Teacher Aide + enum: + - "1301" + - title: Subject Relief Teacher + enum: + - "1203" + - title: Subject Release Teacher + enum: + - "1202" + - title: Subject Tutor + enum: + - "1204" + - title: Classroom Teacher + enum: + - "1205" + - title: Classroom Release teacher + enum: + - "1206" + - title: Classroom Relief Teacher + enum: + - "1207" + - title: Kāhui Ako within School Teacher + enum: + - "1208" + - title: Itinerant Subject Teacher + enum: + - "1209" + - title: Itinerant Subject Tutor + enum: + - "1210" + - title: Specialist Classroom Teacher + enum: + - "1211" + - title: Finance Manager + enum: + - "1011" + RoomList: + description:

List of rooms that apply to the period the + attendance record was taken for.

+ type: object + properties: + RoomId: + type: array + items: + $ref: "#/paths/~1StudentAttendanceTimeLists~1\ + %7BStudentAttendanceTimeListRefId%7D/pu\ + t/requestBody/content/application~1json\ + /schema/properties/StudentAttendanceTim\ + eList/properties/Student" + AttendanceNote: + type: string + description:

Note related to this particular + attendance.

+ PeriodName: + type: string + description:

The name of the period in this curriculum + session.

+ description: "

This object provides more detail about the attendance + spans for a single student during the day: it provides more + detailed information than the single TimeIn and TimeOut + elements in StudentDailyAttendance.

" + x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentAttendanceTimeList: + StudentAttendanceTimeListRefId: 45e9c39e-0e77-40b4-8ce7-6a6fa156249e + Student: + RefId: 7f11e3ed-3ac5-4673-9fdc-bcdbcd971811 + Provider: + RefId: e7c15fb4-48a6-4c11-b66f-fe93520444b6 + Date: 2018-06-26 + SchoolYear: 2018 + AttendanceTimeList: + AttendanceTime: + - AttendanceCode: E + AttendanceStatus: UNE + StartTime: 09:00:00 + EndTime: 10:30:00 + DurationValue: 90 + AttendanceNote: Explained absence, but unjustified, 9:00 to 10:30am + application/xml: + schema: + type: object + properties: + StudentAttendanceTimeList: + $ref: "#/paths/~1StudentAttendanceTimeLists~1%7BStudentAttendance\ + TimeListRefId%7D/put/requestBody/content/application~1json/\ + schema/properties/StudentAttendanceTimeList" + example: >- + + 45e9c39e-0e77-40b4-8ce7-6a6fa156249e + + 7f11e3ed-3ac5-4673-9fdc-bcdbcd971811 + + + e7c15fb4-48a6-4c11-b66f-fe93520444b6 + + 2018-06-26 + 2018 + + + E + UNE + 09:00:00 + 10:30:00 + 90 + Explained absence, but unjustified, 9:00 to 10:30am + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentAttendanceTimeList + summary: Default operation to get a single StudentAttendanceTimeList + parameters: + - name: StudentAttendanceTimeListRefId + in: path + description: The ID (GUID) that uniquely identifies the attendance record. + required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAttendanceTimeList: + $ref: "#/paths/~1StudentAttendanceTimeLists/get/responses/200/c\ + ontent/application~1json/schema/properties/StudentAttenda\ + nceTimeLists/properties/StudentAttendanceTimeList/items" + example: + StudentAttendanceTimeList: + StudentAttendanceTimeListRefId: 45e9c39e-0e77-40b4-8ce7-6a6fa156249e + Student: + RefId: 7f11e3ed-3ac5-4673-9fdc-bcdbcd971811 + Provider: + RefId: e7c15fb4-48a6-4c11-b66f-fe93520444b6 + Date: 2018-06-26 + SchoolYear: 2018 + AttendanceTimeList: + AttendanceTime: + - AttendanceCode: E + AttendanceStatus: UNE + StartTime: 09:00:00 + EndTime: 10:30:00 + DurationValue: 90 + AttendanceNote: Explained absence, but unjustified, 9:00 to 10:30am + application/xml: + schema: + type: object + properties: + StudentAttendanceTimeList: + $ref: "#/paths/~1StudentAttendanceTimeLists/get/responses/200/c\ + ontent/application~1json/schema/properties/StudentAttenda\ + nceTimeLists/properties/StudentAttendanceTimeList/items" + example: >- + + 45e9c39e-0e77-40b4-8ce7-6a6fa156249e + + 7f11e3ed-3ac5-4673-9fdc-bcdbcd971811 + + + e7c15fb4-48a6-4c11-b66f-fe93520444b6 + + 2018-06-26 + 2018 + + + E + UNE + 09:00:00 + 10:30:00 + 90 + Explained absence, but unjustified, 9:00 to 10:30am + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentAttendanceTimeList + summary: Default operation to delete a single StudentAttendanceTimeList + parameters: + - name: StudentAttendanceTimeListRefId + in: path + description: The ID (GUID) that uniquely identifies the attendance record. + required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /WellbeingAlerts: + get: + tags: + - WellbeingAlert + summary: Default operation to get a list of all available WellbeingAlerts + description: Search the set of available WellbeingAlerts, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + WellbeingAlerts: + type: object + description: A List of WellbeingAlert objects + properties: + WellbeingAlert: + type: array + items: + required: + - Provider + - Student + type: object + properties: + WellbeingAlertRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + WellbeingAlertLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1WellbeingAlerts/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/WellbeingAlerts/properties/WellbeingAler\ + t/items/properties/WellbeingAlertRefId" + LocalId: + $ref: "#/paths/~1WellbeingAlerts/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/WellbeingAlerts/properties/WellbeingAler\ + t/items/properties/WellbeingAlertLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1WellbeingAlerts/get/responses/200/co\ + ntent/application~1json/schema/properties/Wellb\ + eingAlerts/properties/WellbeingAlert/items/prop\ + erties/Student" + StaffMember: + $ref: "#/paths/~1WellbeingAlerts/get/responses/200/co\ + ntent/application~1json/schema/properties/Wellb\ + eingAlerts/properties/WellbeingAlert/items/prop\ + erties/Student" + PublishedDate: + type: string + format: date + description:

The calendar date on which this wellbeing + alert was published.

+ StartDate: + type: string + format: date + description:

The date the wellbeing alert period + commenced.

+ EndDate: + type: string + format: date + description:

The date the wellbeing alert is due to + finish.

+ AlertCategory: + type: string + title: Wellbeing Alert Category + description: >- +

Standard codes denoting the category of the + Wellbeing Alert.

    +
  • 'ATT' - Attendance
    • +
  • 'MED' - Medical
    • +
  • 'LEG' - Legal
    • +
  • 'DIS' - Discipline
    • +
  • 'LEA' - Learning Support
    • +
  • 'PLA' - Plan Review
    • +
  • 'CUS' - Custodial
    • +
  • 'TRA' - Transient
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Attendance + enum: + - ATT + - title: Medical + description: Includes Allergies + enum: + - MED + - title: Legal + description: '"Comes with sub-Categories: + ProtectionOrder, CustodialOrder, etc."' + enum: + - LEG + - title: Discipline + enum: + - DIS + - title: Learning Support + description: Sub-categories Gifted and Talented, + Disability, etc. + enum: + - LEA + - title: Plan Review + enum: + - PLA + - title: Custodial + enum: + - CUS + - title: Transient + enum: + - TRA + - title: Other + enum: + - OTH + AlertDescription: + type: string + description:

Description of this particular wellbeing + alert.

+ AcknowledgementList: + description:

Key Contact to get information about this + wellbeing alert from.

+ type: object + required: + - Acknowledgement + properties: + Acknowledgement: + type: array + items: + description:

A provider or staff member that has + been sent the alerts and have acknowledged + they have been read.

+ type: object + required: + - Acknowledged + - AcknowledgedDate + properties: + Acknowledged: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, + unknown and not provided values.

+
    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + AcknowledgedDate: + type: string + format: date + description:

The date the provider acknowledged + a staff member has viewed the + alerts.

+ Provider: + $ref: "#/paths/~1WellbeingAlerts/get/respon\ + ses/200/content/application~1json/sch\ + ema/properties/WellbeingAlerts/proper\ + ties/WellbeingAlert/items/properties/\ + Student" + StaffMember: + $ref: "#/paths/~1WellbeingAlerts/get/respon\ + ses/200/content/application~1json/sch\ + ema/properties/WellbeingAlerts/proper\ + ties/WellbeingAlert/items/properties/\ + Student" + AlertSeverity: + type: string + description:

Severity of this wellbeing alert.

+ KeyContactList: + description:

A list of key contacts for the alert.

+ type: object + required: + - KeyContact + properties: + KeyContact: + type: array + items: + description:

A key contact for the Wellbeing Alert + and their role, e.g. Parent, Doctor, + Principal.

+ type: object + properties: + Role: + type: string + title: Key Contact Role + description: >- +

The role of the key contact in the + Wellbeing Alert.

    +
  • 'DOC' - Doctor
    • +
  • 'PAR' - Parent/Caregiver
    • +
  • 'PRI' - Principal
    • +
+ oneOf: + - title: Doctor + enum: + - DOC + - title: Parent/Caregiver + enum: + - PAR + - title: Principal + enum: + - PRI + Contact: + $ref: "#/paths/~1WellbeingAlerts/get/respon\ + ses/200/content/application~1json/sch\ + ema/properties/WellbeingAlerts/proper\ + ties/WellbeingAlert/items/properties/\ + Student" + WellbeingResponseList: + description:

A list of the Wellbeing Responses that + contributed to the creation of this Wellbeing + Alert.

+ type: object + required: + - WellbeingResponse + properties: + WellbeingResponse: + type: array + items: + $ref: "#/paths/~1WellbeingAlerts/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/WellbeingAlerts/properties/Wellbei\ + ngAlert/items/properties/Student" + WellbeingAppealList: + description:

A list of the Wellbeing Appeal outcomes that + contributed to the creation of this Wellbeing + Alert.

+ type: object + required: + - WellbeingAppeal + properties: + WellbeingAppeal: + type: array + items: + $ref: "#/paths/~1WellbeingAlerts/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/WellbeingAlerts/properties/Wellbei\ + ngAlert/items/properties/Student" + WellbeingCharacteristicList: + description:

A list of the Wellbeing Characteristics that + contributed to the creation of this Wellbeing + Alert.

+ type: object + required: + - WellbeingCharacteristic + properties: + WellbeingCharacteristic: + type: array + items: + $ref: "#/paths/~1WellbeingAlerts/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/WellbeingAlerts/properties/Wellbei\ + ngAlert/items/properties/Student" + description:

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.

+ x-accessControl: + create: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + read: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + update: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + WellbeingAlerts: + WellbeingAlert: + - WellbeingAlertRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StaffMember: + RefId: BA265776-359D-7510-1A8C-77432A901A16 + PublishedDate: 2017-11-01 + StartDate: 2017-11-01 + AlertCategory: MED + AlertDescription: This Student is allergic to peanuts + application/xml: + schema: + type: object + properties: + WellbeingAlerts: + type: object + description: A List of WellbeingAlert objects + properties: + WellbeingAlert: + type: array + items: + $ref: "#/paths/~1WellbeingAlerts/get/responses/200/conten\ + t/application~1json/schema/properties/WellbeingAler\ + ts/properties/WellbeingAlert/items" + example: >- + + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + + BA265776-359D-7510-1A8C-77432A901A16 + + 2017-11-01 + 2017-11-01 + MED + This Student is allergic to peanuts + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/WellbeingAlerts/{WellbeingAlertRefId}": + post: + tags: + - WellbeingAlert + summary: Default operation to create a single WellbeingAlert + parameters: + - name: WellbeingAlertRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingAlert.

+ required: true + schema: + type: string + operationId: createWellbeingAlert + requestBody: + description: CRUD operation on WellbeingAlert + content: + application/json: + schema: + type: object + properties: + WellbeingAlert: + $ref: "#/paths/~1WellbeingAlerts/get/responses/200/content/applic\ + ation~1json/schema/properties/WellbeingAlerts/properties/We\ + llbeingAlert/items" + example: + WellbeingAlert: + WellbeingAlertRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StaffMember: + RefId: BA265776-359D-7510-1A8C-77432A901A16 + PublishedDate: 2017-11-01 + StartDate: 2017-11-01 + AlertCategory: MED + AlertDescription: This Student is allergic to peanuts + application/xml: + schema: + type: object + properties: + WellbeingAlert: + $ref: "#/paths/~1WellbeingAlerts/get/responses/200/content/applic\ + ation~1json/schema/properties/WellbeingAlerts/properties/We\ + llbeingAlert/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + + BA265776-359D-7510-1A8C-77432A901A16 + + 2017-11-01 + 2017-11-01 + MED + This Student is allergic to peanuts + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - WellbeingAlert + summary: Default operation to update a single WellbeingAlert + parameters: + - name: WellbeingAlertRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingAlert.

+ required: true + schema: + type: string + operationId: updateWellbeingAlert + requestBody: + description: CRUD operation on WellbeingAlert + content: + application/json: + schema: + type: object + properties: + WellbeingAlert: + type: object + properties: + WellbeingAlertRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + WellbeingAlertLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlertRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/WellbeingAlert/properties/WellbeingAler\ + tRefId" + LocalId: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlertRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/WellbeingAlert/properties/WellbeingAler\ + tLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlertRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/WellbeingAlert/properties/Student" + StaffMember: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlertRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/WellbeingAlert/properties/Student" + PublishedDate: + type: string + format: date + description:

The calendar date on which this wellbeing alert was + published.

+ StartDate: + type: string + format: date + description:

The date the wellbeing alert period commenced.

+ EndDate: + type: string + format: date + description:

The date the wellbeing alert is due to finish.

+ AlertCategory: + type: string + title: Wellbeing Alert Category + description: >- +

Standard codes denoting the category of the Wellbeing + Alert.

    +
  • 'ATT' - Attendance
    • +
  • 'MED' - Medical
    • +
  • 'LEG' - Legal
    • +
  • 'DIS' - Discipline
    • +
  • 'LEA' - Learning Support
    • +
  • 'PLA' - Plan Review
    • +
  • 'CUS' - Custodial
    • +
  • 'TRA' - Transient
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Attendance + enum: + - ATT + - title: Medical + description: Includes Allergies + enum: + - MED + - title: Legal + description: '"Comes with sub-Categories: ProtectionOrder, + CustodialOrder, etc."' + enum: + - LEG + - title: Discipline + enum: + - DIS + - title: Learning Support + description: Sub-categories Gifted and Talented, Disability, etc. + enum: + - LEA + - title: Plan Review + enum: + - PLA + - title: Custodial + enum: + - CUS + - title: Transient + enum: + - TRA + - title: Other + enum: + - OTH + AlertDescription: + type: string + description:

Description of this particular wellbeing alert.

+ AcknowledgementList: + description:

Key Contact to get information about this wellbeing + alert from.

+ type: object + properties: + Acknowledgement: + type: array + items: + description:

A provider or staff member that has been sent + the alerts and have acknowledged they have been + read.

+ type: object + properties: + Acknowledged: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown + and not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + AcknowledgedDate: + type: string + format: date + description:

The date the provider acknowledged a staff + member has viewed the alerts.

+ Provider: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlert\ + RefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/WellbeingAlert/proper\ + ties/Student" + StaffMember: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlert\ + RefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/WellbeingAlert/proper\ + ties/Student" + AlertSeverity: + type: string + description:

Severity of this wellbeing alert.

+ KeyContactList: + description:

A list of key contacts for the alert.

+ type: object + properties: + KeyContact: + type: array + items: + description:

A key contact for the Wellbeing Alert and their + role, e.g. Parent, Doctor, Principal.

+ type: object + properties: + Role: + type: string + title: Key Contact Role + description: >- +

The role of the key contact in the + Wellbeing Alert.

    +
  • 'DOC' - Doctor
    • +
  • 'PAR' - Parent/Caregiver
    • +
  • 'PRI' - Principal
    • +
+ oneOf: + - title: Doctor + enum: + - DOC + - title: Parent/Caregiver + enum: + - PAR + - title: Principal + enum: + - PRI + Contact: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlert\ + RefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/WellbeingAlert/proper\ + ties/Student" + WellbeingResponseList: + description:

A list of the Wellbeing Responses that contributed to + the creation of this Wellbeing Alert.

+ type: object + properties: + WellbeingResponse: + type: array + items: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlertRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/WellbeingAlert/properties/Student" + WellbeingAppealList: + description:

A list of the Wellbeing Appeal outcomes that + contributed to the creation of this Wellbeing Alert.

+ type: object + properties: + WellbeingAppeal: + type: array + items: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlertRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/WellbeingAlert/properties/Student" + WellbeingCharacteristicList: + description:

A list of the Wellbeing Characteristics that + contributed to the creation of this Wellbeing Alert.

+ type: object + properties: + WellbeingCharacteristic: + type: array + items: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlertRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/WellbeingAlert/properties/Student" + description:

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.

+ x-accessControl: + create: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + read: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + update: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + WellbeingAlert: + WellbeingAlertRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StaffMember: + RefId: BA265776-359D-7510-1A8C-77432A901A16 + PublishedDate: 2017-11-01 + StartDate: 2017-11-01 + AlertCategory: MED + AlertDescription: This Student is allergic to peanuts + application/xml: + schema: + type: object + properties: + WellbeingAlert: + $ref: "#/paths/~1WellbeingAlerts~1%7BWellbeingAlertRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/Well\ + beingAlert" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + + BA265776-359D-7510-1A8C-77432A901A16 + + 2017-11-01 + 2017-11-01 + MED + This Student is allergic to peanuts + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - WellbeingAlert + summary: Default operation to get a single WellbeingAlert + parameters: + - name: WellbeingAlertRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingAlert.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + WellbeingAlert: + $ref: "#/paths/~1WellbeingAlerts/get/responses/200/content/appl\ + ication~1json/schema/properties/WellbeingAlerts/propertie\ + s/WellbeingAlert/items" + example: + WellbeingAlert: + WellbeingAlertRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StaffMember: + RefId: BA265776-359D-7510-1A8C-77432A901A16 + PublishedDate: 2017-11-01 + StartDate: 2017-11-01 + AlertCategory: MED + AlertDescription: This Student is allergic to peanuts + application/xml: + schema: + type: object + properties: + WellbeingAlert: + $ref: "#/paths/~1WellbeingAlerts/get/responses/200/content/appl\ + ication~1json/schema/properties/WellbeingAlerts/propertie\ + s/WellbeingAlert/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + + BA265776-359D-7510-1A8C-77432A901A16 + + 2017-11-01 + 2017-11-01 + MED + This Student is allergic to peanuts + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - WellbeingAlert + summary: Default operation to delete a single WellbeingAlert + parameters: + - name: WellbeingAlertRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingAlert.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /WellbeingCharacteristics: + get: + tags: + - WellbeingCharacteristic + summary: Default operation to get a list of all available WellbeingCharacteristics + description: Search the set of available WellbeingCharacteristics, according to the + search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + WellbeingCharacteristics: + type: object + description: A List of WellbeingCharacteristic objects + properties: + WellbeingCharacteristic: + type: array + items: + required: + - RecordingProvider + - Student + type: object + properties: + WellbeingCharacteristicRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + WellbeingCharacteristicLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1WellbeingCharacteristics/get/res\ + ponses/200/content/application~1json/schema\ + /properties/WellbeingCharacteristics/proper\ + ties/WellbeingCharacteristic/items/properti\ + es/WellbeingCharacteristicRefId" + LocalId: + $ref: "#/paths/~1WellbeingCharacteristics/get/res\ + ponses/200/content/application~1json/schema\ + /properties/WellbeingCharacteristics/proper\ + ties/WellbeingCharacteristic/items/properti\ + es/WellbeingCharacteristicLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + RecordingProvider: + $ref: "#/paths/~1WellbeingCharacteristics/get/respons\ + es/200/content/application~1json/schema/propert\ + ies/WellbeingCharacteristics/properties/Wellbei\ + ngCharacteristic/items/properties/Student" + CreatedBy: + $ref: "#/paths/~1WellbeingCharacteristics/get/respons\ + es/200/content/application~1json/schema/propert\ + ies/WellbeingCharacteristics/properties/Wellbei\ + ngCharacteristic/items/properties/Student" + CreatedDate: + type: string + format: date + description:

The date the characteristic was first created + for the student in the source system.

+ LastUpdatedBy: + $ref: "#/paths/~1WellbeingCharacteristics/get/respons\ + es/200/content/application~1json/schema/propert\ + ies/WellbeingCharacteristics/properties/Wellbei\ + ngCharacteristic/items/properties/Student" + LastUpdatedDate: + type: string + format: date + description:

The date the characteristic was last updated + in the source system.

+ CharacteristicClassification: + type: string + title: Wellbeing Characteristic Class + description: >- +

Standard codes denoting the first level + category of the Wellbeing Characteristic. (Note: + The second and third levels are Category and + SubCategory)

    +
  • 'OTH' - Other
    • +
  • 'MDC' - Medical
    • +
  • 'LSN' - Learning Support Need
    • +
  • 'ALG' - Allergy
    • +
  • 'DPR' - Dietary Preference
    • +
+ oneOf: + - title: Other + enum: + - OTH + - title: Medical + enum: + - MDC + - title: Learning Support Need + enum: + - LSN + - title: Allergy + enum: + - ALG + - title: Dietary Preference + enum: + - DPR + StartDate: + type: string + format: date + description:

Starting Date for this Characteristic to be + noted.

+ EndDate: + type: string + format: date + description:

End date for this Characteristic to be noted, + if there is one.

+ ReviewDate: + type: string + format: date + description:

Date at which this information should be + reviewed.

+ CharacteristicNotes: + type: string + description:

Text relating to the particular + WellbeingCharacteristic.

+ CharacteristicCategory: + description:

Category of WellbeingCharacteristic.

+ CharacteristicSubCategory: + description:

Sub category of the + WellbeingCharacteristic.

+ CharacteristicSeverity: + type: string + description:

The severity of the wellbeing + characteristic

+ CharacteristicPriority: + type: string + title: Wellbeing Characteristic Priority + description: >- +

Codes denoting the priority level of the + characteristic in relation to other + characteristics within the same + classification.

    +
  • 'HGH' - High
    • +
  • 'MOD' - Moderate
    • +
  • 'LOW' - Low
    • +
+ oneOf: + - title: High + enum: + - HGH + - title: Moderate + enum: + - MOD + - title: Low + enum: + - LOW + DailyManagement: + type: string + EmergencyManagement: + type: string + EmergencyResponsePlan: + type: string + Trigger: + type: string + Diagnosis: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + ConfidentialFlag: + $ref: "#/paths/~1WellbeingCharacteristics/get/respons\ + es/200/content/application~1json/schema/propert\ + ies/WellbeingCharacteristics/properties/Wellbei\ + ngCharacteristic/items/properties/Diagnosis" + Alert: + $ref: "#/paths/~1WellbeingCharacteristics/get/respons\ + es/200/content/application~1json/schema/propert\ + ies/WellbeingCharacteristics/properties/Wellbei\ + ngCharacteristic/items/properties/Diagnosis" + MedicationList: + description:

A list of the medications required for this + Wellbeing Characteristic.

+ type: object + required: + - Medication + properties: + Medication: + type: array + items: + description:

The medication, dosage and frequency, + required by the student to manage the + Wellbeing Characteristic.

+ type: object + properties: + MedicationName: + type: string + description:

Name of medication required for the + student.

+ Dosage: + type: string + description:

Dosage and strength of medication + required for the student.

+ Frequency: + type: string + description:

Frequency of Administration.

+ AdministrationInformation: + type: string + description:

Information about how the + medication is to be administered.

+ Method: + type: string + description:

Method of administration.

+ MedicationConsentList: + description:

A list consents that have been + provided for administration of a + medicine to a student.

+ type: object + required: + - MedicationConsent + properties: + MedicationConsent: + type: array + items: + description:

Contains information about + when, by whom, and who consent + was given to for the + administration of a medicine to + a student.

+ type: object + required: + - ConsentedBy + - StartDate + properties: + StartDate: + type: string + format: date + description:

The date from which the + student or student caretaker + consented to the medicine + being administered to the + student by a particular + individual.

+ EndDate: + type: string + format: date + description:

The date the consent for + administration of the + medicine ends or is + revoked.

+ ConsentedBy: + $ref: "#/paths/~1WellbeingCharact\ + eristics/get/responses/200/\ + content/application~1json/s\ + chema/properties/WellbeingC\ + haracteristics/properties/W\ + ellbeingCharacteristic/item\ + s/properties/Student" + ProviderApplicableTo: + $ref: "#/paths/~1WellbeingCharact\ + eristics/get/responses/200/\ + content/application~1json/s\ + chema/properties/WellbeingC\ + haracteristics/properties/W\ + ellbeingCharacteristic/item\ + s/properties/Student" + AdministeredBy: + $ref: "#/paths/~1WellbeingCharact\ + eristics/get/responses/200/\ + content/application~1json/s\ + chema/properties/WellbeingC\ + haracteristics/properties/W\ + ellbeingCharacteristic/item\ + s/properties/Student" + DocumentList: + description:

Describes the Location of any associated + documents kept in relation to this + Characteristic.

+ type: object + required: + - Document + properties: + Document: + type: array + items: + $ref: "#/paths/~1WellbeingCharacteristics/get/r\ + esponses/200/content/application~1json/sc\ + hema/properties/WellbeingCharacteristics/\ + properties/WellbeingCharacteristic/items/\ + properties/Student" + WellbeingEventList: + description:

A list of any Wellbeing Events that have + arisen as a result of this Characteristic.

+ type: object + required: + - WellbeingEvent + properties: + WellbeingEvent: + type: array + items: + $ref: "#/paths/~1WellbeingCharacteristics/get/r\ + esponses/200/content/application~1json/sc\ + hema/properties/WellbeingCharacteristics/\ + properties/WellbeingCharacteristic/items/\ + properties/Student" + WellbeingAlertList: + description:

A list of any Wellbeing Alerts that have + arison as a result of this Chracteristic.

+ type: object + required: + - WellbeingAlert + properties: + WellbeingAlert: + type: array + items: + $ref: "#/paths/~1WellbeingCharacteristics/get/r\ + esponses/200/content/application~1json/sc\ + hema/properties/WellbeingCharacteristics/\ + properties/WellbeingCharacteristic/items/\ + properties/Student" + SpecialAssessmentConditionList: + description:

A list of the special assessment conditions + that a student is entitled to have when sitting + an assessment.

+ type: object + required: + - SpecialAssessmentCondition + properties: + SpecialAssessmentCondition: + type: array + items: + type: string + title: Special Assessment Condition + description: >- +

Standard codes denoting special + assessment conditions that a student + requires when sitting an assessment.

+
    +
  • 'BRA' - Braille Paper
    • +
  • 'COM' - Computer OR Writer
    • +
  • 'ENL' - Enlarged Paper
    • +
  • 'EXT' - Extra Time
    • +
  • 'OTH' - Other
    • +
  • 'REA' - Reader
    • +
  • 'RES' - Rest Breaks
    • +
  • 'SEP' - Separate Accommodation
    • +
  • 'SIR' - Signing Reader
    • +
  • 'SIS' - Signing Supervisor
    • +
  • 'SPE' - Special Paper
    • +
+ oneOf: + - title: Braille Paper + enum: + - BRA + - title: Computer OR Writer + enum: + - COM + - title: Enlarged Paper + enum: + - ENL + - title: Extra Time + enum: + - EXT + - title: Other + enum: + - OTH + - title: Reader + enum: + - REA + - title: Rest Breaks + enum: + - RES + - title: Separate Accommodation + enum: + - SEP + - title: Signing Reader + enum: + - SIR + - title: Signing Supervisor + enum: + - SIS + - title: Special Paper + enum: + - SPE + Status: + type: string + title: Wellbeing Characteristic Status + description: >- +

Code set denoting the status of the Wellbeing + Characteristic.

    +
  • 'ACTI' - Active
    • +
  • 'CLOS' - Closed
    • +
  • 'CREA' - Created in Error
    • +
  • 'PEND' - Pending Approval
    • +
+ oneOf: + - title: Active + enum: + - ACTI + - title: Closed + enum: + - CLOS + - title: Created in Error + enum: + - CREA + - title: Pending Approval + enum: + - PEND + StudentConsentList: + description:

A list of the consents given by the stiudent + or their caregiver in relation to this Wellbeing + Characteristic.

+ type: object + required: + - StudentConsent + properties: + StudentConsent: + type: array + items: + $ref: "#/paths/~1WellbeingCharacteristics/get/r\ + esponses/200/content/application~1json/sc\ + hema/properties/WellbeingCharacteristics/\ + properties/WellbeingCharacteristic/items/\ + properties/Student" + TeWharikiDomainList: + description:

A list of the Te Whāriki Domains that are + relevant to this Wellbeing Characteristic. Only + used for Early Childhood Education.

+ type: object + required: + - TeWharikiDomain + properties: + TeWharikiDomain: + type: array + items: + type: string + title: Learning Support Te Whariki Domain + description: >- +

Code set denoting the Te Whariki Domain + an Early Childhood Education related + intervention is part of.

    +
  • 'WMS' - Wellbeing - Managing Self
    • +
  • 'BLP' - Belonging - Participating
    • +
  • 'CRO' - Contributing - Relating to Others
    • +
  • 'COM' - Communication - Using Language, Symbols and Texts
    • +
+ oneOf: + - title: Wellbeing - Managing Self + enum: + - WMS + - title: Belonging - Participating + enum: + - BLP + - title: Contributing - Relating to Others + enum: + - CRO + - title: Communication - Using Language, + Symbols and Texts + enum: + - COM + LearningSupportOutcomeList: + description:

A list of the expected learning support + outcome for the Wellbeing Characteristic. Only + used for Schools.

+ type: object + required: + - LearningSupportOutcome + properties: + LearningSupportOutcome: + type: array + items: + type: string + title: Learning Support Outcome + description: >- +

Code set denoting the outcome for the + student that the intervention is seeking + to achieve for an area of need. Only + applies to Compulsive Schooling.

    +
  • 'WBG' - Wellbeing
    • +
  • 'PNC' - Presence
    • +
  • 'PTN' - Participation
    • +
  • 'LAA' - Learning and Achievement
    • +
+ oneOf: + - title: Wellbeing + enum: + - WBG + - title: Presence + enum: + - PNC + - title: Participation + enum: + - PTN + - title: Learning and Achievement + enum: + - LAA + description:

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.

+ x-accessControl: + create: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + read: + - 1001 + - 1306 + - 2101 + - 2103 + - 2401 + - 2403 + update: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + WellbeingCharacteristics: + WellbeingCharacteristic: + - WellbeingCharacteristicRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + RecordingProvider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StartDate: 2017-11-01 + EndDate: 2017-11-10 + CharacteristicNotes: This Student has a special need. + CharacteristicCategory: S + application/xml: + schema: + type: object + properties: + WellbeingCharacteristics: + type: object + description: A List of WellbeingCharacteristic objects + properties: + WellbeingCharacteristic: + type: array + items: + $ref: "#/paths/~1WellbeingCharacteristics/get/responses/2\ + 00/content/application~1json/schema/properties/Well\ + beingCharacteristics/properties/WellbeingCharacteri\ + stic/items" + example: >- + + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + 2017-11-01 + 2017-11-10 + This Student has a special need. + S + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/WellbeingCharacteristics/{WellbeingCharacteristicRefId}": + post: + tags: + - WellbeingCharacteristic + summary: Default operation to create a single WellbeingCharacteristic + parameters: + - name: WellbeingCharacteristicRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingCharacteristic.

+ required: true + schema: + type: string + operationId: createWellbeingCharacteristic + requestBody: + description: CRUD operation on WellbeingCharacteristic + content: + application/json: + schema: + type: object + properties: + WellbeingCharacteristic: + $ref: "#/paths/~1WellbeingCharacteristics/get/responses/200/conte\ + nt/application~1json/schema/properties/WellbeingCharacteris\ + tics/properties/WellbeingCharacteristic/items" + example: + WellbeingCharacteristic: + WellbeingCharacteristicRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + RecordingProvider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StartDate: 2017-11-01 + EndDate: 2017-11-10 + CharacteristicNotes: This Student has a special need. + CharacteristicCategory: S + application/xml: + schema: + type: object + properties: + WellbeingCharacteristic: + $ref: "#/paths/~1WellbeingCharacteristics/get/responses/200/conte\ + nt/application~1json/schema/properties/WellbeingCharacteris\ + tics/properties/WellbeingCharacteristic/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + 2017-11-01 + 2017-11-10 + This Student has a special need. + S + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - WellbeingCharacteristic + summary: Default operation to update a single WellbeingCharacteristic + parameters: + - name: WellbeingCharacteristicRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingCharacteristic.

+ required: true + schema: + type: string + operationId: updateWellbeingCharacteristic + requestBody: + description: CRUD operation on WellbeingCharacteristic + content: + application/json: + schema: + type: object + properties: + WellbeingCharacteristic: + type: object + properties: + WellbeingCharacteristicRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + WellbeingCharacteristicLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeingCh\ + aracteristicRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/WellbeingCharacterist\ + ic/properties/WellbeingCharacteristicRefId" + LocalId: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeingCh\ + aracteristicRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/WellbeingCharacterist\ + ic/properties/WellbeingCharacteristicLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + RecordingProvider: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeingCharac\ + teristicRefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/WellbeingCharacteristic/propertie\ + s/Student" + CreatedBy: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeingCharac\ + teristicRefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/WellbeingCharacteristic/propertie\ + s/Student" + CreatedDate: + type: string + format: date + description:

The date the characteristic was first created for the + student in the source system.

+ LastUpdatedBy: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeingCharac\ + teristicRefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/WellbeingCharacteristic/propertie\ + s/Student" + LastUpdatedDate: + type: string + format: date + description:

The date the characteristic was last updated in the + source system.

+ CharacteristicClassification: + type: string + title: Wellbeing Characteristic Class + description: >- +

Standard codes denoting the first level category of + the Wellbeing Characteristic. (Note: The second and + third levels are Category and SubCategory)

    +
  • 'OTH' - Other
    • +
  • 'MDC' - Medical
    • +
  • 'LSN' - Learning Support Need
    • +
  • 'ALG' - Allergy
    • +
  • 'DPR' - Dietary Preference
    • +
+ oneOf: + - title: Other + enum: + - OTH + - title: Medical + enum: + - MDC + - title: Learning Support Need + enum: + - LSN + - title: Allergy + enum: + - ALG + - title: Dietary Preference + enum: + - DPR + StartDate: + type: string + format: date + description:

Starting Date for this Characteristic to be noted.

+ EndDate: + type: string + format: date + description:

End date for this Characteristic to be noted, if + there is one.

+ ReviewDate: + type: string + format: date + description:

Date at which this information should be reviewed.

+ CharacteristicNotes: + type: string + description:

Text relating to the particular + WellbeingCharacteristic.

+ CharacteristicCategory: + description:

Category of WellbeingCharacteristic.

+ CharacteristicSubCategory: + description:

Sub category of the WellbeingCharacteristic.

+ CharacteristicSeverity: + type: string + description:

The severity of the wellbeing characteristic

+ CharacteristicPriority: + type: string + title: Wellbeing Characteristic Priority + description: >- +

Codes denoting the priority level of the + characteristic in relation to other characteristics + within the same classification.

    +
  • 'HGH' - High
    • +
  • 'MOD' - Moderate
    • +
  • 'LOW' - Low
    • +
+ oneOf: + - title: High + enum: + - HGH + - title: Moderate + enum: + - MOD + - title: Low + enum: + - LOW + DailyManagement: + type: string + EmergencyManagement: + type: string + EmergencyResponsePlan: + type: string + Trigger: + type: string + Diagnosis: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + ConfidentialFlag: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeingCharac\ + teristicRefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/WellbeingCharacteristic/propertie\ + s/Diagnosis" + Alert: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeingCharac\ + teristicRefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/WellbeingCharacteristic/propertie\ + s/Diagnosis" + MedicationList: + description:

A list of the medications required for this Wellbeing + Characteristic.

+ type: object + properties: + Medication: + type: array + items: + description:

The medication, dosage and frequency, required + by the student to manage the Wellbeing + Characteristic.

+ type: object + properties: + MedicationName: + type: string + description:

Name of medication required for the + student.

+ Dosage: + type: string + description:

Dosage and strength of medication required + for the student.

+ Frequency: + type: string + description:

Frequency of Administration.

+ AdministrationInformation: + type: string + description:

Information about how the medication is to + be administered.

+ Method: + type: string + description:

Method of administration.

+ MedicationConsentList: + description:

A list consents that have been provided for + administration of a medicine to a student.

+ type: object + properties: + MedicationConsent: + type: array + items: + description:

Contains information about when, by + whom, and who consent was given to for + the administration of a medicine to a + student.

+ type: object + properties: + StartDate: + type: string + format: date + description:

The date from which the student + or student caretaker consented to + the medicine being administered to + the student by a particular + individual.

+ EndDate: + type: string + format: date + description:

The date the consent for + administration of the medicine ends + or is revoked.

+ ConsentedBy: + $ref: "#/paths/~1WellbeingCharacteristics\ + ~1%7BWellbeingCharacteristicRefId%7\ + D/put/requestBody/content/applicati\ + on~1json/schema/properties/Wellbein\ + gCharacteristic/properties/Student" + ProviderApplicableTo: + $ref: "#/paths/~1WellbeingCharacteristics\ + ~1%7BWellbeingCharacteristicRefId%7\ + D/put/requestBody/content/applicati\ + on~1json/schema/properties/Wellbein\ + gCharacteristic/properties/Student" + AdministeredBy: + $ref: "#/paths/~1WellbeingCharacteristics\ + ~1%7BWellbeingCharacteristicRefId%7\ + D/put/requestBody/content/applicati\ + on~1json/schema/properties/Wellbein\ + gCharacteristic/properties/Student" + DocumentList: + description:

Describes the Location of any associated documents + kept in relation to this Characteristic.

+ type: object + properties: + Document: + type: array + items: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeing\ + CharacteristicRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/WellbeingCharac\ + teristic/properties/Student" + WellbeingEventList: + description:

A list of any Wellbeing Events that have arisen as a + result of this Characteristic.

+ type: object + properties: + WellbeingEvent: + type: array + items: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeing\ + CharacteristicRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/WellbeingCharac\ + teristic/properties/Student" + WellbeingAlertList: + description:

A list of any Wellbeing Alerts that have arison as a + result of this Chracteristic.

+ type: object + properties: + WellbeingAlert: + type: array + items: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeing\ + CharacteristicRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/WellbeingCharac\ + teristic/properties/Student" + SpecialAssessmentConditionList: + description:

A list of the special assessment conditions that a + student is entitled to have when sitting an + assessment.

+ type: object + properties: + SpecialAssessmentCondition: + type: array + items: + type: string + title: Special Assessment Condition + description: >- +

Standard codes denoting special assessment + conditions that a student requires when sitting an + assessment.

    +
  • 'BRA' - Braille Paper
    • +
  • 'COM' - Computer OR Writer
    • +
  • 'ENL' - Enlarged Paper
    • +
  • 'EXT' - Extra Time
    • +
  • 'OTH' - Other
    • +
  • 'REA' - Reader
    • +
  • 'RES' - Rest Breaks
    • +
  • 'SEP' - Separate Accommodation
    • +
  • 'SIR' - Signing Reader
    • +
  • 'SIS' - Signing Supervisor
    • +
  • 'SPE' - Special Paper
    • +
+ oneOf: + - title: Braille Paper + enum: + - BRA + - title: Computer OR Writer + enum: + - COM + - title: Enlarged Paper + enum: + - ENL + - title: Extra Time + enum: + - EXT + - title: Other + enum: + - OTH + - title: Reader + enum: + - REA + - title: Rest Breaks + enum: + - RES + - title: Separate Accommodation + enum: + - SEP + - title: Signing Reader + enum: + - SIR + - title: Signing Supervisor + enum: + - SIS + - title: Special Paper + enum: + - SPE + Status: + type: string + title: Wellbeing Characteristic Status + description: >- +

Code set denoting the status of the Wellbeing + Characteristic.

    +
  • 'ACTI' - Active
    • +
  • 'CLOS' - Closed
    • +
  • 'CREA' - Created in Error
    • +
  • 'PEND' - Pending Approval
    • +
+ oneOf: + - title: Active + enum: + - ACTI + - title: Closed + enum: + - CLOS + - title: Created in Error + enum: + - CREA + - title: Pending Approval + enum: + - PEND + StudentConsentList: + description:

A list of the consents given by the stiudent or their + caregiver in relation to this Wellbeing + Characteristic.

+ type: object + properties: + StudentConsent: + type: array + items: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeing\ + CharacteristicRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/WellbeingCharac\ + teristic/properties/Student" + TeWharikiDomainList: + description:

A list of the Te Whāriki Domains that are relevant to + this Wellbeing Characteristic. Only used for Early + Childhood Education.

+ type: object + properties: + TeWharikiDomain: + type: array + items: + type: string + title: Learning Support Te Whariki Domain + description: >- +

Code set denoting the Te Whariki Domain an + Early Childhood Education related intervention is + part of.

    +
  • 'WMS' - Wellbeing - Managing Self
    • +
  • 'BLP' - Belonging - Participating
    • +
  • 'CRO' - Contributing - Relating to Others
    • +
  • 'COM' - Communication - Using Language, Symbols and Texts
    • +
+ oneOf: + - title: Wellbeing - Managing Self + enum: + - WMS + - title: Belonging - Participating + enum: + - BLP + - title: Contributing - Relating to Others + enum: + - CRO + - title: Communication - Using Language, Symbols and + Texts + enum: + - COM + LearningSupportOutcomeList: + description:

A list of the expected learning support outcome for + the Wellbeing Characteristic. Only used for Schools. +

+ type: object + properties: + LearningSupportOutcome: + type: array + items: + type: string + title: Learning Support Outcome + description: >- +

Code set denoting the outcome for the student + that the intervention is seeking to achieve for an + area of need. Only applies to Compulsive + Schooling.

    +
  • 'WBG' - Wellbeing
    • +
  • 'PNC' - Presence
    • +
  • 'PTN' - Participation
    • +
  • 'LAA' - Learning and Achievement
    • +
+ oneOf: + - title: Wellbeing + enum: + - WBG + - title: Presence + enum: + - PNC + - title: Participation + enum: + - PTN + - title: Learning and Achievement + enum: + - LAA + description:

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.

+ x-accessControl: + create: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + read: + - 1001 + - 1306 + - 2101 + - 2103 + - 2401 + - 2403 + update: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + WellbeingCharacteristic: + WellbeingCharacteristicRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + RecordingProvider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StartDate: 2017-11-01 + EndDate: 2017-11-10 + CharacteristicNotes: This Student has a special need. + CharacteristicCategory: S + application/xml: + schema: + type: object + properties: + WellbeingCharacteristic: + $ref: "#/paths/~1WellbeingCharacteristics~1%7BWellbeingCharacteri\ + sticRefId%7D/put/requestBody/content/application~1json/sche\ + ma/properties/WellbeingCharacteristic" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + 2017-11-01 + 2017-11-10 + This Student has a special need. + S + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - WellbeingCharacteristic + summary: Default operation to get a single WellbeingCharacteristic + parameters: + - name: WellbeingCharacteristicRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingCharacteristic.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + WellbeingCharacteristic: + $ref: "#/paths/~1WellbeingCharacteristics/get/responses/200/con\ + tent/application~1json/schema/properties/WellbeingCharact\ + eristics/properties/WellbeingCharacteristic/items" + example: + WellbeingCharacteristic: + WellbeingCharacteristicRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + RecordingProvider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + StartDate: 2017-11-01 + EndDate: 2017-11-10 + CharacteristicNotes: This Student has a special need. + CharacteristicCategory: S + application/xml: + schema: + type: object + properties: + WellbeingCharacteristic: + $ref: "#/paths/~1WellbeingCharacteristics/get/responses/200/con\ + tent/application~1json/schema/properties/WellbeingCharact\ + eristics/properties/WellbeingCharacteristic/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + 2017-11-01 + 2017-11-10 + This Student has a special need. + S + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - WellbeingCharacteristic + summary: Default operation to delete a single WellbeingCharacteristic + parameters: + - name: WellbeingCharacteristicRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingCharacteristic.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /WellbeingEvents: + get: + tags: + - WellbeingEvent + summary: Default operation to get a list of all available WellbeingEvents + description: Search the set of available WellbeingEvents, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + WellbeingEvents: + type: object + description: A List of WellbeingEvent objects + properties: + WellbeingEvent: + type: array + items: + required: + - ReportingProvider + - Student + type: object + properties: + WellbeingEventRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + WellbeingEventLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1WellbeingEvents/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/WellbeingEvents/properties/WellbeingEven\ + t/items/properties/WellbeingEventRefId" + LocalId: + $ref: "#/paths/~1WellbeingEvents/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/WellbeingEvents/properties/WellbeingEven\ + t/items/properties/WellbeingEventLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + ReportingProvider: + $ref: "#/paths/~1WellbeingEvents/get/responses/200/co\ + ntent/application~1json/schema/properties/Wellb\ + eingEvents/properties/WellbeingEvent/items/prop\ + erties/Student" + PhysicalRestraint: + $ref: "#/paths/~1WellbeingEvents/get/responses/200/co\ + ntent/application~1json/schema/properties/Wellb\ + eingEvents/properties/WellbeingEvent/items/prop\ + erties/Student" + EventNotes: + type: string + description:

Text relating to the particular + WellbeingEvent.

+ PossibleMotivationList: + description:

A list of the possible motivations that + triggered the event.

+ type: object + required: + - PossibleMotivation + properties: + PossibleMotivation: + type: array + items: + type: string + title: Wellbeing Event Possible Motivation + description: >- +

Code set denoting the possible + motivation that triggered the Wellbeing + Event.

    +
  • 'AVAD' - Avoid Adult
    • +
  • 'AVPE' - Avoid Peer(s)
    • +
  • 'AVTA' - Avoid Tasks / Activities
    • +
  • 'OBAD' - Obtain Adult Attention
    • +
  • 'OBIT' - Obtain Items / Activities
    • +
  • 'OBPE' - Obtain Peer Attention
    • +
  • 'OTHE' - Other
    • +
  • 'UNKN' - Unknown Motivation
    • +
+ oneOf: + - title: Avoid Adult + enum: + - AVAD + - title: Avoid Peer(s) + enum: + - AVPE + - title: Avoid Tasks / Activities + enum: + - AVTA + - title: Obtain Adult Attention + enum: + - OBAD + - title: Obtain Items / Activities + enum: + - OBIT + - title: Obtain Peer Attention + enum: + - OBPE + - title: Other + enum: + - OTHE + - title: Unknown Motivation + enum: + - UNKN + EventCategoryClass: + type: string + title: Wellbeing Event Category Class + description: >- +

Standard codes denoting the first level + category of the Wellbeing Event. (Note: The + second and third levels are Category and + SubCategory)

    +
  • 'POS' - Positive
    • +
  • 'NEG' - Negative
    • +
  • 'DAT' - Data Record Only
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Positive + enum: + - POS + - title: Negative + enum: + - NEG + - title: Data Record Only + enum: + - DAT + - title: Other + enum: + - OTH + EventCategoryList: + description:

List of Categories of WellbeingEvent.

+ type: object + required: + - EventCategory + properties: + EventCategory: + type: array + items: + description:

+ type: object + required: + - Category + properties: + Category: + type: string + title: Wellbeing Event Category + description: >- +

Standard codes denoting the second + level category of the Wellbeing Event. + (Note: The first and third levels are + CategoryClass and SubCategory)

+
    +
  • 'B1' - Safe
    • +
  • 'B2' - Caring
    • +
  • 'B3' - Respectful
    • +
  • 'B4' - Responsible
    • +
  • 'B5' - Enterprising
    • +
  • 'B6' - Effort
    • +
  • 'B7' - Citizenship
    • +
  • 'B8' - Cooperation
    • +
  • 'B9' - Leadership
    • +
  • 'M1' - Aggressive physical contact against staff
    • +
  • 'M2' - Abuse, threats, harassment or intimidation of staff
    • +
  • 'M3' - Aggressive physical contact against a student
    • +
plus 7 more value(s) at NZCodeSetsWellbeingEventCategoryType + oneOf: + - title: Safe + enum: + - B1 + - title: Caring + enum: + - B2 + - title: Respectful + enum: + - B3 + - title: Responsible + enum: + - B4 + - title: Enterprising + enum: + - B5 + - title: Effort + enum: + - B6 + - title: Citizenship + enum: + - B7 + - title: Cooperation + enum: + - B8 + - title: Leadership + enum: + - B9 + - title: Aggressive physical contact + against staff + enum: + - M1 + - title: Abuse, threats, harassment or + intimidation of staff + enum: + - M2 + - title: Aggressive physical contact + against a student + enum: + - M3 + - title: Abuse, threats, harassment or + intimidation of a student + enum: + - M4 + - title: Damage to, or theft of property + enum: + - M5 + - title: Other violation of Code of Conduct + (classroom managed) + enum: + - M6 + - title: Possession, use or supply of + substances or objects with + restricted sale + enum: + - M7 + - title: Possession, use or supply of + illegal substances or objects + enum: + - M8 + - title: E-breaches + enum: + - M9 + - title: Other Behaviour + enum: + - OT + EventSubCategoryList: + description:

List of Categories of the + WellbeingEvent.

+ type: object + required: + - EventSubCategory + properties: + EventSubCategory: + type: array + items: + description:

+ type: object + required: + - SubCategory + properties: + SubCategory: + type: string + title: Wellbeing Event Sub Category + description: >- +

Standard codes denoting + the third level category of + the Wellbeing Event. (Note: + The first and second levels + are CategoryClass and + Category)

    +
  • 'B1A' - Resolves issues peacefully
    • +
  • 'B1B' - Plays in a friendly way
    • +
  • 'B1C' - Uses equipment safely
    • +
  • 'B1D' - Understands the purpose and need for rules
    • +
  • 'B1E' - Seeks help from a responsible adult
    • +
  • 'B1F' - Alerts others to risks and dangers
    • +
  • 'B1G' - Moves away from danger
    • +
  • 'B1H' - Uses protective interruption with peers
    • +
  • 'B1I' - Observes and listens before acting
    • +
  • 'B2A' - Helps someone or something in need
    • +
  • 'B2B' - Shows empathy
    • +
  • 'B2C' - Shows compassion
    • +
plus 166 more value(s) at NZCodeSetsWellbeingEventSubCategoryType + oneOf: + - title: Resolves issues + peacefully + enum: + - B1A + - title: Plays in a friendly way + enum: + - B1B + - title: Uses equipment safely + enum: + - B1C + - title: Understands the purpose + and need for rules + enum: + - B1D + - title: Seeks help from a + responsible adult + enum: + - B1E + - title: Alerts others to risks + and dangers + enum: + - B1F + - title: Moves away from danger + enum: + - B1G + - title: Uses protective + interruption with peers + enum: + - B1H + - title: Observes and listens + before acting + enum: + - B1I + - title: Helps someone or + something in need + enum: + - B2A + - title: Shows empathy + enum: + - B2B + - title: Shows compassion + enum: + - B2C + - title: Is forgiving + enum: + - B2D + - title: Talks in a friendly way + enum: + - B2E + - title: Shows intercultural + understanding + enum: + - B3A + - title: Acknowledges authority + enum: + - B3B + - title: Shows courtesy + enum: + - B3C + - title: Is polite + enum: + - B3D + - title: Accepts difference + enum: + - B3E + - title: Acknowledges the rights + of others + enum: + - B3F + - title: Uses appropriate + language/tone + enum: + - B3G + - title: Gives value to others' + opinions + enum: + - B3H + - title: Maintains appropriate + personal space + enum: + - B3I + - title: Shows consideration of + impact of actions on + others + enum: + - B3J + - title: Is honest + enum: + - B4A + - title: Acts with integrity + enum: + - B4B + - title: Self regulates + enum: + - B4C + - title: Co-regulates + enum: + - B4D + - title: Helps others to regulate + enum: + - B4E + - title: Is trustworthy + enum: + - B4F + - title: Copes with frustration + enum: + - B4G + - title: Accepts accountability + enum: + - B4H + - title: Owns consequences of + actions + enum: + - B4I + - title: Is organised + enum: + - B4J + - title: Thinks critically + enum: + - B5A + - title: Is creative + enum: + - B5B + - title: Is timely + enum: + - B5C + - title: Takes considered risks + enum: + - B5D + - title: Takes a problem solving + approach + enum: + - B5E + - title: Is adaptable + enum: + - B5F + - title: Shows independence + enum: + - B5G + - title: Takes initiative + enum: + - B5H + - title: Shows persistence + enum: + - B5I + - title: Shows courage + enum: + - B5J + - title: Negotiates + enum: + - B5K + - title: Is persuasive + enum: + - B5L + - title: Builds social support + (networks) + enum: + - B5M + - title: Innovates + enum: + - B5N + - title: Shows determination + enum: + - B5O + - title: Pays attention + enum: + - B6A + - title: Tries hard + enum: + - B6B + - title: Completes work + enum: + - B6C + - title: Perseveres + enum: + - B6D + - title: Asks questions + enum: + - B6E + - title: Shows desire to learn + enum: + - B6F + - title: Stays on task + enum: + - B6G + - title: Participates + constructively + enum: + - B6H + - title: Shows commitment to + identified goals + enum: + - B6I + - title: Promotes justice + enum: + - B7A + - title: Follows rules and laws + enum: + - B7B + - title: Stands up for others + appropriately + enum: + - B7C + - title: Puts others' needs + before own + enum: + - B7D + - title: Contributes to the + school/class + enum: + - B7E + - title: Contributes to the + community + enum: + - B7F + - title: Is involved + enum: + - B7G + - title: Belongs + enum: + - B7H + - title: Promotes harmony + enum: + - B7I + - title: Gives back to the + greater good + enum: + - B7J + - title: Becomes informed + enum: + - B7K + - title: Uses procedures and + protocols + enum: + - B7L + - title: Participates in + democratic decision + making + enum: + - B7M + - title: Helps others to reach + their goals + enum: + - B7N + - title: Is fair + enum: + - B8A + - title: Shows mutuality (sharing + a feeling, action or + relationship) + enum: + - B8B + - title: Shows reciprocity ("I + scratch your back, you + scratch mine") + enum: + - B8C + - title: Shows goodwill + enum: + - B8D + - title: Is attentive to others' + reactions + enum: + - B8E + - title: Is open to + dialogue/discussion + enum: + - B8F + - title: Works to be a valued + member of a team + enum: + - B8G + - title: Offers others choices + enum: + - B8H + - title: Inspires others + enum: + - B9A + - title: Represents others + enum: + - B9B + - title: Delegates to others + enum: + - B9C + - title: Shows self confidence + enum: + - B9D + - title: Shows assertiveness + enum: + - B9E + - title: Stays positive + enum: + - B9F + - title: Shoulders blame + enum: + - B9G + - title: Sets an example + enum: + - B9H + - title: Communicates effectively + enum: + - B9I + - title: Shows wisdom + enum: + - B9J + - title: Striking - Staff + enum: + - M1A + - title: Pushing or barging - + Staff + enum: + - M1B + - title: Use of a weapon or + object - Staff + enum: + - M1C + - title: Projectile - Staff + enum: + - M1D + - title: Struggling to be free of + a physical restraint - + Staff + enum: + - M1E + - title: Unintentional but + negligent contact - + Staff + enum: + - M1F + - title: Verbal abuse - Staff + enum: + - M2A + - title: Non-Verbal abuse - Staff + enum: + - M2B + - title: Verbal threat - Staff + enum: + - M2C + - title: Threatening gesture - + Staff + enum: + - M2D + - title: Disrespectful or + challenging language - + Staff + enum: + - M2E + - title: Malicious gossip - Staff + enum: + - M2F + - title: Sexual harassment - Staff + enum: + - M2G + - title: Striking - Student + enum: + - M3A + - title: Pushing or barging - + Student + enum: + - M3B + - title: Use of a weapon or + object - Student + enum: + - M3C + - title: Projectile - Student + enum: + - M3D + - title: Struggling to be free of + violation of personal + space or deprivation of + liberty - Student + enum: + - M3E + - title: Unintentional but + negligent contact - + Student + enum: + - M3F + - title: Verbal abuse - Student + enum: + - M4A + - title: Non-Verbal abuse - + Student + enum: + - M4B + - title: Verbal threat - Student + enum: + - M4C + - title: Threatening gesture - + Student + enum: + - M4D + - title: Malicious gossip - + Student + enum: + - M4E + - title: Exclusion of peer - + Student + enum: + - M4F + - title: Teasing - Student + enum: + - M4G + - title: Unhelpful bystander + actions - Student + enum: + - M4H + - title: Sexual harassment - + Student + enum: + - M4I + - title: Theft of personal + property + enum: + - M5A + - title: Theft of school property + enum: + - M5B + - title: Deliberate damage to + personal property + enum: + - M5C + - title: Incidental damage + through negligence + enum: + - M5D + - title: Graffiti + enum: + - M5E + - title: Buildings and glass + enum: + - M5F + - title: Fittings and fixtures + enum: + - M5G + - title: Furniture + enum: + - M5H + - title: Equipment + enum: + - M5I + - title: Vehicles + enum: + - M5J + - title: Garden and plants + enum: + - M5K + - title: Active refusal to follow + reasonable instructions + enum: + - M6A + - title: Passive non-compliance + enum: + - M6B + - title: Disruptive + enum: + - M6C + - title: Defiant + enum: + - M6D + - title: Unclear boundaries + enum: + - M6E + - title: Erratic + enum: + - M6F + - title: Impulsive + enum: + - M6G + - title: Uninterested + enum: + - M6H + - title: Inattentive + enum: + - M6I + - title: Unresponsive + enum: + - M6J + - title: Unprepared + enum: + - M6K + - title: Out of bounds + enum: + - M6L + - title: Dress code breach + without reasonable + explanation + enum: + - M6N + - title: Lateness + enum: + - M6O + - title: Class-work avoidance + enum: + - M6P + - title: Unsafe + enum: + - M6Q + - title: Out of class without + permission + enum: + - M6R + - title: Annoying + enum: + - M6S + - title: Inappropriate language + enum: + - M6T + - title: Academic dishonesty + enum: + - M6U + - title: Loud + enum: + - M6V + - title: Out of seat + enum: + - M6W + - title: Failure to use manners + enum: + - M6X + - title: Littering + enum: + - M6Y + - title: Disorderly + enum: + - M6Z + - title: Cigarette / e-cigarette + enum: + - M7A + - title: Alcohol + enum: + - M7B + - title: Over-the-counter + medication + enum: + - M7C + - title: ADHD medication + enum: + - M7D + - title: Other prescription + medication + enum: + - M7E + - title: Aerosol + enum: + - M7F + - title: Solvents + enum: + - M7G + - title: Inappropriate sexual + material + enum: + - M7H + - title: Knife or blade + enum: + - M8A + - title: Firearm + enum: + - M8B + - title: Amphetamines + enum: + - M8C + - title: Marijuana + enum: + - M8D + - title: Drug implement or + paraphernalia + enum: + - M8E + - title: Other illegal drug + enum: + - M8F + - title: Other illegal weapon + enum: + - M8G + - title: Cyberbullying + enum: + - M9A + - title: Hacking + enum: + - M9B + - title: Breach of Department + acceptable use agreement + enum: + - M9C + - title: Breach of Students + Online Policy + enum: + - M9D + - title: Persistent personal use + of a MED when not + permitted + enum: + - M9E + - title: Inappropriate audio or + video recording + enum: + - M9F + - title: Inappropriate uploading + of text, images or audio + enum: + - M9G + - title: Public posting of + messages that bring the + school or Department + into disrepute + enum: + - M9H + - title: Copyright infringement + or plagiarism + enum: + - M9I + Severity: + type: string + title: Wellbeing Event Severity + description: >- +

Code set denoting the severity of the + Wellbeing Event.

    +
  • 'MIN' - Minor
    • +
  • 'MAJ' - Major
    • +
+ oneOf: + - title: Minor + enum: + - MIN + - title: Major + enum: + - MAJ + ReportingStaffMember: + $ref: "#/paths/~1WellbeingEvents/get/responses/200/co\ + ntent/application~1json/schema/properties/Wellb\ + eingEvents/properties/WellbeingEvent/items/prop\ + erties/Student" + EventLocationList: + description:

A list of the locations where the incident + took place.

+ type: object + required: + - Location + properties: + Location: + type: array + items: + type: string + title: Wellbeing Event Location + description: >- +

Code set denoting locations where a + Wellbeing Event incident may have took + place.

    +
  • 'ARTR' - Art Room
    • +
  • 'BATH' - Bathroom / Restroom
    • +
  • 'BUSL' - Bus Loading Zone
    • +
  • 'BUSS' - Bus
    • +
  • 'CAFE' - Cafeteria
    • +
  • 'CLAS' - Classroom
    • +
  • 'COMM' - Commons / Common Area
    • +
  • 'COMP' - Computer Lab
    • +
  • 'GYMM' - Gym
    • +
  • 'HALL' - Hallway / Breezeway
    • +
  • 'LIBR' - Library
    • +
  • 'LOCK' - Locker Room
    • +
plus 10 more value(s) at NZCodeSetsWellbeingEventLocationType + oneOf: + - title: Art Room + description: The area used for art classes and + activities. + enum: + - ARTR + - title: Bathroom / Restroom + description: Areas used by students for taking care + of personal needs. + enum: + - BATH + - title: Bus Loading Zone + description: The area used for bus loading and + unloading. + enum: + - BUSL + - title: Bus + description: The area inside the bus. + enum: + - BUSS + - title: Cafeteria + description: The area used for breakfast and lunch. + enum: + - CAFE + - title: Classroom + description: Areas used for instructional purposes. + enum: + - CLAS + - title: Commons / Common Area + description: Areas shared by students and staff for + specific activities. + enum: + - COMM + - title: Computer Lab + description: Area used for group computer classes + and activities. + enum: + - COMP + - title: Gym + description: Areas used for physical education + activities. + enum: + - GYMM + - title: Hallway / Breezeway + description: Areas designated for passing from one + activity/class to another. + enum: + - HALL + - title: Library + description: The area designated for research and + study. + enum: + - LIBR + - title: Locker Room + description: The area used by students to prepare + for and completing physical education + classes and/or sporting events. + enum: + - LOCK + - title: Music Room + description: The area used by students for music + activities (e.g., music class, choir, + band). + enum: + - MUSC + - title: Off-Campus + description: An area beyond the property boundary + of the school and not affiliated with + a school activity. + enum: + - OFFC + - title: Office + description: The area used by school staff for + primary school business and + management. + enum: + - OFFI + - title: Other Location + description: The location for problem behavior + event occurs in a location that is not + listed. + enum: + - OTHE + - title: Parking Lot + description: Areas used for parking vehicles during + school hours. + enum: + - PARK + - title: Playground + description: The outside area used for recess breaks + enum: + - PLAY + - title: Special Event / Assembly / Field Trip + description: Areas used for infrequent activities + that occur in and/or out of school. + enum: + - SPEC + - title: Stadium + description: Area used for athletic/special events. + enum: + - STAD + - title: Unknown + description: The location of problem behavior event + is not known or undetermined. + enum: + - UNKN + - title: Vocational Room + description: The area of a school used for + vocational classes and activities. + enum: + - VOCA + EventLocationDescription: + type: string + description:

Details of Event Location.

+ EventCreationTimeStamp: + description:

Date and time of the WellbeingEvent record + creation.

+ EventDate: + type: string + format: date + description:

The calendar date on which this + WellbeingEvent occured.

+ EventTime: + description:

The time when WellbeingEvent occured.

+ EventDescription: + type: string + description:

A description of the WellbeingEvent.

+ EventTimePeriod: + type: string + title: Wellbeing Event Time Period + description: >- +

Standard codes denoting the time period of + the Wellbeing Event.

    +
  • 'AM' - AM
    • +
  • 'PM' - PM
    • +
  • 'R' - Recess
    • +
  • 'B' - Before School
    • +
  • 'A' - After School
    • +
  • 'Ex' - Excursion
    • +
  • 'W' - Weekend
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: AM + enum: + - AM + - title: PM + enum: + - PM + - title: Recess + enum: + - R + - title: Before School + enum: + - B + - title: After School + enum: + - A + - title: Excursion + enum: + - Ex + - title: Weekend + enum: + - W + - title: Other + enum: + - O + ConfidentialFlag: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PersonInvolvementList: + description:

List of People involved in the Wellbeing + event. Mandatory if more people than the student + to which this event occurs is involved.

+ type: object + required: + - PersonInvolvement + properties: + PersonInvolvement: + type: array + items: + description:

A repeatable element recording the + identifier and details of another person + that was involved in the Wellbeing + Event/Response.

+ type: object + required: + - ObjectType + properties: + HowInvolved: + type: string + description:

Optional free text detailing + involvement.

+ PersonType: + type: string + title: Person Involved Type + description: >- +

Code set denoting the type of + person that was involved.

    +
  • 'NONE' - None
    • +
  • 'OTHE' - Other
    • +
  • 'PEER' - Peers
    • +
  • 'STAF' - Staff
    • +
  • 'SUBS' - Substitute
    • +
  • 'TEAC' - Teacher
    • +
  • 'UNKN' - Unknown
    • +
+ oneOf: + - title: None + enum: + - NONE + - title: Other + enum: + - OTHE + - title: Peers + enum: + - PEER + - title: Staff + enum: + - STAF + - title: Substitute + enum: + - SUBS + - title: Teacher + enum: + - TEAC + - title: Unknown + enum: + - UNKN + Status: + type: string + title: Wellbeing Status + description: >- +

Standard codes denoting the status of the + Wellbeing Response.

    +
  • 'U' - Unresolved
    • +
  • 'R' - Resolved
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Unresolved + enum: + - U + - title: Resolved + enum: + - R + - title: Other + enum: + - O + BehaviourIdentifiedList: + description:

A list of the problem behaviours identified + for the student as a result of the Wellbeing + Event. There are both minor and major + behaviours.

+ type: object + properties: + BehaviourIdentifiedList: + type: object + properties: + MinorBehaviour: + type: array + items: + - type: string + title: Wellbeing Event Minor Behaviour + description: >- +

Code set denoting the type of + minor behaviour problem identified + as part of the Wellbeing Event.

+
    +
  • 'DEFIA' - Defiance
    • +
  • 'DISRE' - Disrespect
    • +
  • 'DISRU' - Disruption
    • +
  • 'DRESS' - Dress Code Violation
    • +
  • 'INAPP' - Inappropriate Language
    • +
  • 'OTHER' - Other
    • +
  • 'PHYSI' - Physical Contact / Physical Aggression
    • +
  • 'PROPE' - Property Misuse
    • +
  • 'TARDY' - Tardy
    • +
  • 'TECHN' - Technology Violation
    • +
+ oneOf: + - title: Defiance + description: Student engages in brief or + low-intensity failure to follow + directions or talks back. + enum: + - DEFIA + - title: Disrespect + description: Student delivers low-intensity, + socially rude or dismissive + messages to adults or students. + enum: + - DISRE + - title: Disruption + description: Student engages in + low-intensity, but inappropriate + disruption. + enum: + - DISRU + - title: Dress Code Violation + description: Student wears clothing that is + near, but not within, the dress + code guidelines defined by the + school/district. + enum: + - DRESS + - title: Inappropriate Language + description: Student engages in low-intensity + instance of inappropriate + language. + enum: + - INAPP + - title: Other + description: Student engages in any other + minor problem behaviors that do + not fall within the above + categories. + enum: + - OTHER + - title: Physical Contact / Physical + Aggression + description: Student engages in non-serious, + but inappropriate physical + contact. + enum: + - PHYSI + - title: Property Misuse + description: Student engages in low-intensity + misuse of property. + enum: + - PROPE + - title: Tardy + description: Student arrives at class after + the bell (or signal that class + has started). + enum: + - TARDY + - title: Technology Violation + description: Student engages in non-serious, + but inappropriate (as defined by + school) use of cell phone, + pager, music/video players, + camera, and/or computer. + enum: + - TECHN + MajorBehaviour: + type: array + items: + - type: string + title: Wellbeing Event Major Behaviour + description: >- +

Code set denoting the type of + major behaviour problem identified + as part of the Wellbeing Event.

+
    +
  • 'ABUSI' - Abusive Language / Inappropriate Language / Profanity
    • +
  • 'ARSON' - Arson
    • +
  • 'BOMBT' - Bomb Threat / False Alarm
    • +
  • 'DEFIA' - Defiance / Insubordination / Non-Compliance
    • +
  • 'DISRE' - Disrespect
    • +
  • 'DISRU' - Disruption
    • +
  • 'DRESS' - Dress Code Violation
    • +
  • 'FIGHT' - Fighting
    • +
  • 'FORGE' - Forgery / Theft / Plagiarism
    • +
  • 'GANGA' - Gang Affiliation Display
    • +
  • 'HARAS' - Harassment
    • +
  • 'INADI' - Inappropriate Display of Affection
    • +
plus 14 more value(s) at NZCodeSetsWellbeingEventMajorBehaviourType + oneOf: + - title: Abusive Language / Inappropriate + Language / Profanity + description: Student delivers verbal messages + that include swearing, name + calling, or use of words in an + inappropriate way. + enum: + - ABUSI + - title: Arson + description: Student plans and/or + participates in malicious + burning of property. + enum: + - ARSON + - title: Bomb Threat / False Alarm + description: Student delivers a message of + possible explosive materials + being on-campus, near campus, + and/or pending explosion. + enum: + - BOMBT + - title: Defiance / Insubordination / + Non-Compliance + description: Student engages in refusal to + follow directions or talks back. + enum: + - DEFIA + - title: Disrespect + description: Student delivers socially rude + or dismissive messages to adults + or students. + enum: + - DISRE + - title: Disruption + description: Student engages in behavior + causing an interruption in a + class or activity. Disruption + includes sustained loud talk, + yelling, or screaming; noise + with materials; horseplay or + roughhousing; and/or sustained + out-of-seat behavior. + enum: + - DISRU + - title: Dress Code Violation + description: Student wears clothing that does + not fit within the dress code + guidelines practiced by the + school/district. + enum: + - DRESS + - title: Fighting + description: Student is involved in mutual + participation in an incident + involving physical violence. + enum: + - FIGHT + - title: Forgery / Theft / Plagiarism + description: Student is involved by being in + possession of, having passed on, + or being responsible for + removing someone else's + property; or the student has + signed a person’s name without + that person’s permission, or + claims someone else’s work as + their own. + enum: + - FORGE + - title: Gang Affiliation Display + description: Student uses gesture, dress, + and/or speech to display + affiliation with a gang. + enum: + - GANGA + - title: Harassment + description: The delivery of disrespectful + messages in any format related + to gender, ethnicity, sex, race, + religion, disability, physical + features, or other protected + class. + enum: + - HARAS + - title: Inappropriate Display of + Affection + description: Student engages in + inappropriate, consensual (as + defined by school) verbal and/or + physical gestures/contact, of a + sexual nature to another + student/adult. + enum: + - INADI + - title: Inappropriate Location / Out of + Bounds Area + description: Student is in an area that is + outside of school boundaries (as + defined by school). + enum: + - INALO + - title: Lying / Cheating + description: Student delivers message that is + untrue and/or deliberately + violates rules. + enum: + - LYING + - title: Other Behaviour + description: Student engages in problem + behavior not listed. + enum: + - OTHER + - title: Physical Aggression + description: Student engages in actions + involving serious physical + contact where injury may occur + (e.g., hitting, punching, + hitting with an object, kicking, + hair pulling, scratching, etc.). + enum: + - PHYSI + - title: Property Damage / Vandalism + description: Student participates in an + activity that results in + destruction or disfigurement of + property. + enum: + - PROPE + - title: Skip Class + description: Student leaves or misses class + without permission. + enum: + - SKIPC + - title: Tardy + description: Student is late (as defined by + the school) to class or the + start up of the school day (and + Tardy is not considered a minor + problem behavior in the school). + enum: + - TARDY + - title: Technology Violation + description: Student engages in inappropriate + (as defined by school) use of + cell phone, pager, music/video + players, camera, and/or + computer. + enum: + - TECHN + - title: Truancy + description: Student receives an ‘unexcused + absence’ for ½ day or more. + enum: + - TRUAN + - title: Use / Possession of Alcohol + description: Student is in possession of or + is using alcohol. + enum: + - UPOAL + - title: Use / Possession of Combustibles + description: Student is/was in possession of + substances/objects readily + capable of causing bodily harm + and/or property damage (matches, + lighters, firecrackers, + gasoline, lighter fluid). + enum: + - UPOCO + - title: Use / Possession of Drugs + description: Student is in possession of or + is using illegal + drugs/substances or imitations. + enum: + - UPODR + - title: Use / Possession of Tobacco + description: Student is in possession of or + is using tobacco. + enum: + - UPOTO + - title: Use / Possession of Weapons + description: Student is in possession of + knives (greater than 6 in., less + than 6 in.) and guns (real or + look alike), or other objects + readily capable of causing + bodily harm. + enum: + - UPOWE + RestraintType: + type: string + title: Wellbeing Event Restraint Type + description: >- +

Codes denoting the type of restraint used on + a student during a Wellbeing Event.

    +
  • 'NON' - None
    • +
  • 'RES' - Restraint
    • +
  • 'RAS' - Restraint and Seclusion
    • +
  • 'SEC' - Seclusion
    • +
+ oneOf: + - title: None + description: No restraint or seclusion was used. + enum: + - NON + - title: Restraint + description: Any measure or condition used to immobilize + or reduce the ability of a student to move + his or her torso, arms, legs, or head + freely. + enum: + - RES + - title: Restraint and Seclusion + description: The use of both restraint and seclusion. + enum: + - RAS + - title: Seclusion + description: The involuntary confinement of a student + alone in a room or area from which the + student is physically prevented from leaving + or believes they cannot freely exit. + enum: + - SEC + ActionTakenList: + description:

A list of the actions taken as a result of + this WellbeingEvent.

+ type: object + required: + - ActionTaken + properties: + ActionTaken: + type: array + items: + type: string + title: Wellbeing Event Action Taken + description: >- +

Code set denoting the actions that can + be taken as a result of the Wellbeing + event.

    +
  • 'AASS' - Additional Attendance / Saturday School
    • +
  • 'ACPE' - Action Pending
    • +
  • 'ALPL' - Alternative Placement
    • +
  • 'BUSU' - Bus Suspension
    • +
  • 'COSE' - Community Service
    • +
  • 'COST' - Conference with Student
    • +
  • 'EXPU' - Expulsion
    • +
  • 'ININ' - Individualised Instruction
    • +
  • 'ISSU' - In-School Suspension
    • +
  • 'LOPR' - Loss of Privilege
    • +
  • 'OATA' - Other Action Taken
    • +
  • 'OOSS' - Out-of-School Suspension
    • +
plus 4 more value(s) at NZCodeSetsWellbeingEventActionTakenType + oneOf: + - title: Additional Attendance / Saturday School + description: Consequence for referral results in + student attending classes on a + Saturday. + enum: + - AASS + - title: Action Pending + description: Consequence for referral is pending. + Referral will be modified when “action + taken” is determined. + enum: + - ACPE + - title: Alternative Placement + description: Consequence for referral results in + student being placed in a different + educational setting. + enum: + - ALPL + - title: Bus Suspension + description: Consequence for referral results in + 1-3 day period when student not + allowed on the bus. + enum: + - BUSU + - title: Community Service + description: Consequence for referral results in + involvement in community service + activities or projects. + enum: + - COSE + - title: Conference with Student + description: Consequence for referral results in + student meeting with administrator, + teacher, and/or parent (in any + combination). + enum: + - COST + - title: Expulsion + description: Consequence for referral results in + student being dismissed from school + permanently. + enum: + - EXPU + - title: Individualised Instruction + description: Consequence for referral results in + student receiving individualized + instruction specifically related to + the student’s problem behaviors. + enum: + - ININ + - title: In-School Suspension + description: Consequence for referral results in a + period of time spent away from + scheduled activities/classes during + the school day. + enum: + - ISSU + - title: Loss of Privilege + description: Consequence for referral results in + student being unable to participate in + some type of privilege. + enum: + - LOPR + - title: Other Action Taken + description: Consequence for referral results in + administrative decision that is not + listed. Staff using this area will + specify the administrative action + taken. + enum: + - OATA + - title: Out-of-School Suspension + description: Consequence for referral results in a + 1-3 day period when student is not + allowed on campus. + enum: + - OOSS + - title: Parent Contact + description: Consequence for referral results in + parent communication by phone, email, + or person-to-person about the problem. + enum: + - PACO + - title: Restitution / Community Service + description: Consequence for referral results in + apologizing or compensating for loss, + damage, or injury; community services. + enum: + - RECS + - title: Time in Office + description: Consequence for referral results in + student spending time in the office + away from scheduled + activities/classes. + enum: + - TIOF + - title: Time Out / Detention + description: Consequence for referral results in + student spending time in a specified + area away from scheduled + activities/classes. + enum: + - TODE + DocumentList: + description:

Describes the Location of any associated + documents kept in relation to this Response.

+ type: object + required: + - Document + properties: + Document: + type: array + items: + $ref: "#/paths/~1WellbeingEvents/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/WellbeingEvents/properties/Wellbei\ + ngEvent/items/properties/Student" + RelatedWellbeingEventList: + description:

A Wellbeing Event gets created for every + student involved in an event. This list links + together all related Wellbeing Events.

+ type: object + required: + - RelatedWellbeingEvent + properties: + RelatedWellbeingEvent: + type: array + items: + $ref: "#/paths/~1WellbeingEvents/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/WellbeingEvents/properties/Wellbei\ + ngEvent/items/properties/Student" + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + WellbeingEvents: + WellbeingEvent: + - WellbeingEventRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + ReportingProvider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + EventCategoryClass: POS + EventDate: 2017-11-01 + EventTimePeriod: AM + RestraintType: NON + ActionTakenList: + ActionTaken: ININ + application/xml: + schema: + type: object + properties: + WellbeingEvents: + type: object + description: A List of WellbeingEvent objects + properties: + WellbeingEvent: + type: array + items: + $ref: "#/paths/~1WellbeingEvents/get/responses/200/conten\ + t/application~1json/schema/properties/WellbeingEven\ + ts/properties/WellbeingEvent/items" + example: >- + + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + POS + 2017-11-01 + AM + NON + + ININ + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/WellbeingEvents/{WellbeingEventRefId}": + post: + tags: + - WellbeingEvent + summary: Default operation to create a single WellbeingEvent + parameters: + - name: WellbeingEventRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingEvent.

+ required: true + schema: + type: string + operationId: createWellbeingEvent + requestBody: + description: CRUD operation on WellbeingEvent + content: + application/json: + schema: + type: object + properties: + WellbeingEvent: + $ref: "#/paths/~1WellbeingEvents/get/responses/200/content/applic\ + ation~1json/schema/properties/WellbeingEvents/properties/We\ + llbeingEvent/items" + example: + WellbeingEvent: + WellbeingEventRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + ReportingProvider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + EventCategoryClass: POS + EventDate: 2017-11-01 + EventTimePeriod: AM + RestraintType: NON + ActionTakenList: + ActionTaken: ININ + application/xml: + schema: + type: object + properties: + WellbeingEvent: + $ref: "#/paths/~1WellbeingEvents/get/responses/200/content/applic\ + ation~1json/schema/properties/WellbeingEvents/properties/We\ + llbeingEvent/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + POS + 2017-11-01 + AM + NON + + ININ + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - WellbeingEvent + summary: Default operation to update a single WellbeingEvent + parameters: + - name: WellbeingEventRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingEvent.

+ required: true + schema: + type: string + operationId: updateWellbeingEvent + requestBody: + description: CRUD operation on WellbeingEvent + content: + application/json: + schema: + type: object + properties: + WellbeingEvent: + type: object + properties: + WellbeingEventRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + WellbeingEventLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1WellbeingEvents~1%7BWellbeingEventRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/WellbeingEvent/properties/WellbeingEven\ + tRefId" + LocalId: + $ref: "#/paths/~1WellbeingEvents~1%7BWellbeingEventRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/WellbeingEvent/properties/WellbeingEven\ + tLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + ReportingProvider: + $ref: "#/paths/~1WellbeingEvents~1%7BWellbeingEventRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/WellbeingEvent/properties/Student" + PhysicalRestraint: + $ref: "#/paths/~1WellbeingEvents~1%7BWellbeingEventRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/WellbeingEvent/properties/Student" + EventNotes: + type: string + description:

Text relating to the particular WellbeingEvent.

+ PossibleMotivationList: + description:

A list of the possible motivations that triggered the + event.

+ type: object + properties: + PossibleMotivation: + type: array + items: + type: string + title: Wellbeing Event Possible Motivation + description: >- +

Code set denoting the possible motivation that + triggered the Wellbeing Event.

    +
  • 'AVAD' - Avoid Adult
    • +
  • 'AVPE' - Avoid Peer(s)
    • +
  • 'AVTA' - Avoid Tasks / Activities
    • +
  • 'OBAD' - Obtain Adult Attention
    • +
  • 'OBIT' - Obtain Items / Activities
    • +
  • 'OBPE' - Obtain Peer Attention
    • +
  • 'OTHE' - Other
    • +
  • 'UNKN' - Unknown Motivation
    • +
+ oneOf: + - title: Avoid Adult + enum: + - AVAD + - title: Avoid Peer(s) + enum: + - AVPE + - title: Avoid Tasks / Activities + enum: + - AVTA + - title: Obtain Adult Attention + enum: + - OBAD + - title: Obtain Items / Activities + enum: + - OBIT + - title: Obtain Peer Attention + enum: + - OBPE + - title: Other + enum: + - OTHE + - title: Unknown Motivation + enum: + - UNKN + EventCategoryClass: + type: string + title: Wellbeing Event Category Class + description: >- +

Standard codes denoting the first level category of + the Wellbeing Event. (Note: The second and third levels + are Category and SubCategory)

    +
  • 'POS' - Positive
    • +
  • 'NEG' - Negative
    • +
  • 'DAT' - Data Record Only
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Positive + enum: + - POS + - title: Negative + enum: + - NEG + - title: Data Record Only + enum: + - DAT + - title: Other + enum: + - OTH + EventCategoryList: + description:

List of Categories of WellbeingEvent.

+ type: object + properties: + EventCategory: + type: array + items: + description:

+ type: object + properties: + Category: + type: string + title: Wellbeing Event Category + description: >- +

Standard codes denoting the second level + category of the Wellbeing Event. (Note: The + first and third levels are CategoryClass and + SubCategory)

    +
  • 'B1' - Safe
    • +
  • 'B2' - Caring
    • +
  • 'B3' - Respectful
    • +
  • 'B4' - Responsible
    • +
  • 'B5' - Enterprising
    • +
  • 'B6' - Effort
    • +
  • 'B7' - Citizenship
    • +
  • 'B8' - Cooperation
    • +
  • 'B9' - Leadership
    • +
  • 'M1' - Aggressive physical contact against staff
    • +
  • 'M2' - Abuse, threats, harassment or intimidation of staff
    • +
  • 'M3' - Aggressive physical contact against a student
    • +
plus 7 more value(s) at NZCodeSetsWellbeingEventCategoryType + oneOf: + - title: Safe + enum: + - B1 + - title: Caring + enum: + - B2 + - title: Respectful + enum: + - B3 + - title: Responsible + enum: + - B4 + - title: Enterprising + enum: + - B5 + - title: Effort + enum: + - B6 + - title: Citizenship + enum: + - B7 + - title: Cooperation + enum: + - B8 + - title: Leadership + enum: + - B9 + - title: Aggressive physical contact against staff + enum: + - M1 + - title: Abuse, threats, harassment or intimidation + of staff + enum: + - M2 + - title: Aggressive physical contact against a + student + enum: + - M3 + - title: Abuse, threats, harassment or intimidation + of a student + enum: + - M4 + - title: Damage to, or theft of property + enum: + - M5 + - title: Other violation of Code of Conduct + (classroom managed) + enum: + - M6 + - title: Possession, use or supply of substances or + objects with restricted sale + enum: + - M7 + - title: Possession, use or supply of illegal + substances or objects + enum: + - M8 + - title: E-breaches + enum: + - M9 + - title: Other Behaviour + enum: + - OT + EventSubCategoryList: + description:

List of Categories of the + WellbeingEvent.

+ type: object + properties: + EventSubCategory: + type: array + items: + description:

+ type: object + properties: + SubCategory: + type: string + title: Wellbeing Event Sub Category + description: >- +

Standard codes denoting the third + level category of the Wellbeing + Event. (Note: The first and second + levels are CategoryClass and + Category)

    +
  • 'B1A' - Resolves issues peacefully
    • +
  • 'B1B' - Plays in a friendly way
    • +
  • 'B1C' - Uses equipment safely
    • +
  • 'B1D' - Understands the purpose and need for rules
    • +
  • 'B1E' - Seeks help from a responsible adult
    • +
  • 'B1F' - Alerts others to risks and dangers
    • +
  • 'B1G' - Moves away from danger
    • +
  • 'B1H' - Uses protective interruption with peers
    • +
  • 'B1I' - Observes and listens before acting
    • +
  • 'B2A' - Helps someone or something in need
    • +
  • 'B2B' - Shows empathy
    • +
  • 'B2C' - Shows compassion
    • +
plus 166 more value(s) at NZCodeSetsWellbeingEventSubCategoryType + oneOf: + - title: Resolves issues peacefully + enum: + - B1A + - title: Plays in a friendly way + enum: + - B1B + - title: Uses equipment safely + enum: + - B1C + - title: Understands the purpose and need + for rules + enum: + - B1D + - title: Seeks help from a responsible + adult + enum: + - B1E + - title: Alerts others to risks and + dangers + enum: + - B1F + - title: Moves away from danger + enum: + - B1G + - title: Uses protective interruption + with peers + enum: + - B1H + - title: Observes and listens before + acting + enum: + - B1I + - title: Helps someone or something in + need + enum: + - B2A + - title: Shows empathy + enum: + - B2B + - title: Shows compassion + enum: + - B2C + - title: Is forgiving + enum: + - B2D + - title: Talks in a friendly way + enum: + - B2E + - title: Shows intercultural understanding + enum: + - B3A + - title: Acknowledges authority + enum: + - B3B + - title: Shows courtesy + enum: + - B3C + - title: Is polite + enum: + - B3D + - title: Accepts difference + enum: + - B3E + - title: Acknowledges the rights of others + enum: + - B3F + - title: Uses appropriate language/tone + enum: + - B3G + - title: Gives value to others' opinions + enum: + - B3H + - title: Maintains appropriate personal + space + enum: + - B3I + - title: Shows consideration of impact of + actions on others + enum: + - B3J + - title: Is honest + enum: + - B4A + - title: Acts with integrity + enum: + - B4B + - title: Self regulates + enum: + - B4C + - title: Co-regulates + enum: + - B4D + - title: Helps others to regulate + enum: + - B4E + - title: Is trustworthy + enum: + - B4F + - title: Copes with frustration + enum: + - B4G + - title: Accepts accountability + enum: + - B4H + - title: Owns consequences of actions + enum: + - B4I + - title: Is organised + enum: + - B4J + - title: Thinks critically + enum: + - B5A + - title: Is creative + enum: + - B5B + - title: Is timely + enum: + - B5C + - title: Takes considered risks + enum: + - B5D + - title: Takes a problem solving approach + enum: + - B5E + - title: Is adaptable + enum: + - B5F + - title: Shows independence + enum: + - B5G + - title: Takes initiative + enum: + - B5H + - title: Shows persistence + enum: + - B5I + - title: Shows courage + enum: + - B5J + - title: Negotiates + enum: + - B5K + - title: Is persuasive + enum: + - B5L + - title: Builds social support (networks) + enum: + - B5M + - title: Innovates + enum: + - B5N + - title: Shows determination + enum: + - B5O + - title: Pays attention + enum: + - B6A + - title: Tries hard + enum: + - B6B + - title: Completes work + enum: + - B6C + - title: Perseveres + enum: + - B6D + - title: Asks questions + enum: + - B6E + - title: Shows desire to learn + enum: + - B6F + - title: Stays on task + enum: + - B6G + - title: Participates constructively + enum: + - B6H + - title: Shows commitment to identified + goals + enum: + - B6I + - title: Promotes justice + enum: + - B7A + - title: Follows rules and laws + enum: + - B7B + - title: Stands up for others + appropriately + enum: + - B7C + - title: Puts others' needs before own + enum: + - B7D + - title: Contributes to the school/class + enum: + - B7E + - title: Contributes to the community + enum: + - B7F + - title: Is involved + enum: + - B7G + - title: Belongs + enum: + - B7H + - title: Promotes harmony + enum: + - B7I + - title: Gives back to the greater good + enum: + - B7J + - title: Becomes informed + enum: + - B7K + - title: Uses procedures and protocols + enum: + - B7L + - title: Participates in democratic + decision making + enum: + - B7M + - title: Helps others to reach their goals + enum: + - B7N + - title: Is fair + enum: + - B8A + - title: Shows mutuality (sharing a + feeling, action or relationship) + enum: + - B8B + - title: Shows reciprocity ("I scratch + your back, you scratch mine") + enum: + - B8C + - title: Shows goodwill + enum: + - B8D + - title: Is attentive to others' reactions + enum: + - B8E + - title: Is open to dialogue/discussion + enum: + - B8F + - title: Works to be a valued member of a + team + enum: + - B8G + - title: Offers others choices + enum: + - B8H + - title: Inspires others + enum: + - B9A + - title: Represents others + enum: + - B9B + - title: Delegates to others + enum: + - B9C + - title: Shows self confidence + enum: + - B9D + - title: Shows assertiveness + enum: + - B9E + - title: Stays positive + enum: + - B9F + - title: Shoulders blame + enum: + - B9G + - title: Sets an example + enum: + - B9H + - title: Communicates effectively + enum: + - B9I + - title: Shows wisdom + enum: + - B9J + - title: Striking - Staff + enum: + - M1A + - title: Pushing or barging - Staff + enum: + - M1B + - title: Use of a weapon or object - Staff + enum: + - M1C + - title: Projectile - Staff + enum: + - M1D + - title: Struggling to be free of a + physical restraint - Staff + enum: + - M1E + - title: Unintentional but negligent + contact - Staff + enum: + - M1F + - title: Verbal abuse - Staff + enum: + - M2A + - title: Non-Verbal abuse - Staff + enum: + - M2B + - title: Verbal threat - Staff + enum: + - M2C + - title: Threatening gesture - Staff + enum: + - M2D + - title: Disrespectful or challenging + language - Staff + enum: + - M2E + - title: Malicious gossip - Staff + enum: + - M2F + - title: Sexual harassment - Staff + enum: + - M2G + - title: Striking - Student + enum: + - M3A + - title: Pushing or barging - Student + enum: + - M3B + - title: Use of a weapon or object - + Student + enum: + - M3C + - title: Projectile - Student + enum: + - M3D + - title: Struggling to be free of + violation of personal space or + deprivation of liberty - Student + enum: + - M3E + - title: Unintentional but negligent + contact - Student + enum: + - M3F + - title: Verbal abuse - Student + enum: + - M4A + - title: Non-Verbal abuse - Student + enum: + - M4B + - title: Verbal threat - Student + enum: + - M4C + - title: Threatening gesture - Student + enum: + - M4D + - title: Malicious gossip - Student + enum: + - M4E + - title: Exclusion of peer - Student + enum: + - M4F + - title: Teasing - Student + enum: + - M4G + - title: Unhelpful bystander actions - + Student + enum: + - M4H + - title: Sexual harassment - Student + enum: + - M4I + - title: Theft of personal property + enum: + - M5A + - title: Theft of school property + enum: + - M5B + - title: Deliberate damage to personal + property + enum: + - M5C + - title: Incidental damage through + negligence + enum: + - M5D + - title: Graffiti + enum: + - M5E + - title: Buildings and glass + enum: + - M5F + - title: Fittings and fixtures + enum: + - M5G + - title: Furniture + enum: + - M5H + - title: Equipment + enum: + - M5I + - title: Vehicles + enum: + - M5J + - title: Garden and plants + enum: + - M5K + - title: Active refusal to follow + reasonable instructions + enum: + - M6A + - title: Passive non-compliance + enum: + - M6B + - title: Disruptive + enum: + - M6C + - title: Defiant + enum: + - M6D + - title: Unclear boundaries + enum: + - M6E + - title: Erratic + enum: + - M6F + - title: Impulsive + enum: + - M6G + - title: Uninterested + enum: + - M6H + - title: Inattentive + enum: + - M6I + - title: Unresponsive + enum: + - M6J + - title: Unprepared + enum: + - M6K + - title: Out of bounds + enum: + - M6L + - title: Dress code breach without + reasonable explanation + enum: + - M6N + - title: Lateness + enum: + - M6O + - title: Class-work avoidance + enum: + - M6P + - title: Unsafe + enum: + - M6Q + - title: Out of class without permission + enum: + - M6R + - title: Annoying + enum: + - M6S + - title: Inappropriate language + enum: + - M6T + - title: Academic dishonesty + enum: + - M6U + - title: Loud + enum: + - M6V + - title: Out of seat + enum: + - M6W + - title: Failure to use manners + enum: + - M6X + - title: Littering + enum: + - M6Y + - title: Disorderly + enum: + - M6Z + - title: Cigarette / e-cigarette + enum: + - M7A + - title: Alcohol + enum: + - M7B + - title: Over-the-counter medication + enum: + - M7C + - title: ADHD medication + enum: + - M7D + - title: Other prescription medication + enum: + - M7E + - title: Aerosol + enum: + - M7F + - title: Solvents + enum: + - M7G + - title: Inappropriate sexual material + enum: + - M7H + - title: Knife or blade + enum: + - M8A + - title: Firearm + enum: + - M8B + - title: Amphetamines + enum: + - M8C + - title: Marijuana + enum: + - M8D + - title: Drug implement or paraphernalia + enum: + - M8E + - title: Other illegal drug + enum: + - M8F + - title: Other illegal weapon + enum: + - M8G + - title: Cyberbullying + enum: + - M9A + - title: Hacking + enum: + - M9B + - title: Breach of Department acceptable + use agreement + enum: + - M9C + - title: Breach of Students Online Policy + enum: + - M9D + - title: Persistent personal use of a MED + when not permitted + enum: + - M9E + - title: Inappropriate audio or video + recording + enum: + - M9F + - title: Inappropriate uploading of text, + images or audio + enum: + - M9G + - title: Public posting of messages that + bring the school or Department + into disrepute + enum: + - M9H + - title: Copyright infringement or + plagiarism + enum: + - M9I + Severity: + type: string + title: Wellbeing Event Severity + description: >- +

Code set denoting the severity of the Wellbeing + Event.

    +
  • 'MIN' - Minor
    • +
  • 'MAJ' - Major
    • +
+ oneOf: + - title: Minor + enum: + - MIN + - title: Major + enum: + - MAJ + ReportingStaffMember: + $ref: "#/paths/~1WellbeingEvents~1%7BWellbeingEventRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/WellbeingEvent/properties/Student" + EventLocationList: + description:

A list of the locations where the incident took + place.

+ type: object + properties: + Location: + type: array + items: + type: string + title: Wellbeing Event Location + description: >- +

Code set denoting locations where a Wellbeing + Event incident may have took place.

    +
  • 'ARTR' - Art Room
    • +
  • 'BATH' - Bathroom / Restroom
    • +
  • 'BUSL' - Bus Loading Zone
    • +
  • 'BUSS' - Bus
    • +
  • 'CAFE' - Cafeteria
    • +
  • 'CLAS' - Classroom
    • +
  • 'COMM' - Commons / Common Area
    • +
  • 'COMP' - Computer Lab
    • +
  • 'GYMM' - Gym
    • +
  • 'HALL' - Hallway / Breezeway
    • +
  • 'LIBR' - Library
    • +
  • 'LOCK' - Locker Room
    • +
plus 10 more value(s) at NZCodeSetsWellbeingEventLocationType + oneOf: + - title: Art Room + description: The area used for art classes and activities. + enum: + - ARTR + - title: Bathroom / Restroom + description: Areas used by students for taking care of + personal needs. + enum: + - BATH + - title: Bus Loading Zone + description: The area used for bus loading and unloading. + enum: + - BUSL + - title: Bus + description: The area inside the bus. + enum: + - BUSS + - title: Cafeteria + description: The area used for breakfast and lunch. + enum: + - CAFE + - title: Classroom + description: Areas used for instructional purposes. + enum: + - CLAS + - title: Commons / Common Area + description: Areas shared by students and staff for + specific activities. + enum: + - COMM + - title: Computer Lab + description: Area used for group computer classes and + activities. + enum: + - COMP + - title: Gym + description: Areas used for physical education activities. + enum: + - GYMM + - title: Hallway / Breezeway + description: Areas designated for passing from one + activity/class to another. + enum: + - HALL + - title: Library + description: The area designated for research and study. + enum: + - LIBR + - title: Locker Room + description: The area used by students to prepare for and + completing physical education classes and/or + sporting events. + enum: + - LOCK + - title: Music Room + description: The area used by students for music activities + (e.g., music class, choir, band). + enum: + - MUSC + - title: Off-Campus + description: An area beyond the property boundary of the + school and not affiliated with a school + activity. + enum: + - OFFC + - title: Office + description: The area used by school staff for primary + school business and management. + enum: + - OFFI + - title: Other Location + description: The location for problem behavior event occurs + in a location that is not listed. + enum: + - OTHE + - title: Parking Lot + description: Areas used for parking vehicles during school + hours. + enum: + - PARK + - title: Playground + description: The outside area used for recess breaks + enum: + - PLAY + - title: Special Event / Assembly / Field Trip + description: Areas used for infrequent activities that + occur in and/or out of school. + enum: + - SPEC + - title: Stadium + description: Area used for athletic/special events. + enum: + - STAD + - title: Unknown + description: The location of problem behavior event is not + known or undetermined. + enum: + - UNKN + - title: Vocational Room + description: The area of a school used for vocational + classes and activities. + enum: + - VOCA + EventLocationDescription: + type: string + description:

Details of Event Location.

+ EventCreationTimeStamp: + description:

Date and time of the WellbeingEvent record + creation.

+ EventDate: + type: string + format: date + description:

The calendar date on which this WellbeingEvent + occured.

+ EventTime: + description:

The time when WellbeingEvent occured.

+ EventDescription: + type: string + description:

A description of the WellbeingEvent.

+ EventTimePeriod: + type: string + title: Wellbeing Event Time Period + description: >- +

Standard codes denoting the time period of the + Wellbeing Event.

    +
  • 'AM' - AM
    • +
  • 'PM' - PM
    • +
  • 'R' - Recess
    • +
  • 'B' - Before School
    • +
  • 'A' - After School
    • +
  • 'Ex' - Excursion
    • +
  • 'W' - Weekend
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: AM + enum: + - AM + - title: PM + enum: + - PM + - title: Recess + enum: + - R + - title: Before School + enum: + - B + - title: After School + enum: + - A + - title: Excursion + enum: + - Ex + - title: Weekend + enum: + - W + - title: Other + enum: + - O + ConfidentialFlag: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + PersonInvolvementList: + description:

List of People involved in the Wellbeing event. + Mandatory if more people than the student to which this + event occurs is involved.

+ type: object + properties: + PersonInvolvement: + type: array + items: + description:

A repeatable element recording the identifier + and details of another person that was involved in + the Wellbeing Event/Response.

+ type: object + properties: + HowInvolved: + type: string + description:

Optional free text detailing + involvement.

+ PersonType: + type: string + title: Person Involved Type + description: >- +

Code set denoting the type of person that + was involved.

    +
  • 'NONE' - None
    • +
  • 'OTHE' - Other
    • +
  • 'PEER' - Peers
    • +
  • 'STAF' - Staff
    • +
  • 'SUBS' - Substitute
    • +
  • 'TEAC' - Teacher
    • +
  • 'UNKN' - Unknown
    • +
+ oneOf: + - title: None + enum: + - NONE + - title: Other + enum: + - OTHE + - title: Peers + enum: + - PEER + - title: Staff + enum: + - STAF + - title: Substitute + enum: + - SUBS + - title: Teacher + enum: + - TEAC + - title: Unknown + enum: + - UNKN + Status: + type: string + title: Wellbeing Status + description: >- +

Standard codes denoting the status of the Wellbeing + Response.

    +
  • 'U' - Unresolved
    • +
  • 'R' - Resolved
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Unresolved + enum: + - U + - title: Resolved + enum: + - R + - title: Other + enum: + - O + BehaviourIdentifiedList: + description:

A list of the problem behaviours identified for the + student as a result of the Wellbeing Event. There are + both minor and major behaviours.

+ type: object + properties: + BehaviourIdentifiedList: + type: object + properties: + MinorBehaviour: + type: array + items: + - type: string + title: Wellbeing Event Minor Behaviour + description: >- +

Code set denoting the type of minor + behaviour problem identified as part of the + Wellbeing Event.

    +
  • 'DEFIA' - Defiance
    • +
  • 'DISRE' - Disrespect
    • +
  • 'DISRU' - Disruption
    • +
  • 'DRESS' - Dress Code Violation
    • +
  • 'INAPP' - Inappropriate Language
    • +
  • 'OTHER' - Other
    • +
  • 'PHYSI' - Physical Contact / Physical Aggression
    • +
  • 'PROPE' - Property Misuse
    • +
  • 'TARDY' - Tardy
    • +
  • 'TECHN' - Technology Violation
    • +
+ oneOf: + - title: Defiance + description: Student engages in brief or + low-intensity failure to follow + directions or talks back. + enum: + - DEFIA + - title: Disrespect + description: Student delivers low-intensity, socially + rude or dismissive messages to adults or + students. + enum: + - DISRE + - title: Disruption + description: Student engages in low-intensity, but + inappropriate disruption. + enum: + - DISRU + - title: Dress Code Violation + description: Student wears clothing that is near, but + not within, the dress code guidelines + defined by the school/district. + enum: + - DRESS + - title: Inappropriate Language + description: Student engages in low-intensity + instance of inappropriate language. + enum: + - INAPP + - title: Other + description: Student engages in any other minor + problem behaviors that do not fall + within the above categories. + enum: + - OTHER + - title: Physical Contact / Physical Aggression + description: Student engages in non-serious, but + inappropriate physical contact. + enum: + - PHYSI + - title: Property Misuse + description: Student engages in low-intensity misuse + of property. + enum: + - PROPE + - title: Tardy + description: Student arrives at class after the bell + (or signal that class has started). + enum: + - TARDY + - title: Technology Violation + description: Student engages in non-serious, but + inappropriate (as defined by school) use + of cell phone, pager, music/video + players, camera, and/or computer. + enum: + - TECHN + MajorBehaviour: + type: array + items: + - type: string + title: Wellbeing Event Major Behaviour + description: >- +

Code set denoting the type of major + behaviour problem identified as part of the + Wellbeing Event.

    +
  • 'ABUSI' - Abusive Language / Inappropriate Language / Profanity
    • +
  • 'ARSON' - Arson
    • +
  • 'BOMBT' - Bomb Threat / False Alarm
    • +
  • 'DEFIA' - Defiance / Insubordination / Non-Compliance
    • +
  • 'DISRE' - Disrespect
    • +
  • 'DISRU' - Disruption
    • +
  • 'DRESS' - Dress Code Violation
    • +
  • 'FIGHT' - Fighting
    • +
  • 'FORGE' - Forgery / Theft / Plagiarism
    • +
  • 'GANGA' - Gang Affiliation Display
    • +
  • 'HARAS' - Harassment
    • +
  • 'INADI' - Inappropriate Display of Affection
    • +
plus 14 more value(s) at NZCodeSetsWellbeingEventMajorBehaviourType + oneOf: + - title: Abusive Language / Inappropriate + Language / Profanity + description: Student delivers verbal messages that + include swearing, name calling, or use + of words in an inappropriate way. + enum: + - ABUSI + - title: Arson + description: Student plans and/or participates in + malicious burning of property. + enum: + - ARSON + - title: Bomb Threat / False Alarm + description: Student delivers a message of possible + explosive materials being on-campus, + near campus, and/or pending explosion. + enum: + - BOMBT + - title: Defiance / Insubordination / + Non-Compliance + description: Student engages in refusal to follow + directions or talks back. + enum: + - DEFIA + - title: Disrespect + description: Student delivers socially rude or + dismissive messages to adults or + students. + enum: + - DISRE + - title: Disruption + description: Student engages in behavior causing an + interruption in a class or activity. + Disruption includes sustained loud talk, + yelling, or screaming; noise with + materials; horseplay or roughhousing; + and/or sustained out-of-seat behavior. + enum: + - DISRU + - title: Dress Code Violation + description: Student wears clothing that does not fit + within the dress code guidelines + practiced by the school/district. + enum: + - DRESS + - title: Fighting + description: Student is involved in mutual + participation in an incident involving + physical violence. + enum: + - FIGHT + - title: Forgery / Theft / Plagiarism + description: Student is involved by being in + possession of, having passed on, or + being responsible for removing someone + else's property; or the student has + signed a person’s name without that + person’s permission, or claims someone + else’s work as their own. + enum: + - FORGE + - title: Gang Affiliation Display + description: Student uses gesture, dress, and/or + speech to display affiliation with a + gang. + enum: + - GANGA + - title: Harassment + description: The delivery of disrespectful messages + in any format related to gender, + ethnicity, sex, race, religion, + disability, physical features, or other + protected class. + enum: + - HARAS + - title: Inappropriate Display of Affection + description: Student engages in inappropriate, + consensual (as defined by school) verbal + and/or physical gestures/contact, of a + sexual nature to another student/adult. + enum: + - INADI + - title: Inappropriate Location / Out of Bounds + Area + description: Student is in an area that is outside of + school boundaries (as defined by + school). + enum: + - INALO + - title: Lying / Cheating + description: Student delivers message that is untrue + and/or deliberately violates rules. + enum: + - LYING + - title: Other Behaviour + description: Student engages in problem behavior not + listed. + enum: + - OTHER + - title: Physical Aggression + description: Student engages in actions involving + serious physical contact where injury + may occur (e.g., hitting, punching, + hitting with an object, kicking, hair + pulling, scratching, etc.). + enum: + - PHYSI + - title: Property Damage / Vandalism + description: Student participates in an activity that + results in destruction or disfigurement + of property. + enum: + - PROPE + - title: Skip Class + description: Student leaves or misses class without + permission. + enum: + - SKIPC + - title: Tardy + description: Student is late (as defined by the + school) to class or the start up of the + school day (and Tardy is not considered + a minor problem behavior in the school). + enum: + - TARDY + - title: Technology Violation + description: Student engages in inappropriate (as + defined by school) use of cell phone, + pager, music/video players, camera, + and/or computer. + enum: + - TECHN + - title: Truancy + description: Student receives an ‘unexcused absence’ + for ½ day or more. + enum: + - TRUAN + - title: Use / Possession of Alcohol + description: Student is in possession of or is using + alcohol. + enum: + - UPOAL + - title: Use / Possession of Combustibles + description: Student is/was in possession of + substances/objects readily capable of + causing bodily harm and/or property + damage (matches, lighters, firecrackers, + gasoline, lighter fluid). + enum: + - UPOCO + - title: Use / Possession of Drugs + description: Student is in possession of or is using + illegal drugs/substances or imitations. + enum: + - UPODR + - title: Use / Possession of Tobacco + description: Student is in possession of or is using + tobacco. + enum: + - UPOTO + - title: Use / Possession of Weapons + description: Student is in possession of knives + (greater than 6 in., less than 6 in.) + and guns (real or look alike), or other + objects readily capable of causing + bodily harm. + enum: + - UPOWE + RestraintType: + type: string + title: Wellbeing Event Restraint Type + description: >- +

Codes denoting the type of restraint used on a + student during a Wellbeing Event.

    +
  • 'NON' - None
    • +
  • 'RES' - Restraint
    • +
  • 'RAS' - Restraint and Seclusion
    • +
  • 'SEC' - Seclusion
    • +
+ oneOf: + - title: None + description: No restraint or seclusion was used. + enum: + - NON + - title: Restraint + description: Any measure or condition used to immobilize or + reduce the ability of a student to move his or her + torso, arms, legs, or head freely. + enum: + - RES + - title: Restraint and Seclusion + description: The use of both restraint and seclusion. + enum: + - RAS + - title: Seclusion + description: The involuntary confinement of a student alone in a + room or area from which the student is physically + prevented from leaving or believes they cannot + freely exit. + enum: + - SEC + ActionTakenList: + description:

A list of the actions taken as a result of this + WellbeingEvent.

+ type: object + properties: + ActionTaken: + type: array + items: + type: string + title: Wellbeing Event Action Taken + description: >- +

Code set denoting the actions that can be taken + as a result of the Wellbeing event.

    +
  • 'AASS' - Additional Attendance / Saturday School
    • +
  • 'ACPE' - Action Pending
    • +
  • 'ALPL' - Alternative Placement
    • +
  • 'BUSU' - Bus Suspension
    • +
  • 'COSE' - Community Service
    • +
  • 'COST' - Conference with Student
    • +
  • 'EXPU' - Expulsion
    • +
  • 'ININ' - Individualised Instruction
    • +
  • 'ISSU' - In-School Suspension
    • +
  • 'LOPR' - Loss of Privilege
    • +
  • 'OATA' - Other Action Taken
    • +
  • 'OOSS' - Out-of-School Suspension
    • +
plus 4 more value(s) at NZCodeSetsWellbeingEventActionTakenType + oneOf: + - title: Additional Attendance / Saturday School + description: Consequence for referral results in student + attending classes on a Saturday. + enum: + - AASS + - title: Action Pending + description: Consequence for referral is pending. Referral + will be modified when “action taken” is + determined. + enum: + - ACPE + - title: Alternative Placement + description: Consequence for referral results in student + being placed in a different educational + setting. + enum: + - ALPL + - title: Bus Suspension + description: Consequence for referral results in 1-3 day + period when student not allowed on the bus. + enum: + - BUSU + - title: Community Service + description: Consequence for referral results in + involvement in community service activities or + projects. + enum: + - COSE + - title: Conference with Student + description: Consequence for referral results in student + meeting with administrator, teacher, and/or + parent (in any combination). + enum: + - COST + - title: Expulsion + description: Consequence for referral results in student + being dismissed from school permanently. + enum: + - EXPU + - title: Individualised Instruction + description: Consequence for referral results in student + receiving individualized instruction + specifically related to the student’s problem + behaviors. + enum: + - ININ + - title: In-School Suspension + description: Consequence for referral results in a period + of time spent away from scheduled + activities/classes during the school day. + enum: + - ISSU + - title: Loss of Privilege + description: Consequence for referral results in student + being unable to participate in some type of + privilege. + enum: + - LOPR + - title: Other Action Taken + description: Consequence for referral results in + administrative decision that is not listed. + Staff using this area will specify the + administrative action taken. + enum: + - OATA + - title: Out-of-School Suspension + description: Consequence for referral results in a 1-3 day + period when student is not allowed on campus. + enum: + - OOSS + - title: Parent Contact + description: Consequence for referral results in parent + communication by phone, email, or + person-to-person about the problem. + enum: + - PACO + - title: Restitution / Community Service + description: Consequence for referral results in + apologizing or compensating for loss, damage, + or injury; community services. + enum: + - RECS + - title: Time in Office + description: Consequence for referral results in student + spending time in the office away from + scheduled activities/classes. + enum: + - TIOF + - title: Time Out / Detention + description: Consequence for referral results in student + spending time in a specified area away from + scheduled activities/classes. + enum: + - TODE + DocumentList: + description:

Describes the Location of any associated documents + kept in relation to this Response.

+ type: object + properties: + Document: + type: array + items: + $ref: "#/paths/~1WellbeingEvents~1%7BWellbeingEventRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/WellbeingEvent/properties/Student" + RelatedWellbeingEventList: + description:

A Wellbeing Event gets created for every student + involved in an event. This list links together all + related Wellbeing Events.

+ type: object + properties: + RelatedWellbeingEvent: + type: array + items: + $ref: "#/paths/~1WellbeingEvents~1%7BWellbeingEventRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/WellbeingEvent/properties/Student" + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + WellbeingEvent: + WellbeingEventRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + ReportingProvider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + EventCategoryClass: POS + EventDate: 2017-11-01 + EventTimePeriod: AM + RestraintType: NON + ActionTakenList: + ActionTaken: ININ + application/xml: + schema: + type: object + properties: + WellbeingEvent: + $ref: "#/paths/~1WellbeingEvents~1%7BWellbeingEventRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/Well\ + beingEvent" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + POS + 2017-11-01 + AM + NON + + ININ + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - WellbeingEvent + summary: Default operation to get a single WellbeingEvent + parameters: + - name: WellbeingEventRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingEvent.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + WellbeingEvent: + $ref: "#/paths/~1WellbeingEvents/get/responses/200/content/appl\ + ication~1json/schema/properties/WellbeingEvents/propertie\ + s/WellbeingEvent/items" + example: + WellbeingEvent: + WellbeingEventRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + ReportingProvider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + EventCategoryClass: POS + EventDate: 2017-11-01 + EventTimePeriod: AM + RestraintType: NON + ActionTakenList: + ActionTaken: ININ + application/xml: + schema: + type: object + properties: + WellbeingEvent: + $ref: "#/paths/~1WellbeingEvents/get/responses/200/content/appl\ + ication~1json/schema/properties/WellbeingEvents/propertie\ + s/WellbeingEvent/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + POS + 2017-11-01 + AM + NON + + ININ + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - WellbeingEvent + summary: Default operation to delete a single WellbeingEvent + parameters: + - name: WellbeingEventRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingEvent.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /WellbeingResponses: + get: + tags: + - WellbeingResponse + summary: Default operation to get a list of all available WellbeingResponses + description: Search the set of available WellbeingResponses, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + WellbeingResponses: + type: object + description: A List of WellbeingResponse objects + properties: + WellbeingResponse: + type: array + items: + required: + - Provider + - Student + type: object + properties: + WellbeingResponseRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + WellbeingResponseLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1WellbeingResponses/get/responses\ + /200/content/application~1json/schema/prope\ + rties/WellbeingResponses/properties/Wellbei\ + ngResponse/items/properties/WellbeingRespon\ + seRefId" + LocalId: + $ref: "#/paths/~1WellbeingResponses/get/responses\ + /200/content/application~1json/schema/prope\ + rties/WellbeingResponses/properties/Wellbei\ + ngResponse/items/properties/WellbeingRespon\ + seLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1WellbeingResponses/get/responses/200\ + /content/application~1json/schema/properties/We\ + llbeingResponses/properties/WellbeingResponse/i\ + tems/properties/Student" + PublishedDate: + type: string + format: date + description:

The calendar date on which this + WellbeingResponse was published.

+ StartDate: + type: string + format: date + description:

The date the WellbeingResponse period + commenced.

+ EndDate: + type: string + format: date + description:

The date the WellbeingResponse is due to + finish.

+ ResponseStatus: + type: string + title: Wellbeing Status + description: >- +

Standard codes denoting the status of the + Wellbeing Response.

    +
  • 'U' - Unresolved
    • +
  • 'R' - Resolved
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Unresolved + enum: + - U + - title: Resolved + enum: + - R + - title: Other + enum: + - O + ResponseCategory: + type: string + title: Wellbeing Response Category + description: >- +

Standard codes denoting the category a + Wellbeing Response belongs to.

    +
  • 'S' - Suspension
    • +
  • 'D' - Detention
    • +
  • 'A' - Award
    • +
  • 'P' - Plan Required
    • +
  • 'M' - Multiple Response
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Suspension + enum: + - S + - title: Detention + enum: + - D + - title: Award + enum: + - A + - title: Plan Required + enum: + - P + - title: Multiple Response + enum: + - M + - title: Other + enum: + - O + ResponseNotes: + type: string + description:

Text relating to the particular + WellbeingResponse.

+ PersonInvolvementList: + description:

List of People involved in the Wellbeing + Event/Response. Mandatory if more people than + the student to which this event/response occurs + is involved.

+ type: object + required: + - PersonInvolvement + properties: + PersonInvolvement: + type: array + items: + description:

A repeatable element recording the + identifier and details of another person + that was involved in the Wellbeing + Event/Response.

+ type: object + required: + - ObjectType + properties: + HowInvolved: + type: string + description:

Optional free text detailing + involvement.

+ PersonType: + type: string + title: Person Involved Type + description: >- +

Code set denoting the type of + person that was involved.

    +
  • 'NONE' - None
    • +
  • 'OTHE' - Other
    • +
  • 'PEER' - Peers
    • +
  • 'STAF' - Staff
    • +
  • 'SUBS' - Substitute
    • +
  • 'TEAC' - Teacher
    • +
  • 'UNKN' - Unknown
    • +
+ oneOf: + - title: None + enum: + - NONE + - title: Other + enum: + - OTHE + - title: Peers + enum: + - PEER + - title: Staff + enum: + - STAF + - title: Substitute + enum: + - SUBS + - title: Teacher + enum: + - TEAC + - title: Unknown + enum: + - UNKN + Suspension: + description:

Container for details of a Suspension or + Expulsion.

+ type: object + properties: + SuspensionCategory: + type: string + title: Suspension Category + description: >- +

Standard codes denoting the suspension + category a Wellbeing Response belongs + to.

    +
  • 'E' - Expulsion
    • +
  • 'WE' - Whole Exclusion
    • +
  • 'P' - Partial Exclusion
    • +
  • 'I' - In School
    • +
  • 'W' - Withdrawal
    • +
  • 'S' - Suspension
    • +
  • 'R' - Removal
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Expulsion + enum: + - E + - title: Whole Exclusion + enum: + - WE + - title: Partial Exclusion + enum: + - P + - title: In School + enum: + - I + - title: Withdrawal + enum: + - W + - title: Suspension + enum: + - S + - title: Removal + enum: + - R + - title: Other + enum: + - O + WithdrawalTimeList: + description:

Where a student is to be removed or + withdrawn partially for particular times in + a week within the Start and End dates of the + Response.

+ type: object + required: + - Withdrawal + properties: + Withdrawal: + type: array + items: + description:

Repeatable Withdrawal.

+ type: object + properties: + WithdrawalStartDate: + type: string + format: date + description:

The start date of the + withdrawal.

+ WithdrawalEndDate: + type: string + format: date + description:

The end date of the + withdrawal.

+ WithdrawalStartTime: + description:

Start time of the Withdrawal on + that day.

+ WithdrawalEndTime: + description:

End time of the Withdrawal on + that day.

+ SchoolTerm: + type: integer + description:

The school term the withdrawal + took place in.

+ WithdrawalFrom: + $ref: "#/paths/~1WellbeingResponses/get\ + /responses/200/content/applicatio\ + n~1json/schema/properties/Wellbei\ + ngResponses/properties/WellbeingR\ + esponse/items/properties/Student" + Duration: + description:

The duration of a Suspension in days 0.00 + – X.xx. (Half Day = 0.5, Full Day = 1.0 or + the percentage of any day.) Must be provided + for a Suspension when known.

+ AdvisementDate: + type: string + format: date + description:

The date parent/carers were officially + notified.

+ ResolutionMeetingTime: + description:

The date and time at which a meeting with + the student’s parents/carers was held to + resolve the Suspension.

+ ResolutionNotes: + type: string + description:

Comments about how the Suspension has + been resolved, including any reparative + actions the student needs to take.

+ EarlyReturnDate: + type: string + format: date + description:

The date at which the student was + permitted to return to school earlier than + the agreed duration would have allowed.

+ Detention: + description:

Container for details of a Detention.

+ type: object + properties: + DetentionCategory: + type: string + title: Detention Category + description: >- +

Standard codes denoting the detention + category a Wellbeing Response belongs + to.

    +
  • 'B' - Before School
    • +
  • 'R' - Recess
    • +
  • 'MR' - Morning Recess
    • +
  • 'AR' - Afternoon Recess
    • +
  • 'A' - After School
    • +
  • 'L' - Lunch
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Before School + enum: + - B + - title: Recess + enum: + - R + - title: Morning Recess + enum: + - MR + - title: Afternoon Recess + enum: + - AR + - title: After School + enum: + - A + - title: Lunch + enum: + - L + - title: Other + enum: + - O + DetentionDate: + type: string + format: date + description:

The date of the detention.

+ DetentionLocation: + type: string + description:

Eventually to be typed for initial draft + will be string to try and determine a valid + code set.

+ DetentionNotes: + type: string + description:

Any notes that can be provided regarding + the need/response that led to the + detention.

+ PlanRequiredList: + description:

List of plans that are required to be + generated as part of the WellbeingResponse

+ type: object + required: + - Plan + properties: + Plan: + type: array + items: + description:

Repeatable Plan information.

+ type: object + properties: + PlanNotes: + type: string + description:

Any notes that can be provided + regarding the need that led to the + plan.

+ PlanDocument: + $ref: "#/paths/~1WellbeingResponses/get/res\ + ponses/200/content/application~1json/\ + schema/properties/WellbeingResponses/\ + properties/WellbeingResponse/items/pr\ + operties/Student" + Award: + description:

Container for details of an Award.

+ type: object + properties: + AwardDate: + type: string + format: date + description:

Date when to be awarded.

+ AwardType: + type: string + description:

Type of Award.

+ AwardDescription: + type: string + description:

Description of the Award.

+ AwardNotes: + type: string + description:

Any comments/notes associated with the + Award.

+ OtherResponse: + description:

Container for details of another type of + Response.

+ type: object + properties: + OtherResponseDate: + type: string + format: date + description:

Date of the other response

+ OtherResponseDescription: + type: string + description:

Description of the other response.

+ OtherResponseNotes: + type: string + description:

Any comments/notes associated with the + other response.

+ DocumentList: + description:

Describes the Location of any associated + documents kept in relation to this Response.

+ type: object + required: + - Document + properties: + Document: + type: array + items: + $ref: "#/paths/~1WellbeingResponses/get/respons\ + es/200/content/application~1json/schema/p\ + roperties/WellbeingResponses/properties/W\ + ellbeingResponse/items/properties/Student" + WellbeingAlert: + $ref: "#/paths/~1WellbeingResponses/get/responses/200\ + /content/application~1json/schema/properties/We\ + llbeingResponses/properties/WellbeingResponse/i\ + tems/properties/Student" + WellbeingEvent: + $ref: "#/paths/~1WellbeingResponses/get/responses/200\ + /content/application~1json/schema/properties/We\ + llbeingResponses/properties/WellbeingResponse/i\ + tems/properties/Student" + WellbeingAppealList: + description:

A list of any appeals that have been made in + relation to this Wellbeing Response.

+ type: object + required: + - WellbeingAppeal + properties: + WellbeingAppeal: + type: array + items: + $ref: "#/paths/~1WellbeingResponses/get/respons\ + es/200/content/application~1json/schema/p\ + roperties/WellbeingResponses/properties/W\ + ellbeingResponse/items/properties/Student" + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + WellbeingResponses: + WellbeingResponse: + - WellbeingResponseRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + PublishedDate: 2017-11-01 + StartDate: 2017-11-01 + EndDate: 2017-11-10 + ResponseCategory: S + ResponseNotes: This Student is to be withdrawn. + application/xml: + schema: + type: object + properties: + WellbeingResponses: + type: object + description: A List of WellbeingResponse objects + properties: + WellbeingResponse: + type: array + items: + $ref: "#/paths/~1WellbeingResponses/get/responses/200/con\ + tent/application~1json/schema/properties/WellbeingR\ + esponses/properties/WellbeingResponse/items" + example: >- + + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + 2017-11-01 + 2017-11-01 + 2017-11-10 + S + This Student is to be withdrawn. + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/WellbeingResponses/{WellbeingResponseRefId}": + post: + tags: + - WellbeingResponse + summary: Default operation to create a single WellbeingResponse + parameters: + - name: WellbeingResponseRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingResponse.

+ required: true + schema: + type: string + operationId: createWellbeingResponse + requestBody: + description: CRUD operation on WellbeingResponse + content: + application/json: + schema: + type: object + properties: + WellbeingResponse: + $ref: "#/paths/~1WellbeingResponses/get/responses/200/content/app\ + lication~1json/schema/properties/WellbeingResponses/propert\ + ies/WellbeingResponse/items" + example: + WellbeingResponse: + WellbeingResponseRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + PublishedDate: 2017-11-01 + StartDate: 2017-11-01 + EndDate: 2017-11-10 + ResponseCategory: S + ResponseNotes: This Student is to be withdrawn. + application/xml: + schema: + type: object + properties: + WellbeingResponse: + $ref: "#/paths/~1WellbeingResponses/get/responses/200/content/app\ + lication~1json/schema/properties/WellbeingResponses/propert\ + ies/WellbeingResponse/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + 2017-11-01 + 2017-11-01 + 2017-11-10 + S + This Student is to be withdrawn. + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - WellbeingResponse + summary: Default operation to update a single WellbeingResponse + parameters: + - name: WellbeingResponseRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingResponse.

+ required: true + schema: + type: string + operationId: updateWellbeingResponse + requestBody: + description: CRUD operation on WellbeingResponse + content: + application/json: + schema: + type: object + properties: + WellbeingResponse: + type: object + properties: + WellbeingResponseRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + WellbeingResponseLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1WellbeingResponses~1%7BWellbeingResponse\ + RefId%7D/put/requestBody/content/application~1json/\ + schema/properties/WellbeingResponse/properties/Well\ + beingResponseRefId" + LocalId: + $ref: "#/paths/~1WellbeingResponses~1%7BWellbeingResponse\ + RefId%7D/put/requestBody/content/application~1json/\ + schema/properties/WellbeingResponse/properties/Well\ + beingResponseLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1WellbeingResponses~1%7BWellbeingResponseRefI\ + d%7D/put/requestBody/content/application~1json/schema/p\ + roperties/WellbeingResponse/properties/Student" + PublishedDate: + type: string + format: date + description:

The calendar date on which this WellbeingResponse was + published.

+ StartDate: + type: string + format: date + description:

The date the WellbeingResponse period commenced.

+ EndDate: + type: string + format: date + description:

The date the WellbeingResponse is due to finish.

+ ResponseStatus: + type: string + title: Wellbeing Status + description: >- +

Standard codes denoting the status of the Wellbeing + Response.

    +
  • 'U' - Unresolved
    • +
  • 'R' - Resolved
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Unresolved + enum: + - U + - title: Resolved + enum: + - R + - title: Other + enum: + - O + ResponseCategory: + type: string + title: Wellbeing Response Category + description: >- +

Standard codes denoting the category a Wellbeing + Response belongs to.

    +
  • 'S' - Suspension
    • +
  • 'D' - Detention
    • +
  • 'A' - Award
    • +
  • 'P' - Plan Required
    • +
  • 'M' - Multiple Response
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Suspension + enum: + - S + - title: Detention + enum: + - D + - title: Award + enum: + - A + - title: Plan Required + enum: + - P + - title: Multiple Response + enum: + - M + - title: Other + enum: + - O + ResponseNotes: + type: string + description:

Text relating to the particular WellbeingResponse.

+ PersonInvolvementList: + description:

List of People involved in the Wellbeing + Event/Response. Mandatory if more people than the + student to which this event/response occurs is + involved.

+ type: object + properties: + PersonInvolvement: + type: array + items: + description:

A repeatable element recording the identifier + and details of another person that was involved in + the Wellbeing Event/Response.

+ type: object + properties: + HowInvolved: + type: string + description:

Optional free text detailing + involvement.

+ PersonType: + type: string + title: Person Involved Type + description: >- +

Code set denoting the type of person that + was involved.

    +
  • 'NONE' - None
    • +
  • 'OTHE' - Other
    • +
  • 'PEER' - Peers
    • +
  • 'STAF' - Staff
    • +
  • 'SUBS' - Substitute
    • +
  • 'TEAC' - Teacher
    • +
  • 'UNKN' - Unknown
    • +
+ oneOf: + - title: None + enum: + - NONE + - title: Other + enum: + - OTHE + - title: Peers + enum: + - PEER + - title: Staff + enum: + - STAF + - title: Substitute + enum: + - SUBS + - title: Teacher + enum: + - TEAC + - title: Unknown + enum: + - UNKN + Suspension: + description:

Container for details of a Suspension or + Expulsion.

+ type: object + properties: + SuspensionCategory: + type: string + title: Suspension Category + description: >- +

Standard codes denoting the suspension category a + Wellbeing Response belongs to.

    +
  • 'E' - Expulsion
    • +
  • 'WE' - Whole Exclusion
    • +
  • 'P' - Partial Exclusion
    • +
  • 'I' - In School
    • +
  • 'W' - Withdrawal
    • +
  • 'S' - Suspension
    • +
  • 'R' - Removal
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Expulsion + enum: + - E + - title: Whole Exclusion + enum: + - WE + - title: Partial Exclusion + enum: + - P + - title: In School + enum: + - I + - title: Withdrawal + enum: + - W + - title: Suspension + enum: + - S + - title: Removal + enum: + - R + - title: Other + enum: + - O + WithdrawalTimeList: + description:

Where a student is to be removed or withdrawn + partially for particular times in a week within the + Start and End dates of the Response.

+ type: object + properties: + Withdrawal: + type: array + items: + description:

Repeatable Withdrawal.

+ type: object + properties: + WithdrawalStartDate: + type: string + format: date + description:

The start date of the withdrawal.

+ WithdrawalEndDate: + type: string + format: date + description:

The end date of the withdrawal.

+ WithdrawalStartTime: + description:

Start time of the Withdrawal on that + day.

+ WithdrawalEndTime: + description:

End time of the Withdrawal on that + day.

+ SchoolTerm: + type: integer + description:

The school term the withdrawal took + place in.

+ WithdrawalFrom: + $ref: "#/paths/~1WellbeingResponses~1%7BWellbei\ + ngResponseRefId%7D/put/requestBody/conten\ + t/application~1json/schema/properties/Wel\ + lbeingResponse/properties/Student" + Duration: + description:

The duration of a Suspension in days 0.00 – X.xx. + (Half Day = 0.5, Full Day = 1.0 or the percentage of + any day.) Must be provided for a Suspension when + known.

+ AdvisementDate: + type: string + format: date + description:

The date parent/carers were officially + notified.

+ ResolutionMeetingTime: + description:

The date and time at which a meeting with the + student’s parents/carers was held to resolve the + Suspension.

+ ResolutionNotes: + type: string + description:

Comments about how the Suspension has been + resolved, including any reparative actions the + student needs to take.

+ EarlyReturnDate: + type: string + format: date + description:

The date at which the student was permitted to + return to school earlier than the agreed duration + would have allowed.

+ Detention: + description:

Container for details of a Detention.

+ type: object + properties: + DetentionCategory: + type: string + title: Detention Category + description: >- +

Standard codes denoting the detention category a + Wellbeing Response belongs to.

    +
  • 'B' - Before School
    • +
  • 'R' - Recess
    • +
  • 'MR' - Morning Recess
    • +
  • 'AR' - Afternoon Recess
    • +
  • 'A' - After School
    • +
  • 'L' - Lunch
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Before School + enum: + - B + - title: Recess + enum: + - R + - title: Morning Recess + enum: + - MR + - title: Afternoon Recess + enum: + - AR + - title: After School + enum: + - A + - title: Lunch + enum: + - L + - title: Other + enum: + - O + DetentionDate: + type: string + format: date + description:

The date of the detention.

+ DetentionLocation: + type: string + description:

Eventually to be typed for initial draft will be + string to try and determine a valid code set.

+ DetentionNotes: + type: string + description:

Any notes that can be provided regarding the + need/response that led to the detention.

+ PlanRequiredList: + description:

List of plans that are required to be generated as + part of the WellbeingResponse

+ type: object + properties: + Plan: + type: array + items: + description:

Repeatable Plan information.

+ type: object + properties: + PlanNotes: + type: string + description:

Any notes that can be provided regarding + the need that led to the plan.

+ PlanDocument: + $ref: "#/paths/~1WellbeingResponses~1%7BWellbeingRe\ + sponseRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/WellbeingRespon\ + se/properties/Student" + Award: + description:

Container for details of an Award.

+ type: object + properties: + AwardDate: + type: string + format: date + description:

Date when to be awarded.

+ AwardType: + type: string + description:

Type of Award.

+ AwardDescription: + type: string + description:

Description of the Award.

+ AwardNotes: + type: string + description:

Any comments/notes associated with the Award.

+ OtherResponse: + description:

Container for details of another type of Response.

+ type: object + properties: + OtherResponseDate: + type: string + format: date + description:

Date of the other response

+ OtherResponseDescription: + type: string + description:

Description of the other response.

+ OtherResponseNotes: + type: string + description:

Any comments/notes associated with the other + response.

+ DocumentList: + description:

Describes the Location of any associated documents + kept in relation to this Response.

+ type: object + properties: + Document: + type: array + items: + $ref: "#/paths/~1WellbeingResponses~1%7BWellbeingRespon\ + seRefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/WellbeingResponse/propertie\ + s/Student" + WellbeingAlert: + $ref: "#/paths/~1WellbeingResponses~1%7BWellbeingResponseRefI\ + d%7D/put/requestBody/content/application~1json/schema/p\ + roperties/WellbeingResponse/properties/Student" + WellbeingEvent: + $ref: "#/paths/~1WellbeingResponses~1%7BWellbeingResponseRefI\ + d%7D/put/requestBody/content/application~1json/schema/p\ + roperties/WellbeingResponse/properties/Student" + WellbeingAppealList: + description:

A list of any appeals that have been made in relation + to this Wellbeing Response.

+ type: object + properties: + WellbeingAppeal: + type: array + items: + $ref: "#/paths/~1WellbeingResponses~1%7BWellbeingRespon\ + seRefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/WellbeingResponse/propertie\ + s/Student" + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + WellbeingResponse: + WellbeingResponseRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + PublishedDate: 2017-11-01 + StartDate: 2017-11-01 + EndDate: 2017-11-10 + ResponseCategory: S + ResponseNotes: This Student is to be withdrawn. + application/xml: + schema: + type: object + properties: + WellbeingResponse: + $ref: "#/paths/~1WellbeingResponses~1%7BWellbeingResponseRefId%7D\ + /put/requestBody/content/application~1json/schema/propertie\ + s/WellbeingResponse" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + 2017-11-01 + 2017-11-01 + 2017-11-10 + S + This Student is to be withdrawn. + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - WellbeingResponse + summary: Default operation to get a single WellbeingResponse + parameters: + - name: WellbeingResponseRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingResponse.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + WellbeingResponse: + $ref: "#/paths/~1WellbeingResponses/get/responses/200/content/a\ + pplication~1json/schema/properties/WellbeingResponses/pro\ + perties/WellbeingResponse/items" + example: + WellbeingResponse: + WellbeingResponseRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + PublishedDate: 2017-11-01 + StartDate: 2017-11-01 + EndDate: 2017-11-10 + ResponseCategory: S + ResponseNotes: This Student is to be withdrawn. + application/xml: + schema: + type: object + properties: + WellbeingResponse: + $ref: "#/paths/~1WellbeingResponses/get/responses/200/content/a\ + pplication~1json/schema/properties/WellbeingResponses/pro\ + perties/WellbeingResponse/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + 2017-11-01 + 2017-11-01 + 2017-11-10 + S + This Student is to be withdrawn. + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - WellbeingResponse + summary: Default operation to delete a single WellbeingResponse + parameters: + - name: WellbeingResponseRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingResponse.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /WellbeingAppeals: + get: + tags: + - WellbeingAppeal + summary: Default operation to get a list of all available WellbeingAppeals + description: Search the set of available WellbeingAppeals, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + WellbeingAppeals: + type: object + description: A List of WellbeingAppeal objects + properties: + WellbeingAppeal: + type: array + items: + required: + - Provider + - Student + - WellbeingResponse + type: object + properties: + WellbeingAppealRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + WellbeingAppealLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1WellbeingAppeals/get/responses/2\ + 00/content/application~1json/schema/propert\ + ies/WellbeingAppeals/properties/WellbeingAp\ + peal/items/properties/WellbeingAppealRefId" + LocalId: + $ref: "#/paths/~1WellbeingAppeals/get/responses/2\ + 00/content/application~1json/schema/propert\ + ies/WellbeingAppeals/properties/WellbeingAp\ + peal/items/properties/WellbeingAppealLocalI\ + d" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1WellbeingAppeals/get/responses/200/c\ + ontent/application~1json/schema/properties/Well\ + beingAppeals/properties/WellbeingAppeal/items/p\ + roperties/Student" + WellbeingResponse: + $ref: "#/paths/~1WellbeingAppeals/get/responses/200/c\ + ontent/application~1json/schema/properties/Well\ + beingAppeals/properties/WellbeingAppeal/items/p\ + roperties/Student" + WellbeingAlert: + $ref: "#/paths/~1WellbeingAppeals/get/responses/200/c\ + ontent/application~1json/schema/properties/Well\ + beingAppeals/properties/WellbeingAppeal/items/p\ + roperties/Student" + AppealStatus: + type: string + title: Wellbeing Appeal Status + description: >- +

Standard codes denoting the status of the + Wellbeing Appeal.

    +
  • 'IP' - In Progress
    • +
  • 'NS' - Not Specified
    • +
  • 'RE' - Rejected
    • +
  • 'SU' - Successful
    • +
+ oneOf: + - title: In Progress + enum: + - IP + - title: Not Specified + enum: + - NS + - title: Rejected + enum: + - RE + - title: Successful + enum: + - SU + RegisteredDate: + type: string + format: date + description:

The calendar date on which this + WellbeingAppeal was registered.

+ AppealNotes: + type: string + description:

Text relating to the particular + WellbeingAppeal.

+ AppealOutcome: + type: string + title: Wellbeing Appeal Outcome + description: >- +

Code set denoting the outcome of a wellbeing + appeal.

    +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Other + enum: + - OTH + AppealDeterminationBy: + type: string + title: Appeal Determination By + description: >- +

Code set denoting the type of individual or + group that determined the appeal outcome.

+
    +
  • 'BOT' - Board of Trustees
    • +
  • 'PRI' - Principal
    • +
  • 'DEP' - Deputy Principal
    • +
  • 'YEA' - Year Level Dean
    • +
  • 'HOM' - Home Room Teacher
    • +
  • 'MOE' - Ministry of Education
    • +
+ oneOf: + - title: Board of Trustees + enum: + - BOT + - title: Principal + enum: + - PRI + - title: Deputy Principal + enum: + - DEP + - title: Year Level Dean + enum: + - YEA + - title: Home Room Teacher + enum: + - HOM + - title: Ministry of Education + enum: + - MOE + DocumentList: + description:

Describes the Location of any associated + documents kept in relation to this Appeal.

+ type: object + required: + - Document + properties: + Document: + type: array + items: + $ref: "#/paths/~1WellbeingAppeals/get/responses\ + /200/content/application~1json/schema/pro\ + perties/WellbeingAppeals/properties/Wellb\ + eingAppeal/items/properties/Student" + description:

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.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + example: + WellbeingAppeals: + WellbeingAppeal: + - WellbeingAppealRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + WellbeingResponse: + RefId: BC385746-359D-7510-1A8C-36432A901A36 + AppealStatus: SU + RegisteredDate: 2017-11-01 + AppealNotes: This Appeal was successful. + application/xml: + schema: + type: object + properties: + WellbeingAppeals: + type: object + description: A List of WellbeingAppeal objects + properties: + WellbeingAppeal: + type: array + items: + $ref: "#/paths/~1WellbeingAppeals/get/responses/200/conte\ + nt/application~1json/schema/properties/WellbeingApp\ + eals/properties/WellbeingAppeal/items" + example: >- + + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + + BC385746-359D-7510-1A8C-36432A901A36 + + SU + 2017-11-01 + This Appeal was successful. + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/WellbeingAppeals/{WellbeingAppealRefId}": + post: + tags: + - WellbeingAppeal + summary: Default operation to create a single WellbeingAppeal + parameters: + - name: WellbeingAppealRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingAppeal.

+ required: true + schema: + type: string + operationId: createWellbeingAppeal + requestBody: + description: CRUD operation on WellbeingAppeal + content: + application/json: + schema: + type: object + properties: + WellbeingAppeal: + $ref: "#/paths/~1WellbeingAppeals/get/responses/200/content/appli\ + cation~1json/schema/properties/WellbeingAppeals/properties/\ + WellbeingAppeal/items" + example: + WellbeingAppeal: + WellbeingAppealRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + WellbeingResponse: + RefId: BC385746-359D-7510-1A8C-36432A901A36 + AppealStatus: SU + RegisteredDate: 2017-11-01 + AppealNotes: This Appeal was successful. + application/xml: + schema: + type: object + properties: + WellbeingAppeal: + $ref: "#/paths/~1WellbeingAppeals/get/responses/200/content/appli\ + cation~1json/schema/properties/WellbeingAppeals/properties/\ + WellbeingAppeal/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + + BC385746-359D-7510-1A8C-36432A901A36 + + SU + 2017-11-01 + This Appeal was successful. + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - WellbeingAppeal + summary: Default operation to update a single WellbeingAppeal + parameters: + - name: WellbeingAppealRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingAppeal.

+ required: true + schema: + type: string + operationId: updateWellbeingAppeal + requestBody: + description: CRUD operation on WellbeingAppeal + content: + application/json: + schema: + type: object + properties: + WellbeingAppeal: + type: object + properties: + WellbeingAppealRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + WellbeingAppealLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1WellbeingAppeals~1%7BWellbeingAppealRefI\ + d%7D/put/requestBody/content/application~1json/sche\ + ma/properties/WellbeingAppeal/properties/WellbeingA\ + ppealRefId" + LocalId: + $ref: "#/paths/~1WellbeingAppeals~1%7BWellbeingAppealRefI\ + d%7D/put/requestBody/content/application~1json/sche\ + ma/properties/WellbeingAppeal/properties/WellbeingA\ + ppealLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1WellbeingAppeals~1%7BWellbeingAppealRefId%7D\ + /put/requestBody/content/application~1json/schema/prope\ + rties/WellbeingAppeal/properties/Student" + WellbeingResponse: + $ref: "#/paths/~1WellbeingAppeals~1%7BWellbeingAppealRefId%7D\ + /put/requestBody/content/application~1json/schema/prope\ + rties/WellbeingAppeal/properties/Student" + WellbeingAlert: + $ref: "#/paths/~1WellbeingAppeals~1%7BWellbeingAppealRefId%7D\ + /put/requestBody/content/application~1json/schema/prope\ + rties/WellbeingAppeal/properties/Student" + AppealStatus: + type: string + title: Wellbeing Appeal Status + description: >- +

Standard codes denoting the status of the Wellbeing + Appeal.

    +
  • 'IP' - In Progress
    • +
  • 'NS' - Not Specified
    • +
  • 'RE' - Rejected
    • +
  • 'SU' - Successful
    • +
+ oneOf: + - title: In Progress + enum: + - IP + - title: Not Specified + enum: + - NS + - title: Rejected + enum: + - RE + - title: Successful + enum: + - SU + RegisteredDate: + type: string + format: date + description:

The calendar date on which this WellbeingAppeal was + registered.

+ AppealNotes: + type: string + description:

Text relating to the particular WellbeingAppeal.

+ AppealOutcome: + type: string + title: Wellbeing Appeal Outcome + description: >- +

Code set denoting the outcome of a wellbeing + appeal.

    +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Other + enum: + - OTH + AppealDeterminationBy: + type: string + title: Appeal Determination By + description: >- +

Code set denoting the type of individual or group + that determined the appeal outcome.

    +
  • 'BOT' - Board of Trustees
    • +
  • 'PRI' - Principal
    • +
  • 'DEP' - Deputy Principal
    • +
  • 'YEA' - Year Level Dean
    • +
  • 'HOM' - Home Room Teacher
    • +
  • 'MOE' - Ministry of Education
    • +
+ oneOf: + - title: Board of Trustees + enum: + - BOT + - title: Principal + enum: + - PRI + - title: Deputy Principal + enum: + - DEP + - title: Year Level Dean + enum: + - YEA + - title: Home Room Teacher + enum: + - HOM + - title: Ministry of Education + enum: + - MOE + DocumentList: + description:

Describes the Location of any associated documents + kept in relation to this Appeal.

+ type: object + properties: + Document: + type: array + items: + $ref: "#/paths/~1WellbeingAppeals~1%7BWellbeingAppealRe\ + fId%7D/put/requestBody/content/application~1json/\ + schema/properties/WellbeingAppeal/properties/Stud\ + ent" + description:

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.

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + example: + WellbeingAppeal: + WellbeingAppealRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + WellbeingResponse: + RefId: BC385746-359D-7510-1A8C-36432A901A36 + AppealStatus: SU + RegisteredDate: 2017-11-01 + AppealNotes: This Appeal was successful. + application/xml: + schema: + type: object + properties: + WellbeingAppeal: + $ref: "#/paths/~1WellbeingAppeals~1%7BWellbeingAppealRefId%7D/put\ + /requestBody/content/application~1json/schema/properties/We\ + llbeingAppeal" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + + BC385746-359D-7510-1A8C-36432A901A36 + + SU + 2017-11-01 + This Appeal was successful. + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - WellbeingAppeal + summary: Default operation to get a single WellbeingAppeal + parameters: + - name: WellbeingAppealRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingAppeal.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + WellbeingAppeal: + $ref: "#/paths/~1WellbeingAppeals/get/responses/200/content/app\ + lication~1json/schema/properties/WellbeingAppeals/propert\ + ies/WellbeingAppeal/items" + example: + WellbeingAppeal: + WellbeingAppealRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: D3E34B35-9D75-101A-8C3D-00AA001A1652 + Provider: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + WellbeingResponse: + RefId: BC385746-359D-7510-1A8C-36432A901A36 + AppealStatus: SU + RegisteredDate: 2017-11-01 + AppealNotes: This Appeal was successful. + application/xml: + schema: + type: object + properties: + WellbeingAppeal: + $ref: "#/paths/~1WellbeingAppeals/get/responses/200/content/app\ + lication~1json/schema/properties/WellbeingAppeals/propert\ + ies/WellbeingAppeal/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + D3E34B35-9D75-101A-8C3D-00AA001A1652 + + + CA285746-359D-7510-1A8C-36432A901A16 + + + BC385746-359D-7510-1A8C-36432A901A36 + + SU + 2017-11-01 + This Appeal was successful. + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - WellbeingAppeal + summary: Default operation to delete a single WellbeingAppeal + parameters: + - name: WellbeingAppealRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this + WellbeingAppeal.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentActivityParticipations: + get: + tags: + - StudentActivityParticipation + summary: Default operation to get a list of all available + StudentActivityParticipations + description: Search the set of available StudentActivityParticipations, according to + the search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentActivityParticipations: + type: object + description: A List of StudentActivityParticipation objects + properties: + StudentActivityParticipation: + type: array + items: + required: + - ActivityName + - Provider + - StartDate + - Student + type: object + properties: + StudentActivityParticipationRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentActivityParticipationLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentActivityParticipations/ge\ + t/responses/200/content/application~1json/s\ + chema/properties/StudentActivityParticipati\ + ons/properties/StudentActivityParticipation\ + /items/properties/StudentActivityParticipat\ + ionRefId" + LocalId: + $ref: "#/paths/~1StudentActivityParticipations/ge\ + t/responses/200/content/application~1json/s\ + chema/properties/StudentActivityParticipati\ + ons/properties/StudentActivityParticipation\ + /items/properties/StudentActivityParticipat\ + ionLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentActivityParticipations/get/re\ + sponses/200/content/application~1json/schema/pr\ + operties/StudentActivityParticipations/properti\ + es/StudentActivityParticipation/items/propertie\ + s/Student" + ActivityGroup: + type: string + title: Student Activity Group + description: >- +

Standard codes denoting the group of the + activity the student is participating in, e.g. + sport, art, cultural, music.

    +
  • 'SPO' - Sport
    • +
  • 'ART' - Art
    • +
  • 'CUL' - Cultural
    • +
  • 'MUS' - Music
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Sport + enum: + - SPO + - title: Art + enum: + - ART + - title: Cultural + enum: + - CUL + - title: Music + enum: + - MUS + - title: Other + enum: + - OTH + ActivityType: + type: string + title: Student Activity Type + description: >- +

Standard codes denoting the type of activity + the student is participating in, e.g. rugby, + drama, Kapa Haka, Violin.

    +
  • 'NET' - Netball
    • +
  • 'RUG' - Rugby
    • +
  • 'CRI' - Cricket
    • +
  • 'DRA' - Drama
    • +
  • 'DEB' - Debate
    • +
  • 'TER' - Te Reo
    • +
  • 'KAP' - Kapa Haka
    • +
  • 'GUI' - Guitar
    • +
  • 'VIO' - Violin
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Netball + enum: + - NET + - title: Rugby + enum: + - RUG + - title: Cricket + enum: + - CRI + - title: Drama + enum: + - DRA + - title: Debate + enum: + - DEB + - title: Te Reo + enum: + - TER + - title: Kapa Haka + enum: + - KAP + - title: Guitar + enum: + - GUI + - title: Violin + enum: + - VIO + - title: Other + enum: + - OTH + ActivityName: + type: string + description:

The name of the activity the student + participated in.

+ LearningArea: + type: string + title: Learning Area + description: >- +

Codes denoting Learning Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'HPE' - Health and Physical Education / Hauora
    • +
  • 'LAL' - Language and Languages / Ngā Reo
    • +
  • 'MAT' - Mathematics / Pangarau
    • +
  • 'SCI' - Science / Putaiao
    • +
  • 'SSC' - Social Sciences / Tikanga-a-iwi
    • +
  • 'TEC' - Technology / Hangarau
    • +
  • 'ART' - The Arts / Ngā Toi
    • +
  • 'TRP' - Te Reo Pākehā / English Language
    • +
  • 'TRM' - Te Reo Māori / Māori Language and Literature
    • +
+ oneOf: + - title: Health and Physical Education / Hauora + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - HPE + - title: Language and Languages / Ngā Reo + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - LAL + - title: Mathematics / Pangarau + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - MAT + - title: Science / Putaiao + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - SCI + - title: Social Sciences / Tikanga-a-iwi + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - SSC + - title: Technology / Hangarau + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - TEC + - title: The Arts / Ngā Toi + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - ART + - title: Te Reo Pākehā / English Language + description: Applicable to Te Marautanga o Aotearoa. + enum: + - TRP + - title: Te Reo Māori / Māori Language and Literature + description: Applicable to Te Marautanga o Aotearoa. + enum: + - TRM + ParticipationComment: + type: string + description:

Comment related to the student's + participation in the activity.

+ StartDate: + type: string + format: date + description:

This is the date from which the activity + participation is valid (inclusive).

+ EndDate: + type: string + format: date + description:

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.

+ Role: + type: string + description:

Specific role the student plays in the + activity (e.g., band leader, student body + president).

+ RecognitionList: + description:

List of awards and other types of recognition + given to the student for this activity.

+ type: object + required: + - Recognition + properties: + Recognition: + type: array + items: + type: string + description: This object provides information on a co-curricular + or extra-curricular activity in which a student + participates during a given school year. + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + example: + StudentActivityParticipations: + StudentActivityParticipation: + - StudentActivityParticipationRefId: 9ECC9683-0E02-406F-926C-1C4D3542D122 + Student: + RefId: 646C5D4A-C829-4886-A02B-971695C7BC06 + Provider: + RefId: 33d610cd-40d3-44db-b21b-3cffe695503a + 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 + application/xml: + schema: + type: object + properties: + StudentActivityParticipations: + type: object + description: A List of StudentActivityParticipation objects + properties: + StudentActivityParticipation: + type: array + items: + $ref: "#/paths/~1StudentActivityParticipations/get/respon\ + ses/200/content/application~1json/schema/properties\ + /StudentActivityParticipations/properties/StudentAc\ + tivityParticipation/items" + example: >- + + + 9ECC9683-0E02-406F-926C-1C4D3542D122 + + 646C5D4A-C829-4886-A02B-971695C7BC06 + + + 33d610cd-40d3-44db-b21b-3cffe695503a + + SPO + CRI + First XI + First year of participation + 2008-09-01 + Team Member + + Player of the Day + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentActivityParticipations/{StudentActivityParticipationRefId}": + post: + tags: + - StudentActivityParticipation + summary: Default operation to create a single StudentActivityParticipation + parameters: + - name: StudentActivityParticipationRefId + in: path + description: The ID (GUID) that uniquely identifies the instance of the object. + required: true + schema: + type: string + operationId: createStudentActivityParticipation + requestBody: + description: CRUD operation on StudentActivityParticipation + content: + application/json: + schema: + type: object + properties: + StudentActivityParticipation: + $ref: "#/paths/~1StudentActivityParticipations/get/responses/200/\ + content/application~1json/schema/properties/StudentActivity\ + Participations/properties/StudentActivityParticipation/item\ + s" + example: + StudentActivityParticipation: + StudentActivityParticipationRefId: 9ECC9683-0E02-406F-926C-1C4D3542D122 + Student: + RefId: 646C5D4A-C829-4886-A02B-971695C7BC06 + Provider: + RefId: 33d610cd-40d3-44db-b21b-3cffe695503a + 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 + application/xml: + schema: + type: object + properties: + StudentActivityParticipation: + $ref: "#/paths/~1StudentActivityParticipations/get/responses/200/\ + content/application~1json/schema/properties/StudentActivity\ + Participations/properties/StudentActivityParticipation/item\ + s" + example: >- + + 9ECC9683-0E02-406F-926C-1C4D3542D122 + + 646C5D4A-C829-4886-A02B-971695C7BC06 + + + 33d610cd-40d3-44db-b21b-3cffe695503a + + SPO + CRI + First XI + First year of participation + 2008-09-01 + Team Member + + Player of the Day + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentActivityParticipation + summary: Default operation to update a single StudentActivityParticipation + parameters: + - name: StudentActivityParticipationRefId + in: path + description: The ID (GUID) that uniquely identifies the instance of the object. + required: true + schema: + type: string + operationId: updateStudentActivityParticipation + requestBody: + description: CRUD operation on StudentActivityParticipation + content: + application/json: + schema: + type: object + properties: + StudentActivityParticipation: + type: object + properties: + StudentActivityParticipationRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentActivityParticipationLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentActivityParticipations~1%7BStuden\ + tActivityParticipationRefId%7D/put/requestBody/cont\ + ent/application~1json/schema/properties/StudentActi\ + vityParticipation/properties/StudentActivityPartici\ + pationRefId" + LocalId: + $ref: "#/paths/~1StudentActivityParticipations~1%7BStuden\ + tActivityParticipationRefId%7D/put/requestBody/cont\ + ent/application~1json/schema/properties/StudentActi\ + vityParticipation/properties/StudentActivityPartici\ + pationLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentActivityParticipations~1%7BStudentAct\ + ivityParticipationRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/StudentActivityParticip\ + ation/properties/Student" + ActivityGroup: + type: string + title: Student Activity Group + description: >- +

Standard codes denoting the group of the activity the + student is participating in, e.g. sport, art, cultural, + music.

    +
  • 'SPO' - Sport
    • +
  • 'ART' - Art
    • +
  • 'CUL' - Cultural
    • +
  • 'MUS' - Music
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Sport + enum: + - SPO + - title: Art + enum: + - ART + - title: Cultural + enum: + - CUL + - title: Music + enum: + - MUS + - title: Other + enum: + - OTH + ActivityType: + type: string + title: Student Activity Type + description: >- +

Standard codes denoting the type of activity the + student is participating in, e.g. rugby, drama, Kapa + Haka, Violin.

    +
  • 'NET' - Netball
    • +
  • 'RUG' - Rugby
    • +
  • 'CRI' - Cricket
    • +
  • 'DRA' - Drama
    • +
  • 'DEB' - Debate
    • +
  • 'TER' - Te Reo
    • +
  • 'KAP' - Kapa Haka
    • +
  • 'GUI' - Guitar
    • +
  • 'VIO' - Violin
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Netball + enum: + - NET + - title: Rugby + enum: + - RUG + - title: Cricket + enum: + - CRI + - title: Drama + enum: + - DRA + - title: Debate + enum: + - DEB + - title: Te Reo + enum: + - TER + - title: Kapa Haka + enum: + - KAP + - title: Guitar + enum: + - GUI + - title: Violin + enum: + - VIO + - title: Other + enum: + - OTH + ActivityName: + type: string + description:

The name of the activity the student participated + in.

+ LearningArea: + type: string + title: Learning Area + description: >- +

Codes denoting Learning Areas defined by the NZ + Curriculum and Te Marautanga o Aotearoa.

    +
  • 'HPE' - Health and Physical Education / Hauora
    • +
  • 'LAL' - Language and Languages / Ngā Reo
    • +
  • 'MAT' - Mathematics / Pangarau
    • +
  • 'SCI' - Science / Putaiao
    • +
  • 'SSC' - Social Sciences / Tikanga-a-iwi
    • +
  • 'TEC' - Technology / Hangarau
    • +
  • 'ART' - The Arts / Ngā Toi
    • +
  • 'TRP' - Te Reo Pākehā / English Language
    • +
  • 'TRM' - Te Reo Māori / Māori Language and Literature
    • +
+ oneOf: + - title: Health and Physical Education / Hauora + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - HPE + - title: Language and Languages / Ngā Reo + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - LAL + - title: Mathematics / Pangarau + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - MAT + - title: Science / Putaiao + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - SCI + - title: Social Sciences / Tikanga-a-iwi + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - SSC + - title: Technology / Hangarau + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - TEC + - title: The Arts / Ngā Toi + description: Applicable to both the NZ Curriculum and Te + Marautanga o Aotearoa. + enum: + - ART + - title: Te Reo Pākehā / English Language + description: Applicable to Te Marautanga o Aotearoa. + enum: + - TRP + - title: Te Reo Māori / Māori Language and Literature + description: Applicable to Te Marautanga o Aotearoa. + enum: + - TRM + ParticipationComment: + type: string + description:

Comment related to the student's participation in the + activity.

+ StartDate: + type: string + format: date + description:

This is the date from which the activity + participation is valid (inclusive).

+ EndDate: + type: string + format: date + description:

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.

+ Role: + type: string + description:

Specific role the student plays in the activity + (e.g., band leader, student body president).

+ RecognitionList: + description:

List of awards and other types of recognition given + to the student for this activity.

+ type: object + properties: + Recognition: + type: array + items: + type: string + description: This object provides information on a co-curricular or + extra-curricular activity in which a student participates + during a given school year. + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + example: + StudentActivityParticipation: + StudentActivityParticipationRefId: 9ECC9683-0E02-406F-926C-1C4D3542D122 + Student: + RefId: 646C5D4A-C829-4886-A02B-971695C7BC06 + Provider: + RefId: 33d610cd-40d3-44db-b21b-3cffe695503a + 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 + application/xml: + schema: + type: object + properties: + StudentActivityParticipation: + $ref: "#/paths/~1StudentActivityParticipations~1%7BStudentActivit\ + yParticipationRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/StudentActivityParticipation" + example: >- + + 9ECC9683-0E02-406F-926C-1C4D3542D122 + + 646C5D4A-C829-4886-A02B-971695C7BC06 + + + 33d610cd-40d3-44db-b21b-3cffe695503a + + SPO + CRI + First XI + First year of participation + 2008-09-01 + Team Member + + Player of the Day + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentActivityParticipation + summary: Default operation to get a single StudentActivityParticipation + parameters: + - name: StudentActivityParticipationRefId + in: path + description: The ID (GUID) that uniquely identifies the instance of the object. + required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentActivityParticipation: + $ref: "#/paths/~1StudentActivityParticipations/get/responses/20\ + 0/content/application~1json/schema/properties/StudentActi\ + vityParticipations/properties/StudentActivityParticipatio\ + n/items" + example: + StudentActivityParticipation: + StudentActivityParticipationRefId: 9ECC9683-0E02-406F-926C-1C4D3542D122 + Student: + RefId: 646C5D4A-C829-4886-A02B-971695C7BC06 + Provider: + RefId: 33d610cd-40d3-44db-b21b-3cffe695503a + 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 + application/xml: + schema: + type: object + properties: + StudentActivityParticipation: + $ref: "#/paths/~1StudentActivityParticipations/get/responses/20\ + 0/content/application~1json/schema/properties/StudentActi\ + vityParticipations/properties/StudentActivityParticipatio\ + n/items" + example: >- + + 9ECC9683-0E02-406F-926C-1C4D3542D122 + + 646C5D4A-C829-4886-A02B-971695C7BC06 + + + 33d610cd-40d3-44db-b21b-3cffe695503a + + SPO + CRI + First XI + First year of participation + 2008-09-01 + Team Member + + Player of the Day + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentActivityParticipation + summary: Default operation to delete a single StudentActivityParticipation + parameters: + - name: StudentActivityParticipationRefId + in: path + description: The ID (GUID) that uniquely identifies the instance of the object. + required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentPhysicalRestraints: + get: + tags: + - StudentPhysicalRestraint + summary: Default operation to get a list of all available + StudentPhysicalRestraints + description: Search the set of available StudentPhysicalRestraint reports, according + to the search criteria in the URL parameters. Returns the first 20 + objects located; with SIF defined navigation headers, indicating how to + retrieve subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentPhysicalRestraints: + type: object + description: A List of StudentPhysicalRestraint objects + properties: + StudentPhysicalRestraint: + type: array + items: + required: + - Provider + - Student + type: object + properties: + StudentPhysicalRestraintRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentPhysicalRestraintLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentPhysicalRestraints/get/re\ + sponses/200/content/application~1json/schem\ + a/properties/StudentPhysicalRestraints/prop\ + erties/StudentPhysicalRestraint/items/prope\ + rties/StudentPhysicalRestraintRefId" + LocalId: + $ref: "#/paths/~1StudentPhysicalRestraints/get/re\ + sponses/200/content/application~1json/schem\ + a/properties/StudentPhysicalRestraints/prop\ + erties/StudentPhysicalRestraint/items/prope\ + rties/StudentPhysicalRestraintLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Student: + $ref: "#/paths/~1StudentPhysicalRestraints/get/respon\ + ses/200/content/application~1json/schema/proper\ + ties/StudentPhysicalRestraints/properties/Stude\ + ntPhysicalRestraint/items/properties/Provider" + PrincipalOrDelegate: + $ref: "#/paths/~1StudentPhysicalRestraints/get/respon\ + ses/200/content/application~1json/schema/proper\ + ties/StudentPhysicalRestraints/properties/Stude\ + ntPhysicalRestraint/items/properties/Provider" + WellbeingEvent: + $ref: "#/paths/~1StudentPhysicalRestraints/get/respon\ + ses/200/content/application~1json/schema/proper\ + ties/StudentPhysicalRestraints/properties/Stude\ + ntPhysicalRestraint/items/properties/Provider" + ConsideredNecessaryReason: + type: string + description:

Free text description on why the physical + restraint of the student was considered + necessary.

+ FirstTimeStudentRestrained: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + IncidentDate: + type: string + format: date + description:

The date the physical restraint was used on + the student.

+ LocationDescription: + type: string + description:

Free text description of the location the + physical restraint of the student occurred + in.

+ OtherComment: + type: string + description:

Any other comments on the physical restraint + incident.

+ ReportedDate: + type: string + format: date + description:

The date the use of physical restraint on the + student was report.

+ RestraintEndedTime: + description:

The time the physical restraint stopped being + used.

+ RestraintStartedTime: + description:

The time the physical restraint started being + used.

+ RestraintReason: + type: string + title: Restraint Reason + description: >- +

A code set denoting the reason physical + restraint was used on the student.

    +
  • 'SER' - Serious and imminent risk to safety
    • +
  • 'ACT' - Actual injury
    • +
+ oneOf: + - title: Serious and imminent risk to safety + enum: + - SER + - title: Actual injury + enum: + - ACT + StudentYearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid + for describing Funding Year Level and Current + Year Level for a student enrolment.

+

Current Year Level indicates the year level + of the student’s class cohort and the level at + which the student spends most of their time at + school. While a student may be enrolled in + subjects at varying instructional year levels, + in relation to the student enrolment this value + represents the year level at which the student + is considered to be predominantly taught.

+

Funding Year Level measures the actual number + of years that the student has attended a school. + It provides the Ministry with a method of + counting students for funding purposes which is + independent of the way schools are organised or + the particular programme of study that a student + may undertake. Funding Year Level for most + students is based on the date they first started + school.

School Year Level is used to + indicate the instructional year levels offered + by a school, i.e. those years for which student + enrolments may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates + Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + DocumentList: + description:

Describes the Location of any associated + documents kept in relation to this physical + restraint incident.

+ type: object + required: + - Document + properties: + Document: + type: array + items: + $ref: "#/paths/~1StudentPhysicalRestraints/get/\ + responses/200/content/application~1json/s\ + chema/properties/StudentPhysicalRestraint\ + s/properties/StudentPhysicalRestraint/ite\ + ms/properties/Provider" + RestraintWitnessList: + description:

A list of the people that witnessed the + physical constraint.

+ type: object + required: + - Witness + properties: + Witness: + type: array + items: + $ref: "#/paths/~1StudentPhysicalRestraints/get/\ + responses/200/content/application~1json/s\ + chema/properties/StudentPhysicalRestraint\ + s/properties/StudentPhysicalRestraint/ite\ + ms/properties/Provider" + RestraintAdministeredByList: + description:

A list of the people who administered the + physical restraint to the student.

+ type: object + required: + - RestraintAdministeredBy + properties: + RestraintAdministeredBy: + type: array + items: + description:

The person who administered the + physical restraint to the student.

+ type: object + properties: + AdministeredBy: + $ref: "#/paths/~1StudentPhysicalRestraints/\ + get/responses/200/content/application\ + ~1json/schema/properties/StudentPhysi\ + calRestraints/properties/StudentPhysi\ + calRestraint/items/properties/Provide\ + r" + SafePhysicalRestraintTraining: + $ref: "#/paths/~1StudentPhysicalRestraints/\ + get/responses/200/content/application\ + ~1json/schema/properties/StudentPhysi\ + calRestraints/properties/StudentPhysi\ + calRestraint/items/properties/FirstTi\ + meStudentRestrained" + TrainingDescription: + type: string + description:

Free text providing additional + information about any training the + person has had on the safe use pf + physical restraint.

+ Role: + type: string + title: Restraint Administered By Role + description: >- +

Code set denoting the role of the + person who administered the physical + restraint to the student.

    +
  • 'T' - Teacher
    • +
  • 'P' - Principal
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Teacher + enum: + - T + - title: Principal + enum: + - P + - title: Other + enum: + - O + BehaviourDirectedAtList: + description:

The list of the people and/or property that + the student, who was restrained, was directing + their behaviour at.

+ type: object + required: + - BehaviourDirectedAt + properties: + BehaviourDirectedAt: + type: array + items: + description:

The person and/or piece of property + that the student, who was restrained, was + directing their behaviour at.

+ type: object + properties: + DirectedAt: + $ref: "#/paths/~1StudentPhysicalRestraints/\ + get/responses/200/content/application\ + ~1json/schema/properties/StudentPhysi\ + calRestraints/properties/StudentPhysi\ + calRestraint/items/properties/Provide\ + r" + BehaviourDescription: + type: string + description:

Free text describing the behaviour + the student showed towards a person of + piece of property.

+ DirectedAtType: + type: string + title: Behaviour Directed At Type + description: >- +

Code set denoting type of object or + person the student was directing their + behaviour at, e.g. Staff Member, + Student, Desk, Chair.

    +
  • 'STA' - Staff
    • +
  • 'STU' - Student
    • +
  • 'PRO' - Property
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Staff + enum: + - STA + - title: Student + enum: + - STU + - title: Property + enum: + - PRO + - title: Other + enum: + - OTH + StaffReflectionList: + description:

A list of the reflections made by the staff + members who applied the physical restraint.

+ type: object + required: + - StaffReflection + properties: + StaffReflection: + type: array + items: + description:

The reflections performed by the staff + member who applied the physical restraint + to the student.

+ type: object + properties: + ReflectionDate: + type: string + format: date + description:

The date the staff member performed + their reflection on the use of + physical restraint on the student.

+ WitnessedBy: + $ref: "#/paths/~1StudentPhysicalRestraints/\ + get/responses/200/content/application\ + ~1json/schema/properties/StudentPhysi\ + calRestraints/properties/StudentPhysi\ + calRestraint/items/properties/Provide\ + r" + Staff: + $ref: "#/paths/~1StudentPhysicalRestraints/\ + get/responses/200/content/application\ + ~1json/schema/properties/StudentPhysi\ + calRestraints/properties/StudentPhysi\ + calRestraint/items/properties/Provide\ + r" + ReflectionList: + description:

A list of the reflections the staff + member performed.

+ type: object + required: + - Reflection + properties: + Reflection: + type: array + items: + description:

A reflection that a staff + member performed about the + physical restraint incident.

+ type: object + properties: + ReflectionDescription: + type: string + description:

Free text outlining the + staff members thoughts on a + type of reflection.

+ Type: + type: string + title: Staff Restraint Reflection + Type + description: >- +

Code set denoting the + type of reflection that the + staff member performed.

+
    +
  • 'EVE' - Events leading to the incident
    • +
  • 'BEH' - Behaviour of the student
    • +
  • 'WHA' - What did you try before the restraint?
    • +
  • 'RES' - The restraint method used
    • +
  • 'MON' - Monitoring
    • +
  • 'AFT' - After the restraint ended
    • +
  • 'NEX' - If there's a next time
    • +
  • 'HOW' - How about you?
    • +
+ oneOf: + - title: Events leading to the + incident + enum: + - EVE + - title: Behaviour of the student + enum: + - BEH + - title: What did you try before + the restraint? + enum: + - WHA + - title: The restraint method used + enum: + - RES + - title: Monitoring + enum: + - MON + - title: After the restraint ended + enum: + - AFT + - title: If there's a next time + enum: + - NEX + - title: How about you? + enum: + - HOW + RestraintDebriefingList: + description:

A list of the debriefings that took place + after the physical restraint incident + occurred.

+ type: object + required: + - RestraintDebriefing + properties: + RestraintDebriefing: + type: array + items: + description:

A debriefing that took place after the + physical restraint incident occurred. A + debriefing can be with a staff member or + with the student and their + parent/caregiver.

+ type: object + properties: + DebriefingDate: + type: string + format: date + description:

The date the debriefing about the + use of physical restraint on the + student occurred.

+ DebriefingTime: + description:

The time the debriefing about the + use of physical restraint on the + student occurred.

+ Findings: + type: string + description:

Free text outlining the findings of + the debriefing in the use of physical + restraint on the student.

+ NextStepsActions: + type: string + description:

Free text about the next steps + and/or actions that will be taken in + as a result of the debriefing on the + use of physical restraint on the + student.

+ ParentCaregiverComment: + type: string + description:

Parent/caregiver comments made + about the use physical restraint on + the student.

+ StudentComment: + type: string + description:

Student comments made about the use + physical restraint on the them.

+ DebriefingType: + type: string + title: Restraint Debriefing Type + description: >- +

Code set denoting the type of + debriefing that occurred, e.g. staff, + or student and parent/caregiver.

+
    +
  • 'S' - Staff
    • +
  • 'P' - Parent/Caregiver and Student
    • +
+ oneOf: + - title: Staff + enum: + - S + - title: Parent/Caregiver and Student + enum: + - P + AttendeeList: + description:

A list of the people that attended + the debriefing.

+ type: object + required: + - Attendee + properties: + Attendee: + type: array + items: + $ref: "#/paths/~1StudentPhysicalRestr\ + aints/get/responses/200/content\ + /application~1json/schema/prope\ + rties/StudentPhysicalRestraints\ + /properties/StudentPhysicalRest\ + raint/items/properties/Provider" + RestraintQuestionList: + description:

A list of questions and their answers about + the physical restraint incident.

+ type: object + required: + - RestraintQuestion + properties: + RestraintQuestion: + type: array + items: + description:

A question and it's answer about the + physical restraint incident that occurred. + Additional free text information to + support the answer may also be + supplied.

+ type: object + required: + - Question + properties: + Question: + type: string + title: Restraint Question + description: >- +

Code set denoting a question that + was asked about a student physical + restraint incident.

    +
  • '101' - First time the student has been physically restrained?
    • +
  • '102' - The student was physically restrained more than once during the day?
    • +
  • '103' - The student has an Individual Behaviour Plan?
    • +
  • '104' - Physical restraint was a part of the plan?
    • +
  • '105' - Were the parents notifed?
    • +
  • '106' - Was anyone injured?
    • +
  • '107' - Was the staff member who applied restraint a teacher or authorised staff member?
    • +
  • '108' - Role of staff member who applied the restraint?
    • +
  • '109' - Did the staff member who applied the restraint receive any training prior to the incident?
    • +
+ oneOf: + - title: First time the student has been + physically restrained? + enum: + - "101" + - title: The student was physically + restrained more than once during + the day? + enum: + - "102" + - title: The student has an Individual + Behaviour Plan? + enum: + - "103" + - title: Physical restraint was a part of + the plan? + enum: + - "104" + - title: Were the parents notifed? + enum: + - "105" + - title: Was anyone injured? + enum: + - "106" + - title: Was the staff member who applied + restraint a teacher or authorised + staff member? + enum: + - "107" + - title: Role of staff member who applied + the restraint? + enum: + - "108" + - title: Did the staff member who applied + the restraint receive any training + prior to the incident? + enum: + - "109" + Answer: + $ref: "#/paths/~1StudentPhysicalRestraints/\ + get/responses/200/content/application\ + ~1json/schema/properties/StudentPhysi\ + calRestraints/properties/StudentPhysi\ + calRestraint/items/properties/FirstTi\ + meStudentRestrained" + AnswerSupportingDescription: + type: string + description:

A free text description providing + additional information about the + question if required.

+ description:

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

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + application/xml: + schema: + type: object + properties: + StudentPhysicalRestraints: + type: object + description: A List of StudentPhysicalRestraint objects + properties: + StudentPhysicalRestraint: + type: array + items: + $ref: "#/paths/~1StudentPhysicalRestraints/get/responses/\ + 200/content/application~1json/schema/properties/Stu\ + dentPhysicalRestraints/properties/StudentPhysicalRe\ + straint/items" + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentPhysicalRestraints/{StudentPhysicalRestraintRefId}": + post: + tags: + - StudentPhysicalRestraint + summary: Default operation to create a single StudentPhysicalRestraint + parameters: + - name: StudentPhysicalRestraintRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: createStudentPhysicalRestraint + requestBody: + description: CRUD operation on StudentPhysicalRestraint + content: + application/json: + schema: + type: object + properties: + StudentPhysicalRestraint: + $ref: "#/paths/~1StudentPhysicalRestraints/get/responses/200/cont\ + ent/application~1json/schema/properties/StudentPhysicalRest\ + raints/properties/StudentPhysicalRestraint/items" + application/xml: + schema: + type: object + properties: + StudentPhysicalRestraint: + $ref: "#/paths/~1StudentPhysicalRestraints/get/responses/200/cont\ + ent/application~1json/schema/properties/StudentPhysicalRest\ + raints/properties/StudentPhysicalRestraint/items" + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentPhysicalRestraint + summary: Default operation to update a single StudentPhysicalRestraint + parameters: + - name: StudentPhysicalRestraintRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: updateStudentPhysicalRestraint + requestBody: + description: CRUD operation on StudentPhysicalRestraint + content: + application/json: + schema: + type: object + properties: + StudentPhysicalRestraint: + type: object + properties: + StudentPhysicalRestraintRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentPhysicalRestraintLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Provider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStudentPhy\ + sicalRestraintRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/StudentPhysicalRest\ + raint/properties/StudentPhysicalRestraintRefId" + LocalId: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStudentPhy\ + sicalRestraintRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/StudentPhysicalRest\ + raint/properties/StudentPhysicalRestraintLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Student: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStudentPhysica\ + lRestraintRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/StudentPhysicalRestraint/proper\ + ties/Provider" + PrincipalOrDelegate: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStudentPhysica\ + lRestraintRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/StudentPhysicalRestraint/proper\ + ties/Provider" + WellbeingEvent: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStudentPhysica\ + lRestraintRefId%7D/put/requestBody/content/application~\ + 1json/schema/properties/StudentPhysicalRestraint/proper\ + ties/Provider" + ConsideredNecessaryReason: + type: string + description:

Free text description on why the physical restraint + of the student was considered necessary.

+ FirstTimeStudentRestrained: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + IncidentDate: + type: string + format: date + description:

The date the physical restraint was used on the + student.

+ LocationDescription: + type: string + description:

Free text description of the location the physical + restraint of the student occurred in.

+ OtherComment: + type: string + description:

Any other comments on the physical restraint + incident.

+ ReportedDate: + type: string + format: date + description:

The date the use of physical restraint on the student + was report.

+ RestraintEndedTime: + description:

The time the physical restraint stopped being + used.

+ RestraintStartedTime: + description:

The time the physical restraint started being + used.

+ RestraintReason: + type: string + title: Restraint Reason + description: >- +

A code set denoting the reason physical restraint was + used on the student.

    +
  • 'SER' - Serious and imminent risk to safety
    • +
  • 'ACT' - Actual injury
    • +
+ oneOf: + - title: Serious and imminent risk to safety + enum: + - SER + - title: Actual injury + enum: + - ACT + StudentYearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid for + describing Funding Year Level and Current Year Level for + a student enrolment.

Current Year Level indicates + the year level of the student’s class cohort and the + level at which the student spends most of their time at + school. While a student may be enrolled in subjects at + varying instructional year levels, in relation to the + student enrolment this value represents the year level + at which the student is considered to be predominantly + taught.

Funding Year Level measures the actual + number of years that the student has attended a school. + It provides the Ministry with a method of counting + students for funding purposes which is independent of + the way schools are organised or the particular + programme of study that a student may undertake. Funding + Year Level for most students is based on the date they + first started school.

School Year Level is used + to indicate the instructional year levels offered by a + school, i.e. those years for which student enrolments + may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates Year 14 + and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + DocumentList: + description:

Describes the Location of any associated documents + kept in relation to this physical restraint + incident.

+ type: object + properties: + Document: + type: array + items: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStudentP\ + hysicalRestraintRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentPhysic\ + alRestraint/properties/Provider" + RestraintWitnessList: + description:

A list of the people that witnessed the physical + constraint.

+ type: object + properties: + Witness: + type: array + items: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStudentP\ + hysicalRestraintRefId%7D/put/requestBody/content/\ + application~1json/schema/properties/StudentPhysic\ + alRestraint/properties/Provider" + RestraintAdministeredByList: + description:

A list of the people who administered the physical + restraint to the student.

+ type: object + properties: + RestraintAdministeredBy: + type: array + items: + description:

The person who administered the physical + restraint to the student.

+ type: object + properties: + AdministeredBy: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStud\ + entPhysicalRestraintRefId%7D/put/requestBody/\ + content/application~1json/schema/properties/S\ + tudentPhysicalRestraint/properties/Provider" + SafePhysicalRestraintTraining: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStud\ + entPhysicalRestraintRefId%7D/put/requestBody/\ + content/application~1json/schema/properties/S\ + tudentPhysicalRestraint/properties/FirstTimeS\ + tudentRestrained" + TrainingDescription: + type: string + description:

Free text providing additional information + about any training the person has had on the + safe use pf physical restraint.

+ Role: + type: string + title: Restraint Administered By Role + description: >- +

Code set denoting the role of the person + who administered the physical restraint to the + student.

    +
  • 'T' - Teacher
    • +
  • 'P' - Principal
    • +
  • 'O' - Other
    • +
+ oneOf: + - title: Teacher + enum: + - T + - title: Principal + enum: + - P + - title: Other + enum: + - O + BehaviourDirectedAtList: + description:

The list of the people and/or property that the + student, who was restrained, was directing their + behaviour at.

+ type: object + properties: + BehaviourDirectedAt: + type: array + items: + description:

The person and/or piece of property that the + student, who was restrained, was directing their + behaviour at.

+ type: object + properties: + DirectedAt: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStud\ + entPhysicalRestraintRefId%7D/put/requestBody/\ + content/application~1json/schema/properties/S\ + tudentPhysicalRestraint/properties/Provider" + BehaviourDescription: + type: string + description:

Free text describing the behaviour the + student showed towards a person of piece of + property.

+ DirectedAtType: + type: string + title: Behaviour Directed At Type + description: >- +

Code set denoting type of object or person + the student was directing their behaviour at, + e.g. Staff Member, Student, Desk, Chair.

+
    +
  • 'STA' - Staff
    • +
  • 'STU' - Student
    • +
  • 'PRO' - Property
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Staff + enum: + - STA + - title: Student + enum: + - STU + - title: Property + enum: + - PRO + - title: Other + enum: + - OTH + StaffReflectionList: + description:

A list of the reflections made by the staff members + who applied the physical restraint.

+ type: object + properties: + StaffReflection: + type: array + items: + description:

The reflections performed by the staff member + who applied the physical restraint to the + student.

+ type: object + properties: + ReflectionDate: + type: string + format: date + description:

The date the staff member performed their + reflection on the use of physical restraint on + the student.

+ WitnessedBy: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStud\ + entPhysicalRestraintRefId%7D/put/requestBody/\ + content/application~1json/schema/properties/S\ + tudentPhysicalRestraint/properties/Provider" + Staff: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStud\ + entPhysicalRestraintRefId%7D/put/requestBody/\ + content/application~1json/schema/properties/S\ + tudentPhysicalRestraint/properties/Provider" + ReflectionList: + description:

A list of the reflections the staff member + performed.

+ type: object + properties: + Reflection: + type: array + items: + description:

A reflection that a staff member + performed about the physical restraint + incident.

+ type: object + properties: + ReflectionDescription: + type: string + description:

Free text outlining the staff + members thoughts on a type of + reflection.

+ Type: + type: string + title: Staff Restraint Reflection Type + description: >- +

Code set denoting the type of + reflection that the staff member + performed.

    +
  • 'EVE' - Events leading to the incident
    • +
  • 'BEH' - Behaviour of the student
    • +
  • 'WHA' - What did you try before the restraint?
    • +
  • 'RES' - The restraint method used
    • +
  • 'MON' - Monitoring
    • +
  • 'AFT' - After the restraint ended
    • +
  • 'NEX' - If there's a next time
    • +
  • 'HOW' - How about you?
    • +
+ oneOf: + - title: Events leading to the incident + enum: + - EVE + - title: Behaviour of the student + enum: + - BEH + - title: What did you try before the + restraint? + enum: + - WHA + - title: The restraint method used + enum: + - RES + - title: Monitoring + enum: + - MON + - title: After the restraint ended + enum: + - AFT + - title: If there's a next time + enum: + - NEX + - title: How about you? + enum: + - HOW + RestraintDebriefingList: + description:

A list of the debriefings that took place after the + physical restraint incident occurred.

+ type: object + properties: + RestraintDebriefing: + type: array + items: + description:

A debriefing that took place after the physical + restraint incident occurred. A debriefing can be + with a staff member or with the student and their + parent/caregiver.

+ type: object + properties: + DebriefingDate: + type: string + format: date + description:

The date the debriefing about the use of + physical restraint on the student + occurred.

+ DebriefingTime: + description:

The time the debriefing about the use of + physical restraint on the student + occurred.

+ Findings: + type: string + description:

Free text outlining the findings of the + debriefing in the use of physical restraint on + the student.

+ NextStepsActions: + type: string + description:

Free text about the next steps and/or + actions that will be taken in as a result of + the debriefing on the use of physical + restraint on the student.

+ ParentCaregiverComment: + type: string + description:

Parent/caregiver comments made about the + use physical restraint on the student.

+ StudentComment: + type: string + description:

Student comments made about the use + physical restraint on the them.

+ DebriefingType: + type: string + title: Restraint Debriefing Type + description: >- +

Code set denoting the type of debriefing + that occurred, e.g. staff, or student and + parent/caregiver.

    +
  • 'S' - Staff
    • +
  • 'P' - Parent/Caregiver and Student
    • +
+ oneOf: + - title: Staff + enum: + - S + - title: Parent/Caregiver and Student + enum: + - P + AttendeeList: + description:

A list of the people that attended the + debriefing.

+ type: object + properties: + Attendee: + type: array + items: + $ref: "#/paths/~1StudentPhysicalRestraints~1%\ + 7BStudentPhysicalRestraintRefId%7D/put/\ + requestBody/content/application~1json/s\ + chema/properties/StudentPhysicalRestrai\ + nt/properties/Provider" + RestraintQuestionList: + description:

A list of questions and their answers about the + physical restraint incident.

+ type: object + properties: + RestraintQuestion: + type: array + items: + description:

A question and it's answer about the physical + restraint incident that occurred. Additional free + text information to support the answer may also be + supplied.

+ type: object + properties: + Question: + type: string + title: Restraint Question + description: >- +

Code set denoting a question that was asked + about a student physical restraint + incident.

    +
  • '101' - First time the student has been physically restrained?
    • +
  • '102' - The student was physically restrained more than once during the day?
    • +
  • '103' - The student has an Individual Behaviour Plan?
    • +
  • '104' - Physical restraint was a part of the plan?
    • +
  • '105' - Were the parents notifed?
    • +
  • '106' - Was anyone injured?
    • +
  • '107' - Was the staff member who applied restraint a teacher or authorised staff member?
    • +
  • '108' - Role of staff member who applied the restraint?
    • +
  • '109' - Did the staff member who applied the restraint receive any training prior to the incident?
    • +
+ oneOf: + - title: First time the student has been physically + restrained? + enum: + - "101" + - title: The student was physically restrained more + than once during the day? + enum: + - "102" + - title: The student has an Individual Behaviour + Plan? + enum: + - "103" + - title: Physical restraint was a part of the plan? + enum: + - "104" + - title: Were the parents notifed? + enum: + - "105" + - title: Was anyone injured? + enum: + - "106" + - title: Was the staff member who applied restraint + a teacher or authorised staff member? + enum: + - "107" + - title: Role of staff member who applied the + restraint? + enum: + - "108" + - title: Did the staff member who applied the + restraint receive any training prior to + the incident? + enum: + - "109" + Answer: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStud\ + entPhysicalRestraintRefId%7D/put/requestBody/\ + content/application~1json/schema/properties/S\ + tudentPhysicalRestraint/properties/FirstTimeS\ + tudentRestrained" + AnswerSupportingDescription: + type: string + description:

A free text description providing + additional information about the question if + required.

+ description:

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

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + application/xml: + schema: + type: object + properties: + StudentPhysicalRestraint: + $ref: "#/paths/~1StudentPhysicalRestraints~1%7BStudentPhysicalRes\ + traintRefId%7D/put/requestBody/content/application~1json/sc\ + hema/properties/StudentPhysicalRestraint" + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentPhysicalRestraint + summary: Default operation to get a single StudentPhysicalRestraint + parameters: + - name: StudentPhysicalRestraintRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentPhysicalRestraint: + $ref: "#/paths/~1StudentPhysicalRestraints/get/responses/200/co\ + ntent/application~1json/schema/properties/StudentPhysical\ + Restraints/properties/StudentPhysicalRestraint/items" + application/xml: + schema: + type: object + properties: + StudentPhysicalRestraint: + $ref: "#/paths/~1StudentPhysicalRestraints/get/responses/200/co\ + ntent/application~1json/schema/properties/StudentPhysical\ + Restraints/properties/StudentPhysicalRestraint/items" + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentPhysicalRestraint + summary: Default operation to delete a single StudentPhysicalRestraint + parameters: + - name: StudentPhysicalRestraintRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentVoices: + get: + tags: + - StudentVoice + summary: Default operation to get a list of all available StudentVoices + description: Search the set of available StudentVoice entries, according to the + search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentVoices: + type: object + description: A List of StudentVoice objects + properties: + StudentVoice: + type: array + items: + required: + - Provider + - Student + type: object + properties: + StudentVoiceRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentVoiceLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentVoices/get/responses/200/\ + content/application~1json/schema/properties\ + /StudentVoices/properties/StudentVoice/item\ + s/properties/StudentVoiceRefId" + LocalId: + $ref: "#/paths/~1StudentVoices/get/responses/200/\ + content/application~1json/schema/properties\ + /StudentVoices/properties/StudentVoice/item\ + s/properties/StudentVoiceLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentVoices/get/responses/200/cont\ + ent/application~1json/schema/properties/Student\ + Voices/properties/StudentVoice/items/properties\ + /Student" + StudentVoiceNote: + type: string + description:

Extra notes about the student, and their + voice

+ StudentInterestList: + description:

A list of the diffent interests the student + has expressed.

+ type: object + required: + - StudentInterest + properties: + StudentInterest: + type: array + items: + description:

Object recording an interest the + student has expressed.

+ type: object + properties: + InterestRecordedDate: + type: string + format: date + description:

The date the Student's interest was + recorded.

+ InterestDescription: + type: string + description:

A description of the interest the + student wants to achieve

+ InterestName: + type: string + description:

The name of the interest the + student has expressed

+ InterestType: + type: string + title: Student Interest Type + description: >- +

Standard codes denoting the type of + interest the student likes to do.

+
    +
  • 'SPO' - Sports
    • +
  • 'ART' - Arts
    • +
  • 'CUL' - Cultural
    • +
  • 'MUS' - Music
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Sports + enum: + - SPO + - title: Arts + enum: + - ART + - title: Cultural + enum: + - CUL + - title: Music + enum: + - MUS + - title: Other + enum: + - OTH + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas + defined by the NZ Curriculum and Te + Marautanga o Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - title: German + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - GERM + - title: Indonesian + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - INDO + - title: Japanese + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - JAPA + - title: French + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - FREN + - title: English (Remedial) + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - REME + - title: English + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - ENGL + - title: Cook Island Maori + description: Applicable to both NZ Curriculum + and Te Marautanga o Aotearoa + enum: + - COOK + - title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + enum: + - COMM + - title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + enum: + - CHIN + - title: Korean + enum: + - KORE + - title: Latin + enum: + - LATI + - title: Niuean + enum: + - NIUE + - title: Other Languages + enum: + - OLAN + - title: Pacific Language Studies + enum: + - PLAN + - title: Russian + enum: + - RUSS + - title: Samoan + enum: + - SAMO + - title: Spanish + enum: + - SPAN + - title: Te Reo Māori + enum: + - MAOR + - title: Te Reo Rangatira + enum: + - RANG + - title: Tokelauan + enum: + - TOKE + - title: Tongan + enum: + - TONG + - title: English as a Second Language + enum: + - ENSL + - title: Mathematics + enum: + - MATH + - title: Mathematics with Calculus + enum: + - MATC + - title: Mathematics with Statistics + enum: + - MATS + - title: Mathematics (Remedial) + enum: + - REMM + - title: Accounting + enum: + - ACCO + - title: Science + enum: + - SCIE + - title: Agriculture / Horticulture + enum: + - AGHO + - title: Biology / Biological Science + enum: + - BIOL + - title: Chemsitry + enum: + - CHEM + - title: Earth Science / Astronomy + enum: + - EAAS + - title: Human Biology + enum: + - HUMB + - title: Physics + enum: + - PHYS + - title: Technology + enum: + - TECN + - title: Biotechnology + enum: + - BITE + - title: Computer Science / Programming + enum: + - COSC + - title: Computer Studies + enum: + - COMP + - title: Design, Drawing and Graphics + enum: + - DEST + - title: Electronics and Control + enum: + - ELTE + - title: Food Technology + enum: + - FOTE + - title: Graphics + enum: + - GRAP + - title: Information and Communication + Technology + enum: + - INTE + - title: Materials Technology + enum: + - MTEC + - title: Structures and Mechanisms + enum: + - STME + - title: Test and Information Management + enum: + - TIMA + - title: Textiles / Clothing + enum: + - CLTX + - title: The Arts + enum: + - ARTA + - title: Art Design + enum: + - ARTD + - title: Art History + enum: + - ARTH + - title: Dancing + enum: + - DANC + - title: Drama + enum: + - DRAM + - title: Music / Music Studies + enum: + - MUSC + - title: Music Practical / Performance + enum: + - MUSP + - title: Painting + enum: + - ARPA + - title: Performing Arts + enum: + - APER + - title: Photography + enum: + - ARTP + - title: Printmaking + enum: + - ARPR + - title: Sculpture + enum: + - ARTS + - title: Visial Arts + enum: + - ARTC + - title: Social Studies + enum: + - SOST + - title: Classics / Classical Studies + enum: + - CLST + - title: Community Studies + enum: + - CMTY + - title: Economics + enum: + - ECON + - title: Environmental Sustainability + enum: + - SENV + - title: Geography + enum: + - GEOG + - title: History + enum: + - HIST + - title: Language and Cultural Studies + enum: + - LACU + - title: Māori Studies + enum: + - MAOS + - title: Media Studies + enum: + - MEST + - title: Other Social Sciences + enum: + - SOSC + - title: Health and Physical Education + enum: + - HEPH + - title: Health + enum: + - HEED + - title: Home Economics + enum: + - HOME + - title: Outdoor Education + enum: + - OUED + - title: Physical Education + enum: + - PHED + - title: Sports Studies + enum: + - SPOR + - title: Commerce Related + enum: + - BUSS + - title: Defence + enum: + - DEFE + - title: Equestrian + enum: + - EQUE + - title: Farming + enum: + - FARM + - title: Fishing + enum: + - FISH + - title: Forestry + enum: + - FOTY + - title: Industrial Trades + enum: + - INTR + - title: Integrated Studies + enum: + - INTS + - title: Legal / Law Related Studies + enum: + - LAWS + - title: Life Skills / Personal Development + enum: + - LIFE + - title: Religious Education / Studies + enum: + - REST + - title: Remedial Studies + enum: + - REMS + - title: Secondary Tertiary Programme + enum: + - STPR + - title: Service Trades + enum: + - SETR + - title: Special Needs Programme + enum: + - SPPR + - title: Study Skills + enum: + - STDY + - title: Transition / Pre-Employment + enum: + - TRAN + - title: Travel, Hospitality, Tourism + enum: + - THTR + SocialGoalList: + description:

A list of the diffent social goals the + student has expressed.

+ type: object + required: + - SocialGoal + properties: + SocialGoal: + type: array + items: + description:

Base complex type defining elements + common to all flavours of StudentGoal.

+ type: object + properties: + GoalRecordedDate: + type: string + format: date + description:

The date the Student's goal was + recorded.

+ GoalAchievedDate: + type: string + format: date + description:

The date the Student achieved their + goal.

+ GoalDescription: + type: string + description:

A description of the goal the + student wants to achieve

+ GoalName: + type: string + description:

The name of the goal the student + wants to achieve

+ AcademicGoalList: + description:

A list of the diffent academic goals the + student has expressed.

+ type: object + required: + - AcademicGoal + properties: + AcademicGoal: + type: array + items: + description:

Defining elements of the Academic + flavour of student goal.

+ type: object + properties: + SubjectArea: + $ref: "#/paths/~1StudentVoices/get/response\ + s/200/content/application~1json/schem\ + a/properties/StudentVoices/properties\ + /StudentVoice/items/properties/Studen\ + tInterestList/properties/StudentInter\ + est/items/properties/SubjectArea" + CareerGoalList: + description:

A list of the diffent career goals the + student has expressed.

+ type: object + required: + - CareerGoal + properties: + CareerGoal: + type: array + items: + description:

Base complex type defining elements + common to all flavours of StudentGoal.

+ type: object + properties: + GoalRecordedDate: + type: string + format: date + description:

The date the Student's goal was + recorded.

+ GoalAchievedDate: + type: string + format: date + description:

The date the Student achieved their + goal.

+ GoalDescription: + type: string + description:

A description of the goal the + student wants to achieve

+ GoalName: + type: string + description:

The name of the goal the student + wants to achieve

+ description: A record of a student's interests as well as their + social, academic and academic goals. + x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + example: + StudentVoices: + StudentVoice: + - StudentVoiceRefId: 7C834EA9-EDA1-2090-347F-83297E1C290C + StudentVoiceLocalId: 2234523 + Student: + RefId: 5c33548a-1141-40eb-94d3-9267a2258435 + 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 + application/xml: + schema: + type: object + properties: + StudentVoices: + type: object + description: A List of StudentVoice objects + properties: + StudentVoice: + type: array + items: + $ref: "#/paths/~1StudentVoices/get/responses/200/content/\ + application~1json/schema/properties/StudentVoices/p\ + roperties/StudentVoice/items" + example: >- + + + 7C834EA9-EDA1-2090-347F-83297E1C290C + 2234523 + + 5c33548a-1141-40eb-94d3-9267a2258435 + + Timothy doesn't like talking about setting goals. These goals have been gathered through observation. + + + 2018-11-30 + Timothy spends most lunchtimes playing with the piano, or watching others playing music + Music/Piano + MUS + MUSP + + + + + 2018-11-30 + Timothy would like to have more friends to play with at lunchtime. + Have more friends + + + + + 2018-11-30 + Timothy wants to excel at Te Reo Māori + Excel Te Reo + MAOR + + + + + 2018-11-30 + Timothy would like to be a Marine Biologist, or Deep Sea Diver + Marine Biologist + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentVoices/{StudentVoiceRefId}": {} + /LearningSupportRegisterDirectorys: + get: + tags: + - LearningSupportRegisterDirectory + summary: Default operation to get a list of all available + LearningSupportRegisterDirectorys + description: Search the set of available LearningSupportRegisterDirectory entries, + according to the search criteria in the URL parameters. Returns the + first 20 objects located; with SIF defined navigation headers, + indicating how to retrieve subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + LearningSupportRegisterDirectorys: + type: object + description: A List of LearningSupportRegisterDirectory objects + properties: + LearningSupportRegisterDirectory: + type: array + items: + required: + - TargetAudience + type: object + properties: + LearningSupportRegisterDirectoryRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + LearningSupportRegisterDirectoryLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + AreaOfNeed: + type: string + title: Wellbeing Characteristic Category + description: >- +

Standard codes denoting the second level + category of the Wellbeing Characteristic.

+
    +
  • 'MAO' - Allergies - other
    • +
  • 'DIET' - Dietary Preferences
    • +
  • 'LSN-BEL' - Belonging (Participation and Contributing) - Mana whenua
    • +
  • 'LSN-COM' - Communication (Using Language and Text) - Mana reo
    • +
  • 'LSN-CON' - Contribution (Relating to Others) - Mana tangata
    • +
  • 'LSN-EXP' - Exploration (Thinking) - Mana aotūroa
    • +
  • 'LSN-WEL' - Wellbeing (Managing Self) - Mana atua
    • +
  • 'MAIM' - Auto-immune/Immune Disorders
    • +
  • 'MRD' - Respiratory Disorder
    • +
  • 'MB' - Blood disorder
    • +
  • 'MMD' - Heart Disease/ Disorder
    • +
  • 'MMS' - Musculo – skeletal conditions
    • +
plus 17 more value(s) at NZCodeSetsWellbeingCharacteristicCategoryType + oneOf: + - title: Allergies - other + enum: + - MAO + - title: Dietary Preferences + enum: + - DIET + - title*: + en: Belonging (Participation and Contributing) + mi: Mana whenua + enum: + - LSN-BEL + - title*: + en: Communication (Using Language and Text) + mi: Mana reo + enum: + - LSN-COM + - title*: + en: Contribution (Relating to Others) + mi: Mana tangata + enum: + - LSN-CON + - title*: + en: Exploration (Thinking) + mi: Mana aotūroa + enum: + - LSN-EXP + - title*: + en: Wellbeing (Managing Self) + mi: Mana atua + enum: + - LSN-WEL + - title: Auto-immune/Immune Disorders + enum: + - MAIM + - title: Respiratory Disorder + enum: + - MRD + - title: Blood disorder + enum: + - MB + - title: Heart Disease/ Disorder + enum: + - MMD + - title: Musculo – skeletal conditions + enum: + - MMS + - title: Endocrine and Metabolic Disorders + enum: + - MEM + - title: Childhood cancer + enum: + - MC + - title: Allergy – Anaphylaxis + enum: + - MAA + - title: Mental and behavioural disorders + enum: + - MH + - title: Diseases/conditions of the nervous system + enum: + - MN + - title: Seizure disorders + enum: + - MS + - title: Congenital malformations, deformations and + chromosomal abnormalities + enum: + - MCM + - title: Infectious Diseases + enum: + - MI + - title: Gastro Intestinal/Urinary conditions + enum: + - MGI + - title: Neuro/Developmental Disorders + enum: + - MND + - title: Oral/Phalangeal Disorders + enum: + - MO + - title: Deaf and Hard of Hearing + enum: + - MD + - title: Optical/ Vision Disorder + enum: + - MOP + - title: Medical Other + enum: + - M-OTHER + - title: Disability Other + enum: + - D-OTHER + - title: Special Needs Other + enum: + - S-OTHER + - title: Other + enum: + - OTHER + Need: + type: string + title: Wellbeing Characteristic Sub Category + description: >- +

Standard codes denoting the third level + category of the Wellbeing Characteristic.

+
    +
  • 'DIET-01' - Vegan
    • +
  • 'DIET-02' - Vegetarian
    • +
  • 'DIET-03' - Halal
    • +
  • 'DIET-04' - Kosher
    • +
  • 'DIET-05' - Pescetarian
    • +
  • 'DIET-06' - Gluten-free
    • +
  • 'LSN-ABN' - Absence
    • +
  • 'LSN-ACD' - Academic
    • +
  • 'LSN-ANX' - Anxiety
    • +
  • 'LSN-ASD' - ASD
    • +
  • 'LSN-ATT' - Attendance
    • +
  • 'LSN-AUD' - Auditory Processing
    • +
plus 121 more value(s) at NZCodeSetsWellbeingCharacteristicSubCategoryType + oneOf: + - title: Vegan + enum: + - DIET-01 + - title: Vegetarian + enum: + - DIET-02 + - title: Halal + enum: + - DIET-03 + - title: Kosher + enum: + - DIET-04 + - title: Pescetarian + enum: + - DIET-05 + - title: Gluten-free + enum: + - DIET-06 + - title: Absence + enum: + - LSN-ABN + - title: Academic + enum: + - LSN-ACD + - title: Anxiety + enum: + - LSN-ANX + - title: ASD + enum: + - LSN-ASD + - title: Attendance + enum: + - LSN-ATT + - title: Auditory Processing + enum: + - LSN-AUD + - title: Behaviour + enum: + - LSN-BHV + - title: Communication + enum: + - LSN-COM + - title: Comprehension + enum: + - LSN-CPH + - title: Dyscalculia + enum: + - LSN-DCA + - title: Developmental Delay + enum: + - LSN-DEV + - title: Dysgraphia + enum: + - LSN-DGA + - title: Dyspraxia + enum: + - LSN-DPA + - title: Dyslexia + enum: + - LSN-DSA + - title: Engagement + enum: + - LSN-ENG + - title: Epilepsy + enum: + - LSN-EPI + - title: ESOL + enum: + - LSN-ESL + - title: Focus + enum: + - LSN-FCS + - title: Fine Motor Skills + enum: + - LSN-FMS + - title: Hearing + enum: + - LSN-HRG + - title: Handwriting + enum: + - LSN-HWG + - title: Independence + enum: + - LSN-IND + - title: Intellectual Disability + enum: + - LSN-INT + - title: Literacy + enum: + - LSN-LIT + - title: Learning + enum: + - LSN-LNG + - title: Maths + enum: + - LSN-MTH + - title: Numeracy + enum: + - LSN-NUM + - title: Oral Language + enum: + - LSN-ORL + - title: ORS + enum: + - LSN-ORS + - title: Others + enum: + - LSN-OTH + - title: Physical Skills + enum: + - LSN-PHS + - title: Passive Learner + enum: + - LSN-PSL + - title: Pastoral + enum: + - LSN-PST + - title: Reading + enum: + - LSN-RDG + - title: Rate of Learning + enum: + - LSN-ROL + - title: Rate of Progress + enum: + - LSN-ROP + - title: Speech + enum: + - LSN-SPH + - title: Spelling + enum: + - LSN-SPL + - title: Social Relationships + enum: + - LSN-SRL + - title: Vision + enum: + - LSN-VIS + - title: Wellbeing + enum: + - LSN-WBG + - title: Writing + enum: + - LSN-WRT + - title: Adjustment Disorder + enum: + - MH-1 + - title: Anorexia + enum: + - MH-2 + - title: Anxiety Disorder + enum: + - MH-3 + - title: Attachment Disorder + enum: + - MH-4 + - title: Attention Deficit Hyperactivity Disorder + (ADHD) + enum: + - MH-5 + - title: Bipolar Affective Disorder + enum: + - MH-6 + - title: Bulimia + enum: + - MH-7 + - title: Depression + enum: + - MH-8 + - title: Mixed Depression and Anxiety + enum: + - MH-9 + - title: Obsessive Compulsive Disorder + enum: + - MH-10 + - title: Oppositional Defiance Disorder + enum: + - MH-11 + - title: Paranoia + enum: + - MH-12 + - title: Post-Traumatic Stress Disorder + enum: + - MH-13 + - title: Reactive Attachment Disorder + enum: + - MH-14 + - title: Social Anxiety Disorder + enum: + - MH-15 + - title: Tic Disorder + enum: + - MH-16 + - title: Tourette’s Syndrome + enum: + - MH-17 + - title: Conduct Disorder + enum: + - MH-18 + - title: Absence seizures epilepsy + enum: + - MS-1 + - title: Tonic Clonic epilepsy + enum: + - MS-2 + - title: Myotonic epilepsy + enum: + - MS-3 + - title: Refractory epilepsy + enum: + - MS-4 + - title: Antibiotics -specify type(s) + enum: + - MAA-1 + - title: Dairy + enum: + - MAA-2 + - title: Egg + enum: + - MAA-3 + - title: Fruit (specify) + enum: + - MAA-4 + - title: Insect bites - nfd + enum: + - MAA-5 + - title: Bees + enum: + - MAA-6 + - title: Ants + enum: + - MAA-7 + - title: Ticks + enum: + - MAA-8 + - title: Latex + enum: + - MAA-9 + - title: Peanuts + enum: + - MAA-10 + - title: Shellfish + enum: + - MAA-11 + - title: Tree nuts + enum: + - MAA-12 + - title: Wheat + enum: + - MAA-13 + - title: Other + enum: + - MAA-14 + - title: Coeliac Disease - Gluten + enum: + - MAIM-1 + - title: Enterocolitis Syndrome + enum: + - MAIM-2 + - title: Food Protein Induced Syndrome + enum: + - MAIM-3 + - title: Anaemia + enum: + - MB-1 + - title: Haemophilia + enum: + - MB-2 + - title: Thalassemia + enum: + - MB-3 + - title: Vasculitis + enum: + - MB-4 + - title: Von Willebrand's Disease + enum: + - MB-5 + - title: Ehlers Danlos + enum: + - MMS-1 + - title: Fibromyalgia - discuss + enum: + - MMS-2 + - title: Hip Dysplasia + enum: + - MMS-3 + - title: Joint Hypermobility + enum: + - MMS-4 + - title: Juvenile Arthritis + enum: + - MMS-5 + - title: Kohlers Disease + enum: + - MMS-6 + - title: Marfan Syndrome + enum: + - MMS-7 + - title: Meyers Dysplasia + enum: + - MMS-8 + - title: Neurofibromatosis type 1 + enum: + - MMS-9 + - title: Osgood Schlatter Condition + enum: + - MMS-10 + - title: Osteo Imperfecta + enum: + - MMS-11 + - title: Scoliosis + enum: + - MMS-12 + - title: Severs Disease + enum: + - MMS-13 + - title: Talipes + enum: + - MMS-14 + - title: Von Eulenburg Disease + enum: + - MMS-15 + - title: Angelman Syndrome + enum: + - MCM-1 + - title: Charcot Marie Tooth + enum: + - MCM-2 + - title: Coffin Lowry Syndrome + enum: + - MCM-3 + - title: Coffin-Siris Syndrome + enum: + - MCM-4 + - title: Down Syndrome + enum: + - MCM-5 + - title: Foetal Alcohol Syndrome (FAS) + enum: + - MCM-6 + - title: Fragile X Syndrome + enum: + - MCM-7 + - title: G6 PD Deficiency + enum: + - MCM-8 + - title: Hyperglycemia + enum: + - MCM-9 + - title: Klinefelter Syndrome + enum: + - MCM-10 + - title: Malignant Hyperthermia + enum: + - MCM-11 + - title: MCADD - Metabolic disorder + enum: + - MCM-12 + - title: Non Ketotic + enum: + - MCM-13 + - title: Oculocutaneous Albinism + enum: + - MCM-14 + - title: Phelan-McDermid Syndrome + enum: + - MCM-15 + - title: Phenylketonuria + enum: + - MCM-16 + - title: Pierr Robyn Syndrome + enum: + - MCM-17 + - title: Potocki - Lupski Syndrome + enum: + - MCM-18 + - title: Prader Willi Syndrome + enum: + - MCM-19 + - title: Rubinstein-Taybi Syndrome + enum: + - MCM-20 + - title: ScN2A (Sodium Channel) Gene Mutation + enum: + - MCM-21 + - title: Trisomy - chromosome + enum: + - MCM-22 + - title: Trisomy 21/Down Syndrome + enum: + - MCM-23 + - title: Turners Syndrome + enum: + - MCM-24 + - title: Velocardiofacial Syndrome + enum: + - MCM-25 + - title: Wolf-Hirschhorn Syndrome + enum: + - MCM-26 + Intervention: + type: string + title: Learning Support Intervention + description: >- +

Standard codes denoting the learning support + intervention type, e.g. ESOL, First STEPs, + MST.

    +
  • 'AEAC' - Alternative Education - Activity Centre
    • +
  • 'AODC' - Advisors on Deaf Children
    • +
  • 'AESA' - Alternative Education - Service Academy
    • +
  • 'AESS' - Alternative Education - Study Support Centre
    • +
  • 'AETP' - Alternative Education - Teen Parent Unit (TPU)
    • +
  • 'ACBS' - ASD Communication and Behaviour Support
    • +
  • 'ADCO' - ASD Developmental Coordination
    • +
  • 'APED' - ASD Parent Education (ASD Plus, TIPS for Autism, Growing Up With Autism)
    • +
  • 'ASDI' - ASD Specific Disability Information and Advisory Services (DIAS)
    • +
  • 'ATEQ' - Assistive Technology (AT) Equipment
    • +
  • 'ATTSC' - Attendance Services
    • +
  • 'AUME' - Autism and Me
    • +
plus 70 more value(s) at NZCodeSetsLearningSupportInterventionType + oneOf: + - title: Alternative Education - Activity Centre + enum: + - AEAC + - title: Advisors on Deaf Children + enum: + - AODC + - title: Alternative Education - Service Academy + enum: + - AESA + - title: Alternative Education - Study Support Centre + enum: + - AESS + - title: Alternative Education - Teen Parent Unit + (TPU) + enum: + - AETP + - title: ASD Communication and Behaviour Support + enum: + - ACBS + - title: ASD Developmental Coordination + enum: + - ADCO + - title: ASD Parent Education (ASD Plus, TIPS for + Autism, Growing Up With Autism) + enum: + - APED + - title: ASD Specific Disability Information and + Advisory Services (DIAS) + enum: + - ASDI + - title: Assistive Technology (AT) Equipment + enum: + - ATEQ + - title: Attendance Services + enum: + - ATTSC + - title: Autism and Me + enum: + - AUME + - title: Behaviour Crisis Response + enum: + - BCRS + - title: Behaviour Services and Support + enum: + - BSAS + - title: Books and Resources + enum: + - BKRS + - title: Child and Adolescent Mental Heath Services + enum: + - CAMH + - title: Connecting Parents + enum: + - CNPA + - title: Day Special Schools + enum: + - DASS + - title: Deaf Education Centres + enum: + - DECT + - title: Diagnosis Guide + enum: + - DGDE + - title: Disability Support Service + enum: + - DSSC + - title: Early Intervention - Development Needs + enum: + - EIDN + - title: Early Intervention - Disabilities such as + ASD, Learning or Phsyical Disabilities + enum: + - EIDS + - title: Early Intervention - Social Skills + enum: + - EISS + - title: Early Intervention - ASD + enum: + - EIAS + - title: Early Intervention - Behaviour + enum: + - EIBH + - title: Early Intervention - Communication Needs + enum: + - EICN + - title: Early Intervention - Hearing + enum: + - EIHR + - title: Early Intervention - Vision + enum: + - EIVS + - title: EarlyBird + enum: + - ELBD + - title: ESOL Funding + enum: + - ESOL + - title: Expanded Core Curriculum + enum: + - EXCC + - title: Explore ASD Plus + enum: + - EASD + - title: First Signs + enum: + - FTSN + - title: Framework for Autism in New Zealand (FANZ) + enum: + - FANZ + - title: How Can We Help? + enum: + - HCWH + - title: IHC Library + enum: + - IHCL + - title: In-Class Support + enum: + - INSP + - title: "Inclusive Education: A Guide to ASD and + Learning" + enum: + - IEED + - title: Individualised Training Programmes + enum: + - ITPR + - title: Information and Advice + enum: + - INAD + - title: Information Service + enum: + - ISVC + - title: Interim Response Fund (IRF) + enum: + - IRFD + - title: International Research + enum: + - INRS + - title: Learning Resources + enum: + - LRCS + - title: Maternal Infant Child and Adolescent Mental + Health Services (MICAMHS) + enum: + - MICA + - title: Needs Assessment Service Co-Ordination + enum: + - NASC + - title: Occupational Therapists + enum: + - OCTH + - title: Ongoing Resourcing Scheme (ORS) + enum: + - ORSM + - title: PB4L Check and Connect + enum: + - PCAC + - title: PB4L Huakina Mai + enum: + - PHKM + - title: PB4L Incredible Years Parent + enum: + - PIYP + - title: PB4L Incredible Years Teacher + enum: + - PIYT + - title: PB4L My FRIENDS Youth Resilience Programme + enum: + - PFYR + - title: PB4L Restorative Justice + enum: + - PRJS + - title: PB4L School-Wide + enum: + - PSCW + - title: PB4L Te Mana Tikitiki + enum: + - PTMT + - title: PB4L Wellbeing@School + enum: + - PWAS + - title: Physiotherapists + enum: + - PHYS + - title: Planning Alternative Tomorrows with Hope + (PATH) + enum: + - PATH + - title: Positive Behaviour Support (PBS) Framework + enum: + - PBSF + - title: PRISM Professional Development Series + enum: + - PRSM + - title: Resource Teacher Deaf (RTD) + enum: + - RTDF + - title: Resource Teacher Lit (RTLit) + enum: + - RLIT + - title: "Resource Teachers: Learning and Behaviour + Service (RTLB)" + enum: + - RLBS + - title: SAC Assessment + enum: + - SACA + - title: School High Health Needs Fund + enum: + - SHHN + - title: SibSupportNZ + enum: + - SSNZ + - title: Social Workers in Schools (SWiS) Programme + enum: + - SWIS + - title: Specialised School Transport Assistance + (SESTA) + enum: + - SSTA + - title: Speech-Language Therapists + enum: + - SLTH + - title: Support, Information and Education + enum: + - SIAE + - title: Supporting Behaviour + enum: + - SBHV + - title: Teacher Aide Support + enum: + - TASP + - title: Teaching Strategies and Resources + enum: + - TSAR + - title: Tilting the Seesaw for Teams + enum: + - TSFT + - title: Tutor + enum: + - TUTR + - title: Understanding Autism + enum: + - UAUT + - title: Way to Play + enum: + - WTPL + - title: Year 11+ Funding + enum: + - YELF + - title: Year 9+ + enum: + - YNNE + - title: Other + enum: + - OTHR + TargetAudience: + type: string + title: Learning Support Target Audience + description: >- +

Code set denoting the target audience of the + learning support intervention for the area of + need.

    +
  • 'EDU' - Educators
    • +
  • 'EFW' - Educators/Family/Whānau
    • +
  • 'FWH' - Family/Whānau
    • +
  • 'FFW' - Family/Whānau/Workforce
    • +
  • 'FOG' - Organisation
    • +
  • 'PRE' - Pre-School
    • +
  • 'TFP' - Team
    • +
  • 'IST' - Individual Students
    • +
  • 'PWH' - Parents/Whānau
    • +
  • 'SWD' - School Wide
    • +
  • 'SCH' - Schools
    • +
  • 'TPR' - Targeted Programmes
    • +
+ oneOf: + - title: Educators + enum: + - EDU + - title: Educators/Family/Whānau + enum: + - EFW + - title: Family/Whānau + enum: + - FWH + - title: Family/Whānau/Workforce + description: For family/whānau, early childhood teachers, + health professionals, or anyone else living + or working with young children with autism + enum: + - FFW + - title: Organisation + description: For organisations or other groups requiring + a training or education event + enum: + - FOG + - title: Pre-School + description: For parents, whānau, and caregivers of + pre-school children + enum: + - PRE + - title: Team + description: For teams of family and professionals, + working together to support tamariki with + autism aged 5-12 years. Teams may include + parents, caregivers, other family/whānau, + primary school teachers, teacher aids, + learning assistants, SENCOs or RTLBs + enum: + - TFP + - title: Individual Students + enum: + - IST + - title: Parents/Whānau + enum: + - PWH + - title: School Wide + enum: + - SWD + - title: Schools + enum: + - SCH + - title: Targeted Programmes + enum: + - TPR + Resource: + type: string + title: Learning Support Resource + description: >- +

Code set denoting the resource that is + required to support the learning support + intervention in addressing the area of need.

+
    +
  • 'ADC' - Advisor on Deaf Children
    • +
  • 'BSW' - Basic Sight Words Programme
    • +
  • 'BCN' - Building Confidence
    • +
  • 'CCE' - Change Classroom Environment
    • +
  • 'CCM' - Change Classroom Management
    • +
  • 'CIC' - Check In Check Out (CICO)
    • +
  • 'COF' - Circle of Friends, Intervention
    • +
  • 'CTM' - Circle TIme
    • +
  • 'CBT' - Cognitive Behaviour Therapy
    • +
  • 'CED' - Conductor in Conductive Education Programme
    • +
  • 'CSV' - Continence Service
    • +
  • 'DRP' - Daily Report
    • +
plus 34 more value(s) at NZCodeSetsLearningSupportResourceType + oneOf: + - title: Advisor on Deaf Children + enum: + - ADC + - title: Basic Sight Words Programme + enum: + - BSW + - title: Building Confidence + enum: + - BCN + - title: Change Classroom Environment + enum: + - CCE + - title: Change Classroom Management + enum: + - CCM + - title: Check In Check Out (CICO) + enum: + - CIC + - title: Circle of Friends, Intervention + enum: + - COF + - title: Circle TIme + enum: + - CTM + - title: Cognitive Behaviour Therapy + enum: + - CBT + - title: Conductor in Conductive Education Programme + enum: + - CED + - title: Continence Service + enum: + - CSV + - title: Daily Report + enum: + - DRP + - title: Differentiated Programme + enum: + - DPM + - title: District Truancy Service (DTS) + enum: + - DTS + - title: Dyslexia Screening + enum: + - DSS + - title: Educational Psychologist + enum: + - EDP + - title: Guidance Counselling + enum: + - GCG + - title: Inclusion Strategy + enum: + - IST + - title: Learning and Language Intervention (LLI) + enum: + - LLI + - title: Māori or Cultural Advisor + enum: + - MCA + - title: Music Therapist (Registered) + enum: + - MTH + - title: Non-Enrolled Truancy Service (NETS) + enum: + - NET + - title: Occupational Therapist (OT) + enum: + - OTS + - title: Orientation and Mobility Instructor + enum: + - OMT + - title: Parent Funded Tutor + enum: + - PFT + - title: Pause, Prompt, Praise (PPP) + enum: + - PPP + - title: Peer Tutor + enum: + - PTR + - title: Phonics Programme + enum: + - PPR + - title: Psychologist + enum: + - PSY + - title: Physiotherapist + enum: + - PHY + - title: Proximal Praise + enum: + - PXP + - title: Quick 60 Intervention + enum: + - QKI + - title: Reading Recovery + enum: + - RRC + - title: Regular Home/School Meetings + enum: + - RHS + - title: RTLB Resource Teacher + enum: + - RTL + - title: Safety Strategy + enum: + - SSG + - title: Sign Language Interpreter + enum: + - SLI + - title: Social Skills Intervention + enum: + - SSI + - title: Social Worker in School (SWIS) + enum: + - SWS + - title: Special Education Advisor + enum: + - SEA + - title: Specialist Teacher Outreach + enum: + - STO + - title: Speech Language Therapist + enum: + - SLT + - title: Teacher Aide Support + enum: + - TAS + - title: Teacher with additional tertiary + qualifications in learning, vision or + hearing + enum: + - TWA + - title: Transition Strategy + enum: + - TSG + - title: Visual Prompts/Strategies + enum: + - VPS + ResourcesOtherDesc: + type: string + description:

Free text description describing the + resources required for the intervention. Only + populated if a Resource of 'Other' is + selected.

+ FundedBy: + type: string + title: Learning Support Funded By + description: >- +

Code set denoting who can fund a learning + support intervention, i.e. who provides + co-ordination, manages the contents etc. for the + intervention.

    +
  • 'ACC' - Accident Compensation Corporation (ACC)
    • +
  • 'ASP' - ASPIRE
    • +
  • 'DHB' - District Health Board (DHB)
    • +
  • 'EDU' - Educators
    • +
  • 'FWH' - Family/Whānau/Educators/Health Professionals
    • +
  • 'FRE' - Free Service
    • +
  • 'MOE' - Ministry of Education (MoE)
    • +
  • 'MOH' - Ministry of Health (MoH)
    • +
  • 'MHD' - Ministry of Health (MoH)/District Health Board (DHB)
    • +
  • 'OTM' - Oranga Tamariki (OT)
    • +
  • 'PCA' - Parents/Caregivers
    • +
  • 'ACA' - The Association for Child and Adolescent Mental Health
    • +
plus 1 more value(s) at NZCodeSetsLearningSupportFundedByType + oneOf: + - title: Accident Compensation Corporation (ACC) + enum: + - ACC + - title: ASPIRE + enum: + - ASP + - title: District Health Board (DHB) + enum: + - DHB + - title: Educators + enum: + - EDU + - title: Family/Whānau/Educators/Health Professionals + enum: + - FWH + - title: Free Service + enum: + - FRE + - title: Ministry of Education (MoE) + enum: + - MOE + - title: Ministry of Health (MoH) + enum: + - MOH + - title: Ministry of Health (MoH)/District Health + Board (DHB) + enum: + - MHD + - title: Oranga Tamariki (OT) + enum: + - OTM + - title: Parents/Caregivers + enum: + - PCA + - title: The Association for Child and Adolescent + Mental Health + enum: + - ACA + - title: Whole School/Institution + enum: + - WSI + FundedByOtherDesc: + type: string + description:

Free text description of who is funding the + intervention. Only populated if a Funded By of + 'Other' is selected.

+ ProvidedBy: + type: string + title: Learning Support Provided By + description: >- +

Code set denoting who can provide a learning + support intervention, e.g. who provides + co-ordination, manages the contents etc. for the + intervention.

    +
  • 'MOE' - Ministry of Education (MoE)
    • +
  • 'MOH' - Ministry of Health (MoH)
    • +
  • 'OTM' - Oranga Tamariki (OT)
    • +
  • 'DHB' - District Health Board (DHB)
    • +
  • 'EDU' - Educators
    • +
  • 'FRE' - Free Service
    • +
  • 'ACA' - The Association for Child and Adolescent Mental Health
    • +
  • 'PCA' - Parents/Caregivers
    • +
  • 'ACC' - Accident Compensation Corporation (ACC)
    • +
  • 'ASP' - ASPIRE
    • +
  • 'WSI' - Whole School/Institution
    • +
  • 'FWE' - Family/Whānau/Educators/Health Professionals
    • +
plus 1 more value(s) at NZCodeSetsLearningSupportProvidedByType + oneOf: + - title: Ministry of Education (MoE) + enum: + - MOE + - title: Ministry of Health (MoH) + enum: + - MOH + - title: Oranga Tamariki (OT) + enum: + - OTM + - title: District Health Board (DHB) + enum: + - DHB + - title: Educators + enum: + - EDU + - title: Free Service + enum: + - FRE + - title: The Association for Child and Adolescent + Mental Health + enum: + - ACA + - title: Parents/Caregivers + enum: + - PCA + - title: Accident Compensation Corporation (ACC) + enum: + - ACC + - title: ASPIRE + enum: + - ASP + - title: Whole School/Institution + enum: + - WSI + - title: Family/Whānau/Educators/Health Professionals + enum: + - FWE + - title: Ministry of Health (MoH)/District Health + Board (DHB) + enum: + - MHD + ProvidedByOtherDesc: + type: string + description:

Free text description of who is providing the + intervention. Only populated if a Provided By of + 'Other' is selected.

+ DeliveredByDesc: + type: string + description:

Free text description of who is delivered the + intervention on behalf of the Provider.

+ PreRequisiteDesc: + type: string + description:

Free text description of any pre-requisites + required before the intervention can be + implemented.

+ InterventionStatus: + type: string + title: Learning Support Intervention Status + description: >- +

Code set denoting the status of a learning + support intervention, e.g. In Development, + Active.

    +
  • 'IDV' - In Development
    • +
  • 'ACT' - Active
    • +
  • 'DIS' - Disabled
    • +
+ oneOf: + - title: In Development + enum: + - IDV + - title: Active + enum: + - ACT + - title: Disabled + enum: + - DIS + description:

Learning Support Needs are grouped by similarity. + The Learning Support Directory maps those groups to + Learning Support Interventions so when a Learning + Support Need is identified for the Student only + applicable Interventions for the group it belongs to + are presented to the user. It also holds additional + information about the Learning Support + Interventions, e.g. Description, Funded By, Provided + by.

+ x-accessControl: + create: + - 2401 + read: + - 2401 + update: + - 2401 + delete: + - 2401 + aggregate: [] + application/xml: + schema: + type: object + properties: + LearningSupportRegisterDirectorys: + type: object + description: A List of LearningSupportRegisterDirectory objects + properties: + LearningSupportRegisterDirectory: + type: array + items: + $ref: "#/paths/~1LearningSupportRegisterDirectorys/get/re\ + sponses/200/content/application~1json/schema/proper\ + ties/LearningSupportRegisterDirectorys/properties/L\ + earningSupportRegisterDirectory/items" + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/LearningSupportRegisterDirectorys/{LearningSupportRegisterDirectoryRefId}": + post: + tags: + - LearningSupportRegisterDirectory + summary: Default operation to create a single LearningSupportRegisterDirectory + parameters: + - name: LearningSupportRegisterDirectoryRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies this Learning + Support Register Directory record.

+ required: true + schema: + type: string + operationId: createLearningSupportRegisterDirectory + requestBody: + description: CRUD operation on LearningSupportRegisterDirectory + content: + application/json: + schema: + type: object + properties: + LearningSupportRegisterDirectory: + $ref: "#/paths/~1LearningSupportRegisterDirectorys/get/responses/\ + 200/content/application~1json/schema/properties/LearningSup\ + portRegisterDirectorys/properties/LearningSupportRegisterDi\ + rectory/items" + application/xml: + schema: + type: object + properties: + LearningSupportRegisterDirectory: + $ref: "#/paths/~1LearningSupportRegisterDirectorys/get/responses/\ + 200/content/application~1json/schema/properties/LearningSup\ + portRegisterDirectorys/properties/LearningSupportRegisterDi\ + rectory/items" + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - LearningSupportRegisterDirectory + summary: Default operation to update a single LearningSupportRegisterDirectory + parameters: + - name: LearningSupportRegisterDirectoryRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies this Learning + Support Register Directory record.

+ required: true + schema: + type: string + operationId: updateLearningSupportRegisterDirectory + requestBody: + description: CRUD operation on LearningSupportRegisterDirectory + content: + application/json: + schema: + type: object + properties: + LearningSupportRegisterDirectory: + type: object + properties: + LearningSupportRegisterDirectoryRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + LearningSupportRegisterDirectoryLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + AreaOfNeed: + type: string + title: Wellbeing Characteristic Category + description: >- +

Standard codes denoting the second level category of + the Wellbeing Characteristic.

    +
  • 'MAO' - Allergies - other
    • +
  • 'DIET' - Dietary Preferences
    • +
  • 'LSN-BEL' - Belonging (Participation and Contributing) - Mana whenua
    • +
  • 'LSN-COM' - Communication (Using Language and Text) - Mana reo
    • +
  • 'LSN-CON' - Contribution (Relating to Others) - Mana tangata
    • +
  • 'LSN-EXP' - Exploration (Thinking) - Mana aotūroa
    • +
  • 'LSN-WEL' - Wellbeing (Managing Self) - Mana atua
    • +
  • 'MAIM' - Auto-immune/Immune Disorders
    • +
  • 'MRD' - Respiratory Disorder
    • +
  • 'MB' - Blood disorder
    • +
  • 'MMD' - Heart Disease/ Disorder
    • +
  • 'MMS' - Musculo – skeletal conditions
    • +
plus 17 more value(s) at NZCodeSetsWellbeingCharacteristicCategoryType + oneOf: + - title: Allergies - other + enum: + - MAO + - title: Dietary Preferences + enum: + - DIET + - title*: + en: Belonging (Participation and Contributing) + mi: Mana whenua + enum: + - LSN-BEL + - title*: + en: Communication (Using Language and Text) + mi: Mana reo + enum: + - LSN-COM + - title*: + en: Contribution (Relating to Others) + mi: Mana tangata + enum: + - LSN-CON + - title*: + en: Exploration (Thinking) + mi: Mana aotūroa + enum: + - LSN-EXP + - title*: + en: Wellbeing (Managing Self) + mi: Mana atua + enum: + - LSN-WEL + - title: Auto-immune/Immune Disorders + enum: + - MAIM + - title: Respiratory Disorder + enum: + - MRD + - title: Blood disorder + enum: + - MB + - title: Heart Disease/ Disorder + enum: + - MMD + - title: Musculo – skeletal conditions + enum: + - MMS + - title: Endocrine and Metabolic Disorders + enum: + - MEM + - title: Childhood cancer + enum: + - MC + - title: Allergy – Anaphylaxis + enum: + - MAA + - title: Mental and behavioural disorders + enum: + - MH + - title: Diseases/conditions of the nervous system + enum: + - MN + - title: Seizure disorders + enum: + - MS + - title: Congenital malformations, deformations and + chromosomal abnormalities + enum: + - MCM + - title: Infectious Diseases + enum: + - MI + - title: Gastro Intestinal/Urinary conditions + enum: + - MGI + - title: Neuro/Developmental Disorders + enum: + - MND + - title: Oral/Phalangeal Disorders + enum: + - MO + - title: Deaf and Hard of Hearing + enum: + - MD + - title: Optical/ Vision Disorder + enum: + - MOP + - title: Medical Other + enum: + - M-OTHER + - title: Disability Other + enum: + - D-OTHER + - title: Special Needs Other + enum: + - S-OTHER + - title: Other + enum: + - OTHER + Need: + type: string + title: Wellbeing Characteristic Sub Category + description: >- +

Standard codes denoting the third level category of + the Wellbeing Characteristic.

    +
  • 'DIET-01' - Vegan
    • +
  • 'DIET-02' - Vegetarian
    • +
  • 'DIET-03' - Halal
    • +
  • 'DIET-04' - Kosher
    • +
  • 'DIET-05' - Pescetarian
    • +
  • 'DIET-06' - Gluten-free
    • +
  • 'LSN-ABN' - Absence
    • +
  • 'LSN-ACD' - Academic
    • +
  • 'LSN-ANX' - Anxiety
    • +
  • 'LSN-ASD' - ASD
    • +
  • 'LSN-ATT' - Attendance
    • +
  • 'LSN-AUD' - Auditory Processing
    • +
plus 121 more value(s) at NZCodeSetsWellbeingCharacteristicSubCategoryType + oneOf: + - title: Vegan + enum: + - DIET-01 + - title: Vegetarian + enum: + - DIET-02 + - title: Halal + enum: + - DIET-03 + - title: Kosher + enum: + - DIET-04 + - title: Pescetarian + enum: + - DIET-05 + - title: Gluten-free + enum: + - DIET-06 + - title: Absence + enum: + - LSN-ABN + - title: Academic + enum: + - LSN-ACD + - title: Anxiety + enum: + - LSN-ANX + - title: ASD + enum: + - LSN-ASD + - title: Attendance + enum: + - LSN-ATT + - title: Auditory Processing + enum: + - LSN-AUD + - title: Behaviour + enum: + - LSN-BHV + - title: Communication + enum: + - LSN-COM + - title: Comprehension + enum: + - LSN-CPH + - title: Dyscalculia + enum: + - LSN-DCA + - title: Developmental Delay + enum: + - LSN-DEV + - title: Dysgraphia + enum: + - LSN-DGA + - title: Dyspraxia + enum: + - LSN-DPA + - title: Dyslexia + enum: + - LSN-DSA + - title: Engagement + enum: + - LSN-ENG + - title: Epilepsy + enum: + - LSN-EPI + - title: ESOL + enum: + - LSN-ESL + - title: Focus + enum: + - LSN-FCS + - title: Fine Motor Skills + enum: + - LSN-FMS + - title: Hearing + enum: + - LSN-HRG + - title: Handwriting + enum: + - LSN-HWG + - title: Independence + enum: + - LSN-IND + - title: Intellectual Disability + enum: + - LSN-INT + - title: Literacy + enum: + - LSN-LIT + - title: Learning + enum: + - LSN-LNG + - title: Maths + enum: + - LSN-MTH + - title: Numeracy + enum: + - LSN-NUM + - title: Oral Language + enum: + - LSN-ORL + - title: ORS + enum: + - LSN-ORS + - title: Others + enum: + - LSN-OTH + - title: Physical Skills + enum: + - LSN-PHS + - title: Passive Learner + enum: + - LSN-PSL + - title: Pastoral + enum: + - LSN-PST + - title: Reading + enum: + - LSN-RDG + - title: Rate of Learning + enum: + - LSN-ROL + - title: Rate of Progress + enum: + - LSN-ROP + - title: Speech + enum: + - LSN-SPH + - title: Spelling + enum: + - LSN-SPL + - title: Social Relationships + enum: + - LSN-SRL + - title: Vision + enum: + - LSN-VIS + - title: Wellbeing + enum: + - LSN-WBG + - title: Writing + enum: + - LSN-WRT + - title: Adjustment Disorder + enum: + - MH-1 + - title: Anorexia + enum: + - MH-2 + - title: Anxiety Disorder + enum: + - MH-3 + - title: Attachment Disorder + enum: + - MH-4 + - title: Attention Deficit Hyperactivity Disorder (ADHD) + enum: + - MH-5 + - title: Bipolar Affective Disorder + enum: + - MH-6 + - title: Bulimia + enum: + - MH-7 + - title: Depression + enum: + - MH-8 + - title: Mixed Depression and Anxiety + enum: + - MH-9 + - title: Obsessive Compulsive Disorder + enum: + - MH-10 + - title: Oppositional Defiance Disorder + enum: + - MH-11 + - title: Paranoia + enum: + - MH-12 + - title: Post-Traumatic Stress Disorder + enum: + - MH-13 + - title: Reactive Attachment Disorder + enum: + - MH-14 + - title: Social Anxiety Disorder + enum: + - MH-15 + - title: Tic Disorder + enum: + - MH-16 + - title: Tourette’s Syndrome + enum: + - MH-17 + - title: Conduct Disorder + enum: + - MH-18 + - title: Absence seizures epilepsy + enum: + - MS-1 + - title: Tonic Clonic epilepsy + enum: + - MS-2 + - title: Myotonic epilepsy + enum: + - MS-3 + - title: Refractory epilepsy + enum: + - MS-4 + - title: Antibiotics -specify type(s) + enum: + - MAA-1 + - title: Dairy + enum: + - MAA-2 + - title: Egg + enum: + - MAA-3 + - title: Fruit (specify) + enum: + - MAA-4 + - title: Insect bites - nfd + enum: + - MAA-5 + - title: Bees + enum: + - MAA-6 + - title: Ants + enum: + - MAA-7 + - title: Ticks + enum: + - MAA-8 + - title: Latex + enum: + - MAA-9 + - title: Peanuts + enum: + - MAA-10 + - title: Shellfish + enum: + - MAA-11 + - title: Tree nuts + enum: + - MAA-12 + - title: Wheat + enum: + - MAA-13 + - title: Other + enum: + - MAA-14 + - title: Coeliac Disease - Gluten + enum: + - MAIM-1 + - title: Enterocolitis Syndrome + enum: + - MAIM-2 + - title: Food Protein Induced Syndrome + enum: + - MAIM-3 + - title: Anaemia + enum: + - MB-1 + - title: Haemophilia + enum: + - MB-2 + - title: Thalassemia + enum: + - MB-3 + - title: Vasculitis + enum: + - MB-4 + - title: Von Willebrand's Disease + enum: + - MB-5 + - title: Ehlers Danlos + enum: + - MMS-1 + - title: Fibromyalgia - discuss + enum: + - MMS-2 + - title: Hip Dysplasia + enum: + - MMS-3 + - title: Joint Hypermobility + enum: + - MMS-4 + - title: Juvenile Arthritis + enum: + - MMS-5 + - title: Kohlers Disease + enum: + - MMS-6 + - title: Marfan Syndrome + enum: + - MMS-7 + - title: Meyers Dysplasia + enum: + - MMS-8 + - title: Neurofibromatosis type 1 + enum: + - MMS-9 + - title: Osgood Schlatter Condition + enum: + - MMS-10 + - title: Osteo Imperfecta + enum: + - MMS-11 + - title: Scoliosis + enum: + - MMS-12 + - title: Severs Disease + enum: + - MMS-13 + - title: Talipes + enum: + - MMS-14 + - title: Von Eulenburg Disease + enum: + - MMS-15 + - title: Angelman Syndrome + enum: + - MCM-1 + - title: Charcot Marie Tooth + enum: + - MCM-2 + - title: Coffin Lowry Syndrome + enum: + - MCM-3 + - title: Coffin-Siris Syndrome + enum: + - MCM-4 + - title: Down Syndrome + enum: + - MCM-5 + - title: Foetal Alcohol Syndrome (FAS) + enum: + - MCM-6 + - title: Fragile X Syndrome + enum: + - MCM-7 + - title: G6 PD Deficiency + enum: + - MCM-8 + - title: Hyperglycemia + enum: + - MCM-9 + - title: Klinefelter Syndrome + enum: + - MCM-10 + - title: Malignant Hyperthermia + enum: + - MCM-11 + - title: MCADD - Metabolic disorder + enum: + - MCM-12 + - title: Non Ketotic + enum: + - MCM-13 + - title: Oculocutaneous Albinism + enum: + - MCM-14 + - title: Phelan-McDermid Syndrome + enum: + - MCM-15 + - title: Phenylketonuria + enum: + - MCM-16 + - title: Pierr Robyn Syndrome + enum: + - MCM-17 + - title: Potocki - Lupski Syndrome + enum: + - MCM-18 + - title: Prader Willi Syndrome + enum: + - MCM-19 + - title: Rubinstein-Taybi Syndrome + enum: + - MCM-20 + - title: ScN2A (Sodium Channel) Gene Mutation + enum: + - MCM-21 + - title: Trisomy - chromosome + enum: + - MCM-22 + - title: Trisomy 21/Down Syndrome + enum: + - MCM-23 + - title: Turners Syndrome + enum: + - MCM-24 + - title: Velocardiofacial Syndrome + enum: + - MCM-25 + - title: Wolf-Hirschhorn Syndrome + enum: + - MCM-26 + Intervention: + type: string + title: Learning Support Intervention + description: >- +

Standard codes denoting the learning support + intervention type, e.g. ESOL, First STEPs, MST.

    +
  • 'AEAC' - Alternative Education - Activity Centre
    • +
  • 'AODC' - Advisors on Deaf Children
    • +
  • 'AESA' - Alternative Education - Service Academy
    • +
  • 'AESS' - Alternative Education - Study Support Centre
    • +
  • 'AETP' - Alternative Education - Teen Parent Unit (TPU)
    • +
  • 'ACBS' - ASD Communication and Behaviour Support
    • +
  • 'ADCO' - ASD Developmental Coordination
    • +
  • 'APED' - ASD Parent Education (ASD Plus, TIPS for Autism, Growing Up With Autism)
    • +
  • 'ASDI' - ASD Specific Disability Information and Advisory Services (DIAS)
    • +
  • 'ATEQ' - Assistive Technology (AT) Equipment
    • +
  • 'ATTSC' - Attendance Services
    • +
  • 'AUME' - Autism and Me
    • +
plus 70 more value(s) at NZCodeSetsLearningSupportInterventionType + oneOf: + - title: Alternative Education - Activity Centre + enum: + - AEAC + - title: Advisors on Deaf Children + enum: + - AODC + - title: Alternative Education - Service Academy + enum: + - AESA + - title: Alternative Education - Study Support Centre + enum: + - AESS + - title: Alternative Education - Teen Parent Unit (TPU) + enum: + - AETP + - title: ASD Communication and Behaviour Support + enum: + - ACBS + - title: ASD Developmental Coordination + enum: + - ADCO + - title: ASD Parent Education (ASD Plus, TIPS for Autism, + Growing Up With Autism) + enum: + - APED + - title: ASD Specific Disability Information and Advisory + Services (DIAS) + enum: + - ASDI + - title: Assistive Technology (AT) Equipment + enum: + - ATEQ + - title: Attendance Services + enum: + - ATTSC + - title: Autism and Me + enum: + - AUME + - title: Behaviour Crisis Response + enum: + - BCRS + - title: Behaviour Services and Support + enum: + - BSAS + - title: Books and Resources + enum: + - BKRS + - title: Child and Adolescent Mental Heath Services + enum: + - CAMH + - title: Connecting Parents + enum: + - CNPA + - title: Day Special Schools + enum: + - DASS + - title: Deaf Education Centres + enum: + - DECT + - title: Diagnosis Guide + enum: + - DGDE + - title: Disability Support Service + enum: + - DSSC + - title: Early Intervention - Development Needs + enum: + - EIDN + - title: Early Intervention - Disabilities such as ASD, + Learning or Phsyical Disabilities + enum: + - EIDS + - title: Early Intervention - Social Skills + enum: + - EISS + - title: Early Intervention - ASD + enum: + - EIAS + - title: Early Intervention - Behaviour + enum: + - EIBH + - title: Early Intervention - Communication Needs + enum: + - EICN + - title: Early Intervention - Hearing + enum: + - EIHR + - title: Early Intervention - Vision + enum: + - EIVS + - title: EarlyBird + enum: + - ELBD + - title: ESOL Funding + enum: + - ESOL + - title: Expanded Core Curriculum + enum: + - EXCC + - title: Explore ASD Plus + enum: + - EASD + - title: First Signs + enum: + - FTSN + - title: Framework for Autism in New Zealand (FANZ) + enum: + - FANZ + - title: How Can We Help? + enum: + - HCWH + - title: IHC Library + enum: + - IHCL + - title: In-Class Support + enum: + - INSP + - title: "Inclusive Education: A Guide to ASD and Learning" + enum: + - IEED + - title: Individualised Training Programmes + enum: + - ITPR + - title: Information and Advice + enum: + - INAD + - title: Information Service + enum: + - ISVC + - title: Interim Response Fund (IRF) + enum: + - IRFD + - title: International Research + enum: + - INRS + - title: Learning Resources + enum: + - LRCS + - title: Maternal Infant Child and Adolescent Mental Health + Services (MICAMHS) + enum: + - MICA + - title: Needs Assessment Service Co-Ordination + enum: + - NASC + - title: Occupational Therapists + enum: + - OCTH + - title: Ongoing Resourcing Scheme (ORS) + enum: + - ORSM + - title: PB4L Check and Connect + enum: + - PCAC + - title: PB4L Huakina Mai + enum: + - PHKM + - title: PB4L Incredible Years Parent + enum: + - PIYP + - title: PB4L Incredible Years Teacher + enum: + - PIYT + - title: PB4L My FRIENDS Youth Resilience Programme + enum: + - PFYR + - title: PB4L Restorative Justice + enum: + - PRJS + - title: PB4L School-Wide + enum: + - PSCW + - title: PB4L Te Mana Tikitiki + enum: + - PTMT + - title: PB4L Wellbeing@School + enum: + - PWAS + - title: Physiotherapists + enum: + - PHYS + - title: Planning Alternative Tomorrows with Hope (PATH) + enum: + - PATH + - title: Positive Behaviour Support (PBS) Framework + enum: + - PBSF + - title: PRISM Professional Development Series + enum: + - PRSM + - title: Resource Teacher Deaf (RTD) + enum: + - RTDF + - title: Resource Teacher Lit (RTLit) + enum: + - RLIT + - title: "Resource Teachers: Learning and Behaviour Service + (RTLB)" + enum: + - RLBS + - title: SAC Assessment + enum: + - SACA + - title: School High Health Needs Fund + enum: + - SHHN + - title: SibSupportNZ + enum: + - SSNZ + - title: Social Workers in Schools (SWiS) Programme + enum: + - SWIS + - title: Specialised School Transport Assistance (SESTA) + enum: + - SSTA + - title: Speech-Language Therapists + enum: + - SLTH + - title: Support, Information and Education + enum: + - SIAE + - title: Supporting Behaviour + enum: + - SBHV + - title: Teacher Aide Support + enum: + - TASP + - title: Teaching Strategies and Resources + enum: + - TSAR + - title: Tilting the Seesaw for Teams + enum: + - TSFT + - title: Tutor + enum: + - TUTR + - title: Understanding Autism + enum: + - UAUT + - title: Way to Play + enum: + - WTPL + - title: Year 11+ Funding + enum: + - YELF + - title: Year 9+ + enum: + - YNNE + - title: Other + enum: + - OTHR + TargetAudience: + type: string + title: Learning Support Target Audience + description: >- +

Code set denoting the target audience of the learning + support intervention for the area of need.

    +
  • 'EDU' - Educators
    • +
  • 'EFW' - Educators/Family/Whānau
    • +
  • 'FWH' - Family/Whānau
    • +
  • 'FFW' - Family/Whānau/Workforce
    • +
  • 'FOG' - Organisation
    • +
  • 'PRE' - Pre-School
    • +
  • 'TFP' - Team
    • +
  • 'IST' - Individual Students
    • +
  • 'PWH' - Parents/Whānau
    • +
  • 'SWD' - School Wide
    • +
  • 'SCH' - Schools
    • +
  • 'TPR' - Targeted Programmes
    • +
+ oneOf: + - title: Educators + enum: + - EDU + - title: Educators/Family/Whānau + enum: + - EFW + - title: Family/Whānau + enum: + - FWH + - title: Family/Whānau/Workforce + description: For family/whānau, early childhood teachers, health + professionals, or anyone else living or working with + young children with autism + enum: + - FFW + - title: Organisation + description: For organisations or other groups requiring a + training or education event + enum: + - FOG + - title: Pre-School + description: For parents, whānau, and caregivers of pre-school + children + enum: + - PRE + - title: Team + description: For teams of family and professionals, working + together to support tamariki with autism aged 5-12 + years. Teams may include parents, caregivers, other + family/whānau, primary school teachers, teacher + aids, learning assistants, SENCOs or RTLBs + enum: + - TFP + - title: Individual Students + enum: + - IST + - title: Parents/Whānau + enum: + - PWH + - title: School Wide + enum: + - SWD + - title: Schools + enum: + - SCH + - title: Targeted Programmes + enum: + - TPR + Resource: + type: string + title: Learning Support Resource + description: >- +

Code set denoting the resource that is required to + support the learning support intervention in addressing + the area of need.

    +
  • 'ADC' - Advisor on Deaf Children
    • +
  • 'BSW' - Basic Sight Words Programme
    • +
  • 'BCN' - Building Confidence
    • +
  • 'CCE' - Change Classroom Environment
    • +
  • 'CCM' - Change Classroom Management
    • +
  • 'CIC' - Check In Check Out (CICO)
    • +
  • 'COF' - Circle of Friends, Intervention
    • +
  • 'CTM' - Circle TIme
    • +
  • 'CBT' - Cognitive Behaviour Therapy
    • +
  • 'CED' - Conductor in Conductive Education Programme
    • +
  • 'CSV' - Continence Service
    • +
  • 'DRP' - Daily Report
    • +
plus 34 more value(s) at NZCodeSetsLearningSupportResourceType + oneOf: + - title: Advisor on Deaf Children + enum: + - ADC + - title: Basic Sight Words Programme + enum: + - BSW + - title: Building Confidence + enum: + - BCN + - title: Change Classroom Environment + enum: + - CCE + - title: Change Classroom Management + enum: + - CCM + - title: Check In Check Out (CICO) + enum: + - CIC + - title: Circle of Friends, Intervention + enum: + - COF + - title: Circle TIme + enum: + - CTM + - title: Cognitive Behaviour Therapy + enum: + - CBT + - title: Conductor in Conductive Education Programme + enum: + - CED + - title: Continence Service + enum: + - CSV + - title: Daily Report + enum: + - DRP + - title: Differentiated Programme + enum: + - DPM + - title: District Truancy Service (DTS) + enum: + - DTS + - title: Dyslexia Screening + enum: + - DSS + - title: Educational Psychologist + enum: + - EDP + - title: Guidance Counselling + enum: + - GCG + - title: Inclusion Strategy + enum: + - IST + - title: Learning and Language Intervention (LLI) + enum: + - LLI + - title: Māori or Cultural Advisor + enum: + - MCA + - title: Music Therapist (Registered) + enum: + - MTH + - title: Non-Enrolled Truancy Service (NETS) + enum: + - NET + - title: Occupational Therapist (OT) + enum: + - OTS + - title: Orientation and Mobility Instructor + enum: + - OMT + - title: Parent Funded Tutor + enum: + - PFT + - title: Pause, Prompt, Praise (PPP) + enum: + - PPP + - title: Peer Tutor + enum: + - PTR + - title: Phonics Programme + enum: + - PPR + - title: Psychologist + enum: + - PSY + - title: Physiotherapist + enum: + - PHY + - title: Proximal Praise + enum: + - PXP + - title: Quick 60 Intervention + enum: + - QKI + - title: Reading Recovery + enum: + - RRC + - title: Regular Home/School Meetings + enum: + - RHS + - title: RTLB Resource Teacher + enum: + - RTL + - title: Safety Strategy + enum: + - SSG + - title: Sign Language Interpreter + enum: + - SLI + - title: Social Skills Intervention + enum: + - SSI + - title: Social Worker in School (SWIS) + enum: + - SWS + - title: Special Education Advisor + enum: + - SEA + - title: Specialist Teacher Outreach + enum: + - STO + - title: Speech Language Therapist + enum: + - SLT + - title: Teacher Aide Support + enum: + - TAS + - title: Teacher with additional tertiary qualifications in + learning, vision or hearing + enum: + - TWA + - title: Transition Strategy + enum: + - TSG + - title: Visual Prompts/Strategies + enum: + - VPS + ResourcesOtherDesc: + type: string + description:

Free text description describing the resources + required for the intervention. Only populated if a + Resource of 'Other' is selected.

+ FundedBy: + type: string + title: Learning Support Funded By + description: >- +

Code set denoting who can fund a learning support + intervention, i.e. who provides co-ordination, manages + the contents etc. for the intervention.

    +
  • 'ACC' - Accident Compensation Corporation (ACC)
    • +
  • 'ASP' - ASPIRE
    • +
  • 'DHB' - District Health Board (DHB)
    • +
  • 'EDU' - Educators
    • +
  • 'FWH' - Family/Whānau/Educators/Health Professionals
    • +
  • 'FRE' - Free Service
    • +
  • 'MOE' - Ministry of Education (MoE)
    • +
  • 'MOH' - Ministry of Health (MoH)
    • +
  • 'MHD' - Ministry of Health (MoH)/District Health Board (DHB)
    • +
  • 'OTM' - Oranga Tamariki (OT)
    • +
  • 'PCA' - Parents/Caregivers
    • +
  • 'ACA' - The Association for Child and Adolescent Mental Health
    • +
plus 1 more value(s) at NZCodeSetsLearningSupportFundedByType + oneOf: + - title: Accident Compensation Corporation (ACC) + enum: + - ACC + - title: ASPIRE + enum: + - ASP + - title: District Health Board (DHB) + enum: + - DHB + - title: Educators + enum: + - EDU + - title: Family/Whānau/Educators/Health Professionals + enum: + - FWH + - title: Free Service + enum: + - FRE + - title: Ministry of Education (MoE) + enum: + - MOE + - title: Ministry of Health (MoH) + enum: + - MOH + - title: Ministry of Health (MoH)/District Health Board (DHB) + enum: + - MHD + - title: Oranga Tamariki (OT) + enum: + - OTM + - title: Parents/Caregivers + enum: + - PCA + - title: The Association for Child and Adolescent Mental + Health + enum: + - ACA + - title: Whole School/Institution + enum: + - WSI + FundedByOtherDesc: + type: string + description:

Free text description of who is funding the + intervention. Only populated if a Funded By of 'Other' + is selected.

+ ProvidedBy: + type: string + title: Learning Support Provided By + description: >- +

Code set denoting who can provide a learning support + intervention, e.g. who provides co-ordination, manages + the contents etc. for the intervention.

    +
  • 'MOE' - Ministry of Education (MoE)
    • +
  • 'MOH' - Ministry of Health (MoH)
    • +
  • 'OTM' - Oranga Tamariki (OT)
    • +
  • 'DHB' - District Health Board (DHB)
    • +
  • 'EDU' - Educators
    • +
  • 'FRE' - Free Service
    • +
  • 'ACA' - The Association for Child and Adolescent Mental Health
    • +
  • 'PCA' - Parents/Caregivers
    • +
  • 'ACC' - Accident Compensation Corporation (ACC)
    • +
  • 'ASP' - ASPIRE
    • +
  • 'WSI' - Whole School/Institution
    • +
  • 'FWE' - Family/Whānau/Educators/Health Professionals
    • +
plus 1 more value(s) at NZCodeSetsLearningSupportProvidedByType + oneOf: + - title: Ministry of Education (MoE) + enum: + - MOE + - title: Ministry of Health (MoH) + enum: + - MOH + - title: Oranga Tamariki (OT) + enum: + - OTM + - title: District Health Board (DHB) + enum: + - DHB + - title: Educators + enum: + - EDU + - title: Free Service + enum: + - FRE + - title: The Association for Child and Adolescent Mental + Health + enum: + - ACA + - title: Parents/Caregivers + enum: + - PCA + - title: Accident Compensation Corporation (ACC) + enum: + - ACC + - title: ASPIRE + enum: + - ASP + - title: Whole School/Institution + enum: + - WSI + - title: Family/Whānau/Educators/Health Professionals + enum: + - FWE + - title: Ministry of Health (MoH)/District Health Board (DHB) + enum: + - MHD + ProvidedByOtherDesc: + type: string + description:

Free text description of who is providing the + intervention. Only populated if a Provided By of 'Other' + is selected.

+ DeliveredByDesc: + type: string + description:

Free text description of who is delivered the + intervention on behalf of the Provider.

+ PreRequisiteDesc: + type: string + description:

Free text description of any pre-requisites required + before the intervention can be implemented.

+ InterventionStatus: + type: string + title: Learning Support Intervention Status + description: >- +

Code set denoting the status of a learning support + intervention, e.g. In Development, Active.

    +
  • 'IDV' - In Development
    • +
  • 'ACT' - Active
    • +
  • 'DIS' - Disabled
    • +
+ oneOf: + - title: In Development + enum: + - IDV + - title: Active + enum: + - ACT + - title: Disabled + enum: + - DIS + description:

Learning Support Needs are grouped by similarity. The + Learning Support Directory maps those groups to Learning + Support Interventions so when a Learning Support Need is + identified for the Student only applicable Interventions for + the group it belongs to are presented to the user. It also + holds additional information about the Learning Support + Interventions, e.g. Description, Funded By, Provided by. +

+ x-accessControl: + create: + - 2401 + read: + - 2401 + update: + - 2401 + delete: + - 2401 + aggregate: [] + application/xml: + schema: + type: object + properties: + LearningSupportRegisterDirectory: + $ref: "#/paths/~1LearningSupportRegisterDirectorys~1%7BLearningSu\ + pportRegisterDirectoryRefId%7D/put/requestBody/content/appl\ + ication~1json/schema/properties/LearningSupportRegisterDire\ + ctory" + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - LearningSupportRegisterDirectory + summary: Default operation to get a single LearningSupportRegisterDirectory + parameters: + - name: LearningSupportRegisterDirectoryRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies this Learning + Support Register Directory record.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + LearningSupportRegisterDirectory: + $ref: "#/paths/~1LearningSupportRegisterDirectorys/get/response\ + s/200/content/application~1json/schema/properties/Learnin\ + gSupportRegisterDirectorys/properties/LearningSupportRegi\ + sterDirectory/items" + application/xml: + schema: + type: object + properties: + LearningSupportRegisterDirectory: + $ref: "#/paths/~1LearningSupportRegisterDirectorys/get/response\ + s/200/content/application~1json/schema/properties/Learnin\ + gSupportRegisterDirectorys/properties/LearningSupportRegi\ + sterDirectory/items" + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - LearningSupportRegisterDirectory + summary: Default operation to delete a single LearningSupportRegisterDirectory + parameters: + - name: LearningSupportRegisterDirectoryRefId + in: path + description:

Unique identifier (GUID) that uniquely identifies this Learning + Support Register Directory record.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentLearningSupportParticipations: + get: + tags: + - StudentLearningSupportParticipation + summary: Default operation to get a list of all available + StudentLearningSupportParticipations + description: Search the set of available StudentLearningSupportParticipations, + according to the search criteria in the URL parameters. Returns the + first 20 objects located; with SIF defined navigation headers, + indicating how to retrieve subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentLearningSupportParticipations: + type: object + description: A List of StudentLearningSupportParticipation objects + properties: + StudentLearningSupportParticipation: + type: array + items: + required: + - Student + type: object + properties: + StudentLearningSupportParticipationRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentLearningSupportParticipationLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentLearningSupportParticipat\ + ions/get/responses/200/content/application~\ + 1json/schema/properties/StudentLearningSupp\ + ortParticipations/properties/StudentLearnin\ + gSupportParticipation/items/properties/Stud\ + entLearningSupportParticipationRefId" + LocalId: + $ref: "#/paths/~1StudentLearningSupportParticipat\ + ions/get/responses/200/content/application~\ + 1json/schema/properties/StudentLearningSupp\ + ortParticipations/properties/StudentLearnin\ + gSupportParticipation/items/properties/Stud\ + entLearningSupportParticipationLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + AssignedTo: + $ref: "#/paths/~1StudentLearningSupportParticipations\ + /get/responses/200/content/application~1json/sc\ + hema/properties/StudentLearningSupportParticipa\ + tions/properties/StudentLearningSupportParticip\ + ation/items/properties/Student" + CompletedDate: + type: string + format: date + description:

The date the student's participation in the + learning support intervention is considered + complete.

+ FundApprovedDate: + type: string + format: date + description:

The date the learning support participation + record for the student was created in the source + system.

+ RequestSentToAgencyDate: + type: string + format: date + description:

The date the learning support participation + request was sent to the agency providing the + intervention.

+ ParticipationStartDate: + type: string + format: date + description:

The date the student started participating in + the learning support.

+ ParticipationEndDate: + type: string + format: date + description:

The date the student stopped participating in + the learning support.

+ ParticipationNote: + type: string + description:

Free text note pertaining to the student's + learning support participation.

+ PermissionEndDate: + type: string + format: date + description:

The date the permission for learning support + ended or was revoked, if provided, by the + student's parent/caregiver.

+ PermissionStartDate: + type: string + format: date + description:

The date the permission for learning support + was provided or was declined by the student's + parent/caregiver.

+ PermissionToParticipate: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + WellbeingCharacteristicList: + description:

A list of wellbeing characteristics that + require learning support.

+ type: object + required: + - WellbeingCharacteristic + properties: + WellbeingCharacteristic: + type: array + items: + $ref: "#/paths/~1StudentLearningSupportParticip\ + ations/get/responses/200/content/applicat\ + ion~1json/schema/properties/StudentLearni\ + ngSupportParticipations/properties/Studen\ + tLearningSupportParticipation/items/prope\ + rties/Student" + LearningSupportIntervention: + type: string + title: Learning Support Intervention + description: >- +

Standard codes denoting the learning support + intervention type, e.g. ESOL, First STEPs, + MST.

    +
  • 'AEAC' - Alternative Education - Activity Centre
    • +
  • 'AODC' - Advisors on Deaf Children
    • +
  • 'AESA' - Alternative Education - Service Academy
    • +
  • 'AESS' - Alternative Education - Study Support Centre
    • +
  • 'AETP' - Alternative Education - Teen Parent Unit (TPU)
    • +
  • 'ACBS' - ASD Communication and Behaviour Support
    • +
  • 'ADCO' - ASD Developmental Coordination
    • +
  • 'APED' - ASD Parent Education (ASD Plus, TIPS for Autism, Growing Up With Autism)
    • +
  • 'ASDI' - ASD Specific Disability Information and Advisory Services (DIAS)
    • +
  • 'ATEQ' - Assistive Technology (AT) Equipment
    • +
  • 'ATTSC' - Attendance Services
    • +
  • 'AUME' - Autism and Me
    • +
plus 70 more value(s) at NZCodeSetsLearningSupportInterventionType + oneOf: + - title: Alternative Education - Activity Centre + enum: + - AEAC + - title: Advisors on Deaf Children + enum: + - AODC + - title: Alternative Education - Service Academy + enum: + - AESA + - title: Alternative Education - Study Support Centre + enum: + - AESS + - title: Alternative Education - Teen Parent Unit + (TPU) + enum: + - AETP + - title: ASD Communication and Behaviour Support + enum: + - ACBS + - title: ASD Developmental Coordination + enum: + - ADCO + - title: ASD Parent Education (ASD Plus, TIPS for + Autism, Growing Up With Autism) + enum: + - APED + - title: ASD Specific Disability Information and + Advisory Services (DIAS) + enum: + - ASDI + - title: Assistive Technology (AT) Equipment + enum: + - ATEQ + - title: Attendance Services + enum: + - ATTSC + - title: Autism and Me + enum: + - AUME + - title: Behaviour Crisis Response + enum: + - BCRS + - title: Behaviour Services and Support + enum: + - BSAS + - title: Books and Resources + enum: + - BKRS + - title: Child and Adolescent Mental Heath Services + enum: + - CAMH + - title: Connecting Parents + enum: + - CNPA + - title: Day Special Schools + enum: + - DASS + - title: Deaf Education Centres + enum: + - DECT + - title: Diagnosis Guide + enum: + - DGDE + - title: Disability Support Service + enum: + - DSSC + - title: Early Intervention - Development Needs + enum: + - EIDN + - title: Early Intervention - Disabilities such as + ASD, Learning or Phsyical Disabilities + enum: + - EIDS + - title: Early Intervention - Social Skills + enum: + - EISS + - title: Early Intervention - ASD + enum: + - EIAS + - title: Early Intervention - Behaviour + enum: + - EIBH + - title: Early Intervention - Communication Needs + enum: + - EICN + - title: Early Intervention - Hearing + enum: + - EIHR + - title: Early Intervention - Vision + enum: + - EIVS + - title: EarlyBird + enum: + - ELBD + - title: ESOL Funding + enum: + - ESOL + - title: Expanded Core Curriculum + enum: + - EXCC + - title: Explore ASD Plus + enum: + - EASD + - title: First Signs + enum: + - FTSN + - title: Framework for Autism in New Zealand (FANZ) + enum: + - FANZ + - title: How Can We Help? + enum: + - HCWH + - title: IHC Library + enum: + - IHCL + - title: In-Class Support + enum: + - INSP + - title: "Inclusive Education: A Guide to ASD and + Learning" + enum: + - IEED + - title: Individualised Training Programmes + enum: + - ITPR + - title: Information and Advice + enum: + - INAD + - title: Information Service + enum: + - ISVC + - title: Interim Response Fund (IRF) + enum: + - IRFD + - title: International Research + enum: + - INRS + - title: Learning Resources + enum: + - LRCS + - title: Maternal Infant Child and Adolescent Mental + Health Services (MICAMHS) + enum: + - MICA + - title: Needs Assessment Service Co-Ordination + enum: + - NASC + - title: Occupational Therapists + enum: + - OCTH + - title: Ongoing Resourcing Scheme (ORS) + enum: + - ORSM + - title: PB4L Check and Connect + enum: + - PCAC + - title: PB4L Huakina Mai + enum: + - PHKM + - title: PB4L Incredible Years Parent + enum: + - PIYP + - title: PB4L Incredible Years Teacher + enum: + - PIYT + - title: PB4L My FRIENDS Youth Resilience Programme + enum: + - PFYR + - title: PB4L Restorative Justice + enum: + - PRJS + - title: PB4L School-Wide + enum: + - PSCW + - title: PB4L Te Mana Tikitiki + enum: + - PTMT + - title: PB4L Wellbeing@School + enum: + - PWAS + - title: Physiotherapists + enum: + - PHYS + - title: Planning Alternative Tomorrows with Hope + (PATH) + enum: + - PATH + - title: Positive Behaviour Support (PBS) Framework + enum: + - PBSF + - title: PRISM Professional Development Series + enum: + - PRSM + - title: Resource Teacher Deaf (RTD) + enum: + - RTDF + - title: Resource Teacher Lit (RTLit) + enum: + - RLIT + - title: "Resource Teachers: Learning and Behaviour + Service (RTLB)" + enum: + - RLBS + - title: SAC Assessment + enum: + - SACA + - title: School High Health Needs Fund + enum: + - SHHN + - title: SibSupportNZ + enum: + - SSNZ + - title: Social Workers in Schools (SWiS) Programme + enum: + - SWIS + - title: Specialised School Transport Assistance + (SESTA) + enum: + - SSTA + - title: Speech-Language Therapists + enum: + - SLTH + - title: Support, Information and Education + enum: + - SIAE + - title: Supporting Behaviour + enum: + - SBHV + - title: Teacher Aide Support + enum: + - TASP + - title: Teaching Strategies and Resources + enum: + - TSAR + - title: Tilting the Seesaw for Teams + enum: + - TSFT + - title: Tutor + enum: + - TUTR + - title: Understanding Autism + enum: + - UAUT + - title: Way to Play + enum: + - WTPL + - title: Year 11+ Funding + enum: + - YELF + - title: Year 9+ + enum: + - YNNE + - title: Other + enum: + - OTHR + InterventionOutcome: + type: string + title: Learning Support Intervention Outcome + description: >- +

Code set denoting the possible outcomes of a + student's participation on a learning support + intervention.

    +
  • 'FIR' - Further Intervention Required
    • +
  • 'OAC' - Outcome Achieved
    • +
+ oneOf: + - title: Further Intervention Required + enum: + - FIR + - title: Outcome Achieved + enum: + - OAC + LearningSupportType: + type: string + title: Learning Support Type + description: >- +

Standard codes denoting the type of learning + support, e.g. Fund, Programme, Service.

    +
  • 'FUN' - Fund
    • +
  • 'PRO' - Programme
    • +
  • 'SER' - Service
    • +
  • 'APP' - Approach
    • +
  • 'SUP' - Support Group
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Fund + enum: + - FUN + - title: Programme + enum: + - PRO + - title: Service + enum: + - SER + - title: Approach + enum: + - APP + - title: Support Group + enum: + - SUP + - title: Other + enum: + - OTH + LearningSupportTypeOtherDesc: + type: string + description:

Free text description of the learning support + type that is being provided to the student. Only + populated if a Learning of Support Type of + 'Other' is selected.

+ ProvidedBy: + type: string + title: Learning Support Provided By + description: >- +

Code set denoting who can provide a learning + support intervention, e.g. who provides + co-ordination, manages the contents etc. for the + intervention.

    +
  • 'MOE' - Ministry of Education (MoE)
    • +
  • 'MOH' - Ministry of Health (MoH)
    • +
  • 'OTM' - Oranga Tamariki (OT)
    • +
  • 'DHB' - District Health Board (DHB)
    • +
  • 'EDU' - Educators
    • +
  • 'FRE' - Free Service
    • +
  • 'ACA' - The Association for Child and Adolescent Mental Health
    • +
  • 'PCA' - Parents/Caregivers
    • +
  • 'ACC' - Accident Compensation Corporation (ACC)
    • +
  • 'ASP' - ASPIRE
    • +
  • 'WSI' - Whole School/Institution
    • +
  • 'FWE' - Family/Whānau/Educators/Health Professionals
    • +
plus 1 more value(s) at NZCodeSetsLearningSupportProvidedByType + oneOf: + - title: Ministry of Education (MoE) + enum: + - MOE + - title: Ministry of Health (MoH) + enum: + - MOH + - title: Oranga Tamariki (OT) + enum: + - OTM + - title: District Health Board (DHB) + enum: + - DHB + - title: Educators + enum: + - EDU + - title: Free Service + enum: + - FRE + - title: The Association for Child and Adolescent + Mental Health + enum: + - ACA + - title: Parents/Caregivers + enum: + - PCA + - title: Accident Compensation Corporation (ACC) + enum: + - ACC + - title: ASPIRE + enum: + - ASP + - title: Whole School/Institution + enum: + - WSI + - title: Family/Whānau/Educators/Health Professionals + enum: + - FWE + - title: Ministry of Health (MoH)/District Health + Board (DHB) + enum: + - MHD + ParticipationStatus: + type: string + title: Learning Support Participation Status + description: >- +

Code set denoting the status of the learning + support participation.

    +
  • 'WAI' - Waiting
    • +
  • 'ACT' - Active
    • +
  • 'COM' - Completed
    • +
  • 'DEC' - Declined
    • +
  • 'ONH' - On-Hold
    • +
  • 'DNC' - Did Not Complete
    • +
+ oneOf: + - title: Waiting + enum: + - WAI + - title: Active + enum: + - ACT + - title: Completed + enum: + - COM + - title: Declined + enum: + - DEC + - title: On-Hold + enum: + - ONH + - title: Did Not Complete + enum: + - DNC + ReviewList: + description:

A list of reviews made in regards to the + student's learning support participation.

+ type: object + required: + - Review + properties: + Review: + type: array + items: + description:

A review made in regards to the + student's learning support + participation.

+ type: object + required: + - ReviewDate + - ReviewNote + properties: + ReviewDate: + type: string + format: date + description:

The date the review was made of the + student's learning support + participation.

+ ReviewNote: + type: string + description:

Free text comment about a review + that was made of the student's + learning support participation.

+ DocumentList: + description:

A list of the documents associated the + student's learning support participation.

+ type: object + required: + - Document + properties: + Document: + type: array + items: + $ref: "#/paths/~1StudentLearningSupportParticip\ + ations/get/responses/200/content/applicat\ + ion~1json/schema/properties/StudentLearni\ + ngSupportParticipations/properties/Studen\ + tLearningSupportParticipation/items/prope\ + rties/Student" + CreatedBy: + $ref: "#/paths/~1StudentLearningSupportParticipations\ + /get/responses/200/content/application~1json/sc\ + hema/properties/StudentLearningSupportParticipa\ + tions/properties/StudentLearningSupportParticip\ + ation/items/properties/Student" + LastUpdatedBy: + $ref: "#/paths/~1StudentLearningSupportParticipations\ + /get/responses/200/content/application~1json/sc\ + hema/properties/StudentLearningSupportParticipa\ + tions/properties/StudentLearningSupportParticip\ + ation/items/properties/Student" + CreatedDate: + type: string + format: date + description:

The date the learning support participation + record for the student was created in the source + system.

+ LastUpdatedDate: + type: string + format: date + description:

The date the learning support participation + record for the student was last updated in the + source system.

+ description:

Contains information pertaining to a student's + participation in learning support.

+ x-accessControl: + create: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + read: + - 1001 + - 1306 + - 2101 + - 2103 + - 2401 + - 2403 + update: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StudentLearningSupportParticipations: + StudentLearningSupportParticipation: + - StudentLearningSupportParticipationRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + application/xml: + schema: + type: object + properties: + StudentLearningSupportParticipations: + type: object + description: A List of StudentLearningSupportParticipation objects + properties: + StudentLearningSupportParticipation: + type: array + items: + $ref: "#/paths/~1StudentLearningSupportParticipations/get\ + /responses/200/content/application~1json/schema/pro\ + perties/StudentLearningSupportParticipations/proper\ + ties/StudentLearningSupportParticipation/items" + example: >- + + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentLearningSupportParticipations/{StudentLearningSupportParticipationRefId}": + post: + tags: + - StudentLearningSupportParticipation + summary: Default operation to create a single StudentLearningSupportParticipation + parameters: + - name: StudentLearningSupportParticipationRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Student Learning + Support Participation record.

+ required: true + schema: + type: string + operationId: createStudentLearningSupportParticipation + requestBody: + description: CRUD operation on StudentLearningSupportParticipation + content: + application/json: + schema: + type: object + properties: + StudentLearningSupportParticipation: + $ref: "#/paths/~1StudentLearningSupportParticipations/get/respons\ + es/200/content/application~1json/schema/properties/StudentL\ + earningSupportParticipations/properties/StudentLearningSupp\ + ortParticipation/items" + example: + StudentLearningSupportParticipation: + StudentLearningSupportParticipationRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + application/xml: + schema: + type: object + properties: + StudentLearningSupportParticipation: + $ref: "#/paths/~1StudentLearningSupportParticipations/get/respons\ + es/200/content/application~1json/schema/properties/StudentL\ + earningSupportParticipations/properties/StudentLearningSupp\ + ortParticipation/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentLearningSupportParticipation + summary: Default operation to update a single StudentLearningSupportParticipation + parameters: + - name: StudentLearningSupportParticipationRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Student Learning + Support Participation record.

+ required: true + schema: + type: string + operationId: updateStudentLearningSupportParticipation + requestBody: + description: CRUD operation on StudentLearningSupportParticipation + content: + application/json: + schema: + type: object + properties: + StudentLearningSupportParticipation: + type: object + properties: + StudentLearningSupportParticipationRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentLearningSupportParticipationLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentLearningSupportParticipations~1%7\ + BStudentLearningSupportParticipationRefId%7D/put/re\ + questBody/content/application~1json/schema/properti\ + es/StudentLearningSupportParticipation/properties/S\ + tudentLearningSupportParticipationRefId" + LocalId: + $ref: "#/paths/~1StudentLearningSupportParticipations~1%7\ + BStudentLearningSupportParticipationRefId%7D/put/re\ + questBody/content/application~1json/schema/properti\ + es/StudentLearningSupportParticipation/properties/S\ + tudentLearningSupportParticipationLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + AssignedTo: + $ref: "#/paths/~1StudentLearningSupportParticipations~1%7BStu\ + dentLearningSupportParticipationRefId%7D/put/requestBod\ + y/content/application~1json/schema/properties/StudentLe\ + arningSupportParticipation/properties/Student" + CompletedDate: + type: string + format: date + description:

The date the student's participation in the learning + support intervention is considered complete.

+ FundApprovedDate: + type: string + format: date + description:

The date the learning support participation record + for the student was created in the source system.

+ RequestSentToAgencyDate: + type: string + format: date + description:

The date the learning support participation request + was sent to the agency providing the intervention.

+ ParticipationStartDate: + type: string + format: date + description:

The date the student started participating in the + learning support.

+ ParticipationEndDate: + type: string + format: date + description:

The date the student stopped participating in the + learning support.

+ ParticipationNote: + type: string + description:

Free text note pertaining to the student's learning + support participation.

+ PermissionEndDate: + type: string + format: date + description:

The date the permission for learning support ended or + was revoked, if provided, by the student's + parent/caregiver.

+ PermissionStartDate: + type: string + format: date + description:

The date the permission for learning support was + provided or was declined by the student's + parent/caregiver.

+ PermissionToParticipate: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + WellbeingCharacteristicList: + description:

A list of wellbeing characteristics that require + learning support.

+ type: object + properties: + WellbeingCharacteristic: + type: array + items: + $ref: "#/paths/~1StudentLearningSupportParticipations~1\ + %7BStudentLearningSupportParticipationRefId%7D/pu\ + t/requestBody/content/application~1json/schema/pr\ + operties/StudentLearningSupportParticipation/prop\ + erties/Student" + LearningSupportIntervention: + type: string + title: Learning Support Intervention + description: >- +

Standard codes denoting the learning support + intervention type, e.g. ESOL, First STEPs, MST.

    +
  • 'AEAC' - Alternative Education - Activity Centre
    • +
  • 'AODC' - Advisors on Deaf Children
    • +
  • 'AESA' - Alternative Education - Service Academy
    • +
  • 'AESS' - Alternative Education - Study Support Centre
    • +
  • 'AETP' - Alternative Education - Teen Parent Unit (TPU)
    • +
  • 'ACBS' - ASD Communication and Behaviour Support
    • +
  • 'ADCO' - ASD Developmental Coordination
    • +
  • 'APED' - ASD Parent Education (ASD Plus, TIPS for Autism, Growing Up With Autism)
    • +
  • 'ASDI' - ASD Specific Disability Information and Advisory Services (DIAS)
    • +
  • 'ATEQ' - Assistive Technology (AT) Equipment
    • +
  • 'ATTSC' - Attendance Services
    • +
  • 'AUME' - Autism and Me
    • +
plus 70 more value(s) at NZCodeSetsLearningSupportInterventionType + oneOf: + - title: Alternative Education - Activity Centre + enum: + - AEAC + - title: Advisors on Deaf Children + enum: + - AODC + - title: Alternative Education - Service Academy + enum: + - AESA + - title: Alternative Education - Study Support Centre + enum: + - AESS + - title: Alternative Education - Teen Parent Unit (TPU) + enum: + - AETP + - title: ASD Communication and Behaviour Support + enum: + - ACBS + - title: ASD Developmental Coordination + enum: + - ADCO + - title: ASD Parent Education (ASD Plus, TIPS for Autism, + Growing Up With Autism) + enum: + - APED + - title: ASD Specific Disability Information and Advisory + Services (DIAS) + enum: + - ASDI + - title: Assistive Technology (AT) Equipment + enum: + - ATEQ + - title: Attendance Services + enum: + - ATTSC + - title: Autism and Me + enum: + - AUME + - title: Behaviour Crisis Response + enum: + - BCRS + - title: Behaviour Services and Support + enum: + - BSAS + - title: Books and Resources + enum: + - BKRS + - title: Child and Adolescent Mental Heath Services + enum: + - CAMH + - title: Connecting Parents + enum: + - CNPA + - title: Day Special Schools + enum: + - DASS + - title: Deaf Education Centres + enum: + - DECT + - title: Diagnosis Guide + enum: + - DGDE + - title: Disability Support Service + enum: + - DSSC + - title: Early Intervention - Development Needs + enum: + - EIDN + - title: Early Intervention - Disabilities such as ASD, + Learning or Phsyical Disabilities + enum: + - EIDS + - title: Early Intervention - Social Skills + enum: + - EISS + - title: Early Intervention - ASD + enum: + - EIAS + - title: Early Intervention - Behaviour + enum: + - EIBH + - title: Early Intervention - Communication Needs + enum: + - EICN + - title: Early Intervention - Hearing + enum: + - EIHR + - title: Early Intervention - Vision + enum: + - EIVS + - title: EarlyBird + enum: + - ELBD + - title: ESOL Funding + enum: + - ESOL + - title: Expanded Core Curriculum + enum: + - EXCC + - title: Explore ASD Plus + enum: + - EASD + - title: First Signs + enum: + - FTSN + - title: Framework for Autism in New Zealand (FANZ) + enum: + - FANZ + - title: How Can We Help? + enum: + - HCWH + - title: IHC Library + enum: + - IHCL + - title: In-Class Support + enum: + - INSP + - title: "Inclusive Education: A Guide to ASD and Learning" + enum: + - IEED + - title: Individualised Training Programmes + enum: + - ITPR + - title: Information and Advice + enum: + - INAD + - title: Information Service + enum: + - ISVC + - title: Interim Response Fund (IRF) + enum: + - IRFD + - title: International Research + enum: + - INRS + - title: Learning Resources + enum: + - LRCS + - title: Maternal Infant Child and Adolescent Mental Health + Services (MICAMHS) + enum: + - MICA + - title: Needs Assessment Service Co-Ordination + enum: + - NASC + - title: Occupational Therapists + enum: + - OCTH + - title: Ongoing Resourcing Scheme (ORS) + enum: + - ORSM + - title: PB4L Check and Connect + enum: + - PCAC + - title: PB4L Huakina Mai + enum: + - PHKM + - title: PB4L Incredible Years Parent + enum: + - PIYP + - title: PB4L Incredible Years Teacher + enum: + - PIYT + - title: PB4L My FRIENDS Youth Resilience Programme + enum: + - PFYR + - title: PB4L Restorative Justice + enum: + - PRJS + - title: PB4L School-Wide + enum: + - PSCW + - title: PB4L Te Mana Tikitiki + enum: + - PTMT + - title: PB4L Wellbeing@School + enum: + - PWAS + - title: Physiotherapists + enum: + - PHYS + - title: Planning Alternative Tomorrows with Hope (PATH) + enum: + - PATH + - title: Positive Behaviour Support (PBS) Framework + enum: + - PBSF + - title: PRISM Professional Development Series + enum: + - PRSM + - title: Resource Teacher Deaf (RTD) + enum: + - RTDF + - title: Resource Teacher Lit (RTLit) + enum: + - RLIT + - title: "Resource Teachers: Learning and Behaviour Service + (RTLB)" + enum: + - RLBS + - title: SAC Assessment + enum: + - SACA + - title: School High Health Needs Fund + enum: + - SHHN + - title: SibSupportNZ + enum: + - SSNZ + - title: Social Workers in Schools (SWiS) Programme + enum: + - SWIS + - title: Specialised School Transport Assistance (SESTA) + enum: + - SSTA + - title: Speech-Language Therapists + enum: + - SLTH + - title: Support, Information and Education + enum: + - SIAE + - title: Supporting Behaviour + enum: + - SBHV + - title: Teacher Aide Support + enum: + - TASP + - title: Teaching Strategies and Resources + enum: + - TSAR + - title: Tilting the Seesaw for Teams + enum: + - TSFT + - title: Tutor + enum: + - TUTR + - title: Understanding Autism + enum: + - UAUT + - title: Way to Play + enum: + - WTPL + - title: Year 11+ Funding + enum: + - YELF + - title: Year 9+ + enum: + - YNNE + - title: Other + enum: + - OTHR + InterventionOutcome: + type: string + title: Learning Support Intervention Outcome + description: >- +

Code set denoting the possible outcomes of a + student's participation on a learning support + intervention.

    +
  • 'FIR' - Further Intervention Required
    • +
  • 'OAC' - Outcome Achieved
    • +
+ oneOf: + - title: Further Intervention Required + enum: + - FIR + - title: Outcome Achieved + enum: + - OAC + LearningSupportType: + type: string + title: Learning Support Type + description: >- +

Standard codes denoting the type of learning support, + e.g. Fund, Programme, Service.

    +
  • 'FUN' - Fund
    • +
  • 'PRO' - Programme
    • +
  • 'SER' - Service
    • +
  • 'APP' - Approach
    • +
  • 'SUP' - Support Group
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Fund + enum: + - FUN + - title: Programme + enum: + - PRO + - title: Service + enum: + - SER + - title: Approach + enum: + - APP + - title: Support Group + enum: + - SUP + - title: Other + enum: + - OTH + LearningSupportTypeOtherDesc: + type: string + description:

Free text description of the learning support type + that is being provided to the student. Only populated if + a Learning of Support Type of 'Other' is selected.

+ ProvidedBy: + type: string + title: Learning Support Provided By + description: >- +

Code set denoting who can provide a learning support + intervention, e.g. who provides co-ordination, manages + the contents etc. for the intervention.

    +
  • 'MOE' - Ministry of Education (MoE)
    • +
  • 'MOH' - Ministry of Health (MoH)
    • +
  • 'OTM' - Oranga Tamariki (OT)
    • +
  • 'DHB' - District Health Board (DHB)
    • +
  • 'EDU' - Educators
    • +
  • 'FRE' - Free Service
    • +
  • 'ACA' - The Association for Child and Adolescent Mental Health
    • +
  • 'PCA' - Parents/Caregivers
    • +
  • 'ACC' - Accident Compensation Corporation (ACC)
    • +
  • 'ASP' - ASPIRE
    • +
  • 'WSI' - Whole School/Institution
    • +
  • 'FWE' - Family/Whānau/Educators/Health Professionals
    • +
plus 1 more value(s) at NZCodeSetsLearningSupportProvidedByType + oneOf: + - title: Ministry of Education (MoE) + enum: + - MOE + - title: Ministry of Health (MoH) + enum: + - MOH + - title: Oranga Tamariki (OT) + enum: + - OTM + - title: District Health Board (DHB) + enum: + - DHB + - title: Educators + enum: + - EDU + - title: Free Service + enum: + - FRE + - title: The Association for Child and Adolescent Mental + Health + enum: + - ACA + - title: Parents/Caregivers + enum: + - PCA + - title: Accident Compensation Corporation (ACC) + enum: + - ACC + - title: ASPIRE + enum: + - ASP + - title: Whole School/Institution + enum: + - WSI + - title: Family/Whānau/Educators/Health Professionals + enum: + - FWE + - title: Ministry of Health (MoH)/District Health Board (DHB) + enum: + - MHD + ParticipationStatus: + type: string + title: Learning Support Participation Status + description: >- +

Code set denoting the status of the learning support + participation.

    +
  • 'WAI' - Waiting
    • +
  • 'ACT' - Active
    • +
  • 'COM' - Completed
    • +
  • 'DEC' - Declined
    • +
  • 'ONH' - On-Hold
    • +
  • 'DNC' - Did Not Complete
    • +
+ oneOf: + - title: Waiting + enum: + - WAI + - title: Active + enum: + - ACT + - title: Completed + enum: + - COM + - title: Declined + enum: + - DEC + - title: On-Hold + enum: + - ONH + - title: Did Not Complete + enum: + - DNC + ReviewList: + description:

A list of reviews made in regards to the student's + learning support participation.

+ type: object + properties: + Review: + type: array + items: + description:

A review made in regards to the student's + learning support participation.

+ type: object + properties: + ReviewDate: + type: string + format: date + description:

The date the review was made of the + student's learning support participation.

+ ReviewNote: + type: string + description:

Free text comment about a review that was + made of the student's learning support + participation.

+ DocumentList: + description:

A list of the documents associated the student's + learning support participation.

+ type: object + properties: + Document: + type: array + items: + $ref: "#/paths/~1StudentLearningSupportParticipations~1\ + %7BStudentLearningSupportParticipationRefId%7D/pu\ + t/requestBody/content/application~1json/schema/pr\ + operties/StudentLearningSupportParticipation/prop\ + erties/Student" + CreatedBy: + $ref: "#/paths/~1StudentLearningSupportParticipations~1%7BStu\ + dentLearningSupportParticipationRefId%7D/put/requestBod\ + y/content/application~1json/schema/properties/StudentLe\ + arningSupportParticipation/properties/Student" + LastUpdatedBy: + $ref: "#/paths/~1StudentLearningSupportParticipations~1%7BStu\ + dentLearningSupportParticipationRefId%7D/put/requestBod\ + y/content/application~1json/schema/properties/StudentLe\ + arningSupportParticipation/properties/Student" + CreatedDate: + type: string + format: date + description:

The date the learning support participation record + for the student was created in the source system.

+ LastUpdatedDate: + type: string + format: date + description:

The date the learning support participation record + for the student was last updated in the source + system.

+ description:

Contains information pertaining to a student's + participation in learning support.

+ x-accessControl: + create: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + read: + - 1001 + - 1306 + - 2101 + - 2103 + - 2401 + - 2403 + update: + - 1001 + - 1306 + - 2103 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: [] + example: + StudentLearningSupportParticipation: + StudentLearningSupportParticipationRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + application/xml: + schema: + type: object + properties: + StudentLearningSupportParticipation: + $ref: "#/paths/~1StudentLearningSupportParticipations~1%7BStudent\ + LearningSupportParticipationRefId%7D/put/requestBody/conten\ + t/application~1json/schema/properties/StudentLearningSuppor\ + tParticipation" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentLearningSupportParticipation + summary: Default operation to get a single StudentLearningSupportParticipation + parameters: + - name: StudentLearningSupportParticipationRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Student Learning + Support Participation record.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentLearningSupportParticipation: + $ref: "#/paths/~1StudentLearningSupportParticipations/get/respo\ + nses/200/content/application~1json/schema/properties/Stud\ + entLearningSupportParticipations/properties/StudentLearni\ + ngSupportParticipation/items" + example: + StudentLearningSupportParticipation: + StudentLearningSupportParticipationRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + application/xml: + schema: + type: object + properties: + StudentLearningSupportParticipation: + $ref: "#/paths/~1StudentLearningSupportParticipations/get/respo\ + nses/200/content/application~1json/schema/properties/Stud\ + entLearningSupportParticipations/properties/StudentLearni\ + ngSupportParticipation/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentLearningSupportParticipation + summary: Default operation to delete a single StudentLearningSupportParticipation + parameters: + - name: StudentLearningSupportParticipationRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Student Learning + Support Participation record.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /AssessmentTasks: + get: + tags: + - AssessmentTask + summary: Default operation to get a list of all available AssessmentTasks + description: Search the set of available AssessmentTasks, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + AssessmentTasks: + type: object + description: A List of AssessmentTask objects + properties: + AssessmentTask: + type: array + items: + required: + - AssessmentName + - ProviderInvolvedList + type: object + properties: + AssessmentTaskRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + AssessmentTaskLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + AssessmentName: + type: string + description:

The name of the assessment task.

+ ProviderInvolvedList: + description:

A list of the providers involved and their + role, e.g. assessing provider, assessment + provider, assessment location provider, + registering provider.

+ type: object + required: + - ProviderInvolved + properties: + ProviderInvolved: + type: array + items: + description:

The provider involved with the + assessment task and the role they play, + e.g. assessing provider, assessment + location provider, assessment provider, + registering provider.

+ type: object + required: + - ObjectType + - ProviderRole + properties: + ProviderRole: + type: string + title: Assessment Provider Role + description: >- +

Code set denoting the role of the + provider in the assessment, e.g. + Assessing Provider, Location + Provider.

    +
  • 'ASR' - Assessor
    • +
  • 'LOC' - Location Provider
    • +
  • 'PRO' - Provider
    • +
+ oneOf: + - title: Assessor + enum: + - ASR + - title: Location Provider + enum: + - LOC + - title: Provider + enum: + - PRO + TeachingGroup: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1AssessmentTasks/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/AssessmentTasks/properties/AssessmentTas\ + k/items/properties/AssessmentTaskRefId" + LocalId: + $ref: "#/paths/~1AssessmentTasks/get/responses/20\ + 0/content/application~1json/schema/properti\ + es/AssessmentTasks/properties/AssessmentTas\ + k/items/properties/AssessmentTaskLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + ProviderCourse: + $ref: "#/paths/~1AssessmentTasks/get/responses/200/co\ + ntent/application~1json/schema/properties/Asses\ + smentTasks/properties/AssessmentTask/items/prop\ + erties/TeachingGroup" + StudentList: + description:

The GUIDs for students that are the intended + participants for this Assessement Task.

+ type: object + required: + - Student + properties: + Student: + type: array + items: + $ref: "#/paths/~1AssessmentTasks/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/AssessmentTasks/properties/Assessm\ + entTask/items/properties/TeachingGroup" + StaffInvolvedList: + description:

A list of the staff involved and their role + in relation to the assessment task, e.g. the + moderator, the marker.

+ type: object + required: + - StaffInvolved + properties: + StaffInvolved: + type: array + items: + description:

The staff member involved with the + assessment task and their role, e.g. + created the assessment task, moderator, + marker.

+ type: object + required: + - ObjectType + - StaffRole + properties: + StaffRole: + type: string + title: Assessment Staff Role + description: |- + +
    +
  • 'CRE' - Creator
    • +
  • 'MOD' - Moderator
    • +
  • 'ASS' - Assessor
    • +
  • 'INV' - Invigilator
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Creator + enum: + - CRE + - title: Moderator + enum: + - MOD + - title: Assessor + enum: + - ASS + - title: Invigilator + enum: + - INV + - title: Other + enum: + - OTH + GradingCategory: + type: string + description:

A particular grading category for the + assignment, used to provide grouping and type + information.

+ Description: + type: string + description:

The text-based description of the + assignment.

+ PointsPossible: + type: integer + description:

The points possible on the assignment.

+ CreatedDate: + type: string + format: date + description:

Creation date of the assignment.

+ DueDate: + type: string + format: date + description:

Date the assignment is due.

+ Weight: + description:

The weight of the assignment.

+ MaxAttemptsAllowed: + type: integer + description:

How many attempts the student is allowed on + the assignment (applicable particularly to + online activities).

+ DetailedDescriptionURL: + type: string + format: uri + description:

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.

+ AssessmentType: + type: string + description:

Type of assessment (e.g. diagnostic vs + paedagogical).

+ LevelAssessed: + type: string + description:

Level at which assessment is aimed; may be + year level.

+ FormativeIndicator: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + SummativeIndicator: + $ref: "#/paths/~1AssessmentTasks/get/responses/200/co\ + ntent/application~1json/schema/properties/Asses\ + smentTasks/properties/AssessmentTask/items/prop\ + erties/FormativeIndicator" + AssessmentToolTypeName: + type: string + description:

The type of assessment tool used for the + assessment task.

+ AssessmentPurpose: + type: string + description:

Purpose for the assessment.

+ SubAssessmentTaskList: + type: object + required: + - SubAssessmentTask + properties: + SubAssessmentTask: + type: array + items: + $ref: "#/paths/~1AssessmentTasks/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/AssessmentTasks/properties/Assessm\ + entTask/items/properties/TeachingGroup" + description:

AssessmentTasks which this assessment task is + composed of.

+ PrerequisiteList: + description:

References to objects (Course, + LearningStandard, AssessmentTask etc.) being + prerequisite conditions to be met for + assessment.

+ type: object + required: + - Prerequisite + properties: + Prerequisite: + type: array + items: + $ref: "#/paths/~1AssessmentTasks/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/AssessmentTasks/properties/Assessm\ + entTask/items/properties/TeachingGroup" + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - GERM + - title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - INDO + - title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - JAPA + - title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - FREN + - title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - REME + - title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - ENGL + - title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - COOK + - title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + enum: + - COMM + - title: Chinese + description: Applicable to Te Marautanga o Aotearoa + enum: + - CHIN + - title: Korean + enum: + - KORE + - title: Latin + enum: + - LATI + - title: Niuean + enum: + - NIUE + - title: Other Languages + enum: + - OLAN + - title: Pacific Language Studies + enum: + - PLAN + - title: Russian + enum: + - RUSS + - title: Samoan + enum: + - SAMO + - title: Spanish + enum: + - SPAN + - title: Te Reo Māori + enum: + - MAOR + - title: Te Reo Rangatira + enum: + - RANG + - title: Tokelauan + enum: + - TOKE + - title: Tongan + enum: + - TONG + - title: English as a Second Language + enum: + - ENSL + - title: Mathematics + enum: + - MATH + - title: Mathematics with Calculus + enum: + - MATC + - title: Mathematics with Statistics + enum: + - MATS + - title: Mathematics (Remedial) + enum: + - REMM + - title: Accounting + enum: + - ACCO + - title: Science + enum: + - SCIE + - title: Agriculture / Horticulture + enum: + - AGHO + - title: Biology / Biological Science + enum: + - BIOL + - title: Chemsitry + enum: + - CHEM + - title: Earth Science / Astronomy + enum: + - EAAS + - title: Human Biology + enum: + - HUMB + - title: Physics + enum: + - PHYS + - title: Technology + enum: + - TECN + - title: Biotechnology + enum: + - BITE + - title: Computer Science / Programming + enum: + - COSC + - title: Computer Studies + enum: + - COMP + - title: Design, Drawing and Graphics + enum: + - DEST + - title: Electronics and Control + enum: + - ELTE + - title: Food Technology + enum: + - FOTE + - title: Graphics + enum: + - GRAP + - title: Information and Communication Technology + enum: + - INTE + - title: Materials Technology + enum: + - MTEC + - title: Structures and Mechanisms + enum: + - STME + - title: Test and Information Management + enum: + - TIMA + - title: Textiles / Clothing + enum: + - CLTX + - title: The Arts + enum: + - ARTA + - title: Art Design + enum: + - ARTD + - title: Art History + enum: + - ARTH + - title: Dancing + enum: + - DANC + - title: Drama + enum: + - DRAM + - title: Music / Music Studies + enum: + - MUSC + - title: Music Practical / Performance + enum: + - MUSP + - title: Painting + enum: + - ARPA + - title: Performing Arts + enum: + - APER + - title: Photography + enum: + - ARTP + - title: Printmaking + enum: + - ARPR + - title: Sculpture + enum: + - ARTS + - title: Visial Arts + enum: + - ARTC + - title: Social Studies + enum: + - SOST + - title: Classics / Classical Studies + enum: + - CLST + - title: Community Studies + enum: + - CMTY + - title: Economics + enum: + - ECON + - title: Environmental Sustainability + enum: + - SENV + - title: Geography + enum: + - GEOG + - title: History + enum: + - HIST + - title: Language and Cultural Studies + enum: + - LACU + - title: Māori Studies + enum: + - MAOS + - title: Media Studies + enum: + - MEST + - title: Other Social Sciences + enum: + - SOSC + - title: Health and Physical Education + enum: + - HEPH + - title: Health + enum: + - HEED + - title: Home Economics + enum: + - HOME + - title: Outdoor Education + enum: + - OUED + - title: Physical Education + enum: + - PHED + - title: Sports Studies + enum: + - SPOR + - title: Commerce Related + enum: + - BUSS + - title: Defence + enum: + - DEFE + - title: Equestrian + enum: + - EQUE + - title: Farming + enum: + - FARM + - title: Fishing + enum: + - FISH + - title: Forestry + enum: + - FOTY + - title: Industrial Trades + enum: + - INTR + - title: Integrated Studies + enum: + - INTS + - title: Legal / Law Related Studies + enum: + - LAWS + - title: Life Skills / Personal Development + enum: + - LIFE + - title: Religious Education / Studies + enum: + - REST + - title: Remedial Studies + enum: + - REMS + - title: Secondary Tertiary Programme + enum: + - STPR + - title: Service Trades + enum: + - SETR + - title: Special Needs Programme + enum: + - SPPR + - title: Study Skills + enum: + - STDY + - title: Transition / Pre-Employment + enum: + - TRAN + - title: Travel, Hospitality, Tourism + enum: + - THTR + YearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid + for describing Funding Year Level and Current + Year Level for a student enrolment.

+

Current Year Level indicates the year level + of the student’s class cohort and the level at + which the student spends most of their time at + school. While a student may be enrolled in + subjects at varying instructional year levels, + in relation to the student enrolment this value + represents the year level at which the student + is considered to be predominantly taught.

+

Funding Year Level measures the actual number + of years that the student has attended a school. + It provides the Ministry with a method of + counting students for funding purposes which is + independent of the way schools are organised or + the particular programme of study that a student + may undertake. Funding Year Level for most + students is based on the date they first started + school.

School Year Level is used to + indicate the instructional year levels offered + by a school, i.e. those years for which student + enrolments may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates + Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + LearningStandardList: + type: object + required: + - LearningStandard + properties: + LearningStandard: + type: array + items: + $ref: "#/paths/~1AssessmentTasks/get/responses/\ + 200/content/application~1json/schema/prop\ + erties/AssessmentTasks/properties/Assessm\ + entTask/items/properties/TeachingGroup" + description:

A list of references to LearningStandards + that will be assessed as part of this + AssessmentTask.

+ SpecialAssessmentConditionExclusionList: + description:

A list of SACs that are excluded for this + particular assessment task.

+ type: object + required: + - SpecialAssessmentCondition + properties: + SpecialAssessmentCondition: + type: array + items: + type: string + title: Special Assessment Condition + description: >- +

Standard codes denoting special + assessment conditions that a student + requires when sitting an assessment.

+
    +
  • 'BRA' - Braille Paper
    • +
  • 'COM' - Computer OR Writer
    • +
  • 'ENL' - Enlarged Paper
    • +
  • 'EXT' - Extra Time
    • +
  • 'OTH' - Other
    • +
  • 'REA' - Reader
    • +
  • 'RES' - Rest Breaks
    • +
  • 'SEP' - Separate Accommodation
    • +
  • 'SIR' - Signing Reader
    • +
  • 'SIS' - Signing Supervisor
    • +
  • 'SPE' - Special Paper
    • +
+ oneOf: + - title: Braille Paper + enum: + - BRA + - title: Computer OR Writer + enum: + - COM + - title: Enlarged Paper + enum: + - ENL + - title: Extra Time + enum: + - EXT + - title: Other + enum: + - OTH + - title: Reader + enum: + - REA + - title: Rest Breaks + enum: + - RES + - title: Separate Accommodation + enum: + - SEP + - title: Signing Reader + enum: + - SIR + - title: Signing Supervisor + enum: + - SIS + - title: Special Paper + enum: + - SPE + Timeframe: + type: string + title: Assessment Timeframe + description: >- +

The timeframe of the assessment, e.g. + Mid-Year, End of Year.

    +
  • 'OTH' - Other
    • +
  • 'OUT' - Out of Cycle
    • +
  • 'INT' - Interim
    • +
  • 'END' - End of Year
    • +
+ oneOf: + - title: Other + enum: + - OTH + - title: Out of Cycle + enum: + - OUT + - title: Interim + enum: + - INT + - title: End of Year + enum: + - END + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + AssessmentTasks: + AssessmentTask: + - AssessmentTaskRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + AssessmentName: NZ History Classroom Test + ProviderInvolvedList: + ProviderInvolved: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: PRO + TeachingGroup: + RefId: D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + StaffInvolvedList: + StaffInvolved: + RefId: cd106d6d-d9d5-41fb-9943-5feb967c9435 + StaffRole: ASS + GradingCategory: Classroom Test + Description: Pop Quiz + PointsPossible: 100 + CreatedDate: 2018-11-21 + DueDate: 2018-11-25 + Weight: 1 + DetailedDescriptionURL: http://www.assignmentinfo.com/assignment1.pdf + application/xml: + schema: + type: object + properties: + AssessmentTasks: + type: object + description: A List of AssessmentTask objects + properties: + AssessmentTask: + type: array + items: + $ref: "#/paths/~1AssessmentTasks/get/responses/200/conten\ + t/application~1json/schema/properties/AssessmentTas\ + ks/properties/AssessmentTask/items" + example: >- + + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + NZ History Classroom Test + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + PRO + + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + + + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + ASS + + + Classroom Test + Pop Quiz + 100 + 2018-11-21 + 2018-11-25 + 1.0 + http://www.assignmentinfo.com/assignment1.pdf + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/AssessmentTasks/{AssessmentTaskRefId}": + post: + tags: + - AssessmentTask + summary: Default operation to create a single AssessmentTask + parameters: + - name: AssessmentTaskRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: createAssessmentTask + requestBody: + description: CRUD operation on AssessmentTask + content: + application/json: + schema: + type: object + properties: + AssessmentTask: + $ref: "#/paths/~1AssessmentTasks/get/responses/200/content/applic\ + ation~1json/schema/properties/AssessmentTasks/properties/As\ + sessmentTask/items" + example: + AssessmentTask: + AssessmentTaskRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + AssessmentName: NZ History Classroom Test + ProviderInvolvedList: + ProviderInvolved: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: PRO + TeachingGroup: + RefId: D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + StaffInvolvedList: + StaffInvolved: + RefId: cd106d6d-d9d5-41fb-9943-5feb967c9435 + StaffRole: ASS + GradingCategory: Classroom Test + Description: Pop Quiz + PointsPossible: 100 + CreatedDate: 2018-11-21 + DueDate: 2018-11-25 + Weight: 1 + DetailedDescriptionURL: http://www.assignmentinfo.com/assignment1.pdf + application/xml: + schema: + type: object + properties: + AssessmentTask: + $ref: "#/paths/~1AssessmentTasks/get/responses/200/content/applic\ + ation~1json/schema/properties/AssessmentTasks/properties/As\ + sessmentTask/items" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + NZ History Classroom Test + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + PRO + + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + + + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + ASS + + + Classroom Test + Pop Quiz + 100 + 2018-11-21 + 2018-11-25 + 1.0 + http://www.assignmentinfo.com/assignment1.pdf + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - AssessmentTask + summary: Default operation to update a single AssessmentTask + parameters: + - name: AssessmentTaskRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: updateAssessmentTask + requestBody: + description: CRUD operation on AssessmentTask + content: + application/json: + schema: + type: object + properties: + AssessmentTask: + type: object + properties: + AssessmentTaskRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + AssessmentTaskLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + AssessmentName: + type: string + description:

The name of the assessment task.

+ ProviderInvolvedList: + description:

A list of the providers involved and their role, e.g. + assessing provider, assessment provider, assessment + location provider, registering provider.

+ type: object + properties: + ProviderInvolved: + type: array + items: + description:

The provider involved with the assessment task + and the role they play, e.g. assessing provider, + assessment location provider, assessment provider, + registering provider.

+ type: object + properties: + ProviderRole: + type: string + title: Assessment Provider Role + description: >- +

Code set denoting the role of the provider + in the assessment, e.g. Assessing Provider, + Location Provider.

    +
  • 'ASR' - Assessor
    • +
  • 'LOC' - Location Provider
    • +
  • 'PRO' - Provider
    • +
+ oneOf: + - title: Assessor + enum: + - ASR + - title: Location Provider + enum: + - LOC + - title: Provider + enum: + - PRO + TeachingGroup: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1AssessmentTasks~1%7BAssessmentTaskRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/AssessmentTask/properties/AssessmentTas\ + kRefId" + LocalId: + $ref: "#/paths/~1AssessmentTasks~1%7BAssessmentTaskRefId%\ + 7D/put/requestBody/content/application~1json/schema\ + /properties/AssessmentTask/properties/AssessmentTas\ + kLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + ProviderCourse: + $ref: "#/paths/~1AssessmentTasks~1%7BAssessmentTaskRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/AssessmentTask/properties/TeachingGroup" + StudentList: + description:

The GUIDs for students that are the intended + participants for this Assessement Task.

+ type: object + properties: + Student: + type: array + items: + $ref: "#/paths/~1AssessmentTasks~1%7BAssessmentTaskRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/AssessmentTask/properties/Teachin\ + gGroup" + StaffInvolvedList: + description:

A list of the staff involved and their role in + relation to the assessment task, e.g. the moderator, the + marker.

+ type: object + properties: + StaffInvolved: + type: array + items: + description:

The staff member involved with the assessment + task and their role, e.g. created the assessment + task, moderator, marker.

+ type: object + properties: + StaffRole: + type: string + title: Assessment Staff Role + description: |- + +
    +
  • 'CRE' - Creator
    • +
  • 'MOD' - Moderator
    • +
  • 'ASS' - Assessor
    • +
  • 'INV' - Invigilator
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Creator + enum: + - CRE + - title: Moderator + enum: + - MOD + - title: Assessor + enum: + - ASS + - title: Invigilator + enum: + - INV + - title: Other + enum: + - OTH + GradingCategory: + type: string + description:

A particular grading category for the assignment, + used to provide grouping and type information.

+ Description: + type: string + description:

The text-based description of the assignment.

+ PointsPossible: + type: integer + description:

The points possible on the assignment.

+ CreatedDate: + type: string + format: date + description:

Creation date of the assignment.

+ DueDate: + type: string + format: date + description:

Date the assignment is due.

+ Weight: + description:

The weight of the assignment.

+ MaxAttemptsAllowed: + type: integer + description:

How many attempts the student is allowed on the + assignment (applicable particularly to online + activities).

+ DetailedDescriptionURL: + type: string + format: uri + description:

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.

+ AssessmentType: + type: string + description:

Type of assessment (e.g. diagnostic vs + paedagogical).

+ LevelAssessed: + type: string + description:

Level at which assessment is aimed; may be year + level.

+ FormativeIndicator: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + SummativeIndicator: + $ref: "#/paths/~1AssessmentTasks~1%7BAssessmentTaskRefId%7D/p\ + ut/requestBody/content/application~1json/schema/propert\ + ies/AssessmentTask/properties/FormativeIndicator" + AssessmentToolTypeName: + type: string + description:

The type of assessment tool used for the assessment + task.

+ AssessmentPurpose: + type: string + description:

Purpose for the assessment.

+ SubAssessmentTaskList: + type: object + properties: + SubAssessmentTask: + type: array + items: + $ref: "#/paths/~1AssessmentTasks~1%7BAssessmentTaskRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/AssessmentTask/properties/Teachin\ + gGroup" + description:

AssessmentTasks which this assessment task is + composed of.

+ PrerequisiteList: + description:

References to objects (Course, LearningStandard, + AssessmentTask etc.) being prerequisite conditions to be + met for assessment.

+ type: object + properties: + Prerequisite: + type: array + items: + $ref: "#/paths/~1AssessmentTasks~1%7BAssessmentTaskRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/AssessmentTask/properties/Teachin\ + gGroup" + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the NZ + Curriculum and Te Marautanga o Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - title: German + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - GERM + - title: Indonesian + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - INDO + - title: Japanese + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - JAPA + - title: French + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - FREN + - title: English (Remedial) + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - REME + - title: English + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - ENGL + - title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - COOK + - title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + enum: + - COMM + - title: Chinese + description: Applicable to Te Marautanga o Aotearoa + enum: + - CHIN + - title: Korean + enum: + - KORE + - title: Latin + enum: + - LATI + - title: Niuean + enum: + - NIUE + - title: Other Languages + enum: + - OLAN + - title: Pacific Language Studies + enum: + - PLAN + - title: Russian + enum: + - RUSS + - title: Samoan + enum: + - SAMO + - title: Spanish + enum: + - SPAN + - title: Te Reo Māori + enum: + - MAOR + - title: Te Reo Rangatira + enum: + - RANG + - title: Tokelauan + enum: + - TOKE + - title: Tongan + enum: + - TONG + - title: English as a Second Language + enum: + - ENSL + - title: Mathematics + enum: + - MATH + - title: Mathematics with Calculus + enum: + - MATC + - title: Mathematics with Statistics + enum: + - MATS + - title: Mathematics (Remedial) + enum: + - REMM + - title: Accounting + enum: + - ACCO + - title: Science + enum: + - SCIE + - title: Agriculture / Horticulture + enum: + - AGHO + - title: Biology / Biological Science + enum: + - BIOL + - title: Chemsitry + enum: + - CHEM + - title: Earth Science / Astronomy + enum: + - EAAS + - title: Human Biology + enum: + - HUMB + - title: Physics + enum: + - PHYS + - title: Technology + enum: + - TECN + - title: Biotechnology + enum: + - BITE + - title: Computer Science / Programming + enum: + - COSC + - title: Computer Studies + enum: + - COMP + - title: Design, Drawing and Graphics + enum: + - DEST + - title: Electronics and Control + enum: + - ELTE + - title: Food Technology + enum: + - FOTE + - title: Graphics + enum: + - GRAP + - title: Information and Communication Technology + enum: + - INTE + - title: Materials Technology + enum: + - MTEC + - title: Structures and Mechanisms + enum: + - STME + - title: Test and Information Management + enum: + - TIMA + - title: Textiles / Clothing + enum: + - CLTX + - title: The Arts + enum: + - ARTA + - title: Art Design + enum: + - ARTD + - title: Art History + enum: + - ARTH + - title: Dancing + enum: + - DANC + - title: Drama + enum: + - DRAM + - title: Music / Music Studies + enum: + - MUSC + - title: Music Practical / Performance + enum: + - MUSP + - title: Painting + enum: + - ARPA + - title: Performing Arts + enum: + - APER + - title: Photography + enum: + - ARTP + - title: Printmaking + enum: + - ARPR + - title: Sculpture + enum: + - ARTS + - title: Visial Arts + enum: + - ARTC + - title: Social Studies + enum: + - SOST + - title: Classics / Classical Studies + enum: + - CLST + - title: Community Studies + enum: + - CMTY + - title: Economics + enum: + - ECON + - title: Environmental Sustainability + enum: + - SENV + - title: Geography + enum: + - GEOG + - title: History + enum: + - HIST + - title: Language and Cultural Studies + enum: + - LACU + - title: Māori Studies + enum: + - MAOS + - title: Media Studies + enum: + - MEST + - title: Other Social Sciences + enum: + - SOSC + - title: Health and Physical Education + enum: + - HEPH + - title: Health + enum: + - HEED + - title: Home Economics + enum: + - HOME + - title: Outdoor Education + enum: + - OUED + - title: Physical Education + enum: + - PHED + - title: Sports Studies + enum: + - SPOR + - title: Commerce Related + enum: + - BUSS + - title: Defence + enum: + - DEFE + - title: Equestrian + enum: + - EQUE + - title: Farming + enum: + - FARM + - title: Fishing + enum: + - FISH + - title: Forestry + enum: + - FOTY + - title: Industrial Trades + enum: + - INTR + - title: Integrated Studies + enum: + - INTS + - title: Legal / Law Related Studies + enum: + - LAWS + - title: Life Skills / Personal Development + enum: + - LIFE + - title: Religious Education / Studies + enum: + - REST + - title: Remedial Studies + enum: + - REMS + - title: Secondary Tertiary Programme + enum: + - STPR + - title: Service Trades + enum: + - SETR + - title: Special Needs Programme + enum: + - SPPR + - title: Study Skills + enum: + - STDY + - title: Transition / Pre-Employment + enum: + - TRAN + - title: Travel, Hospitality, Tourism + enum: + - THTR + YearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid for + describing Funding Year Level and Current Year Level for + a student enrolment.

Current Year Level indicates + the year level of the student’s class cohort and the + level at which the student spends most of their time at + school. While a student may be enrolled in subjects at + varying instructional year levels, in relation to the + student enrolment this value represents the year level + at which the student is considered to be predominantly + taught.

Funding Year Level measures the actual + number of years that the student has attended a school. + It provides the Ministry with a method of counting + students for funding purposes which is independent of + the way schools are organised or the particular + programme of study that a student may undertake. Funding + Year Level for most students is based on the date they + first started school.

School Year Level is used + to indicate the instructional year levels offered by a + school, i.e. those years for which student enrolments + may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates Year 14 + and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + LearningStandardList: + type: object + properties: + LearningStandard: + type: array + items: + $ref: "#/paths/~1AssessmentTasks~1%7BAssessmentTaskRefI\ + d%7D/put/requestBody/content/application~1json/sc\ + hema/properties/AssessmentTask/properties/Teachin\ + gGroup" + description:

A list of references to LearningStandards that will + be assessed as part of this AssessmentTask.

+ SpecialAssessmentConditionExclusionList: + description:

A list of SACs that are excluded for this particular + assessment task.

+ type: object + properties: + SpecialAssessmentCondition: + type: array + items: + type: string + title: Special Assessment Condition + description: >- +

Standard codes denoting special assessment + conditions that a student requires when sitting an + assessment.

    +
  • 'BRA' - Braille Paper
    • +
  • 'COM' - Computer OR Writer
    • +
  • 'ENL' - Enlarged Paper
    • +
  • 'EXT' - Extra Time
    • +
  • 'OTH' - Other
    • +
  • 'REA' - Reader
    • +
  • 'RES' - Rest Breaks
    • +
  • 'SEP' - Separate Accommodation
    • +
  • 'SIR' - Signing Reader
    • +
  • 'SIS' - Signing Supervisor
    • +
  • 'SPE' - Special Paper
    • +
+ oneOf: + - title: Braille Paper + enum: + - BRA + - title: Computer OR Writer + enum: + - COM + - title: Enlarged Paper + enum: + - ENL + - title: Extra Time + enum: + - EXT + - title: Other + enum: + - OTH + - title: Reader + enum: + - REA + - title: Rest Breaks + enum: + - RES + - title: Separate Accommodation + enum: + - SEP + - title: Signing Reader + enum: + - SIR + - title: Signing Supervisor + enum: + - SIS + - title: Special Paper + enum: + - SPE + Timeframe: + type: string + title: Assessment Timeframe + description: >- +

The timeframe of the assessment, e.g. Mid-Year, End + of Year.

    +
  • 'OTH' - Other
    • +
  • 'OUT' - Out of Cycle
    • +
  • 'INT' - Interim
    • +
  • 'END' - End of Year
    • +
+ oneOf: + - title: Other + enum: + - OTH + - title: Out of Cycle + enum: + - OUT + - title: Interim + enum: + - INT + - title: End of Year + enum: + - END + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + AssessmentTask: + AssessmentTaskRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + AssessmentName: NZ History Classroom Test + ProviderInvolvedList: + ProviderInvolved: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: PRO + TeachingGroup: + RefId: D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + StaffInvolvedList: + StaffInvolved: + RefId: cd106d6d-d9d5-41fb-9943-5feb967c9435 + StaffRole: ASS + GradingCategory: Classroom Test + Description: Pop Quiz + PointsPossible: 100 + CreatedDate: 2018-11-21 + DueDate: 2018-11-25 + Weight: 1 + DetailedDescriptionURL: http://www.assignmentinfo.com/assignment1.pdf + application/xml: + schema: + type: object + properties: + AssessmentTask: + $ref: "#/paths/~1AssessmentTasks~1%7BAssessmentTaskRefId%7D/put/r\ + equestBody/content/application~1json/schema/properties/Asse\ + ssmentTask" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + NZ History Classroom Test + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + PRO + + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + + + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + ASS + + + Classroom Test + Pop Quiz + 100 + 2018-11-21 + 2018-11-25 + 1.0 + http://www.assignmentinfo.com/assignment1.pdf + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - AssessmentTask + summary: Default operation to get a single AssessmentTask + parameters: + - name: AssessmentTaskRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + AssessmentTask: + $ref: "#/paths/~1AssessmentTasks/get/responses/200/content/appl\ + ication~1json/schema/properties/AssessmentTasks/propertie\ + s/AssessmentTask/items" + example: + AssessmentTask: + AssessmentTaskRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + AssessmentName: NZ History Classroom Test + ProviderInvolvedList: + ProviderInvolved: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: PRO + TeachingGroup: + RefId: D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + StaffInvolvedList: + StaffInvolved: + RefId: cd106d6d-d9d5-41fb-9943-5feb967c9435 + StaffRole: ASS + GradingCategory: Classroom Test + Description: Pop Quiz + PointsPossible: 100 + CreatedDate: 2018-11-21 + DueDate: 2018-11-25 + Weight: 1 + DetailedDescriptionURL: http://www.assignmentinfo.com/assignment1.pdf + application/xml: + schema: + type: object + properties: + AssessmentTask: + $ref: "#/paths/~1AssessmentTasks/get/responses/200/content/appl\ + ication~1json/schema/properties/AssessmentTasks/propertie\ + s/AssessmentTask/items" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + NZ History Classroom Test + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + PRO + + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + + + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + ASS + + + Classroom Test + Pop Quiz + 100 + 2018-11-21 + 2018-11-25 + 1.0 + http://www.assignmentinfo.com/assignment1.pdf + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - AssessmentTask + summary: Default operation to delete a single AssessmentTask + parameters: + - name: AssessmentTaskRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentAssessmentTaskRegistrations: + get: + tags: + - StudentAssessmentTaskRegistration + summary: Default operation to get a list of all available + StudentAssessmentTaskRegistrations + description: Search the set of available StudentAssessmentTaskRegistrations, + according to the search criteria in the URL parameters. Returns the + first 20 objects located; with SIF defined navigation headers, + indicating how to retrieve subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTaskRegistrations: + type: object + description: A List of StudentAssessmentTaskRegistration objects + properties: + StudentAssessmentTaskRegistration: + type: array + items: + required: + - AssessmentTask + - AssessmentYear + - DateRegistered + - ProviderInvolvedList + - Student + type: object + properties: + StudentAssessmentTaskRegistrationRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentAssessmentTaskRegistrationLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + ProviderInvolvedList: + description:

A list of the providers involved and their + role, e.g. assessment provider, registering + provider.

+ type: object + required: + - ProviderInvolved + properties: + ProviderInvolved: + type: array + items: + description:

The provider involved with the + assessment task and the role they play, + e.g. assessing provider, assessment + location provider, assessment provider, + registering provider.

+ type: object + required: + - ObjectType + - ProviderRole + properties: + ProviderRole: + type: string + title: Assessment Provider Role + description: >- +

Code set denoting the role of the + provider in the assessment, e.g. + Assessing Provider, Location + Provider.

    +
  • 'ASR' - Assessor
    • +
  • 'LOC' - Location Provider
    • +
  • 'PRO' - Provider
    • +
+ oneOf: + - title: Assessor + enum: + - ASR + - title: Location Provider + enum: + - LOC + - title: Provider + enum: + - PRO + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentAssessmentTaskRegistratio\ + ns/get/responses/200/content/application~1j\ + son/schema/properties/StudentAssessmentTask\ + Registrations/properties/StudentAssessmentT\ + askRegistration/items/properties/StudentAss\ + essmentTaskRegistrationRefId" + LocalId: + $ref: "#/paths/~1StudentAssessmentTaskRegistratio\ + ns/get/responses/200/content/application~1j\ + son/schema/properties/StudentAssessmentTask\ + Registrations/properties/StudentAssessmentT\ + askRegistration/items/properties/StudentAss\ + essmentTaskRegistrationLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + StaffMember: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations/g\ + et/responses/200/content/application~1json/sche\ + ma/properties/StudentAssessmentTaskRegistration\ + s/properties/StudentAssessmentTaskRegistration/\ + items/properties/Student" + AssessmentTask: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations/g\ + et/responses/200/content/application~1json/sche\ + ma/properties/StudentAssessmentTaskRegistration\ + s/properties/StudentAssessmentTaskRegistration/\ + items/properties/Student" + SpecialAssessmentConditionList: + description:

A list of references identifying any Special + Assessment Conditions that the student is + entitled to for the assessment task they are + registering for.

+ type: object + required: + - SpecialAssessmentCondition + properties: + SpecialAssessmentCondition: + type: array + items: + type: string + title: Special Assessment Condition + description: >- +

Standard codes denoting special + assessment conditions that a student + requires when sitting an assessment.

+
    +
  • 'BRA' - Braille Paper
    • +
  • 'COM' - Computer OR Writer
    • +
  • 'ENL' - Enlarged Paper
    • +
  • 'EXT' - Extra Time
    • +
  • 'OTH' - Other
    • +
  • 'REA' - Reader
    • +
  • 'RES' - Rest Breaks
    • +
  • 'SEP' - Separate Accommodation
    • +
  • 'SIR' - Signing Reader
    • +
  • 'SIS' - Signing Supervisor
    • +
  • 'SPE' - Special Paper
    • +
+ oneOf: + - title: Braille Paper + enum: + - BRA + - title: Computer OR Writer + enum: + - COM + - title: Enlarged Paper + enum: + - ENL + - title: Extra Time + enum: + - EXT + - title: Other + enum: + - OTH + - title: Reader + enum: + - REA + - title: Rest Breaks + enum: + - RES + - title: Separate Accommodation + enum: + - SEP + - title: Signing Reader + enum: + - SIR + - title: Signing Supervisor + enum: + - SIS + - title: Special Paper + enum: + - SPE + ProviderCourse: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations/g\ + et/responses/200/content/application~1json/sche\ + ma/properties/StudentAssessmentTaskRegistration\ + s/properties/StudentAssessmentTaskRegistration/\ + items/properties/Student" + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - GERM + - title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - INDO + - title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - JAPA + - title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - FREN + - title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - REME + - title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - ENGL + - title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + enum: + - COOK + - title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + enum: + - COMM + - title: Chinese + description: Applicable to Te Marautanga o Aotearoa + enum: + - CHIN + - title: Korean + enum: + - KORE + - title: Latin + enum: + - LATI + - title: Niuean + enum: + - NIUE + - title: Other Languages + enum: + - OLAN + - title: Pacific Language Studies + enum: + - PLAN + - title: Russian + enum: + - RUSS + - title: Samoan + enum: + - SAMO + - title: Spanish + enum: + - SPAN + - title: Te Reo Māori + enum: + - MAOR + - title: Te Reo Rangatira + enum: + - RANG + - title: Tokelauan + enum: + - TOKE + - title: Tongan + enum: + - TONG + - title: English as a Second Language + enum: + - ENSL + - title: Mathematics + enum: + - MATH + - title: Mathematics with Calculus + enum: + - MATC + - title: Mathematics with Statistics + enum: + - MATS + - title: Mathematics (Remedial) + enum: + - REMM + - title: Accounting + enum: + - ACCO + - title: Science + enum: + - SCIE + - title: Agriculture / Horticulture + enum: + - AGHO + - title: Biology / Biological Science + enum: + - BIOL + - title: Chemsitry + enum: + - CHEM + - title: Earth Science / Astronomy + enum: + - EAAS + - title: Human Biology + enum: + - HUMB + - title: Physics + enum: + - PHYS + - title: Technology + enum: + - TECN + - title: Biotechnology + enum: + - BITE + - title: Computer Science / Programming + enum: + - COSC + - title: Computer Studies + enum: + - COMP + - title: Design, Drawing and Graphics + enum: + - DEST + - title: Electronics and Control + enum: + - ELTE + - title: Food Technology + enum: + - FOTE + - title: Graphics + enum: + - GRAP + - title: Information and Communication Technology + enum: + - INTE + - title: Materials Technology + enum: + - MTEC + - title: Structures and Mechanisms + enum: + - STME + - title: Test and Information Management + enum: + - TIMA + - title: Textiles / Clothing + enum: + - CLTX + - title: The Arts + enum: + - ARTA + - title: Art Design + enum: + - ARTD + - title: Art History + enum: + - ARTH + - title: Dancing + enum: + - DANC + - title: Drama + enum: + - DRAM + - title: Music / Music Studies + enum: + - MUSC + - title: Music Practical / Performance + enum: + - MUSP + - title: Painting + enum: + - ARPA + - title: Performing Arts + enum: + - APER + - title: Photography + enum: + - ARTP + - title: Printmaking + enum: + - ARPR + - title: Sculpture + enum: + - ARTS + - title: Visial Arts + enum: + - ARTC + - title: Social Studies + enum: + - SOST + - title: Classics / Classical Studies + enum: + - CLST + - title: Community Studies + enum: + - CMTY + - title: Economics + enum: + - ECON + - title: Environmental Sustainability + enum: + - SENV + - title: Geography + enum: + - GEOG + - title: History + enum: + - HIST + - title: Language and Cultural Studies + enum: + - LACU + - title: Māori Studies + enum: + - MAOS + - title: Media Studies + enum: + - MEST + - title: Other Social Sciences + enum: + - SOSC + - title: Health and Physical Education + enum: + - HEPH + - title: Health + enum: + - HEED + - title: Home Economics + enum: + - HOME + - title: Outdoor Education + enum: + - OUED + - title: Physical Education + enum: + - PHED + - title: Sports Studies + enum: + - SPOR + - title: Commerce Related + enum: + - BUSS + - title: Defence + enum: + - DEFE + - title: Equestrian + enum: + - EQUE + - title: Farming + enum: + - FARM + - title: Fishing + enum: + - FISH + - title: Forestry + enum: + - FOTY + - title: Industrial Trades + enum: + - INTR + - title: Integrated Studies + enum: + - INTS + - title: Legal / Law Related Studies + enum: + - LAWS + - title: Life Skills / Personal Development + enum: + - LIFE + - title: Religious Education / Studies + enum: + - REST + - title: Remedial Studies + enum: + - REMS + - title: Secondary Tertiary Programme + enum: + - STPR + - title: Service Trades + enum: + - SETR + - title: Special Needs Programme + enum: + - SPPR + - title: Study Skills + enum: + - STDY + - title: Transition / Pre-Employment + enum: + - TRAN + - title: Travel, Hospitality, Tourism + enum: + - THTR + YearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid + for describing Funding Year Level and Current + Year Level for a student enrolment.

+

Current Year Level indicates the year level + of the student’s class cohort and the level at + which the student spends most of their time at + school. While a student may be enrolled in + subjects at varying instructional year levels, + in relation to the student enrolment this value + represents the year level at which the student + is considered to be predominantly taught.

+

Funding Year Level measures the actual number + of years that the student has attended a school. + It provides the Ministry with a method of + counting students for funding purposes which is + independent of the way schools are organised or + the particular programme of study that a student + may undertake. Funding Year Level for most + students is based on the date they first started + school.

School Year Level is used to + indicate the instructional year levels offered + by a school, i.e. those years for which student + enrolments may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates + Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + DateRegistered: + type: string + format: date + description:

The date the student's intent to participate + in the assessment task was registered.

+ AssessmentYear: + description:

The assessment year the student's intent to + participate in the assessment task was + registered for.

+ description:

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

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + example: + StudentAssessmentTaskRegistrations: + StudentAssessmentTaskRegistration: + - StudentAssessmentTaskRegistrationRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + ProviderInvolvedList: + ProviderInvolved: + - RefId: 5556b4eb-850f-4102-800c-9a3fde8bfa9f + ProviderRole: ASR + - RefId: 6661f830-13a6-44d7-bd96-be00cbad68f1 + ProviderRole: PRO + Student: + RefId: 19059103-3c50-4970-bc48-341349c32858 + Name: Harry Potter + 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 + application/xml: + schema: + type: object + properties: + StudentAssessmentTaskRegistrations: + type: object + description: A List of StudentAssessmentTaskRegistration objects + properties: + StudentAssessmentTaskRegistration: + type: array + items: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations/get/r\ + esponses/200/content/application~1json/schema/prope\ + rties/StudentAssessmentTaskRegistrations/properties\ + /StudentAssessmentTaskRegistration/items" + example: >- + + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + + 5556b4eb-850f-4102-800c-9a3fde8bfa9f + ASR + + + 6661f830-13a6-44d7-bd96-be00cbad68f1 + PRO + + + + 19059103-3c50-4970-bc48-341349c32858 + Harry Potter + + + c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb + + + cedd0ce7-f555-482b-887b-d130e5c40d02 + + + COM + EXT + SEP + + PHYS + 12 + 2018-03-30 + 2018 + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentAssessmentTaskRegistrations/{StudentAssessmentTaskRegistrationRefId}": + post: + tags: + - StudentAssessmentTaskRegistration + summary: Default operation to create a single StudentAssessmentTaskRegistration + parameters: + - name: StudentAssessmentTaskRegistrationRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: createStudentAssessmentTaskRegistration + requestBody: + description: CRUD operation on StudentAssessmentTaskRegistration + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTaskRegistration: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations/get/responses\ + /200/content/application~1json/schema/properties/StudentAss\ + essmentTaskRegistrations/properties/StudentAssessmentTaskRe\ + gistration/items" + example: + StudentAssessmentTaskRegistration: + StudentAssessmentTaskRegistrationRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + ProviderInvolvedList: + ProviderInvolved: + - RefId: 5556b4eb-850f-4102-800c-9a3fde8bfa9f + ProviderRole: ASR + - RefId: 6661f830-13a6-44d7-bd96-be00cbad68f1 + ProviderRole: PRO + Student: + RefId: 19059103-3c50-4970-bc48-341349c32858 + Name: Harry Potter + 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 + application/xml: + schema: + type: object + properties: + StudentAssessmentTaskRegistration: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations/get/responses\ + /200/content/application~1json/schema/properties/StudentAss\ + essmentTaskRegistrations/properties/StudentAssessmentTaskRe\ + gistration/items" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + + 5556b4eb-850f-4102-800c-9a3fde8bfa9f + ASR + + + 6661f830-13a6-44d7-bd96-be00cbad68f1 + PRO + + + + 19059103-3c50-4970-bc48-341349c32858 + Harry Potter + + + c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb + + + cedd0ce7-f555-482b-887b-d130e5c40d02 + + + COM + EXT + SEP + + PHYS + 12 + 2018-03-30 + 2018 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentAssessmentTaskRegistration + summary: Default operation to update a single StudentAssessmentTaskRegistration + parameters: + - name: StudentAssessmentTaskRegistrationRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: updateStudentAssessmentTaskRegistration + requestBody: + description: CRUD operation on StudentAssessmentTaskRegistration + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTaskRegistration: + type: object + properties: + StudentAssessmentTaskRegistrationRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentAssessmentTaskRegistrationLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + ProviderInvolvedList: + description:

A list of the providers involved and their role, e.g. + assessment provider, registering provider.

+ type: object + properties: + ProviderInvolved: + type: array + items: + description:

The provider involved with the assessment task + and the role they play, e.g. assessing provider, + assessment location provider, assessment provider, + registering provider.

+ type: object + properties: + ProviderRole: + type: string + title: Assessment Provider Role + description: >- +

Code set denoting the role of the provider + in the assessment, e.g. Assessing Provider, + Location Provider.

    +
  • 'ASR' - Assessor
    • +
  • 'LOC' - Location Provider
    • +
  • 'PRO' - Provider
    • +
+ oneOf: + - title: Assessor + enum: + - ASR + - title: Location Provider + enum: + - LOC + - title: Provider + enum: + - PRO + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations~1%7BS\ + tudentAssessmentTaskRegistrationRefId%7D/put/reques\ + tBody/content/application~1json/schema/properties/S\ + tudentAssessmentTaskRegistration/properties/Student\ + AssessmentTaskRegistrationRefId" + LocalId: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations~1%7BS\ + tudentAssessmentTaskRegistrationRefId%7D/put/reques\ + tBody/content/application~1json/schema/properties/S\ + tudentAssessmentTaskRegistration/properties/Student\ + AssessmentTaskRegistrationLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + StaffMember: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations~1%7BStude\ + ntAssessmentTaskRegistrationRefId%7D/put/requestBody/co\ + ntent/application~1json/schema/properties/StudentAssess\ + mentTaskRegistration/properties/Student" + AssessmentTask: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations~1%7BStude\ + ntAssessmentTaskRegistrationRefId%7D/put/requestBody/co\ + ntent/application~1json/schema/properties/StudentAssess\ + mentTaskRegistration/properties/Student" + SpecialAssessmentConditionList: + description:

A list of references identifying any Special + Assessment Conditions that the student is entitled to + for the assessment task they are registering for.

+ type: object + properties: + SpecialAssessmentCondition: + type: array + items: + type: string + title: Special Assessment Condition + description: >- +

Standard codes denoting special assessment + conditions that a student requires when sitting an + assessment.

    +
  • 'BRA' - Braille Paper
    • +
  • 'COM' - Computer OR Writer
    • +
  • 'ENL' - Enlarged Paper
    • +
  • 'EXT' - Extra Time
    • +
  • 'OTH' - Other
    • +
  • 'REA' - Reader
    • +
  • 'RES' - Rest Breaks
    • +
  • 'SEP' - Separate Accommodation
    • +
  • 'SIR' - Signing Reader
    • +
  • 'SIS' - Signing Supervisor
    • +
  • 'SPE' - Special Paper
    • +
+ oneOf: + - title: Braille Paper + enum: + - BRA + - title: Computer OR Writer + enum: + - COM + - title: Enlarged Paper + enum: + - ENL + - title: Extra Time + enum: + - EXT + - title: Other + enum: + - OTH + - title: Reader + enum: + - REA + - title: Rest Breaks + enum: + - RES + - title: Separate Accommodation + enum: + - SEP + - title: Signing Reader + enum: + - SIR + - title: Signing Supervisor + enum: + - SIS + - title: Special Paper + enum: + - SPE + ProviderCourse: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations~1%7BStude\ + ntAssessmentTaskRegistrationRefId%7D/put/requestBody/co\ + ntent/application~1json/schema/properties/StudentAssess\ + mentTaskRegistration/properties/Student" + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the NZ + Curriculum and Te Marautanga o Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - title: German + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - GERM + - title: Indonesian + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - INDO + - title: Japanese + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - JAPA + - title: French + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - FREN + - title: English (Remedial) + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - REME + - title: English + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - ENGL + - title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te Marautanga o + Aotearoa + enum: + - COOK + - title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + enum: + - COMM + - title: Chinese + description: Applicable to Te Marautanga o Aotearoa + enum: + - CHIN + - title: Korean + enum: + - KORE + - title: Latin + enum: + - LATI + - title: Niuean + enum: + - NIUE + - title: Other Languages + enum: + - OLAN + - title: Pacific Language Studies + enum: + - PLAN + - title: Russian + enum: + - RUSS + - title: Samoan + enum: + - SAMO + - title: Spanish + enum: + - SPAN + - title: Te Reo Māori + enum: + - MAOR + - title: Te Reo Rangatira + enum: + - RANG + - title: Tokelauan + enum: + - TOKE + - title: Tongan + enum: + - TONG + - title: English as a Second Language + enum: + - ENSL + - title: Mathematics + enum: + - MATH + - title: Mathematics with Calculus + enum: + - MATC + - title: Mathematics with Statistics + enum: + - MATS + - title: Mathematics (Remedial) + enum: + - REMM + - title: Accounting + enum: + - ACCO + - title: Science + enum: + - SCIE + - title: Agriculture / Horticulture + enum: + - AGHO + - title: Biology / Biological Science + enum: + - BIOL + - title: Chemsitry + enum: + - CHEM + - title: Earth Science / Astronomy + enum: + - EAAS + - title: Human Biology + enum: + - HUMB + - title: Physics + enum: + - PHYS + - title: Technology + enum: + - TECN + - title: Biotechnology + enum: + - BITE + - title: Computer Science / Programming + enum: + - COSC + - title: Computer Studies + enum: + - COMP + - title: Design, Drawing and Graphics + enum: + - DEST + - title: Electronics and Control + enum: + - ELTE + - title: Food Technology + enum: + - FOTE + - title: Graphics + enum: + - GRAP + - title: Information and Communication Technology + enum: + - INTE + - title: Materials Technology + enum: + - MTEC + - title: Structures and Mechanisms + enum: + - STME + - title: Test and Information Management + enum: + - TIMA + - title: Textiles / Clothing + enum: + - CLTX + - title: The Arts + enum: + - ARTA + - title: Art Design + enum: + - ARTD + - title: Art History + enum: + - ARTH + - title: Dancing + enum: + - DANC + - title: Drama + enum: + - DRAM + - title: Music / Music Studies + enum: + - MUSC + - title: Music Practical / Performance + enum: + - MUSP + - title: Painting + enum: + - ARPA + - title: Performing Arts + enum: + - APER + - title: Photography + enum: + - ARTP + - title: Printmaking + enum: + - ARPR + - title: Sculpture + enum: + - ARTS + - title: Visial Arts + enum: + - ARTC + - title: Social Studies + enum: + - SOST + - title: Classics / Classical Studies + enum: + - CLST + - title: Community Studies + enum: + - CMTY + - title: Economics + enum: + - ECON + - title: Environmental Sustainability + enum: + - SENV + - title: Geography + enum: + - GEOG + - title: History + enum: + - HIST + - title: Language and Cultural Studies + enum: + - LACU + - title: Māori Studies + enum: + - MAOS + - title: Media Studies + enum: + - MEST + - title: Other Social Sciences + enum: + - SOSC + - title: Health and Physical Education + enum: + - HEPH + - title: Health + enum: + - HEED + - title: Home Economics + enum: + - HOME + - title: Outdoor Education + enum: + - OUED + - title: Physical Education + enum: + - PHED + - title: Sports Studies + enum: + - SPOR + - title: Commerce Related + enum: + - BUSS + - title: Defence + enum: + - DEFE + - title: Equestrian + enum: + - EQUE + - title: Farming + enum: + - FARM + - title: Fishing + enum: + - FISH + - title: Forestry + enum: + - FOTY + - title: Industrial Trades + enum: + - INTR + - title: Integrated Studies + enum: + - INTS + - title: Legal / Law Related Studies + enum: + - LAWS + - title: Life Skills / Personal Development + enum: + - LIFE + - title: Religious Education / Studies + enum: + - REST + - title: Remedial Studies + enum: + - REMS + - title: Secondary Tertiary Programme + enum: + - STPR + - title: Service Trades + enum: + - SETR + - title: Special Needs Programme + enum: + - SPPR + - title: Study Skills + enum: + - STDY + - title: Transition / Pre-Employment + enum: + - TRAN + - title: Travel, Hospitality, Tourism + enum: + - THTR + YearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid for + describing Funding Year Level and Current Year Level for + a student enrolment.

Current Year Level indicates + the year level of the student’s class cohort and the + level at which the student spends most of their time at + school. While a student may be enrolled in subjects at + varying instructional year levels, in relation to the + student enrolment this value represents the year level + at which the student is considered to be predominantly + taught.

Funding Year Level measures the actual + number of years that the student has attended a school. + It provides the Ministry with a method of counting + students for funding purposes which is independent of + the way schools are organised or the particular + programme of study that a student may undertake. Funding + Year Level for most students is based on the date they + first started school.

School Year Level is used + to indicate the instructional year levels offered by a + school, i.e. those years for which student enrolments + may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates Year 14 + and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + DateRegistered: + type: string + format: date + description:

The date the student's intent to participate in the + assessment task was registered.

+ AssessmentYear: + description:

The assessment year the student's intent to + participate in the assessment task was registered + for.

+ description:

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

+ x-accessControl: + ? create + ? read + ? update + ? delete + ? aggregate + example: + StudentAssessmentTaskRegistration: + StudentAssessmentTaskRegistrationRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + ProviderInvolvedList: + ProviderInvolved: + - RefId: 5556b4eb-850f-4102-800c-9a3fde8bfa9f + ProviderRole: ASR + - RefId: 6661f830-13a6-44d7-bd96-be00cbad68f1 + ProviderRole: PRO + Student: + RefId: 19059103-3c50-4970-bc48-341349c32858 + Name: Harry Potter + 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 + application/xml: + schema: + type: object + properties: + StudentAssessmentTaskRegistration: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations~1%7BStudentAs\ + sessmentTaskRegistrationRefId%7D/put/requestBody/content/ap\ + plication~1json/schema/properties/StudentAssessmentTaskRegi\ + stration" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + + 5556b4eb-850f-4102-800c-9a3fde8bfa9f + ASR + + + 6661f830-13a6-44d7-bd96-be00cbad68f1 + PRO + + + + 19059103-3c50-4970-bc48-341349c32858 + Harry Potter + + + c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb + + + cedd0ce7-f555-482b-887b-d130e5c40d02 + + + COM + EXT + SEP + + PHYS + 12 + 2018-03-30 + 2018 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentAssessmentTaskRegistration + summary: Default operation to get a single StudentAssessmentTaskRegistration + parameters: + - name: StudentAssessmentTaskRegistrationRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTaskRegistration: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations/get/respons\ + es/200/content/application~1json/schema/properties/Studen\ + tAssessmentTaskRegistrations/properties/StudentAssessment\ + TaskRegistration/items" + example: + StudentAssessmentTaskRegistration: + StudentAssessmentTaskRegistrationRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + ProviderInvolvedList: + ProviderInvolved: + - RefId: 5556b4eb-850f-4102-800c-9a3fde8bfa9f + ProviderRole: ASR + - RefId: 6661f830-13a6-44d7-bd96-be00cbad68f1 + ProviderRole: PRO + Student: + RefId: 19059103-3c50-4970-bc48-341349c32858 + Name: Harry Potter + 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 + application/xml: + schema: + type: object + properties: + StudentAssessmentTaskRegistration: + $ref: "#/paths/~1StudentAssessmentTaskRegistrations/get/respons\ + es/200/content/application~1json/schema/properties/Studen\ + tAssessmentTaskRegistrations/properties/StudentAssessment\ + TaskRegistration/items" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + + 5556b4eb-850f-4102-800c-9a3fde8bfa9f + ASR + + + 6661f830-13a6-44d7-bd96-be00cbad68f1 + PRO + + + + 19059103-3c50-4970-bc48-341349c32858 + Harry Potter + + + c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb + + + cedd0ce7-f555-482b-887b-d130e5c40d02 + + + COM + EXT + SEP + + PHYS + 12 + 2018-03-30 + 2018 + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentAssessmentTaskRegistration + summary: Default operation to delete a single StudentAssessmentTaskRegistration + parameters: + - name: StudentAssessmentTaskRegistrationRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentAssessmentTasks: + get: + tags: + - StudentAssessmentTask + summary: Default operation to get a list of all available StudentAssessmentTasks + description: Search the set of available StudentAssessmentTasks, according to the + search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTasks: + type: object + description: A List of StudentAssessmentTask objects + properties: + StudentAssessmentTask: + type: array + items: + required: + - AssessmentTask + - ProviderInvolvedList + - Student + type: object + properties: + StudentAssessmentTaskRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentAssessmentTaskLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentAssessmentTasks/get/respo\ + nses/200/content/application~1json/schema/p\ + roperties/StudentAssessmentTasks/properties\ + /StudentAssessmentTask/items/properties/Stu\ + dentAssessmentTaskRefId" + LocalId: + $ref: "#/paths/~1StudentAssessmentTasks/get/respo\ + nses/200/content/application~1json/schema/p\ + roperties/StudentAssessmentTasks/properties\ + /StudentAssessmentTask/items/properties/Stu\ + dentAssessmentTaskLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + AssessmentTask: + $ref: "#/paths/~1StudentAssessmentTasks/get/responses\ + /200/content/application~1json/schema/propertie\ + s/StudentAssessmentTasks/properties/StudentAsse\ + ssmentTask/items/properties/Student" + ProviderInvolvedList: + description:

A list of the providers involved and their + role, e.g. assessing provider, assessment + provider, assessment location provider.

+ type: object + required: + - ProviderInvolved + properties: + ProviderInvolved: + type: array + items: + description:

The provider involved with the + assessment task and the role they play, + e.g. assessing provider, assessment + location provider, assessment provider, + registering provider.

+ type: object + required: + - ObjectType + - ProviderRole + properties: + ProviderRole: + type: string + title: Assessment Provider Role + description: >- +

Code set denoting the role of the + provider in the assessment, e.g. + Assessing Provider, Location + Provider.

    +
  • 'ASR' - Assessor
    • +
  • 'LOC' - Location Provider
    • +
  • 'PRO' - Provider
    • +
+ oneOf: + - title: Assessor + enum: + - ASR + - title: Location Provider + enum: + - LOC + - title: Provider + enum: + - PRO + ProviderCourse: + $ref: "#/paths/~1StudentAssessmentTasks/get/responses\ + /200/content/application~1json/schema/propertie\ + s/StudentAssessmentTasks/properties/StudentAsse\ + ssmentTask/items/properties/Student" + LearningStandard: + $ref: "#/paths/~1StudentAssessmentTasks/get/responses\ + /200/content/application~1json/schema/propertie\ + s/StudentAssessmentTasks/properties/StudentAsse\ + ssmentTask/items/properties/Student" + StaffInvolvedList: + description:

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.

+ type: object + required: + - StaffInvolved + properties: + StaffInvolved: + type: array + items: + description:

The staff member involved with the + assessment task and their role, e.g. + created the assessment task, moderator, + marker.

+ type: object + required: + - ObjectType + - StaffRole + properties: + StaffRole: + type: string + title: Assessment Staff Role + description: |- + +
    +
  • 'CRE' - Creator
    • +
  • 'MOD' - Moderator
    • +
  • 'ASS' - Assessor
    • +
  • 'INV' - Invigilator
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Creator + enum: + - CRE + - title: Moderator + enum: + - MOD + - title: Assessor + enum: + - ASS + - title: Invigilator + enum: + - INV + - title: Other + enum: + - OTH + DateTimeAssessmentScheduled: + description:

The date and time the student is scheduled to + be assessed against the assessment task.

+ DateTimeAssessmentOccurred: + description:

The date and time the student was assessed + against the assessment task.

+ YearAssessmentOccurred: + description:

The year the student was assessed against the + assessment task.

+ AssessmentType: + type: string + title: Assessment Type + description: >- +

Standard codes denoting the type of + assessment the student is sitting for the + assessment task.

    +
  • 'INT' - Internal Exam/Assessment
    • +
  • 'EXT' - External Exam/Assessment
    • +
  • 'MOC' - Mock
    • +
  • 'POR' - Portfolio
    • +
  • 'PRA' - Practical
    • +
  • 'OTJ' - Overall Teacher Judgement
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Internal Exam/Assessment + enum: + - INT + - title: External Exam/Assessment + enum: + - EXT + - title: Mock + enum: + - MOC + - title: Portfolio + enum: + - POR + - title: Practical + enum: + - PRA + - title: Overall Teacher Judgement + enum: + - OTJ + - title: Other + enum: + - OTH + Status: + type: string + title: Assessment Status + description: >- +

Codes denoting the current status of the + assessment task.

    +
  • 'MOD' - Moderated
    • +
  • 'NOT' - Unmoderated
    • +
  • 'PUB' - Published
    • +
  • 'ENT' - Entered
    • +
  • 'MAR' - Marked
    • +
+ oneOf: + - title: Moderated + enum: + - MOD + - title: Unmoderated + enum: + - NOT + - title: Published + enum: + - PUB + - title: Entered + enum: + - ENT + - title: Marked + enum: + - MAR + Timeframe: + type: string + title: Assessment Timeframe + description: >- +

The timeframe of the assessment, e.g. + Mid-Year, End of Year.

    +
  • 'OTH' - Other
    • +
  • 'OUT' - Out of Cycle
    • +
  • 'INT' - Interim
    • +
  • 'END' - End of Year
    • +
+ oneOf: + - title: Other + enum: + - OTH + - title: Out of Cycle + enum: + - OUT + - title: Interim + enum: + - INT + - title: End of Year + enum: + - END + NCEAStatusDate: + type: string + format: date + description:

Date the current NCEA status was set.

+ AchievementAttempt: + type: integer + description:

The attempt number the student is making to + pass this assessment, e.g. is it their first, + second attempt.

+ SubjectAreaList: + description:

The list of Subject Area the assessment task + pertains to.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZ Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication + Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural + Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication + (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + YearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid + for describing Funding Year Level and Current + Year Level for a student enrolment.

+

Current Year Level indicates the year level + of the student’s class cohort and the level at + which the student spends most of their time at + school. While a student may be enrolled in + subjects at varying instructional year levels, + in relation to the student enrolment this value + represents the year level at which the student + is considered to be predominantly taught.

+

Funding Year Level measures the actual number + of years that the student has attended a school. + It provides the Ministry with a method of + counting students for funding purposes which is + independent of the way schools are organised or + the particular programme of study that a student + may undertake. Funding Year Level for most + students is based on the date they first started + school.

School Year Level is used to + indicate the instructional year levels offered + by a school, i.e. those years for which student + enrolments may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates + Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + SpecialAssessmentConditionList: + description:

The list of the special assessment conditions + that the student is entitled to have when + sitting this assessment task.

+ type: object + required: + - SpecialAssessmentCondition + properties: + SpecialAssessmentCondition: + type: array + items: + type: string + title: Special Assessment Condition + description: >- +

Standard codes denoting special + assessment conditions that a student + requires when sitting an assessment.

+
    +
  • 'BRA' - Braille Paper
    • +
  • 'COM' - Computer OR Writer
    • +
  • 'ENL' - Enlarged Paper
    • +
  • 'EXT' - Extra Time
    • +
  • 'OTH' - Other
    • +
  • 'REA' - Reader
    • +
  • 'RES' - Rest Breaks
    • +
  • 'SEP' - Separate Accommodation
    • +
  • 'SIR' - Signing Reader
    • +
  • 'SIS' - Signing Supervisor
    • +
  • 'SPE' - Special Paper
    • +
+ oneOf: + - title: Braille Paper + enum: + - BRA + - title: Computer OR Writer + enum: + - COM + - title: Enlarged Paper + enum: + - ENL + - title: Extra Time + enum: + - EXT + - title: Other + enum: + - OTH + - title: Reader + enum: + - REA + - title: Rest Breaks + enum: + - RES + - title: Separate Accommodation + enum: + - SEP + - title: Signing Reader + enum: + - SIR + - title: Signing Supervisor + enum: + - SIS + - title: Special Paper + enum: + - SPE + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentAssessmentTasks: + StudentAssessmentTask: + - StudentAssessmentTaskRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + Student: + RefId: cd106d6d-d9d5-41fb-9943-5feb967c9435 + LocalId: HP-850139 + Name: Harry Potter + AssessmentTask: + RefId: D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + ProviderInvolvedList: + ProviderInvolved: + - RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: LOC + - RefId: ad30d3a6-e663-4d5b-8975-6c4ffc745bfb + ProviderRole: PRO + ProviderCourse: + RefId: 2c55ec5e-7def-4815-ae08-caad3b9f274d + StaffInvolvedList: + StaffInvolved: + RefId: 228a2cbe-93c4-46ba-91fa-b3ae689eb437 + Name: Prof. McGonnegal + StaffRole: INV + DateTimeAssessmentScheduled: 2018-11-25T09:00:00+12:00 + AssessmentType: EXT + SubjectAreaList: + SubjectArea: PHYS + YearLevel: 11 + application/xml: + schema: + type: object + properties: + StudentAssessmentTasks: + type: object + description: A List of StudentAssessmentTask objects + properties: + StudentAssessmentTask: + type: array + items: + $ref: "#/paths/~1StudentAssessmentTasks/get/responses/200\ + /content/application~1json/schema/properties/Studen\ + tAssessmentTasks/properties/StudentAssessmentTask/i\ + tems" + example: >- + + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + HP-850139 + Harry Potter + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + LOC + + + ad30d3a6-e663-4d5b-8975-6c4ffc745bfb + PRO + + + + 2c55ec5e-7def-4815-ae08-caad3b9f274d + + + + 228a2cbe-93c4-46ba-91fa-b3ae689eb437 + Prof. McGonnegal + INV + + + 2018-11-25T09:00:00+12:00 + EXT + + PHYS + + 11 + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentAssessmentTasks/{StudentAssessmentTaskRefId}": + post: + tags: + - StudentAssessmentTask + summary: Default operation to create a single StudentAssessmentTask + parameters: + - name: StudentAssessmentTaskRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: createStudentAssessmentTask + requestBody: + description: CRUD operation on StudentAssessmentTask + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTask: + $ref: "#/paths/~1StudentAssessmentTasks/get/responses/200/content\ + /application~1json/schema/properties/StudentAssessmentTasks\ + /properties/StudentAssessmentTask/items" + example: + StudentAssessmentTask: + StudentAssessmentTaskRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + Student: + RefId: cd106d6d-d9d5-41fb-9943-5feb967c9435 + LocalId: HP-850139 + Name: Harry Potter + AssessmentTask: + RefId: D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + ProviderInvolvedList: + ProviderInvolved: + - RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: LOC + - RefId: ad30d3a6-e663-4d5b-8975-6c4ffc745bfb + ProviderRole: PRO + ProviderCourse: + RefId: 2c55ec5e-7def-4815-ae08-caad3b9f274d + StaffInvolvedList: + StaffInvolved: + RefId: 228a2cbe-93c4-46ba-91fa-b3ae689eb437 + Name: Prof. McGonnegal + StaffRole: INV + DateTimeAssessmentScheduled: 2018-11-25T09:00:00+12:00 + AssessmentType: EXT + SubjectAreaList: + SubjectArea: PHYS + YearLevel: 11 + application/xml: + schema: + type: object + properties: + StudentAssessmentTask: + $ref: "#/paths/~1StudentAssessmentTasks/get/responses/200/content\ + /application~1json/schema/properties/StudentAssessmentTasks\ + /properties/StudentAssessmentTask/items" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + HP-850139 + Harry Potter + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + LOC + + + ad30d3a6-e663-4d5b-8975-6c4ffc745bfb + PRO + + + + 2c55ec5e-7def-4815-ae08-caad3b9f274d + + + + 228a2cbe-93c4-46ba-91fa-b3ae689eb437 + Prof. McGonnegal + INV + + + 2018-11-25T09:00:00+12:00 + EXT + + PHYS + + 11 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentAssessmentTask + summary: Default operation to update a single StudentAssessmentTask + parameters: + - name: StudentAssessmentTaskRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: updateStudentAssessmentTask + requestBody: + description: CRUD operation on StudentAssessmentTask + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTask: + type: object + properties: + StudentAssessmentTaskRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentAssessmentTaskLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentAssessmentTasks~1%7BStudentAssess\ + mentTaskRefId%7D/put/requestBody/content/applicatio\ + n~1json/schema/properties/StudentAssessmentTask/pro\ + perties/StudentAssessmentTaskRefId" + LocalId: + $ref: "#/paths/~1StudentAssessmentTasks~1%7BStudentAssess\ + mentTaskRefId%7D/put/requestBody/content/applicatio\ + n~1json/schema/properties/StudentAssessmentTask/pro\ + perties/StudentAssessmentTaskLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + AssessmentTask: + $ref: "#/paths/~1StudentAssessmentTasks~1%7BStudentAssessment\ + TaskRefId%7D/put/requestBody/content/application~1json/\ + schema/properties/StudentAssessmentTask/properties/Stud\ + ent" + ProviderInvolvedList: + description:

A list of the providers involved and their role, e.g. + assessing provider, assessment provider, assessment + location provider.

+ type: object + properties: + ProviderInvolved: + type: array + items: + description:

The provider involved with the assessment task + and the role they play, e.g. assessing provider, + assessment location provider, assessment provider, + registering provider.

+ type: object + properties: + ProviderRole: + type: string + title: Assessment Provider Role + description: >- +

Code set denoting the role of the provider + in the assessment, e.g. Assessing Provider, + Location Provider.

    +
  • 'ASR' - Assessor
    • +
  • 'LOC' - Location Provider
    • +
  • 'PRO' - Provider
    • +
+ oneOf: + - title: Assessor + enum: + - ASR + - title: Location Provider + enum: + - LOC + - title: Provider + enum: + - PRO + ProviderCourse: + $ref: "#/paths/~1StudentAssessmentTasks~1%7BStudentAssessment\ + TaskRefId%7D/put/requestBody/content/application~1json/\ + schema/properties/StudentAssessmentTask/properties/Stud\ + ent" + LearningStandard: + $ref: "#/paths/~1StudentAssessmentTasks~1%7BStudentAssessment\ + TaskRefId%7D/put/requestBody/content/application~1json/\ + schema/properties/StudentAssessmentTask/properties/Stud\ + ent" + StaffInvolvedList: + description:

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.

+ type: object + properties: + StaffInvolved: + type: array + items: + description:

The staff member involved with the assessment + task and their role, e.g. created the assessment + task, moderator, marker.

+ type: object + properties: + StaffRole: + type: string + title: Assessment Staff Role + description: |- + +
    +
  • 'CRE' - Creator
    • +
  • 'MOD' - Moderator
    • +
  • 'ASS' - Assessor
    • +
  • 'INV' - Invigilator
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Creator + enum: + - CRE + - title: Moderator + enum: + - MOD + - title: Assessor + enum: + - ASS + - title: Invigilator + enum: + - INV + - title: Other + enum: + - OTH + DateTimeAssessmentScheduled: + description:

The date and time the student is scheduled to be + assessed against the assessment task.

+ DateTimeAssessmentOccurred: + description:

The date and time the student was assessed against + the assessment task.

+ YearAssessmentOccurred: + description:

The year the student was assessed against the + assessment task.

+ AssessmentType: + type: string + title: Assessment Type + description: >- +

Standard codes denoting the type of assessment the + student is sitting for the assessment task.

    +
  • 'INT' - Internal Exam/Assessment
    • +
  • 'EXT' - External Exam/Assessment
    • +
  • 'MOC' - Mock
    • +
  • 'POR' - Portfolio
    • +
  • 'PRA' - Practical
    • +
  • 'OTJ' - Overall Teacher Judgement
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Internal Exam/Assessment + enum: + - INT + - title: External Exam/Assessment + enum: + - EXT + - title: Mock + enum: + - MOC + - title: Portfolio + enum: + - POR + - title: Practical + enum: + - PRA + - title: Overall Teacher Judgement + enum: + - OTJ + - title: Other + enum: + - OTH + Status: + type: string + title: Assessment Status + description: >- +

Codes denoting the current status of the assessment + task.

    +
  • 'MOD' - Moderated
    • +
  • 'NOT' - Unmoderated
    • +
  • 'PUB' - Published
    • +
  • 'ENT' - Entered
    • +
  • 'MAR' - Marked
    • +
+ oneOf: + - title: Moderated + enum: + - MOD + - title: Unmoderated + enum: + - NOT + - title: Published + enum: + - PUB + - title: Entered + enum: + - ENT + - title: Marked + enum: + - MAR + Timeframe: + type: string + title: Assessment Timeframe + description: >- +

The timeframe of the assessment, e.g. Mid-Year, End + of Year.

    +
  • 'OTH' - Other
    • +
  • 'OUT' - Out of Cycle
    • +
  • 'INT' - Interim
    • +
  • 'END' - End of Year
    • +
+ oneOf: + - title: Other + enum: + - OTH + - title: Out of Cycle + enum: + - OUT + - title: Interim + enum: + - INT + - title: End of Year + enum: + - END + NCEAStatusDate: + type: string + format: date + description:

Date the current NCEA status was set.

+ AchievementAttempt: + type: integer + description:

The attempt number the student is making to pass this + assessment, e.g. is it their first, second attempt.

+ SubjectAreaList: + description:

The list of Subject Area the assessment task pertains + to.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + YearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid for + describing Funding Year Level and Current Year Level for + a student enrolment.

Current Year Level indicates + the year level of the student’s class cohort and the + level at which the student spends most of their time at + school. While a student may be enrolled in subjects at + varying instructional year levels, in relation to the + student enrolment this value represents the year level + at which the student is considered to be predominantly + taught.

Funding Year Level measures the actual + number of years that the student has attended a school. + It provides the Ministry with a method of counting + students for funding purposes which is independent of + the way schools are organised or the particular + programme of study that a student may undertake. Funding + Year Level for most students is based on the date they + first started school.

School Year Level is used + to indicate the instructional year levels offered by a + school, i.e. those years for which student enrolments + may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates Year 14 + and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + SpecialAssessmentConditionList: + description:

The list of the special assessment conditions that + the student is entitled to have when sitting this + assessment task.

+ type: object + properties: + SpecialAssessmentCondition: + type: array + items: + type: string + title: Special Assessment Condition + description: >- +

Standard codes denoting special assessment + conditions that a student requires when sitting an + assessment.

    +
  • 'BRA' - Braille Paper
    • +
  • 'COM' - Computer OR Writer
    • +
  • 'ENL' - Enlarged Paper
    • +
  • 'EXT' - Extra Time
    • +
  • 'OTH' - Other
    • +
  • 'REA' - Reader
    • +
  • 'RES' - Rest Breaks
    • +
  • 'SEP' - Separate Accommodation
    • +
  • 'SIR' - Signing Reader
    • +
  • 'SIS' - Signing Supervisor
    • +
  • 'SPE' - Special Paper
    • +
+ oneOf: + - title: Braille Paper + enum: + - BRA + - title: Computer OR Writer + enum: + - COM + - title: Enlarged Paper + enum: + - ENL + - title: Extra Time + enum: + - EXT + - title: Other + enum: + - OTH + - title: Reader + enum: + - REA + - title: Rest Breaks + enum: + - RES + - title: Separate Accommodation + enum: + - SEP + - title: Signing Reader + enum: + - SIR + - title: Signing Supervisor + enum: + - SIS + - title: Special Paper + enum: + - SPE + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentAssessmentTask: + StudentAssessmentTaskRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + Student: + RefId: cd106d6d-d9d5-41fb-9943-5feb967c9435 + LocalId: HP-850139 + Name: Harry Potter + AssessmentTask: + RefId: D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + ProviderInvolvedList: + ProviderInvolved: + - RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: LOC + - RefId: ad30d3a6-e663-4d5b-8975-6c4ffc745bfb + ProviderRole: PRO + ProviderCourse: + RefId: 2c55ec5e-7def-4815-ae08-caad3b9f274d + StaffInvolvedList: + StaffInvolved: + RefId: 228a2cbe-93c4-46ba-91fa-b3ae689eb437 + Name: Prof. McGonnegal + StaffRole: INV + DateTimeAssessmentScheduled: 2018-11-25T09:00:00+12:00 + AssessmentType: EXT + SubjectAreaList: + SubjectArea: PHYS + YearLevel: 11 + application/xml: + schema: + type: object + properties: + StudentAssessmentTask: + $ref: "#/paths/~1StudentAssessmentTasks~1%7BStudentAssessmentTask\ + RefId%7D/put/requestBody/content/application~1json/schema/p\ + roperties/StudentAssessmentTask" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + HP-850139 + Harry Potter + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + LOC + + + ad30d3a6-e663-4d5b-8975-6c4ffc745bfb + PRO + + + + 2c55ec5e-7def-4815-ae08-caad3b9f274d + + + + 228a2cbe-93c4-46ba-91fa-b3ae689eb437 + Prof. McGonnegal + INV + + + 2018-11-25T09:00:00+12:00 + EXT + + PHYS + + 11 + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentAssessmentTask + summary: Default operation to get a single StudentAssessmentTask + parameters: + - name: StudentAssessmentTaskRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTask: + $ref: "#/paths/~1StudentAssessmentTasks/get/responses/200/conte\ + nt/application~1json/schema/properties/StudentAssessmentT\ + asks/properties/StudentAssessmentTask/items" + example: + StudentAssessmentTask: + StudentAssessmentTaskRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + Student: + RefId: cd106d6d-d9d5-41fb-9943-5feb967c9435 + LocalId: HP-850139 + Name: Harry Potter + AssessmentTask: + RefId: D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + ProviderInvolvedList: + ProviderInvolved: + - RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: LOC + - RefId: ad30d3a6-e663-4d5b-8975-6c4ffc745bfb + ProviderRole: PRO + ProviderCourse: + RefId: 2c55ec5e-7def-4815-ae08-caad3b9f274d + StaffInvolvedList: + StaffInvolved: + RefId: 228a2cbe-93c4-46ba-91fa-b3ae689eb437 + Name: Prof. McGonnegal + StaffRole: INV + DateTimeAssessmentScheduled: 2018-11-25T09:00:00+12:00 + AssessmentType: EXT + SubjectAreaList: + SubjectArea: PHYS + YearLevel: 11 + application/xml: + schema: + type: object + properties: + StudentAssessmentTask: + $ref: "#/paths/~1StudentAssessmentTasks/get/responses/200/conte\ + nt/application~1json/schema/properties/StudentAssessmentT\ + asks/properties/StudentAssessmentTask/items" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + HP-850139 + Harry Potter + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + LOC + + + ad30d3a6-e663-4d5b-8975-6c4ffc745bfb + PRO + + + + 2c55ec5e-7def-4815-ae08-caad3b9f274d + + + + 228a2cbe-93c4-46ba-91fa-b3ae689eb437 + Prof. McGonnegal + INV + + + 2018-11-25T09:00:00+12:00 + EXT + + PHYS + + 11 + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentAssessmentTask + summary: Default operation to delete a single StudentAssessmentTask + parameters: + - name: StudentAssessmentTaskRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentAssessmentTaskResults: + get: + tags: + - StudentAssessmentTaskResult + summary: Default operation to get a list of all available + StudentAssessmentTaskResults + description: Search the set of available StudentAssessmentTaskResults, according to + the search criteria in the URL parameters. Returns the first 20 objects + located; with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTaskResults: + type: object + description: A List of StudentAssessmentTaskResult objects + properties: + StudentAssessmentTaskResult: + type: array + items: + required: + - ProviderInvolvedList + - Student + - StudentAssessmentTask + type: object + properties: + StudentAssessmentTaskResultRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentAssessmentTaskResultLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + StudentAssessmentTask: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentAssessmentTaskResults/get\ + /responses/200/content/application~1json/sc\ + hema/properties/StudentAssessmentTaskResult\ + s/properties/StudentAssessmentTaskResult/it\ + ems/properties/StudentAssessmentTaskResultR\ + efId" + LocalId: + $ref: "#/paths/~1StudentAssessmentTaskResults/get\ + /responses/200/content/application~1json/sc\ + hema/properties/StudentAssessmentTaskResult\ + s/properties/StudentAssessmentTaskResult/it\ + ems/properties/StudentAssessmentTaskResultL\ + ocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + AssessmentType: + type: string + title: Assessment Type + description: >- +

Standard codes denoting the type of + assessment the student is sitting for the + assessment task.

    +
  • 'INT' - Internal Exam/Assessment
    • +
  • 'EXT' - External Exam/Assessment
    • +
  • 'MOC' - Mock
    • +
  • 'POR' - Portfolio
    • +
  • 'PRA' - Practical
    • +
  • 'OTJ' - Overall Teacher Judgement
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Internal Exam/Assessment + enum: + - INT + - title: External Exam/Assessment + enum: + - EXT + - title: Mock + enum: + - MOC + - title: Portfolio + enum: + - POR + - title: Practical + enum: + - PRA + - title: Overall Teacher Judgement + enum: + - OTJ + - title: Other + enum: + - OTH + Student: + $ref: "#/paths/~1StudentAssessmentTaskResults/get/res\ + ponses/200/content/application~1json/schema/pro\ + perties/StudentAssessmentTaskResults/properties\ + /StudentAssessmentTaskResult/items/properties/S\ + tudentAssessmentTask" + ProviderInvolvedList: + description:

A list of the providers involved and their + role, e.g. assessing provider, assessment + provider, assessment location provider, + registering provider.

+ type: object + required: + - ProviderInvolved + properties: + ProviderInvolved: + type: array + items: + description:

The provider involved with the + assessment task and the role they play, + e.g. assessing provider, assessment + location provider, assessment provider, + registering provider.

+ type: object + required: + - ObjectType + - ProviderRole + properties: + ProviderRole: + type: string + title: Assessment Provider Role + description: >- +

Code set denoting the role of the + provider in the assessment, e.g. + Assessing Provider, Location + Provider.

    +
  • 'ASR' - Assessor
    • +
  • 'LOC' - Location Provider
    • +
  • 'PRO' - Provider
    • +
+ oneOf: + - title: Assessor + enum: + - ASR + - title: Location Provider + enum: + - LOC + - title: Provider + enum: + - PRO + StaffInvolvedList: + description:

A list of the staff involved and their role + in relation to the assessment task, e.g. the + moderator, the marker.

+ type: object + required: + - StaffInvolved + properties: + StaffInvolved: + type: array + items: + description:

The staff member involved with the + assessment task and their role, e.g. + created the assessment task, moderator, + marker.

+ type: object + required: + - ObjectType + - StaffRole + properties: + StaffRole: + type: string + title: Assessment Staff Role + description: |- + +
    +
  • 'CRE' - Creator
    • +
  • 'MOD' - Moderator
    • +
  • 'ASS' - Assessor
    • +
  • 'INV' - Invigilator
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Creator + enum: + - CRE + - title: Moderator + enum: + - MOD + - title: Assessor + enum: + - ASS + - title: Invigilator + enum: + - INV + - title: Other + enum: + - OTH + ProviderCourse: + $ref: "#/paths/~1StudentAssessmentTaskResults/get/res\ + ponses/200/content/application~1json/schema/pro\ + perties/StudentAssessmentTaskResults/properties\ + /StudentAssessmentTaskResult/items/properties/S\ + tudentAssessmentTask" + LearningStandard: + $ref: "#/paths/~1StudentAssessmentTaskResults/get/res\ + ponses/200/content/application~1json/schema/pro\ + perties/StudentAssessmentTaskResults/properties\ + /StudentAssessmentTaskResult/items/properties/S\ + tudentAssessmentTask" + SubjectAreaList: + description:

A list of the subject areas that the + assessment pertains to.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZ Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication + Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural + Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication + (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + StudentYearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid + for describing Funding Year Level and Current + Year Level for a student enrolment.

+

Current Year Level indicates the year level + of the student’s class cohort and the level at + which the student spends most of their time at + school. While a student may be enrolled in + subjects at varying instructional year levels, + in relation to the student enrolment this value + represents the year level at which the student + is considered to be predominantly taught.

+

Funding Year Level measures the actual number + of years that the student has attended a school. + It provides the Ministry with a method of + counting students for funding purposes which is + independent of the way schools are organised or + the particular programme of study that a student + may undertake. Funding Year Level for most + students is based on the date they first started + school.

School Year Level is used to + indicate the instructional year levels offered + by a school, i.e. those years for which student + enrolments may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates + Year 14 and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + Curriculum: + type: string + title: Curriculum + description: >- +

Codes denoting the two curricula used in New + Zealand.

    +
  • 'NZC' - NZ Curriculum
    • +
  • 'TMA' - Te Marautanga o Aotearoa
    • +
  • 'ECE' - Te Whaariki
    • +
  • 'OTH' - Other Curriculum
    • +
+ oneOf: + - title: NZ Curriculum + enum: + - NZC + - title: Te Marautanga o Aotearoa + enum: + - TMA + - title: Te Whaariki + enum: + - ECE + - title: Other Curriculum + enum: + - OTH + CurriculumLevel: + type: string + title: Curriculum Level + description: >- +

Codes denoting the levels of the two + Curricula used in New Zealand.

    +
  • '1' - Student is working at level 1 of the relevant curriculum
    • +
  • '2' - Student is working at level 2 of the relevant curriculum
    • +
  • '3' - Student is working at level 3 of the relevant curriculum
    • +
  • '4' - Student is working at level 4 of the relevant curriculum
    • +
  • '5' - Student is working at level 5 of the relevant curriculum
    • +
  • '6' - Student is working at level 6 of the relevant curriculum
    • +
  • '7' - Student is working at level 7 of the relevant curriculum
    • +
  • '8' - Student is working at level 8 of the relevant curriculum
    • +
+ oneOf: + - title: Student is working at level 1 of the + relevant curriculum + enum: + - "1" + - title: Student is working at level 2 of the + relevant curriculum + enum: + - "2" + - title: Student is working at level 3 of the + relevant curriculum + enum: + - "3" + - title: Student is working at level 4 of the + relevant curriculum + enum: + - "4" + - title: Student is working at level 5 of the + relevant curriculum + enum: + - "5" + - title: Student is working at level 6 of the + relevant curriculum + enum: + - "6" + - title: Student is working at level 7 of the + relevant curriculum + enum: + - "7" + - title: Student is working at level 8 of the + relevant curriculum + enum: + - "8" + AssessmentToolTypeName: + type: string + description:

The type of assessment tool used for the + assessment task.

+ Timeframe: + type: string + title: Assessment Timeframe + description: >- +

The timeframe of the assessment, e.g. + Mid-Year, End of Year.

    +
  • 'OTH' - Other
    • +
  • 'OUT' - Out of Cycle
    • +
  • 'INT' - Interim
    • +
  • 'END' - End of Year
    • +
+ oneOf: + - title: Other + enum: + - OTH + - title: Out of Cycle + enum: + - OUT + - title: Interim + enum: + - INT + - title: End of Year + enum: + - END + AchievementAttempt: + type: integer + description:

The attempt number the student is making to + pass this assessment, e.g. is it their first or + second attempt.

+ SummativeIndicator: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and + not provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + FormativeIndicator: + $ref: "#/paths/~1StudentAssessmentTaskResults/get/res\ + ponses/200/content/application~1json/schema/pro\ + perties/StudentAssessmentTaskResults/properties\ + /StudentAssessmentTaskResult/items/properties/S\ + ummativeIndicator" + DateMarked: + type: string + format: date + description:

Date the assessment task was marked.

+ DateAssessed: + type: string + format: date + description:

Date the student was asssessed against this + assessment.

+ DateStudentNotified: + type: string + format: date + description:

The date the student was notified of their + final mark for the assessment task.

+ PublishedDate: + type: string + format: date + description:

The date the assessment task result was first + published in a report.

+ Iteration: + type: integer + description:

The iteration of this result for the + assessment, e.g. some tasks require multiple + assessments before being achieved.

+ CreditsAchieved: + type: integer + description:

The number of credits the student + achieved.

+ ResultScoreList: + description:

A list of the assessment result scores that + the student received for this assessment + task.

+ type: object + required: + - ResultScore + properties: + ResultScore: + type: array + items: + description:

An individual result score for the + assessment task.

+ type: object + properties: + Competency: + type: string + description:

String describing a particular + competency that is being reported in + the assessment.

+ ScoreMetric: + type: string + title: Score Metric + description: >- +

The type of score metric used for + an assessment task result.

    +
  • 'RAW' - Raw
    • +
  • 'SCA' - Scale
    • +
  • 'MAR' - Margin of Error
    • +
  • 'STA' - Stanine
    • +
  • 'YEA' - Year Level
    • +
  • 'NA' - NA
    • +
  • 'NAM' - NAME
    • +
  • 'CUR' - Curriculum Level
    • +
+ oneOf: + - title: Raw + enum: + - RAW + - title: Scale + enum: + - SCA + - title: Margin of Error + enum: + - MAR + - title: Stanine + enum: + - STA + - title: Year Level + enum: + - YEA + - title: NA + description: '"NZQA Unit Standards: Not + Achieved, Achieved"' + enum: + - NA + - title: NAME + description: '"NZQA Achievement Standards: Not + Achieved, Achieved, Achieved with + Merit, Achieved with Excellence"' + enum: + - NAM + - title: Curriculum Level + description: '"Student is assessed to be at one + of the levels defined by The + National Curriculum: 1A, 1B + through 5A, 5B"' + enum: + - CUR + ScoreValue: + type: string + description:

The actual score

+ FinalResultValue: + type: string + description:

The final result that was given to the + student for this assessment task.

+ EffortComment: + type: string + description:

Free text comment about the effort the + student made for the assessment.

+ OtherComment: + type: string + description:

Free text comments providing additional + information for the students assessment + result.

+ DocumentList: + description:

List which describes the meta-data for, and + the Location of any associated documents.

+ type: object + required: + - Document + properties: + Document: + type: array + items: + $ref: "#/paths/~1StudentAssessmentTaskResults/g\ + et/responses/200/content/application~1jso\ + n/schema/properties/StudentAssessmentTask\ + Results/properties/StudentAssessmentTaskR\ + esult/items/properties/StudentAssessmentT\ + ask" + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentAssessmentTaskResults: + StudentAssessmentTaskResult: + - StudentAssessmentTaskResultRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + AssessmentType: INT + Student: + RefId: A75A0010-1A8C-301D-02E3-A05B359D0A00 + ProviderInvolvedList: + ProviderInvolved: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: PRO + SubjectAreaList: + SubjectArea: MATH + SummativeIndicator: N + FormativeIndicator: Y + DateAssessed: 2018-11-21 + ResultScoreList: + ResultScore: + - ScoreMetric: RAW + ScoreValue: 25 + - ScoreMetric: SCA + ScoreValue: 38.5 + - ScoreMetric: MAR + ScoreValue: 5 + - ScoreMetric: STA + ScoreValue: 6 + - ScoreMetric: YEA + ScoreValue: 4 + application/xml: + schema: + type: object + properties: + StudentAssessmentTaskResults: + type: object + description: A List of StudentAssessmentTaskResult objects + properties: + StudentAssessmentTaskResult: + type: array + items: + $ref: "#/paths/~1StudentAssessmentTaskResults/get/respons\ + es/200/content/application~1json/schema/properties/\ + StudentAssessmentTaskResults/properties/StudentAsse\ + ssmentTaskResult/items" + example: >- + + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + INT + + A75A0010-1A8C-301D-02E3-A05B359D0A00 + + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + PRO + + + + MATH + + N + Y + 2018-11-21 + + + RAW + 25 + + + SCA + 38.5 + + + MAR + 5.0 + + + STA + 6 + + + YEA + 4 + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentAssessmentTaskResults/{StudentAssessmentTaskResultRefId}": + post: + tags: + - StudentAssessmentTaskResult + summary: Default operation to create a single StudentAssessmentTaskResult + parameters: + - name: StudentAssessmentTaskResultRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: createStudentAssessmentTaskResult + requestBody: + description: CRUD operation on StudentAssessmentTaskResult + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTaskResult: + $ref: "#/paths/~1StudentAssessmentTaskResults/get/responses/200/c\ + ontent/application~1json/schema/properties/StudentAssessmen\ + tTaskResults/properties/StudentAssessmentTaskResult/items" + example: + StudentAssessmentTaskResult: + StudentAssessmentTaskResultRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + AssessmentType: INT + Student: + RefId: A75A0010-1A8C-301D-02E3-A05B359D0A00 + ProviderInvolvedList: + ProviderInvolved: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: PRO + SubjectAreaList: + SubjectArea: MATH + SummativeIndicator: N + FormativeIndicator: Y + DateAssessed: 2018-11-21 + ResultScoreList: + ResultScore: + - ScoreMetric: RAW + ScoreValue: 25 + - ScoreMetric: SCA + ScoreValue: 38.5 + - ScoreMetric: MAR + ScoreValue: 5 + - ScoreMetric: STA + ScoreValue: 6 + - ScoreMetric: YEA + ScoreValue: 4 + application/xml: + schema: + type: object + properties: + StudentAssessmentTaskResult: + $ref: "#/paths/~1StudentAssessmentTaskResults/get/responses/200/c\ + ontent/application~1json/schema/properties/StudentAssessmen\ + tTaskResults/properties/StudentAssessmentTaskResult/items" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + INT + + A75A0010-1A8C-301D-02E3-A05B359D0A00 + + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + PRO + + + + MATH + + N + Y + 2018-11-21 + + + RAW + 25 + + + SCA + 38.5 + + + MAR + 5.0 + + + STA + 6 + + + YEA + 4 + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentAssessmentTaskResult + summary: Default operation to update a single StudentAssessmentTaskResult + parameters: + - name: StudentAssessmentTaskResultRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: updateStudentAssessmentTaskResult + requestBody: + description: CRUD operation on StudentAssessmentTaskResult + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTaskResult: + type: object + properties: + StudentAssessmentTaskResultRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentAssessmentTaskResultLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + StudentAssessmentTask: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentAssessmentTaskResults~1%7BStudent\ + AssessmentTaskResultRefId%7D/put/requestBody/conten\ + t/application~1json/schema/properties/StudentAssess\ + mentTaskResult/properties/StudentAssessmentTaskResu\ + ltRefId" + LocalId: + $ref: "#/paths/~1StudentAssessmentTaskResults~1%7BStudent\ + AssessmentTaskResultRefId%7D/put/requestBody/conten\ + t/application~1json/schema/properties/StudentAssess\ + mentTaskResult/properties/StudentAssessmentTaskResu\ + ltLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + AssessmentType: + type: string + title: Assessment Type + description: >- +

Standard codes denoting the type of assessment the + student is sitting for the assessment task.

    +
  • 'INT' - Internal Exam/Assessment
    • +
  • 'EXT' - External Exam/Assessment
    • +
  • 'MOC' - Mock
    • +
  • 'POR' - Portfolio
    • +
  • 'PRA' - Practical
    • +
  • 'OTJ' - Overall Teacher Judgement
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Internal Exam/Assessment + enum: + - INT + - title: External Exam/Assessment + enum: + - EXT + - title: Mock + enum: + - MOC + - title: Portfolio + enum: + - POR + - title: Practical + enum: + - PRA + - title: Overall Teacher Judgement + enum: + - OTJ + - title: Other + enum: + - OTH + Student: + $ref: "#/paths/~1StudentAssessmentTaskResults~1%7BStudentAsse\ + ssmentTaskResultRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StudentAssessmentTaskResu\ + lt/properties/StudentAssessmentTask" + ProviderInvolvedList: + description:

A list of the providers involved and their role, e.g. + assessing provider, assessment provider, assessment + location provider, registering provider.

+ type: object + properties: + ProviderInvolved: + type: array + items: + description:

The provider involved with the assessment task + and the role they play, e.g. assessing provider, + assessment location provider, assessment provider, + registering provider.

+ type: object + properties: + ProviderRole: + type: string + title: Assessment Provider Role + description: >- +

Code set denoting the role of the provider + in the assessment, e.g. Assessing Provider, + Location Provider.

    +
  • 'ASR' - Assessor
    • +
  • 'LOC' - Location Provider
    • +
  • 'PRO' - Provider
    • +
+ oneOf: + - title: Assessor + enum: + - ASR + - title: Location Provider + enum: + - LOC + - title: Provider + enum: + - PRO + StaffInvolvedList: + description:

A list of the staff involved and their role in + relation to the assessment task, e.g. the moderator, the + marker.

+ type: object + properties: + StaffInvolved: + type: array + items: + description:

The staff member involved with the assessment + task and their role, e.g. created the assessment + task, moderator, marker.

+ type: object + properties: + StaffRole: + type: string + title: Assessment Staff Role + description: |- + +
    +
  • 'CRE' - Creator
    • +
  • 'MOD' - Moderator
    • +
  • 'ASS' - Assessor
    • +
  • 'INV' - Invigilator
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Creator + enum: + - CRE + - title: Moderator + enum: + - MOD + - title: Assessor + enum: + - ASS + - title: Invigilator + enum: + - INV + - title: Other + enum: + - OTH + ProviderCourse: + $ref: "#/paths/~1StudentAssessmentTaskResults~1%7BStudentAsse\ + ssmentTaskResultRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StudentAssessmentTaskResu\ + lt/properties/StudentAssessmentTask" + LearningStandard: + $ref: "#/paths/~1StudentAssessmentTaskResults~1%7BStudentAsse\ + ssmentTaskResultRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StudentAssessmentTaskResu\ + lt/properties/StudentAssessmentTask" + SubjectAreaList: + description:

A list of the subject areas that the assessment + pertains to.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + StudentYearLevel: + type: string + title: Year Level Code + description: >- +

Year Level defines the values that are valid for + describing Funding Year Level and Current Year Level for + a student enrolment.

Current Year Level indicates + the year level of the student’s class cohort and the + level at which the student spends most of their time at + school. While a student may be enrolled in subjects at + varying instructional year levels, in relation to the + student enrolment this value represents the year level + at which the student is considered to be predominantly + taught.

Funding Year Level measures the actual + number of years that the student has attended a school. + It provides the Ministry with a method of counting + students for funding purposes which is independent of + the way schools are organised or the particular + programme of study that a student may undertake. Funding + Year Level for most students is based on the date they + first started school.

School Year Level is used + to indicate the instructional year levels offered by a + school, i.e. those years for which student enrolments + may be accepted.

    +
  • '0' - Year 0
    • +
  • '1' - Year 1
    • +
  • '2' - Year 2
    • +
  • '3' - Year 3
    • +
  • '4' - Year 4
    • +
  • '5' - Year 5
    • +
  • '6' - Year 6
    • +
  • '7' - Year 7
    • +
  • '8' - Year 8
    • +
  • '9' - Year 9
    • +
  • '10' - Year 10
    • +
  • '11' - Year 11
    • +
plus 4 more value(s) at NZCodeSetsYearLevelCodeType + oneOf: + - title: Year 0 + description: Only applies to Funding Year Level + enum: + - "0" + - title: Year 1 + enum: + - "1" + - title: Year 2 + enum: + - "2" + - title: Year 3 + enum: + - "3" + - title: Year 4 + enum: + - "4" + - title: Year 5 + enum: + - "5" + - title: Year 6 + enum: + - "6" + - title: Year 7 + enum: + - "7" + - title: Year 8 + enum: + - "8" + - title: Year 9 + enum: + - "9" + - title: Year 10 + enum: + - "10" + - title: Year 11 + enum: + - "11" + - title: Year 12 + enum: + - "12" + - title: Year 13 + enum: + - "13" + - title: Year 14 + description: For Current Year Level this code indicates Year 14 + and above + enum: + - "14" + - title: Year 15 + description: Only applies to Funding Year Level + enum: + - "15" + Curriculum: + type: string + title: Curriculum + description: >- +

Codes denoting the two curricula used in New Zealand. +

    +
  • 'NZC' - NZ Curriculum
    • +
  • 'TMA' - Te Marautanga o Aotearoa
    • +
  • 'ECE' - Te Whaariki
    • +
  • 'OTH' - Other Curriculum
    • +
+ oneOf: + - title: NZ Curriculum + enum: + - NZC + - title: Te Marautanga o Aotearoa + enum: + - TMA + - title: Te Whaariki + enum: + - ECE + - title: Other Curriculum + enum: + - OTH + CurriculumLevel: + type: string + title: Curriculum Level + description: >- +

Codes denoting the levels of the two Curricula used + in New Zealand.

    +
  • '1' - Student is working at level 1 of the relevant curriculum
    • +
  • '2' - Student is working at level 2 of the relevant curriculum
    • +
  • '3' - Student is working at level 3 of the relevant curriculum
    • +
  • '4' - Student is working at level 4 of the relevant curriculum
    • +
  • '5' - Student is working at level 5 of the relevant curriculum
    • +
  • '6' - Student is working at level 6 of the relevant curriculum
    • +
  • '7' - Student is working at level 7 of the relevant curriculum
    • +
  • '8' - Student is working at level 8 of the relevant curriculum
    • +
+ oneOf: + - title: Student is working at level 1 of the relevant + curriculum + enum: + - "1" + - title: Student is working at level 2 of the relevant + curriculum + enum: + - "2" + - title: Student is working at level 3 of the relevant + curriculum + enum: + - "3" + - title: Student is working at level 4 of the relevant + curriculum + enum: + - "4" + - title: Student is working at level 5 of the relevant + curriculum + enum: + - "5" + - title: Student is working at level 6 of the relevant + curriculum + enum: + - "6" + - title: Student is working at level 7 of the relevant + curriculum + enum: + - "7" + - title: Student is working at level 8 of the relevant + curriculum + enum: + - "8" + AssessmentToolTypeName: + type: string + description:

The type of assessment tool used for the assessment + task.

+ Timeframe: + type: string + title: Assessment Timeframe + description: >- +

The timeframe of the assessment, e.g. Mid-Year, End + of Year.

    +
  • 'OTH' - Other
    • +
  • 'OUT' - Out of Cycle
    • +
  • 'INT' - Interim
    • +
  • 'END' - End of Year
    • +
+ oneOf: + - title: Other + enum: + - OTH + - title: Out of Cycle + enum: + - OUT + - title: Interim + enum: + - INT + - title: End of Year + enum: + - END + AchievementAttempt: + type: integer + description:

The attempt number the student is making to pass this + assessment, e.g. is it their first or second + attempt.

+ SummativeIndicator: + type: string + title: Yes Or No Category + description: >- +

A reusable code set for yes, no, unknown and not + provided values.

    +
  • 'N' - No
    • +
  • 'U' - Unknown
    • +
  • 'X' - Not Provided
    • +
  • 'Y' - Yes
    • +
+ oneOf: + - title: No + enum: + - N + - title: Unknown + enum: + - U + - title: Not Provided + enum: + - X + - title: Yes + enum: + - Y + FormativeIndicator: + $ref: "#/paths/~1StudentAssessmentTaskResults~1%7BStudentAsse\ + ssmentTaskResultRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StudentAssessmentTaskResu\ + lt/properties/SummativeIndicator" + DateMarked: + type: string + format: date + description:

Date the assessment task was marked.

+ DateAssessed: + type: string + format: date + description:

Date the student was asssessed against this + assessment.

+ DateStudentNotified: + type: string + format: date + description:

The date the student was notified of their final mark + for the assessment task.

+ PublishedDate: + type: string + format: date + description:

The date the assessment task result was first + published in a report.

+ Iteration: + type: integer + description:

The iteration of this result for the assessment, e.g. + some tasks require multiple assessments before being + achieved.

+ CreditsAchieved: + type: integer + description:

The number of credits the student achieved.

+ ResultScoreList: + description:

A list of the assessment result scores that the + student received for this assessment task.

+ type: object + properties: + ResultScore: + type: array + items: + description:

An individual result score for the assessment + task.

+ type: object + properties: + Competency: + type: string + description:

String describing a particular competency + that is being reported in the assessment.

+ ScoreMetric: + type: string + title: Score Metric + description: >- +

The type of score metric used for an + assessment task result.

    +
  • 'RAW' - Raw
    • +
  • 'SCA' - Scale
    • +
  • 'MAR' - Margin of Error
    • +
  • 'STA' - Stanine
    • +
  • 'YEA' - Year Level
    • +
  • 'NA' - NA
    • +
  • 'NAM' - NAME
    • +
  • 'CUR' - Curriculum Level
    • +
+ oneOf: + - title: Raw + enum: + - RAW + - title: Scale + enum: + - SCA + - title: Margin of Error + enum: + - MAR + - title: Stanine + enum: + - STA + - title: Year Level + enum: + - YEA + - title: NA + description: '"NZQA Unit Standards: Not Achieved, + Achieved"' + enum: + - NA + - title: NAME + description: '"NZQA Achievement Standards: Not + Achieved, Achieved, Achieved with Merit, + Achieved with Excellence"' + enum: + - NAM + - title: Curriculum Level + description: '"Student is assessed to be at one of the + levels defined by The National Curriculum: + 1A, 1B through 5A, 5B"' + enum: + - CUR + ScoreValue: + type: string + description:

The actual score

+ FinalResultValue: + type: string + description:

The final result that was given to the student for + this assessment task.

+ EffortComment: + type: string + description:

Free text comment about the effort the student made + for the assessment.

+ OtherComment: + type: string + description:

Free text comments providing additional information + for the students assessment result.

+ DocumentList: + description:

List which describes the meta-data for, and the + Location of any associated documents.

+ type: object + properties: + Document: + type: array + items: + $ref: "#/paths/~1StudentAssessmentTaskResults~1%7BStude\ + ntAssessmentTaskResultRefId%7D/put/requestBody/co\ + ntent/application~1json/schema/properties/Student\ + AssessmentTaskResult/properties/StudentAssessment\ + Task" + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentAssessmentTaskResult: + StudentAssessmentTaskResultRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + AssessmentType: INT + Student: + RefId: A75A0010-1A8C-301D-02E3-A05B359D0A00 + ProviderInvolvedList: + ProviderInvolved: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: PRO + SubjectAreaList: + SubjectArea: MATH + SummativeIndicator: N + FormativeIndicator: Y + DateAssessed: 2018-11-21 + ResultScoreList: + ResultScore: + - ScoreMetric: RAW + ScoreValue: 25 + - ScoreMetric: SCA + ScoreValue: 38.5 + - ScoreMetric: MAR + ScoreValue: 5 + - ScoreMetric: STA + ScoreValue: 6 + - ScoreMetric: YEA + ScoreValue: 4 + application/xml: + schema: + type: object + properties: + StudentAssessmentTaskResult: + $ref: "#/paths/~1StudentAssessmentTaskResults~1%7BStudentAssessme\ + ntTaskResultRefId%7D/put/requestBody/content/application~1j\ + son/schema/properties/StudentAssessmentTaskResult" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + INT + + A75A0010-1A8C-301D-02E3-A05B359D0A00 + + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + PRO + + + + MATH + + N + Y + 2018-11-21 + + + RAW + 25 + + + SCA + 38.5 + + + MAR + 5.0 + + + STA + 6 + + + YEA + 4 + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentAssessmentTaskResult + summary: Default operation to get a single StudentAssessmentTaskResult + parameters: + - name: StudentAssessmentTaskResultRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAssessmentTaskResult: + $ref: "#/paths/~1StudentAssessmentTaskResults/get/responses/200\ + /content/application~1json/schema/properties/StudentAsses\ + smentTaskResults/properties/StudentAssessmentTaskResult/i\ + tems" + example: + StudentAssessmentTaskResult: + StudentAssessmentTaskResultRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + AssessmentType: INT + Student: + RefId: A75A0010-1A8C-301D-02E3-A05B359D0A00 + ProviderInvolvedList: + ProviderInvolved: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + ProviderRole: PRO + SubjectAreaList: + SubjectArea: MATH + SummativeIndicator: N + FormativeIndicator: Y + DateAssessed: 2018-11-21 + ResultScoreList: + ResultScore: + - ScoreMetric: RAW + ScoreValue: 25 + - ScoreMetric: SCA + ScoreValue: 38.5 + - ScoreMetric: MAR + ScoreValue: 5 + - ScoreMetric: STA + ScoreValue: 6 + - ScoreMetric: YEA + ScoreValue: 4 + application/xml: + schema: + type: object + properties: + StudentAssessmentTaskResult: + $ref: "#/paths/~1StudentAssessmentTaskResults/get/responses/200\ + /content/application~1json/schema/properties/StudentAsses\ + smentTaskResults/properties/StudentAssessmentTaskResult/i\ + tems" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + INT + + A75A0010-1A8C-301D-02E3-A05B359D0A00 + + + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + PRO + + + + MATH + + N + Y + 2018-11-21 + + + RAW + 25 + + + SCA + 38.5 + + + MAR + 5.0 + + + STA + 6 + + + YEA + 4 + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentAssessmentTaskResult + summary: Default operation to delete a single StudentAssessmentTaskResult + parameters: + - name: StudentAssessmentTaskResultRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentAttainments: + get: + tags: + - StudentAttainment + summary: Default operation to get a list of all available StudentAttainments + description: Search the set of available StudentAttainments, according to the search + criteria in the URL parameters. Returns the first 20 objects located; + with SIF defined navigation headers, indicating how to retrieve + subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAttainments: + type: object + description: A List of StudentAttainment objects + properties: + StudentAttainment: + type: array + items: + required: + - Attainment + - GrantingProvider + - Student + type: object + properties: + StudentAttainmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentAttainmentLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + GrantingProvider: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentAttainments/get/responses\ + /200/content/application~1json/schema/prope\ + rties/StudentAttainments/properties/Student\ + Attainment/items/properties/StudentAttainme\ + ntRefId" + LocalId: + $ref: "#/paths/~1StudentAttainments/get/responses\ + /200/content/application~1json/schema/prope\ + rties/StudentAttainments/properties/Student\ + Attainment/items/properties/StudentAttainme\ + ntLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Attainment: + $ref: "#/paths/~1StudentAttainments/get/responses/200\ + /content/application~1json/schema/properties/St\ + udentAttainments/properties/StudentAttainment/i\ + tems/properties/GrantingProvider" + Student: + $ref: "#/paths/~1StudentAttainments/get/responses/200\ + /content/application~1json/schema/properties/St\ + udentAttainments/properties/StudentAttainment/i\ + tems/properties/GrantingProvider" + AuthorisingStaffMember: + $ref: "#/paths/~1StudentAttainments/get/responses/200\ + /content/application~1json/schema/properties/St\ + udentAttainments/properties/StudentAttainment/i\ + tems/properties/GrantingProvider" + DateAttained: + type: string + format: date + description:

The date the student achieved the + attainment.

+ YearAttained: + description:

The year the student achieved the + attainment.

+ JustificationList: + description:

A list of references identifying the + assessment task results that justify the student + achieving this attainment.

+ type: object + required: + - Justification + properties: + Justification: + type: array + items: + description:

Details of an assessment task result or + other student attainment that justifies + the student achieving this attainment. +

+ type: object + required: + - Date + - ObjectType + - Result + properties: + AssessmentType: + type: string + title: Assessment Type + description: >- +

Standard codes denoting the type of + assessment the student is sitting for + the assessment task.

    +
  • 'INT' - Internal Exam/Assessment
    • +
  • 'EXT' - External Exam/Assessment
    • +
  • 'MOC' - Mock
    • +
  • 'POR' - Portfolio
    • +
  • 'PRA' - Practical
    • +
  • 'OTJ' - Overall Teacher Judgement
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Internal Exam/Assessment + enum: + - INT + - title: External Exam/Assessment + enum: + - EXT + - title: Mock + enum: + - MOC + - title: Portfolio + enum: + - POR + - title: Practical + enum: + - PRA + - title: Overall Teacher Judgement + enum: + - OTJ + - title: Other + enum: + - OTH + Result: + type: string + description:

The final result of the assessment + task that justifies the + attainment.

+ Date: + type: string + format: date + description:

The date the justifying assessment + task was achieved.

+ CreditValue: + description:

The number of credits the + justifying assessment task contributes + towards this attainment.

+ SubjectAreaList: + description:

Code denoting the Learning or Subject Area + the assessment task is for.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZ Curriculum and Te Marautanga o + Aotearoa.

    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and + Te Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o + Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o + Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication + Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined + by the NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural + Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication + (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + EndorsementLevel: + type: string + title: NCEA Endorsement Level + description: >- +

The level of NCEA endorsement the student + received for the attainment.

    +
  • 'E' - Excellence
    • +
  • 'M' - Merit
    • +
+ oneOf: + - title: Excellence + enum: + - E + - title: Merit + enum: + - M + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentAttainments: + StudentAttainment: + - StudentAttainmentRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + GrantingProvider: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + 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 + 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 + application/xml: + schema: + type: object + properties: + StudentAttainments: + type: object + description: A List of StudentAttainment objects + properties: + StudentAttainment: + type: array + items: + $ref: "#/paths/~1StudentAttainments/get/responses/200/con\ + tent/application~1json/schema/properties/StudentAtt\ + ainments/properties/StudentAttainment/items" + example: >- + + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + NCEA Level 2 Chemistry - Endorsed with merit + Credential + + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + HP85-1039 + Harry Potter + + 2018-07-25 + + + 2752a16b-b62a-4973-9d44-23e13e1c037b + 91165-v2 + Demonstrate understanding of the properties of selected organic compounds + StudentAssessmentTaskResult + EXT + Achieved + 2016-06-28 + 4 + + + eca0da5d-94af-4223-aaa6-7c0083006efd + 91166-v2 + Demonstrate understanding of chemical reactivity + StudentAssessmentTaskResult + INT + Achieved with merit + 2016-06-01 + 3 + + + 12f4761d-5e97-4e12-804e-e16d882c86c7 + 91167-v2 + Demonstrate understanding of oxidation-reduction + StudentAssessmentTaskResult + EXT + Achieved + 2016-06-28 + 3 + + + + CHEM + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentAttainments/{StudentAttainmentRefId}": + post: + tags: + - StudentAttainment + summary: Default operation to create a single StudentAttainment + parameters: + - name: StudentAttainmentRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: createStudentAttainment + requestBody: + description: CRUD operation on StudentAttainment + content: + application/json: + schema: + type: object + properties: + StudentAttainment: + $ref: "#/paths/~1StudentAttainments/get/responses/200/content/app\ + lication~1json/schema/properties/StudentAttainments/propert\ + ies/StudentAttainment/items" + example: + StudentAttainment: + StudentAttainmentRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + GrantingProvider: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + 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 + 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 + application/xml: + schema: + type: object + properties: + StudentAttainment: + $ref: "#/paths/~1StudentAttainments/get/responses/200/content/app\ + lication~1json/schema/properties/StudentAttainments/propert\ + ies/StudentAttainment/items" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + NCEA Level 2 Chemistry - Endorsed with merit + Credential + + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + HP85-1039 + Harry Potter + + 2018-07-25 + + + 2752a16b-b62a-4973-9d44-23e13e1c037b + 91165-v2 + Demonstrate understanding of the properties of selected organic compounds + StudentAssessmentTaskResult + EXT + Achieved + 2016-06-28 + 4 + + + eca0da5d-94af-4223-aaa6-7c0083006efd + 91166-v2 + Demonstrate understanding of chemical reactivity + StudentAssessmentTaskResult + INT + Achieved with merit + 2016-06-01 + 3 + + + 12f4761d-5e97-4e12-804e-e16d882c86c7 + 91167-v2 + Demonstrate understanding of oxidation-reduction + StudentAssessmentTaskResult + EXT + Achieved + 2016-06-28 + 3 + + + + CHEM + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentAttainment + summary: Default operation to update a single StudentAttainment + parameters: + - name: StudentAttainmentRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + operationId: updateStudentAttainment + requestBody: + description: CRUD operation on StudentAttainment + content: + application/json: + schema: + type: object + properties: + StudentAttainment: + type: object + properties: + StudentAttainmentRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentAttainmentLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + GrantingProvider: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentAttainments~1%7BStudentAttainment\ + RefId%7D/put/requestBody/content/application~1json/\ + schema/properties/StudentAttainment/properties/Stud\ + entAttainmentRefId" + LocalId: + $ref: "#/paths/~1StudentAttainments~1%7BStudentAttainment\ + RefId%7D/put/requestBody/content/application~1json/\ + schema/properties/StudentAttainment/properties/Stud\ + entAttainmentLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Attainment: + $ref: "#/paths/~1StudentAttainments~1%7BStudentAttainmentRefI\ + d%7D/put/requestBody/content/application~1json/schema/p\ + roperties/StudentAttainment/properties/GrantingProvider" + Student: + $ref: "#/paths/~1StudentAttainments~1%7BStudentAttainmentRefI\ + d%7D/put/requestBody/content/application~1json/schema/p\ + roperties/StudentAttainment/properties/GrantingProvider" + AuthorisingStaffMember: + $ref: "#/paths/~1StudentAttainments~1%7BStudentAttainmentRefI\ + d%7D/put/requestBody/content/application~1json/schema/p\ + roperties/StudentAttainment/properties/GrantingProvider" + DateAttained: + type: string + format: date + description:

The date the student achieved the attainment.

+ YearAttained: + description:

The year the student achieved the attainment.

+ JustificationList: + description:

A list of references identifying the assessment task + results that justify the student achieving this + attainment.

+ type: object + properties: + Justification: + type: array + items: + description:

Details of an assessment task result or other + student attainment that justifies the student + achieving this attainment.

+ type: object + properties: + AssessmentType: + type: string + title: Assessment Type + description: >- +

Standard codes denoting the type of + assessment the student is sitting for the + assessment task.

    +
  • 'INT' - Internal Exam/Assessment
    • +
  • 'EXT' - External Exam/Assessment
    • +
  • 'MOC' - Mock
    • +
  • 'POR' - Portfolio
    • +
  • 'PRA' - Practical
    • +
  • 'OTJ' - Overall Teacher Judgement
    • +
  • 'OTH' - Other
    • +
+ oneOf: + - title: Internal Exam/Assessment + enum: + - INT + - title: External Exam/Assessment + enum: + - EXT + - title: Mock + enum: + - MOC + - title: Portfolio + enum: + - POR + - title: Practical + enum: + - PRA + - title: Overall Teacher Judgement + enum: + - OTJ + - title: Other + enum: + - OTH + Result: + type: string + description:

The final result of the assessment task + that justifies the attainment.

+ Date: + type: string + format: date + description:

The date the justifying assessment task was + achieved.

+ CreditValue: + description:

The number of credits the justifying + assessment task contributes towards this + attainment.

+ SubjectAreaList: + description:

Code denoting the Learning or Subject Area the + assessment task is for.

+ type: object + properties: + SubjectAreaList: + type: array + items: + SubjectArea: + type: string + title: Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZ Curriculum and Te Marautanga o Aotearoa.

+
    +
  • 'GERM' - German
    • +
  • 'INDO' - Indonesian
    • +
  • 'JAPA' - Japanese
    • +
  • 'FREN' - French
    • +
  • 'REME' - English (Remedial)
    • +
  • 'ENGL' - English
    • +
  • 'COOK' - Cook Island Maori
    • +
  • 'COMM' - Communication Skills
    • +
  • 'CHIN' - Chinese
    • +
  • 'KORE' - Korean
    • +
  • 'LATI' - Latin
    • +
  • 'NIUE' - Niuean
    • +
plus 83 more value(s) at NZCodeSetsSubjectAreaType + oneOf: + - const: GERM + title: German + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: INDO + title: Indonesian + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: JAPA + title: Japanese + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: FREN + title: French + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: REME + title: English (Remedial) + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: ENGL + title: English + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COOK + title: Cook Island Maori + description: Applicable to both NZ Curriculum and Te + Marautanga o Aotearoa + - const: COMM + title: Communication Skills + description: Applicable to Te Marautanga o Aotearoa + - const: CHIN + title: Chinese + description: Applicable to Te Marautanga o Aotearoa + - const: KORE + title: Korean + - const: LATI + title: Latin + - const: NIUE + title: Niuean + - const: OLAN + title: Other Languages + - const: PLAN + title: Pacific Language Studies + - const: RUSS + title: Russian + - const: SAMO + title: Samoan + - const: SPAN + title: Spanish + - const: MAOR + title: Te Reo Māori + - const: RANG + title: Te Reo Rangatira + - const: TOKE + title: Tokelauan + - const: TONG + title: Tongan + - const: ENSL + title: English as a Second Language + - const: MATH + title: Mathematics + - const: MATC + title: Mathematics with Calculus + - const: MATS + title: Mathematics with Statistics + - const: REMM + title: Mathematics (Remedial) + - const: ACCO + title: Accounting + - const: SCIE + title: Science + - const: AGHO + title: Agriculture / Horticulture + - const: BIOL + title: Biology / Biological Science + - const: CHEM + title: Chemsitry + - const: EAAS + title: Earth Science / Astronomy + - const: HUMB + title: Human Biology + - const: PHYS + title: Physics + - const: TECN + title: Technology + - const: BITE + title: Biotechnology + - const: COSC + title: Computer Science / Programming + - const: COMP + title: Computer Studies + - const: DEST + title: Design, Drawing and Graphics + - const: ELTE + title: Electronics and Control + - const: FOTE + title: Food Technology + - const: GRAP + title: Graphics + - const: INTE + title: Information and Communication Technology + - const: MTEC + title: Materials Technology + - const: STME + title: Structures and Mechanisms + - const: TIMA + title: Test and Information Management + - const: CLTX + title: Textiles / Clothing + - const: ARTA + title: The Arts + - const: ARTD + title: Art Design + - const: ARTH + title: Art History + - const: DANC + title: Dancing + - const: DRAM + title: Drama + - const: MUSC + title: Music / Music Studies + - const: MUSP + title: Music Practical / Performance + - const: ARPA + title: Painting + - const: APER + title: Performing Arts + - const: ARTP + title: Photography + - const: ARPR + title: Printmaking + - const: ARTS + title: Sculpture + - const: ARTC + title: Visial Arts + - const: SOST + title: Social Studies + - const: CLST + title: Classics / Classical Studies + - const: CMTY + title: Community Studies + - const: ECON + title: Economics + - const: SENV + title: Environmental Sustainability + - const: GEOG + title: Geography + - const: HIST + title: History + - const: LACU + title: Language and Cultural Studies + - const: MAOS + title: Māori Studies + - const: MEST + title: Media Studies + - const: SOSC + title: Other Social Sciences + - const: HEPH + title: Health and Physical Education + - const: HEED + title: Health + - const: HOME + title: Home Economics + - const: OUED + title: Outdoor Education + - const: PHED + title: Physical Education + - const: SPOR + title: Sports Studies + - const: BUSS + title: Commerce Related + - const: DEFE + title: Defence + - const: EQUE + title: Equestrian + - const: FARM + title: Farming + - const: FISH + title: Fishing + - const: FOTY + title: Forestry + - const: INTR + title: Industrial Trades + - const: INTS + title: Integrated Studies + - const: LAWS + title: Legal / Law Related Studies + - const: LIFE + title: Life Skills / Personal Development + - const: REST + title: Religious Education / Studies + - const: REMS + title: Remedial Studies + - const: STPR + title: Secondary Tertiary Programme + - const: SETR + title: Service Trades + - const: SPPR + title: Special Needs Programme + - const: STDY + title: Study Skills + - const: TRAN + title: Transition / Pre-Employment + - const: THTR + title: Travel, Hospitality, Tourism + NCEASubjectArea: + type: string + title: NCEA Subject Area + description: >- +

Codes denoting Subject Areas defined by the + NZQA for NCEA.

    +
  • 'ACCO' - Accounting
    • +
  • 'AGHO' - Agricultural and Horticultural Science
    • +
  • 'AGRI' - Agribusiness (Business Studies)
    • +
  • 'ARTC' - Visual Arts
    • +
  • 'ARTH' - Art History
    • +
  • 'BIOL' - Biology
    • +
  • 'BUST' - Business Studies
    • +
  • 'CHEM' - Chemistry
    • +
  • 'CHIN' - Chinese
    • +
  • 'CLST' - Classical Studies
    • +
  • 'COMP' - Computing
    • +
  • 'COOK' - Cook Island Māori
    • +
plus 50 more value(s) at NZCodeSetsNCEASubjectAreaType + oneOf: + - const: ACCO + title: Accounting + - const: AGHO + title: Agricultural and Horticultural Science + - const: AGRI + title: Agribusiness (Business Studies) + - const: ARTC + title: Visual Arts + - const: ARTH + title: Art History + - const: BIOL + title: Biology + - const: BUST + title: Business Studies + - const: CHEM + title: Chemistry + - const: CHIN + title: Chinese + - const: CLST + title: Classical Studies + - const: COMP + title: Computing + - const: COOK + title: Cook Island Māori + - const: DANC + title: Dance + - const: DLIC + title: Drivers Licence + - const: DRAM + title: Drama + - const: DTEC + title: Digital Technologies + - const: EAAS + title: Earth and Space Science + - const: ECON + title: Economics + - const: ENAC + title: English for Academic Purposes + - const: ENGL + title: English + - const: ENSL + title: English Language (EL) + - const: FIMA + title: Field Māori + - const: FREN + title: French + - const: GEOG + title: Geography + - const: GERM + title: German + - const: GRAP + title: Digital and Visual Communication (Graphics) + - const: HANG + title: Hangarau + - const: HAUO + title: Hauora + - const: HEED + title: Health + - const: HIST + title: History + - const: HOME + title: Home Economics + - const: JAPA + title: Japanese + - const: KORE + title: Korean + - const: LAFT + title: Lea Faka-Tonga + - const: LATI + title: Latin + - const: LAWS + title: Legal Studies + - const: LITE + title: Literacy + - const: MAOR + title: Te Reo Māori + - const: MAST + title: Mathematics and Statistics + - const: MEST + title: Media Studies + - const: MPRT + title: Māori Performing Arts + - const: MUSC + title: Music + - const: NGAT + title: Ngā Toi + - const: NUME + title: Numeracy + - const: NZSL + title: New Zealand Sign Language + - const: PANG + title: Pāngarau + - const: PHED + title: Physical Education + - const: PHYS + title: Physics + - const: PLAN + title: Pacific Language Studies + - const: PSYC + title: Psychology + - const: PUTA + title: Pūtaiao + - const: RANG + title: Te Reo Rangatira + - const: REST + title: Religious Studies + - const: SAMO + title: Samoan + - const: SCIE + title: Science + - const: SENV + title: Education for Sustainability + - const: SOSC + title: Sociology + - const: SOST + title: Social Studies + - const: SPAN + title: Spanish + - const: SULE + title: Supported Learning + - const: TECN + title: Technology + - const: TIKA + title: Tikanga-ā-iwi + EndorsementLevel: + type: string + title: NCEA Endorsement Level + description: >- +

The level of NCEA endorsement the student received + for the attainment.

    +
  • 'E' - Excellence
    • +
  • 'M' - Merit
    • +
+ oneOf: + - title: Excellence + enum: + - E + - title: Merit + enum: + - M + description:

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

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentAttainment: + StudentAttainmentRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + GrantingProvider: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + 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 + 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 + application/xml: + schema: + type: object + properties: + StudentAttainment: + $ref: "#/paths/~1StudentAttainments~1%7BStudentAttainmentRefId%7D\ + /put/requestBody/content/application~1json/schema/propertie\ + s/StudentAttainment" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + NCEA Level 2 Chemistry - Endorsed with merit + Credential + + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + HP85-1039 + Harry Potter + + 2018-07-25 + + + 2752a16b-b62a-4973-9d44-23e13e1c037b + 91165-v2 + Demonstrate understanding of the properties of selected organic compounds + StudentAssessmentTaskResult + EXT + Achieved + 2016-06-28 + 4 + + + eca0da5d-94af-4223-aaa6-7c0083006efd + 91166-v2 + Demonstrate understanding of chemical reactivity + StudentAssessmentTaskResult + INT + Achieved with merit + 2016-06-01 + 3 + + + 12f4761d-5e97-4e12-804e-e16d882c86c7 + 91167-v2 + Demonstrate understanding of oxidation-reduction + StudentAssessmentTaskResult + EXT + Achieved + 2016-06-28 + 3 + + + + CHEM + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentAttainment + summary: Default operation to get a single StudentAttainment + parameters: + - name: StudentAttainmentRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentAttainment: + $ref: "#/paths/~1StudentAttainments/get/responses/200/content/a\ + pplication~1json/schema/properties/StudentAttainments/pro\ + perties/StudentAttainment/items" + example: + StudentAttainment: + StudentAttainmentRefId: 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + GrantingProvider: + RefId: 11737EA4-301C-ADCA-75C8-7214A7C46BDB + 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 + 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 + application/xml: + schema: + type: object + properties: + StudentAttainment: + $ref: "#/paths/~1StudentAttainments/get/responses/200/content/a\ + pplication~1json/schema/properties/StudentAttainments/pro\ + perties/StudentAttainment/items" + example: >- + + 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 + + 11737EA4-301C-ADCA-75C8-7214A7C46BDB + + + D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 + NCEA Level 2 Chemistry - Endorsed with merit + Credential + + + cd106d6d-d9d5-41fb-9943-5feb967c9435 + HP85-1039 + Harry Potter + + 2018-07-25 + + + 2752a16b-b62a-4973-9d44-23e13e1c037b + 91165-v2 + Demonstrate understanding of the properties of selected organic compounds + StudentAssessmentTaskResult + EXT + Achieved + 2016-06-28 + 4 + + + eca0da5d-94af-4223-aaa6-7c0083006efd + 91166-v2 + Demonstrate understanding of chemical reactivity + StudentAssessmentTaskResult + INT + Achieved with merit + 2016-06-01 + 3 + + + 12f4761d-5e97-4e12-804e-e16d882c86c7 + 91167-v2 + Demonstrate understanding of oxidation-reduction + StudentAssessmentTaskResult + EXT + Achieved + 2016-06-28 + 3 + + + + CHEM + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentAttainment + summary: Default operation to delete a single StudentAttainment + parameters: + - name: StudentAttainmentRefId + in: path + description:

A GUID that identifies an instance of this object.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" + /StudentCurriculumProgressReports: + get: + tags: + - StudentCurriculumProgressReport + summary: Default operation to get a list of all available + StudentCurriculumProgressReports + description: Search the set of available StudentCurriculumProgressReports, according + to the search criteria in the URL parameters. Returns the first 20 + objects located; with SIF defined navigation headers, indicating how to + retrieve subsequent sets of 20 objects. + parameters: + - name: LocalId + in: path + description: Search for object by LocalId, within the context of the organisation + represented by the ZoneId of the request. + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentCurriculumProgressReports: + type: object + description: A List of StudentCurriculumProgressReport objects + properties: + StudentCurriculumProgressReport: + type: array + items: + required: + - Provider + - Student + - TeachingGroup + type: object + properties: + StudentCurriculumProgressReportRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[\ + a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + StudentCurriculumProgressReportLocalId: + description:

This is a common element used to define the + locally assigned identifier associated with an + entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + required: + - ObjectType + properties: + RefId: + $ref: "#/paths/~1StudentCurriculumProgressReports\ + /get/responses/200/content/application~1jso\ + n/schema/properties/StudentCurriculumProgre\ + ssReports/properties/StudentCurriculumProgr\ + essReport/items/properties/StudentCurriculu\ + mProgressReportRefId" + LocalId: + $ref: "#/paths/~1StudentCurriculumProgressReports\ + /get/responses/200/content/application~1jso\ + n/schema/properties/StudentCurriculumProgre\ + ssReports/properties/StudentCurriculumProgr\ + essReport/items/properties/StudentCurriculu\ + mProgressReportLocalId" + Name: + type: string + description:

The normal descriptive name of the + referenced object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject + names, to be included in Object + References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates + within the education sector; but doesn’t + provide education services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education + services such as ECE Service, School or + TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two + providers of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students + enrol in, and may be assessed for, and + achieve passes in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted + by a national body, professional + association or other interested party. + The Credential describes an award that + is made to the learner at the successful + completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and + demographic information relating to a + staff member, who might be a teacher or + other employee of a Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to + a particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information + related to the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information + about a person who is a part of a + Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a + part of a Student's whānau and that + Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an + education provider for the purpose of + receiving educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other + group of students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance + spans for a single student at a single + provider during a single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to + be undertaken by one or more Students at + some time. Defines the task separately + from each student's attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an + assessment task they are intending to + participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a + particular assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single + student at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment + e.g. NCEA Qualification, Learning + Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups + generated by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests + and academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular + or extra-curricular activity in which a + student participates during a given + school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a + student's participation in learning + support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement + reports provided for a student. Used in + technology centres the host provider, to + report on student progress to their base + school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentCurriculumProgressReports/get\ + /responses/200/content/application~1json/schema\ + /properties/StudentCurriculumProgressReports/pr\ + operties/StudentCurriculumProgressReport/items/\ + properties/Student" + TeachingGroup: + $ref: "#/paths/~1StudentCurriculumProgressReports/get\ + /responses/200/content/application~1json/schema\ + /properties/StudentCurriculumProgressReports/pr\ + operties/StudentCurriculumProgressReport/items/\ + properties/Student" + AuthorList: + description:

A list of StaffMembers who are the authors of + the curriculum progress report

+ type: object + required: + - Author + properties: + Author: + type: array + items: + $ref: "#/paths/~1StudentCurriculumProgressRepor\ + ts/get/responses/200/content/application~\ + 1json/schema/properties/StudentCurriculum\ + ProgressReports/properties/StudentCurricu\ + lumProgressReport/items/properties/Studen\ + t" + RepositoryReceivedDate: + type: string + format: date + description:

The date the repository received the students + technology centre progress and achievement + report.

+ TimeFrame: + type: string + title: Curriculum Progress Report Timeframe + description: >- +

Codes denoting the period of time that a + Curriculum Progress Report applies to.

    +
  • 'END' - End of Year
    • +
  • 'MID' - Mid-Year
    • +
  • 'SEM' - Semester
    • +
  • 'TRM' - Term
    • +
  • 'ONG' - Ongoing / As Available / Ad-Hoc
    • +
+ oneOf: + - title: End of Year + enum: + - END + - title: Mid-Year + enum: + - MID + - title: Semester + enum: + - SEM + - title: Term + enum: + - TRM + - title: Ongoing / As Available / Ad-Hoc + enum: + - ONG + TechnologyClassList: + description:

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.

+ type: object + required: + - TechnologyClass + properties: + TechnologyClass: + type: array + items: + description:

A record of the Student's progress in a + particular class from the Technology + curriculum.

+ type: object + required: + - Class + properties: + Class: + type: string + title: Technology Class + description: >- +

Code set denoting a class or + subject area from the technology + curriculum that the progress report + covers.

    +
  • 'HM' - Hard Materials
    • +
  • 'FD' - Food
    • +
  • 'DE' - 3D Design
    • +
  • 'MM' - Multimedia
    • +
+ oneOf: + - title: Hard Materials + enum: + - HM + - title: Food + enum: + - FD + - title: 3D Design + enum: + - DE + - title: Multimedia + enum: + - MM + Teacher: + $ref: "#/paths/~1StudentCurriculumProgressR\ + eports/get/responses/200/content/appl\ + ication~1json/schema/properties/Stude\ + ntCurriculumProgressReports/propertie\ + s/StudentCurriculumProgressReport/ite\ + ms/properties/Student" + BehaviourComment: + type: string + description:

Overall comment about the behaviour + of the student over the course of the + lessons in the Class.

+ EffortComment: + type: string + description:

Overall comment about the effort + the student has made in class

+ StrandList: + description:

A record of the Student's progress + in a set of learning strands from the + Technology curriculum, that were + covered in the class

+ type: object + required: + - Strand + properties: + Strand: + type: array + items: + description:

A record of the Student's + progress in a particular + learning strand from the + Technology curriculum, that was + covered in the class.

+ type: object + required: + - LearningStrand + properties: + LearningStrand: + type: string + title: Technology Learning Strand + description: >- +

Code list denoting the + learning strands from the + Technology curriculum that + can be covered as part of a + technology class.

    +
  • 'TP' - Technological Practice
    • +
  • 'TK' - Technological Knowledge
    • +
  • 'NT' - Nature of Technology
    • +
+ oneOf: + - title: Technological Practice + enum: + - TP + - title: Technological Knowledge + enum: + - TK + - title: Nature of Technology + enum: + - NT + AchievementObjectiveList: + description:

A record of the Student's + progress in a set of + achievement objectives from + the from the Technology + curriculum strand, that was + covered in the class.

+ type: object + required: + - AchievementObjective + properties: + AchievementObjective: + type: array + items: + description:

A record of the + Student's progress in + a particular + achievement objective + from the Technology + curriculum strand, + that was covered in + the class.

+ type: object + required: + - AchievementObjective + properties: + AchievementObjective: + type: string + title: Strand Achievement + Objective + description: >- +

Code set + denoting achievement + objectives against + which a student can + be assessed within a + Learning Strand.

+
    +
  • 'BD' - Brief Development
    • +
  • 'PP' - Planning for Practice
    • +
  • 'OD' - Outcome Development and Evaluation
    • +
  • 'TM' - Technological Modelling
    • +
  • 'TP' - Technological Products
    • +
  • 'TS' - Technological Systems
    • +
  • 'CT' - Characteristics of Technology
    • +
  • 'CO' - Characteristics of Technological Outcomes
    • +
+ oneOf: + - title: Brief Development + enum: + - BD + - title: Planning for Practice + enum: + - PP + - title: Outcome + Development and + Evaluation + enum: + - OD + - title: Technological + Modelling + enum: + - TM + - title: Technological + Products + enum: + - TP + - title: Technological Systems + enum: + - TS + - title: Characteristics + of Technology + enum: + - CT + - title: Characteristics + of Technological + Outcomes + enum: + - CO + CurriculumLevel: + type: string + title: Technology + Curriculum Level + description: >- +

Code set + denoting the + technology + curriculum level + that the student's + progress report is + being made against. + e.g. 2, 3, 4 or + 5.

    +
  • '2' - Level 2
    • +
  • '3' - Level 3
    • +
  • '4' - Level 4
    • +
+ oneOf: + - title: Level 2 + enum: + - "2" + - title: Level 3 + enum: + - "3" + - title: Level 4 + enum: + - "4" + ProgressLevel: + type: string + title: Strand Achievement + Progress Level + description: >- +

Code set + denoting the level + of progress the + student has made + against the learning + strand achievement + objectiv. e.g. + Beginner, + Proficient, and + Advanced.

    +
  • 'B' - Beginner
    • +
  • 'P' - Proficient
    • +
  • 'A' - Advanced
    • +
+ oneOf: + - title: Beginner + enum: + - B + - title: Proficient + enum: + - P + - title: Advanced + enum: + - A + AchievementObjectiveDesc: + type: string + description:

A description + of what the + achievement + objective + covers.

+ OverallStudentEffortNote: + type: string + description:

A note about + the student's + overall effort in + relation to this + achievement + objective for this + strand.

+ PracticalAbilityDesc: + type: string + description:

A description + of practical ability + covered by the + achievement + objective for the + strand.

+ PracticalAbilityProgressNote: + type: string + description:

A note about + the student's + practical ability + progress in relation + to this achievement + objective for this + strand.

+ DocumentList: + description:

Documents that + relate to students + progress in this + strand achievement + objective, e.g. + report, photos, + media, documents + etc.

+ type: object + required: + - Document + properties: + Document: + type: array + items: + $ref: "#/paths/~1\ + StudentCurriculumPr\ + ogressReports/get/r\ + esponses/200/conten\ + t/application~1json\ + /schema/properties/\ + StudentCurriculumPr\ + ogressReports/prope\ + rties/StudentCurric\ + ulumProgressReport/\ + items/properties/St\ + udent" + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentCurriculumProgressReports: + StudentCurriculumProgressReport: + - StudentCurriculumProgressReportRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + Provider: + RefId: 407405d9-caae-4853-a397-4053e0cda895 + 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 + application/xml: + schema: + type: object + properties: + StudentCurriculumProgressReports: + type: object + description: A List of StudentCurriculumProgressReport objects + properties: + StudentCurriculumProgressReport: + type: array + items: + $ref: "#/paths/~1StudentCurriculumProgressReports/get/res\ + ponses/200/content/application~1json/schema/propert\ + ies/StudentCurriculumProgressReports/properties/Stu\ + dentCurriculumProgressReport/items" + example: >- + + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + + 407405d9-caae-4853-a397-4053e0cda895 + + + 4f6dce25-cca6-49ef-8be4-675e2cfce8b8 + HM8P + Year 8 Hard Materials, Pinehurst School + + + + 1b6fabed-2af9-4395-b48c-f46c8edb1b78 + SMcG + Steve McGannaway + + + TRM + + + HM + Excellent + Not particularly interested, attention wanders + + + TP + + + BD + 2 + B + Brief Development in hard materials + Not particularly interested, attention wanders + Beginner + Struggles with the planning required + + + + + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + "/StudentCurriculumProgressReports/{StudentCurriculumProgressReportRefId}": + post: + tags: + - StudentCurriculumProgressReport + summary: Default operation to create a single StudentCurriculumProgressReport + parameters: + - name: StudentCurriculumProgressReportRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Student + Curriculum Progress Report.

+ required: true + schema: + type: string + operationId: createStudentCurriculumProgressReport + requestBody: + description: CRUD operation on StudentCurriculumProgressReport + content: + application/json: + schema: + type: object + properties: + StudentCurriculumProgressReport: + $ref: "#/paths/~1StudentCurriculumProgressReports/get/responses/2\ + 00/content/application~1json/schema/properties/StudentCurri\ + culumProgressReports/properties/StudentCurriculumProgressRe\ + port/items" + example: + StudentCurriculumProgressReport: + StudentCurriculumProgressReportRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + Provider: + RefId: 407405d9-caae-4853-a397-4053e0cda895 + 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 + application/xml: + schema: + type: object + properties: + StudentCurriculumProgressReport: + $ref: "#/paths/~1StudentCurriculumProgressReports/get/responses/2\ + 00/content/application~1json/schema/properties/StudentCurri\ + culumProgressReports/properties/StudentCurriculumProgressRe\ + port/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + + 407405d9-caae-4853-a397-4053e0cda895 + + + 4f6dce25-cca6-49ef-8be4-675e2cfce8b8 + HM8P + Year 8 Hard Materials, Pinehurst School + + + + 1b6fabed-2af9-4395-b48c-f46c8edb1b78 + SMcG + Steve McGannaway + + + TRM + + + HM + Excellent + Not particularly interested, attention wanders + + + TP + + + BD + 2 + B + Brief Development in hard materials + Not particularly interested, attention wanders + Beginner + Struggles with the planning required + + + + + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/post/responses/de\ + fault" + put: + tags: + - StudentCurriculumProgressReport + summary: Default operation to update a single StudentCurriculumProgressReport + parameters: + - name: StudentCurriculumProgressReportRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Student + Curriculum Progress Report.

+ required: true + schema: + type: string + operationId: updateStudentCurriculumProgressReport + requestBody: + description: CRUD operation on StudentCurriculumProgressReport + content: + application/json: + schema: + type: object + properties: + StudentCurriculumProgressReport: + type: object + properties: + StudentCurriculumProgressReportRefId: + description: An object or element identifier. + type: string + pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-\ + 9]{4}-[a-fA-F0-9]{12}" + StudentCurriculumProgressReportLocalId: + description:

This is a common element used to define the locally + assigned identifier associated with an entity.

+ type: string + Student: + description:

A reference to another SIF Data Object

+ type: object + properties: + RefId: + $ref: "#/paths/~1StudentCurriculumProgressReports~1%7BStu\ + dentCurriculumProgressReportRefId%7D/put/requestBod\ + y/content/application~1json/schema/properties/Stude\ + ntCurriculumProgressReport/properties/StudentCurric\ + ulumProgressReportRefId" + LocalId: + $ref: "#/paths/~1StudentCurriculumProgressReports~1%7BStu\ + dentCurriculumProgressReportRefId%7D/put/requestBod\ + y/content/application~1json/schema/properties/Stude\ + ntCurriculumProgressReport/properties/StudentCurric\ + ulumProgressReportLocalId" + Name: + type: string + description:

The normal descriptive name of the referenced + object.

+ ObjectType: + type: string + title: Referrable Data Objects + description: >- +

An enumeration of valid SIF DataObject names, to + be included in Object References

    +
  • 'Organisation' - Organisation
    • +
  • 'Provider' - Provider
    • +
  • 'AcademicDepartment' - AcademicDepartment
    • +
  • 'ProviderRelationship' - ProviderRelationship
    • +
  • 'ProviderCourse' - ProviderCourse
    • +
  • 'LearningStandard' - LearningStandard
    • +
  • 'Credential' - Credential
    • +
  • 'StaffPersonal' - StaffPersonal
    • +
  • 'StaffAssignment' - StaffAssignment
    • +
  • 'StaffTeachingGroupAssignment' - StaffTeachingGroupAssignment
    • +
  • 'StudentPersonal' - StudentPersonal
    • +
  • 'StudentContactPersonal' - StudentContactPersonal
    • +
plus 33 more value(s) at NZCodeSetsReferrableDataObjectsType + oneOf: + - title: Organisation + description: A generic organisation that operates within the + education sector; but doesn’t provide education + services. + enum: + - Organisation + - title: Provider + description: A recognised provider of education services such + as ECE Service, School or TEI + enum: + - Provider + - title: AcademicDepartment + description: "" + enum: + - AcademicDepartment + - title: ProviderRelationship + description: A recognised relationship between two providers + of education service. + enum: + - ProviderRelationship + - title: ProviderCourse + description: A Provider defined course that Students enrol + in, and may be assessed for, and achieve passes + in. + enum: + - ProviderCourse + - title: LearningStandard + description: 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. + enum: + - LearningStandard + - title: Credential + description: '"A qualification or other award granted by a + national body, professional association or other + interested party. The Credential describes an + award that is made to the learner at the + successful completion of a particular learning + programme. eg: NCEA Level 1; University + Entrance; NCEA Level 2 Chemistry;"' + enum: + - Credential + - title: StaffPersonal + description: All the personal, contact and demographic + information relating to a staff member, who + might be a teacher or other employee of a + Provider. + enum: + - StaffPersonal + - title: StaffAssignment + description: Records assignment of a Staff member to a + particular Role at a Provider or other + EducationOrganisation. + enum: + - StaffAssignment + - title: StaffTeachingGroupAssignment + description: "" + enum: + - StaffTeachingGroupAssignment + - title: StudentPersonal + description: Contains all the personal information related to + the student. + enum: + - StudentPersonal + - title: StudentContactPersonal + description: Contains all the personal information about a + person who is a part of a Student's whānau. + enum: + - StudentContactPersonal + - title: StudentContactRelationship + description: A relationship between a person who is a part of + a Student's whānau and that Student + enum: + - StudentContactRelationship + - title: StudentProviderEnrolment + description: A student’s association with an education + provider for the purpose of receiving + educational services. + enum: + - StudentProviderEnrolment + - title: StudentTeachingGroupEnrolment + description: "" + enum: + - StudentTeachingGroupEnrolment + - title: TeachingGroup + description: Identifies a particular class or other group of + students. + enum: + - TeachingGroup + - title: StudentAttendanceTimeList + description: Records detail about the attendance spans for a + single student at a single provider during a + single day. + enum: + - StudentAttendanceTimeList + - title: StudentAttendanceSummary + description: 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. + enum: + - StudentAttendanceSummary + - title: AssessmentTask + description: Provides information about a particular + assignment or other assessment task, to be + undertaken by one or more Students at some time. + Defines the task separately from each student's + attempting the task. + enum: + - AssessmentTask + - title: StudentAssessmentTaskRegistration + description: The student's registration for an assessment + task they are intending to participate in. + enum: + - StudentAssessmentTaskRegistration + - title: StudentAssessmentTask + description: Record of a student's attempt at a particular + assessment task. + enum: + - StudentAssessmentTask + - title: StudentAssessmentTaskResult + description: Records the result achieved by a single student + at a particular assessment task. + enum: + - StudentAssessmentTaskResult + - title: StudentAttainment + description: Records a student gaining an Attainment e.g. + NCEA Qualification, Learning Standard etc. + enum: + - StudentAttainment + - title: WellbeingAlert + description: 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. + enum: + - WellbeingAlert + - title: WellbeingCharacteristic + description: 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. + enum: + - WellbeingCharacteristic + - title: WellbeingEvent + description: 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. + enum: + - WellbeingEvent + - title: WellbeingResponse + description: A record of the outcome and follow ups generated + by a WellbeingEvent. + enum: + - WellbeingResponse + - title: WellbeingAppeal + description: 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. + enum: + - WellbeingAppeal + - title: Document + description: "" + enum: + - Document + - title: StudentVoice + description: Information about a student's interests and + academic, career and social goals. + enum: + - StudentVoice + - title: StudentActivityParticipation + description: Provides information on a co-curricular or + extra-curricular activity in which a student + participates during a given school year. + enum: + - StudentActivityParticipation + - title: StudentLearningSupportParticipation + description: Contains information pertaining to a student's + participation in learning support. + enum: + - StudentLearningSupportParticipation + - title: LearningSupportRegisterDirectory + description: "" + enum: + - LearningSupportRegisterDirectory + - title: StudentCurriculumProgressReport + description: A curriculum progress and achievement reports + provided for a student. Used in technology + centres the host provider, to report on student + progress to their base school. + enum: + - StudentCurriculumProgressReport + - title: StudentPhysicalRestraint + description: "" + enum: + - StudentPhysicalRestraint + - title: StudentConsent + description: "" + enum: + - StudentConsent + - title: Schedule + description: "" + enum: + - Schedule + - title: BellSchedule + description: "" + enum: + - BellSchedule + - title: ScheduleDate + description: "" + enum: + - ScheduleDate + - title: SchedulePeriod + description: "" + enum: + - SchedulePeriod + - title: ScheduleEvent + description: "" + enum: + - ScheduleEvent + - title: ScheduleHoliday + description: "" + enum: + - ScheduleHoliday + - title: ScheduleAcademicDay + description: "" + enum: + - ScheduleAcademicDay + - title: ScheduleTerm + description: "" + enum: + - ScheduleTerm + - title: TeachingGroupEvent + description: "" + enum: + - TeachingGroupEvent + Provider: + $ref: "#/paths/~1StudentCurriculumProgressReports~1%7BStudent\ + CurriculumProgressReportRefId%7D/put/requestBody/conten\ + t/application~1json/schema/properties/StudentCurriculum\ + ProgressReport/properties/Student" + TeachingGroup: + $ref: "#/paths/~1StudentCurriculumProgressReports~1%7BStudent\ + CurriculumProgressReportRefId%7D/put/requestBody/conten\ + t/application~1json/schema/properties/StudentCurriculum\ + ProgressReport/properties/Student" + AuthorList: + description:

A list of StaffMembers who are the authors of the + curriculum progress report

+ type: object + properties: + Author: + type: array + items: + $ref: "#/paths/~1StudentCurriculumProgressReports~1%7BS\ + tudentCurriculumProgressReportRefId%7D/put/reques\ + tBody/content/application~1json/schema/properties\ + /StudentCurriculumProgressReport/properties/Stude\ + nt" + RepositoryReceivedDate: + type: string + format: date + description:

The date the repository received the students + technology centre progress and achievement report.

+ TimeFrame: + type: string + title: Curriculum Progress Report Timeframe + description: >- +

Codes denoting the period of time that a Curriculum + Progress Report applies to.

    +
  • 'END' - End of Year
    • +
  • 'MID' - Mid-Year
    • +
  • 'SEM' - Semester
    • +
  • 'TRM' - Term
    • +
  • 'ONG' - Ongoing / As Available / Ad-Hoc
    • +
+ oneOf: + - title: End of Year + enum: + - END + - title: Mid-Year + enum: + - MID + - title: Semester + enum: + - SEM + - title: Term + enum: + - TRM + - title: Ongoing / As Available / Ad-Hoc + enum: + - ONG + TechnologyClassList: + description:

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.

+ type: object + properties: + TechnologyClass: + type: array + items: + description:

A record of the Student's progress in a + particular class from the Technology curriculum. +

+ type: object + properties: + Class: + type: string + title: Technology Class + description: >- +

Code set denoting a class or subject area + from the technology curriculum that the + progress report covers.

    +
  • 'HM' - Hard Materials
    • +
  • 'FD' - Food
    • +
  • 'DE' - 3D Design
    • +
  • 'MM' - Multimedia
    • +
+ oneOf: + - title: Hard Materials + enum: + - HM + - title: Food + enum: + - FD + - title: 3D Design + enum: + - DE + - title: Multimedia + enum: + - MM + Teacher: + $ref: "#/paths/~1StudentCurriculumProgressReports~1\ + %7BStudentCurriculumProgressReportRefId%7D/pu\ + t/requestBody/content/application~1json/schem\ + a/properties/StudentCurriculumProgressReport/\ + properties/Student" + BehaviourComment: + type: string + description:

Overall comment about the behaviour of the + student over the course of the lessons in the + Class.

+ EffortComment: + type: string + description:

Overall comment about the effort the + student has made in class

+ StrandList: + description:

A record of the Student's progress in a set + of learning strands from the Technology + curriculum, that were covered in the class

+ type: object + properties: + Strand: + type: array + items: + description:

A record of the Student's progress in + a particular learning strand from the + Technology curriculum, that was covered + in the class.

+ type: object + properties: + LearningStrand: + type: string + title: Technology Learning Strand + description: >- +

Code list denoting the learning + strands from the Technology + curriculum that can be covered as + part of a technology class.

    +
  • 'TP' - Technological Practice
    • +
  • 'TK' - Technological Knowledge
    • +
  • 'NT' - Nature of Technology
    • +
+ oneOf: + - title: Technological Practice + enum: + - TP + - title: Technological Knowledge + enum: + - TK + - title: Nature of Technology + enum: + - NT + AchievementObjectiveList: + description:

A record of the Student's + progress in a set of achievement + objectives from the from the + Technology curriculum strand, that + was covered in the class.

+ type: object + properties: + AchievementObjective: + type: array + items: + description:

A record of the Student's + progress in a particular + achievement objective from the + Technology curriculum strand, + that was covered in the class. +

+ type: object + properties: + AchievementObjective: + type: string + title: Strand Achievement + Objective + description: >- +

Code set denoting + achievement objectives + against which a student + can be assessed within a + Learning Strand.

    +
  • 'BD' - Brief Development
    • +
  • 'PP' - Planning for Practice
    • +
  • 'OD' - Outcome Development and Evaluation
    • +
  • 'TM' - Technological Modelling
    • +
  • 'TP' - Technological Products
    • +
  • 'TS' - Technological Systems
    • +
  • 'CT' - Characteristics of Technology
    • +
  • 'CO' - Characteristics of Technological Outcomes
    • +
+ oneOf: + - title: Brief Development + enum: + - BD + - title: Planning for Practice + enum: + - PP + - title: Outcome Development + and Evaluation + enum: + - OD + - title: Technological Modelling + enum: + - TM + - title: Technological Products + enum: + - TP + - title: Technological Systems + enum: + - TS + - title: Characteristics of + Technology + enum: + - CT + - title: Characteristics of + Technological Outcomes + enum: + - CO + CurriculumLevel: + type: string + title: Technology Curriculum Level + description: >- +

Code set denoting the + technology curriculum + level that the student's + progress report is being + made against. e.g. 2, 3, 4 + or 5.

    +
  • '2' - Level 2
    • +
  • '3' - Level 3
    • +
  • '4' - Level 4
    • +
+ oneOf: + - title: Level 2 + enum: + - "2" + - title: Level 3 + enum: + - "3" + - title: Level 4 + enum: + - "4" + ProgressLevel: + type: string + title: Strand Achievement + Progress Level + description: >- +

Code set denoting the + level of progress the + student has made against + the learning strand + achievement objectiv. e.g. + Beginner, Proficient, and + Advanced.

    +
  • 'B' - Beginner
    • +
  • 'P' - Proficient
    • +
  • 'A' - Advanced
    • +
+ oneOf: + - title: Beginner + enum: + - B + - title: Proficient + enum: + - P + - title: Advanced + enum: + - A + AchievementObjectiveDesc: + type: string + description:

A description of what + the achievement objective + covers.

+ OverallStudentEffortNote: + type: string + description:

A note about the + student's overall effort + in relation to this + achievement objective for + this strand.

+ PracticalAbilityDesc: + type: string + description:

A description of + practical ability covered + by the achievement + objective for the + strand.

+ PracticalAbilityProgressNote: + type: string + description:

A note about the + student's practical + ability progress in + relation to this + achievement objective for + this strand.

+ DocumentList: + description:

Documents that relate + to students progress in + this strand achievement + objective, e.g. report, + photos, media, documents + etc.

+ type: object + properties: + Document: + type: array + items: + $ref: "#/paths/~1StudentC\ + urriculumProgressRe\ + ports~1%7BStudentCu\ + rriculumProgressRep\ + ortRefId%7D/put/req\ + uestBody/content/ap\ + plication~1json/sch\ + ema/properties/Stud\ + entCurriculumProgre\ + ssReport/properties\ + /Student" + description:

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.

+ x-accessControl: + create: + - 1001 + - 2401 + - 2403 + read: + - 1001 + - 2401 + - 2403 + update: + - 1001 + - 2401 + - 2403 + delete: + - 1001 + - 2401 + - 2403 + aggregate: + - 2002 + - 2102 + example: + StudentCurriculumProgressReport: + StudentCurriculumProgressReportRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + Provider: + RefId: 407405d9-caae-4853-a397-4053e0cda895 + 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 + application/xml: + schema: + type: object + properties: + StudentCurriculumProgressReport: + $ref: "#/paths/~1StudentCurriculumProgressReports~1%7BStudentCurr\ + iculumProgressReportRefId%7D/put/requestBody/content/applic\ + ation~1json/schema/properties/StudentCurriculumProgressRepo\ + rt" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + + 407405d9-caae-4853-a397-4053e0cda895 + + + 4f6dce25-cca6-49ef-8be4-675e2cfce8b8 + HM8P + Year 8 Hard Materials, Pinehurst School + + + + 1b6fabed-2af9-4395-b48c-f46c8edb1b78 + SMcG + Steve McGannaway + + + TRM + + + HM + Excellent + Not particularly interested, attention wanders + + + TP + + + BD + 2 + B + Brief Development in hard materials + Not particularly interested, attention wanders + Beginner + Struggles with the planning required + + + + + + + + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/put/responses/def\ + ault" + get: + tags: + - StudentCurriculumProgressReport + summary: Default operation to get a single StudentCurriculumProgressReport + parameters: + - name: StudentCurriculumProgressReportRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Student + Curriculum Progress Report.

+ required: true + schema: + type: string + responses: + "200": + description: successful operation + content: + application/json: + schema: + type: object + properties: + StudentCurriculumProgressReport: + $ref: "#/paths/~1StudentCurriculumProgressReports/get/responses\ + /200/content/application~1json/schema/properties/StudentC\ + urriculumProgressReports/properties/StudentCurriculumProg\ + ressReport/items" + example: + StudentCurriculumProgressReport: + StudentCurriculumProgressReportRefId: 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + Student: + RefId: CA285746-359D-7510-1A8C-36432A901A16 + Provider: + RefId: 407405d9-caae-4853-a397-4053e0cda895 + 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 + application/xml: + schema: + type: object + properties: + StudentCurriculumProgressReport: + $ref: "#/paths/~1StudentCurriculumProgressReports/get/responses\ + /200/content/application~1json/schema/properties/StudentC\ + urriculumProgressReports/properties/StudentCurriculumProg\ + ressReport/items" + example: >- + + 2FFB63B4-CFEF-4820-8501-E7D1E54555CB + + CA285746-359D-7510-1A8C-36432A901A16 + + + 407405d9-caae-4853-a397-4053e0cda895 + + + 4f6dce25-cca6-49ef-8be4-675e2cfce8b8 + HM8P + Year 8 Hard Materials, Pinehurst School + + + + 1b6fabed-2af9-4395-b48c-f46c8edb1b78 + SMcG + Steve McGannaway + + + TRM + + + HM + Excellent + Not particularly interested, attention wanders + + + TP + + + BD + 2 + B + Brief Development in hard materials + Not particularly interested, attention wanders + Beginner + Struggles with the planning required + + + + + + + + default: + $ref: "#/paths/~1ScheduleTerms/get/responses/default" + delete: + tags: + - StudentCurriculumProgressReport + summary: Default operation to delete a single StudentCurriculumProgressReport + parameters: + - name: StudentCurriculumProgressReportRefId + in: path + description:

The ID (GUID) assigned to uniquely identify this Student + Curriculum Progress Report.

+ required: true + schema: + type: string + responses: + "200": + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + 200" + default: + $ref: "#/paths/~1ScheduleTerms~1%7BScheduleTermRefId%7D/delete/responses/\ + default" +components: + errors: + query: + description: Failed to retrieve object(s). content: application/json: schema: - allOf: - - description: My Pet - title: Pettie - - $ref: '#/components/schemas/Pet' + type: object + properties: + error: + required: + - code + - message + - scope + type: object + properties: + id: + type: string + description:

Optional identifier for the error, that can be used to + track the failed operation through the system audit + logs

+ xml: + attribute: true + code: + type: integer + description:

Corresponds to the value contained in the HTTPS Header + Status-Code" field in which the Error Object is the + payload.

+ scope: + type: string + description: '

Attempted operation. Ex: "Modify Student"

' + message: + type: string + description: '

A simple, easy to understand, compact description of + the error. The primary consumer of this message is the + application user. Example: "Unable to open database."

' + description: + type: string + description: "

An optional error description that is more complete + and technical in nature. It is to be used as a diagnostic + message in trouble-shooting procedures. Example: \"The + 'Students' table is opened in exclusive mode by user + 'ADM1' (dbm.cpp, line 300).\"

" application/xml: schema: - type: 'object' + type: object properties: - name: - type: string - description: hooray - description: Pet object that needs to be added to the store - required: true - UserArray: + error: + $ref: "#/components/errors/query/content/application~1json/schema/p\ + roperties/error" + create: + description: Failed to create object(s). content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/User' - description: List of user object - required: true - securitySchemes: - petstore_auth: - description: | - Get access to data while protecting your account credentials. - OAuth2 is also a safer and more secure way to give you access. - type: oauth2 - flows: - implicit: - authorizationUrl: 'http://petstore.swagger.io/api/oauth/dialog' - scopes: - 'write:pets': modify pets in your account - 'read:pets': read your pets - api_key: - description: > - For this sample, you can use the api key `special-key` to test the - authorization filters. - type: apiKey - name: api_key - in: header + type: object + required: + - creates + properties: + creates: + type: object + description: For each requested object successfully created, an internal + status of 201 (Created) and the service-assigned refId of the + newly created object. For each requested object that failed + to be created indicated by an error statusCode and a + corresponding error payload. + required: + - create + properties: + create: + type: array + items: + type: object + required: + - advisoryId + properties: + id: + type: string + description: For successful create requests, the RefId of the + newly created object, which may not be the RefId + from the original create object request; indeed the + original request create request may have only + provided a LocalId. qv. advisoryId. + xml: + attribute: true + advisoryId: + type: string + description: The RefId, or LocalId from the object create + request; Used to cross-reference this create + response to the original create request, allowing + the client to correctly followup successful and + failed create requests. + xml: + attribute: true + statusCode: + type: string + description: The internal HTTP status for this particular create + object request; Use code 201 (Created) for + successful object creations Where the object create + has failed, use standard HTTP error codes in the 4xx + (Client Error) and 5xx (Server Error) ranges. + xml: + attribute: true + error: + type: object + description: Detailed description of the operation that failed, + and the reasons why. + required: + - code + - message + - scope + properties: + id: + type: string + description: An optional identifier for the Error, that may + be used to track the failed create operation + through the system audit logs. + xml: + attribute: true + code: + type: integer + description:

Corresponds to the value contained in the + HTTPS Header Status-Code" field in which the + Error Object is the payload.

+ scope: + type: string + description: '

Attempted operation. Ex: "Modify + Student"

' + message: + type: string + description: '

A simple, easy to understand, compact + description of the error. The primary consumer + of this message is the application user. + Example: "Unable to open database."

' + description: + type: string + description: "

An optional error description that is more + complete and technical in nature. It is to be + used as a diagnostic message in trouble-shooting + procedures. Example: \"The 'Students' table is + opened in exclusive mode by user 'ADM1' + (dbm.cpp, line 300).\"

" + description:

An HTTP Response with a status of 200 and a payload consisting + of a single "createResponse" element. This includes, for each + requested object successfully created, an internal status of 201 + (Created) and the service-assigned refId. Any requested object + that failed to be created is indicated by an error statusCode and + a corresponding error payload.

+ application/xml: + schema: + $ref: "#/components/errors/create/content/application~1json/schema" + update: + description: Failed to update object(s). + content: + application/json: + schema: + required: + - updates + type: object + properties: + updates: + type: object + description: For each requested object successfully updated, an internal + status of 20O (Ok) and the service-assigned refId of the + updated object. For each requested object that failed to be + updated indicated by an error statusCode and a corresponding + error payload. + required: + - update + properties: + update: + type: array + items: + type: object + properties: + id: + description: For successful update requests, the RefId of the + newly updated object + type: string + xml: + attribute: true + statusCode: + type: string + description: "The internal HTTP status for this particular update + object request; Use code 200 (Ok) for successful + object updates Where the update has failed use + standard HTTP error codes in the 4xx (Client Error) + and 5xx (Server Error) ranges. " + xml: + attribute: true + error: + required: + - code + - message + - scope + type: object + properties: + id: + type: string + description: An optional identifier for the Error, that may + be used to track the failed update operation + through the system audit logs. + xml: + attribute: true + code: + type: integer + description:

Corresponds to the value contained in the + HTTPS Header Status-Code" field in which the + Error Object is the payload.

+ scope: + type: string + description: '

Attempted operation. Ex: "Modify + Student"

' + message: + type: string + description: '

A simple, easy to understand, compact + description of the error. The primary consumer + of this message is the application user. + Example: "Unable to open database."

' + description: + type: string + description: "

An optional error description that is more + complete and technical in nature. It is to be + used as a diagnostic message in trouble-shooting + procedures. Example: \"The 'Students' table is + opened in exclusive mode by user 'ADM1' + (dbm.cpp, line 300).\"

" + description:

An HTTP Response with a status of 200 (success) and a location + corresponding to the URL of the first successfully modified + object. It contains a payload consisting of a single + "updateResponse" element.

+ application/xml: + schema: + $ref: "#/components/errors/update/content/application~1json/schema" + delete: + description: Failed to delete object(s). + content: + application/json: + schema: + required: + - deletes + type: object + properties: + deletes: + type: object + description: "For each requested object successfully deleted, an internal + status of 200 (Ok) and the service-assigned refId of the + deleted object. For each requested object that failed to be + deleted indicated by an error statusCode and a corresponding + error payload. " + required: + - delete + properties: + delete: + type: array + items: + type: object + properties: + id: + type: string + description: "For successful delete requests, the RefId of the + newly deleted object. " + xml: + attribute: true + statusCode: + type: string + description: The internal HTTP status for this particular delete + object request; Use code 200 (Ok) for successful + object deletions Where the object delete has failed, + use standard HTTP error codes in the 4xx (Client + Error) and 5xx (Server Error) ranges. + xml: + attribute: true + error: + required: + - code + - message + - scope + type: object + properties: + id: + type: string + description: An optional identifier for the Error, that may + be used to track the failed delete operation + through the system audit logs. + xml: + attribute: true + code: + type: integer + description:

Corresponds to the value contained in the + HTTPS Header Status-Code" field in which the + Error Object is the payload.

+ scope: + type: string + description: '

Attempted operation. Ex: "Modify + Student"

' + message: + type: string + description: '

A simple, easy to understand, compact + description of the error. The primary consumer + of this message is the application user. + Example: "Unable to open database."

' + description: + type: string + description: "

An optional error description that is more + complete and technical in nature. It is to be + used as a diagnostic message in trouble-shooting + procedures. Example: \"The 'Students' table is + opened in exclusive mode by user 'ADM1' + (dbm.cpp, line 300).\"

" + description:

An HTTP Response with a status of 200 (success). It contains a + payload consisting of a single "deleteResponse" element.

+ application/xml: + schema: + $ref: "#/components/errors/delete/content/application~1json/schema" + responses: + create: + description: Successfully created object(s). + content: + application/json: + schema: + $ref: "#/components/errors/create/content/application~1json/schema" + application/xml: + schema: + $ref: "#/components/errors/create/content/application~1json/schema" + update: + description: Successfully updated object(s). + content: + application/json: + schema: + $ref: "#/components/errors/update/content/application~1json/schema" + application/xml: + schema: + $ref: "#/components/errors/update/content/application~1json/schema" + delete: + description: Successfully deleted object(s). + content: + application/json: + schema: + $ref: "#/components/errors/delete/content/application~1json/schema" + application/xml: + schema: + $ref: "#/components/errors/delete/content/application~1json/schema" diff --git a/demo/petstore.openapi.yaml b/demo/petstore.openapi.yaml new file mode 100644 index 00000000..fc3ce073 --- /dev/null +++ b/demo/petstore.openapi.yaml @@ -0,0 +1,928 @@ +openapi: 3.0.0 +servers: + - url: //petstore.swagger.io/v2 + description: Default server + - url: //petstore.swagger.io/sandbox + description: Sandbox server +info: + description: | + This is a sample server Petstore server. + You can find out more about Swagger at + [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). + For this sample, you can use the api key `special-key` to test the authorization filters. + + # Introduction + This API is documented in **OpenAPI format** and is based on + [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team. + It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo) + tool and [ReDoc](https://github.com/Rebilly/ReDoc) documentation. In addition to standard + OpenAPI syntax we use a few [vendor extensions](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md). + + # OpenAPI Specification + This API is documented in **OpenAPI format** and is based on + [Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team. + It was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo) + tool and [ReDoc](https://github.com/Rebilly/ReDoc) documentation. In addition to standard + OpenAPI syntax we use a few [vendor extensions](https://github.com/Rebilly/ReDoc/blob/master/docs/redoc-vendor-extensions.md). + + # Cross-Origin Resource Sharing + This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/). + And that allows cross-domain communication from the browser. + All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site. + + # Authentication + + Petstore offers two forms of authentication: + - API Key + - OAuth2 + OAuth2 - an open protocol to allow secure authorization in a simple + and standard method from web, mobile and desktop applications. + + + + version: 1.0.0 + title: Swagger Petstore + termsOfService: 'http://swagger.io/terms/' + contact: + name: API Support + email: apiteam@swagger.io + url: https://github.com/Rebilly/ReDoc + x-logo: + url: 'https://rebilly.github.io/ReDoc/petstore-logo.png' + altText: Petstore logo + license: + name: Apache 2.0 + url: 'http://www.apache.org/licenses/LICENSE-2.0.html' +externalDocs: + description: Find out how to create Github repo for your OpenAPI spec. + url: 'https://github.com/Rebilly/generator-openapi-repo' +tags: + - name: pet + description: Everything about your Pets + - name: store + description: Access to Petstore orders + - name: user + description: Operations about user +x-tagGroups: + - name: General + tags: + - pet + - store + - name: User Management + tags: + - user +paths: + /pet: + parameters: + - name: cookieParam + in: cookie + description: Some cookie + required: true + schema: + type: integer + format: int64 + post: + tags: + - pet + summary: Add a new pet to the store + description: Add new pet to the store inventory. + operationId: addPet + responses: + '405': + description: Invalid input + security: + - petstore_auth: + - 'write:pets' + - 'read:pets' + x-code-samples: + - lang: 'C#' + source: | + PetStore.v1.Pet pet = new PetStore.v1.Pet(); + pet.setApiKey("your api key"); + pet.petType = PetStore.v1.Pet.TYPE_DOG; + pet.name = "Rex"; + // set other fields + PetStoreResponse response = pet.create(); + if (response.statusCode == HttpStatusCode.Created) + { + // Successfully created + } + else + { + // Something wrong -- check response for errors + Console.WriteLine(response.getRawResponse()); + } + - lang: PHP + source: | + $form = new \PetStore\Entities\Pet(); + $form->setPetType("Dog"); + $form->setName("Rex"); + // set other fields + try { + $pet = $client->pets()->create($form); + } catch (UnprocessableEntityException $e) { + var_dump($e->getErrors()); + } + requestBody: + $ref: '#/components/requestBodies/Pet' + put: + tags: + - pet + summary: Update an existing pet + description: '' + operationId: updatePet + responses: + '400': + description: Invalid ID supplied + '404': + description: Pet not found + '405': + description: Validation exception + security: + - petstore_auth: + - 'write:pets' + - 'read:pets' + x-code-samples: + - lang: PHP + source: | + $form = new \PetStore\Entities\Pet(); + $form->setPetId(1); + $form->setPetType("Dog"); + $form->setName("Rex"); + // set other fields + try { + $pet = $client->pets()->update($form); + } catch (UnprocessableEntityException $e) { + var_dump($e->getErrors()); + } + requestBody: + $ref: '#/components/requestBodies/Pet' + '/pet/{petId}': + get: + tags: + - pet + summary: Find pet by ID + description: Returns a single pet + operationId: getPetById + parameters: + - name: petId + in: path + description: ID of pet to return + required: true + deprecated: true + schema: + type: integer + format: int64 + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/Pet' + application/xml: + schema: + $ref: '#/components/schemas/Pet' + '400': + description: Invalid ID supplied + '404': + description: Pet not found + security: + - api_key: [] + post: + tags: + - pet + summary: Updates a pet in the store with form data + description: '' + operationId: updatePetWithForm + parameters: + - name: petId + in: path + description: ID of pet that needs to be updated + required: true + schema: + type: integer + format: int64 + responses: + '405': + description: Invalid input + security: + - petstore_auth: + - 'write:pets' + - 'read:pets' + requestBody: + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + name: + description: Updated name of the pet + type: string + status: + description: Updated status of the pet + type: string + delete: + tags: + - pet + summary: Deletes a pet + description: '' + operationId: deletePet + parameters: + - name: api_key + in: header + required: false + schema: + type: string + example: "Bearer " + - name: petId + in: path + description: Pet id to delete + required: true + schema: + type: integer + format: int64 + responses: + '400': + description: Invalid pet value + security: + - petstore_auth: + - 'write:pets' + - 'read:pets' + '/pet/{petId}/uploadImage': + post: + tags: + - pet + summary: uploads an image + description: '' + operationId: uploadFile + parameters: + - name: petId + in: path + description: ID of pet to update + required: true + schema: + type: integer + format: int64 + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/ApiResponse' + security: + - petstore_auth: + - 'write:pets' + - 'read:pets' + requestBody: + content: + application/octet-stream: + schema: + type: string + format: binary + /pet/findByStatus: + get: + tags: + - pet + summary: Finds Pets by status + description: Multiple status values can be provided with comma seperated strings + operationId: findPetsByStatus + parameters: + - name: status + in: query + description: Status values that need to be considered for filter + required: true + style: form + schema: + type: array + minItems: 1 + maxItems: 3 + items: + type: string + enum: + - available + - pending + - sold + default: available + responses: + '200': + description: successful operation + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Pet' + application/xml: + schema: + type: array + items: + $ref: '#/components/schemas/Pet' + '400': + description: Invalid status value + security: + - petstore_auth: + - 'write:pets' + - 'read:pets' + /pet/findByTags: + get: + tags: + - pet + summary: Finds Pets by tags + description: >- + Muliple tags can be provided with comma seperated strings. Use tag1, + tag2, tag3 for testing. + operationId: findPetsByTags + deprecated: true + parameters: + - name: tags + in: query + description: Tags to filter by + required: true + style: form + schema: + type: array + items: + type: string + responses: + '200': + description: successful operation + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Pet' + application/xml: + schema: + type: array + items: + $ref: '#/components/schemas/Pet' + '400': + description: Invalid tag value + security: + - petstore_auth: + - 'write:pets' + - 'read:pets' + /store/inventory: + get: + tags: + - store + summary: Returns pet inventories by status + description: Returns a map of status codes to quantities + operationId: getInventory + responses: + '200': + description: successful operation + content: + application/json: + schema: + type: object + additionalProperties: + type: integer + format: int32 + security: + - api_key: [] + /store/order: + post: + tags: + - store + summary: Place an order for a pet + description: '' + operationId: placeOrder + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + application/xml: + schema: + $ref: '#/components/schemas/Order' + '400': + description: Invalid Order + content: + application/json: + example: + status: 400 + message: "Invalid Order" + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + description: order placed for purchasing the pet + required: true + '/store/order/{orderId}': + get: + tags: + - store + summary: Find purchase order by ID + description: >- + For valid response try integer IDs with value <= 5 or > 10. Other values + will generated exceptions + operationId: getOrderById + parameters: + - name: orderId + in: path + description: ID of pet that needs to be fetched + required: true + schema: + type: integer + format: int64 + minimum: 1 + maximum: 5 + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + application/xml: + schema: + $ref: '#/components/schemas/Order' + '400': + description: Invalid ID supplied + '404': + description: Order not found + delete: + tags: + - store + summary: Delete purchase order by ID + description: >- + For valid response try integer IDs with value < 1000. Anything above + 1000 or nonintegers will generate API errors + operationId: deleteOrder + parameters: + - name: orderId + in: path + description: ID of the order that needs to be deleted + required: true + schema: + type: string + minimum: 1 + responses: + '400': + description: Invalid ID supplied + '404': + description: Order not found + /user: + post: + tags: + - user + summary: Create user + description: This can only be done by the logged in user. + operationId: createUser + responses: + default: + description: successful operation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: Created user object + required: true + '/user/{username}': + get: + tags: + - user + summary: Get user by user name + description: '' + operationId: getUserByName + parameters: + - name: username + in: path + description: 'The name that needs to be fetched. Use user1 for testing. ' + required: true + schema: + type: string + responses: + '200': + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/User' + application/xml: + schema: + $ref: '#/components/schemas/User' + '400': + description: Invalid username supplied + '404': + description: User not found + put: + tags: + - user + summary: Updated user + description: This can only be done by the logged in user. + operationId: updateUser + parameters: + - name: username + in: path + description: name that need to be deleted + required: true + schema: + type: string + responses: + '400': + description: Invalid user supplied + '404': + description: User not found + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: Updated user object + required: true + delete: + tags: + - user + summary: Delete user + description: This can only be done by the logged in user. + operationId: deleteUser + parameters: + - name: username + in: path + description: The name that needs to be deleted + required: true + schema: + type: string + responses: + '400': + description: Invalid username supplied + '404': + description: User not found + /user/createWithArray: + post: + tags: + - user + summary: Creates list of users with given input array + description: '' + operationId: createUsersWithArrayInput + responses: + default: + description: successful operation + requestBody: + $ref: '#/components/requestBodies/UserArray' + /user/createWithList: + post: + tags: + - user + summary: Creates list of users with given input array + description: '' + operationId: createUsersWithListInput + responses: + default: + description: successful operation + requestBody: + $ref: '#/components/requestBodies/UserArray' + /user/login: + get: + tags: + - user + summary: Logs user into the system + description: '' + operationId: loginUser + parameters: + - name: username + in: query + description: The user name for login + required: true + schema: + type: string + - name: password + in: query + description: The password for login in clear text + required: true + schema: + type: string + responses: + '200': + description: successful operation + headers: + X-Rate-Limit: + description: calls per hour allowed by the user + schema: + type: integer + format: int32 + X-Expires-After: + description: date in UTC when toekn expires + schema: + type: string + format: date-time + content: + application/json: + schema: + type: string + examples: + response: + value: OK + application/xml: + schema: + type: string + examples: + response: + value: OK + text/plain: + examples: + response: + value: OK + '400': + description: Invalid username/password supplied + /user/logout: + get: + tags: + - user + summary: Logs out current logged in user session + description: '' + operationId: logoutUser + responses: + default: + description: successful operation +components: + schemas: + ApiResponse: + type: object + properties: + code: + type: integer + format: int32 + type: + type: string + message: + type: string + Cat: + description: A representation of a cat + allOf: + - $ref: '#/components/schemas/Pet' + - type: object + properties: + huntingSkill: + type: string + description: The measured skill for hunting + default: lazy + enum: + - clueless + - lazy + - adventurous + - aggressive + required: + - huntingSkill + Category: + type: object + properties: + id: + description: Category ID + allOf: + - $ref: '#/components/schemas/Id' + name: + description: Category name + type: string + minLength: 1 + sub: + description: Test Sub Category + type: object + properties: + prop1: + type: string + description: Dumb Property + xml: + name: Category + Dog: + description: A representation of a dog + allOf: + - $ref: '#/components/schemas/Pet' + - type: object + properties: + packSize: + type: integer + format: int32 + description: The size of the pack the dog is from + default: 1 + minimum: 1 + required: + - packSize + HoneyBee: + description: A representation of a honey bee + allOf: + - $ref: '#/components/schemas/Pet' + - type: object + properties: + honeyPerDay: + type: number + description: Average amount of honey produced per day in ounces + example: 3.14 + required: + - honeyPerDay + Id: + type: integer + format: int64 + readOnly: true + Order: + type: object + properties: + id: + description: Order ID + allOf: + - $ref: '#/components/schemas/Id' + petId: + description: Pet ID + allOf: + - $ref: '#/components/schemas/Id' + quantity: + type: integer + format: int32 + minimum: 1 + default: 1 + shipDate: + description: Estimated ship date + type: string + format: date-time + status: + type: string + description: Order Status + enum: + - placed + - approved + - delivered + complete: + description: Indicates whenever order was completed or not + type: boolean + default: false + xml: + name: Order + Pet: + type: object + required: + - name + - photoUrls + discriminator: + propertyName: petType + mapping: + cat: '#/components/schemas/Cat' + dog: '#/components/schemas/Dog' + bee: '#/components/schemas/HoneyBee' + properties: + id: + externalDocs: + description: "Find more info here" + url: "https://example.com" + description: Pet ID + allOf: + - $ref: '#/components/schemas/Id' + category: + description: Categories this pet belongs to + allOf: + - $ref: '#/components/schemas/Category' + name: + description: The name given to a pet + type: string + example: Guru + photoUrls: + description: The list of URL to a cute photos featuring pet + type: array + maxItems: 20 + xml: + name: photoUrl + wrapped: true + items: + type: string + format: url + friend: + allOf: + - $ref: '#/components/schemas/Pet' + tags: + description: Tags attached to the pet + type: array + minItems: 1 + xml: + name: tag + wrapped: true + items: + $ref: '#/components/schemas/Tag' + status: + type: string + description: Pet status in the store + enum: + - available + - pending + - sold + petType: + description: Type of a pet + type: string + xml: + name: Pet + Tag: + type: object + properties: + id: + description: Tag ID + allOf: + - $ref: '#/components/schemas/Id' + name: + description: Tag name + type: string + minLength: 1 + xml: + name: Tag + User: + type: object + properties: + id: + $ref: '#/components/schemas/Id' + pet: + oneOf: + - $ref: '#/components/schemas/Pet' + - $ref: '#/components/schemas/Tag' + username: + description: User supplied username + type: string + minLength: 4 + example: John78 + firstName: + description: User first name + type: string + minLength: 1 + example: John + lastName: + description: User last name + type: string + minLength: 1 + example: Smith + email: + description: User email address + type: string + format: email + example: john.smith@example.com + password: + type: string + description: >- + User password, MUST contain a mix of upper and lower case letters, + as well as digits + format: password + minLength: 8 + pattern: '(?=.*[a-z])(?=.*[A-Z])(?=.*[0-9])' + example: drowssaP123 + phone: + description: User phone number in international format + type: string + pattern: '^\+(?:[0-9]-?){6,14}[0-9]$' + example: +1-202-555-0192 + nullable: true + userStatus: + description: User status + type: integer + format: int32 + xml: + name: User + requestBodies: + Pet: + content: + application/json: + schema: + allOf: + - description: My Pet + title: Pettie + - $ref: '#/components/schemas/Pet' + application/xml: + schema: + type: 'object' + properties: + name: + type: string + description: hooray + description: Pet object that needs to be added to the store + required: true + UserArray: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + description: List of user object + required: true + securitySchemes: + petstore_auth: + description: | + Get access to data while protecting your account credentials. + OAuth2 is also a safer and more secure way to give you access. + type: oauth2 + flows: + implicit: + authorizationUrl: 'http://petstore.swagger.io/api/oauth/dialog' + scopes: + 'write:pets': modify pets in your account + 'read:pets': read your pets + api_key: + description: > + For this sample, you can use the api key `special-key` to test the + authorization filters. + type: apiKey + name: api_key + in: header diff --git a/demo/swagger.yaml b/demo/petstore.swagger.yaml similarity index 100% rename from demo/swagger.yaml rename to demo/petstore.swagger.yaml