API docs by Redocly

LearnEasy (v0.1.0)

Download OpenAPI specification:

2. Users

createUser

Create a new user.

Request Body schema: application/json
required
registrationCode
required
string = 6 characters

Responses

Request samples

Content type
application/json
{
  • "registrationCode": "string"
}

Response samples

Content type
application/json
{
  • "username": "string"
}

getUser

Get details of a user.

path Parameters
username
required
string

Responses

Response samples

Content type
application/json
Example
{
  • "type": "string",
  • "exerciseProgresses": {
    }
}

deleteUser

Delete a user.

path Parameters
username
required
string

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

3. Subjects

getSubjectsOfUser

Get all subjects of a user.

path Parameters
username
required
string
query Parameters
perPage
integer <int32> [ 5 .. 20 ]
Default: 5
pageNumber
integer <int32> >= 1

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "subjects": [
    ]
}

createSubjectInUser

Create a new subject for a user.

path Parameters
username
required
string
Request Body schema: application/json
required
name
required
string
bookId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "bookId": "710266f4-0087-48f9-97e1-4b13ac48f353"
}

Response samples

Content type
application/json
{
  • "registrationCode": "string"
}

joinSubjectOfUser

Join a subject as a user.

path Parameters
username
required
string
Request Body schema: application/json
required
registrationCode
required
string = 6 characters

Responses

Request samples

Content type
application/json
{
  • "registrationCode": "string"
}

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

getSubjectOfUser

Get details of a subject of a user.

path Parameters
username
required
string
subjectId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "book": {
    }
}

deleteSubjectOfUser

Delete a subject of a user.

path Parameters
username
required
string
subjectId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

getRegistrationCodeOfSubjectOfUser

Get the registration code of a subject of a user.

path Parameters
username
required
string
subjectId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "registrationCode": "string"
}

4. Exercises

getExercisesOfSubjectOfUser

Get all exercises of a subject of a user.

path Parameters
username
required
string
subjectId
required
string <uuid>
query Parameters
perPage
integer <int32> [ 10 .. 100 ]
Default: 50
pageNumber
integer <int32> >= 1

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "exercises": [
    ]
}

createExerciseInSubjectOfUser

Create a new exercise for a subject of a user.

path Parameters
username
required
string
subjectId
required
string <uuid>
Request Body schema: application/json
required
One of
exerciseTemplateId
required
string <uuid>
type
required
string
presentation
string
Enum: "TextAskForeignLanguage" "TextAskNativeLanguage" "TextRandom" "Pairs"
selectedVocabularyWordNumbers
Array of integers <int32> [ items <int32 > ]
numberOfCorrectAnswersForCompletion
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "exerciseTemplateId": "ba726942-509e-4c25-8bde-74e97f667f09",
  • "type": "string",
  • "presentation": "TextAskForeignLanguage",
  • "selectedVocabularyWordNumbers": [
    ],
  • "numberOfCorrectAnswersForCompletion": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

markExerciseOfSubjectOfUserAsSuccessful

Mark an exercise of a subject of a user as successful.

path Parameters
username
required
string
subjectId
required
string <uuid>
exerciseId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ]
}

getExerciseOfSubjectOfUser

Get details of an exercise of a subject of a user.

path Parameters
username
required
string
subjectId
required
string <uuid>
exerciseId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "string",
  • "vocabularyOfChapterExerciseTemplate": {
    },
  • "presentation": "TextAskForeignLanguage",
  • "selectedVocabularyWordNumbers": [
    ],
  • "numberOfCorrectAnswersForCompletion": 0
}

getStatisticsOfExerciseOfSubjectOfUser

Get statistics of an exercise of a subject of a user.

path Parameters
username
required
string
subjectId
required
string <uuid>
exerciseId
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "successfulCompletions": 0
}

1. Books

getBooks

Get all books.

query Parameters
perPage
integer <int32> [ 5 .. 20 ]
Default: 5
pageNumber
integer <int32> >= 1

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "books": [
    ]
}

getExerciseTemplatesOfBook

Get all exercise templates of a book.

path Parameters
bookId
required
string <uuid>
query Parameters
chapter
string
perPage
integer <int32> [ 10 .. 100 ]
Default: 50
pageNumber
integer <int32> >= 1

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "exerciseTemplates": [
    ]
}

getChaptersOfBook

Get all chapters of a book.

path Parameters
bookId
required
string <uuid>
query Parameters
perPage
integer <int32> [ 10 .. 100 ]
Default: 50
pageNumber
integer <int32> >= 1

Responses

Response samples

Content type
application/json
{
  • "maximumPage": 0,
  • "chapters": [
    ]
}