Get Training Plan including Visits

Get Training Plan including Visits

Path Parameters
trainingPlanLocalId string — REQUIRED The training plan local identifier.

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

Responses
200 The operation returned successfully. Schema — OPTIONAL trainingPlan object — OPTIONAL trainingPlanSignedDate date Training Plan Signed Date The date the training plan was signed between the apprentice, employer, and MAC. Type: Date Guidance: 2024-04-08 You must use ISO-8601 for your dates. The Training Plan Signed Date must be on or after the associated Training Agreement Signed date. For each Pending, Hold, Grace enrolment associated with the Training Agreement, where enrolment participation start date is before the Training Plan Signed Date, check that the programme is active as at the Training Plan Signed Date. This check is required, as these enrolments will have their participation start date uploaded to Training Plan Signed Date. This change also applies to Complex Arrangements for both over-arching and sub-enrolments. learnerLocalId string — OPTIONAL Learner Local ID A code which uniquely identifies the learner within each TEO, as captured in a TEO’s TMS system. The Learner Local ID must remain constant for the learner throughout their enrolment history at your organisation. Length: 20 Type: String Guidance: This number must be the unique value generated by each TEO via their TMS. Both ‘Learner Identification Code’ and ‘Learner Local ID’ cannot both be NULL. trainingPlanLocalId string — OPTIONAL Training Plan Local ID A unique number issued by the TEO that identifies the Training Plan. A unique Training Plan has a unique combination of Organisation ID, Learner Local ID, and Training Plan Signed Date. Length: 20 Type: String Guidance: trainingAgreementLocalId string — OPTIONAL Training Agreement Local ID A unique number issued by the TEO that Identifies the training agreement that the Training Plan relates. Length: 20 Type: String Guidance: The referenced Training Agreement must: › exist and match the training agreement for that apprentice at that TEO. › have a status of ‘Pending’, ‘Hold’, or ‘Grace’. Enrolments associated with the Training Agreement must be NZAs. A single Training Agreement can relate to multiple Training Plans. trainingPlanEndDate date — OPTIONAL trainingPlan Type: Training Plan End Date visits object[] — OPTIONAL visits Type: TrainingPlanVisit array visitLocalId string Possible values: 1 ≤ length ≤ 20 Visit Local ID A code which uniquely identifies a visit against a training plan. Length: 20 Type: String Guidance: This number must be a unique value. visitDate date Visit Date The date the visit occurred. Type: Date Guidance: 2024-04-08 You must use ISO-8601 for your dates. The Visit Date must be on or after then Training Plan Signed Date, must be a date no later than today, and must be on or before the Training Plan End Date. Multiple visits with the same learner cannot be reported on the same day. A training plan can have many associated visits.
400 Bad request. Check errors and codes for more detail. Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL errors object — OPTIONAL
401 Unauthorized Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL errors object — OPTIONAL
429 Rate Limiting may apply. Refer to Retry-After header Schema — OPTIONAL type string — OPTIONAL title string — OPTIONAL status int32 — OPTIONAL detail string — OPTIONAL instance string — OPTIONAL