Skip to main content
POST
Record an externally-achieved exam result on a learner's enrolment

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Record an exam result achieved outside the platform on a learner's enrolment. Completes (or fails) the learner's current enrolment period with the supplied dates and marks it as an external result; later learner activity never overwrites it.

Record an exam result achieved outside the platform on a learner's enrolment. Completes (or fails) the learner's current enrolment period with the supplied dates and marks it as an external result; later learner activity never overwrites it.

passed
boolean
required

Whether the learner passed the external exam

achieved_date
string<date>
required

Calendar date, YYYY-MM-DD (stored as that day at 12:00 UTC). The date the result was achieved; must not be in the future

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
learner_email
string

Email of a partner contact in one of your company's partnerships — resolves to the learner's user. Exactly one of learner_email / user_uuid is required.

Required string length: 1 - 320
user_uuid
string<uuid>

UUID of a user who is a partner contact in one of your company's partnerships. Exactly one of learner_email / user_uuid is required.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
partnership_uuid
string<uuid>

UUID of a partnership in your company — disambiguates when the learner is a contact in more than one partnership

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
score
integer

Exam score (0-100)

Required range: 0 <= x <= 100
expiry_date
string<date> | null

Calendar date, YYYY-MM-DD (stored as that day at 12:00 UTC). When the certificate expires; omit to derive from the certification's validity schedule, null for no expiry

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Response

200 - application/json

A user's enrollment and progress in a certification.

A user's enrollment and progress in a certification.

uuid
string
required
user_uuid
string
required
user_email
string
required
status
enum<string>
required

enrolled → in_progress → completed or failed

Available options:
enrolled,
in_progress,
completed,
failed
progress_percentage
number
required

Completion progress (0-100)

enrolled_at
string
required
started_at
string | null
required
completed_at
string | null
required
assessment_best_score
number | null
required

Highest assessment score (0-100), or null if not attempted

assessment_passed
boolean | null
required

Whether the user passed the assessment

result_source
enum<string>
required

Where the result came from: 'platform' (learner activity), 'external' (recorded by an admin), or 'imported' (bulk-imported issued certificate)

Available options:
platform,
external,
imported
expires_at
string | null
required

When the certificate on this enrolment's current period expires, or null when the certification has no validity schedule

expired
boolean
required

Whether the certificate on this enrolment has passed its expiry date