Upload qualification completion data to the submission

Using a valid submission token, upload qualification 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 qualification 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: Alpha-Numeric Type of enrolment: D Guidance: The value is generated by each TEO. 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. qualificationCode string — REQUIRED Possible values: 1 ≤ length ≤ 6 Qualification Code The Qualification code relating to a quality assured qualification. The field is used to indicate: › the qualification the learner is currently enrolled in, or › a qualification that has been completed by the learner, or › a qualification for which a course has been approved for funding. Length: 6 Type: Alpha-Numeric Type of enrolment: D Guidance: The value should be a six alpha-numeric code as on the SDR Qualifications Register which uniquely identifies a quality assured qualification. (Note requirements for pre-service teacher education qualifications in SDR Qualifications Register section). This field is mandatory. yearRequirementsMet int32 — REQUIRED Year Requirements Met The year the requirements have been met for the award of a qualification as set out in the approved regulations. Type: Integer Type of enrolment: D Guidance: Enter the year in the format YYYY - e.g., 2023. This field is mandatory. irdNumber string Possible values: length ≤ 11 IRD number IRD number of the learner. The IRD number enables data matching to support the learner in claiming their Fees Free entitlement. Learners will apply for their Fees Free entitlement via myIR. To match the learner’s data (such as course fees) provided by TEC, Inland Revenue will use the learner’s IRD number. (They will also use NSN and date of birth). While not mandatory, TEOs are encouraged to provide the learner’s IRD number upon enrolment. If this was not possible, the IRD number can be captured here when recording the learner’s qualification completion. Type: String Length: 11 Type of enrolment: D Guidance: IRD numbers are either eight or nine digits with dashes e.g., 123-456-789. Please enter leading zero in the first box if your IRD number is only 8 digits. Only provide an IRD number for a learner here if it has not been previously provided via the learner file and the learner may meet the eligibility criteria for Fees Free at the time they met the requirements to be awarded the qualification. We are using Inland Revenue’s checksum code to validate the IRD number. However, we cannot determine if the learner provided an IRD number that does not belong to them. Inland Revenue will work directly with the learner to resolve this situation. qualificationCompletionDate date-time Qualification Completion Date The date the requirements have been met by the learner to be awarded the qualification. This should align with what is reported for the 'Year Requirements Met' field.” Type: Date Type of enrolment: B, C, D Guidance: DD/MM/YYYY This field is mandatory. linkedQualificationCodeForFeesFree string Possible values: length ≤ 6 Linked Qualification Code for Fees Free Used for exit or expired qualifications when the learner’s course enrolments have been reported under a different qualification code than the one completed. The link will identify the qualification that the original course enrolments and course fees are reported under to calculate the learner’s entitlement for Fees Fee. Length: 6 Type: Alpha-Numeric Type of enrolment: D Guidance: The value should be a six alpha-numeric code as on the SDR Qualifications Register which uniquely identifies a quality assured qualification.

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