GET v1/highLevelQuizSummaries/{id}

Retrieves a HighLevelQuizSummary by the quizId

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the HighLevelQuizSummary for the quiz requested.

 string

Required

Body Parameters

None.

Response Information

Resource Description

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

HighLevelQuizSummary
NameDescriptionTypeAdditional information
QuizId

string

None.
QuizName

string

None.
IsGraded

boolean

None.
NumberOfParticipants

integer

None.
NumberOfAttempts

integer

None.
AverageScore

decimal number

None.
Questions

Collection of HighLevelQuizSummaryQuestion

None.

Response Codes

  • 200 OK: Requested HighLevelQuizSummary successfully returned.
  • 401 Unauthorized:
  • 404 NotFound: Requested HighLevelQuizSummary does not exist.
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "QuizId": "sample string 1",
  "QuizName": "sample string 2",
  "IsGraded": true,
  "NumberOfParticipants": 4,
  "NumberOfAttempts": 5,
  "AverageScore": 6.0,
  "Questions": [
    {
      "QuestionId": "sample string 1",
      "QuestionName": "sample string 2",
      "QuestionOrder": 3,
      "IsGraded": true,
      "AnsweredCorrectlyNumber": 5,
      "AnsweredCorrectlyPercent": 6.0,
      "Answers": [
        {
          "AnswerId": "sample string 1",
          "AnswerName": "sample string 2",
          "AnswerOrder": 3,
          "IsCorrect": true,
          "AnsweredWithNumber": 5,
          "AnsweredWithPercent": 6.0
        },
        {
          "AnswerId": "sample string 1",
          "AnswerName": "sample string 2",
          "AnswerOrder": 3,
          "IsCorrect": true,
          "AnsweredWithNumber": 5,
          "AnsweredWithPercent": 6.0
        }
      ]
    },
    {
      "QuestionId": "sample string 1",
      "QuestionName": "sample string 2",
      "QuestionOrder": 3,
      "IsGraded": true,
      "AnsweredCorrectlyNumber": 5,
      "AnsweredCorrectlyPercent": 6.0,
      "Answers": [
        {
          "AnswerId": "sample string 1",
          "AnswerName": "sample string 2",
          "AnswerOrder": 3,
          "IsCorrect": true,
          "AnsweredWithNumber": 5,
          "AnsweredWithPercent": 6.0
        },
        {
          "AnswerId": "sample string 1",
          "AnswerName": "sample string 2",
          "AnswerOrder": 3,
          "IsCorrect": true,
          "AnsweredWithNumber": 5,
          "AnsweredWithPercent": 6.0
        }
      ]
    }
  ]
}

text/html

Sample: 
{"QuizId":"sample string 1","QuizName":"sample string 2","IsGraded":true,"NumberOfParticipants":4,"NumberOfAttempts":5,"AverageScore":6.0,"Questions":[{"QuestionId":"sample string 1","QuestionName":"sample string 2","QuestionOrder":3,"IsGraded":true,"AnsweredCorrectlyNumber":5,"AnsweredCorrectlyPercent":6.0,"Answers":[{"AnswerId":"sample string 1","AnswerName":"sample string 2","AnswerOrder":3,"IsCorrect":true,"AnsweredWithNumber":5,"AnsweredWithPercent":6.0},{"AnswerId":"sample string 1","AnswerName":"sample string 2","AnswerOrder":3,"IsCorrect":true,"AnsweredWithNumber":5,"AnsweredWithPercent":6.0}]},{"QuestionId":"sample string 1","QuestionName":"sample string 2","QuestionOrder":3,"IsGraded":true,"AnsweredCorrectlyNumber":5,"AnsweredCorrectlyPercent":6.0,"Answers":[{"AnswerId":"sample string 1","AnswerName":"sample string 2","AnswerOrder":3,"IsCorrect":true,"AnsweredWithNumber":5,"AnsweredWithPercent":6.0},{"AnswerId":"sample string 1","AnswerName":"sample string 2","AnswerOrder":3,"IsCorrect":true,"AnsweredWithNumber":5,"AnsweredWithPercent":6.0}]}]}

application/xml, text/xml

Sample: 
<HighLevelQuizSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Questionnaire.Api.Contracts.v1.Models">
  <AverageScore>6</AverageScore>
  <IsGraded>true</IsGraded>
  <NumberOfAttempts>5</NumberOfAttempts>
  <NumberOfParticipants>4</NumberOfParticipants>
  <Questions>
    <HighLevelQuizSummaryQuestion>
      <AnsweredCorrectlyNumber>5</AnsweredCorrectlyNumber>
      <AnsweredCorrectlyPercent>6</AnsweredCorrectlyPercent>
      <Answers>
        <HighLevelQuizSummaryAnswer>
          <AnswerId>sample string 1</AnswerId>
          <AnswerName>sample string 2</AnswerName>
          <AnswerOrder>3</AnswerOrder>
          <AnsweredWithNumber>5</AnsweredWithNumber>
          <AnsweredWithPercent>6</AnsweredWithPercent>
          <IsCorrect>true</IsCorrect>
        </HighLevelQuizSummaryAnswer>
        <HighLevelQuizSummaryAnswer>
          <AnswerId>sample string 1</AnswerId>
          <AnswerName>sample string 2</AnswerName>
          <AnswerOrder>3</AnswerOrder>
          <AnsweredWithNumber>5</AnsweredWithNumber>
          <AnsweredWithPercent>6</AnsweredWithPercent>
          <IsCorrect>true</IsCorrect>
        </HighLevelQuizSummaryAnswer>
      </Answers>
      <IsGraded>true</IsGraded>
      <QuestionId>sample string 1</QuestionId>
      <QuestionName>sample string 2</QuestionName>
      <QuestionOrder>3</QuestionOrder>
    </HighLevelQuizSummaryQuestion>
    <HighLevelQuizSummaryQuestion>
      <AnsweredCorrectlyNumber>5</AnsweredCorrectlyNumber>
      <AnsweredCorrectlyPercent>6</AnsweredCorrectlyPercent>
      <Answers>
        <HighLevelQuizSummaryAnswer>
          <AnswerId>sample string 1</AnswerId>
          <AnswerName>sample string 2</AnswerName>
          <AnswerOrder>3</AnswerOrder>
          <AnsweredWithNumber>5</AnsweredWithNumber>
          <AnsweredWithPercent>6</AnsweredWithPercent>
          <IsCorrect>true</IsCorrect>
        </HighLevelQuizSummaryAnswer>
        <HighLevelQuizSummaryAnswer>
          <AnswerId>sample string 1</AnswerId>
          <AnswerName>sample string 2</AnswerName>
          <AnswerOrder>3</AnswerOrder>
          <AnsweredWithNumber>5</AnsweredWithNumber>
          <AnsweredWithPercent>6</AnsweredWithPercent>
          <IsCorrect>true</IsCorrect>
        </HighLevelQuizSummaryAnswer>
      </Answers>
      <IsGraded>true</IsGraded>
      <QuestionId>sample string 1</QuestionId>
      <QuestionName>sample string 2</QuestionName>
      <QuestionOrder>3</QuestionOrder>
    </HighLevelQuizSummaryQuestion>
  </Questions>
  <QuizId>sample string 1</QuizId>
  <QuizName>sample string 2</QuizName>
</HighLevelQuizSummary>