{"info":{"_postman_id":"bbce6d9f-fcb5-4de3-9357-f43d438b60d9","name":"API Documentation","description":"

Here you can test API for learning-cards.

You must have running local learning-cards

It is configured so it will connect to learning-cards running on localhost.

If you want to try out without installing local try https://www.learn.hajek.live/api in variables

For github project https://github.com/matyash12/learning-cards

Docs autogenerated using postbot. Mistakes can be.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"23011773","collectionId":"bbce6d9f-fcb5-4de3-9357-f43d438b60d9","publishedId":"2s9YkuXxkm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-12-27T15:52:34.000Z"},"item":[{"name":"User","item":[{"name":"Recovery","item":[{"name":"Request recovery link for password","id":"1b88e5f1-e014-4c52-bd98-92edd14d90bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"email","value":"whatever@example.com","type":"text"}]},"url":"https://www.learn.hajek.live/api/recovery/request/password","description":"

This endpoint allows you to send a POST request to initiate a password recovery process. The request should be sent to https://www.learn.hajek.live/api/recovery/request/password.

Request Body

email (text): The email address of the user for whom the password recovery process needs to be initiated.

Response

Status: 200 OK
message: A message indicating the outcome of the request.
data: This field is null in the response.
status: Indicates the status of the request.
code: An integer value representing the status code of the response.

Add documentation

\n","urlObject":{"path":["recovery","request","password"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b88e5f1-e014-4c52-bd98-92edd14d90bf"},{"name":"Create new password","id":"16a0b559-b3b5-49f5-8953-7c81411b7556","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"token","value":"54d9ca5d-7994-4e2a-a697-d3b6720b84fb","type":"text"},{"key":"userid","value":"2","type":"text"},{"key":"password","value":"Password1","type":"text"}]},"url":"https://www.learn.hajek.live/api/recovery/change/password","description":"

This endpoint is used to change the password for account recovery. The HTTP POST request should be made to https://www.learn.hajek.live/api/recovery/change/password. The request payload should be of x-www-form-urlencoded type and include the following parameters:

token (text): The recovery token received via email.
userid (text): The user ID for the account.
password (text): The new password to be set.

The response to the request will have a status code of 200 and will include the following fields:

message: A message indicating the result of the password change process.
data: This field will be null in this response.
status: The status of the operation.
code: A code indicating the result of the password change operation.

\n","urlObject":{"path":["recovery","change","password"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"16a0b559-b3b5-49f5-8953-7c81411b7556"}],"id":"81f54d20-b997-427f-a6a3-f5273c412ff1","description":"

This folder has endpoints for recovering password.

NOTE: You must have configured email

\n","_postman_id":"81f54d20-b997-427f-a6a3-f5273c412ff1"},{"name":"Info about current user","id":"0fdddcfd-a1e1-4d3e-b963-04bf994dd499","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/user/info","description":"

This endpoint makes an HTTP GET request to retrieve user information from the server. The request does not include a request body. The response will have a status code of 200 and will contain a JSON object with the keys \"message\", \"data\", \"status\", and \"code\". The \"data\" object will include \"userId\" and \"authorities\" as its keys.

\n","urlObject":{"path":["user","info"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0fdddcfd-a1e1-4d3e-b963-04bf994dd499"},{"name":"login","id":"990c7ea4-3879-41e0-8426-34f277188c47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"username","value":"Matyas","type":"text","disabled":true},{"key":"email","value":"test@test.com","type":"text"},{"key":"password","value":"yourpassword","type":"text"}]},"url":"https://www.learn.hajek.live/api/user/login","description":"

POST /user/login

This endpoint is used to log in a user.

Request Body

email (text, required): The email of the user.
password (text, required): The password of the user.

Response

Status: 200
message: A message indicating the result of the login attempt.
data: The user data if the login is successful, otherwise null.
status: The status of the response.
code: A code indicating the result of the login attempt.

\n","urlObject":{"path":["user","login"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"990c7ea4-3879-41e0-8426-34f277188c47"},{"name":"Create new user","id":"78f135e8-b6ae-48d3-be07-cafe7a79d4a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"username","value":"whatever","type":"text"},{"key":"email","value":"whatever@example.com","type":"text"},{"key":"password","value":"Password1","type":"text"}]},"url":"https://www.learn.hajek.live/api/user/register","description":"

This endpoint allows you to register a new user. You need to make an HTTP POST request to https://www.learn.hajek.live/api/user/register with the form-data request body type. The request should include the following parameters:

username (text): The username of the new user.
email (text): The email address of the new user.
password (text): The password for the new user.

The response to this request will have a status code of 200 and will include the following fields:

message: A message indicating the result of the registration process.
data: This field will be null in this response.
status: The status of the registration process.
code: A code indicating the result of the registration process.

\n","urlObject":{"path":["user","register"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"78f135e8-b6ae-48d3-be07-cafe7a79d4a9"},{"name":"logout","id":"c710ca21-4ca2-4c84-811d-d7f0d8de5da2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://www.learn.hajek.live/api/user/logout","description":"

This endpoint is used to log out the user. Upon successful execution, it returns a status code of 200 with an empty message and data. The response also includes a status and code. There are no request body parameters for this endpoint.

\n","urlObject":{"path":["user","logout"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c710ca21-4ca2-4c84-811d-d7f0d8de5da2"}],"id":"8b672d8b-1e1f-4464-a8ec-671a686ea7ec","description":"

The /me endpoints let you manage information about the authenticated user.

\n","_postman_id":"8b672d8b-1e1f-4464-a8ec-671a686ea7ec"},{"name":"Export","item":[{"name":"Get string of cards","id":"e74aa08e-42ba-480c-b500-2f5410d62228","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/export/allcardshumanformat","description":"

This endpoint makes an HTTP GET request to retrieve all cards in a human-readable format. The request does not require any payload in the request body.

Response

Status: 200
\n

Body:

  {\n      \"message\": \"\",\n      \"data\": {\n          \"text\": \"\"\n      },\n      \"status\": \"\",\n      \"code\": 0\n  }\n\n

\n","urlObject":{"path":["export","allcardshumanformat"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"e74aa08e-42ba-480c-b500-2f5410d62228"}],"id":"229c1d1a-0b52-4dcc-b6c6-21cd348d36fd","_postman_id":"229c1d1a-0b52-4dcc-b6c6-21cd348d36fd","description":""},{"name":"Card","item":[{"name":"Get card by it's id","event":[{"listen":"test","script":{"id":"7d2b5529-ba71-4b31-a83b-b8a71897c73e","exec":["var template = `","","",""," "," "," "," "," "," "," "," "," "," "," "," "," "," "," "," "," "," "," "," ","

ID	Hidden Part	Visible Part	Mark	Deck Name	User Name	User Email	User Role
{{response.data.id}}	{{response.data.hiddenPart}}	{{response.data.visiblePart}}	{{response.data.mark}}	{{response.data.deckEntity.name}}	{{response.data.deckEntity.tridaEntity.userEntity.username}}	{{response.data.deckEntity.tridaEntity.userEntity.email}}	{{response.data.deckEntity.tridaEntity.userEntity.roles.[0].authority}}

","`;","","function constructVisualizerPayload() {"," return {response: pm.response.json()}","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript"}}],"id":"43671025-33cb-4855-b1d6-59e58d4cc1a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/card/28","description":"

This endpoint makes an HTTP GET request to retrieve information about a specific card with the ID 28. The request does not include a request body.

Response

Status: 200

Body:

{\n  \"message\": \"\",\n  \"data\": {\n    \"id\": 0,\n    \"hiddenPart\": \"\",\n    \"visiblePart\": \"\",\n    \"mark\": 0,\n    \"deckEntity\": {\n      \"id\": 0,\n      \"name\": \"\",\n      \"tridaEntity\": {\n        \"id\": 0,\n        \"name\": \"\",\n        \"userEntity\": {\n          \"id\": 0,\n          \"username\": \"\",\n          \"email\": \"\",\n          \"roles\": [\n            {\n              \"authority\": \"\"\n            }\n          ],\n          \"rolesStr\": \"\"\n        }\n      }\n    },\n    \"status\": \"\",\n    \"code\": 0\n  }\n}\n

This endpoint retrieves detailed information about the card with the ID 28.

\n","urlObject":{"path":["card","28"],"host":["https://www.learn.hajek.live/api"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[],"_postman_id":"43671025-33cb-4855-b1d6-59e58d4cc1a8"},{"name":"Get all cards","event":[{"listen":"test","script":{"id":"5fc49793-3f23-4a4f-a847-cbc4b00d4474","exec":["var template = `","","",""," "," "," "," "," "," "," "," "," "," "," "," "," "," {{#each response.data}}"," "," "," "," "," "," "," "," "," "," "," "," "," {{/each}}","

ID	Hidden Part	Visible Part	Mark	Deck ID	Deck Name	User ID	Username	Email	Role
{{id}}	{{hiddenPart}}	{{visiblePart}}	{{mark}}	{{deckEntity.id}}	{{deckEntity.name}}	{{deckEntity.tridaEntity.id}}	{{deckEntity.tridaEntity.userEntity.username}}	{{deckEntity.tridaEntity.userEntity.email}}	{{deckEntity.tridaEntity.userEntity.roles.[0].authority}}

","`;","","function constructVisualizerPayload() {"," return {response: pm.response.json()}","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript"}}],"id":"d3f3e313-46d9-42bc-bf18-1a990d548c6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/card/all","description":"

This endpoint makes an HTTP GET request to retrieve all card data. The request does not include a request body.

The response to the request returns a status code of 200 along with a JSON object. The JSON object includes a \"message\" field, a \"data\" array containing card information, a \"status\" field, and a \"code\" field. Each card object in the \"data\" array includes an \"id\", \"hiddenPart\", \"visiblePart\", \"mark\", and \"deckEntity\" fields. The \"deckEntity\" includes an \"id\", \"name\", and \"tridaEntity\" with an \"id\", \"name\", and \"userEntity\" with an \"id\", \"username\", \"email\", \"roles\" array, and \"rolesStr\" fields.

\n","urlObject":{"path":["card","all"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"d3f3e313-46d9-42bc-bf18-1a990d548c6c"},{"name":"Create new card","id":"1c93a64e-9844-4f5c-b87e-3df3f44e371f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"hiddenPart","value":"Dog","type":"text"},{"key":"visiblePart","value":"Pes","type":"text"},{"key":"deckid","value":"2","type":"text"},{"key":"hiddenPartImageFile","description":"

image

\n","type":"file","src":"/Users/matyashajek/Downloads/Cat_November_2010-1a.jpg"},{"key":"visiblePartImageFile","description":"

image

\n","type":"file","value":null,"disabled":true}]},"url":"https://www.learn.hajek.live/api/card/new","description":"

This endpoint allows you to create a new card by making an HTTP POST request to https://www.learn.hajek.live/api/card/new. The request should include form-data with the following parameters:

hiddenPart (text) - Description of the hidden part of the card.
visiblePart (text) - Description of the visible part of the card.
deckid (text) - ID of the deck to which the card belongs.

The response to the request will have a status code of 201 and will include the following fields:

message: A message regarding the status of the request.
data: The data related to the new card created.
status: The status of the request.
code: The status code of the response.

\n","urlObject":{"path":["card","new"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1c93a64e-9844-4f5c-b87e-3df3f44e371f"},{"name":"Delete one card by id","id":"9c8bf7d7-50ea-4bb0-8f65-9f986c4f128a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"30","type":"text"}]},"url":"https://www.learn.hajek.live/api/card/delete","description":"

Returns 204 NO CONTENT if it was successfuly deleted

\n","urlObject":{"path":["card","delete"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c8bf7d7-50ea-4bb0-8f65-9f986c4f128a"},{"name":"Update one card","id":"f5776159-0e78-448e-9643-b2cd3c17024e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"32","description":"

required

\n","type":"text"},{"key":"hiddenPart","value":"Dog","type":"text"},{"key":"visiblePart","value":"Pes","type":"text"},{"key":"mark","value":"3","type":"text"},{"key":"deckid","value":"2","type":"text","disabled":true},{"key":"hiddenPartImageFile","type":"file","value":null,"disabled":true},{"key":"visiblePartImageFile","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/matyashajek/Downloads/A_cat.jpeg"],"value":null,"disabled":true},{"key":"hiddenPartImageFileDelete","value":"True","description":"

to delete

\n","type":"text","disabled":true},{"key":"visiblePartImageFileDelete","value":"True","description":"

to delete

\n","type":"text","disabled":true}]},"url":"https://www.learn.hajek.live/api/card/update","description":"

This endpoint is used to update a card via an HTTP POST request to https://www.learn.hajek.live/api/card/update. The request should include a form-data body with the following parameters:

id (required): The ID of the card to be updated.
hiddenPart: The hidden part of the card.
mark: The mark associated with the card.

The response to the request will have a status code of 200 and will include the following fields:

message: A message related to the status of the request.
data: Additional data related to the update, if applicable.
status: The status of the request.
code: A code indicating the status of the request.

\n","urlObject":{"path":["card","update"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5776159-0e78-448e-9643-b2cd3c17024e"},{"name":"Find card by deckid","id":"de254136-b253-4c12-abfe-21b91369e4b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"deckid","value":"2","type":"text"}]},"url":"https://www.learn.hajek.live/api/card/find","description":"

Add Card

This endpoint allows you to find a card using the specified deck ID.

Request

Method: POST
URL: https://www.learn.hajek.live/api/card/find
Body: form-data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Key	Type	Description
deckid	text

Response

Status: 200 OK

{\n    \"message\": \"\",\n    \"data\": [\n        {\n            \"id\": 0,\n            \"hiddenPart\": \"\",\n            \"visiblePart\": \"\",\n            \"mark\": 0,\n            \"deckEntity\": {\n                \"id\": 0,\n                \"name\": \"\",\n                \"tridaEntity\": {\n                    \"id\": 0,\n                    \"name\": \"\",\n                    \"userEntity\": {\n                        \"id\": 0,\n                        \"username\": \"\",\n                        \"email\": \"\",\n                        \"roles\": [\n                            {\n                                \"authority\": \"\"\n                            }\n                        ],\n                        \"rolesStr\": \"\"\n                    }\n                }\n            }\n        }\n    ],\n    \"status\": \"\",\n    \"code\": 0\n}\n\n

\n","urlObject":{"path":["card","find"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"de254136-b253-4c12-abfe-21b91369e4b0"}],"id":"d5d8c637-72d1-4155-91fd-fc7886c57339","_postman_id":"d5d8c637-72d1-4155-91fd-fc7886c57339","description":""},{"name":"Deck","item":[{"name":"Create new deck","id":"b75ace77-12b3-4ed3-8824-8a7b696b47a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Math","type":"text"},{"key":"tridaid","value":"2","type":"text"}]},"url":"https://www.learn.hajek.live/api/deck/new","description":"

Create a New Deck

This endpoint allows you to create a new deck.

Request Body

name (text): The name of the deck.
tridaid (text): The ID of the trida.

Response

Status: 200
message: A message related to the response.
data:
- id: The ID of the created deck.
- name: The name of the created deck.
- tridaEntity:
  - id: The ID of the trida entity.
  - name: The name of the trida entity.
  - userEntity:
    - id: The ID of the user entity.
    - username: The username of the user.
    - email: The email of the user.
    - roles: An array of user roles.
    - rolesStr: A string representation of user roles.
    \n
  \n
\n
status: The status of the response.
code: The status code of the response.

\n","urlObject":{"path":["deck","new"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"b75ace77-12b3-4ed3-8824-8a7b696b47a9"},{"name":"Get deck by deckid","id":"d22a2a2c-e100-4fb2-98ae-02e1dea4d01f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/deck/2","description":"

This endpoint makes an HTTP GET request to retrieve information about a specific deck with ID 2. The response will include data related to the deck, such as its ID, name, and associated user information.

The response will have a status code of 200, indicating a successful request. The response body will contain a JSON object with a message, data, status, and code properties.

The data property will include the ID and name of the deck, as well as additional information about related entities such as tridaEntity and userEntity.

It's important to note that the response may contain empty strings or null values for certain properties.

\n","urlObject":{"path":["deck","2"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"d22a2a2c-e100-4fb2-98ae-02e1dea4d01f"},{"name":"Delete deck by id","id":"e0d2af38-74f7-4bd6-ac65-9d09a80fc538","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","type":"text"}]},"url":"https://www.learn.hajek.live/api/deck/delete","urlObject":{"path":["deck","delete"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"e0d2af38-74f7-4bd6-ac65-9d09a80fc538"},{"name":"Get all decks","id":"072ef417-6e63-41e8-bb56-aa5b6ef34e50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/deck/all","urlObject":{"path":["deck","all"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"072ef417-6e63-41e8-bb56-aa5b6ef34e50"},{"name":"Update deck","id":"fe643b6e-03ee-4b5b-b770-0a64227a8141","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"2","type":"text"},{"key":"name","value":"Fyzika","type":"text"}]},"url":"https://www.learn.hajek.live/api/deck/update","description":"

Update Deck

This endpoint is used to update a deck.

Request Body

id (text) - The ID of the deck to be updated.
name (text) - The new name for the deck.

Response

Status: 200
message - A message indicating the result of the update.
data - The updated data, if applicable.
status - The status of the update.
code - The status code of the response.

\n","urlObject":{"path":["deck","update"],"host":["https://www.learn.hajek.live/api"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[],"_postman_id":"fe643b6e-03ee-4b5b-b770-0a64227a8141"}],"id":"2b5c0762-ad04-49e3-803a-a207a990c9a2","_postman_id":"2b5c0762-ad04-49e3-803a-a207a990c9a2","description":""},{"name":"Trida (class)","item":[{"name":"Create new trida","id":"000af593-6aff-46ba-b4b7-a3ed67e57e4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"matika","type":"text"}]},"url":"https://www.learn.hajek.live/api/tridy/new","description":"

Add New Tridy

This endpoint is used to add a new class.

Request Body

The request should be sent as form-data.
\n
- name (text) - The name of the class.
\n

Response

Upon a successful request, the server returns a status code of 200 with the following response body:

  {\n      \"message\": \"\",\n      \"data\": null,\n      \"status\": \"\",\n      \"code\": 0\n  }\n\n

\n","urlObject":{"path":["tridy","new"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"000af593-6aff-46ba-b4b7-a3ed67e57e4a"},{"name":"Get trida by id","id":"8d69d254-4678-4c36-aec0-c80fe1fb5c79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/tridy/2","description":"

GET /tridy/{id}

This endpoint retrieves information for a specific resource with the ID.

Response

message: A message related to the response.
data
- id: The ID of the resource.
- name: The name of the resource.
- userEntity
  - id: The ID of the user associated with the resource.
  - username: The username of the user.
  - email: The email of the user.
  - roles: An array of roles associated with the user.
    - authority: The authority of a specific role.
    \n
  - rolesStr: A string representation of the user's roles.
  \n
\n
status: The status of the response.
code: The status code of the response.

\n","urlObject":{"path":["tridy","2"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d69d254-4678-4c36-aec0-c80fe1fb5c79"},{"name":"Delete trida","id":"c82dd9a2-7910-43a2-b2e2-68858d2eb51b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"3","type":"text"}]},"url":"https://www.learn.hajek.live/api/tridy/delete","description":"

Returns 204 NO CONTENT if successful

\n","urlObject":{"path":["tridy","delete"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"c82dd9a2-7910-43a2-b2e2-68858d2eb51b"},{"name":"Get all trida","id":"1aa11588-2c56-41f5-bb27-3951fb559dfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/tridy/all","description":"

This endpoint makes an HTTP GET request to retrieve all \"tridy\". The request does not contain a request body.

The response to the last call had a status code of 200 and included a JSON object with a \"message\", \"data\", \"status\", and \"code\" keys. The \"data\" key holds an array of objects, each containing an \"id\", \"name\", and \"userEntity\" object with \"id\", \"username\", \"email\", \"roles\", and \"rolesStr\" keys.

The userEntity object contains information about the user, including their \"id\", \"username\", \"email\", \"roles\", and \"rolesStr\".

\n","urlObject":{"path":["tridy","all"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1aa11588-2c56-41f5-bb27-3951fb559dfa"},{"name":"Update trida","id":"ddcb4bfc-0d78-4fe9-a8d3-db424f2f2d7d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"2","type":"text"},{"key":"name","value":"Fyzika","type":"text"}]},"url":"https://www.learn.hajek.live/api/tridy/update","description":"

This endpoint makes an HTTP POST request to update a resource at the specified URL. The request should include a form-data body with 'id' and 'name' parameters. The 'id' parameter should be of type text, and the 'name' parameter should also be of type text.

The response to the request will have a status code of 200, along with a JSON body containing the keys 'message', 'data', 'status', and 'code'. The 'message' key may contain a descriptive message, the 'data' key may hold the updated resource data, the 'status' key may contain a status description, and the 'code' key may hold a status code.

\n","urlObject":{"path":["tridy","update"],"host":["https://www.learn.hajek.live/api"],"query":[{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[],"_postman_id":"ddcb4bfc-0d78-4fe9-a8d3-db424f2f2d7d"}],"id":"95d3f298-ab0f-4918-b1f3-94f44c485cb3","_postman_id":"95d3f298-ab0f-4918-b1f3-94f44c485cb3","description":""},{"name":"Image","item":[{"name":"Get image","id":"2a15cd80-f2aa-4a98-bbf5-cfddef5389d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/image/2","description":"

This endpoint makes an HTTP GET request to retrieve information about a specific image. The request should be made to https://www.learn.hajek.live/api/image/2.

The response to the last call had a status code of 200 and included a JSON object with the following structure:

{\n    \"message\": \"\",\n    \"data\": {\n        \"id\": 0,\n        \"name\": \"\",\n        \"position\": 0\n    },\n    \"status\": \"\",\n    \"code\": 0\n}\n\n

The \"data\" object contains information about the image, including its ID, name, and position.

\n","urlObject":{"path":["image","2"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"2a15cd80-f2aa-4a98-bbf5-cfddef5389d5"},{"name":"Upload image","id":"052dfd41-03ff-48c5-b447-a2d0b0cfaddc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","src":"/Users/matyashajek/Downloads/799px-A_cat.jpeg"}]},"url":"https://www.learn.hajek.live/api/image/upload","description":"

Deprecated

\n","urlObject":{"path":["image","upload"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"052dfd41-03ff-48c5-b447-a2d0b0cfaddc"},{"name":"Get image by cardid","id":"722d408a-defa-45b0-9bac-027509a7b2c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"cardid","value":"56","type":"text"}]},"url":"https://www.learn.hajek.live/api/image/find","description":"

POST /image/find

This endpoint is used to find an image by card ID.

Request Body

form-data
- cardid (text): The ID of the card to search for.
\n

Response

Status: 200
message (string): A message related to the response.
data (array): An array of objects containing image information.
- id (integer): The ID of the image.
- name (string): The name of the image.
- position (integer): The position of the image.
\n
status (string): The status of the response.
code (integer): The status code of the response.

\n","urlObject":{"path":["image","find"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"722d408a-defa-45b0-9bac-027509a7b2c3"},{"name":"Get all images","id":"2e88e126-5ea0-47a5-9108-730799e7256d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/image/all","description":"

This endpoint retrieves all the images.

No request body is required for this request.

Response

Status: 200
\n

Body:

{\n    \"message\": \"\",\n    \"data\": [\n        {\n            \"id\": 0,\n            \"name\": \"\",\n            \"position\": 0\n        }\n    ],\n    \"status\": \"\",\n    \"code\": 0\n}\n\n

The response includes a message, data array containing image details like id, name, and position, status, and code.

\n","urlObject":{"path":["image","all"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e88e126-5ea0-47a5-9108-730799e7256d"},{"name":"Show image","id":"8d0c9c72-a06a-4bd6-95d2-90acc052caa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/image/show/2","description":"

This endpoint makes an HTTP GET request to retrieve the image with the ID 2. The request does not include a request body. The response will have a status code of 200.

\n","urlObject":{"path":["image","show","2"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d0c9c72-a06a-4bd6-95d2-90acc052caa4"}],"id":"908699e3-9398-4133-858f-8de8d96c45bf","_postman_id":"908699e3-9398-4133-858f-8de8d96c45bf","description":""},{"name":"Learn","item":[{"name":"Learn session","item":[{"name":"Create new session","id":"73282652-0e60-448b-8b0d-90693a98b6ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"deckId","value":"1","type":"text"},{"key":"numberOfCardsInActiveLearning","value":"3","type":"text"}]},"url":"https://www.learn.hajek.live/api/learnsession/new","description":"

Create New Learn Session

This endpoint allows you to create a new learn session.

Request Body

deckId (text): The ID of the deck for the new learn session.
numberOfCardsInActiveLearning (text): The number of cards in active learning for the new session.

Response

Status: 201
Content-Type: application/json

Response Body

{\n    \"message\": \"\",\n    \"data\": {\n        \"id\": 0,\n        \"deckEntity\": {\n            \"id\": 0,\n            \"name\": \"\",\n            \"tridaEntity\": {\n                \"id\": 0,\n                \"name\": \"\",\n                \"userEntity\": {\n                    \"id\": 0,\n                    \"username\": null,\n                    \"email\": \"\",\n                    \"roles\": [\n                        {\n                            \"authority\": \"\"\n                        }\n                    ],\n                    \"rolesStr\": \"\"\n                }\n            }\n        },\n        \"currentIndex\": 0,\n        \"numberOfCardsInActiveLearning\": 0\n    },\n    \"status\": \"\",\n    \"code\": 0\n}\n

\n","urlObject":{"path":["learnsession","new"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"73282652-0e60-448b-8b0d-90693a98b6ca"},{"name":"Update session","id":"b016c61d-9977-4a3f-a4c3-483fe722949a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"sessionId","value":"1","description":"

learnsessionid

\n","type":"text"},{"key":"numberOfCardsInActiveLearning","value":"5","description":"

how many cards you wanna have in \"active learning\"

\n","type":"text"}]},"url":"https://www.learn.hajek.live/api/learnsession/update","description":"

Update Learn Session

This endpoint is used to update a learn session.

Request Body

sessionId (text): The ID of the learn session.
numberOfCardsInActiveLearning (text): The number of cards to have in \"active learning\".

Response

message (string): A message regarding the status of the request.
data (object): The data related to the updated learn session.
status (string): The status of the response.
code (integer): The status code of the response.

\n","urlObject":{"path":["learnsession","update"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"b016c61d-9977-4a3f-a4c3-483fe722949a"},{"name":"Get session","id":"2c1da2f2-e5a8-42cf-b0df-54167a9291e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.learn.hajek.live/api/learnsession/1","description":"

Get Learn Session Details

This endpoint retrieves details of a specific learn session.

Request

Endpoint

GET /learnsession/5

Response

Status: 200
Content-Type: application/json

Response Body

{\n    \"message\": \"\",\n    \"data\": {\n        \"id\": 0,\n        \"deckEntity\": {\n            \"id\": 0,\n            \"name\": \"\",\n            \"tridaEntity\": {\n                \"id\": 0,\n                \"name\": \"\",\n                \"userEntity\": {\n                    \"id\": 0,\n                    \"username\": null,\n                    \"email\": \"\",\n                    \"roles\": [\n                        {\n                            \"authority\": \"\"\n                        }\n                    ],\n                    \"rolesStr\": \"\"\n                }\n            }\n        },\n        \"currentIndex\": 0,\n        \"numberOfCardsInActiveLearning\": 0,\n        \"progress\": 0\n    },\n    \"status\": \"\",\n    \"code\": 0\n}\n\n

This endpoint returns the details of a learn session including the session ID, deck details, user information, current index, number of cards in active learning, and progress.

\n","urlObject":{"path":["learnsession","1"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c1da2f2-e5a8-42cf-b0df-54167a9291e2"}],"id":"d1593c30-4c99-4828-b8af-c52b0b0b4de8","_postman_id":"d1593c30-4c99-4828-b8af-c52b0b0b4de8","description":""},{"name":"Get next card","id":"3224b74c-b0c8-4355-ac67-abce5d57c562","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"id","value":"1","description":"

id of learning session

\n","type":"text"}]},"url":"https://www.learn.hajek.live/api/learn/next","description":"

Add Learning Session

This endpoint allows the user to add a new learning session.

Request Body

id (text, required): The id of the learning session.

Response

Status: 200
Content-Type: application/json
message (string): A message related to the response.
data (object): An object containing details of the learning session.
- id (number): The id of the learning session.
- hiddenPart (string): The hidden part of the learning session.
- visiblePart (string): The visible part of the learning session.
- mark (number): The mark of the learning session.
- deckEntity (object): An object containing details of the deck entity.
  - id (number): The id of the deck entity.
  - name (string): The name of the deck entity.
  - tridaEntity (object): An object containing details of the trida entity.
    - id (number): The id of the trida entity.
    - name (string): The name of the trida entity.
    - userEntity (object): An object containing details of the user entity.
      - id (number): The id of the user entity.
      - username (string): The username of the user entity.
      - email (string): The email of the user entity.
      - roles (array): An array containing roles of the user entity.
        \n
        authority (string): The authority of the role.
        \n
        \n
      - rolesStr (string): String representation of the roles.
      \n
    \n
  \n
\n
status (string): The status of the response.
code (number): The code related to the response.

\n","urlObject":{"path":["learn","next"],"host":["https://www.learn.hajek.live/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"3224b74c-b0c8-4355-ac67-abce5d57c562"}],"id":"1c81c7f9-0908-48d6-a3c6-262ca656c288","_postman_id":"1c81c7f9-0908-48d6-a3c6-262ca656c288","description":""}],"event":[{"listen":"prerequest","script":{"id":"101a2dd4-7caf-445d-bc95-5e5572540446","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3df5369c-5661-4110-bc25-681d1993f287","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"http://localhost/api","disabled":true},{"key":"baseUrl","value":"https://www.learn.hajek.live/api","type":"string"}]}