Skip to main content

Get the status of an enrolment completion task

Get the status of an enrolment completion task

Path Parameters
taskId uuid REQUIRED
Header Parameters
EID string REQUIRED

Enter the EDUMIS (Organisation) ID

Responses
200

The task status was retrieved successfully.

Schema OPTIONAL
taskId uuid OPTIONAL

The unique identifier for the task

status string OPTIONAL

The current status of the task (Running, Completed, Failed)

startTime date-time OPTIONAL

The time the task was started

completionTime date-time OPTIONAL

The time the task completed (or failed)

elapsedTime date-span OPTIONAL

The elapsed time of the task

result object OPTIONAL
earliestActiveEnrolmentDate date OPTIONAL
earliestActiveEnrolmentDateQueryTime date-span OPTIONAL
completedEnrolmentComponentIds int32[] OPTIONAL
completedEnrolmentComponentsCount int32 OPTIONAL
componentCompletionTime date-span OPTIONAL
completedQualificationIds int32[] OPTIONAL
completedQualificationsCount int32 OPTIONAL
qualificationCompletionTime date-span OPTIONAL
completedSimpleEnrolmentIds int32[] OPTIONAL
completedSimpleEnrolmentsCount int32 OPTIONAL
simpleEnrolmentCompletionTime date-span OPTIONAL
completedComplexEnrolmentIds int32[] OPTIONAL
completedComplexEnrolmentsCount int32 OPTIONAL
complexEnrolmentCompletionTime date-span OPTIONAL
expiredTrainingAgreementIds int32[] OPTIONAL
expiredTrainingAgreementsCount int32 OPTIONAL
graceExpiryTime date-span OPTIONAL
finishedTrainingAgreementIds int32[] OPTIONAL
finishedTrainingAgreementsCount int32 OPTIONAL
finishedTrainingAgreementsTime date-span OPTIONAL
totalCompletionTime date-span OPTIONAL
errorMessage string OPTIONAL

Error message if the task failed

401

Unauthorized

Schema OPTIONAL
type string OPTIONAL
title string OPTIONAL
status int32 OPTIONAL
detail string OPTIONAL
instance string OPTIONAL
errors object OPTIONAL
404

The specified task was not found.

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