MatchingSessions

Resume a matching session (leg F)

Re-mint a fresh single-use navigation token for an existing matching attempt.

Access is STAFF-only (internal_admin, internal_user), enforced by the role gate on this route. There is no row-level ownership check: any staff user may resume any matching session. This is deliberate, so several staff can collaborate on one matching-server session. matching_sessions.opened_by_admin_id still records who STARTED the session. The resuming user is recorded in the application log only.

Note: this router mounts at the top level (/api/matching-sessions), outside the /api/cohorts tree, so it does NOT inherit requireCohortAccess. The role gate on this route is the only access control here. Add one to every new route on this router.

On success the row transitions to in_progress (per the §7 state machine). The response includes status so the SPA can update its sessions list immediately without a follow-up GET.

Per §11.7, an outbound failure to matching-server does NOT mutate the row's status. The caller can retry by clicking Resume again.

post/api/matching-sessions/{id}/resume

Request

  • Base URL
    https://api.production.yourmedley.com
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Request body

object required

Response

Token re-minted. Row transitioned to in_progress.

matching_urlstring uri required

matching-server URL with a freshly minted single-use navigation token

status'in_progress' required

The row's status after a successful resume. Always in_progress per the §7 state machine. Returned so the SPA can update its sessions list immediately without a follow-up GET.

Changes

No recorded changes to this operation across all 1 revision of this API.