Sessions
Per-end-user assessment sessions.
Create an assessment session
path Parameters
productAssessment product identifier.
Create an assessment session › Request Body
subjectmoderedirectUrlWhere to send the end user after a hosted session completes. Required when mode is "hosted", and must be an http(s) URL.
Accepted and validated but not currently persisted or echoed back. Do not rely on retrieving it later.
Create an assessment session › Responses
Session created.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = object |
Get session status
path Parameters
productAssessment product identifier.
idSession (submission) id.
Get session status › Responses
Session status.
sessionIdproductstatuscreatedAtcompletedAtRecord answers
path Parameters
productAssessment product identifier.
idSession (submission) id.
Record answers › Request Body
Record answers › Responses
Answers recorded.
sessionIdrecordedComplete and score a session
Scores the session against the assessment it was created with, not the currently published one. Answers must therefore use the questionId values returned by POST /v1/{product}/sessions; a set that matches none of them is rejected with 422 invalid_request and the session stays open rather than being scored as if unanswered.
path Parameters
productAssessment product identifier.
idSession (submission) id.
Complete and score a session › Responses
Session completed; results returned.
sessionIdstatusScored results, or null when the session has not been scored yet.
Get session results
path Parameters
productAssessment product identifier.
idSession (submission) id.
Get session results › Responses
Scored results.
sessionIdScored Values Bridge results. Per-value authenticityGapScaled is a signed percentage of the rating span in −100…+100 (positive = the value is lived less than desired); totals (totalAuthenticityGapScaled, totalConflictScoreScaled, totalHarmonyScoreScaled) and pairing scaledScores are 0–100. values is ordered by idealDisplayRank ascending, pairings by scaledScore descending. Numeric fields are null when a value or pairing produced no score.