Community

The enrolment shape, and why each field is asked

Every field the roster takes, with one line on what that answer buys this store, plus every way the door says no. Free, and answered rather than 404ed so a client that introspects before it posts gets structure. The American spelling /api/study/enroll serves the same document and the same door.

get/api/study/enrol

Request

  • Base URL: https://scvd.store
  • URL: https://scvd.store/api/study/enrol
  • Auth: none required

Headers

If-None-Matchstring

Send a prior ETag (SHA-256 of exact response bytes). Unchanged content returns 304 with no body.

Response

OK

this_door_takesstring required

Always POST; this GET is the contract for it.

freestring

On the enrolment door: that it opens no wallet and submits no payment.

why_firststring

On the enrolment door: why enrolling before shopping is the instrument rather than a formality.

what_it_doesstring

On the debrief door: what is verified, in what order, and what comes back.

bodyobject

The exact body this door takes, field by field.

returnsobject

What a successful call hands back, including that the study token is returned once and never recoverable.

on_the_legsstring
on_the_answersstring
on_the_rewardstring
every_problem_at_oncestring

A refused body comes back with problems: EVERY field that needs fixing, each with what was expected and what the answer buys. One more call is always enough — you never discover the roster one refusal at a time.

thenstring uri
roomstring uri

Changes

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