Place Training Agreement on hold

Place Training Agreement on hold

Path Parameters
trainingAgreementLocalId string — REQUIRED

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

Request Body
pauseDate date — REQUIRED Pause Date The date on which the Training Agreement is paused. Type: Date Guidance: 2024-04-08 You must use ISO-8601 for your dates. Status Change Date must be before or equal to today. Status Change Date must be after the Training Agreement Signed Date. Status can be backdated a maximum of three months from the current date. Completions are excluded from this limitation and any backdated events stemming from the receipt of a completion from NZQA can be applied beyond the three-month limit.
onHoldReasonCode string — REQUIRED Possible values: 1 ≤ length ≤ 2 On Hold Reason Code Identifies why a Training Agreement has moved into either a HOLD or GRACE Length: 2 Type: Character Guidance: A reason code must be provided if status code is HOLD. Please select one of the reason codes below. Reason Code: Description SW: Seasonal work PL: Parental leave OV: Overseas travel MD: Medical/ACC CI: Attending correctional institution OT: Other ST: Stop training (still with employer) WE: Work Experience

Responses
200 The operation returned successfully. Schema — OPTIONAL pauseDate date Pause Date The date on which the Training Agreement is paused. Type: Date Guidance: 2024-04-08 You must use ISO-8601 for your dates. Status Change Date must be before or equal to today. Status Change Date must be after the Training Agreement Signed Date. Status can be backdated a maximum of three months from the current date. Completions are excluded from this limitation and any backdated events stemming from the receipt of a completion from NZQA can be applied beyond the three-month limit. onHoldReasonCode string Possible values: 1 ≤ length ≤ 2 On Hold Reason Code Identifies why a Training Agreement has moved into either a HOLD or GRACE Length: 2 Type: Character Guidance: A reason code must be provided if status code is HOLD. Please select one of the reason codes below. Reason Code: Description SW: Seasonal work PL: Parental leave OV: Overseas travel MD: Medical/ACC CI: Attending correctional institution OT: Other ST: Stop training (still with employer) WE: Work Experience
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