GET v1/take

Return top level information about a Take

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Take
NameDescriptionTypeAdditional information
ParticipantId

string

None.
StartedUtc

date

None.
IsPreview

boolean

None.
RootSectionId

string

None.
TotalQuestions

integer

None.
PointsPossible

integer

None.
QuizId

string

None.
QuizName

string

None.
CompletionTime

string

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.
FinishedUtc

date

None.
PointsCorrect

integer

None.
Score

decimal number

None.
IsPassed

boolean

None.
CanShowResultsSummary

boolean

None.
RetakeAvailable

boolean

None.
NumberOfRetakesAvailable

integer

None.

Response Codes

  • 200 OK: The top level information about a Take returned successfully
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "ParticipantId": "sample string 1",
  "StartedUtc": "2025-12-11T11:06:20.1893243-06:00",
  "IsPreview": true,
  "RootSectionId": "sample string 3",
  "TotalQuestions": 4,
  "PointsPossible": 5,
  "QuizId": "sample string 6",
  "QuizName": "sample string 7",
  "CompletionTime": "sample string 8",
  "IsGraded": true,
  "PassingScore": 10.0,
  "StartMessage": "sample string 11",
  "PassMessage": "sample string 12",
  "FailMessage": "sample string 13",
  "AllowRetakes": true,
  "NumberOfRetakesAllowed": 1,
  "ThemeId": "sample string 15",
  "FinishedUtc": "2025-12-11T11:06:20.1893243-06:00",
  "PointsCorrect": 16,
  "Score": 17.0,
  "IsPassed": true,
  "CanShowResultsSummary": true,
  "RetakeAvailable": true,
  "NumberOfRetakesAvailable": 1
}

text/html

Sample: 
{"ParticipantId":"sample string 1","StartedUtc":"2025-12-11T11:06:20.1893243-06:00","IsPreview":true,"RootSectionId":"sample string 3","TotalQuestions":4,"PointsPossible":5,"QuizId":"sample string 6","QuizName":"sample string 7","CompletionTime":"sample string 8","IsGraded":true,"PassingScore":10.0,"StartMessage":"sample string 11","PassMessage":"sample string 12","FailMessage":"sample string 13","AllowRetakes":true,"NumberOfRetakesAllowed":1,"ThemeId":"sample string 15","FinishedUtc":"2025-12-11T11:06:20.1893243-06:00","PointsCorrect":16,"Score":17.0,"IsPassed":true,"CanShowResultsSummary":true,"RetakeAvailable":true,"NumberOfRetakesAvailable":1}

application/xml, text/xml

Sample: 
<Take 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>
  <CanShowResultsSummary>true</CanShowResultsSummary>
  <CompletionTime>sample string 8</CompletionTime>
  <FailMessage>sample string 13</FailMessage>
  <FinishedUtc>2025-12-11T11:06:20.1893243-06:00</FinishedUtc>
  <IsGraded>true</IsGraded>
  <IsPassed>true</IsPassed>
  <IsPreview>true</IsPreview>
  <NumberOfRetakesAllowed>1</NumberOfRetakesAllowed>
  <NumberOfRetakesAvailable>1</NumberOfRetakesAvailable>
  <ParticipantId>sample string 1</ParticipantId>
  <PassMessage>sample string 12</PassMessage>
  <PassingScore>10</PassingScore>
  <PointsCorrect>16</PointsCorrect>
  <PointsPossible>5</PointsPossible>
  <QuizId>sample string 6</QuizId>
  <QuizName>sample string 7</QuizName>
  <RetakeAvailable>true</RetakeAvailable>
  <RootSectionId>sample string 3</RootSectionId>
  <Score>17</Score>
  <StartMessage>sample string 11</StartMessage>
  <StartedUtc>2025-12-11T11:06:20.1893243-06:00</StartedUtc>
  <ThemeId>sample string 15</ThemeId>
  <TotalQuestions>4</TotalQuestions>
</Take>