GET v1/quizResultSummary

Retrieves a QuizResultSummary by the takeKey

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The HighLevelQuizSummary, if it exists. Otherwise a 404 error.

QuizResultSummary
NameDescriptionTypeAdditional information
QuizId

string

None.
QuizName

string

None.
CanShowResultsSummary

boolean

None.
AreSummaryAnswersShown

boolean

None.
AreSummaryCorrectAnswersShown

boolean

None.
IsGraded

boolean

None.
IsTakeAvailable

boolean

None.
Questions

Collection of QuizResultSummaryQuestion

None.
IsPassed

boolean

None.

Response Codes

  • 200 OK: Requested QuizResultSummary successfully returned.
  • 401 Unauthorized:
  • 403 Forbidden: This quiz does not support summary results.
  • 404 NotFound: Requested QuizResultSummary does not exist.
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "QuizId": "sample string 1",
  "QuizName": "sample string 2",
  "CanShowResultsSummary": true,
  "AreSummaryAnswersShown": true,
  "AreSummaryCorrectAnswersShown": true,
  "IsGraded": true,
  "IsTakeAvailable": true,
  "Questions": [
    {
      "QuestionId": "sample string 1",
      "QuestionHtml": "sample string 2",
      "QuestionOrder": 3,
      "IsGraded": true,
      "AnsweredCorrectly": true,
      "PossibleAnswers": [
        {
          "AnswerId": "sample string 1",
          "AnswerHtml": "sample string 2",
          "AnswerOrder": 3,
          "IsChosen": true,
          "IsCorrect": true
        },
        {
          "AnswerId": "sample string 1",
          "AnswerHtml": "sample string 2",
          "AnswerOrder": 3,
          "IsChosen": true,
          "IsCorrect": true
        }
      ]
    },
    {
      "QuestionId": "sample string 1",
      "QuestionHtml": "sample string 2",
      "QuestionOrder": 3,
      "IsGraded": true,
      "AnsweredCorrectly": true,
      "PossibleAnswers": [
        {
          "AnswerId": "sample string 1",
          "AnswerHtml": "sample string 2",
          "AnswerOrder": 3,
          "IsChosen": true,
          "IsCorrect": true
        },
        {
          "AnswerId": "sample string 1",
          "AnswerHtml": "sample string 2",
          "AnswerOrder": 3,
          "IsChosen": true,
          "IsCorrect": true
        }
      ]
    }
  ],
  "IsPassed": true
}

text/html

Sample: 
{"QuizId":"sample string 1","QuizName":"sample string 2","CanShowResultsSummary":true,"AreSummaryAnswersShown":true,"AreSummaryCorrectAnswersShown":true,"IsGraded":true,"IsTakeAvailable":true,"Questions":[{"QuestionId":"sample string 1","QuestionHtml":"sample string 2","QuestionOrder":3,"IsGraded":true,"AnsweredCorrectly":true,"PossibleAnswers":[{"AnswerId":"sample string 1","AnswerHtml":"sample string 2","AnswerOrder":3,"IsChosen":true,"IsCorrect":true},{"AnswerId":"sample string 1","AnswerHtml":"sample string 2","AnswerOrder":3,"IsChosen":true,"IsCorrect":true}]},{"QuestionId":"sample string 1","QuestionHtml":"sample string 2","QuestionOrder":3,"IsGraded":true,"AnsweredCorrectly":true,"PossibleAnswers":[{"AnswerId":"sample string 1","AnswerHtml":"sample string 2","AnswerOrder":3,"IsChosen":true,"IsCorrect":true},{"AnswerId":"sample string 1","AnswerHtml":"sample string 2","AnswerOrder":3,"IsChosen":true,"IsCorrect":true}]}],"IsPassed":true}

application/xml, text/xml

Sample: 
<QuizResultSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Questionnaire.Api.Contracts.v1.Models">
  <AreSummaryAnswersShown>true</AreSummaryAnswersShown>
  <AreSummaryCorrectAnswersShown>true</AreSummaryCorrectAnswersShown>
  <CanShowResultsSummary>true</CanShowResultsSummary>
  <IsGraded>true</IsGraded>
  <IsPassed>true</IsPassed>
  <IsTakeAvailable>true</IsTakeAvailable>
  <Questions>
    <QuizResultSummaryQuestion>
      <AnsweredCorrectly>true</AnsweredCorrectly>
      <IsGraded>true</IsGraded>
      <PossibleAnswers>
        <QuizResultSummaryAnswer>
          <AnswerHtml>sample string 2</AnswerHtml>
          <AnswerId>sample string 1</AnswerId>
          <AnswerOrder>3</AnswerOrder>
          <IsChosen>true</IsChosen>
          <IsCorrect>true</IsCorrect>
        </QuizResultSummaryAnswer>
        <QuizResultSummaryAnswer>
          <AnswerHtml>sample string 2</AnswerHtml>
          <AnswerId>sample string 1</AnswerId>
          <AnswerOrder>3</AnswerOrder>
          <IsChosen>true</IsChosen>
          <IsCorrect>true</IsCorrect>
        </QuizResultSummaryAnswer>
      </PossibleAnswers>
      <QuestionHtml>sample string 2</QuestionHtml>
      <QuestionId>sample string 1</QuestionId>
      <QuestionOrder>3</QuestionOrder>
    </QuizResultSummaryQuestion>
    <QuizResultSummaryQuestion>
      <AnsweredCorrectly>true</AnsweredCorrectly>
      <IsGraded>true</IsGraded>
      <PossibleAnswers>
        <QuizResultSummaryAnswer>
          <AnswerHtml>sample string 2</AnswerHtml>
          <AnswerId>sample string 1</AnswerId>
          <AnswerOrder>3</AnswerOrder>
          <IsChosen>true</IsChosen>
          <IsCorrect>true</IsCorrect>
        </QuizResultSummaryAnswer>
        <QuizResultSummaryAnswer>
          <AnswerHtml>sample string 2</AnswerHtml>
          <AnswerId>sample string 1</AnswerId>
          <AnswerOrder>3</AnswerOrder>
          <IsChosen>true</IsChosen>
          <IsCorrect>true</IsCorrect>
        </QuizResultSummaryAnswer>
      </PossibleAnswers>
      <QuestionHtml>sample string 2</QuestionHtml>
      <QuestionId>sample string 1</QuestionId>
      <QuestionOrder>3</QuestionOrder>
    </QuizResultSummaryQuestion>
  </Questions>
  <QuizId>sample string 1</QuizId>
  <QuizName>sample string 2</QuizName>
</QuizResultSummary>