Skip to content
Jadwigo docs

Reads an attempt: its plan and everything asked so far.

GET
/api/v1/attempts/{id}
curl --request GET \
  --url https://app.jadwigo.pl/api/v1/attempts/example

No sign-in: the attempt id is the access, and whoever holds it may use it.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
/^att_[0-7][0-9a-hjkmnp-tv-z]{25}$/

Responses

Section titled “Responses”

200

Section titled “200”

OK.

Media typeapplication/json
object
attempt
required
object
id
required
string
/^att_[0-7][0-9a-hjkmnp-tv-z]{25}$/
pod_id
required
string
/^pod_[0-7][0-9a-hjkmnp-tv-z]{25}$/
assignment_id
required
string
/^asg_[0-7][0-9a-hjkmnp-tv-z]{25}$/
lesson_version_id
required
string
/^lesv_[0-7][0-9a-hjkmnp-tv-z]{25}$/
learner_id
required
Any of:
string
/^lrn_[0-7][0-9a-hjkmnp-tv-z]{25}$/
player_name
required
string | null
mode
required
string
Allowed values: real preview
status
required
string
Allowed values: in_progress paused finished
resume_at
required
Any of:
integer
>= 1 <= 9007199254740991
started_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))$/
finished_at
required
Any of:
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))$/
claimed_by
Any of:
string
/^acc_[0-7][0-9a-hjkmnp-tv-z]{25}$/
claimed_at
Any of:
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))$/
moved_by
Any of:
string
/^acc_[0-7][0-9a-hjkmnp-tv-z]{25}$/
moved_at
Any of:
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))$/
plan
required
Array<object>
object
position
required
integer
>= 1 <= 9007199254740991
lesson_question_id
required
string
/^lq_[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
question
required
One of:
object
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
questions
required
Array<object>
object
seq
required
integer
>= 1 <= 9007199254740991
lesson_question_id
required
string
/^lq_[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
question
required
One of:
object
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
added
required
string
Allowed values: planned twin
placed
required
Any of:
string
Allowed values: now review_round
added_for
required
Any of:
integer
>= 1 <= 9007199254740991
help_released
required
integer
<= 9007199254740991
help
required
Array<object>
object
rung
required
integer
>= 1 <= 4
card
required
Any of:
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>
focus
required
Array<string>
given
required
Any of:
object
key
additional properties
worked
required
Any of:
Array<string>
blank
required
boolean
hints
required
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
tries
required
integer
<= 9007199254740991
ended
required
Any of:
string
Allowed values: correct skipped missed done
asked_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))$/
open_seq
required
Any of:
integer
>= 1 <= 9007199254740991
last_event_id
required
Any of:
string
/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/

Example 

{
  "attempt": {
    "mode": "real",
    "status": "in_progress"
  },
  "plan": [
    {
      "question_type": "true_false",
      "question": {
        "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"
        }
      }
    }
  ],
  "questions": [
    {
      "question_type": "true_false",
      "question": {
        "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"
        }
      },
      "added": "planned",
      "placed": "now",
      "help": [
        {
          "card": {
            "picture": {
              "kind": "image"
            }
          },
          "hints": [
            {
              "pictures": [
                {
                  "decorative": true,
                  "labels": {
                    "items": [
                      {
                        "math": false
                      }
                    ]
                  }
                }
              ]
            }
          ]
        }
      ],
      "ended": "correct"
    }
  ]
}

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"
  }
}