Record a Visit against a Training Plan

Record a Visit against a Training Plan

Path Parameters
trainingPlanLocalId string — REQUIRED

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

Request Body
visitLocalId string — REQUIRED 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 — REQUIRED 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.

Responses
201 The operation returned successfully and a new resource was created. Schema — OPTIONAL 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