openapi: 3.0.2 info: version: 3.0 title: "SIF NZ derived API" description: >- Systems Interoperability Framework™ SIF Implementation Specification (New Zealand) 3.0

Sample OpenAPI specification, (although somewhat incomplete) derived from SIF locale data model A complete specification requires:

host: "api.terito.education.govt.nz" basePath: "v3" # ///////////////////////////////////////////////////////////// x-tagGroups: - name: "Provider" tags: - "ProviderOverview" - "Provider" - "Organisation" - "ProviderRelationship" - "StaffPersonal" - "StaffAssignment" - "ProviderCourse" - "TeachingGroup" - "AcademicDepartment" - "Schedule" - "ScheduleAcademicDay" - "SchedulePeriod" - "ScheduleTerm" - "ScheduleDate" - "ScheduleEvent" - "BellSchedule" - "ScheduleHoliday" - "TeachingGroupEvent" - "LearningSupportRegisterDirectory" - name: "Student & Whānau" tags: - "StudentWhānauOverview" - "StudentPersonal" - "StudentContactPersonal" - "StudentContactRelationship" - "StudentConsent" - name: "Enrolment" tags: - "EnrolmentOverview" - "StudentProviderEnrolment" - "StudentTeachingGroupEnrolment" - name: "Hauora / Wellbeing" tags: - "HauoraWellbeingOverview" - "StudentConsent" - "WellbeingCharacteristic" - "WellbeingAlert" - "WellbeingEvent" - "WellbeingResponse" - "WellbeingAppeal" - "StudentLearningSupport" - "StudentLearningSupportResponse" - "Document" - "StudentVoice" - "StudentPhysicalRestraint" - name: "Schedule & Attendance" tags: - "ScheduleAttendanceOverview" - "StudentAttendanceTimeList" - "StudentAttendanceSummary" - name: "Aromatawai / Assessment" tags: - "AromatawaiAssessmentOverview" - "StudentAssessmentTaskRegistration" - "AssessmentTask" - "StudentAssessmentTask" - "StudentAssessmentTaskResult" - "StudentAttainment" - "Credential" - "LearningStandard" - "StudentCurriculumProgressReport" # ///////////////////////////////////////////////////////////// tags: - name: "ProviderOverview" x-displayName: "Provider Overview" description: >-

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

Background documentation on the Provider domain is available here

externalDocs: description: "Provider Domain in SIF NZ Data Model" url: "http://specification.sifassociation.org/Implementation/NZ/3.0/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.0/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.0/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.0/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.0/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.0/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: >-

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

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

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

- name: "ScheduleHoliday" description: >-

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

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

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

- name: "ScheduleEvent" description: >-

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

- name: "StudentAttendanceSummary" description: >-

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

- name: "StudentAttendanceTimeList" description: >-

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

- name: "WellbeingAlert" description: >-

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

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

- name: "WellbeingCharacteristic" description: >-

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

- name: "WellbeingEvent" description: >-

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

- name: "WellbeingResponse" description: >-

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

- name: "WellbeingAppeal" description: >-

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

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

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

