GET v1/quizzes/{id}
Retrieves a Quiz by their id
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Unique Identifier of the Quiz requested. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The Quiz, if it exists. Otherwise a 404 error.
Quiz| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | string |
None. |
|
| Name | string |
None. |
|
| CompletionTime | string |
None. |
|
| StartDateUtc | date |
None. |
|
| EndDateUtc | date |
None. |
|
| IsGraded | boolean |
None. |
|
| PassingScore | decimal number |
None. |
|
| StartMessage | string |
None. |
|
| PassMessage | string |
None. |
|
| FailMessage | string |
None. |
|
| AllowRetakes | boolean |
None. |
|
| NumberOfRetakesAllowed | integer |
None. |
|
| ThemeId | string |
None. |
|
| RootSectionId | string |
None. |
|
| IsPublished | boolean |
None. |
|
| CanShowResultsSummary | boolean |
None. |
|
| AreSummaryAnswersShown | boolean |
None. |
|
| AreSummaryCorrectAnswersShown | boolean |
None. |
Response Codes
- 200 OK: Requested Quiz successfully returned.
- 401 Unauthorized:
- 404 NotFound: Requested Quiz does not exist.
- 500 InternalServerError:
Response Formats
application/json, text/json
Sample:
{
"Id": "sample string 1",
"Name": "sample string 2",
"CompletionTime": "sample string 3",
"StartDateUtc": "2025-12-11T11:06:20.0018346-06:00",
"EndDateUtc": "2025-12-11T11:06:20.0018346-06:00",
"IsGraded": true,
"PassingScore": 5.0,
"StartMessage": "sample string 6",
"PassMessage": "sample string 7",
"FailMessage": "sample string 8",
"AllowRetakes": true,
"NumberOfRetakesAllowed": 1,
"ThemeId": "sample string 10",
"RootSectionId": "sample string 11",
"IsPublished": true,
"CanShowResultsSummary": true,
"AreSummaryAnswersShown": true,
"AreSummaryCorrectAnswersShown": true
}
text/html
Sample:
{"Id":"sample string 1","Name":"sample string 2","CompletionTime":"sample string 3","StartDateUtc":"2025-12-11T11:06:20.0018346-06:00","EndDateUtc":"2025-12-11T11:06:20.0018346-06:00","IsGraded":true,"PassingScore":5.0,"StartMessage":"sample string 6","PassMessage":"sample string 7","FailMessage":"sample string 8","AllowRetakes":true,"NumberOfRetakesAllowed":1,"ThemeId":"sample string 10","RootSectionId":"sample string 11","IsPublished":true,"CanShowResultsSummary":true,"AreSummaryAnswersShown":true,"AreSummaryCorrectAnswersShown":true}
application/xml, text/xml
Sample:
<Quiz xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Questionnaire.Api.Contracts.v1.Models"> <AllowRetakes>true</AllowRetakes> <AreSummaryAnswersShown>true</AreSummaryAnswersShown> <AreSummaryCorrectAnswersShown>true</AreSummaryCorrectAnswersShown> <CanShowResultsSummary>true</CanShowResultsSummary> <CompletionTime>sample string 3</CompletionTime> <EndDateUtc>2025-12-11T11:06:20.0018346-06:00</EndDateUtc> <FailMessage>sample string 8</FailMessage> <Id>sample string 1</Id> <IsGraded>true</IsGraded> <IsPublished>true</IsPublished> <Name>sample string 2</Name> <NumberOfRetakesAllowed>1</NumberOfRetakesAllowed> <PassMessage>sample string 7</PassMessage> <PassingScore>5</PassingScore> <RootSectionId>sample string 11</RootSectionId> <StartDateUtc>2025-12-11T11:06:20.0018346-06:00</StartDateUtc> <StartMessage>sample string 6</StartMessage> <ThemeId>sample string 10</ThemeId> </Quiz>