Assessments

Get Next Assessment Question

Use this API to locate the next, first, or previous unanswered or flagged question in an assessment. The response includes the relevant section and question identifiers, along with overall assessment progress.

🗒 Things to Know

  • The returned sectionId can be used with the Get Assessment Question Section API to retrieve the full question details and available response options.
  • This endpoint is useful when only a subset of assessment questions remain unanswered.
get/api/assessment/v2/assessments/{assessmentId}/questions/unanswered

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/assessment/v2/assessments/{assessmentId}/questions/unanswered
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ASSESSMENT_READ, ASSESSMENT

Path parameters

assessmentIdstring uuid required

UUID of the assessment to find the next actionable question in

Query parameters

action'FIRST_UNANSWERED' | 'NEXT_UNANSWERED' | 'PREVIOUS_UNANSWERED' | 'NEXT_UNANSWERED_FLAGGED' | 'PREVIOUS_UNANSWERED_FLAGGED' | 'NEXT_FLAGGED_QUESTION' | 'QUESTION_POSITION' required

FIRST_UNANSWERED needs no current position. NEXT_UNANSWERED/PREVIOUS_UNANSWERED/QUESTION_POSITION require both sectionId and questionId. NEXT_FLAGGED_QUESTION, NEXT_UNANSWERED_FLAGGED, and PREVIOUS_UNANSWERED_FLAGGED accept them optionally; PREVIOUS_UNANSWERED_FLAGGED returns the last unanswered-or-flagged question when omitted, or when there is none before the given position (loops back to the end). Case-insensitive.

sectionIdstring uuid

Current section, if resuming from a known position.

questionIdstring uuid

Current question, if resuming from a known position.

filter'ALL_QUESTIONS' | 'UNANSWERED_QUESTIONS' | 'REQUIRED_QUESTIONS' | 'REQUIRED_UNANSWERED_QUESTIONS' | 'EFFECTIVENESS_SCALE_QUESTIONS'

Section navigation filter used for the progress calculation. Case-insensitive.

Response

OK

sectionIdstring uuid
questionIdstring uuid
position'UNDEFINED' | 'FIRST' | 'MIDDLE' | 'LAST'

Changes

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