Skip to content
Jadwigo docs

Lists the playground's authored examples in one language, with their keys.

GET
/api/v1/playground-examples/{language}
curl --request GET \
  --url https://app.jadwigo.pl/api/v1/playground-examples/pl

The one response that carries a key: the playground reviews Jadwigo’s own examples, and Try it looks a free answer up in the key.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
language
required
string
Allowed values: pl en uk

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json
object
examples
required
Array<object>
object
id
required
string
/^lqx_[0-7][0-9a-hjkmnp-tv-z]{25}$/
pod_id
required
string
/^pod_[0-7][0-9a-hjkmnp-tv-z]{25}$/
lesson_question_id
required
string
/^lq_[0-7][0-9a-hjkmnp-tv-z]{25}$/
twin
required
Any of:
string
/^lq_[0-7][0-9a-hjkmnp-tv-z]{25}$/
language
required
string
Allowed values: pl en uk
slug
required
string
/^[a-z0-9]+(-[a-z0-9]+)*$/
position
required
integer
>= 1 <= 9007199254740991
label
required
string
>= 1 characters
showcase
required
boolean
scenarios
required
Array<object>
object
try
required
string
>= 1 characters
value
required
outcome
required
string
Allowed values: correct incorrect
mistake_class
required
Any of:
string
>= 1 characters
marks
required
Array<object>
object
id
required
string
correct
required
boolean
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
questions
required
Array
One of:
object
id
required
string
/^lq_[0-7][0-9a-hjkmnp-tv-z]{25}$/
pod_id
required
string
/^pod_[0-7][0-9a-hjkmnp-tv-z]{25}$/
question_type
required
string
Allowed values: true_false recognition lettered_choice multi_select mark_numbers fraction_compare production short_text expression measure fill_gaps fill_table label_picture column pyramid clock_read money_count order bucket match number_line_place hotspot spatial_build draw_graph clock_set money_pay fraction_shade area_model explain
say
required
string
help
required
object
hints
Array<object>
object
text
required
string
pictures
Array<object>
object
src
required
string
alt
required
string
width
required
number
height
required
number
decorative
boolean
labels
object
range
required
array
>= 2 items <= 2 items
items
required
Array<object>
object
content
required
string
coordinates
required
array
>= 2 items <= 2 items
alignment
required
string
math
boolean
look
object
text
required
string
picture
One of:
object
kind
required
string
Allowed value: image
src
required
string
alt
required
string
width
number
height
number
focus
Array<string>
boost
object
text
required
string
picture
One of:
object
kind
required
string
Allowed value: image
src
required
string
alt
required
string
width
number
height
number
focus
Array<string>
boost_by_mistake
object
key
additional properties
object
text
required
string
picture
One of:
object
kind
required
string
Allowed value: image
src
required
string
alt
required
string
width
number
height
number
focus
Array<string>
give
Array<string>
worked
Array<string>
almost
Array<string>
credit
required
Any of:
object
source
required
string
>= 1 characters
ref
required
string
>= 1 characters
url
string format: uri
licence
required
string
>= 1 characters
original_lang
required
string
Allowed values: pl en uk
checked
required
string format: date
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/
subject
required
string
Allowed values: math polish english
grade
required
Any of:
integer
<= 9007199254740991
skill_ids
required
Array<string>
twin_of
required
Any of:
string
/^lq_[0-7][0-9a-hjkmnp-tv-z]{25}$/
based_on
required
Any of:
object
question
required
string
/^(khan|bank|authored):.+$/
changes
required
Array<object>
object
change
required
string
Allowed values: numbers context wording tutor_notes
why
required
string
reviewed
required
boolean
content_hash
required
string
>= 1 characters
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$/
family
required
string
Allowed value: choose
data
required
object
stem
object
text
string
image
string
image_alt
string
text_replaces_say
boolean
pictures
Array<object>
object
src
required
string
alt
required
string
width
required
number
height
required
number
decorative
boolean
labels
object
range
required
array
>= 2 items <= 2 items
items
required
Array<object>
object
content
required
string
coordinates
required
array
>= 2 items <= 2 items
alignment
required
string
math
boolean
terminal
object
lang
required
string
Allowed value: bash
copy
required
boolean
lines
required
Array<object>
object
cmd
required
string
out
required
Any of:
Array<string>
figure
One of:
object
kind
required
string
Allowed value: expression
text
required
string
reference
object
prompt
required
string
text
required
string
audio
object
clip
required
string
slow
string
audio_text
object
text
required
string
language
required
string
slow
boolean
options
required
Array<object>
object
id
required
string
content
required
One of:
object
kind
required
string
Allowed value: text
text
required
string
letter
string
select
required
string
Allowed values: one many
layout
required
string
Allowed values: list grid binary lettered inline
tokens
string
Allowed values: marked words
line
string
boost
string
key
required
object
correct
required
Array<string>
near
object
key
additional properties
string
worked_solution
Array<string>
why
string

