Upload course completion data to the submission

Using a valid submission token, upload course completion data to the submission.

You are able to make multiple calls to this end point to accumulate data against the submission.

Each record in the submission content must contain a localId field - this field is used by the caller to indentify the record.

The value of localId is only used in the context of the caller managing the records within the submission.

The value of localId must be unique within the submission course completions and must be set by the caller. Adding a second record in the same content type with an identical localId will cause the first record with the same localId value to be replaced.

Header Parameters
EID string — REQUIRED Enter the EDUMIS (Organisation) ID

Request Body
submissionToken string — REQUIRED Possible values: 1 ≤ length The valid submission token to submit data against
content object[] — REQUIRED localId string — REQUIRED Possible values: 1 ≤ length An integrator generated unique identifier for this item. studentIdentificationCode string — REQUIRED Possible values: 1 ≤ length ≤ 10 Student Identification Code A code which uniquely identifies the learner within each TEO. The student ID must remain constant for the learner throughout their enrolment history at your organisation Length: 10 Type: Character Type of enrolment: D Guidance: The value is generated by each TEO. This field is mandatory. courseCode string — REQUIRED Possible values: 1 ≤ length ≤ 20 Course Code The internal code for a course in which learners are enrolled. The code must be able to uniquely identify a specific course in which a learner is enrolled regardless of the period, location, and year in which it is taught. The course code should be consistently reported for each course offered by the TEO. Length: 20 Type: Alpha-Numeric Type of enrolment: D Guidance: The internal code for the course. The code should contain no reference to dates or years in which the course is taught, e.g., “ECON112”. Note: Every unique course in the course enrolment file should appear once, and once only, in the course register file. This field is mandatory. studentCourseCompletionIndicator int32 — REQUIRED Student Course Completion indicator The completion status of a course. A learner is deemed to have successfully completed the course when they have met the requirements set out in the approved course or outline. Type: Integer Type of enrolment: D Guidance: Select a value from the list below. 0: Still to complete course – valid extension or grade not yet available (NZQCF Level 1-8) 1: Still to complete course – course end date not yet reached (NZQCF Level 1-8) 2: Completed course successfully 3: Completed course unsuccessfully 4: Did not complete course 5: Practicum to complete – on job training (NZQCF Levels 1-8) 6: Yet to complete – NZQCF Levels 9 & 10 7: Extension granted or under moderation – NZQCF Levels 9 & 10 8: Completed Successfully Thesis written in Te Reo Māori This field is mandatory. courseStartDate date-time — REQUIRED Course Start Date The start date of the learner’s course(s) in the current or previous academic year. This date is the officially notified beginning date of instruction and/or structured supervision associated with each learner’s course(s) at a tertiary education organisation. Type: Date Type of enrolment: D Guidance: DD/MM/YYYY. This field is mandatory. nationalStudentNumber int32 — REQUIRED National Student Number A number which uniquely identifies the learner. The NSN must remain constant for the learner throughout their enrolment at your or any other organisation. The NSN is part of the NSI database system maintained by the Ministry of Education. Type: Integer Type of enrolment: D Guidance: This number must be the value generated by the National Student Index (NSI) for the learner. This field is mandatory. courseEndDate date-time — REQUIRED Course End Date The end date of the learner’s course. This will normally be the officially notified end date of instruction and/or examination associated with a course. If a course spans the end of the normal academic year, the last date will be for the following year. Type: Date Type of enrolment: D Guidance: DD/MM/YYYY. This field is mandatory. pbrfCourseCompletionYear int32 PBRF Course Completion Year The actual end year of the learner’s course(s) for those completing PBRF (funded only) course(s). This field value is the officially notified year the research component of the course is completed. Type: Integer Type of enrolment: D Guidance: Enter the year in the format YYYY - e.g., 2023.

Responses
200 Acknowledgement of data received Schema — OPTIONAL submissionToken string — OPTIONAL The valid submission token to submit data against content object[] — OPTIONAL The submission content result. localId string — OPTIONAL errors string[] — OPTIONAL
400 Submission token is not found - check error code for more detail Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL errors object — OPTIONAL returnId string — OPTIONAL submissionToken string — OPTIONAL content object — OPTIONAL errorCode string — OPTIONAL
401 Authorization failed Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL
429 Concurrent Request Not Allowed - check error code for more detail Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL