Sign in
GameContent

Get Game Contents

Changed on

Get all Game Contents for given category and level with a certain number of words

get/game-contents

Request

  • Base URL: http://localhost:8080/api/v1
  • URL: http://localhost:8080/api/v1/game-contents
  • Auth: none declared

Query parameters

theme_idstring uuid

Theme ID associated with the game's contents

theme_weekinteger

Theme Week associated with the game's contents

category'receptive_language' | 'expressive_language' | 'social_pragmatic_language' | 'speech'

The category associated with the game

question_type'sequencing' | 'following_directions' | 'wh_questions' | 'true_false' | 'concepts_sorting' | 'fill_in_the_blank' | 'categorical_language' | 'emotions' | 'teamwork_talk' | 'express_excitement_interest' | 'fluency' | 'articulation_s' | 'articulation_l'

The type of question being asked in the game

difficulty_levelinteger

The difficulty level of the game

question_countinteger

Refers to the number of questions that should be returned through sampling

words_countinteger

The number of words that need to be retrieved as correct answer and wrong options

exercise_type'game' | 'pdf'

The type of exercise for which content is being requested (game or pdf)

applicable_game_typesstring[]

The applicable game types for which content is being requested

Response

The Game Content (corresponding category and level)

idstring uuid required

ID of a Game Content.

theme_idstring uuid required

The UUID of the Theme associated with the game's content

weekinteger required

The Week of the Content in the session

category'receptive_language' | 'expressive_language' | 'social_pragmatic_language' | 'speech' required

The category of the game

question_type'sequencing' | 'following_directions' | 'wh_questions' | 'true_false' | 'concepts_sorting' | 'fill_in_the_blank' | 'categorical_language' | 'emotions' | 'teamwork_talk' | 'express_excitement_interest' | 'fluency' | 'articulation_s' | 'articulation_l' required

The type of the question being asked in the game

difficulty_levelinteger required

The corresponding level of content for this game's content

questionstring required

The question being asked in the game

optionsstring[] required

The list of wrong-words that are given for the game.

answerstring required

The answer to the game (presigned URL)

exercise_type'game' | 'pdf' required

The exercise type of the game content

applicable_game_typesstring[] required

The list of applicable game types for this content

raw_answerstring

The raw answer to the game.

presigned_optionsstring[] required

The list of wrong-words that are given for the game.

created_atstring date-time required

When the game-content was created

updated_atstring date-time required

When the game-content was last updated

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "theme_id": "123e4567-e89b-12d3-a456-426614174001",
    "week": 2,
    "category": "speech",
    "question_type": "fluency",
    "difficulty_level": 4,
    "question": "What type of reptile is Swampy?",
    "options": [
      "Crocorokodile",
      "Krookodile",
      "Koorkodile"
    ],
    "answer": "Crocodile",
    "exercise_type": "game",
    "applicable_game_types": [
      "drag and drop",
      "spinner"
    ],
    "presigned_options": [
      "Crocorokodile",
      "Krookodile",
      "Koorkodile"
    ],
    "created_at": "2025-09-13T17:19:00Z",
    "updated_at": "2025-09-13T17:19:00Z"
  }
]

Changes

  • fe7d8f76957bRevision changes
    • ○

      added the new optional query request parameter theme_week

  • 528ef41356abRevision changes
    • ●

      added the new multi-match enum value to the // response property for the response status

    • ○

      added the enum value multi-match to the property items/ of the query request parameter applicable_game_types