Example 

{
  "examples": [
    {
      "language": "pl",
      "scenarios": [
        {
          "outcome": "correct"
        }
      ]
    }
  ],
  "questions": [
    {
      "question_type": "true_false",
      "help": {
        "hints": [
          {
            "pictures": [
              {
                "decorative": true,
                "labels": {
                  "items": [
                    {
                      "math": false
                    }
                  ]
                }
              }
            ]
          }
        ],
        "look": {
          "picture": {
            "kind": "image"
          }
        },
        "boost": {
          "picture": {
            "kind": "image"
          }
        },
        "boost_by_mistake": {
          "additionalProperty": {
            "picture": {
              "kind": "image"
            }
          }
        }
      },
      "credit": {
        "original_lang": "pl"
      },
      "subject": "math",
      "based_on": {
        "changes": [
          {
            "change": "numbers"
          }
        ]
      },
      "family": "choose",
      "data": {
        "stem": {
          "pictures": [
            {
              "decorative": true,
              "labels": {
                "items": [
                  {
                    "math": false
                  }
                ]
              }
            }
          ],
          "terminal": {
            "lang": "bash"
          },
          "figure": {
            "kind": "expression"
          },
          "audio_text": {
            "slow": true
          }
        },
        "options": [
          {
            "content": {
              "kind": "text"
            }
          }
        ],
        "select": "one",
        "layout": "list",
        "tokens": "marked"
      }
    }
  ]
}

4XX

Section titled “4XX”

An error: {error: {type, message}}. The type names the cause, and answers with one status:

  • 400: BadRequest, ServerFieldSupplied
  • 401: NotSignedIn, Unauthorized
  • 404: NotFound
  • 409: AccountMissing, AttemptClaimed, AttemptPreview, AssignmentClosed, AttemptFinished, AttemptNotFinished, AttemptPaused, QuestionNotOpen, TryOutOfOrder, AnswerConflict, EventIdMismatch, WriteOnce
  • 429: AnswerLimit
  • 502: BankUnavailable
Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: BadRequest ServerFieldSupplied NotSignedIn NotFound AccountMissing AttemptClaimed AttemptPreview AssignmentClosed AttemptFinished AttemptNotFinished AttemptPaused QuestionNotOpen TryOutOfOrder AnswerConflict EventIdMismatch WriteOnce AnswerLimit Unauthorized BankUnavailable
message
required
string

Example 

{
  "error": {
    "type": "BadRequest"
  }
}

5XX

Section titled “5XX”

An error: {error: {type, message}}. The type names the cause, and answers with one status:

  • 400: BadRequest, ServerFieldSupplied
  • 401: NotSignedIn, Unauthorized
  • 404: NotFound
  • 409: AccountMissing, AttemptClaimed, AttemptPreview, AssignmentClosed, AttemptFinished, AttemptNotFinished, AttemptPaused, QuestionNotOpen, TryOutOfOrder, AnswerConflict, EventIdMismatch, WriteOnce
  • 429: AnswerLimit
  • 502: BankUnavailable
Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: BadRequest ServerFieldSupplied NotSignedIn NotFound AccountMissing AttemptClaimed AttemptPreview AssignmentClosed AttemptFinished AttemptNotFinished AttemptPaused QuestionNotOpen TryOutOfOrder AnswerConflict EventIdMismatch WriteOnce AnswerLimit Unauthorized BankUnavailable
message
required
string

Example 

{
  "error": {
    "type": "BadRequest"
  }
}