Get a singleplayer quiz share

Get a singleplayer quiz share

GET /api/v1/share/{shareId}

Get a singleplayer quiz share

cURL

curl --request GET \
  --url http://localhost:8787/api/v1/share/{shareId}

200

{
  "quiz": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "topic": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "passingScore": 123,
    "documentId": 123,
    "type": "<string>",
    "createdAt": "<string>",
    "language": "<string>",
    "userScore": 123,
    "correctAnswersCount": 123,
    "questionsCount": 123,
    "roomId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "totalTimeTaken": 123,
    "passed": true,
    "createdBy": "<string>",
    "generatedTags": [
      "<string>"
    ],
    "generatedCategories": [
      "<string>"
    ],
    "embedding": [
      123
    ]
  },
  "shareId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shareUrl": "<string>",
  "isPublic": true,
  "isAnonymous": true,
  "type": "<string>",
  "multiplayerSubmission": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "quizId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "roomId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userScore": 123,
    "correctAnswersCount": 123,
    "createdAt": "<string>"
  }
}

Path Parameters

shareId · string<uuid> · required

Response

200 - application/json

Quiz share retrieved successfully

quiz · object · required

Show child attributes

shareId · string<uuid> · required

shareUrl · string<uri> · required

isPublic · boolean · required

isAnonymous · boolean · required

type · string · required

multiplayerSubmission · object

Show child attributes