Skip to content

Formation API

Liam Boudadi edited this page Feb 5, 2025 · 19 revisions

Listing existing formations

GET / (gets all in-memory formations details)

Parameters

None

Responses

http code content-type response
200 json [{"id": {int}, "name": {string}, "description": {string}}, ...]

Example cURL

 curl -L -X GET 'http://localhost:8080/formation/formations' -H 'Authorization: Bearer {jwt}'

Listing details of the requested formation

GET / (gets details about the formation requested)

Parameters

name type data type description
None required int formation id

Responses

http code content-type response
200 json {"id": {int}, "name": {string}, "description": {string}}
404 N/A

Example cURL

 curl -L -X GET 'http://localhost:8080/formation/{id}' -H 'Authorization: Bearer {jwt}'

Listing existing quizzes

GET / (gets all in-memory quizzes details)

Parameters

None

Responses

http code content-type response
200 json [{"id": {int}, "json": {string}}, ...]

Example cURL

 curl -L -X GET 'http://localhost:8080/formation/quiz' -H 'Authorization: Bearer {jwt}'

Listing details of the requested quiz

GET / (gets details about the quiz requested)

Parameters

name type data type description
None required int quiz id

Responses

http code content-type response
200 json {"id": {int}, "json": {string}}
404 N/A

Example cURL

 curl -L -X GET 'http://localhost:8080/formation/quiz/{id}' -H 'Authorization: Bearer {jwt}'

Clone this wiki locally