A resolved step records a participant's completion or attempt of a step in an online program. Use the Resolved Steps API to track participant progress through both quiz and non-quiz steps.
With the Resolved Steps API, you can:
- Mark non-quiz steps as completed.
- Record quiz attempts and their completion status.
- Retrieve a specific resolved step.
- Query resolved steps to build participant progress views.
- Remove an incorrectly recorded resolved step.
Each resolved step is uniquely identified by its combination of participantId and programStepId. Upserting the same combination updates the existing record instead of creating a duplicate.
It's important to note the following points before starting to code:
- The participant must have joined the program that contains the specified step.
- For a non-quiz step, omit
quizSubmissionId. The API sets the resolved step's status to COMPLETED.
- For a quiz step, specify
quizSubmissionId. The quiz submission must belong to the quiz associated with the program step. The API copies the earned score and passing grade from the submission, then sets the status to COMPLETED or FAILED.
- For another attempt at the same quiz step, specify the new quiz submission ID. The API updates the existing resolved step with the latest attempt.
- The API automatically deletes resolved steps when the corresponding program step is deleted or the participant is removed from the program.
- Resolved step: Record of a participant's completion or attempt of a program step.
- Program step: Individual activity or lesson in an online program.
- Participant: Member who has joined an online program.
- Quiz submission: Participant's attempt at the quiz associated with a program step.