openapi: 3.0.2 info: version: 3.1 (rc 5) title: "SIF NZ derived API" description: >- Systems Interoperability Framework™ SIF Implementation Specification (New Zealand) 3.1
Sample OpenAPI specification, (although somewhat incomplete) derived from SIF locale data model A complete specification requires:
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: "http://specification.sifassociation.org/Implementation/NZ/3.1-rc5//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: "http://specification.sifassociation.org/Implementation/NZ/3.1-rc5//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: "http://specification.sifassociation.org/Implementation/NZ/3.1-rc5//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: "http://specification.sifassociation.org/Implementation/NZ/3.1-rc5//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: "http://specification.sifassociation.org/Implementation/NZ/3.1-rc5//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: "http://specification.sifassociation.org/Implementation/NZ/3.1-rc5//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: >-The universally unique identifier for the data object record that is used across systems.
- 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: >-A rotation of ScheduleAcademicDays that a Provider has in place to manage their timetable.
- 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 one or more academic days. Periods are assigned to particular days in the Schedule in SchduleAcademicDay.PeriodList - 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: "StudentLearningSupport" description: >-Provides information about a student's learning support.
- name: "StudentLearningSupportResponse" description: >-Provides information about a response provided for a students learning support need.
- 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: # ///////////////////////////////////////////////////////////// /Providers: get: tags: - "Provider" summary: Default operation to get a list of all available Providers responses: '200': description: successful operation content: application/json: schema: type: object properties: Providers: type: object description: >- A List of Provider objects properties: Provider: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/Provider' example: "Providers": { "Provider": [{ "AddressList": { "Address": [{ "Type": "RU", "Role": "PHY", "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", "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", "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", "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": "LOF" }, { "RefId": "ac0871d9-6562-4209-ae86-abdb3661842b", "LocalId": "99204", "Name": "Masterton (Whakaoriori) Kāhui Ako", "ObjectType": "Organisation", "StartDate": "2012-04-30", "Type": "34028" }] }, "OperationalStatus": "O", "Type": "21", "ProviderRefId": 448, "Authority": "STATE", "SchoolService": { "CoEdStatus": "COED", "Decile": 5, "NewEntrantPolicyList": { "EnactedPolicy": [{ "EffectiveTo": "2018-12-31", "Policy": "AE" }, { "EffectiveFrom": "2019-01-01", "Policy": "CE" }] }, "SchoolClassificationList": { "Classification": ["52010", "52004", "52002"] }, "SchoolYearList": { "SchoolYear": [{ "YearLevel": "1", "Gender": "C" }, { "YearLevel": "2", "Gender": "C" }, { "YearLevel": "3", "Gender": "C" }, { "YearLevel": "4", "Gender": "C" }, { "YearLevel": "5", "Gender": "C" }, { "YearLevel": "6", "Gender": "C" }, { "YearLevel": "7", "Gender": "C" }, { "YearLevel": "8", "Gender": "C" }, { "YearLevel": "9", "Gender": "F" }, { "YearLevel": "10", "Gender": "F" }, { "YearLevel": "11", "Gender": "F" }, { "YearLevel": "12", "Gender": "F" }, { "YearLevel": "13", "Gender": "F" }] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: Providers: type: object description: >- A List of Provider objects properties: Provider: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/Provider' example: >-1 to 5 digit Ministry Organisation Id for the Provider, without leading zeros
required: true schema: type: string operationId: updateProvider requestBody: description: CRUD operation on Provider content: application/json: schema: type: object properties: Provider: $ref: 'jsonSchemaUpdate.yaml#/properties/Provider' example: "Provider": { "AddressList": { "Address": [{ "Type": "RU", "Role": "PHY", "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", "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", "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", "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": "LOF" }, { "RefId": "ac0871d9-6562-4209-ae86-abdb3661842b", "LocalId": "99204", "Name": "Masterton (Whakaoriori) Kāhui Ako", "ObjectType": "Organisation", "StartDate": "2012-04-30", "Type": "34028" }] }, "OperationalStatus": "O", "Type": "21", "ProviderRefId": 448, "Authority": "STATE", "SchoolService": { "CoEdStatus": "COED", "Decile": 5, "NewEntrantPolicyList": { "EnactedPolicy": [{ "EffectiveTo": "2018-12-31", "Policy": "AE" }, { "EffectiveFrom": "2019-01-01", "Policy": "CE" }] }, "SchoolClassificationList": { "Classification": ["52010", "52004", "52002"] }, "SchoolYearList": { "SchoolYear": [{ "YearLevel": "1", "Gender": "C" }, { "YearLevel": "2", "Gender": "C" }, { "YearLevel": "3", "Gender": "C" }, { "YearLevel": "4", "Gender": "C" }, { "YearLevel": "5", "Gender": "C" }, { "YearLevel": "6", "Gender": "C" }, { "YearLevel": "7", "Gender": "C" }, { "YearLevel": "8", "Gender": "C" }, { "YearLevel": "9", "Gender": "F" }, { "YearLevel": "10", "Gender": "F" }, { "YearLevel": "11", "Gender": "F" }, { "YearLevel": "12", "Gender": "F" }, { "YearLevel": "13", "Gender": "F" }] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: Provider: $ref: 'jsonSchemaUpdate.yaml#/properties/Provider' example: >-1 to 5 digit Ministry Organisation Id for the Provider, without leading zeros
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: Provider: $ref: 'jsonSchemaCreate.yaml#/properties/Provider' example: "Provider": { "AddressList": { "Address": [{ "Type": "RU", "Role": "PHY", "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", "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", "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", "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": "LOF" }, { "RefId": "ac0871d9-6562-4209-ae86-abdb3661842b", "LocalId": "99204", "Name": "Masterton (Whakaoriori) Kāhui Ako", "ObjectType": "Organisation", "StartDate": "2012-04-30", "Type": "34028" }] }, "OperationalStatus": "O", "Type": "21", "ProviderRefId": 448, "Authority": "STATE", "SchoolService": { "CoEdStatus": "COED", "Decile": 5, "NewEntrantPolicyList": { "EnactedPolicy": [{ "EffectiveTo": "2018-12-31", "Policy": "AE" }, { "EffectiveFrom": "2019-01-01", "Policy": "CE" }] }, "SchoolClassificationList": { "Classification": ["52010", "52004", "52002"] }, "SchoolYearList": { "SchoolYear": [{ "YearLevel": "1", "Gender": "C" }, { "YearLevel": "2", "Gender": "C" }, { "YearLevel": "3", "Gender": "C" }, { "YearLevel": "4", "Gender": "C" }, { "YearLevel": "5", "Gender": "C" }, { "YearLevel": "6", "Gender": "C" }, { "YearLevel": "7", "Gender": "C" }, { "YearLevel": "8", "Gender": "C" }, { "YearLevel": "9", "Gender": "F" }, { "YearLevel": "10", "Gender": "F" }, { "YearLevel": "11", "Gender": "F" }, { "YearLevel": "12", "Gender": "F" }, { "YearLevel": "13", "Gender": "F" }] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: Provider: $ref: 'jsonSchemaCreate.yaml#/properties/Provider' example: >-1 to 5 digit Ministry Organisation Id for the Provider, without leading zeros
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /ProviderRelationships: get: tags: - "ProviderRelationship" summary: Default operation to get a list of all available ProviderRelationships 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: $ref: 'jsonSchemaCreate.yaml#/properties/ProviderRelationship' application/xml: schema: type: object properties: ProviderRelationships: type: object description: >- A List of ProviderRelationship objects properties: ProviderRelationship: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/ProviderRelationship' post: tags: - "ProviderRelationship" summary: Default operation to create a single ProviderRelationship operationId: createProviderRelationship requestBody: description: CRUD operation on ProviderRelationship content: application/json: schema: type: object properties: ProviderRelationship: $ref: 'jsonSchemaCreate.yaml#/properties/ProviderRelationship' application/xml: schema: type: object properties: ProviderRelationship: $ref: 'jsonSchemaCreate.yaml#/properties/ProviderRelationship' # ///////////////////////////////////////////////////////////// /ProviderRelationships/{ProviderRelationshipRefId}: put: tags: - "ProviderRelationship" summary: Default operation to update a single ProviderRelationship parameters: - name: ProviderRelationshipRefId in: path description: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateProviderRelationship requestBody: description: CRUD operation on ProviderRelationship content: application/json: schema: type: object properties: ProviderRelationship: $ref: 'jsonSchemaUpdate.yaml#/properties/ProviderRelationship' application/xml: schema: type: object properties: ProviderRelationship: $ref: 'jsonSchemaUpdate.yaml#/properties/ProviderRelationship' get: tags: - "ProviderRelationship" summary: Default operation to get a single ProviderRelationship parameters: - name: ProviderRelationshipRefId in: path description: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: ProviderRelationship: $ref: 'jsonSchemaCreate.yaml#/properties/ProviderRelationship' application/xml: schema: type: object properties: ProviderRelationship: $ref: 'jsonSchemaCreate.yaml#/properties/ProviderRelationship' delete: tags: - "ProviderRelationship" summary: Default operation to delete a single ProviderRelationship parameters: - name: ProviderRelationshipRefId in: path description: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /Organisations: get: tags: - "Organisation" summary: Default operation to get a list of all available Organisations 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: $ref: 'jsonSchemaCreate.yaml#/properties/Organisation' 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", "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": "35008", "OrganisationRefId": 99204, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: Organisations: type: object description: >- A List of Organisation objects properties: Organisation: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/Organisation' example: >-1 to 5 digit Ministry Organisation Id for the Organisation, without leading zeros
required: true schema: type: string operationId: updateOrganisation requestBody: description: CRUD operation on Organisation content: application/json: schema: type: object properties: Organisation: $ref: 'jsonSchemaUpdate.yaml#/properties/Organisation' 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", "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": "35008", "OrganisationRefId": 99204, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: Organisation: $ref: 'jsonSchemaUpdate.yaml#/properties/Organisation' example: >-1 to 5 digit Ministry Organisation Id for the Organisation, without leading zeros
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: Organisation: $ref: 'jsonSchemaCreate.yaml#/properties/Organisation' 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", "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": "35008", "OrganisationRefId": 99204, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: Organisation: $ref: 'jsonSchemaCreate.yaml#/properties/Organisation' example: >-1 to 5 digit Ministry Organisation Id for the Organisation, without leading zeros
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /AcademicDepartments: get: tags: - "AcademicDepartment" summary: Default operation to get a list of all available AcademicDepartments 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: $ref: 'jsonSchemaCreate.yaml#/properties/AcademicDepartment' example: "AcademicDepartments": { "AcademicDepartment": [{ "AcademicDepartmentRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Science Department", "Provider": { "RefId": 9961 }, "StaffList": { "StaffMember": [{ "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: AcademicDepartments: type: object description: >- A List of AcademicDepartment objects properties: AcademicDepartment: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/AcademicDepartment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateAcademicDepartment requestBody: description: CRUD operation on AcademicDepartment content: application/json: schema: type: object properties: AcademicDepartment: $ref: 'jsonSchemaUpdate.yaml#/properties/AcademicDepartment' example: "AcademicDepartment": { "AcademicDepartmentRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Science Department", "Provider": { "RefId": 9961 }, "StaffList": { "StaffMember": [{ "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: AcademicDepartment: $ref: 'jsonSchemaUpdate.yaml#/properties/AcademicDepartment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: AcademicDepartment: $ref: 'jsonSchemaCreate.yaml#/properties/AcademicDepartment' example: "AcademicDepartment": { "AcademicDepartmentRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Science Department", "Provider": { "RefId": 9961 }, "StaffList": { "StaffMember": [{ "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: AcademicDepartment: $ref: 'jsonSchemaCreate.yaml#/properties/AcademicDepartment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StaffPersonals: get: tags: - "StaffPersonal" summary: Default operation to get a list of all available StaffPersonals 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: $ref: 'jsonSchemaCreate.yaml#/properties/StaffPersonal' 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", "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" }] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StaffPersonals: type: object description: >- A List of StaffPersonal objects properties: StaffPersonal: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StaffPersonal' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStaffPersonal requestBody: description: CRUD operation on StaffPersonal content: application/json: schema: type: object properties: StaffPersonal: $ref: 'jsonSchemaUpdate.yaml#/properties/StaffPersonal' 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", "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" }] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StaffPersonal: $ref: 'jsonSchemaUpdate.yaml#/properties/StaffPersonal' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StaffPersonal: $ref: 'jsonSchemaCreate.yaml#/properties/StaffPersonal' 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", "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" }] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StaffPersonal: $ref: 'jsonSchemaCreate.yaml#/properties/StaffPersonal' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StaffAssignments: get: tags: - "StaffAssignment" summary: Default operation to get a list of all available StaffAssignments 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: $ref: 'jsonSchemaCreate.yaml#/properties/StaffAssignment' example: "StaffAssignments": { "StaffAssignment": [{ "StaffAssignmentRefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652", "StaffMember": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1651" }, "AssignedLocation": { "RefId": 203, "Name": "Wellington College" }, "Description": "Senior English Teacher", "StaffRole": "1102", "StartDate": "2000-09-05", "EndDate": "2001-06-25", "CasualReliefTeacher": "N", "EmploymentStatus": "A", "StaffSubjectList": { "StaffSubject": [{ "PreferenceNumber": 1, "Code": "ENGL", "YearLevels": { "YearLevel": [11, 12, 13] } }, { "PreferenceNumber": 2, "Code": "HIST" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StaffAssignments: type: object description: >- A List of StaffAssignment objects properties: StaffAssignment: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StaffAssignment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStaffAssignment requestBody: description: CRUD operation on StaffAssignment content: application/json: schema: type: object properties: StaffAssignment: $ref: 'jsonSchemaUpdate.yaml#/properties/StaffAssignment' example: "StaffAssignment": { "StaffAssignmentRefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652", "StaffMember": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1651" }, "AssignedLocation": { "RefId": 203, "Name": "Wellington College" }, "Description": "Senior English Teacher", "StaffRole": "1102", "StartDate": "2000-09-05", "EndDate": "2001-06-25", "CasualReliefTeacher": "N", "EmploymentStatus": "A", "StaffSubjectList": { "StaffSubject": [{ "PreferenceNumber": 1, "Code": "ENGL", "YearLevels": { "YearLevel": [11, 12, 13] } }, { "PreferenceNumber": 2, "Code": "HIST" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StaffAssignment: $ref: 'jsonSchemaUpdate.yaml#/properties/StaffAssignment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StaffAssignment: $ref: 'jsonSchemaCreate.yaml#/properties/StaffAssignment' example: "StaffAssignment": { "StaffAssignmentRefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652", "StaffMember": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1651" }, "AssignedLocation": { "RefId": 203, "Name": "Wellington College" }, "Description": "Senior English Teacher", "StaffRole": "1102", "StartDate": "2000-09-05", "EndDate": "2001-06-25", "CasualReliefTeacher": "N", "EmploymentStatus": "A", "StaffSubjectList": { "StaffSubject": [{ "PreferenceNumber": 1, "Code": "ENGL", "YearLevels": { "YearLevel": [11, 12, 13] } }, { "PreferenceNumber": 2, "Code": "HIST" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StaffAssignment: $ref: 'jsonSchemaCreate.yaml#/properties/StaffAssignment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StaffTeachingGroupAssignments: get: tags: - "StaffTeachingGroupAssignment" summary: Default operation to get a list of all available StaffTeachingGroupAssignments 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: $ref: 'jsonSchemaCreate.yaml#/properties/StaffTeachingGroupAssignment' example: "StaffTeachingGroupAssignments": { "StaffTeachingGroupAssignment": [{ "StaffTeachingGroupAssignmentRefId": "92828e71-c702-4944-841e-761203142ccd", "StaffMember": { "RefId": "6c12f5ae-ca86-40e2-b252-593154c8b967" }, "Provider": { "RefId": 636 }, "TeachingGroup": { "RefId": "edc3ac19-264f-4734-b75b-6d56fbf84a18", "LocalId": "11FrenA", "Name": "Year 11 French, Stream A" }, "Role": 1201, "StartDate": "2000-09-05", "EndDate": "2001-06-25", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StaffTeachingGroupAssignments: type: object description: >- A List of StaffTeachingGroupAssignment objects properties: StaffTeachingGroupAssignment: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StaffTeachingGroupAssignment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStaffTeachingGroupAssignment requestBody: description: CRUD operation on StaffTeachingGroupAssignment content: application/json: schema: type: object properties: StaffTeachingGroupAssignment: $ref: 'jsonSchemaUpdate.yaml#/properties/StaffTeachingGroupAssignment' example: "StaffTeachingGroupAssignment": { "StaffTeachingGroupAssignmentRefId": "92828e71-c702-4944-841e-761203142ccd", "StaffMember": { "RefId": "6c12f5ae-ca86-40e2-b252-593154c8b967" }, "Provider": { "RefId": 636 }, "TeachingGroup": { "RefId": "edc3ac19-264f-4734-b75b-6d56fbf84a18", "LocalId": "11FrenA", "Name": "Year 11 French, Stream A" }, "Role": 1201, "StartDate": "2000-09-05", "EndDate": "2001-06-25", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StaffTeachingGroupAssignment: $ref: 'jsonSchemaUpdate.yaml#/properties/StaffTeachingGroupAssignment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StaffTeachingGroupAssignment: $ref: 'jsonSchemaCreate.yaml#/properties/StaffTeachingGroupAssignment' example: "StaffTeachingGroupAssignment": { "StaffTeachingGroupAssignmentRefId": "92828e71-c702-4944-841e-761203142ccd", "StaffMember": { "RefId": "6c12f5ae-ca86-40e2-b252-593154c8b967" }, "Provider": { "RefId": 636 }, "TeachingGroup": { "RefId": "edc3ac19-264f-4734-b75b-6d56fbf84a18", "LocalId": "11FrenA", "Name": "Year 11 French, Stream A" }, "Role": 1201, "StartDate": "2000-09-05", "EndDate": "2001-06-25", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StaffTeachingGroupAssignment: $ref: 'jsonSchemaCreate.yaml#/properties/StaffTeachingGroupAssignment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentPersonals: get: tags: - "StudentPersonal" summary: Default operation to get a list of all available StudentPersonals 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentPersonal' 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": { "Iwi": [{ "Code": "NZS1001", "PreferenceOrderNumber": 1, "HapuAffiliationList": { "Hapu": [{ "HapuName": "Manukorihi", "PreferenceOrderNumber": 1 }] } }] }, "ReligiousAffiliationList": { "ReligiousAffiliation": ["NZS212", "NZS215"] } }, "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way", "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "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", "Line1": "P O Box 81", "City": "Martinborough", "PostalCode": "5781" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "hagrid@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "MOB", "Number": "(021) 300 999" }] } }] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentPersonals: type: object description: >- A List of StudentPersonal objects properties: StudentPersonal: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentPersonal' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentPersonal requestBody: description: CRUD operation on StudentPersonal content: application/json: schema: type: object properties: StudentPersonal: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentPersonal' 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": { "Iwi": [{ "Code": "NZS1001", "PreferenceOrderNumber": 1, "HapuAffiliationList": { "Hapu": [{ "HapuName": "Manukorihi", "PreferenceOrderNumber": 1 }] } }] }, "ReligiousAffiliationList": { "ReligiousAffiliation": ["NZS212", "NZS215"] } }, "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way", "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "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", "Line1": "P O Box 81", "City": "Martinborough", "PostalCode": "5781" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "hagrid@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "MOB", "Number": "(021) 300 999" }] } }] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentPersonal: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentPersonal' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentPersonal: $ref: 'jsonSchemaCreate.yaml#/properties/StudentPersonal' 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": { "Iwi": [{ "Code": "NZS1001", "PreferenceOrderNumber": 1, "HapuAffiliationList": { "Hapu": [{ "HapuName": "Manukorihi", "PreferenceOrderNumber": 1 }] } }] }, "ReligiousAffiliationList": { "ReligiousAffiliation": ["NZS212", "NZS215"] } }, "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way", "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "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", "Line1": "P O Box 81", "City": "Martinborough", "PostalCode": "5781" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "hagrid@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "MOB", "Number": "(021) 300 999" }] } }] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentPersonal: $ref: 'jsonSchemaCreate.yaml#/properties/StudentPersonal' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentContactPersonals: get: tags: - "StudentContactPersonal" summary: Default operation to get a list of all available StudentContactPersonals 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentContactPersonal' 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", "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way", "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "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", "Line1": "P O Box 81", "City": "Martinborough", "PostalCode": "5781" }] }, "EmailList": { "Email": [{ "Type": "WORK", "Address": "ridwulfa@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "MOB", "Number": "(021) 300 999" }] } }] } }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentContactPersonals: type: object description: >- A List of StudentContactPersonal objects properties: StudentContactPersonal: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentContactPersonal' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentContactRelationship requestBody: description: CRUD operation on StudentContactRelationship content: application/json: schema: type: object properties: StudentContactRelationship: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentContactRelationship' 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", "LivesWith": "N", "AccessToRecords": "N", "ReceivesAssessmentReport": "Y", "EmergencyContact": "Y", "CivilDefenceEmergencyContact": "N", "DisciplinaryContact": "N", "AttendanceContact": "N", "PrimaryCareProvider": "N", "FeesBilling": "Y", "FamilyMail": "Y", "CourtOrder": "N" }, "ContactSequence": 1, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentContactRelationship: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentContactRelationship' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentContactRelationship: $ref: 'jsonSchemaCreate.yaml#/properties/StudentContactRelationship' 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", "LivesWith": "N", "AccessToRecords": "N", "ReceivesAssessmentReport": "Y", "EmergencyContact": "Y", "CivilDefenceEmergencyContact": "N", "DisciplinaryContact": "N", "AttendanceContact": "N", "PrimaryCareProvider": "N", "FeesBilling": "Y", "FamilyMail": "Y", "CourtOrder": "N" }, "ContactSequence": 1, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentContactRelationship: $ref: 'jsonSchemaCreate.yaml#/properties/StudentContactRelationship' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /Documents: get: tags: - "Document" summary: Default operation to get a list of all available Documents 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: $ref: 'jsonSchemaCreate.yaml#/properties/Document' example: "Documents": { "Document": [{ "DocumentRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Provider": { "RefId": 386 }, "DocumentDescription": "Timmy McGannaway's IEP for 2019", "URL": "http://somehost.co.nz/docs/ghf12312", "DocumentType": "IEP", "PersonDocumentRoleList": { "PersonDocumentRole": [{ "Role": "SU", "Student": { "RefId": "17c9b7aa-bc34-435f-8bba-7e337891f53b", "ObjectType": "StudentPersonal", "NationalStudentNumber": 6788765445 } }, { "Role": "AU", "Person": { "RefId": "2a288f40-c3fb-4d9c-857e-0e562f3f5dde", "ObjectType": "StaffPersonal" } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: Documents: type: object description: >- A List of Document objects properties: Document: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/Document' example: >-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: $ref: 'jsonSchemaUpdate.yaml#/properties/Document' example: "Document": { "DocumentRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Provider": { "RefId": 386 }, "DocumentDescription": "Timmy McGannaway's IEP for 2019", "URL": "http://somehost.co.nz/docs/ghf12312", "DocumentType": "IEP", "PersonDocumentRoleList": { "PersonDocumentRole": [{ "Role": "SU", "Student": { "RefId": "17c9b7aa-bc34-435f-8bba-7e337891f53b", "ObjectType": "StudentPersonal", "NationalStudentNumber": 6788765445 } }, { "Role": "AU", "Person": { "RefId": "2a288f40-c3fb-4d9c-857e-0e562f3f5dde", "ObjectType": "StaffPersonal" } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: Document: $ref: 'jsonSchemaUpdate.yaml#/properties/Document' example: >-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: 'jsonSchemaCreate.yaml#/properties/Document' example: "Document": { "DocumentRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Provider": { "RefId": 386 }, "DocumentDescription": "Timmy McGannaway's IEP for 2019", "URL": "http://somehost.co.nz/docs/ghf12312", "DocumentType": "IEP", "PersonDocumentRoleList": { "PersonDocumentRole": [{ "Role": "SU", "Student": { "RefId": "17c9b7aa-bc34-435f-8bba-7e337891f53b", "ObjectType": "StudentPersonal", "NationalStudentNumber": 6788765445 } }, { "Role": "AU", "Person": { "RefId": "2a288f40-c3fb-4d9c-857e-0e562f3f5dde", "ObjectType": "StaffPersonal" } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: Document: $ref: 'jsonSchemaCreate.yaml#/properties/Document' example: >-The ID (GUID) assigned to uniquely identify this Document.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentConsents: get: tags: - "StudentConsent" summary: Default operation to get a list of all available StudentConsents 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentConsent' example: "StudentConsents": { "StudentConsent": [{ "StudentConsentRefId": "7c834ea9-eda1-2090-347f-83297e1c290c", "StudentConsentLocalId": "S1234567", "Student": { "RefId": "fe659ed3-8a78-4bc0-8876-7b75ac585edf" }, "Organisation": { "RefId": 9961 }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentConsents: type: object description: >- A List of StudentConsent objects properties: StudentConsent: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentConsent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentConsent requestBody: description: CRUD operation on StudentConsent content: application/json: schema: type: object properties: StudentConsent: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentConsent' example: "StudentConsent": { "StudentConsentRefId": "7c834ea9-eda1-2090-347f-83297e1c290c", "StudentConsentLocalId": "S1234567", "Student": { "RefId": "fe659ed3-8a78-4bc0-8876-7b75ac585edf" }, "Organisation": { "RefId": 9961 }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentConsent: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentConsent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentConsent: $ref: 'jsonSchemaCreate.yaml#/properties/StudentConsent' example: "StudentConsent": { "StudentConsentRefId": "7c834ea9-eda1-2090-347f-83297e1c290c", "StudentConsentLocalId": "S1234567", "Student": { "RefId": "fe659ed3-8a78-4bc0-8876-7b75ac585edf" }, "Organisation": { "RefId": 9961 }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentConsent: $ref: 'jsonSchemaCreate.yaml#/properties/StudentConsent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /TeachingGroups: get: tags: - "TeachingGroup" summary: Default operation to get a list of all available TeachingGroups 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: $ref: 'jsonSchemaCreate.yaml#/properties/TeachingGroup' 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": 234 }, "ScheduleTerm": { "LocalId": "FY2020" }, "StudentList": { "Student": [{ "RefId": "9897466f-200e-4bc1-b9ae-d1507da15cef", "LocalId": "SMI001", "Name": "Peter Smith" }, { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290d", "LocalId": "SMI002", "Name": "Jennifer Smith" }, { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290e", "LocalId": "SMI003", "Name": "Terence Smith" }] }, "TeacherList": { "StaffMember": [{ "RefId": "a8c3a2e3-5b35-9d75-101d-00aa001a0000", "LocalId": "SMI1", "Name": "Thomas Smith", "Role": "1001" }, { "RefId": "a8cccce3-5b35-9d75-101d-00aa001a0000", "LocalId": "LONG2", "Name": "Tamara Long", "Role": "1002" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: TeachingGroups: type: object description: >- A List of TeachingGroup objects properties: TeachingGroup: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/TeachingGroup' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateTeachingGroup requestBody: description: CRUD operation on TeachingGroup content: application/json: schema: type: object properties: TeachingGroup: $ref: 'jsonSchemaUpdate.yaml#/properties/TeachingGroup' example: "TeachingGroup": { "TeachingGroupRefId": "64a309da-063a-2e35-b359-d75101a8c3d1", "TeachingGroupLocalId": "20087ASPN", "ShortName": "7A SPN", "LongName": "Year 7A Maths - Space and Numbers", "GroupType": "SC", "Provider": { "RefId": 234 }, "ScheduleTerm": { "LocalId": "FY2020" }, "StudentList": { "Student": [{ "RefId": "9897466f-200e-4bc1-b9ae-d1507da15cef", "LocalId": "SMI001", "Name": "Peter Smith" }, { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290d", "LocalId": "SMI002", "Name": "Jennifer Smith" }, { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290e", "LocalId": "SMI003", "Name": "Terence Smith" }] }, "TeacherList": { "StaffMember": [{ "RefId": "a8c3a2e3-5b35-9d75-101d-00aa001a0000", "LocalId": "SMI1", "Name": "Thomas Smith", "Role": "1001" }, { "RefId": "a8cccce3-5b35-9d75-101d-00aa001a0000", "LocalId": "LONG2", "Name": "Tamara Long", "Role": "1002" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: TeachingGroup: $ref: 'jsonSchemaUpdate.yaml#/properties/TeachingGroup' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: TeachingGroup: $ref: 'jsonSchemaCreate.yaml#/properties/TeachingGroup' example: "TeachingGroup": { "TeachingGroupRefId": "64a309da-063a-2e35-b359-d75101a8c3d1", "TeachingGroupLocalId": "20087ASPN", "ShortName": "7A SPN", "LongName": "Year 7A Maths - Space and Numbers", "GroupType": "SC", "Provider": { "RefId": 234 }, "ScheduleTerm": { "LocalId": "FY2020" }, "StudentList": { "Student": [{ "RefId": "9897466f-200e-4bc1-b9ae-d1507da15cef", "LocalId": "SMI001", "Name": "Peter Smith" }, { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290d", "LocalId": "SMI002", "Name": "Jennifer Smith" }, { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290e", "LocalId": "SMI003", "Name": "Terence Smith" }] }, "TeacherList": { "StaffMember": [{ "RefId": "a8c3a2e3-5b35-9d75-101d-00aa001a0000", "LocalId": "SMI1", "Name": "Thomas Smith", "Role": "1001" }, { "RefId": "a8cccce3-5b35-9d75-101d-00aa001a0000", "LocalId": "LONG2", "Name": "Tamara Long", "Role": "1002" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: TeachingGroup: $ref: 'jsonSchemaCreate.yaml#/properties/TeachingGroup' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /ProviderCourses: get: tags: - "ProviderCourse" summary: Default operation to get a list of all available ProviderCourses 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: $ref: 'jsonSchemaCreate.yaml#/properties/ProviderCourse' example: "ProviderCourses": { "ProviderCourse": [{ "ProviderCourseRefId": "9d75101a-8c3d-00aa-001a-0000a2e35b35", "ProviderCourseLocalId": "12CHEM", "Provider": { "RefId": 632 }, "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": { "LearningStandardRefId": ["NC-91165-v2", "NC-91166-v2", "NC-91167-v2"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: ProviderCourses: type: object description: >- A List of ProviderCourse objects properties: ProviderCourse: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/ProviderCourse' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateProviderCourse requestBody: description: CRUD operation on ProviderCourse content: application/json: schema: type: object properties: ProviderCourse: $ref: 'jsonSchemaUpdate.yaml#/properties/ProviderCourse' example: "ProviderCourse": { "ProviderCourseRefId": "9d75101a-8c3d-00aa-001a-0000a2e35b35", "ProviderCourseLocalId": "12CHEM", "Provider": { "RefId": 632 }, "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": { "LearningStandardRefId": ["NC-91165-v2", "NC-91166-v2", "NC-91167-v2"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: ProviderCourse: $ref: 'jsonSchemaUpdate.yaml#/properties/ProviderCourse' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: ProviderCourse: $ref: 'jsonSchemaCreate.yaml#/properties/ProviderCourse' example: "ProviderCourse": { "ProviderCourseRefId": "9d75101a-8c3d-00aa-001a-0000a2e35b35", "ProviderCourseLocalId": "12CHEM", "Provider": { "RefId": 632 }, "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": { "LearningStandardRefId": ["NC-91165-v2", "NC-91166-v2", "NC-91167-v2"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: ProviderCourse: $ref: 'jsonSchemaCreate.yaml#/properties/ProviderCourse' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /LearningStandards: get: tags: - "LearningStandard" summary: Default operation to get a list of all available LearningStandards 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: $ref: 'jsonSchemaCreate.yaml#/properties/LearningStandard' 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", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: LearningStandards: type: object description: >- A List of LearningStandard objects properties: LearningStandard: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/LearningStandard' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateLearningStandard requestBody: description: CRUD operation on LearningStandard content: application/json: schema: type: object properties: LearningStandard: $ref: 'jsonSchemaUpdate.yaml#/properties/LearningStandard' 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", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: LearningStandard: $ref: 'jsonSchemaUpdate.yaml#/properties/LearningStandard' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: LearningStandard: $ref: 'jsonSchemaCreate.yaml#/properties/LearningStandard' 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", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: LearningStandard: $ref: 'jsonSchemaCreate.yaml#/properties/LearningStandard' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /Credentials: get: tags: - "Credential" summary: Default operation to get a list of all available Credentials 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: $ref: 'jsonSchemaCreate.yaml#/properties/Credential' example: "Credentials": { "Credential": [{ "CredentialRefId": "2b560779-872b-4491-afd6-3c6bd5f1c8cc", "CredentialLocalId": "91165-v2", "Title": "NCEA Level 2 - Endorsed with Merit", "VersionNo": 2, "Administrator": { "RefId": "3d614c16-9046-47d1-87b5-51438590de15", "Name": "NZQA" }, "Description": "Achieved sufficient chemistry credits endorsed with merit", "SubjectAreaList": { "SubjectArea": ["CHEM"] }, "Status": "PU", "Credits": 4, "Level": 2, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: Credentials: type: object description: >- A List of Credential objects properties: Credential: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/Credential' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateCredential requestBody: description: CRUD operation on Credential content: application/json: schema: type: object properties: Credential: $ref: 'jsonSchemaUpdate.yaml#/properties/Credential' example: "Credential": { "CredentialRefId": "2b560779-872b-4491-afd6-3c6bd5f1c8cc", "CredentialLocalId": "91165-v2", "Title": "NCEA Level 2 - Endorsed with Merit", "VersionNo": 2, "Administrator": { "RefId": "3d614c16-9046-47d1-87b5-51438590de15", "Name": "NZQA" }, "Description": "Achieved sufficient chemistry credits endorsed with merit", "SubjectAreaList": { "SubjectArea": ["CHEM"] }, "Status": "PU", "Credits": 4, "Level": 2, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: Credential: $ref: 'jsonSchemaUpdate.yaml#/properties/Credential' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: Credential: $ref: 'jsonSchemaCreate.yaml#/properties/Credential' example: "Credential": { "CredentialRefId": "2b560779-872b-4491-afd6-3c6bd5f1c8cc", "CredentialLocalId": "91165-v2", "Title": "NCEA Level 2 - Endorsed with Merit", "VersionNo": 2, "Administrator": { "RefId": "3d614c16-9046-47d1-87b5-51438590de15", "Name": "NZQA" }, "Description": "Achieved sufficient chemistry credits endorsed with merit", "SubjectAreaList": { "SubjectArea": ["CHEM"] }, "Status": "PU", "Credits": 4, "Level": 2, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: Credential: $ref: 'jsonSchemaCreate.yaml#/properties/Credential' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentProviderEnrolments: get: tags: - "StudentProviderEnrolment" summary: Default operation to get a list of all available StudentProviderEnrolments 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentProviderEnrolment' example: "StudentProviderEnrolments": { "StudentProviderEnrolment": [{ "StudentProviderEnrolmentRefId": "a8c3d3e3-4b35-9d75-101d-00aa001a1652", "StudentProviderEnrolmentLocalId": "2004H102", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 872 }, "StudentId": "123ABC", "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.0, "FundingType": "EX", "FundingYearLevel": "1", "Curriculum": "NZC", "CurriculumLevel": 5, "InternationalEnrolment": { "NZArrivalDate": "2018-05-02", "ExchangeScheme": "STA" } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentProviderEnrolments: type: object description: >- A List of StudentProviderEnrolment objects properties: StudentProviderEnrolment: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentProviderEnrolment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentProviderEnrolment requestBody: description: CRUD operation on StudentProviderEnrolment content: application/json: schema: type: object properties: StudentProviderEnrolment: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentProviderEnrolment' example: "StudentProviderEnrolment": { "StudentProviderEnrolmentRefId": "a8c3d3e3-4b35-9d75-101d-00aa001a1652", "StudentProviderEnrolmentLocalId": "2004H102", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 872 }, "StudentId": "123ABC", "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.0, "FundingType": "EX", "FundingYearLevel": "1", "Curriculum": "NZC", "CurriculumLevel": 5, "InternationalEnrolment": { "NZArrivalDate": "2018-05-02", "ExchangeScheme": "STA" } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentProviderEnrolment: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentProviderEnrolment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentProviderEnrolment: $ref: 'jsonSchemaCreate.yaml#/properties/StudentProviderEnrolment' example: "StudentProviderEnrolment": { "StudentProviderEnrolmentRefId": "a8c3d3e3-4b35-9d75-101d-00aa001a1652", "StudentProviderEnrolmentLocalId": "2004H102", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 872 }, "StudentId": "123ABC", "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.0, "FundingType": "EX", "FundingYearLevel": "1", "Curriculum": "NZC", "CurriculumLevel": 5, "InternationalEnrolment": { "NZArrivalDate": "2018-05-02", "ExchangeScheme": "STA" } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentProviderEnrolment: $ref: 'jsonSchemaCreate.yaml#/properties/StudentProviderEnrolment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentTeachingGroupEnrolments: get: tags: - "StudentTeachingGroupEnrolment" summary: Default operation to get a list of all available StudentTeachingGroupEnrolments 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentTeachingGroupEnrolment' example: "StudentTeachingGroupEnrolments": { "StudentTeachingGroupEnrolment": [{ "StudentTeachingGroupEnrolmentRefId": "a8c3d3e3-4b35-9d75-101d-00aa001a1652", "StudentTeachingGroupEnrolmentLocalId": "2004H102", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 9961 }, "TeachingGroup": { "RefId": "93b9b77e-a23f-4acd-a65e-e26f1034317f" }, "StartDate": "2018-01-29", "EndDate": "2018-12-05", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentTeachingGroupEnrolments: type: object description: >- A List of StudentTeachingGroupEnrolment objects properties: StudentTeachingGroupEnrolment: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentTeachingGroupEnrolment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentTeachingGroupEnrolment requestBody: description: CRUD operation on StudentTeachingGroupEnrolment content: application/json: schema: type: object properties: StudentTeachingGroupEnrolment: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentTeachingGroupEnrolment' example: "StudentTeachingGroupEnrolment": { "StudentTeachingGroupEnrolmentRefId": "a8c3d3e3-4b35-9d75-101d-00aa001a1652", "StudentTeachingGroupEnrolmentLocalId": "2004H102", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 9961 }, "TeachingGroup": { "RefId": "93b9b77e-a23f-4acd-a65e-e26f1034317f" }, "StartDate": "2018-01-29", "EndDate": "2018-12-05", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentTeachingGroupEnrolment: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentTeachingGroupEnrolment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentTeachingGroupEnrolment: $ref: 'jsonSchemaCreate.yaml#/properties/StudentTeachingGroupEnrolment' example: "StudentTeachingGroupEnrolment": { "StudentTeachingGroupEnrolmentRefId": "a8c3d3e3-4b35-9d75-101d-00aa001a1652", "StudentTeachingGroupEnrolmentLocalId": "2004H102", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 9961 }, "TeachingGroup": { "RefId": "93b9b77e-a23f-4acd-a65e-e26f1034317f" }, "StartDate": "2018-01-29", "EndDate": "2018-12-05", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentTeachingGroupEnrolment: $ref: 'jsonSchemaCreate.yaml#/properties/StudentTeachingGroupEnrolment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /Schedules: get: tags: - "Schedule" summary: Default operation to get a list of all available Schedules 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: $ref: 'jsonSchemaCreate.yaml#/properties/Schedule' 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": 783, "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" }] } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: Schedules: type: object description: >- A List of Schedule objects properties: Schedule: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/Schedule' example: >-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: $ref: 'jsonSchemaUpdate.yaml#/properties/Schedule' 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": 783, "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" }] } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: Schedule: $ref: 'jsonSchemaUpdate.yaml#/properties/Schedule' example: >-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: 'jsonSchemaCreate.yaml#/properties/Schedule' 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": 783, "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" }] } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: Schedule: $ref: 'jsonSchemaCreate.yaml#/properties/Schedule' example: >-The ID (GUID) assigned to uniquely identify this Schedule.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /ScheduleAcademicDays: get: tags: - "ScheduleAcademicDay" summary: Default operation to get a list of all available ScheduleAcademicDays 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: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleAcademicDay' example: "ScheduleAcademicDays": { "ScheduleAcademicDay": [{ "ScheduleAcademicDayRefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9", "ScheduleAcademicDayLocalId": "2019a-A", "AcademicDayName": "Scheule 2019a, Day A", "Provider": { "RefId": 783, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: ScheduleAcademicDays: type: object description: >- A List of ScheduleAcademicDay objects properties: ScheduleAcademicDay: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleAcademicDay' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateScheduleAcademicDay requestBody: description: CRUD operation on ScheduleAcademicDay content: application/json: schema: type: object properties: ScheduleAcademicDay: $ref: 'jsonSchemaUpdate.yaml#/properties/ScheduleAcademicDay' example: "ScheduleAcademicDay": { "ScheduleAcademicDayRefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9", "ScheduleAcademicDayLocalId": "2019a-A", "AcademicDayName": "Scheule 2019a, Day A", "Provider": { "RefId": 783, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: ScheduleAcademicDay: $ref: 'jsonSchemaUpdate.yaml#/properties/ScheduleAcademicDay' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: ScheduleAcademicDay: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleAcademicDay' example: "ScheduleAcademicDay": { "ScheduleAcademicDayRefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9", "ScheduleAcademicDayLocalId": "2019a-A", "AcademicDayName": "Scheule 2019a, Day A", "Provider": { "RefId": 783, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: ScheduleAcademicDay: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleAcademicDay' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /SchedulePeriods: get: tags: - "SchedulePeriod" summary: Default operation to get a list of all available SchedulePeriods 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: $ref: 'jsonSchemaCreate.yaml#/properties/SchedulePeriod' example: "SchedulePeriods": { "SchedulePeriod": [{ "SchedulePeriodRefId": "215f796c-67f7-4855-83dc-28ad9d002830", "SchedulePeriodLocalId": "2019a-1", "PeriodName": "Period 1", "Provider": { "RefId": 783, "Name": "Hogwarts High" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "LocalId": "2019a", "Name": "Scheule 2019a (Term 1)" }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: SchedulePeriods: type: object description: >- A List of SchedulePeriod objects properties: SchedulePeriod: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/SchedulePeriod' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateSchedulePeriod requestBody: description: CRUD operation on SchedulePeriod content: application/json: schema: type: object properties: SchedulePeriod: $ref: 'jsonSchemaUpdate.yaml#/properties/SchedulePeriod' example: "SchedulePeriod": { "SchedulePeriodRefId": "215f796c-67f7-4855-83dc-28ad9d002830", "SchedulePeriodLocalId": "2019a-1", "PeriodName": "Period 1", "Provider": { "RefId": 783, "Name": "Hogwarts High" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "LocalId": "2019a", "Name": "Scheule 2019a (Term 1)" }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: SchedulePeriod: $ref: 'jsonSchemaUpdate.yaml#/properties/SchedulePeriod' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: SchedulePeriod: $ref: 'jsonSchemaCreate.yaml#/properties/SchedulePeriod' example: "SchedulePeriod": { "SchedulePeriodRefId": "215f796c-67f7-4855-83dc-28ad9d002830", "SchedulePeriodLocalId": "2019a-1", "PeriodName": "Period 1", "Provider": { "RefId": 783, "Name": "Hogwarts High" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "LocalId": "2019a", "Name": "Scheule 2019a (Term 1)" }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: SchedulePeriod: $ref: 'jsonSchemaCreate.yaml#/properties/SchedulePeriod' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /BellSchedules: get: tags: - "BellSchedule" summary: Default operation to get a list of all available BellSchedules 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: $ref: 'jsonSchemaCreate.yaml#/properties/BellSchedule' example: "BellSchedules": { "BellSchedule": [{ "BellScheduleRefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "BellScheduleLocalId": "2019a-Normal", "BellScheduleName": "Schedule 2019a, Normal Bell Schedule", "Provider": { "RefId": 844, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: BellSchedules: type: object description: >- A List of BellSchedule objects properties: BellSchedule: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/BellSchedule' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateBellSchedule requestBody: description: CRUD operation on BellSchedule content: application/json: schema: type: object properties: BellSchedule: $ref: 'jsonSchemaUpdate.yaml#/properties/BellSchedule' example: "BellSchedule": { "BellScheduleRefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "BellScheduleLocalId": "2019a-Normal", "BellScheduleName": "Schedule 2019a, Normal Bell Schedule", "Provider": { "RefId": 844, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: BellSchedule: $ref: 'jsonSchemaUpdate.yaml#/properties/BellSchedule' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: BellSchedule: $ref: 'jsonSchemaCreate.yaml#/properties/BellSchedule' example: "BellSchedule": { "BellScheduleRefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "BellScheduleLocalId": "2019a-Normal", "BellScheduleName": "Schedule 2019a, Normal Bell Schedule", "Provider": { "RefId": 844, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: BellSchedule: $ref: 'jsonSchemaCreate.yaml#/properties/BellSchedule' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /ScheduleTerms: get: tags: - "ScheduleTerm" summary: Default operation to get a list of all available ScheduleTerms 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: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleTerm' example: "ScheduleTerms": { "ScheduleTerm": [{ "ScheduleTermRefId": "eed03e3c-b088-4b69-bba7-b042f6f7a040", "ScheduleTermLocalId": "2019-1", "TermName": "Term I of 2019", "Provider": { "RefId": 783 }, "StartDate": "2019-01-28", "EndDate": "2019-03-13", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: ScheduleTerms: type: object description: >- A List of ScheduleTerm objects properties: ScheduleTerm: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleTerm' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateScheduleTerm requestBody: description: CRUD operation on ScheduleTerm content: application/json: schema: type: object properties: ScheduleTerm: $ref: 'jsonSchemaUpdate.yaml#/properties/ScheduleTerm' example: "ScheduleTerm": { "ScheduleTermRefId": "eed03e3c-b088-4b69-bba7-b042f6f7a040", "ScheduleTermLocalId": "2019-1", "TermName": "Term I of 2019", "Provider": { "RefId": 783 }, "StartDate": "2019-01-28", "EndDate": "2019-03-13", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: ScheduleTerm: $ref: 'jsonSchemaUpdate.yaml#/properties/ScheduleTerm' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: ScheduleTerm: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleTerm' example: "ScheduleTerm": { "ScheduleTermRefId": "eed03e3c-b088-4b69-bba7-b042f6f7a040", "ScheduleTermLocalId": "2019-1", "TermName": "Term I of 2019", "Provider": { "RefId": 783 }, "StartDate": "2019-01-28", "EndDate": "2019-03-13", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: ScheduleTerm: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleTerm' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /ScheduleHolidays: get: tags: - "ScheduleHoliday" summary: Default operation to get a list of all available ScheduleHolidays 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: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleHoliday' 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", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: ScheduleHolidays: type: object description: >- A List of ScheduleHoliday objects properties: ScheduleHoliday: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleHoliday' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateScheduleHoliday requestBody: description: CRUD operation on ScheduleHoliday content: application/json: schema: type: object properties: ScheduleHoliday: $ref: 'jsonSchemaUpdate.yaml#/properties/ScheduleHoliday' example: "ScheduleHoliday": { "ScheduleHolidayRefId": "4e8387f0-faed-4eb5-84ef-2139da62133d", "ScheduleHolidayLocalId": "2019-ANZAC", "HolidayDate": "2019-04-25", "HolidayName": "ANZAC Day", "HolidayLongName": "ANZAC Day, 2019", "AlwaysDisplayFlag": "Y", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: ScheduleHoliday: $ref: 'jsonSchemaUpdate.yaml#/properties/ScheduleHoliday' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: ScheduleHoliday: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleHoliday' example: "ScheduleHoliday": { "ScheduleHolidayRefId": "4e8387f0-faed-4eb5-84ef-2139da62133d", "ScheduleHolidayLocalId": "2019-ANZAC", "HolidayDate": "2019-04-25", "HolidayName": "ANZAC Day", "HolidayLongName": "ANZAC Day, 2019", "AlwaysDisplayFlag": "Y", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: ScheduleHoliday: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleHoliday' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /ScheduleDates: get: tags: - "ScheduleDate" summary: Default operation to get a list of all available ScheduleDates 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: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleDate' example: "ScheduleDates": { "ScheduleDate": [{ "ScheduleDateRefId": "84c40f87-769d-46cc-8077-f5efb912e099", "ScheduleDateLocalId": "2019a-A-06", "CalendarDate": "2019-03-14", "Provider": { "RefId": 783, "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" }, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: ScheduleDates: type: object description: >- A List of ScheduleDate objects properties: ScheduleDate: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleDate' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateScheduleDate requestBody: description: CRUD operation on ScheduleDate content: application/json: schema: type: object properties: ScheduleDate: $ref: 'jsonSchemaUpdate.yaml#/properties/ScheduleDate' example: "ScheduleDate": { "ScheduleDateRefId": "84c40f87-769d-46cc-8077-f5efb912e099", "ScheduleDateLocalId": "2019a-A-06", "CalendarDate": "2019-03-14", "Provider": { "RefId": 783, "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" }, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: ScheduleDate: $ref: 'jsonSchemaUpdate.yaml#/properties/ScheduleDate' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: ScheduleDate: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleDate' example: "ScheduleDate": { "ScheduleDateRefId": "84c40f87-769d-46cc-8077-f5efb912e099", "ScheduleDateLocalId": "2019a-A-06", "CalendarDate": "2019-03-14", "Provider": { "RefId": 783, "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" }, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: ScheduleDate: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleDate' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /TeachingGroupEvents: get: tags: - "TeachingGroupEvent" summary: Default operation to get a list of all available TeachingGroupEvents 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: $ref: 'jsonSchemaCreate.yaml#/properties/TeachingGroupEvent' example: "TeachingGroupEvents": { "TeachingGroupEvent": [{ "TeachingGroupEventRefId": "9356909d-e46a-456a-a177-6a914af861ae", "TeachingGroupEventLocalId": "20197A-SPN-1", "Provider": { "RefId": 9961, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: TeachingGroupEvents: type: object description: >- A List of TeachingGroupEvent objects properties: TeachingGroupEvent: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/TeachingGroupEvent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateTeachingGroupEvent requestBody: description: CRUD operation on TeachingGroupEvent content: application/json: schema: type: object properties: TeachingGroupEvent: $ref: 'jsonSchemaUpdate.yaml#/properties/TeachingGroupEvent' example: "TeachingGroupEvent": { "TeachingGroupEventRefId": "9356909d-e46a-456a-a177-6a914af861ae", "TeachingGroupEventLocalId": "20197A-SPN-1", "Provider": { "RefId": 9961, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: TeachingGroupEvent: $ref: 'jsonSchemaUpdate.yaml#/properties/TeachingGroupEvent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: TeachingGroupEvent: $ref: 'jsonSchemaCreate.yaml#/properties/TeachingGroupEvent' example: "TeachingGroupEvent": { "TeachingGroupEventRefId": "9356909d-e46a-456a-a177-6a914af861ae", "TeachingGroupEventLocalId": "20197A-SPN-1", "Provider": { "RefId": 9961, "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" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: TeachingGroupEvent: $ref: 'jsonSchemaCreate.yaml#/properties/TeachingGroupEvent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /ScheduleEvents: get: tags: - "ScheduleEvent" summary: Default operation to get a list of all available ScheduleEvents 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: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleEvent' example: "ScheduleEvents": { "ScheduleEvent": [{ "ScheduleEventRefId": "c79e65df-0b11-4a97-9062-9fbd1c1a38e3", "ScheduleEventLocalId": "evMarSlip", "Provider": { "RefId": 783, "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: 'jsonSchemaCreate.yaml#/properties/ScheduleEvent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateScheduleEvent requestBody: description: CRUD operation on ScheduleEvent content: application/json: schema: type: object properties: ScheduleEvent: $ref: 'jsonSchemaUpdate.yaml#/properties/ScheduleEvent' example: "ScheduleEvent": { "ScheduleEventRefId": "c79e65df-0b11-4a97-9062-9fbd1c1a38e3", "ScheduleEventLocalId": "evMarSlip", "Provider": { "RefId": 783, "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: ScheduleEvent: $ref: 'jsonSchemaUpdate.yaml#/properties/ScheduleEvent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: ScheduleEvent: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleEvent' example: "ScheduleEvent": { "ScheduleEventRefId": "c79e65df-0b11-4a97-9062-9fbd1c1a38e3", "ScheduleEventLocalId": "evMarSlip", "Provider": { "RefId": 783, "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: ScheduleEvent: $ref: 'jsonSchemaCreate.yaml#/properties/ScheduleEvent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentAttendanceSummarys: get: tags: - "StudentAttendanceSummary" summary: Default operation to get a list of all available StudentAttendanceSummarys 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttendanceSummary' example: "StudentAttendanceSummarys": { "StudentAttendanceSummary": [{ "StudentAttendanceSummaryRefId": "d3476fae-8647-384b-da24-31eda3583211", "Student": { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290c" }, "Provider": { "RefId": 743 }, "SchoolCalendarYear": 2015, "StartDate": "2014-08-30", "EndDate": "2015-06-10", "StartDay": 1, "EndDay": 180, "FTE": 1.00, "HalfDaysYearPresent": 178, "HalfDaysYearJustified": 2, "HalfDaysYearTotal": 2, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentAttendanceSummarys: type: object description: >- A List of StudentAttendanceSummary objects properties: StudentAttendanceSummary: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttendanceSummary' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentAttendanceSummary requestBody: description: CRUD operation on StudentAttendanceSummary content: application/json: schema: type: object properties: StudentAttendanceSummary: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAttendanceSummary' example: "StudentAttendanceSummary": { "StudentAttendanceSummaryRefId": "d3476fae-8647-384b-da24-31eda3583211", "Student": { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290c" }, "Provider": { "RefId": 743 }, "SchoolCalendarYear": 2015, "StartDate": "2014-08-30", "EndDate": "2015-06-10", "StartDay": 1, "EndDay": 180, "FTE": 1.00, "HalfDaysYearPresent": 178, "HalfDaysYearJustified": 2, "HalfDaysYearTotal": 2, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentAttendanceSummary: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAttendanceSummary' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentAttendanceSummary: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttendanceSummary' example: "StudentAttendanceSummary": { "StudentAttendanceSummaryRefId": "d3476fae-8647-384b-da24-31eda3583211", "Student": { "RefId": "7c834ea9-eda1-2090-347f-83297e1c290c" }, "Provider": { "RefId": 743 }, "SchoolCalendarYear": 2015, "StartDate": "2014-08-30", "EndDate": "2015-06-10", "StartDay": 1, "EndDay": 180, "FTE": 1.00, "HalfDaysYearPresent": 178, "HalfDaysYearJustified": 2, "HalfDaysYearTotal": 2, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentAttendanceSummary: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttendanceSummary' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentAttendanceTimeLists: get: tags: - "StudentAttendanceTimeList" summary: Default operation to get a list of all available StudentAttendanceTimeLists 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttendanceTimeList' example: "StudentAttendanceTimeLists": { "StudentAttendanceTimeList": [{ "Student": { "RefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd991234" }, "Provider": { "RefId": 762 }, "TeachingGroup": { "RefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd993378" }, "AttendanceTimeList": { "AttendanceTime": [{ "AttendanceTimeLocalId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd934554", "AttendanceType": "SCH", "Code": "P", "AttendanceDate": "2018-06-26", "SchedulePeriod": { "RefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd999999" }, "SubmissionDateTime": "2018-06-30T06:30:57", "Note": "Student was present.", "RecordAudit": { "LastUpdatedDateTime": "2018-06-28T06:30:57" } }, { "AttendanceTimeLocalId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd934667", "AttendanceType": "ADH", "Code": "E", "AttendanceDate": "2018-06-27", "StartTime": "09:45:00", "EndTime": "10:30:00", "SubmissionDateTime": "2018-06-30T06:30:57", "Note": "Explained absence, but unjustified.", "RecordAudit": { "LastUpdatedDateTime": "2018-06-28T06:30:57" } }] } }] } application/xml: schema: type: object properties: StudentAttendanceTimeLists: type: object description: >- A List of StudentAttendanceTimeList objects properties: StudentAttendanceTimeList: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttendanceTimeList' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateWellbeingAlert requestBody: description: CRUD operation on WellbeingAlert content: application/json: schema: type: object properties: WellbeingAlert: $ref: 'jsonSchemaUpdate.yaml#/properties/WellbeingAlert' example: "WellbeingAlert": { "WellbeingAlertRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 672 }, "StaffMember": { "RefId": "ba265776-359d-7510-1a8c-77432a901a16" }, "PublishedDate": "2017-11-01", "StartDate": "2017-11-01", "AlertCategory": "MED", "AlertDescription": "This Student is allergic to peanuts", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: WellbeingAlert: $ref: 'jsonSchemaUpdate.yaml#/properties/WellbeingAlert' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: WellbeingAlert: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingAlert' example: "WellbeingAlert": { "WellbeingAlertRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 672 }, "StaffMember": { "RefId": "ba265776-359d-7510-1a8c-77432a901a16" }, "PublishedDate": "2017-11-01", "StartDate": "2017-11-01", "AlertCategory": "MED", "AlertDescription": "This Student is allergic to peanuts", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: WellbeingAlert: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingAlert' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /WellbeingCharacteristics: get: tags: - "WellbeingCharacteristic" summary: Default operation to get a list of all available WellbeingCharacteristics 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: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingCharacteristic' example: "WellbeingCharacteristics": { "WellbeingCharacteristic": [{ "WellbeingCharacteristicRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "RecordingProvider": { "RefId": 672 }, "StartDate": "2017-11-01", "EndDate": "2017-11-10", "CharacteristicNotes": "This Student has a special need.", "Classification": "LSN", "Category": "LSN-SOC", "SubCategory": "LSN-HYP", "CaseLead": "RT", "CaseLeadContactPerson": "Dr RTL Bush", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: WellbeingCharacteristics: type: object description: >- A List of WellbeingCharacteristic objects properties: WellbeingCharacteristic: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingCharacteristic' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateWellbeingCharacteristic requestBody: description: CRUD operation on WellbeingCharacteristic content: application/json: schema: type: object properties: WellbeingCharacteristic: $ref: 'jsonSchemaUpdate.yaml#/properties/WellbeingCharacteristic' example: "WellbeingCharacteristic": { "WellbeingCharacteristicRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "RecordingProvider": { "RefId": 672 }, "StartDate": "2017-11-01", "EndDate": "2017-11-10", "CharacteristicNotes": "This Student has a special need.", "Classification": "LSN", "Category": "LSN-SOC", "SubCategory": "LSN-HYP", "CaseLead": "RT", "CaseLeadContactPerson": "Dr RTL Bush", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: WellbeingCharacteristic: $ref: 'jsonSchemaUpdate.yaml#/properties/WellbeingCharacteristic' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: WellbeingCharacteristic: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingCharacteristic' example: "WellbeingCharacteristic": { "WellbeingCharacteristicRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "RecordingProvider": { "RefId": 672 }, "StartDate": "2017-11-01", "EndDate": "2017-11-10", "CharacteristicNotes": "This Student has a special need.", "Classification": "LSN", "Category": "LSN-SOC", "SubCategory": "LSN-HYP", "CaseLead": "RT", "CaseLeadContactPerson": "Dr RTL Bush", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: WellbeingCharacteristic: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingCharacteristic' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /WellbeingEvents: get: tags: - "WellbeingEvent" summary: Default operation to get a list of all available WellbeingEvents 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: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingEvent' example: "WellbeingEvents": { "WellbeingEvent": [{ "WellbeingEventRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "ReportingProvider": { "RefId": 773 }, "EventCategoryClass": "POS", "EventDate": "2017-11-01", "EventTimePeriod": "AM", "RestraintType": "NON", "ActionTakenList": { "ActionTaken": ["ININ"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: WellbeingEvents: type: object description: >- A List of WellbeingEvent objects properties: WellbeingEvent: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingEvent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateWellbeingEvent requestBody: description: CRUD operation on WellbeingEvent content: application/json: schema: type: object properties: WellbeingEvent: $ref: 'jsonSchemaUpdate.yaml#/properties/WellbeingEvent' example: "WellbeingEvent": { "WellbeingEventRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "ReportingProvider": { "RefId": 773 }, "EventCategoryClass": "POS", "EventDate": "2017-11-01", "EventTimePeriod": "AM", "RestraintType": "NON", "ActionTakenList": { "ActionTaken": ["ININ"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: WellbeingEvent: $ref: 'jsonSchemaUpdate.yaml#/properties/WellbeingEvent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: WellbeingEvent: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingEvent' example: "WellbeingEvent": { "WellbeingEventRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "ReportingProvider": { "RefId": 773 }, "EventCategoryClass": "POS", "EventDate": "2017-11-01", "EventTimePeriod": "AM", "RestraintType": "NON", "ActionTakenList": { "ActionTaken": ["ININ"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: WellbeingEvent: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingEvent' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /WellbeingResponses: get: tags: - "WellbeingResponse" summary: Default operation to get a list of all available WellbeingResponses 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: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingResponse' example: "WellbeingResponses": { "WellbeingResponse": [{ "WellbeingResponseRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 877 }, "PublishedDate": "2017-11-01", "StartDate": "2017-11-01", "EndDate": "2017-11-10", "ResponseCategory": "S", "ResponseNotes": "This Student is to be withdrawn.", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: WellbeingResponses: type: object description: >- A List of WellbeingResponse objects properties: WellbeingResponse: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingResponse' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateWellbeingResponse requestBody: description: CRUD operation on WellbeingResponse content: application/json: schema: type: object properties: WellbeingResponse: $ref: 'jsonSchemaUpdate.yaml#/properties/WellbeingResponse' example: "WellbeingResponse": { "WellbeingResponseRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 877 }, "PublishedDate": "2017-11-01", "StartDate": "2017-11-01", "EndDate": "2017-11-10", "ResponseCategory": "S", "ResponseNotes": "This Student is to be withdrawn.", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: WellbeingResponse: $ref: 'jsonSchemaUpdate.yaml#/properties/WellbeingResponse' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: WellbeingResponse: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingResponse' example: "WellbeingResponse": { "WellbeingResponseRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 877 }, "PublishedDate": "2017-11-01", "StartDate": "2017-11-01", "EndDate": "2017-11-10", "ResponseCategory": "S", "ResponseNotes": "This Student is to be withdrawn.", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: WellbeingResponse: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingResponse' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /WellbeingAppeals: get: tags: - "WellbeingAppeal" summary: Default operation to get a list of all available WellbeingAppeals 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: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingAppeal' example: "WellbeingAppeals": { "WellbeingAppeal": [{ "WellbeingAppealRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 9961 }, "WellbeingResponse": { "RefId": "bc385746-359d-7510-1a8c-36432a901a36" }, "AppealStatus": "SU", "RegisteredDate": "2017-11-01", "AppealNotes": "This Appeal was successful.", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: WellbeingAppeals: type: object description: >- A List of WellbeingAppeal objects properties: WellbeingAppeal: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingAppeal' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateWellbeingAppeal requestBody: description: CRUD operation on WellbeingAppeal content: application/json: schema: type: object properties: WellbeingAppeal: $ref: 'jsonSchemaUpdate.yaml#/properties/WellbeingAppeal' example: "WellbeingAppeal": { "WellbeingAppealRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 9961 }, "WellbeingResponse": { "RefId": "bc385746-359d-7510-1a8c-36432a901a36" }, "AppealStatus": "SU", "RegisteredDate": "2017-11-01", "AppealNotes": "This Appeal was successful.", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: WellbeingAppeal: $ref: 'jsonSchemaUpdate.yaml#/properties/WellbeingAppeal' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: WellbeingAppeal: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingAppeal' example: "WellbeingAppeal": { "WellbeingAppealRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 9961 }, "WellbeingResponse": { "RefId": "bc385746-359d-7510-1a8c-36432a901a36" }, "AppealStatus": "SU", "RegisteredDate": "2017-11-01", "AppealNotes": "This Appeal was successful.", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: WellbeingAppeal: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingAppeal' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentActivityParticipations: get: tags: - "StudentActivityParticipation" summary: Default operation to get a list of all available StudentActivityParticipations 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentActivityParticipation' example: "StudentActivityParticipations": { "StudentActivityParticipation": [{ "StudentActivityParticipationRefId": "9ecc9683-0e02-406f-926c-1c4d3542d122", "Student": { "RefId": "646c5d4a-c829-4886-a02b-971695c7bc06" }, "Provider": { "RefId": 2342 }, "ActivityGroup": "SPO", "ActivityType": "CRI", "ActivityName": "First XI", "ParticipationComment": "First year of participation", "StartDate": "2008-09-01", "Role": "Team Member", "RecognitionList": { "Recognition": ["Player of the Day"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentActivityParticipations: type: object description: >- A List of StudentActivityParticipation objects properties: StudentActivityParticipation: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentActivityParticipation' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentActivityParticipation requestBody: description: CRUD operation on StudentActivityParticipation content: application/json: schema: type: object properties: StudentActivityParticipation: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentActivityParticipation' example: "StudentActivityParticipation": { "StudentActivityParticipationRefId": "9ecc9683-0e02-406f-926c-1c4d3542d122", "Student": { "RefId": "646c5d4a-c829-4886-a02b-971695c7bc06" }, "Provider": { "RefId": 2342 }, "ActivityGroup": "SPO", "ActivityType": "CRI", "ActivityName": "First XI", "ParticipationComment": "First year of participation", "StartDate": "2008-09-01", "Role": "Team Member", "RecognitionList": { "Recognition": ["Player of the Day"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentActivityParticipation: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentActivityParticipation' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentActivityParticipation: $ref: 'jsonSchemaCreate.yaml#/properties/StudentActivityParticipation' example: "StudentActivityParticipation": { "StudentActivityParticipationRefId": "9ecc9683-0e02-406f-926c-1c4d3542d122", "Student": { "RefId": "646c5d4a-c829-4886-a02b-971695c7bc06" }, "Provider": { "RefId": 2342 }, "ActivityGroup": "SPO", "ActivityType": "CRI", "ActivityName": "First XI", "ParticipationComment": "First year of participation", "StartDate": "2008-09-01", "Role": "Team Member", "RecognitionList": { "Recognition": ["Player of the Day"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentActivityParticipation: $ref: 'jsonSchemaCreate.yaml#/properties/StudentActivityParticipation' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentPhysicalRestraints: get: tags: - "StudentPhysicalRestraint" summary: Default operation to get a list of all available StudentPhysicalRestraints 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentPhysicalRestraint' application/xml: schema: type: object properties: StudentPhysicalRestraints: type: object description: >- A List of StudentPhysicalRestraint objects properties: StudentPhysicalRestraint: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentPhysicalRestraint' post: tags: - "StudentPhysicalRestraint" summary: Default operation to create a single StudentPhysicalRestraint operationId: createStudentPhysicalRestraint requestBody: description: CRUD operation on StudentPhysicalRestraint content: application/json: schema: type: object properties: StudentPhysicalRestraint: $ref: 'jsonSchemaCreate.yaml#/properties/StudentPhysicalRestraint' application/xml: schema: type: object properties: StudentPhysicalRestraint: $ref: 'jsonSchemaCreate.yaml#/properties/StudentPhysicalRestraint' # ///////////////////////////////////////////////////////////// /StudentPhysicalRestraints/{StudentPhysicalRestraintRefId}: put: tags: - "StudentPhysicalRestraint" summary: Default operation to update a single StudentPhysicalRestraint parameters: - name: StudentPhysicalRestraintRefId in: path description: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentPhysicalRestraint requestBody: description: CRUD operation on StudentPhysicalRestraint content: application/json: schema: type: object properties: StudentPhysicalRestraint: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentPhysicalRestraint' application/xml: schema: type: object properties: StudentPhysicalRestraint: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentPhysicalRestraint' get: tags: - "StudentPhysicalRestraint" summary: Default operation to get a single StudentPhysicalRestraint parameters: - name: StudentPhysicalRestraintRefId in: path description: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentPhysicalRestraint: $ref: 'jsonSchemaCreate.yaml#/properties/StudentPhysicalRestraint' application/xml: schema: type: object properties: StudentPhysicalRestraint: $ref: 'jsonSchemaCreate.yaml#/properties/StudentPhysicalRestraint' delete: tags: - "StudentPhysicalRestraint" summary: Default operation to delete a single StudentPhysicalRestraint parameters: - name: StudentPhysicalRestraintRefId in: path description: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentVoices: get: tags: - "StudentVoice" summary: Default operation to get a list of all available StudentVoices 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentVoice' example: "StudentVoices": { "StudentVoice": [{ "StudentVoiceRefId": "7c834ea9-eda1-2090-347f-83297e1c290c", "StudentVoiceLocalId": 2234523, "Student": { "RefId": "5c33548a-1141-40eb-94d3-9267a2258435" }, "Provider": { "RefId": 234 }, "StudentVoiceNote": "Timothy doesn't like talking about setting goals. These goals have been gathered through observation.", "StudentInterestList": { "StudentInterest": [{ "InterestRecordedDate": "2018-11-30", "InterestDescription": "Timothy spends most lunchtimes playing with the piano, or watching others playing music", "InterestName": "Music/Piano", "InterestType": "MUS", "SubjectArea": "MUSP" }] }, "SocialGoalList": { "SocialGoal": [{ "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy would like to have more friends to play with at lunchtime.", "GoalName": "Have more friends" }] }, "AcademicGoalList": { "AcademicGoal": [{ "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy wants to excel at Te Reo Māori", "GoalName": "Excel Te Reo", "SubjectArea": "MAOR" }] }, "CareerGoalList": { "CareerGoal": [{ "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy would like to be a Marine Biologist, or Deep Sea Diver", "GoalName": "Marine Biologist" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentVoices: type: object description: >- A List of StudentVoice objects properties: StudentVoice: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentVoice' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentVoice requestBody: description: CRUD operation on StudentVoice content: application/json: schema: type: object properties: StudentVoice: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentVoice' example: "StudentVoice": { "StudentVoiceRefId": "7c834ea9-eda1-2090-347f-83297e1c290c", "StudentVoiceLocalId": 2234523, "Student": { "RefId": "5c33548a-1141-40eb-94d3-9267a2258435" }, "Provider": { "RefId": 234 }, "StudentVoiceNote": "Timothy doesn't like talking about setting goals. These goals have been gathered through observation.", "StudentInterestList": { "StudentInterest": [{ "InterestRecordedDate": "2018-11-30", "InterestDescription": "Timothy spends most lunchtimes playing with the piano, or watching others playing music", "InterestName": "Music/Piano", "InterestType": "MUS", "SubjectArea": "MUSP" }] }, "SocialGoalList": { "SocialGoal": [{ "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy would like to have more friends to play with at lunchtime.", "GoalName": "Have more friends" }] }, "AcademicGoalList": { "AcademicGoal": [{ "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy wants to excel at Te Reo Māori", "GoalName": "Excel Te Reo", "SubjectArea": "MAOR" }] }, "CareerGoalList": { "CareerGoal": [{ "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy would like to be a Marine Biologist, or Deep Sea Diver", "GoalName": "Marine Biologist" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentVoice: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentVoice' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentVoice: $ref: 'jsonSchemaCreate.yaml#/properties/StudentVoice' example: "StudentVoice": { "StudentVoiceRefId": "7c834ea9-eda1-2090-347f-83297e1c290c", "StudentVoiceLocalId": 2234523, "Student": { "RefId": "5c33548a-1141-40eb-94d3-9267a2258435" }, "Provider": { "RefId": 234 }, "StudentVoiceNote": "Timothy doesn't like talking about setting goals. These goals have been gathered through observation.", "StudentInterestList": { "StudentInterest": [{ "InterestRecordedDate": "2018-11-30", "InterestDescription": "Timothy spends most lunchtimes playing with the piano, or watching others playing music", "InterestName": "Music/Piano", "InterestType": "MUS", "SubjectArea": "MUSP" }] }, "SocialGoalList": { "SocialGoal": [{ "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy would like to have more friends to play with at lunchtime.", "GoalName": "Have more friends" }] }, "AcademicGoalList": { "AcademicGoal": [{ "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy wants to excel at Te Reo Māori", "GoalName": "Excel Te Reo", "SubjectArea": "MAOR" }] }, "CareerGoalList": { "CareerGoal": [{ "GoalRecordedDate": "2018-11-30", "GoalDescription": "Timothy would like to be a Marine Biologist, or Deep Sea Diver", "GoalName": "Marine Biologist" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentVoice: $ref: 'jsonSchemaCreate.yaml#/properties/StudentVoice' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentLearningSupports: get: tags: - "StudentLearningSupport" summary: Default operation to get a list of all available StudentLearningSupports responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentLearningSupports: type: object description: >- A List of StudentLearningSupport objects properties: StudentLearningSupport: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentLearningSupport' example: "StudentLearningSupports": { "StudentLearningSupport": [{ "StudentLearningSupportRefId": "461b63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "ca285746-359d-7510-1a8c-36432a901a16" }, "Provider": { "RefId": 744 }, "LearnerStatus": "ACT", "StudentConsentList": { "StudentConsent": [{ "RefId": "461423b4-cfef-4820-8501-e7d1e54555cb" }] }, "DyslexiaScreeningTool": "Y", "OtherScreening": "N", "AdolescentHealthScreening": "N", "NonAttendance": "Y", "NewToNewZealand": "N", "NumberOfSchoolChanges": "Y", "B4SchoolCheck": "Y", "OtherFamilyContext": "N", "StudentVoiceList": { "StudentVoice": [{ "RefId": "461423b4-cfef-4820-8345-e7d1e54555cb" }, { "RefId": "461423b4-bbef-4820-8345-e7d1e54555cb" }] }, "SupportNeedList": { "SupportNeed": [{ "Need": { "RefId": "461423b4-bbef-4820-8345-e724e54555cb", "Name": "Literacy" }, "ResponseList": { "Response": [{ "RefId": "461423b4-bbef-4820-8345-e724e5455bbb" }] } }] } }] } application/xml: schema: type: object properties: StudentLearningSupports: type: object description: >- A List of StudentLearningSupport objects properties: StudentLearningSupport: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentLearningSupport' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentLearningSupport requestBody: description: CRUD operation on StudentLearningSupport content: application/json: schema: type: object properties: StudentLearningSupport: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentLearningSupport' example: "StudentLearningSupport": { "StudentLearningSupportRefId": "461b63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "ca285746-359d-7510-1a8c-36432a901a16" }, "Provider": { "RefId": 744 }, "LearnerStatus": "ACT", "StudentConsentList": { "StudentConsent": [{ "RefId": "461423b4-cfef-4820-8501-e7d1e54555cb" }] }, "DyslexiaScreeningTool": "Y", "OtherScreening": "N", "AdolescentHealthScreening": "N", "NonAttendance": "Y", "NewToNewZealand": "N", "NumberOfSchoolChanges": "Y", "B4SchoolCheck": "Y", "OtherFamilyContext": "N", "StudentVoiceList": { "StudentVoice": [{ "RefId": "461423b4-cfef-4820-8345-e7d1e54555cb" }, { "RefId": "461423b4-bbef-4820-8345-e7d1e54555cb" }] }, "SupportNeedList": { "SupportNeed": [{ "Need": { "RefId": "461423b4-bbef-4820-8345-e724e54555cb", "Name": "Literacy" }, "ResponseList": { "Response": [{ "RefId": "461423b4-bbef-4820-8345-e724e5455bbb" }] } }] } } application/xml: schema: type: object properties: StudentLearningSupport: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentLearningSupport' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentLearningSupport: $ref: 'jsonSchemaCreate.yaml#/properties/StudentLearningSupport' example: "StudentLearningSupport": { "StudentLearningSupportRefId": "461b63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "ca285746-359d-7510-1a8c-36432a901a16" }, "Provider": { "RefId": 744 }, "LearnerStatus": "ACT", "StudentConsentList": { "StudentConsent": [{ "RefId": "461423b4-cfef-4820-8501-e7d1e54555cb" }] }, "DyslexiaScreeningTool": "Y", "OtherScreening": "N", "AdolescentHealthScreening": "N", "NonAttendance": "Y", "NewToNewZealand": "N", "NumberOfSchoolChanges": "Y", "B4SchoolCheck": "Y", "OtherFamilyContext": "N", "StudentVoiceList": { "StudentVoice": [{ "RefId": "461423b4-cfef-4820-8345-e7d1e54555cb" }, { "RefId": "461423b4-bbef-4820-8345-e7d1e54555cb" }] }, "SupportNeedList": { "SupportNeed": [{ "Need": { "RefId": "461423b4-bbef-4820-8345-e724e54555cb", "Name": "Literacy" }, "ResponseList": { "Response": [{ "RefId": "461423b4-bbef-4820-8345-e724e5455bbb" }] } }] } } application/xml: schema: type: object properties: StudentLearningSupport: $ref: 'jsonSchemaCreate.yaml#/properties/StudentLearningSupport' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentLearningSupportResponses: get: tags: - "StudentLearningSupportResponse" summary: Default operation to get a list of all available StudentLearningSupportResponses responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentLearningSupportResponses: type: object description: >- A List of StudentLearningSupportResponse objects properties: StudentLearningSupportResponse: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentLearningSupportResponse' example: "StudentLearningSupportResponses": { "StudentLearningSupportResponse": [{ "StudentLearningSupportResponseRefId": "461b63b4-cfef-4820-8501-e7dbbb4555cb", "Student": { "RefId": "8631e737-c9db-4e6c-804d-a78c65f98f67" }, "LearningSupportNeed": { "RefId": "ca222226-359d-7510-1a8c-36432a901a16" }, "ResponseType": "ADA", "ResponseDetail": "ACU", "ResponseGoals": "The student is confident in their reading ability.", "TierOfResponse": "IND", "InternalResponse": { "ProvidedBy": "TEA", "ProvidedByName": "Jane Doe", "Status": "MON", "FundedBy": "BOA" }, "ReviewList": { "Review": [{ "Reviewer": { "RefId": "ca2bbb26-359d-2480-1a8c-36432a901a16" }, "ReviewDate": "2019-11-11", "ReviewComments": "The student is progressing well. Ability to identify words is increasing and is gaining confidence in trying to sound out words they do not recognise.", "NextReviewDate": "2010-01-21" }] }, "AttachmentList": { "Document": [{ "RefId": "ca2bbb26-359d-3480-1a8c-36432a901a16" }] }, "RecordAudit": { "CreatedDateTime": "2019-10-28T06:30:57", "CreatedBy": { "RefId": "ca222226-359d-2480-1a8c-36432a901a16" } } }] } application/xml: schema: type: object properties: StudentLearningSupportResponses: type: object description: >- A List of StudentLearningSupportResponse objects properties: StudentLearningSupportResponse: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentLearningSupportResponse' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentLearningSupportResponse requestBody: description: CRUD operation on StudentLearningSupportResponse content: application/json: schema: type: object properties: StudentLearningSupportResponse: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentLearningSupportResponse' example: "StudentLearningSupportResponse": { "StudentLearningSupportResponseRefId": "461b63b4-cfef-4820-8501-e7dbbb4555cb", "Student": { "RefId": "8631e737-c9db-4e6c-804d-a78c65f98f67" }, "LearningSupportNeed": { "RefId": "ca222226-359d-7510-1a8c-36432a901a16" }, "ResponseType": "ADA", "ResponseDetail": "ACU", "ResponseGoals": "The student is confident in their reading ability.", "TierOfResponse": "IND", "InternalResponse": { "ProvidedBy": "TEA", "ProvidedByName": "Jane Doe", "Status": "MON", "FundedBy": "BOA" }, "ReviewList": { "Review": [{ "Reviewer": { "RefId": "ca2bbb26-359d-2480-1a8c-36432a901a16" }, "ReviewDate": "2019-11-11", "ReviewComments": "The student is progressing well. Ability to identify words is increasing and is gaining confidence in trying to sound out words they do not recognise.", "NextReviewDate": "2010-01-21" }] }, "AttachmentList": { "Document": [{ "RefId": "ca2bbb26-359d-3480-1a8c-36432a901a16" }] }, "RecordAudit": { "CreatedDateTime": "2019-10-28T06:30:57", "CreatedBy": { "RefId": "ca222226-359d-2480-1a8c-36432a901a16" } } } application/xml: schema: type: object properties: StudentLearningSupportResponse: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentLearningSupportResponse' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentLearningSupportResponse: $ref: 'jsonSchemaCreate.yaml#/properties/StudentLearningSupportResponse' example: "StudentLearningSupportResponse": { "StudentLearningSupportResponseRefId": "461b63b4-cfef-4820-8501-e7dbbb4555cb", "Student": { "RefId": "8631e737-c9db-4e6c-804d-a78c65f98f67" }, "LearningSupportNeed": { "RefId": "ca222226-359d-7510-1a8c-36432a901a16" }, "ResponseType": "ADA", "ResponseDetail": "ACU", "ResponseGoals": "The student is confident in their reading ability.", "TierOfResponse": "IND", "InternalResponse": { "ProvidedBy": "TEA", "ProvidedByName": "Jane Doe", "Status": "MON", "FundedBy": "BOA" }, "ReviewList": { "Review": [{ "Reviewer": { "RefId": "ca2bbb26-359d-2480-1a8c-36432a901a16" }, "ReviewDate": "2019-11-11", "ReviewComments": "The student is progressing well. Ability to identify words is increasing and is gaining confidence in trying to sound out words they do not recognise.", "NextReviewDate": "2010-01-21" }] }, "AttachmentList": { "Document": [{ "RefId": "ca2bbb26-359d-3480-1a8c-36432a901a16" }] }, "RecordAudit": { "CreatedDateTime": "2019-10-28T06:30:57", "CreatedBy": { "RefId": "ca222226-359d-2480-1a8c-36432a901a16" } } } application/xml: schema: type: object properties: StudentLearningSupportResponse: $ref: 'jsonSchemaCreate.yaml#/properties/StudentLearningSupportResponse' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /AssessmentTasks: get: tags: - "AssessmentTask" summary: Default operation to get a list of all available AssessmentTasks 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: $ref: 'jsonSchemaCreate.yaml#/properties/AssessmentTask' example: "AssessmentTasks": { "AssessmentTask": [{ "AssessmentTaskRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "AssessmentName": "NZ History Classroom Test", "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 9962, "ProviderRole": "PRO" }] }, "TeachingGroup": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39" }, "StaffInvolvedList": { "StaffInvolved": [{ "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "StaffRole": "ASS" }] }, "Description": "Pop Quiz", "PointsPossible": 100, "DueDate": "2018-11-25", "Weight": 1.0, "DetailedDescriptionURL": "http://www.assignmentinfo.com/assignment1.pdf", "AssessmentType": "INT", "AssessmentMethodology": "P", "EvaluationType": "F", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: AssessmentTasks: type: object description: >- A List of AssessmentTask objects properties: AssessmentTask: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/AssessmentTask' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateAssessmentTask requestBody: description: CRUD operation on AssessmentTask content: application/json: schema: type: object properties: AssessmentTask: $ref: 'jsonSchemaUpdate.yaml#/properties/AssessmentTask' example: "AssessmentTask": { "AssessmentTaskRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "AssessmentName": "NZ History Classroom Test", "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 9962, "ProviderRole": "PRO" }] }, "TeachingGroup": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39" }, "StaffInvolvedList": { "StaffInvolved": [{ "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "StaffRole": "ASS" }] }, "Description": "Pop Quiz", "PointsPossible": 100, "DueDate": "2018-11-25", "Weight": 1.0, "DetailedDescriptionURL": "http://www.assignmentinfo.com/assignment1.pdf", "AssessmentType": "INT", "AssessmentMethodology": "P", "EvaluationType": "F", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: AssessmentTask: $ref: 'jsonSchemaUpdate.yaml#/properties/AssessmentTask' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: AssessmentTask: $ref: 'jsonSchemaCreate.yaml#/properties/AssessmentTask' example: "AssessmentTask": { "AssessmentTaskRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "AssessmentName": "NZ History Classroom Test", "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 9962, "ProviderRole": "PRO" }] }, "TeachingGroup": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39" }, "StaffInvolvedList": { "StaffInvolved": [{ "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "StaffRole": "ASS" }] }, "Description": "Pop Quiz", "PointsPossible": 100, "DueDate": "2018-11-25", "Weight": 1.0, "DetailedDescriptionURL": "http://www.assignmentinfo.com/assignment1.pdf", "AssessmentType": "INT", "AssessmentMethodology": "P", "EvaluationType": "F", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: AssessmentTask: $ref: 'jsonSchemaCreate.yaml#/properties/AssessmentTask' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentAssessmentTaskResults: get: tags: - "StudentAssessmentTaskResult" summary: Default operation to get a list of all available StudentAssessmentTaskResults 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTaskResult' example: "StudentAssessmentTaskResults": { "StudentAssessmentTaskResult": [{ "StudentAssessmentTaskResultRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "a75a0010-1a8c-301d-02e3-a05b359d0a00" }, "AssessmentType": "INT", "AssessmentMethodology": "P", "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 9953, "ProviderRole": "PRO" }] }, "SubjectAreaList": { "SubjectArea": ["MATH"] }, "Curriculum": "NZC", "AssessmentToolUsed": "PATCOMP", "EvaluationType": "F", "DateTimeAssessed": "2018-11-21T15:34:22", "ResultScoreList": { "ResultScore": [{ "ScoreType": "FIN", "ScoreMetric": "RAW", "ScoreValue": "25" }, { "ScoreType": "FIN", "ScoreMetric": "SCA", "ScoreValue": "38.5" }, { "ScoreType": "FIN", "ScoreMetric": "MAR", "ScoreValue": "5.0" }, { "ScoreType": "FIN", "ScoreMetric": "YEA", "ScoreValue": "4" }, { "ScoreType": "FIN", "ScoreMetric": "STA", "ScoreValue": "6" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentAssessmentTaskResults: type: object description: >- A List of StudentAssessmentTaskResult objects properties: StudentAssessmentTaskResult: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTaskResult' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentAssessmentTaskResult requestBody: description: CRUD operation on StudentAssessmentTaskResult content: application/json: schema: type: object properties: StudentAssessmentTaskResult: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAssessmentTaskResult' example: "StudentAssessmentTaskResult": { "StudentAssessmentTaskResultRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "a75a0010-1a8c-301d-02e3-a05b359d0a00" }, "AssessmentType": "INT", "AssessmentMethodology": "P", "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 9953, "ProviderRole": "PRO" }] }, "SubjectAreaList": { "SubjectArea": ["MATH"] }, "Curriculum": "NZC", "AssessmentToolUsed": "PATCOMP", "EvaluationType": "F", "DateTimeAssessed": "2018-11-21T15:34:22", "ResultScoreList": { "ResultScore": [{ "ScoreType": "FIN", "ScoreMetric": "RAW", "ScoreValue": "25" }, { "ScoreType": "FIN", "ScoreMetric": "SCA", "ScoreValue": "38.5" }, { "ScoreType": "FIN", "ScoreMetric": "MAR", "ScoreValue": "5.0" }, { "ScoreType": "FIN", "ScoreMetric": "YEA", "ScoreValue": "4" }, { "ScoreType": "FIN", "ScoreMetric": "STA", "ScoreValue": "6" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentAssessmentTaskResult: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAssessmentTaskResult' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentAssessmentTaskResult: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTaskResult' example: "StudentAssessmentTaskResult": { "StudentAssessmentTaskResultRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "a75a0010-1a8c-301d-02e3-a05b359d0a00" }, "AssessmentType": "INT", "AssessmentMethodology": "P", "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 9953, "ProviderRole": "PRO" }] }, "SubjectAreaList": { "SubjectArea": ["MATH"] }, "Curriculum": "NZC", "AssessmentToolUsed": "PATCOMP", "EvaluationType": "F", "DateTimeAssessed": "2018-11-21T15:34:22", "ResultScoreList": { "ResultScore": [{ "ScoreType": "FIN", "ScoreMetric": "RAW", "ScoreValue": "25" }, { "ScoreType": "FIN", "ScoreMetric": "SCA", "ScoreValue": "38.5" }, { "ScoreType": "FIN", "ScoreMetric": "MAR", "ScoreValue": "5.0" }, { "ScoreType": "FIN", "ScoreMetric": "YEA", "ScoreValue": "4" }, { "ScoreType": "FIN", "ScoreMetric": "STA", "ScoreValue": "6" }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentAssessmentTaskResult: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTaskResult' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentAssessmentTaskRegistrations: get: tags: - "StudentAssessmentTaskRegistration" summary: Default operation to get a list of all available StudentAssessmentTaskRegistrations 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTaskRegistration' example: "StudentAssessmentTaskRegistrations": { "StudentAssessmentTaskRegistration": [{ "StudentAssessmentTaskRegistrationRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 9772, "ProviderRole": "ASR" }, { "RefId": 377, "ProviderRole": "PRO" }] }, "Student": { "LocalId": "851039-HP", "Name": "Harry Potter", "NationalStudentNumber": 23423421 }, "StaffMember": { "RefId": "c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb" }, "AssessmentTask": { "RefId": "cedd0ce7-f555-482b-887b-d130e5c40d02" }, "SpecialAssessmentConditionList": { "SpecialAssessmentCondition": ["COM", "EXT", "SEP"] }, "SubjectArea": "PHYS", "YearLevel": 12, "DateRegistered": "2018-03-30", "AssessmentYear": 2018, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentAssessmentTaskRegistrations: type: object description: >- A List of StudentAssessmentTaskRegistration objects properties: StudentAssessmentTaskRegistration: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTaskRegistration' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentAssessmentTaskRegistration requestBody: description: CRUD operation on StudentAssessmentTaskRegistration content: application/json: schema: type: object properties: StudentAssessmentTaskRegistration: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAssessmentTaskRegistration' example: "StudentAssessmentTaskRegistration": { "StudentAssessmentTaskRegistrationRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 9772, "ProviderRole": "ASR" }, { "RefId": 377, "ProviderRole": "PRO" }] }, "Student": { "LocalId": "851039-HP", "Name": "Harry Potter", "NationalStudentNumber": 23423421 }, "StaffMember": { "RefId": "c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb" }, "AssessmentTask": { "RefId": "cedd0ce7-f555-482b-887b-d130e5c40d02" }, "SpecialAssessmentConditionList": { "SpecialAssessmentCondition": ["COM", "EXT", "SEP"] }, "SubjectArea": "PHYS", "YearLevel": 12, "DateRegistered": "2018-03-30", "AssessmentYear": 2018, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentAssessmentTaskRegistration: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAssessmentTaskRegistration' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentAssessmentTaskRegistration: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTaskRegistration' example: "StudentAssessmentTaskRegistration": { "StudentAssessmentTaskRegistrationRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 9772, "ProviderRole": "ASR" }, { "RefId": 377, "ProviderRole": "PRO" }] }, "Student": { "LocalId": "851039-HP", "Name": "Harry Potter", "NationalStudentNumber": 23423421 }, "StaffMember": { "RefId": "c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb" }, "AssessmentTask": { "RefId": "cedd0ce7-f555-482b-887b-d130e5c40d02" }, "SpecialAssessmentConditionList": { "SpecialAssessmentCondition": ["COM", "EXT", "SEP"] }, "SubjectArea": "PHYS", "YearLevel": 12, "DateRegistered": "2018-03-30", "AssessmentYear": 2018, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentAssessmentTaskRegistration: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTaskRegistration' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentAssessmentTasks: get: tags: - "StudentAssessmentTask" summary: Default operation to get a list of all available StudentAssessmentTasks 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTask' example: "StudentAssessmentTasks": { "StudentAssessmentTask": [{ "StudentAssessmentTaskRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "LocalId": "850139-HP", "Name": "Harry Potter", "NationalStudentNumber": 23423421 }, "AssessmentTask": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39" }, "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 762, "ProviderRole": "LOC" }, { "RefId": 9962, "ProviderRole": "PRO" }] }, "StaffInvolvedList": { "StaffInvolved": [{ "RefId": "228a2cbe-93c4-46ba-91fa-b3ae689eb437", "Name": "Prof. McGonnegal", "StaffRole": "INV" }] }, "DateTimeAssessmentScheduled": "2018-11-25T09:00:00+12:00", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentAssessmentTasks: type: object description: >- A List of StudentAssessmentTask objects properties: StudentAssessmentTask: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTask' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentAssessmentTask requestBody: description: CRUD operation on StudentAssessmentTask content: application/json: schema: type: object properties: StudentAssessmentTask: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAssessmentTask' example: "StudentAssessmentTask": { "StudentAssessmentTaskRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "LocalId": "850139-HP", "Name": "Harry Potter", "NationalStudentNumber": 23423421 }, "AssessmentTask": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39" }, "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 762, "ProviderRole": "LOC" }, { "RefId": 9962, "ProviderRole": "PRO" }] }, "StaffInvolvedList": { "StaffInvolved": [{ "RefId": "228a2cbe-93c4-46ba-91fa-b3ae689eb437", "Name": "Prof. McGonnegal", "StaffRole": "INV" }] }, "DateTimeAssessmentScheduled": "2018-11-25T09:00:00+12:00", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentAssessmentTask: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAssessmentTask' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentAssessmentTask: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTask' example: "StudentAssessmentTask": { "StudentAssessmentTaskRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "Student": { "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "LocalId": "850139-HP", "Name": "Harry Potter", "NationalStudentNumber": 23423421 }, "AssessmentTask": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39" }, "ProviderInvolvedList": { "ProviderInvolved": [{ "RefId": 762, "ProviderRole": "LOC" }, { "RefId": 9962, "ProviderRole": "PRO" }] }, "StaffInvolvedList": { "StaffInvolved": [{ "RefId": "228a2cbe-93c4-46ba-91fa-b3ae689eb437", "Name": "Prof. McGonnegal", "StaffRole": "INV" }] }, "DateTimeAssessmentScheduled": "2018-11-25T09:00:00+12:00", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentAssessmentTask: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAssessmentTask' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentAttainments: get: tags: - "StudentAttainment" summary: Default operation to get a list of all available StudentAttainments 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttainment' example: "StudentAttainments": { "StudentAttainment": [{ "StudentAttainmentRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "GrantingProvider": { "RefId": 762 }, "Attainment": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39", "Name": "NCEA Level 2 Chemistry - Endorsed with merit", "ObjectType": "Credential" }, "Student": { "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "LocalId": "HP85-1039", "Name": "Harry Potter", "NationalStudentNumber": 23423421 }, "DateAttained": "2018-07-25", "JustificationList": { "Justification": [{ "RefId": "2752a16b-b62a-4973-9d44-23e13e1c037b", "LocalId": "91165-v2", "Name": "Demonstrate understanding of the properties of selected organic compounds", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "EXT", "Result": "Achieved", "Date": "2016-06-28", "CreditValue": 4 }, { "RefId": "eca0da5d-94af-4223-aaa6-7c0083006efd", "LocalId": "91166-v2", "Name": "Demonstrate understanding of chemical reactivity", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "INT", "Result": "Achieved with merit", "Date": "2016-06-01", "CreditValue": 3 }, { "RefId": "12f4761d-5e97-4e12-804e-e16d882c86c7", "LocalId": "91167-v2", "Name": "Demonstrate understanding of oxidation-reduction", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "EXT", "Result": "Achieved", "Date": "2016-06-28", "CreditValue": 3 }] }, "SubjectAreaList": { "SubjectArea": ["CHEM"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentAttainments: type: object description: >- A List of StudentAttainment objects properties: StudentAttainment: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttainment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentAttainment requestBody: description: CRUD operation on StudentAttainment content: application/json: schema: type: object properties: StudentAttainment: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAttainment' example: "StudentAttainment": { "StudentAttainmentRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "GrantingProvider": { "RefId": 762 }, "Attainment": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39", "Name": "NCEA Level 2 Chemistry - Endorsed with merit", "ObjectType": "Credential" }, "Student": { "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "LocalId": "HP85-1039", "Name": "Harry Potter", "NationalStudentNumber": 23423421 }, "DateAttained": "2018-07-25", "JustificationList": { "Justification": [{ "RefId": "2752a16b-b62a-4973-9d44-23e13e1c037b", "LocalId": "91165-v2", "Name": "Demonstrate understanding of the properties of selected organic compounds", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "EXT", "Result": "Achieved", "Date": "2016-06-28", "CreditValue": 4 }, { "RefId": "eca0da5d-94af-4223-aaa6-7c0083006efd", "LocalId": "91166-v2", "Name": "Demonstrate understanding of chemical reactivity", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "INT", "Result": "Achieved with merit", "Date": "2016-06-01", "CreditValue": 3 }, { "RefId": "12f4761d-5e97-4e12-804e-e16d882c86c7", "LocalId": "91167-v2", "Name": "Demonstrate understanding of oxidation-reduction", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "EXT", "Result": "Achieved", "Date": "2016-06-28", "CreditValue": 3 }] }, "SubjectAreaList": { "SubjectArea": ["CHEM"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentAttainment: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAttainment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentAttainment: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttainment' example: "StudentAttainment": { "StudentAttainmentRefId": "359d7510-1ad0-a9d7-a8c3-dad0a85103a2", "GrantingProvider": { "RefId": 762 }, "Attainment": { "RefId": "d0a0a27a-d0a8-510a-d9d7-5101a8c3da39", "Name": "NCEA Level 2 Chemistry - Endorsed with merit", "ObjectType": "Credential" }, "Student": { "RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435", "LocalId": "HP85-1039", "Name": "Harry Potter", "NationalStudentNumber": 23423421 }, "DateAttained": "2018-07-25", "JustificationList": { "Justification": [{ "RefId": "2752a16b-b62a-4973-9d44-23e13e1c037b", "LocalId": "91165-v2", "Name": "Demonstrate understanding of the properties of selected organic compounds", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "EXT", "Result": "Achieved", "Date": "2016-06-28", "CreditValue": 4 }, { "RefId": "eca0da5d-94af-4223-aaa6-7c0083006efd", "LocalId": "91166-v2", "Name": "Demonstrate understanding of chemical reactivity", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "INT", "Result": "Achieved with merit", "Date": "2016-06-01", "CreditValue": 3 }, { "RefId": "12f4761d-5e97-4e12-804e-e16d882c86c7", "LocalId": "91167-v2", "Name": "Demonstrate understanding of oxidation-reduction", "ObjectType": "StudentAssessmentTaskResult", "AssessmentType": "EXT", "Result": "Achieved", "Date": "2016-06-28", "CreditValue": 3 }] }, "SubjectAreaList": { "SubjectArea": ["CHEM"] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentAttainment: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttainment' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentCurriculumProgressReports: get: tags: - "StudentCurriculumProgressReport" summary: Default operation to get a list of all available StudentCurriculumProgressReports 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: $ref: 'jsonSchemaCreate.yaml#/properties/StudentCurriculumProgressReport' example: "StudentCurriculumProgressReports": { "StudentCurriculumProgressReport": [{ "StudentCurriculumProgressReportRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "ca285746-359d-7510-1a8c-36432a901a16" }, "Provider": { "RefId": 9961 }, "TeachingGroup": { "RefId": "4f6dce25-cca6-49ef-8be4-675e2cfce8b8", "LocalId": "HM8P", "Name": "Year 8 Hard Materials, Pinehurst School" }, "AuthorList": { "Author": [{ "RefId": "1b6fabed-2af9-4395-b48c-f46c8edb1b78", "LocalId": "SMcG", "Name": "Steve McGannaway" }] }, "TimeFrame": "TRM", "TechnologyClassList": { "TechnologyClass": [{ "Class": "HM", "BehaviourComment": "Excellent", "EffortComment": "Not particularly interested, attention wanders", "StrandList": { "Strand": [{ "LearningStrand": "TP", "AchievementObjectiveList": { "AchievementObjective": [{ "AchievementObjective": "BD", "CurriculumLevel": 2, "ProgressLevel": "B", "AchievementObjectiveDesc": "Brief Development in hard materials", "OverallStudentEffortNote": "Not particularly interested, attention wanders", "PracticalAbilityDesc": "Beginner", "PracticalAbilityProgressNote": "Struggles with the planning required" }] } }] } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } }] } application/xml: schema: type: object properties: StudentCurriculumProgressReports: type: object description: >- A List of StudentCurriculumProgressReport objects properties: StudentCurriculumProgressReport: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentCurriculumProgressReport' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string operationId: updateStudentCurriculumProgressReport requestBody: description: CRUD operation on StudentCurriculumProgressReport content: application/json: schema: type: object properties: StudentCurriculumProgressReport: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentCurriculumProgressReport' example: "StudentCurriculumProgressReport": { "StudentCurriculumProgressReportRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "ca285746-359d-7510-1a8c-36432a901a16" }, "Provider": { "RefId": 9961 }, "TeachingGroup": { "RefId": "4f6dce25-cca6-49ef-8be4-675e2cfce8b8", "LocalId": "HM8P", "Name": "Year 8 Hard Materials, Pinehurst School" }, "AuthorList": { "Author": [{ "RefId": "1b6fabed-2af9-4395-b48c-f46c8edb1b78", "LocalId": "SMcG", "Name": "Steve McGannaway" }] }, "TimeFrame": "TRM", "TechnologyClassList": { "TechnologyClass": [{ "Class": "HM", "BehaviourComment": "Excellent", "EffortComment": "Not particularly interested, attention wanders", "StrandList": { "Strand": [{ "LearningStrand": "TP", "AchievementObjectiveList": { "AchievementObjective": [{ "AchievementObjective": "BD", "CurriculumLevel": 2, "ProgressLevel": "B", "AchievementObjectiveDesc": "Brief Development in hard materials", "OverallStudentEffortNote": "Not particularly interested, attention wanders", "PracticalAbilityDesc": "Beginner", "PracticalAbilityProgressNote": "Struggles with the planning required" }] } }] } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentCurriculumProgressReport: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentCurriculumProgressReport' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentCurriculumProgressReport: $ref: 'jsonSchemaCreate.yaml#/properties/StudentCurriculumProgressReport' example: "StudentCurriculumProgressReport": { "StudentCurriculumProgressReportRefId": "2ffb63b4-cfef-4820-8501-e7d1e54555cb", "Student": { "RefId": "ca285746-359d-7510-1a8c-36432a901a16" }, "Provider": { "RefId": 9961 }, "TeachingGroup": { "RefId": "4f6dce25-cca6-49ef-8be4-675e2cfce8b8", "LocalId": "HM8P", "Name": "Year 8 Hard Materials, Pinehurst School" }, "AuthorList": { "Author": [{ "RefId": "1b6fabed-2af9-4395-b48c-f46c8edb1b78", "LocalId": "SMcG", "Name": "Steve McGannaway" }] }, "TimeFrame": "TRM", "TechnologyClassList": { "TechnologyClass": [{ "Class": "HM", "BehaviourComment": "Excellent", "EffortComment": "Not particularly interested, attention wanders", "StrandList": { "Strand": [{ "LearningStrand": "TP", "AchievementObjectiveList": { "AchievementObjective": [{ "AchievementObjective": "BD", "CurriculumLevel": 2, "ProgressLevel": "B", "AchievementObjectiveDesc": "Brief Development in hard materials", "OverallStudentEffortNote": "Not particularly interested, attention wanders", "PracticalAbilityDesc": "Beginner", "PracticalAbilityProgressNote": "Struggles with the planning required" }] } }] } }] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44fb63b4-cfef-4820-8501-e7d1e54555cb", "Name": "Bobby Test" } } } application/xml: schema: type: object properties: StudentCurriculumProgressReport: $ref: 'jsonSchemaCreate.yaml#/properties/StudentCurriculumProgressReport' example: >-The universally unique identifier for the data object record that is used across systems.
required: true schema: type: string responses: '200': description: successful operation