- name: "StudentVoice" description: >- A record of a student's interests as well as their social, academic and academic goals. - name: "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", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "CommunicationChannelList": { "Channel": [{ "Notes": "Attendance System (Self Service)", "Type": "WEB", "Value": "http://att.hogwarts.school.nz" }, { "Notes": "School Website", "Type": "WEB", "Value": "http://www.hogwarts.school.nz" }] }, "ContactList": { "Contact": [{ "Name": { "FamilyName": "Dumbledore", "GivenName": "Albus", "FullName": "Albus Dumbledore" }, "PositionTitle": "Headmaster", "Role": "PRI", "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }] }, "EmailList": {}, "PhoneNumberList": {} }, { "Name": { "FamilyName": "Hagrid", "GivenName": "Rubeus", "FullName": "Rubeus Hagrid" }, "PositionTitle": "Gamekeeper", "Role": "DIR", "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }] }, "EmailList": {}, "PhoneNumberList": {} }] }, "EducationRegion": "TAIT", "EmailList": { "Email": [{ "Type": "PRIM", "Address": "stuart@gmail.com" }] }, "EntityOpen": "1652-04-01", "LocationList": { "Location": [{ "Description": "Only Campus", "Address": { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough", "PostalCode": "5781" }, "GridLocation": { "Latitude": -41.2814719, "Longitude": 175.3458472 }, "StatisticalAreaList": { "StatisticalArea": [{ "SpatialUnitType": "GE", "Code": "058" }, { "SpatialUnitType": "TA", "Code": "050" }, { "SpatialUnitType": "WA", "Code": "05003" }] } }] }, "Name": "Hogwart's Area School", "PhoneNumberList": { "PhoneNumber": [{ "Notes": "Attendance Office (Automated)", "Usage": "SMS", "Type": "WTE", "Number": "(0274) 300 9991" }, { "Notes": "Attendance Office", "Usage": "INT", "Type": "WTE", "Number": "(04) 300 9992" }, { "Notes": "School Secretary DDI", "Type": "WTE", "Number": "(04) 300 9993" }] }, "RelatedOrganisationList": { "RelatedOrganisation": [{ "RefId": "0951bacf-fc88-4ed6-8113-11a6d6335c07", "LocalId": "99102", "Name": "Tai Tokerau", "ObjectType": "Organisation", "StartDate": "2012-10-31", "Type": "MOE" }, { "RefId": "ac0871d9-6562-4209-ae86-abdb3661842b", "LocalId": "99204", "Name": "Masterton (Whakaoriori) Kāhui Ako", "ObjectType": "Organisation", "StartDate": "2012-04-30", "Type": "COL" }] }, "OperationalStatus": "O", "Type": "21", "ProviderRefId": 448, "Authority": "STATE", "SchoolService": { "CoEdStatus": "COED", "Decile": 5, "NewEntrantPolicyList": { "EnactedPolicy": [{ "EffectiveTo": "2018-12-31", "Policy": "AE" }, { "EffectiveFrom": "2019-01-01", "Policy": "CE" }] }, "DefinitionList": { "Definition": ["SMBS", "KKMA", "SWBF"] }, "SchoolYearList": { "SchoolYear": [{ "YearLevel": "1", "Gender": "C" }, { "YearLevel": "2", "Gender": "C" }, { "YearLevel": "3", "Gender": "C" }, { "YearLevel": "4", "Gender": "C" }, { "YearLevel": "5", "Gender": "C" }, { "YearLevel": "6", "Gender": "C" }, { "YearLevel": "7", "Gender": "C" }, { "YearLevel": "8", "Gender": "C" }, { "YearLevel": "9", "Gender": "F" }, { "YearLevel": "10", "Gender": "F" }, { "YearLevel": "11", "Gender": "F" }, { "YearLevel": "12", "Gender": "F" }, { "YearLevel": "13", "Gender": "F" }] } }, "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: >-
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
Attendance System (Self Service) WEB http://att.hogwarts.school.nz School Website WEB http://www.hogwarts.school.nz Dumbledore Albus Albus Dumbledore Headmaster PRI
TH PHY 533 Hogwart's Way Hogsmead 7733
Hagrid Rubeus Rubeus Hagrid Gamekeeper DIR
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
TAIT PRIM stuart@gmail.com 1652-04-01 Only Campus
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough 5781
-41.2814719 175.3458472 GE 058 TA 050 WA 05003
Hogwart's Area School Attendance Office (Automated) SMS WTE (0274) 300 9991 Attendance Office INT WTE (04) 300 9992 School Secretary DDI WTE (04) 300 9993 0951bacf-fc88-4ed6-8113-11a6d6335c07 99102 Tai Tokerau Organisation 2012-10-31 MOE ac0871d9-6562-4209-ae86-abdb3661842b 99204 Masterton (Whakaoriori) Kāhui Ako Organisation 2012-04-30 COL O 21 448 STATE COED 5 2018-12-31 AE 2019-01-01 CE SMBS KKMA SWBF 1 C 2 C 3 C 4 C 5 C 6 C 7 C 8 C 9 F 10 F 11 F 12 F 13 F 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
post: tags: - "Provider" summary: Default operation to create a single Provider operationId: createProvider requestBody: description: CRUD operation on Provider content: application/json: schema: type: object properties: Provider: $ref: 'jsonSchemaCreate.yaml#/properties/Provider' example: "Provider": { "AddressList": { "Address": [{ "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "CommunicationChannelList": { "Channel": [{ "Notes": "Attendance System (Self Service)", "Type": "WEB", "Value": "http://att.hogwarts.school.nz" }, { "Notes": "School Website", "Type": "WEB", "Value": "http://www.hogwarts.school.nz" }] }, "ContactList": { "Contact": [{ "Name": { "FamilyName": "Dumbledore", "GivenName": "Albus", "FullName": "Albus Dumbledore" }, "PositionTitle": "Headmaster", "Role": "PRI", "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }] }, "EmailList": {}, "PhoneNumberList": {} }, { "Name": { "FamilyName": "Hagrid", "GivenName": "Rubeus", "FullName": "Rubeus Hagrid" }, "PositionTitle": "Gamekeeper", "Role": "DIR", "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }] }, "EmailList": {}, "PhoneNumberList": {} }] }, "EducationRegion": "TAIT", "EmailList": { "Email": [{ "Type": "PRIM", "Address": "stuart@gmail.com" }] }, "EntityOpen": "1652-04-01", "LocationList": { "Location": [{ "Description": "Only Campus", "Address": { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough", "PostalCode": "5781" }, "GridLocation": { "Latitude": -41.2814719, "Longitude": 175.3458472 }, "StatisticalAreaList": { "StatisticalArea": [{ "SpatialUnitType": "GE", "Code": "058" }, { "SpatialUnitType": "TA", "Code": "050" }, { "SpatialUnitType": "WA", "Code": "05003" }] } }] }, "Name": "Hogwart's Area School", "PhoneNumberList": { "PhoneNumber": [{ "Notes": "Attendance Office (Automated)", "Usage": "SMS", "Type": "WTE", "Number": "(0274) 300 9991" }, { "Notes": "Attendance Office", "Usage": "INT", "Type": "WTE", "Number": "(04) 300 9992" }, { "Notes": "School Secretary DDI", "Type": "WTE", "Number": "(04) 300 9993" }] }, "RelatedOrganisationList": { "RelatedOrganisation": [{ "RefId": "0951bacf-fc88-4ed6-8113-11a6d6335c07", "LocalId": "99102", "Name": "Tai Tokerau", "ObjectType": "Organisation", "StartDate": "2012-10-31", "Type": "MOE" }, { "RefId": "ac0871d9-6562-4209-ae86-abdb3661842b", "LocalId": "99204", "Name": "Masterton (Whakaoriori) Kāhui Ako", "ObjectType": "Organisation", "StartDate": "2012-04-30", "Type": "COL" }] }, "OperationalStatus": "O", "Type": "21", "ProviderRefId": 448, "Authority": "STATE", "SchoolService": { "CoEdStatus": "COED", "Decile": 5, "NewEntrantPolicyList": { "EnactedPolicy": [{ "EffectiveTo": "2018-12-31", "Policy": "AE" }, { "EffectiveFrom": "2019-01-01", "Policy": "CE" }] }, "DefinitionList": { "Definition": ["SMBS", "KKMA", "SWBF"] }, "SchoolYearList": { "SchoolYear": [{ "YearLevel": "1", "Gender": "C" }, { "YearLevel": "2", "Gender": "C" }, { "YearLevel": "3", "Gender": "C" }, { "YearLevel": "4", "Gender": "C" }, { "YearLevel": "5", "Gender": "C" }, { "YearLevel": "6", "Gender": "C" }, { "YearLevel": "7", "Gender": "C" }, { "YearLevel": "8", "Gender": "C" }, { "YearLevel": "9", "Gender": "F" }, { "YearLevel": "10", "Gender": "F" }, { "YearLevel": "11", "Gender": "F" }, { "YearLevel": "12", "Gender": "F" }, { "YearLevel": "13", "Gender": "F" }] } }, "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: >-
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
Attendance System (Self Service) WEB http://att.hogwarts.school.nz School Website WEB http://www.hogwarts.school.nz Dumbledore Albus Albus Dumbledore Headmaster PRI
TH PHY 533 Hogwart's Way Hogsmead 7733
Hagrid Rubeus Rubeus Hagrid Gamekeeper DIR
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
TAIT PRIM stuart@gmail.com 1652-04-01 Only Campus
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough 5781
-41.2814719 175.3458472 GE 058 TA 050 WA 05003
Hogwart's Area School Attendance Office (Automated) SMS WTE (0274) 300 9991 Attendance Office INT WTE (04) 300 9992 School Secretary DDI WTE (04) 300 9993 0951bacf-fc88-4ed6-8113-11a6d6335c07 99102 Tai Tokerau Organisation 2012-10-31 MOE ac0871d9-6562-4209-ae86-abdb3661842b 99204 Masterton (Whakaoriori) Kāhui Ako Organisation 2012-04-30 COL O 21 448 STATE COED 5 2018-12-31 AE 2019-01-01 CE SMBS KKMA SWBF 1 C 2 C 3 C 4 C 5 C 6 C 7 C 8 C 9 F 10 F 11 F 12 F 13 F 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
# ///////////////////////////////////////////////////////////// /Providers/{ProviderRefId}: put: tags: - "Provider" summary: Default operation to update a single Provider parameters: - name: ProviderRefId in: path description: >-

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

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", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "CommunicationChannelList": { "Channel": [{ "Notes": "Attendance System (Self Service)", "Type": "WEB", "Value": "http://att.hogwarts.school.nz" }, { "Notes": "School Website", "Type": "WEB", "Value": "http://www.hogwarts.school.nz" }] }, "ContactList": { "Contact": [{ "Name": { "FamilyName": "Dumbledore", "GivenName": "Albus", "FullName": "Albus Dumbledore" }, "PositionTitle": "Headmaster", "Role": "PRI", "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }] }, "EmailList": {}, "PhoneNumberList": {} }, { "Name": { "FamilyName": "Hagrid", "GivenName": "Rubeus", "FullName": "Rubeus Hagrid" }, "PositionTitle": "Gamekeeper", "Role": "DIR", "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }] }, "EmailList": {}, "PhoneNumberList": {} }] }, "EducationRegion": "TAIT", "EmailList": { "Email": [{ "Type": "PRIM", "Address": "stuart@gmail.com" }] }, "EntityOpen": "1652-04-01", "LocationList": { "Location": [{ "Description": "Only Campus", "Address": { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough", "PostalCode": "5781" }, "GridLocation": { "Latitude": -41.2814719, "Longitude": 175.3458472 }, "StatisticalAreaList": { "StatisticalArea": [{ "SpatialUnitType": "GE", "Code": "058" }, { "SpatialUnitType": "TA", "Code": "050" }, { "SpatialUnitType": "WA", "Code": "05003" }] } }] }, "Name": "Hogwart's Area School", "PhoneNumberList": { "PhoneNumber": [{ "Notes": "Attendance Office (Automated)", "Usage": "SMS", "Type": "WTE", "Number": "(0274) 300 9991" }, { "Notes": "Attendance Office", "Usage": "INT", "Type": "WTE", "Number": "(04) 300 9992" }, { "Notes": "School Secretary DDI", "Type": "WTE", "Number": "(04) 300 9993" }] }, "RelatedOrganisationList": { "RelatedOrganisation": [{ "RefId": "0951bacf-fc88-4ed6-8113-11a6d6335c07", "LocalId": "99102", "Name": "Tai Tokerau", "ObjectType": "Organisation", "StartDate": "2012-10-31", "Type": "MOE" }, { "RefId": "ac0871d9-6562-4209-ae86-abdb3661842b", "LocalId": "99204", "Name": "Masterton (Whakaoriori) Kāhui Ako", "ObjectType": "Organisation", "StartDate": "2012-04-30", "Type": "COL" }] }, "OperationalStatus": "O", "Type": "21", "ProviderRefId": 448, "Authority": "STATE", "SchoolService": { "CoEdStatus": "COED", "Decile": 5, "NewEntrantPolicyList": { "EnactedPolicy": [{ "EffectiveTo": "2018-12-31", "Policy": "AE" }, { "EffectiveFrom": "2019-01-01", "Policy": "CE" }] }, "DefinitionList": { "Definition": ["SMBS", "KKMA", "SWBF"] }, "SchoolYearList": { "SchoolYear": [{ "YearLevel": "1", "Gender": "C" }, { "YearLevel": "2", "Gender": "C" }, { "YearLevel": "3", "Gender": "C" }, { "YearLevel": "4", "Gender": "C" }, { "YearLevel": "5", "Gender": "C" }, { "YearLevel": "6", "Gender": "C" }, { "YearLevel": "7", "Gender": "C" }, { "YearLevel": "8", "Gender": "C" }, { "YearLevel": "9", "Gender": "F" }, { "YearLevel": "10", "Gender": "F" }, { "YearLevel": "11", "Gender": "F" }, { "YearLevel": "12", "Gender": "F" }, { "YearLevel": "13", "Gender": "F" }] } }, "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: >-
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
Attendance System (Self Service) WEB http://att.hogwarts.school.nz School Website WEB http://www.hogwarts.school.nz Dumbledore Albus Albus Dumbledore Headmaster PRI
TH PHY 533 Hogwart's Way Hogsmead 7733
Hagrid Rubeus Rubeus Hagrid Gamekeeper DIR
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
TAIT PRIM stuart@gmail.com 1652-04-01 Only Campus
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough 5781
-41.2814719 175.3458472 GE 058 TA 050 WA 05003
Hogwart's Area School Attendance Office (Automated) SMS WTE (0274) 300 9991 Attendance Office INT WTE (04) 300 9992 School Secretary DDI WTE (04) 300 9993 0951bacf-fc88-4ed6-8113-11a6d6335c07 99102 Tai Tokerau Organisation 2012-10-31 MOE ac0871d9-6562-4209-ae86-abdb3661842b 99204 Masterton (Whakaoriori) Kāhui Ako Organisation 2012-04-30 COL O 21 448 STATE COED 5 2018-12-31 AE 2019-01-01 CE SMBS KKMA SWBF 1 C 2 C 3 C 4 C 5 C 6 C 7 C 8 C 9 F 10 F 11 F 12 F 13 F 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
get: tags: - "Provider" summary: Default operation to get a single Provider parameters: - name: ProviderRefId 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: Provider: $ref: 'jsonSchemaCreate.yaml#/properties/Provider' example: "Provider": { "AddressList": { "Address": [{ "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "CommunicationChannelList": { "Channel": [{ "Notes": "Attendance System (Self Service)", "Type": "WEB", "Value": "http://att.hogwarts.school.nz" }, { "Notes": "School Website", "Type": "WEB", "Value": "http://www.hogwarts.school.nz" }] }, "ContactList": { "Contact": [{ "Name": { "FamilyName": "Dumbledore", "GivenName": "Albus", "FullName": "Albus Dumbledore" }, "PositionTitle": "Headmaster", "Role": "PRI", "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }] }, "EmailList": {}, "PhoneNumberList": {} }, { "Name": { "FamilyName": "Hagrid", "GivenName": "Rubeus", "FullName": "Rubeus Hagrid" }, "PositionTitle": "Gamekeeper", "Role": "DIR", "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }] }, "EmailList": {}, "PhoneNumberList": {} }] }, "EducationRegion": "TAIT", "EmailList": { "Email": [{ "Type": "PRIM", "Address": "stuart@gmail.com" }] }, "EntityOpen": "1652-04-01", "LocationList": { "Location": [{ "Description": "Only Campus", "Address": { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough", "PostalCode": "5781" }, "GridLocation": { "Latitude": -41.2814719, "Longitude": 175.3458472 }, "StatisticalAreaList": { "StatisticalArea": [{ "SpatialUnitType": "GE", "Code": "058" }, { "SpatialUnitType": "TA", "Code": "050" }, { "SpatialUnitType": "WA", "Code": "05003" }] } }] }, "Name": "Hogwart's Area School", "PhoneNumberList": { "PhoneNumber": [{ "Notes": "Attendance Office (Automated)", "Usage": "SMS", "Type": "WTE", "Number": "(0274) 300 9991" }, { "Notes": "Attendance Office", "Usage": "INT", "Type": "WTE", "Number": "(04) 300 9992" }, { "Notes": "School Secretary DDI", "Type": "WTE", "Number": "(04) 300 9993" }] }, "RelatedOrganisationList": { "RelatedOrganisation": [{ "RefId": "0951bacf-fc88-4ed6-8113-11a6d6335c07", "LocalId": "99102", "Name": "Tai Tokerau", "ObjectType": "Organisation", "StartDate": "2012-10-31", "Type": "MOE" }, { "RefId": "ac0871d9-6562-4209-ae86-abdb3661842b", "LocalId": "99204", "Name": "Masterton (Whakaoriori) Kāhui Ako", "ObjectType": "Organisation", "StartDate": "2012-04-30", "Type": "COL" }] }, "OperationalStatus": "O", "Type": "21", "ProviderRefId": 448, "Authority": "STATE", "SchoolService": { "CoEdStatus": "COED", "Decile": 5, "NewEntrantPolicyList": { "EnactedPolicy": [{ "EffectiveTo": "2018-12-31", "Policy": "AE" }, { "EffectiveFrom": "2019-01-01", "Policy": "CE" }] }, "DefinitionList": { "Definition": ["SMBS", "KKMA", "SWBF"] }, "SchoolYearList": { "SchoolYear": [{ "YearLevel": "1", "Gender": "C" }, { "YearLevel": "2", "Gender": "C" }, { "YearLevel": "3", "Gender": "C" }, { "YearLevel": "4", "Gender": "C" }, { "YearLevel": "5", "Gender": "C" }, { "YearLevel": "6", "Gender": "C" }, { "YearLevel": "7", "Gender": "C" }, { "YearLevel": "8", "Gender": "C" }, { "YearLevel": "9", "Gender": "F" }, { "YearLevel": "10", "Gender": "F" }, { "YearLevel": "11", "Gender": "F" }, { "YearLevel": "12", "Gender": "F" }, { "YearLevel": "13", "Gender": "F" }] } }, "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: >-
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
Attendance System (Self Service) WEB http://att.hogwarts.school.nz School Website WEB http://www.hogwarts.school.nz Dumbledore Albus Albus Dumbledore Headmaster PRI
TH PHY 533 Hogwart's Way Hogsmead 7733
Hagrid Rubeus Rubeus Hagrid Gamekeeper DIR
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
TAIT PRIM stuart@gmail.com 1652-04-01 Only Campus
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough 5781
-41.2814719 175.3458472 GE 058 TA 050 WA 05003
Hogwart's Area School Attendance Office (Automated) SMS WTE (0274) 300 9991 Attendance Office INT WTE (04) 300 9992 School Secretary DDI WTE (04) 300 9993 0951bacf-fc88-4ed6-8113-11a6d6335c07 99102 Tai Tokerau Organisation 2012-10-31 MOE ac0871d9-6562-4209-ae86-abdb3661842b 99204 Masterton (Whakaoriori) Kāhui Ako Organisation 2012-04-30 COL O 21 448 STATE COED 5 2018-12-31 AE 2019-01-01 CE SMBS KKMA SWBF 1 C 2 C 3 C 4 C 5 C 6 C 7 C 8 C 9 F 10 F 11 F 12 F 13 F 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
delete: tags: - "Provider" summary: Default operation to delete a single Provider parameters: - name: ProviderRefId 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 # ///////////////////////////////////////////////////////////// /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", "Street": { "Line1": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" } }, "EmailList": {}, "PhoneNumberList": {} } }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "stuart@gmail.com" }] }, "LocationList": {}, "Name": "Masterton (Whakaoriori) Kāhui Ako", "PhoneNumberList": { "PhoneNumber": { "Notes": "Lead School Secretary (Mobile)", "Type": "MOB", "Number": "(021) 300 999" } }, "Type": "35008", "OrganisationRefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652", "OrganisationLocalId": 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: >- Dumbledore Albus Albus Dumbledore Lead School Headmaster PRI
TH PHY 533 Hogwart's Way Hogsmead 7733
PRIM stuart@gmail.com Masterton (Whakaoriori) Kāhui Ako Lead School Secretary (Mobile) MOB (021) 300 999 35008 D3E34B35-9D75-101A-8C3D-00AA001A1652 99204 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
post: tags: - "Organisation" summary: Default operation to create a single Organisation operationId: createOrganisation requestBody: description: CRUD operation on Organisation 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", "Street": { "Line1": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" } }, "EmailList": {}, "PhoneNumberList": {} } }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "stuart@gmail.com" }] }, "LocationList": {}, "Name": "Masterton (Whakaoriori) Kāhui Ako", "PhoneNumberList": { "PhoneNumber": { "Notes": "Lead School Secretary (Mobile)", "Type": "MOB", "Number": "(021) 300 999" } }, "Type": "35008", "OrganisationRefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652", "OrganisationLocalId": 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: >- Dumbledore Albus Albus Dumbledore Lead School Headmaster PRI
TH PHY 533 Hogwart's Way Hogsmead 7733
PRIM stuart@gmail.com Masterton (Whakaoriori) Kāhui Ako Lead School Secretary (Mobile) MOB (021) 300 999 35008 D3E34B35-9D75-101A-8C3D-00AA001A1652 99204 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
# ///////////////////////////////////////////////////////////// /Organisations/{OrganisationRefId}: put: tags: - "Organisation" summary: Default operation to update a single Organisation parameters: - name: OrganisationRefId in: path description: >-

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

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", "Street": { "Line1": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" } }, "EmailList": {}, "PhoneNumberList": {} } }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "stuart@gmail.com" }] }, "LocationList": {}, "Name": "Masterton (Whakaoriori) Kāhui Ako", "PhoneNumberList": { "PhoneNumber": { "Notes": "Lead School Secretary (Mobile)", "Type": "MOB", "Number": "(021) 300 999" } }, "Type": "35008", "OrganisationRefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652", "OrganisationLocalId": 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: >- Dumbledore Albus Albus Dumbledore Lead School Headmaster PRI
TH PHY 533 Hogwart's Way Hogsmead 7733
PRIM stuart@gmail.com Masterton (Whakaoriori) Kāhui Ako Lead School Secretary (Mobile) MOB (021) 300 999 35008 D3E34B35-9D75-101A-8C3D-00AA001A1652 99204 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
get: tags: - "Organisation" summary: Default operation to get a single Organisation parameters: - name: OrganisationRefId 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: 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", "Street": { "Line1": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" } }, "EmailList": {}, "PhoneNumberList": {} } }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "stuart@gmail.com" }] }, "LocationList": {}, "Name": "Masterton (Whakaoriori) Kāhui Ako", "PhoneNumberList": { "PhoneNumber": { "Notes": "Lead School Secretary (Mobile)", "Type": "MOB", "Number": "(021) 300 999" } }, "Type": "35008", "OrganisationRefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652", "OrganisationLocalId": 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: >- Dumbledore Albus Albus Dumbledore Lead School Headmaster PRI
TH PHY 533 Hogwart's Way Hogsmead 7733
PRIM stuart@gmail.com Masterton (Whakaoriori) Kāhui Ako Lead School Secretary (Mobile) MOB (021) 300 999 35008 D3E34B35-9D75-101A-8C3D-00AA001A1652 99204 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
delete: tags: - "Organisation" summary: Default operation to delete a single Organisation parameters: - name: OrganisationRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB Science Department 9961 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "AcademicDepartment" summary: Default operation to create a single AcademicDepartment operationId: createAcademicDepartment requestBody: description: CRUD operation on AcademicDepartment 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB Science Department 9961 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /AcademicDepartments/{AcademicDepartmentRefId}: put: tags: - "AcademicDepartment" summary: Default operation to update a single AcademicDepartment parameters: - name: AcademicDepartmentRefId in: path description: >-

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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB Science Department 9961 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "AcademicDepartment" summary: Default operation to get a single AcademicDepartment parameters: - name: AcademicDepartmentRefId 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: 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB Science Department 9961 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "AcademicDepartment" summary: Default operation to delete a single AcademicDepartment parameters: - name: AcademicDepartmentRefId 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 # ///////////////////////////////////////////////////////////// /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", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "Suburb": "RD 1", "City": "Hogsmeade", "PostalCode": 5780 }] }, "EmailList": { "Email": [{ "Type": "ALT1", "Address": "fsmith@yahoo.com" }, { "Type": "PRIM", "Address": "freddy@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "WTE", "Number": "03 9637-2289", "Extension": 72289 }, { "Type": "HTE", "Number": "0437-765-234" }] } }, "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: >- D3E34F41-9D75-101A-8C3D-00AA001A1652 Smith Fred Fred Smith LGL Y
TH PHY The Enchanted Wood 533 Hogwart's Way RD 1 Hogsmeade 5780
ALT1 fsmith@yahoo.com PRIM freddy@gmail.com WTE 03 9637-2289 72289 HTE 0437-765-234
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
post: tags: - "StaffPersonal" summary: Default operation to create a single StaffPersonal operationId: createStaffPersonal requestBody: description: CRUD operation on StaffPersonal 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", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "Suburb": "RD 1", "City": "Hogsmeade", "PostalCode": 5780 }] }, "EmailList": { "Email": [{ "Type": "ALT1", "Address": "fsmith@yahoo.com" }, { "Type": "PRIM", "Address": "freddy@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "WTE", "Number": "03 9637-2289", "Extension": 72289 }, { "Type": "HTE", "Number": "0437-765-234" }] } }, "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: >- D3E34F41-9D75-101A-8C3D-00AA001A1652 Smith Fred Fred Smith LGL Y
TH PHY The Enchanted Wood 533 Hogwart's Way RD 1 Hogsmeade 5780
ALT1 fsmith@yahoo.com PRIM freddy@gmail.com WTE 03 9637-2289 72289 HTE 0437-765-234
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
# ///////////////////////////////////////////////////////////// /StaffPersonals/{StaffPersonalRefId}: put: tags: - "StaffPersonal" summary: Default operation to update a single StaffPersonal parameters: - name: StaffPersonalRefId in: path description: >-

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", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "Suburb": "RD 1", "City": "Hogsmeade", "PostalCode": 5780 }] }, "EmailList": { "Email": [{ "Type": "ALT1", "Address": "fsmith@yahoo.com" }, { "Type": "PRIM", "Address": "freddy@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "WTE", "Number": "03 9637-2289", "Extension": 72289 }, { "Type": "HTE", "Number": "0437-765-234" }] } }, "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: >- D3E34F41-9D75-101A-8C3D-00AA001A1652 Smith Fred Fred Smith LGL Y
TH PHY The Enchanted Wood 533 Hogwart's Way RD 1 Hogsmeade 5780
ALT1 fsmith@yahoo.com PRIM freddy@gmail.com WTE 03 9637-2289 72289 HTE 0437-765-234
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
get: tags: - "StaffPersonal" summary: Default operation to get a single StaffPersonal parameters: - name: StaffPersonalRefId 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: 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", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "Suburb": "RD 1", "City": "Hogsmeade", "PostalCode": 5780 }] }, "EmailList": { "Email": [{ "Type": "ALT1", "Address": "fsmith@yahoo.com" }, { "Type": "PRIM", "Address": "freddy@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "WTE", "Number": "03 9637-2289", "Extension": 72289 }, { "Type": "HTE", "Number": "0437-765-234" }] } }, "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: >- D3E34F41-9D75-101A-8C3D-00AA001A1652 Smith Fred Fred Smith LGL Y
TH PHY The Enchanted Wood 533 Hogwart's Way RD 1 Hogsmeade 5780
ALT1 fsmith@yahoo.com PRIM freddy@gmail.com WTE 03 9637-2289 72289 HTE 0437-765-234
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
delete: tags: - "StaffPersonal" summary: Default operation to delete a single StaffPersonal parameters: - name: StaffPersonalRefId 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 # ///////////////////////////////////////////////////////////// /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", "StaffRoleList": { "StaffRole": { "Role": ["1102"] } }, "StartDate": "2000-09-05", "EndDate": "2001-06-25", "CasualReliefTeacher": "N", "EmploymentStatus": "A", "StaffSubjectList": { "StaffSubject": [{ "PreferenceNumber": 1, "Code": "ENGL", "YearLevels": { "YearLevel": [11, 12, 13] } }, { "PreferenceNumber": 2, "Code": "HIST" }] }, "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: >- D3E34B35-9D75-101A-8C3D-00AA001A1652 D3E34B35-9D75-101A-8C3D-00AA001A1651 203 Wellington College Senior English Teacher 1102 2000-09-05 2001-06-25 N A 1 ENGL 11 12 13 2 HIST 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StaffAssignment" summary: Default operation to create a single StaffAssignment operationId: createStaffAssignment requestBody: description: CRUD operation on StaffAssignment 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", "StaffRoleList": { "StaffRole": { "Role": ["1102"] } }, "StartDate": "2000-09-05", "EndDate": "2001-06-25", "CasualReliefTeacher": "N", "EmploymentStatus": "A", "StaffSubjectList": { "StaffSubject": [{ "PreferenceNumber": 1, "Code": "ENGL", "YearLevels": { "YearLevel": [11, 12, 13] } }, { "PreferenceNumber": 2, "Code": "HIST" }] }, "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: >- D3E34B35-9D75-101A-8C3D-00AA001A1652 D3E34B35-9D75-101A-8C3D-00AA001A1651 203 Wellington College Senior English Teacher 1102 2000-09-05 2001-06-25 N A 1 ENGL 11 12 13 2 HIST 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StaffAssignments/{StaffAssignmentRefId}: put: tags: - "StaffAssignment" summary: Default operation to update a single StaffAssignment parameters: - name: StaffAssignmentRefId in: path description: >-

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", "StaffRoleList": { "StaffRole": { "Role": ["1102"] } }, "StartDate": "2000-09-05", "EndDate": "2001-06-25", "CasualReliefTeacher": "N", "EmploymentStatus": "A", "StaffSubjectList": { "StaffSubject": [{ "PreferenceNumber": 1, "Code": "ENGL", "YearLevels": { "YearLevel": [11, 12, 13] } }, { "PreferenceNumber": 2, "Code": "HIST" }] }, "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: >- D3E34B35-9D75-101A-8C3D-00AA001A1652 D3E34B35-9D75-101A-8C3D-00AA001A1651 203 Wellington College Senior English Teacher 1102 2000-09-05 2001-06-25 N A 1 ENGL 11 12 13 2 HIST 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StaffAssignment" summary: Default operation to get a single StaffAssignment parameters: - name: StaffAssignmentRefId 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: 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", "StaffRoleList": { "StaffRole": { "Role": ["1102"] } }, "StartDate": "2000-09-05", "EndDate": "2001-06-25", "CasualReliefTeacher": "N", "EmploymentStatus": "A", "StaffSubjectList": { "StaffSubject": [{ "PreferenceNumber": 1, "Code": "ENGL", "YearLevels": { "YearLevel": [11, 12, 13] } }, { "PreferenceNumber": 2, "Code": "HIST" }] }, "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: >- D3E34B35-9D75-101A-8C3D-00AA001A1652 D3E34B35-9D75-101A-8C3D-00AA001A1651 203 Wellington College Senior English Teacher 1102 2000-09-05 2001-06-25 N A 1 ENGL 11 12 13 2 HIST 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StaffAssignment" summary: Default operation to delete a single StaffAssignment parameters: - name: StaffAssignmentRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 92828e71-c702-4944-841e-761203142ccd 6c12f5ae-ca86-40e2-b252-593154c8b967 636 edc3ac19-264f-4734-b75b-6d56fbf84a18 11FrenA Year 11 French, Stream A 1201 2000-09-05 2001-06-25 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StaffTeachingGroupAssignment" summary: Default operation to create a single StaffTeachingGroupAssignment operationId: createStaffTeachingGroupAssignment requestBody: description: CRUD operation on StaffTeachingGroupAssignment 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: >- 92828e71-c702-4944-841e-761203142ccd 6c12f5ae-ca86-40e2-b252-593154c8b967 636 edc3ac19-264f-4734-b75b-6d56fbf84a18 11FrenA Year 11 French, Stream A 1201 2000-09-05 2001-06-25 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StaffTeachingGroupAssignments/{StaffTeachingGroupAssignmentRefId}: put: tags: - "StaffTeachingGroupAssignment" summary: Default operation to update a single StaffTeachingGroupAssignment parameters: - name: StaffTeachingGroupAssignmentRefId in: path description: >-

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: >- 92828e71-c702-4944-841e-761203142ccd 6c12f5ae-ca86-40e2-b252-593154c8b967 636 edc3ac19-264f-4734-b75b-6d56fbf84a18 11FrenA Year 11 French, Stream A 1201 2000-09-05 2001-06-25 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StaffTeachingGroupAssignment" summary: Default operation to get a single StaffTeachingGroupAssignment parameters: - name: StaffTeachingGroupAssignmentRefId 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: 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: >- 92828e71-c702-4944-841e-761203142ccd 6c12f5ae-ca86-40e2-b252-593154c8b967 636 edc3ac19-264f-4734-b75b-6d56fbf84a18 11FrenA Year 11 French, Stream A 1201 2000-09-05 2001-06-25 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StaffTeachingGroupAssignment" summary: Default operation to delete a single StaffTeachingGroupAssignment parameters: - name: StaffTeachingGroupAssignmentRefId 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 # ///////////////////////////////////////////////////////////// /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", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "hagrid@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": { "Type": "MOB", "Number": "(021) 300 999" } }, "HouseholdContactInfoList": { "HouseholdContactInfo": [{ "PreferenceNumber": 1, "HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e", "AddressList": { "Address": [{ "Type": "DE", "Role": "POS", "Street": { "Line1": "P O Box 81" }, "City": "Martinborough", "PostalCode": "5781" }] }, "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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C S1234567 2234523 1996-05-04 Hagrid Rubeus Rubeus Hagrid LGL N Anderson Samuel Samuel Anderson AKA Y NZPAS L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba Rowinski Sam Sam Rowinski PRF N 1990-09-26 Dunedin ZAF NZL ZAF NZCI NZPAS L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba 2 NZS01110 FL AD SP NZS01112 SL BE SP 1 111 1 211 NZS1001 1 Manukorihi 1 NZS212 NZS215
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
PRIM hagrid@gmail.com MOB (021) 300 999 1 7d5c3f5c-d89c-4551-9442-6b008207986e
DE POS P O Box 81 Martinborough 5781
PRIM hagrid@gmail.com MOB (021) 300 999
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
post: tags: - "StudentPersonal" summary: Default operation to create a single StudentPersonal operationId: createStudentPersonal requestBody: description: CRUD operation on StudentPersonal 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", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "hagrid@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": { "Type": "MOB", "Number": "(021) 300 999" } }, "HouseholdContactInfoList": { "HouseholdContactInfo": [{ "PreferenceNumber": 1, "HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e", "AddressList": { "Address": [{ "Type": "DE", "Role": "POS", "Street": { "Line1": "P O Box 81" }, "City": "Martinborough", "PostalCode": "5781" }] }, "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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C S1234567 2234523 1996-05-04 Hagrid Rubeus Rubeus Hagrid LGL N Anderson Samuel Samuel Anderson AKA Y NZPAS L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba Rowinski Sam Sam Rowinski PRF N 1990-09-26 Dunedin ZAF NZL ZAF NZCI NZPAS L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba 2 NZS01110 FL AD SP NZS01112 SL BE SP 1 111 1 211 NZS1001 1 Manukorihi 1 NZS212 NZS215
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
PRIM hagrid@gmail.com MOB (021) 300 999 1 7d5c3f5c-d89c-4551-9442-6b008207986e
DE POS P O Box 81 Martinborough 5781
PRIM hagrid@gmail.com MOB (021) 300 999
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
# ///////////////////////////////////////////////////////////// /StudentPersonals/{StudentPersonalRefId}: put: tags: - "StudentPersonal" summary: Default operation to update a single StudentPersonal parameters: - name: StudentPersonalRefId in: path description: >-

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", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "hagrid@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": { "Type": "MOB", "Number": "(021) 300 999" } }, "HouseholdContactInfoList": { "HouseholdContactInfo": [{ "PreferenceNumber": 1, "HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e", "AddressList": { "Address": [{ "Type": "DE", "Role": "POS", "Street": { "Line1": "P O Box 81" }, "City": "Martinborough", "PostalCode": "5781" }] }, "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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C S1234567 2234523 1996-05-04 Hagrid Rubeus Rubeus Hagrid LGL N Anderson Samuel Samuel Anderson AKA Y NZPAS L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba Rowinski Sam Sam Rowinski PRF N 1990-09-26 Dunedin ZAF NZL ZAF NZCI NZPAS L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba 2 NZS01110 FL AD SP NZS01112 SL BE SP 1 111 1 211 NZS1001 1 Manukorihi 1 NZS212 NZS215
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
PRIM hagrid@gmail.com MOB (021) 300 999 1 7d5c3f5c-d89c-4551-9442-6b008207986e
DE POS P O Box 81 Martinborough 5781
PRIM hagrid@gmail.com MOB (021) 300 999
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
get: tags: - "StudentPersonal" summary: Default operation to get a single StudentPersonal parameters: - name: StudentPersonalRefId 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: 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", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "hagrid@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": { "Type": "MOB", "Number": "(021) 300 999" } }, "HouseholdContactInfoList": { "HouseholdContactInfo": [{ "PreferenceNumber": 1, "HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e", "AddressList": { "Address": [{ "Type": "DE", "Role": "POS", "Street": { "Line1": "P O Box 81" }, "City": "Martinborough", "PostalCode": "5781" }] }, "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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C S1234567 2234523 1996-05-04 Hagrid Rubeus Rubeus Hagrid LGL N Anderson Samuel Samuel Anderson AKA Y NZPAS L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba Rowinski Sam Sam Rowinski PRF N 1990-09-26 Dunedin ZAF NZL ZAF NZCI NZPAS L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba 2 NZS01110 FL AD SP NZS01112 SL BE SP 1 111 1 211 NZS1001 1 Manukorihi 1 NZS212 NZS215
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
PRIM hagrid@gmail.com MOB (021) 300 999 1 7d5c3f5c-d89c-4551-9442-6b008207986e
DE POS P O Box 81 Martinborough 5781
PRIM hagrid@gmail.com MOB (021) 300 999
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
delete: tags: - "StudentPersonal" summary: Default operation to delete a single StudentPersonal parameters: - name: StudentPersonalRefId 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 # ///////////////////////////////////////////////////////////// /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", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "ridwulfa@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "MOB", "Number": "(021) 300 999" }] }, "HouseholdContactInfoList": { "HouseholdContactInfo": [{ "PreferenceNumber": 1, "HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e", "AddressList": { "Address": [{ "Type": "DE", "Role": "POS", "Street": { "Line1": "P O Box 81" }, "City": "Martinborough", "PostalCode": "5781" }] }, "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: >- 7C834EA9-EDA1-2090-347F-83297E1C290F P1234567 N Hagrid Fridwulfa Fridwulfa Hagrid LGL
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
PRIM ridwulfa@gmail.com MOB (021) 300 999 1 7d5c3f5c-d89c-4551-9442-6b008207986e
DE POS P O Box 81 Martinborough 5781
WORK ridwulfa@gmail.com MOB (021) 300 999
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
post: tags: - "StudentContactPersonal" summary: Default operation to create a single StudentContactPersonal operationId: createStudentContactPersonal requestBody: description: CRUD operation on StudentContactPersonal content: application/json: schema: type: object properties: StudentContactPersonal: $ref: 'jsonSchemaCreate.yaml#/properties/StudentContactPersonal' example: "StudentContactPersonal": { "StudentContactPersonalRefId": "7C834EA9-EDA1-2090-347F-83297E1C290F", "StudentContactPersonalLocalId": "P1234567", "HasBOTVote": "N", "PersonInfo": { "Name": { "FamilyName": "Hagrid", "GivenName": "Fridwulfa", "FullName": "Fridwulfa Hagrid", "Type": "LGL" }, "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "ridwulfa@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "MOB", "Number": "(021) 300 999" }] }, "HouseholdContactInfoList": { "HouseholdContactInfo": [{ "PreferenceNumber": 1, "HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e", "AddressList": { "Address": [{ "Type": "DE", "Role": "POS", "Street": { "Line1": "P O Box 81" }, "City": "Martinborough", "PostalCode": "5781" }] }, "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: StudentContactPersonal: $ref: 'jsonSchemaCreate.yaml#/properties/StudentContactPersonal' example: >- 7C834EA9-EDA1-2090-347F-83297E1C290F P1234567 N Hagrid Fridwulfa Fridwulfa Hagrid LGL
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
PRIM ridwulfa@gmail.com MOB (021) 300 999 1 7d5c3f5c-d89c-4551-9442-6b008207986e
DE POS P O Box 81 Martinborough 5781
WORK ridwulfa@gmail.com MOB (021) 300 999
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
# ///////////////////////////////////////////////////////////// /StudentContactPersonals/{StudentContactPersonalRefId}: put: tags: - "StudentContactPersonal" summary: Default operation to update a single StudentContactPersonal parameters: - name: StudentContactPersonalRefId in: path description: >- required: true schema: type: string operationId: updateStudentContactPersonal requestBody: description: CRUD operation on StudentContactPersonal content: application/json: schema: type: object properties: StudentContactPersonal: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentContactPersonal' example: "StudentContactPersonal": { "StudentContactPersonalRefId": "7C834EA9-EDA1-2090-347F-83297E1C290F", "StudentContactPersonalLocalId": "P1234567", "HasBOTVote": "N", "PersonInfo": { "Name": { "FamilyName": "Hagrid", "GivenName": "Fridwulfa", "FullName": "Fridwulfa Hagrid", "Type": "LGL" }, "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "ridwulfa@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "MOB", "Number": "(021) 300 999" }] }, "HouseholdContactInfoList": { "HouseholdContactInfo": [{ "PreferenceNumber": 1, "HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e", "AddressList": { "Address": [{ "Type": "DE", "Role": "POS", "Street": { "Line1": "P O Box 81" }, "City": "Martinborough", "PostalCode": "5781" }] }, "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: StudentContactPersonal: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentContactPersonal' example: >- 7C834EA9-EDA1-2090-347F-83297E1C290F P1234567 N Hagrid Fridwulfa Fridwulfa Hagrid LGL
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
PRIM ridwulfa@gmail.com MOB (021) 300 999 1 7d5c3f5c-d89c-4551-9442-6b008207986e
DE POS P O Box 81 Martinborough 5781
WORK ridwulfa@gmail.com MOB (021) 300 999
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
get: tags: - "StudentContactPersonal" summary: Default operation to get a single StudentContactPersonal parameters: - name: StudentContactPersonalRefId in: path description: >- required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentContactPersonal: $ref: 'jsonSchemaCreate.yaml#/properties/StudentContactPersonal' example: "StudentContactPersonal": { "StudentContactPersonalRefId": "7C834EA9-EDA1-2090-347F-83297E1C290F", "StudentContactPersonalLocalId": "P1234567", "HasBOTVote": "N", "PersonInfo": { "Name": { "FamilyName": "Hagrid", "GivenName": "Fridwulfa", "FullName": "Fridwulfa Hagrid", "Type": "LGL" }, "AddressList": { "Address": [{ "Type": "TH", "Role": "PHY", "Street": { "Line1": "The Enchanted Wood", "Line2": "533 Hogwart's Way" }, "City": "Hogsmead", "PostalCode": "7733" }, { "Type": "RU", "Role": "PHY", "Street": { "Line1": "1175 Lake Ferry Rd" }, "Suburb": "RD 1", "City": "Martinborough" }] }, "EmailList": { "Email": [{ "Type": "PRIM", "Address": "ridwulfa@gmail.com" }] }, "PhoneNumberList": { "PhoneNumber": [{ "Type": "MOB", "Number": "(021) 300 999" }] }, "HouseholdContactInfoList": { "HouseholdContactInfo": [{ "PreferenceNumber": 1, "HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e", "AddressList": { "Address": [{ "Type": "DE", "Role": "POS", "Street": { "Line1": "P O Box 81" }, "City": "Martinborough", "PostalCode": "5781" }] }, "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: StudentContactPersonal: $ref: 'jsonSchemaCreate.yaml#/properties/StudentContactPersonal' example: >- 7C834EA9-EDA1-2090-347F-83297E1C290F P1234567 N Hagrid Fridwulfa Fridwulfa Hagrid LGL
TH PHY The Enchanted Wood 533 Hogwart's Way Hogsmead 7733
RU PHY 1175 Lake Ferry Rd RD 1 Martinborough
PRIM ridwulfa@gmail.com MOB (021) 300 999 1 7d5c3f5c-d89c-4551-9442-6b008207986e
DE POS P O Box 81 Martinborough 5781
WORK ridwulfa@gmail.com MOB (021) 300 999
2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test
delete: tags: - "StudentContactPersonal" summary: Default operation to delete a single StudentContactPersonal parameters: - name: StudentContactPersonalRefId in: path description: >- required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /StudentContactRelationships: get: tags: - "StudentContactRelationship" summary: Default operation to get a list of all available StudentContactRelationships responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentContactRelationships: type: object description: >- A List of StudentContactRelationship objects properties: StudentContactRelationship: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentContactRelationship' example: "StudentContactRelationships": { "StudentContactRelationship": [{ "StudentContactRelationshipRefId": "7572B261-0947-583A-463D-BB345291B332", "Student": { "RefId": "DEE34B35-9D75-101A-8C3D-00AA001A1652" }, "StudentContact": { "RefId": "6472B261-0947-583A-463D-BB345291B001" }, "Provider": { "RefId": "4661c4c8-fd03-4fc6-8af7-5084338494db" }, "Relationship": { "Code": "LEG" }, "HouseholdList": { "HouseholdId": ["FamilyA", "FamilyB"] }, "ContactFlags": { "ParentLegalGuardian": "Y", "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: StudentContactRelationships: type: object description: >- A List of StudentContactRelationship objects properties: StudentContactRelationship: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/StudentContactRelationship' example: >- 7572B261-0947-583A-463D-BB345291B332 DEE34B35-9D75-101A-8C3D-00AA001A1652 6472B261-0947-583A-463D-BB345291B001 4661c4c8-fd03-4fc6-8af7-5084338494db LEG FamilyA FamilyB Y N N Y Y N N N N Y Y N 1 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentContactRelationship" summary: Default operation to create a single StudentContactRelationship operationId: createStudentContactRelationship requestBody: description: CRUD operation on StudentContactRelationship 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: >- 7572B261-0947-583A-463D-BB345291B332 DEE34B35-9D75-101A-8C3D-00AA001A1652 6472B261-0947-583A-463D-BB345291B001 4661c4c8-fd03-4fc6-8af7-5084338494db LEG FamilyA FamilyB Y N N Y Y N N N N Y Y N 1 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentContactRelationships/{StudentContactRelationshipRefId}: put: tags: - "StudentContactRelationship" summary: Default operation to update a single StudentContactRelationship parameters: - name: StudentContactRelationshipRefId in: path description: >-

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: >- 7572B261-0947-583A-463D-BB345291B332 DEE34B35-9D75-101A-8C3D-00AA001A1652 6472B261-0947-583A-463D-BB345291B001 4661c4c8-fd03-4fc6-8af7-5084338494db LEG FamilyA FamilyB Y N N Y Y N N N N Y Y N 1 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentContactRelationship" summary: Default operation to get a single StudentContactRelationship parameters: - name: StudentContactRelationshipRefId 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: 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: >- 7572B261-0947-583A-463D-BB345291B332 DEE34B35-9D75-101A-8C3D-00AA001A1652 6472B261-0947-583A-463D-BB345291B001 4661c4c8-fd03-4fc6-8af7-5084338494db LEG FamilyA FamilyB Y N N Y Y N N N N Y Y N 1 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentContactRelationship" summary: Default operation to delete a single StudentContactRelationship parameters: - name: StudentContactRelationshipRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB 386 Timmy McGannaway's IEP for 2019 http://somehost.co.nz/docs/ghf12312 IEP SU 17c9b7aa-bc34-435f-8bba-7e337891f53b StudentPersonal 6788765445 AU 2a288f40-c3fb-4d9c-857e-0e562f3f5dde StaffPersonal 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "Document" summary: Default operation to create a single Document operationId: createDocument requestBody: description: CRUD operation on Document 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB 386 Timmy McGannaway's IEP for 2019 http://somehost.co.nz/docs/ghf12312 IEP SU 17c9b7aa-bc34-435f-8bba-7e337891f53b StudentPersonal 6788765445 AU 2a288f40-c3fb-4d9c-857e-0e562f3f5dde StaffPersonal 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /Documents/{DocumentRefId}: put: tags: - "Document" summary: Default operation to update a single Document parameters: - name: DocumentRefId in: path description: >-

The ID (GUID) assigned to uniquely identify this Document.

required: true schema: type: string operationId: updateDocument requestBody: description: CRUD operation on Document content: application/json: schema: type: object properties: Document: $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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB 386 Timmy McGannaway's IEP for 2019 http://somehost.co.nz/docs/ghf12312 IEP SU 17c9b7aa-bc34-435f-8bba-7e337891f53b StudentPersonal 6788765445 AU 2a288f40-c3fb-4d9c-857e-0e562f3f5dde StaffPersonal 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "Document" summary: Default operation to get a single Document parameters: - name: DocumentRefId in: path description: >-

The ID (GUID) assigned to uniquely identify this Document.

required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: Document: $ref: '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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB 386 Timmy McGannaway's IEP for 2019 http://somehost.co.nz/docs/ghf12312 IEP SU 17c9b7aa-bc34-435f-8bba-7e337891f53b StudentPersonal 6788765445 AU 2a288f40-c3fb-4d9c-857e-0e562f3f5dde StaffPersonal 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "Document" summary: Default operation to delete a single Document parameters: - name: DocumentRefId in: path description: >-

The ID (GUID) assigned to uniquely identify this Document.

required: true schema: type: string responses: '200': 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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C S1234567 fe659ed3-8a78-4bc0-8876-7b75ac585edf 9961 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentConsent" summary: Default operation to create a single StudentConsent operationId: createStudentConsent requestBody: description: CRUD operation on StudentConsent 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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C S1234567 fe659ed3-8a78-4bc0-8876-7b75ac585edf 9961 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentConsents/{StudentConsentRefId}: put: tags: - "StudentConsent" summary: Default operation to update a single StudentConsent parameters: - name: StudentConsentRefId in: path description: >-

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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C S1234567 fe659ed3-8a78-4bc0-8876-7b75ac585edf 9961 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentConsent" summary: Default operation to get a single StudentConsent parameters: - name: StudentConsentRefId 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: 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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C S1234567 fe659ed3-8a78-4bc0-8876-7b75ac585edf 9961 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentConsent" summary: Default operation to delete a single StudentConsent parameters: - name: StudentConsentRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 64A309DA-063A-2E35-B359-D75101A8C3D1 20087ASPN 7A SPN Year 7A Maths - Space and Numbers SC 234 FY2020 9897466F-200E-4BC1-B9AE-D1507DA15CEF SMI001 Peter Smith 7C834EA9-EDA1-2090-347F-83297E1C290D SMI002 Jennifer Smith 7C834EA9-EDA1-2090-347F-83297E1C290E SMI003 Terence Smith A8C3A2E3-5B35-9D75-101D-00AA001A0000 SMI1 Thomas Smith 1001 A8CCCCE3-5B35-9D75-101D-00AA001A0000 LONG2 Tamara Long 1002 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "TeachingGroup" summary: Default operation to create a single TeachingGroup operationId: createTeachingGroup requestBody: description: CRUD operation on TeachingGroup 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: >- 64A309DA-063A-2E35-B359-D75101A8C3D1 20087ASPN 7A SPN Year 7A Maths - Space and Numbers SC 234 FY2020 9897466F-200E-4BC1-B9AE-D1507DA15CEF SMI001 Peter Smith 7C834EA9-EDA1-2090-347F-83297E1C290D SMI002 Jennifer Smith 7C834EA9-EDA1-2090-347F-83297E1C290E SMI003 Terence Smith A8C3A2E3-5B35-9D75-101D-00AA001A0000 SMI1 Thomas Smith 1001 A8CCCCE3-5B35-9D75-101D-00AA001A0000 LONG2 Tamara Long 1002 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /TeachingGroups/{TeachingGroupRefId}: put: tags: - "TeachingGroup" summary: Default operation to update a single TeachingGroup parameters: - name: TeachingGroupRefId in: path description: >-

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: >- 64A309DA-063A-2E35-B359-D75101A8C3D1 20087ASPN 7A SPN Year 7A Maths - Space and Numbers SC 234 FY2020 9897466F-200E-4BC1-B9AE-D1507DA15CEF SMI001 Peter Smith 7C834EA9-EDA1-2090-347F-83297E1C290D SMI002 Jennifer Smith 7C834EA9-EDA1-2090-347F-83297E1C290E SMI003 Terence Smith A8C3A2E3-5B35-9D75-101D-00AA001A0000 SMI1 Thomas Smith 1001 A8CCCCE3-5B35-9D75-101D-00AA001A0000 LONG2 Tamara Long 1002 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "TeachingGroup" summary: Default operation to get a single TeachingGroup parameters: - name: TeachingGroupRefId 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: 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: >- 64A309DA-063A-2E35-B359-D75101A8C3D1 20087ASPN 7A SPN Year 7A Maths - Space and Numbers SC 234 FY2020 9897466F-200E-4BC1-B9AE-D1507DA15CEF SMI001 Peter Smith 7C834EA9-EDA1-2090-347F-83297E1C290D SMI002 Jennifer Smith 7C834EA9-EDA1-2090-347F-83297E1C290E SMI003 Terence Smith A8C3A2E3-5B35-9D75-101D-00AA001A0000 SMI1 Thomas Smith 1001 A8CCCCE3-5B35-9D75-101D-00AA001A0000 LONG2 Tamara Long 1002 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "TeachingGroup" summary: Default operation to delete a single TeachingGroup parameters: - name: TeachingGroupRefId 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 # ///////////////////////////////////////////////////////////// /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": { "LearningStandard": [{ "RefId": "ac0871d9-6562-4209-ae86-face3661842b", "LocalId": "91165-v2", "Name": "Demonstrate understanding of the properties of selected organic compounds" }, { "RefId": "ac0871d9-6562-4209-ae86-aabb3661842b", "LocalId": "91166-v2", "Name": "Demonstrate understanding of chemical reactivity" }, { "RefId": "ac0871d9-6562-4209-ae86-aabb3661842b", "LocalId": "91167-v2", "Name": "Demonstrate understanding of oxidation-reduction" }] }, "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: >- 9D75101A-8C3D-00AA-001A-0000A2E35B35 12CHEM 632 NZC CHEM 12 Year 12 Chemistry Organic & Inorganic Chemistry for NCEA Level 2 35 11 NZS01112 1 ac0871d9-6562-4209-ae86-face3661842b 91165-v2 Demonstrate understanding of the properties of selected organic compounds ac0871d9-6562-4209-ae86-aabb3661842b 91166-v2 Demonstrate understanding of chemical reactivity ac0871d9-6562-4209-ae86-aabb3661842b 91167-v2 Demonstrate understanding of oxidation-reduction 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "ProviderCourse" summary: Default operation to create a single ProviderCourse operationId: createProviderCourse requestBody: description: CRUD operation on ProviderCourse 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": { "LearningStandard": [{ "RefId": "ac0871d9-6562-4209-ae86-face3661842b", "LocalId": "91165-v2", "Name": "Demonstrate understanding of the properties of selected organic compounds" }, { "RefId": "ac0871d9-6562-4209-ae86-aabb3661842b", "LocalId": "91166-v2", "Name": "Demonstrate understanding of chemical reactivity" }, { "RefId": "ac0871d9-6562-4209-ae86-aabb3661842b", "LocalId": "91167-v2", "Name": "Demonstrate understanding of oxidation-reduction" }] }, "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: >- 9D75101A-8C3D-00AA-001A-0000A2E35B35 12CHEM 632 NZC CHEM 12 Year 12 Chemistry Organic & Inorganic Chemistry for NCEA Level 2 35 11 NZS01112 1 ac0871d9-6562-4209-ae86-face3661842b 91165-v2 Demonstrate understanding of the properties of selected organic compounds ac0871d9-6562-4209-ae86-aabb3661842b 91166-v2 Demonstrate understanding of chemical reactivity ac0871d9-6562-4209-ae86-aabb3661842b 91167-v2 Demonstrate understanding of oxidation-reduction 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /ProviderCourses/{ProviderCourseRefId}: put: tags: - "ProviderCourse" summary: Default operation to update a single ProviderCourse parameters: - name: ProviderCourseRefId in: path description: >-

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": { "LearningStandard": [{ "RefId": "ac0871d9-6562-4209-ae86-face3661842b", "LocalId": "91165-v2", "Name": "Demonstrate understanding of the properties of selected organic compounds" }, { "RefId": "ac0871d9-6562-4209-ae86-aabb3661842b", "LocalId": "91166-v2", "Name": "Demonstrate understanding of chemical reactivity" }, { "RefId": "ac0871d9-6562-4209-ae86-aabb3661842b", "LocalId": "91167-v2", "Name": "Demonstrate understanding of oxidation-reduction" }] }, "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: >- 9D75101A-8C3D-00AA-001A-0000A2E35B35 12CHEM 632 NZC CHEM 12 Year 12 Chemistry Organic & Inorganic Chemistry for NCEA Level 2 35 11 NZS01112 1 ac0871d9-6562-4209-ae86-face3661842b 91165-v2 Demonstrate understanding of the properties of selected organic compounds ac0871d9-6562-4209-ae86-aabb3661842b 91166-v2 Demonstrate understanding of chemical reactivity ac0871d9-6562-4209-ae86-aabb3661842b 91167-v2 Demonstrate understanding of oxidation-reduction 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "ProviderCourse" summary: Default operation to get a single ProviderCourse parameters: - name: ProviderCourseRefId 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: 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": { "LearningStandard": [{ "RefId": "ac0871d9-6562-4209-ae86-face3661842b", "LocalId": "91165-v2", "Name": "Demonstrate understanding of the properties of selected organic compounds" }, { "RefId": "ac0871d9-6562-4209-ae86-aabb3661842b", "LocalId": "91166-v2", "Name": "Demonstrate understanding of chemical reactivity" }, { "RefId": "ac0871d9-6562-4209-ae86-aabb3661842b", "LocalId": "91167-v2", "Name": "Demonstrate understanding of oxidation-reduction" }] }, "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: >- 9D75101A-8C3D-00AA-001A-0000A2E35B35 12CHEM 632 NZC CHEM 12 Year 12 Chemistry Organic & Inorganic Chemistry for NCEA Level 2 35 11 NZS01112 1 ac0871d9-6562-4209-ae86-face3661842b 91165-v2 Demonstrate understanding of the properties of selected organic compounds ac0871d9-6562-4209-ae86-aabb3661842b 91166-v2 Demonstrate understanding of chemical reactivity ac0871d9-6562-4209-ae86-aabb3661842b 91167-v2 Demonstrate understanding of oxidation-reduction 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "ProviderCourse" summary: Default operation to delete a single ProviderCourse parameters: - name: ProviderCourseRefId 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 # ///////////////////////////////////////////////////////////// /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: >- cedf9eae-4358-408d-af57-ec0ea1b0d210 91165 Chemistry 2 cedf9eae-4358-408d-af57-ec0ea1b0d210 Demonstrate understanding of the properties of selected organic compounds CHEM PU 4 2 INT 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "LearningStandard" summary: Default operation to create a single LearningStandard operationId: createLearningStandard requestBody: description: CRUD operation on LearningStandard 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: >- cedf9eae-4358-408d-af57-ec0ea1b0d210 91165 Chemistry 2 cedf9eae-4358-408d-af57-ec0ea1b0d210 Demonstrate understanding of the properties of selected organic compounds CHEM PU 4 2 INT 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /LearningStandards/{LearningStandardRefId}: put: tags: - "LearningStandard" summary: Default operation to update a single LearningStandard parameters: - name: LearningStandardRefId in: path description: >-

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: >- cedf9eae-4358-408d-af57-ec0ea1b0d210 91165 Chemistry 2 cedf9eae-4358-408d-af57-ec0ea1b0d210 Demonstrate understanding of the properties of selected organic compounds CHEM PU 4 2 INT 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "LearningStandard" summary: Default operation to get a single LearningStandard parameters: - name: LearningStandardRefId 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: 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: >- cedf9eae-4358-408d-af57-ec0ea1b0d210 91165 Chemistry 2 cedf9eae-4358-408d-af57-ec0ea1b0d210 Demonstrate understanding of the properties of selected organic compounds CHEM PU 4 2 INT 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "LearningStandard" summary: Default operation to delete a single LearningStandard parameters: - name: LearningStandardRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 2b560779-872b-4491-afd6-3c6bd5f1c8cc 91165-v2 NCEA Level 2 - Endorsed with Merit 2 3d614c16-9046-47d1-87b5-51438590de15 NZQA Achieved sufficient chemistry credits endorsed with merit CHEM PU 4 2 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "Credential" summary: Default operation to create a single Credential operationId: createCredential requestBody: description: CRUD operation on Credential 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: >- 2b560779-872b-4491-afd6-3c6bd5f1c8cc 91165-v2 NCEA Level 2 - Endorsed with Merit 2 3d614c16-9046-47d1-87b5-51438590de15 NZQA Achieved sufficient chemistry credits endorsed with merit CHEM PU 4 2 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /Credentials/{CredentialRefId}: put: tags: - "Credential" summary: Default operation to update a single Credential parameters: - name: CredentialRefId in: path description: >-

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: >- 2b560779-872b-4491-afd6-3c6bd5f1c8cc 91165-v2 NCEA Level 2 - Endorsed with Merit 2 3d614c16-9046-47d1-87b5-51438590de15 NZQA Achieved sufficient chemistry credits endorsed with merit CHEM PU 4 2 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "Credential" summary: Default operation to get a single Credential parameters: - name: CredentialRefId 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: 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: >- 2b560779-872b-4491-afd6-3c6bd5f1c8cc 91165-v2 NCEA Level 2 - Endorsed with Merit 2 3d614c16-9046-47d1-87b5-51438590de15 NZQA Achieved sufficient chemistry credits endorsed with merit CHEM PU 4 2 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "Credential" summary: Default operation to delete a single Credential parameters: - name: CredentialRefId 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 # ///////////////////////////////////////////////////////////// /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: >- A8C3D3E3-4B35-9D75-101D-00AA001A1652 2004H102 d3e34b35-9d75-101a-8c3d-00aa001a1652 872 123ABC 2018-01-29 WIT 2018 BASE 11 GAE AUSPA L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba 1.0 EX 1 NZC 5 2018-05-02 STA 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentProviderEnrolment" summary: Default operation to create a single StudentProviderEnrolment operationId: createStudentProviderEnrolment requestBody: description: CRUD operation on StudentProviderEnrolment 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: >- A8C3D3E3-4B35-9D75-101D-00AA001A1652 2004H102 d3e34b35-9d75-101a-8c3d-00aa001a1652 872 123ABC 2018-01-29 WIT 2018 BASE 11 GAE AUSPA L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba 1.0 EX 1 NZC 5 2018-05-02 STA 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentProviderEnrolments/{StudentProviderEnrolmentRefId}: put: tags: - "StudentProviderEnrolment" summary: Default operation to update a single StudentProviderEnrolment parameters: - name: StudentProviderEnrolmentRefId in: path description: >-

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: >- A8C3D3E3-4B35-9D75-101D-00AA001A1652 2004H102 d3e34b35-9d75-101a-8c3d-00aa001a1652 872 123ABC 2018-01-29 WIT 2018 BASE 11 GAE AUSPA L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba 1.0 EX 1 NZC 5 2018-05-02 STA 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentProviderEnrolment" summary: Default operation to get a single StudentProviderEnrolment parameters: - name: StudentProviderEnrolmentRefId 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: 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: >- A8C3D3E3-4B35-9D75-101D-00AA001A1652 2004H102 d3e34b35-9d75-101a-8c3d-00aa001a1652 872 123ABC 2018-01-29 WIT 2018 BASE 11 GAE AUSPA L905673 2019-03-30 true 2003-11-30T12:34:56.7 822f6c83-2841-4a87-9ff9-49730951b3ba 1.0 EX 1 NZC 5 2018-05-02 STA 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentProviderEnrolment" summary: Default operation to delete a single StudentProviderEnrolment parameters: - name: StudentProviderEnrolmentRefId 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 # ///////////////////////////////////////////////////////////// /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: >- A8C3D3E3-4B35-9D75-101D-00AA001A1652 2004H102 d3e34b35-9d75-101a-8c3d-00aa001a1652 9961 93b9b77e-a23f-4acd-a65e-e26f1034317f 2018-01-29 2018-12-05 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentTeachingGroupEnrolment" summary: Default operation to create a single StudentTeachingGroupEnrolment operationId: createStudentTeachingGroupEnrolment requestBody: description: CRUD operation on StudentTeachingGroupEnrolment 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: >- A8C3D3E3-4B35-9D75-101D-00AA001A1652 2004H102 d3e34b35-9d75-101a-8c3d-00aa001a1652 9961 93b9b77e-a23f-4acd-a65e-e26f1034317f 2018-01-29 2018-12-05 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentTeachingGroupEnrolments/{StudentTeachingGroupEnrolmentRefId}: put: tags: - "StudentTeachingGroupEnrolment" summary: Default operation to update a single StudentTeachingGroupEnrolment parameters: - name: StudentTeachingGroupEnrolmentRefId in: path description: >-

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: >- A8C3D3E3-4B35-9D75-101D-00AA001A1652 2004H102 d3e34b35-9d75-101a-8c3d-00aa001a1652 9961 93b9b77e-a23f-4acd-a65e-e26f1034317f 2018-01-29 2018-12-05 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentTeachingGroupEnrolment" summary: Default operation to get a single StudentTeachingGroupEnrolment parameters: - name: StudentTeachingGroupEnrolmentRefId 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: 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: >- A8C3D3E3-4B35-9D75-101D-00AA001A1652 2004H102 d3e34b35-9d75-101a-8c3d-00aa001a1652 9961 93b9b77e-a23f-4acd-a65e-e26f1034317f 2018-01-29 2018-12-05 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentTeachingGroupEnrolment" summary: Default operation to delete a single StudentTeachingGroupEnrolment parameters: - name: StudentTeachingGroupEnrolmentRefId 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 # ///////////////////////////////////////////////////////////// /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: >- d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a Scheule 2019a (Term 1) 2019-01-30 2019-04-07 783 Hogwarts High 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Schedule 2019a, Day A 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 337804c6-1247-4c0f-b288-e4aa28584aad 2019a-B Schedule 2019a, DayB f6776718-4680-4cb7-b649-a84f9796905c 2019a-B1 Period 1 on Day B 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 2019a-B2 Period 2 on Day B 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "Schedule" summary: Default operation to create a single Schedule operationId: createSchedule requestBody: description: CRUD operation on Schedule 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: >- d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a Scheule 2019a (Term 1) 2019-01-30 2019-04-07 783 Hogwarts High 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Schedule 2019a, Day A 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 337804c6-1247-4c0f-b288-e4aa28584aad 2019a-B Schedule 2019a, DayB f6776718-4680-4cb7-b649-a84f9796905c 2019a-B1 Period 1 on Day B 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 2019a-B2 Period 2 on Day B 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /Schedules/{ScheduleRefId}: put: tags: - "Schedule" summary: Default operation to update a single Schedule parameters: - name: ScheduleRefId in: path description: >-

The ID (GUID) assigned to uniquely identify this Schedule.

required: true schema: type: string operationId: updateSchedule requestBody: description: CRUD operation on Schedule content: application/json: schema: type: object properties: Schedule: $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: >- d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a Scheule 2019a (Term 1) 2019-01-30 2019-04-07 783 Hogwarts High 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Schedule 2019a, Day A 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 337804c6-1247-4c0f-b288-e4aa28584aad 2019a-B Schedule 2019a, DayB f6776718-4680-4cb7-b649-a84f9796905c 2019a-B1 Period 1 on Day B 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 2019a-B2 Period 2 on Day B 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "Schedule" summary: Default operation to get a single Schedule parameters: - name: ScheduleRefId in: path description: >-

The ID (GUID) assigned to uniquely identify this Schedule.

required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: Schedule: $ref: '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: >- d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a Scheule 2019a (Term 1) 2019-01-30 2019-04-07 783 Hogwarts High 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Schedule 2019a, Day A 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 337804c6-1247-4c0f-b288-e4aa28584aad 2019a-B Schedule 2019a, DayB f6776718-4680-4cb7-b649-a84f9796905c 2019a-B1 Period 1 on Day B 0ddaa486-adf1-4cb3-bd06-71397f4bbdd9 2019a-B2 Period 2 on Day B 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "Schedule" summary: Default operation to delete a single Schedule parameters: - name: ScheduleRefId in: path description: >-

The ID (GUID) assigned to uniquely identify this Schedule.

required: true schema: type: string responses: '200': 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: >- 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A 783 Hogwarts High d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 Schedule 2019a, Normal Bell Schedule 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "ScheduleAcademicDay" summary: Default operation to create a single ScheduleAcademicDay operationId: createScheduleAcademicDay requestBody: description: CRUD operation on ScheduleAcademicDay 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: >- 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A 783 Hogwarts High d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 Schedule 2019a, Normal Bell Schedule 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /ScheduleAcademicDays/{ScheduleAcademicDayRefId}: put: tags: - "ScheduleAcademicDay" summary: Default operation to update a single ScheduleAcademicDay parameters: - name: ScheduleAcademicDayRefId in: path description: >-

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: >- 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A 783 Hogwarts High d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 Schedule 2019a, Normal Bell Schedule 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "ScheduleAcademicDay" summary: Default operation to get a single ScheduleAcademicDay parameters: - name: ScheduleAcademicDayRefId 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: 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: >- 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A 783 Hogwarts High d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 Schedule 2019a, Normal Bell Schedule 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "ScheduleAcademicDay" summary: Default operation to delete a single ScheduleAcademicDay parameters: - name: ScheduleAcademicDayRefId 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 # ///////////////////////////////////////////////////////////// /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-A1", "PeriodName": "Period 1 on Day A", "Provider": { "RefId": 783, "Name": "Hogwarts High" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "LocalId": "2019a", "Name": "Scheule 2019a (Term 1)" }, "AcademicDay": { "RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9", "LocalId": "2019a-A", "Name": "Schedule 2019a, Day A" }, "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: >- 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 783 Hogwarts High d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a Scheule 2019a (Term 1) 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Schedule 2019a, Day A 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "SchedulePeriod" summary: Default operation to create a single SchedulePeriod operationId: createSchedulePeriod requestBody: description: CRUD operation on SchedulePeriod content: application/json: schema: type: object properties: SchedulePeriod: $ref: 'jsonSchemaCreate.yaml#/properties/SchedulePeriod' example: "SchedulePeriod": { "SchedulePeriodRefId": "215f796c-67f7-4855-83dc-28ad9d002830", "SchedulePeriodLocalId": "2019a-A1", "PeriodName": "Period 1 on Day A", "Provider": { "RefId": 783, "Name": "Hogwarts High" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "LocalId": "2019a", "Name": "Scheule 2019a (Term 1)" }, "AcademicDay": { "RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9", "LocalId": "2019a-A", "Name": "Schedule 2019a, Day A" }, "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: >- 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 783 Hogwarts High d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a Scheule 2019a (Term 1) 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Schedule 2019a, Day A 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /SchedulePeriods/{SchedulePeriodRefId}: put: tags: - "SchedulePeriod" summary: Default operation to update a single SchedulePeriod parameters: - name: SchedulePeriodRefId in: path description: >-

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-A1", "PeriodName": "Period 1 on Day A", "Provider": { "RefId": 783, "Name": "Hogwarts High" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "LocalId": "2019a", "Name": "Scheule 2019a (Term 1)" }, "AcademicDay": { "RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9", "LocalId": "2019a-A", "Name": "Schedule 2019a, Day A" }, "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: >- 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 783 Hogwarts High d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a Scheule 2019a (Term 1) 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Schedule 2019a, Day A 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "SchedulePeriod" summary: Default operation to get a single SchedulePeriod parameters: - name: SchedulePeriodRefId 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: SchedulePeriod: $ref: 'jsonSchemaCreate.yaml#/properties/SchedulePeriod' example: "SchedulePeriod": { "SchedulePeriodRefId": "215f796c-67f7-4855-83dc-28ad9d002830", "SchedulePeriodLocalId": "2019a-A1", "PeriodName": "Period 1 on Day A", "Provider": { "RefId": 783, "Name": "Hogwarts High" }, "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "LocalId": "2019a", "Name": "Scheule 2019a (Term 1)" }, "AcademicDay": { "RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9", "LocalId": "2019a-A", "Name": "Schedule 2019a, Day A" }, "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: >- 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 783 Hogwarts High d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a Scheule 2019a (Term 1) 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Schedule 2019a, Day A 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "SchedulePeriod" summary: Default operation to delete a single SchedulePeriod parameters: - name: SchedulePeriodRefId 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 # ///////////////////////////////////////////////////////////// /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: >- d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a-Normal Schedule 2019a, Normal Bell Schedule 844 Hogwarts High Scheule 2019a (Term 1) 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 08:45:00 09:35:00 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 09:45:00 10:35:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "BellSchedule" summary: Default operation to create a single BellSchedule operationId: createBellSchedule requestBody: description: CRUD operation on BellSchedule 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: >- d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a-Normal Schedule 2019a, Normal Bell Schedule 844 Hogwarts High Scheule 2019a (Term 1) 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 08:45:00 09:35:00 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 09:45:00 10:35:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /BellSchedules/{BellScheduleRefId}: put: tags: - "BellSchedule" summary: Default operation to update a single BellSchedule parameters: - name: BellScheduleRefId in: path description: >-

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: >- d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a-Normal Schedule 2019a, Normal Bell Schedule 844 Hogwarts High Scheule 2019a (Term 1) 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 08:45:00 09:35:00 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 09:45:00 10:35:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "BellSchedule" summary: Default operation to get a single BellSchedule parameters: - name: BellScheduleRefId 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: 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: >- d2f4aea9-564f-4bdf-a18e-42a111a0602c 2019a-Normal Schedule 2019a, Normal Bell Schedule 844 Hogwarts High Scheule 2019a (Term 1) 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 08:45:00 09:35:00 1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34 2019a-A2 Period 2 on Day A 09:45:00 10:35:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "BellSchedule" summary: Default operation to delete a single BellSchedule parameters: - name: BellScheduleRefId 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 # ///////////////////////////////////////////////////////////// /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: >- eed03e3c-b088-4b69-bba7-b042f6f7a040 2019-1 Term I of 2019 783 2019-01-28 2019-03-13 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "ScheduleTerm" summary: Default operation to create a single ScheduleTerm operationId: createScheduleTerm requestBody: description: CRUD operation on ScheduleTerm 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: >- eed03e3c-b088-4b69-bba7-b042f6f7a040 2019-1 Term I of 2019 783 2019-01-28 2019-03-13 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /ScheduleTerms/{ScheduleTermRefId}: put: tags: - "ScheduleTerm" summary: Default operation to update a single ScheduleTerm parameters: - name: ScheduleTermRefId in: path description: >-

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: >- eed03e3c-b088-4b69-bba7-b042f6f7a040 2019-1 Term I of 2019 783 2019-01-28 2019-03-13 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "ScheduleTerm" summary: Default operation to get a single ScheduleTerm parameters: - name: ScheduleTermRefId 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: 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: >- eed03e3c-b088-4b69-bba7-b042f6f7a040 2019-1 Term I of 2019 783 2019-01-28 2019-03-13 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "ScheduleTerm" summary: Default operation to delete a single ScheduleTerm parameters: - name: ScheduleTermRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 4e8387f0-faed-4eb5-84ef-2139da62133d 2019-ANZAC 2019-04-25 ANZAC Day ANZAC Day, 2019 Y 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "ScheduleHoliday" summary: Default operation to create a single ScheduleHoliday operationId: createScheduleHoliday requestBody: description: CRUD operation on ScheduleHoliday 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: >- 4e8387f0-faed-4eb5-84ef-2139da62133d 2019-ANZAC 2019-04-25 ANZAC Day ANZAC Day, 2019 Y 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /ScheduleHolidays/{ScheduleHolidayRefId}: put: tags: - "ScheduleHoliday" summary: Default operation to update a single ScheduleHoliday parameters: - name: ScheduleHolidayRefId in: path description: >-

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: >- 4e8387f0-faed-4eb5-84ef-2139da62133d 2019-ANZAC 2019-04-25 ANZAC Day ANZAC Day, 2019 Y 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "ScheduleHoliday" summary: Default operation to get a single ScheduleHoliday parameters: - name: ScheduleHolidayRefId 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: 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: >- 4e8387f0-faed-4eb5-84ef-2139da62133d 2019-ANZAC 2019-04-25 ANZAC Day ANZAC Day, 2019 Y 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "ScheduleHoliday" summary: Default operation to delete a single ScheduleHoliday parameters: - name: ScheduleHolidayRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 84c40f87-769d-46cc-8077-f5efb912e099 2019a-A-06 2019-03-14 783 Hogwarts High 2f97ed99-7291-4b88-91c3-709be4308c63 Hogwarts High, Term I, 2019 d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 Schedule 2019a, Normal Bell Schedule 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 08:45:00 09:35:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "ScheduleDate" summary: Default operation to create a single ScheduleDate operationId: createScheduleDate requestBody: description: CRUD operation on ScheduleDate 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: >- 84c40f87-769d-46cc-8077-f5efb912e099 2019a-A-06 2019-03-14 783 Hogwarts High 2f97ed99-7291-4b88-91c3-709be4308c63 Hogwarts High, Term I, 2019 d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 Schedule 2019a, Normal Bell Schedule 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 08:45:00 09:35:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /ScheduleDates/{ScheduleDateRefId}: put: tags: - "ScheduleDate" summary: Default operation to update a single ScheduleDate parameters: - name: ScheduleDateRefId in: path description: >-

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: >- 84c40f87-769d-46cc-8077-f5efb912e099 2019a-A-06 2019-03-14 783 Hogwarts High 2f97ed99-7291-4b88-91c3-709be4308c63 Hogwarts High, Term I, 2019 d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 Schedule 2019a, Normal Bell Schedule 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 08:45:00 09:35:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "ScheduleDate" summary: Default operation to get a single ScheduleDate parameters: - name: ScheduleDateRefId 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: 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: >- 84c40f87-769d-46cc-8077-f5efb912e099 2019a-A-06 2019-03-14 783 Hogwarts High 2f97ed99-7291-4b88-91c3-709be4308c63 Hogwarts High, Term I, 2019 d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A 8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8 Schedule 2019a, Normal Bell Schedule 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 08:45:00 09:35:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "ScheduleDate" summary: Default operation to delete a single ScheduleDate parameters: - name: ScheduleDateRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 9356909d-e46a-456a-a177-6a914af861ae 20197A-SPN-1 9961 Hogwarts High 64a309da-063a-2e35-b359-d75101a8c3d1 20197ASPN Year 7A Maths - Space and Numbers d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A TB202 Tower Block, Room 202 Y A8C3A2E3-5B35-9D75-101D-00AA001A0000 SMI1 Thomas Smith 1001 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "TeachingGroupEvent" summary: Default operation to create a single TeachingGroupEvent operationId: createTeachingGroupEvent requestBody: description: CRUD operation on TeachingGroupEvent 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: >- 9356909d-e46a-456a-a177-6a914af861ae 20197A-SPN-1 9961 Hogwarts High 64a309da-063a-2e35-b359-d75101a8c3d1 20197ASPN Year 7A Maths - Space and Numbers d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A TB202 Tower Block, Room 202 Y A8C3A2E3-5B35-9D75-101D-00AA001A0000 SMI1 Thomas Smith 1001 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /TeachingGroupEvents/{TeachingGroupEventRefId}: put: tags: - "TeachingGroupEvent" summary: Default operation to update a single TeachingGroupEvent parameters: - name: TeachingGroupEventRefId in: path description: >-

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: >- 9356909d-e46a-456a-a177-6a914af861ae 20197A-SPN-1 9961 Hogwarts High 64a309da-063a-2e35-b359-d75101a8c3d1 20197ASPN Year 7A Maths - Space and Numbers d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A TB202 Tower Block, Room 202 Y A8C3A2E3-5B35-9D75-101D-00AA001A0000 SMI1 Thomas Smith 1001 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "TeachingGroupEvent" summary: Default operation to get a single TeachingGroupEvent parameters: - name: TeachingGroupEventRefId 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: 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: >- 9356909d-e46a-456a-a177-6a914af861ae 20197A-SPN-1 9961 Hogwarts High 64a309da-063a-2e35-b359-d75101a8c3d1 20197ASPN Year 7A Maths - Space and Numbers d2f4aea9-564f-4bdf-a18e-42a111a0602c Scheule 2019a (Term 1) 215f796c-67f7-4855-83dc-28ad9d002830 2019a-A1 Period 1 on Day A 364f0aa5-49e2-434e-9c82-45770f4c71a9 2019a-A Scheule 2019a, Day A TB202 Tower Block, Room 202 Y A8C3A2E3-5B35-9D75-101D-00AA001A0000 SMI1 Thomas Smith 1001 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "TeachingGroupEvent" summary: Default operation to delete a single TeachingGroupEvent parameters: - name: TeachingGroupEventRefId 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 # ///////////////////////////////////////////////////////////// /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: >- c79e65df-0b11-4a97-9062-9fbd1c1a38e3 evMarSlip 783 Hogwarts High 2019-03-14 1 March Floods - School Closed - Slip Schedule INSERT d2f4aea9-564f-4bdf-a18e-42a111a0602c Schedule 2019a (Term 1) post: tags: - "ScheduleEvent" summary: Default operation to create a single ScheduleEvent operationId: createScheduleEvent requestBody: description: CRUD operation on ScheduleEvent 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: >- c79e65df-0b11-4a97-9062-9fbd1c1a38e3 evMarSlip 783 Hogwarts High 2019-03-14 1 March Floods - School Closed - Slip Schedule INSERT d2f4aea9-564f-4bdf-a18e-42a111a0602c Schedule 2019a (Term 1) # ///////////////////////////////////////////////////////////// /ScheduleEvents/{ScheduleEventRefId}: put: tags: - "ScheduleEvent" summary: Default operation to update a single ScheduleEvent parameters: - name: ScheduleEventRefId in: path description: >-

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: >- c79e65df-0b11-4a97-9062-9fbd1c1a38e3 evMarSlip 783 Hogwarts High 2019-03-14 1 March Floods - School Closed - Slip Schedule INSERT d2f4aea9-564f-4bdf-a18e-42a111a0602c Schedule 2019a (Term 1) get: tags: - "ScheduleEvent" summary: Default operation to get a single ScheduleEvent parameters: - name: ScheduleEventRefId 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: 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: >- c79e65df-0b11-4a97-9062-9fbd1c1a38e3 evMarSlip 783 Hogwarts High 2019-03-14 1 March Floods - School Closed - Slip Schedule INSERT d2f4aea9-564f-4bdf-a18e-42a111a0602c Schedule 2019a (Term 1) delete: tags: - "ScheduleEvent" summary: Default operation to delete a single ScheduleEvent parameters: - name: ScheduleEventRefId 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 # ///////////////////////////////////////////////////////////// /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: >- d3476fae-8647-384b-da24-31eda3583211 7c834ea9-eda1-2090-347f-83297e1c290c 743 2015 2014-08-30 2015-06-10 1 180 1.00 178 2 2 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentAttendanceSummary" summary: Default operation to create a single StudentAttendanceSummary operationId: createStudentAttendanceSummary requestBody: description: CRUD operation on StudentAttendanceSummary 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: >- d3476fae-8647-384b-da24-31eda3583211 7c834ea9-eda1-2090-347f-83297e1c290c 743 2015 2014-08-30 2015-06-10 1 180 1.00 178 2 2 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentAttendanceSummarys/{StudentAttendanceSummaryRefId}: put: tags: - "StudentAttendanceSummary" summary: Default operation to update a single StudentAttendanceSummary parameters: - name: StudentAttendanceSummaryRefId in: path description: >-

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: >- d3476fae-8647-384b-da24-31eda3583211 7c834ea9-eda1-2090-347f-83297e1c290c 743 2015 2014-08-30 2015-06-10 1 180 1.00 178 2 2 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentAttendanceSummary" summary: Default operation to get a single StudentAttendanceSummary parameters: - name: StudentAttendanceSummaryRefId 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: 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: >- d3476fae-8647-384b-da24-31eda3583211 7c834ea9-eda1-2090-347f-83297e1c290c 743 2015 2014-08-30 2015-06-10 1 180 1.00 178 2 2 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentAttendanceSummary" summary: Default operation to delete a single StudentAttendanceSummary parameters: - name: StudentAttendanceSummaryRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 7f11e3ed-3ac5-4673-9fdc-bcdbcd991234 762 7f11e3ed-3ac5-4673-9fdc-bcdbcd993378 7f11e3ed-3ac5-4673-9fdc-bcdbcd934554 SCH P 2018-06-26 7f11e3ed-3ac5-4673-9fdc-bcdbcd999999 2018-06-30T06:30:57 Student was present. 2018-06-28T06:30:57 7f11e3ed-3ac5-4673-9fdc-bcdbcd934667 ADH E 2018-06-27 09:45:00 10:30:00 2018-06-30T06:30:57 Explained absence, but unjustified. 2018-06-28T06:30:57 post: tags: - "StudentAttendanceTimeList" summary: Default operation to create a single StudentAttendanceTimeList operationId: createStudentAttendanceTimeList requestBody: description: CRUD operation on StudentAttendanceTimeList content: application/json: schema: type: object properties: StudentAttendanceTimeList: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttendanceTimeList' example: "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: StudentAttendanceTimeList: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttendanceTimeList' example: >- 7f11e3ed-3ac5-4673-9fdc-bcdbcd991234 762 7f11e3ed-3ac5-4673-9fdc-bcdbcd993378 7f11e3ed-3ac5-4673-9fdc-bcdbcd934554 SCH P 2018-06-26 7f11e3ed-3ac5-4673-9fdc-bcdbcd999999 2018-06-30T06:30:57 Student was present. 2018-06-28T06:30:57 7f11e3ed-3ac5-4673-9fdc-bcdbcd934667 ADH E 2018-06-27 09:45:00 10:30:00 2018-06-30T06:30:57 Explained absence, but unjustified. 2018-06-28T06:30:57 # ///////////////////////////////////////////////////////////// /StudentAttendanceTimeLists/{StudentAttendanceTimeListRefId}: put: tags: - "StudentAttendanceTimeList" summary: Default operation to update a single StudentAttendanceTimeList parameters: - name: StudentAttendanceTimeListRefId in: path description: >- required: true schema: type: string operationId: updateStudentAttendanceTimeList requestBody: description: CRUD operation on StudentAttendanceTimeList content: application/json: schema: type: object properties: StudentAttendanceTimeList: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAttendanceTimeList' example: "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: StudentAttendanceTimeList: $ref: 'jsonSchemaUpdate.yaml#/properties/StudentAttendanceTimeList' example: >- 7f11e3ed-3ac5-4673-9fdc-bcdbcd991234 762 7f11e3ed-3ac5-4673-9fdc-bcdbcd993378 7f11e3ed-3ac5-4673-9fdc-bcdbcd934554 SCH P 2018-06-26 7f11e3ed-3ac5-4673-9fdc-bcdbcd999999 2018-06-30T06:30:57 Student was present. 2018-06-28T06:30:57 7f11e3ed-3ac5-4673-9fdc-bcdbcd934667 ADH E 2018-06-27 09:45:00 10:30:00 2018-06-30T06:30:57 Explained absence, but unjustified. 2018-06-28T06:30:57 get: tags: - "StudentAttendanceTimeList" summary: Default operation to get a single StudentAttendanceTimeList parameters: - name: StudentAttendanceTimeListRefId in: path description: >- required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object properties: StudentAttendanceTimeList: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttendanceTimeList' example: "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: StudentAttendanceTimeList: $ref: 'jsonSchemaCreate.yaml#/properties/StudentAttendanceTimeList' example: >- 7f11e3ed-3ac5-4673-9fdc-bcdbcd991234 762 7f11e3ed-3ac5-4673-9fdc-bcdbcd993378 7f11e3ed-3ac5-4673-9fdc-bcdbcd934554 SCH P 2018-06-26 7f11e3ed-3ac5-4673-9fdc-bcdbcd999999 2018-06-30T06:30:57 Student was present. 2018-06-28T06:30:57 7f11e3ed-3ac5-4673-9fdc-bcdbcd934667 ADH E 2018-06-27 09:45:00 10:30:00 2018-06-30T06:30:57 Explained absence, but unjustified. 2018-06-28T06:30:57 delete: tags: - "StudentAttendanceTimeList" summary: Default operation to delete a single StudentAttendanceTimeList parameters: - name: StudentAttendanceTimeListRefId in: path description: >- required: true schema: type: string responses: '200': description: successful operation # ///////////////////////////////////////////////////////////// /WellbeingAlerts: get: tags: - "WellbeingAlert" summary: Default operation to get a list of all available WellbeingAlerts responses: '200': description: successful operation content: application/json: schema: type: object properties: WellbeingAlerts: type: object description: >- A List of WellbeingAlert objects properties: WellbeingAlert: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingAlert' example: "WellbeingAlerts": { "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: WellbeingAlerts: type: object description: >- A List of WellbeingAlert objects properties: WellbeingAlert: type: array items: $ref: 'jsonSchemaCreate.yaml#/properties/WellbeingAlert' example: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 672 BA265776-359D-7510-1A8C-77432A901A16 2017-11-01 2017-11-01 MED This Student is allergic to peanuts 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "WellbeingAlert" summary: Default operation to create a single WellbeingAlert operationId: createWellbeingAlert requestBody: description: CRUD operation on WellbeingAlert 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 672 BA265776-359D-7510-1A8C-77432A901A16 2017-11-01 2017-11-01 MED This Student is allergic to peanuts 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /WellbeingAlerts/{WellbeingAlertRefId}: put: tags: - "WellbeingAlert" summary: Default operation to update a single WellbeingAlert parameters: - name: WellbeingAlertRefId in: path description: >-

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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 672 BA265776-359D-7510-1A8C-77432A901A16 2017-11-01 2017-11-01 MED This Student is allergic to peanuts 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "WellbeingAlert" summary: Default operation to get a single WellbeingAlert parameters: - name: WellbeingAlertRefId 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: 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 672 BA265776-359D-7510-1A8C-77432A901A16 2017-11-01 2017-11-01 MED This Student is allergic to peanuts 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "WellbeingAlert" summary: Default operation to delete a single WellbeingAlert parameters: - name: WellbeingAlertRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 672 2017-11-01 2017-11-10 This Student has a special need. LSN LSN-SOC LSN-HYP RT Dr RTL Bush 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "WellbeingCharacteristic" summary: Default operation to create a single WellbeingCharacteristic operationId: createWellbeingCharacteristic requestBody: description: CRUD operation on WellbeingCharacteristic 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 672 2017-11-01 2017-11-10 This Student has a special need. LSN LSN-SOC LSN-HYP RT Dr RTL Bush 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /WellbeingCharacteristics/{WellbeingCharacteristicRefId}: put: tags: - "WellbeingCharacteristic" summary: Default operation to update a single WellbeingCharacteristic parameters: - name: WellbeingCharacteristicRefId in: path description: >-

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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 672 2017-11-01 2017-11-10 This Student has a special need. LSN LSN-SOC LSN-HYP RT Dr RTL Bush 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "WellbeingCharacteristic" summary: Default operation to get a single WellbeingCharacteristic parameters: - name: WellbeingCharacteristicRefId 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: 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 672 2017-11-01 2017-11-10 This Student has a special need. LSN LSN-SOC LSN-HYP RT Dr RTL Bush 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "WellbeingCharacteristic" summary: Default operation to delete a single WellbeingCharacteristic parameters: - name: WellbeingCharacteristicRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 773 POS 2017-11-01 AM NON ININ 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "WellbeingEvent" summary: Default operation to create a single WellbeingEvent operationId: createWellbeingEvent requestBody: description: CRUD operation on WellbeingEvent 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 773 POS 2017-11-01 AM NON ININ 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /WellbeingEvents/{WellbeingEventRefId}: put: tags: - "WellbeingEvent" summary: Default operation to update a single WellbeingEvent parameters: - name: WellbeingEventRefId in: path description: >-

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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 773 POS 2017-11-01 AM NON ININ 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "WellbeingEvent" summary: Default operation to get a single WellbeingEvent parameters: - name: WellbeingEventRefId 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: 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 773 POS 2017-11-01 AM NON ININ 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "WellbeingEvent" summary: Default operation to delete a single WellbeingEvent parameters: - name: WellbeingEventRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 877 2017-11-01 2017-11-01 2017-11-10 S This Student is to be withdrawn. 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "WellbeingResponse" summary: Default operation to create a single WellbeingResponse operationId: createWellbeingResponse requestBody: description: CRUD operation on WellbeingResponse 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 877 2017-11-01 2017-11-01 2017-11-10 S This Student is to be withdrawn. 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /WellbeingResponses/{WellbeingResponseRefId}: put: tags: - "WellbeingResponse" summary: Default operation to update a single WellbeingResponse parameters: - name: WellbeingResponseRefId in: path description: >-

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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 877 2017-11-01 2017-11-01 2017-11-10 S This Student is to be withdrawn. 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "WellbeingResponse" summary: Default operation to get a single WellbeingResponse parameters: - name: WellbeingResponseRefId 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: 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 877 2017-11-01 2017-11-01 2017-11-10 S This Student is to be withdrawn. 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "WellbeingResponse" summary: Default operation to delete a single WellbeingResponse parameters: - name: WellbeingResponseRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 9961 BC385746-359D-7510-1A8C-36432A901A36 SU 2017-11-01 This Appeal was successful. 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "WellbeingAppeal" summary: Default operation to create a single WellbeingAppeal operationId: createWellbeingAppeal requestBody: description: CRUD operation on WellbeingAppeal 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 9961 BC385746-359D-7510-1A8C-36432A901A36 SU 2017-11-01 This Appeal was successful. 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /WellbeingAppeals/{WellbeingAppealRefId}: put: tags: - "WellbeingAppeal" summary: Default operation to update a single WellbeingAppeal parameters: - name: WellbeingAppealRefId in: path description: >-

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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 9961 BC385746-359D-7510-1A8C-36432A901A36 SU 2017-11-01 This Appeal was successful. 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "WellbeingAppeal" summary: Default operation to get a single WellbeingAppeal parameters: - name: WellbeingAppealRefId 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: 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB D3E34B35-9D75-101A-8C3D-00AA001A1652 9961 BC385746-359D-7510-1A8C-36432A901A36 SU 2017-11-01 This Appeal was successful. 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "WellbeingAppeal" summary: Default operation to delete a single WellbeingAppeal parameters: - name: WellbeingAppealRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 9ECC9683-0E02-406F-926C-1C4D3542D122 646C5D4A-C829-4886-A02B-971695C7BC06 2342 SPO CRI First XI First year of participation 2008-09-01 Team Member Player of the Day 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentActivityParticipation" summary: Default operation to create a single StudentActivityParticipation operationId: createStudentActivityParticipation requestBody: description: CRUD operation on StudentActivityParticipation 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: >- 9ECC9683-0E02-406F-926C-1C4D3542D122 646C5D4A-C829-4886-A02B-971695C7BC06 2342 SPO CRI First XI First year of participation 2008-09-01 Team Member Player of the Day 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentActivityParticipations/{StudentActivityParticipationRefId}: put: tags: - "StudentActivityParticipation" summary: Default operation to update a single StudentActivityParticipation parameters: - name: StudentActivityParticipationRefId in: path description: >-

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: >- 9ECC9683-0E02-406F-926C-1C4D3542D122 646C5D4A-C829-4886-A02B-971695C7BC06 2342 SPO CRI First XI First year of participation 2008-09-01 Team Member Player of the Day 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentActivityParticipation" summary: Default operation to get a single StudentActivityParticipation parameters: - name: StudentActivityParticipationRefId 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: 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: >- 9ECC9683-0E02-406F-926C-1C4D3542D122 646C5D4A-C829-4886-A02B-971695C7BC06 2342 SPO CRI First XI First year of participation 2008-09-01 Team Member Player of the Day 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentActivityParticipation" summary: Default operation to delete a single StudentActivityParticipation parameters: - name: StudentActivityParticipationRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C 2234523 5c33548a-1141-40eb-94d3-9267a2258435 234 Timothy doesn't like talking about setting goals. These goals have been gathered through observation. 2018-11-30 Timothy spends most lunchtimes playing with the piano, or watching others playing music Music/Piano MUS MUSP 2018-11-30 Timothy would like to have more friends to play with at lunchtime. Have more friends 2018-11-30 Timothy wants to excel at Te Reo Māori Excel Te Reo MAOR 2018-11-30 Timothy would like to be a Marine Biologist, or Deep Sea Diver Marine Biologist 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentVoice" summary: Default operation to create a single StudentVoice operationId: createStudentVoice requestBody: description: CRUD operation on StudentVoice 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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C 2234523 5c33548a-1141-40eb-94d3-9267a2258435 234 Timothy doesn't like talking about setting goals. These goals have been gathered through observation. 2018-11-30 Timothy spends most lunchtimes playing with the piano, or watching others playing music Music/Piano MUS MUSP 2018-11-30 Timothy would like to have more friends to play with at lunchtime. Have more friends 2018-11-30 Timothy wants to excel at Te Reo Māori Excel Te Reo MAOR 2018-11-30 Timothy would like to be a Marine Biologist, or Deep Sea Diver Marine Biologist 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentVoices/{StudentVoiceRefId}: put: tags: - "StudentVoice" summary: Default operation to update a single StudentVoice parameters: - name: StudentVoiceRefId in: path description: >-

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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C 2234523 5c33548a-1141-40eb-94d3-9267a2258435 234 Timothy doesn't like talking about setting goals. These goals have been gathered through observation. 2018-11-30 Timothy spends most lunchtimes playing with the piano, or watching others playing music Music/Piano MUS MUSP 2018-11-30 Timothy would like to have more friends to play with at lunchtime. Have more friends 2018-11-30 Timothy wants to excel at Te Reo Māori Excel Te Reo MAOR 2018-11-30 Timothy would like to be a Marine Biologist, or Deep Sea Diver Marine Biologist 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentVoice" summary: Default operation to get a single StudentVoice parameters: - name: StudentVoiceRefId 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: 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: >- 7C834EA9-EDA1-2090-347F-83297E1C290C 2234523 5c33548a-1141-40eb-94d3-9267a2258435 234 Timothy doesn't like talking about setting goals. These goals have been gathered through observation. 2018-11-30 Timothy spends most lunchtimes playing with the piano, or watching others playing music Music/Piano MUS MUSP 2018-11-30 Timothy would like to have more friends to play with at lunchtime. Have more friends 2018-11-30 Timothy wants to excel at Te Reo Māori Excel Te Reo MAOR 2018-11-30 Timothy would like to be a Marine Biologist, or Deep Sea Diver Marine Biologist 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentVoice" summary: Default operation to delete a single StudentVoice parameters: - name: StudentVoiceRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 461B63B4-CFEF-4820-8501-E7D1E54555CB CA285746-359D-7510-1A8C-36432A901A16 744 ACT 461423B4-CFEF-4820-8501-E7D1E54555CB Y N N Y N Y Y N 461423B4-CFEF-4820-8345-E7D1E54555CB 461423B4-BBEF-4820-8345-E7D1E54555CB 461423B4-BBEF-4820-8345-E724E54555CB Literacy 461423B4-BBEF-4820-8345-E724E5455BBB post: tags: - "StudentLearningSupport" summary: Default operation to create a single StudentLearningSupport operationId: createStudentLearningSupport requestBody: description: CRUD operation on StudentLearningSupport 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: >- 461B63B4-CFEF-4820-8501-E7D1E54555CB CA285746-359D-7510-1A8C-36432A901A16 744 ACT 461423B4-CFEF-4820-8501-E7D1E54555CB Y N N Y N Y Y N 461423B4-CFEF-4820-8345-E7D1E54555CB 461423B4-BBEF-4820-8345-E7D1E54555CB 461423B4-BBEF-4820-8345-E724E54555CB Literacy 461423B4-BBEF-4820-8345-E724E5455BBB # ///////////////////////////////////////////////////////////// /StudentLearningSupports/{StudentLearningSupportRefId}: put: tags: - "StudentLearningSupport" summary: Default operation to update a single StudentLearningSupport parameters: - name: StudentLearningSupportRefId in: path description: >-

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: >- 461B63B4-CFEF-4820-8501-E7D1E54555CB CA285746-359D-7510-1A8C-36432A901A16 744 ACT 461423B4-CFEF-4820-8501-E7D1E54555CB Y N N Y N Y Y N 461423B4-CFEF-4820-8345-E7D1E54555CB 461423B4-BBEF-4820-8345-E7D1E54555CB 461423B4-BBEF-4820-8345-E724E54555CB Literacy 461423B4-BBEF-4820-8345-E724E5455BBB get: tags: - "StudentLearningSupport" summary: Default operation to get a single StudentLearningSupport parameters: - name: StudentLearningSupportRefId 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: 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: >- 461B63B4-CFEF-4820-8501-E7D1E54555CB CA285746-359D-7510-1A8C-36432A901A16 744 ACT 461423B4-CFEF-4820-8501-E7D1E54555CB Y N N Y N Y Y N 461423B4-CFEF-4820-8345-E7D1E54555CB 461423B4-BBEF-4820-8345-E7D1E54555CB 461423B4-BBEF-4820-8345-E724E54555CB Literacy 461423B4-BBEF-4820-8345-E724E5455BBB delete: tags: - "StudentLearningSupport" summary: Default operation to delete a single StudentLearningSupport parameters: - name: StudentLearningSupportRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 461B63B4-CFEF-4820-8501-E7DBBB4555CB 8631e737-c9db-4e6c-804d-a78c65f98f67 CA222226-359D-7510-1A8C-36432A901A16 ADA ACU The student is confident in their reading ability. IND TEA Jane Doe MON BOA CA2BBB26-359D-2480-1A8C-36432A901A16 2019-11-11 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. 2010-01-21 CA2BBB26-359D-3480-1A8C-36432A901A16 2019-10-28T06:30:57 CA222226-359D-2480-1A8C-36432A901A16 post: tags: - "StudentLearningSupportResponse" summary: Default operation to create a single StudentLearningSupportResponse operationId: createStudentLearningSupportResponse requestBody: description: CRUD operation on StudentLearningSupportResponse 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: >- 461B63B4-CFEF-4820-8501-E7DBBB4555CB 8631e737-c9db-4e6c-804d-a78c65f98f67 CA222226-359D-7510-1A8C-36432A901A16 ADA ACU The student is confident in their reading ability. IND TEA Jane Doe MON BOA CA2BBB26-359D-2480-1A8C-36432A901A16 2019-11-11 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. 2010-01-21 CA2BBB26-359D-3480-1A8C-36432A901A16 2019-10-28T06:30:57 CA222226-359D-2480-1A8C-36432A901A16 # ///////////////////////////////////////////////////////////// /StudentLearningSupportResponses/{StudentLearningSupportResponseRefId}: put: tags: - "StudentLearningSupportResponse" summary: Default operation to update a single StudentLearningSupportResponse parameters: - name: StudentLearningSupportResponseRefId in: path description: >-

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: >- 461B63B4-CFEF-4820-8501-E7DBBB4555CB 8631e737-c9db-4e6c-804d-a78c65f98f67 CA222226-359D-7510-1A8C-36432A901A16 ADA ACU The student is confident in their reading ability. IND TEA Jane Doe MON BOA CA2BBB26-359D-2480-1A8C-36432A901A16 2019-11-11 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. 2010-01-21 CA2BBB26-359D-3480-1A8C-36432A901A16 2019-10-28T06:30:57 CA222226-359D-2480-1A8C-36432A901A16 get: tags: - "StudentLearningSupportResponse" summary: Default operation to get a single StudentLearningSupportResponse parameters: - name: StudentLearningSupportResponseRefId 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: 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: >- 461B63B4-CFEF-4820-8501-E7DBBB4555CB 8631e737-c9db-4e6c-804d-a78c65f98f67 CA222226-359D-7510-1A8C-36432A901A16 ADA ACU The student is confident in their reading ability. IND TEA Jane Doe MON BOA CA2BBB26-359D-2480-1A8C-36432A901A16 2019-11-11 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. 2010-01-21 CA2BBB26-359D-3480-1A8C-36432A901A16 2019-10-28T06:30:57 CA222226-359D-2480-1A8C-36432A901A16 delete: tags: - "StudentLearningSupportResponse" summary: Default operation to delete a single StudentLearningSupportResponse parameters: - name: StudentLearningSupportResponseRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 NZ History Classroom Test 9962 PRO D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 cd106d6d-d9d5-41fb-9943-5feb967c9435 ASS Pop Quiz 100 2018-11-25 1.0 http://www.assignmentinfo.com/assignment1.pdf INT P F 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "AssessmentTask" summary: Default operation to create a single AssessmentTask operationId: createAssessmentTask requestBody: description: CRUD operation on AssessmentTask 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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 NZ History Classroom Test 9962 PRO D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 cd106d6d-d9d5-41fb-9943-5feb967c9435 ASS Pop Quiz 100 2018-11-25 1.0 http://www.assignmentinfo.com/assignment1.pdf INT P F 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /AssessmentTasks/{AssessmentTaskRefId}: put: tags: - "AssessmentTask" summary: Default operation to update a single AssessmentTask parameters: - name: AssessmentTaskRefId in: path description: >-

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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 NZ History Classroom Test 9962 PRO D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 cd106d6d-d9d5-41fb-9943-5feb967c9435 ASS Pop Quiz 100 2018-11-25 1.0 http://www.assignmentinfo.com/assignment1.pdf INT P F 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "AssessmentTask" summary: Default operation to get a single AssessmentTask parameters: - name: AssessmentTaskRefId 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: 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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 NZ History Classroom Test 9962 PRO D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 cd106d6d-d9d5-41fb-9943-5feb967c9435 ASS Pop Quiz 100 2018-11-25 1.0 http://www.assignmentinfo.com/assignment1.pdf INT P F 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "AssessmentTask" summary: Default operation to delete a single AssessmentTask parameters: - name: AssessmentTaskRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 A75A0010-1A8C-301D-02E3-A05B359D0A00 INT P 9953 PRO MATH NZC PATCOMP F 2018-11-21T15:34:22 FIN RAW 25 FIN SCA 38.5 FIN MAR 5.0 FIN YEA 4 FIN STA 6 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentAssessmentTaskResult" summary: Default operation to create a single StudentAssessmentTaskResult operationId: createStudentAssessmentTaskResult requestBody: description: CRUD operation on StudentAssessmentTaskResult 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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 A75A0010-1A8C-301D-02E3-A05B359D0A00 INT P 9953 PRO MATH NZC PATCOMP F 2018-11-21T15:34:22 FIN RAW 25 FIN SCA 38.5 FIN MAR 5.0 FIN YEA 4 FIN STA 6 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentAssessmentTaskResults/{StudentAssessmentTaskResultRefId}: put: tags: - "StudentAssessmentTaskResult" summary: Default operation to update a single StudentAssessmentTaskResult parameters: - name: StudentAssessmentTaskResultRefId in: path description: >-

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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 A75A0010-1A8C-301D-02E3-A05B359D0A00 INT P 9953 PRO MATH NZC PATCOMP F 2018-11-21T15:34:22 FIN RAW 25 FIN SCA 38.5 FIN MAR 5.0 FIN YEA 4 FIN STA 6 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentAssessmentTaskResult" summary: Default operation to get a single StudentAssessmentTaskResult parameters: - name: StudentAssessmentTaskResultRefId 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: 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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 A75A0010-1A8C-301D-02E3-A05B359D0A00 INT P 9953 PRO MATH NZC PATCOMP F 2018-11-21T15:34:22 FIN RAW 25 FIN SCA 38.5 FIN MAR 5.0 FIN YEA 4 FIN STA 6 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentAssessmentTaskResult" summary: Default operation to delete a single StudentAssessmentTaskResult parameters: - name: StudentAssessmentTaskResultRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 9772 ASR 377 PRO 851039-HP Harry Potter 23423421 c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb cedd0ce7-f555-482b-887b-d130e5c40d02 COM EXT SEP PHYS 12 2018-03-30 2018 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentAssessmentTaskRegistration" summary: Default operation to create a single StudentAssessmentTaskRegistration operationId: createStudentAssessmentTaskRegistration requestBody: description: CRUD operation on StudentAssessmentTaskRegistration 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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 9772 ASR 377 PRO 851039-HP Harry Potter 23423421 c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb cedd0ce7-f555-482b-887b-d130e5c40d02 COM EXT SEP PHYS 12 2018-03-30 2018 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentAssessmentTaskRegistrations/{StudentAssessmentTaskRegistrationRefId}: put: tags: - "StudentAssessmentTaskRegistration" summary: Default operation to update a single StudentAssessmentTaskRegistration parameters: - name: StudentAssessmentTaskRegistrationRefId in: path description: >-

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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 9772 ASR 377 PRO 851039-HP Harry Potter 23423421 c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb cedd0ce7-f555-482b-887b-d130e5c40d02 COM EXT SEP PHYS 12 2018-03-30 2018 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentAssessmentTaskRegistration" summary: Default operation to get a single StudentAssessmentTaskRegistration parameters: - name: StudentAssessmentTaskRegistrationRefId 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: 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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 9772 ASR 377 PRO 851039-HP Harry Potter 23423421 c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb cedd0ce7-f555-482b-887b-d130e5c40d02 COM EXT SEP PHYS 12 2018-03-30 2018 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentAssessmentTaskRegistration" summary: Default operation to delete a single StudentAssessmentTaskRegistration parameters: - name: StudentAssessmentTaskRegistrationRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 cd106d6d-d9d5-41fb-9943-5feb967c9435 850139-HP Harry Potter 23423421 D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 762 LOC 9962 PRO 228a2cbe-93c4-46ba-91fa-b3ae689eb437 Prof. McGonnegal INV 2018-11-25T09:00:00+12:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentAssessmentTask" summary: Default operation to create a single StudentAssessmentTask operationId: createStudentAssessmentTask requestBody: description: CRUD operation on StudentAssessmentTask 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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 cd106d6d-d9d5-41fb-9943-5feb967c9435 850139-HP Harry Potter 23423421 D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 762 LOC 9962 PRO 228a2cbe-93c4-46ba-91fa-b3ae689eb437 Prof. McGonnegal INV 2018-11-25T09:00:00+12:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentAssessmentTasks/{StudentAssessmentTaskRefId}: put: tags: - "StudentAssessmentTask" summary: Default operation to update a single StudentAssessmentTask parameters: - name: StudentAssessmentTaskRefId in: path description: >-

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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 cd106d6d-d9d5-41fb-9943-5feb967c9435 850139-HP Harry Potter 23423421 D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 762 LOC 9962 PRO 228a2cbe-93c4-46ba-91fa-b3ae689eb437 Prof. McGonnegal INV 2018-11-25T09:00:00+12:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentAssessmentTask" summary: Default operation to get a single StudentAssessmentTask parameters: - name: StudentAssessmentTaskRefId 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: 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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 cd106d6d-d9d5-41fb-9943-5feb967c9435 850139-HP Harry Potter 23423421 D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 762 LOC 9962 PRO 228a2cbe-93c4-46ba-91fa-b3ae689eb437 Prof. McGonnegal INV 2018-11-25T09:00:00+12:00 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentAssessmentTask" summary: Default operation to delete a single StudentAssessmentTask parameters: - name: StudentAssessmentTaskRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 762 D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 NCEA Level 2 Chemistry - Endorsed with merit Credential cd106d6d-d9d5-41fb-9943-5feb967c9435 HP85-1039 Harry Potter 23423421 2018-07-25 2752a16b-b62a-4973-9d44-23e13e1c037b 91165-v2 Demonstrate understanding of the properties of selected organic compounds StudentAssessmentTaskResult EXT Achieved 2016-06-28 4 eca0da5d-94af-4223-aaa6-7c0083006efd 91166-v2 Demonstrate understanding of chemical reactivity StudentAssessmentTaskResult INT Achieved with merit 2016-06-01 3 12f4761d-5e97-4e12-804e-e16d882c86c7 91167-v2 Demonstrate understanding of oxidation-reduction StudentAssessmentTaskResult EXT Achieved 2016-06-28 3 CHEM 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentAttainment" summary: Default operation to create a single StudentAttainment operationId: createStudentAttainment requestBody: description: CRUD operation on StudentAttainment 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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 762 D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 NCEA Level 2 Chemistry - Endorsed with merit Credential cd106d6d-d9d5-41fb-9943-5feb967c9435 HP85-1039 Harry Potter 23423421 2018-07-25 2752a16b-b62a-4973-9d44-23e13e1c037b 91165-v2 Demonstrate understanding of the properties of selected organic compounds StudentAssessmentTaskResult EXT Achieved 2016-06-28 4 eca0da5d-94af-4223-aaa6-7c0083006efd 91166-v2 Demonstrate understanding of chemical reactivity StudentAssessmentTaskResult INT Achieved with merit 2016-06-01 3 12f4761d-5e97-4e12-804e-e16d882c86c7 91167-v2 Demonstrate understanding of oxidation-reduction StudentAssessmentTaskResult EXT Achieved 2016-06-28 3 CHEM 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentAttainments/{StudentAttainmentRefId}: put: tags: - "StudentAttainment" summary: Default operation to update a single StudentAttainment parameters: - name: StudentAttainmentRefId in: path description: >-

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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 762 D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 NCEA Level 2 Chemistry - Endorsed with merit Credential cd106d6d-d9d5-41fb-9943-5feb967c9435 HP85-1039 Harry Potter 23423421 2018-07-25 2752a16b-b62a-4973-9d44-23e13e1c037b 91165-v2 Demonstrate understanding of the properties of selected organic compounds StudentAssessmentTaskResult EXT Achieved 2016-06-28 4 eca0da5d-94af-4223-aaa6-7c0083006efd 91166-v2 Demonstrate understanding of chemical reactivity StudentAssessmentTaskResult INT Achieved with merit 2016-06-01 3 12f4761d-5e97-4e12-804e-e16d882c86c7 91167-v2 Demonstrate understanding of oxidation-reduction StudentAssessmentTaskResult EXT Achieved 2016-06-28 3 CHEM 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentAttainment" summary: Default operation to get a single StudentAttainment parameters: - name: StudentAttainmentRefId 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: 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: >- 359D7510-1AD0-A9D7-A8C3-DAD0A85103A2 762 D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39 NCEA Level 2 Chemistry - Endorsed with merit Credential cd106d6d-d9d5-41fb-9943-5feb967c9435 HP85-1039 Harry Potter 23423421 2018-07-25 2752a16b-b62a-4973-9d44-23e13e1c037b 91165-v2 Demonstrate understanding of the properties of selected organic compounds StudentAssessmentTaskResult EXT Achieved 2016-06-28 4 eca0da5d-94af-4223-aaa6-7c0083006efd 91166-v2 Demonstrate understanding of chemical reactivity StudentAssessmentTaskResult INT Achieved with merit 2016-06-01 3 12f4761d-5e97-4e12-804e-e16d882c86c7 91167-v2 Demonstrate understanding of oxidation-reduction StudentAssessmentTaskResult EXT Achieved 2016-06-28 3 CHEM 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentAttainment" summary: Default operation to delete a single StudentAttainment parameters: - name: StudentAttainmentRefId 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 # ///////////////////////////////////////////////////////////// /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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB CA285746-359D-7510-1A8C-36432A901A16 9961 4f6dce25-cca6-49ef-8be4-675e2cfce8b8 HM8P Year 8 Hard Materials, Pinehurst School 1b6fabed-2af9-4395-b48c-f46c8edb1b78 SMcG Steve McGannaway TRM HM Excellent Not particularly interested, attention wanders TP BD 2 B Brief Development in hard materials Not particularly interested, attention wanders Beginner Struggles with the planning required 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test post: tags: - "StudentCurriculumProgressReport" summary: Default operation to create a single StudentCurriculumProgressReport operationId: createStudentCurriculumProgressReport requestBody: description: CRUD operation on StudentCurriculumProgressReport 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB CA285746-359D-7510-1A8C-36432A901A16 9961 4f6dce25-cca6-49ef-8be4-675e2cfce8b8 HM8P Year 8 Hard Materials, Pinehurst School 1b6fabed-2af9-4395-b48c-f46c8edb1b78 SMcG Steve McGannaway TRM HM Excellent Not particularly interested, attention wanders TP BD 2 B Brief Development in hard materials Not particularly interested, attention wanders Beginner Struggles with the planning required 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test # ///////////////////////////////////////////////////////////// /StudentCurriculumProgressReports/{StudentCurriculumProgressReportRefId}: put: tags: - "StudentCurriculumProgressReport" summary: Default operation to update a single StudentCurriculumProgressReport parameters: - name: StudentCurriculumProgressReportRefId in: path description: >-

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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB CA285746-359D-7510-1A8C-36432A901A16 9961 4f6dce25-cca6-49ef-8be4-675e2cfce8b8 HM8P Year 8 Hard Materials, Pinehurst School 1b6fabed-2af9-4395-b48c-f46c8edb1b78 SMcG Steve McGannaway TRM HM Excellent Not particularly interested, attention wanders TP BD 2 B Brief Development in hard materials Not particularly interested, attention wanders Beginner Struggles with the planning required 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test get: tags: - "StudentCurriculumProgressReport" summary: Default operation to get a single StudentCurriculumProgressReport parameters: - name: StudentCurriculumProgressReportRefId 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: 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: >- 2FFB63B4-CFEF-4820-8501-E7D1E54555CB CA285746-359D-7510-1A8C-36432A901A16 9961 4f6dce25-cca6-49ef-8be4-675e2cfce8b8 HM8P Year 8 Hard Materials, Pinehurst School 1b6fabed-2af9-4395-b48c-f46c8edb1b78 SMcG Steve McGannaway TRM HM Excellent Not particularly interested, attention wanders TP BD 2 B Brief Development in hard materials Not particularly interested, attention wanders Beginner Struggles with the planning required 2019-01-01T03:15:00 44FB63B4-CFEF-4820-8501-E7D1E54555CB Bobby Test delete: tags: - "StudentCurriculumProgressReport" summary: Default operation to delete a single StudentCurriculumProgressReport parameters: - name: StudentCurriculumProgressReportRefId 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