Documentation · API

API · Assignments

Entitlements: create, window, limit attempts and revoke.

Example
Purpose
Model the right to sit an assessment as a first-class, revocable object.
Prerequisites
  • A candidate
  • An assessment id mapped from your catalogue
Architecture
An assignment binds candidate + assessment + attempt allowance + validity window + order reference.

Configuration

valid_untilMirrors the commercial access period

Implementation steps

  1. 01Map SKU/course/stage to assessment_id
  2. 02Create the assignment with an order reference
  3. 03Revoke or shorten on negative lifecycle events

Examples

Create

json
{
  "user_external_id": "WC-8291",
  "assessment_id": "asm_pro_cert_001",
  "attempts_allowed": 1,
  "valid_until": "2026-11-24T23:59:59Z",
  "order_reference": "WC-10492"
}

Testing procedure

  • Attempt launch after valid_until and assert refusal

Troubleshooting

409 duplicate_assignment

Treat as success if the existing assignment matches your order reference.