POST v1/takes/request-take

Request a Take of a Quiz.

Request Information

URI Parameters

None.

Body Parameters

Includes: QuizId = What Quiz the Take is Requested ParticipantId = Who is Taking the Quiz IsPreview = Whether this is a Preview. Test Previews are not record.

TakeRequest
NameDescriptionTypeAdditional information
QuizId

string

None.
ParticipantId

string

None.
ParticipantMetadata

Dictionary of string [key] and string [value]

None.
IsPreview

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "QuizId": "sample string 1",
  "ParticipantId": "sample string 2",
  "ParticipantMetadata": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "IsPreview": true
}

text/html

Sample: 
{"QuizId":"sample string 1","ParticipantId":"sample string 2","ParticipantMetadata":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"IsPreview":true}

application/xml, text/xml

Sample: 
<TakeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Questionnaire.Api.Contracts.v1.Models">
  <IsPreview>true</IsPreview>
  <ParticipantId>sample string 2</ParticipantId>
  <ParticipantMetadata xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </ParticipantMetadata>
  <QuizId>sample string 1</QuizId>
</TakeRequest>

Response Information

Resource Description

An object with the Take Key. The Take Key is used to Take the Quiz.

RequestTakePostResponse
NameDescriptionTypeAdditional information
TakeKey

globally unique identifier

None.

Response Codes

  • 200 OK: A Take of a Quiz successfully requested.
  • 400 BadRequest: Data validation failed, see the response body for more information.
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "TakeKey": "5842bbbe-390a-481b-8521-7c5dbad455c0"
}

text/html

Sample: 
{"TakeKey":"5842bbbe-390a-481b-8521-7c5dbad455c0"}

application/xml, text/xml

Sample: 
<RequestTakePostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Questionnaire.Api.Contracts.v1.Responses">
  <TakeKey>5842bbbe-390a-481b-8521-7c5dbad455c0</TakeKey>
</RequestTakePostResponse>