search

davemckain / qtiworks

**This project will be closed in early 2023!** IMS QTI 2.1 assessment delivery engine and Java development library (JQTI+). Supports the MathAssess extensions. Replacement for QTIEngine/JQTI and MathAssessEngine/JQTI. Note that this project has now ended and no further work is currently planned.
Other
67 stars 55 forks source link

REST api #56

Closed carlogaratti closed 7 years ago

carlogaratti commented 9 years ago

Hi all,

my question is very easy: where is the documentation of the Rest API?

Thanks in advance Carlo

davemckain commented 9 years ago

Thanks for your query! The REST stuff is just a basic sketch with very limited functionality and isn't documented well, I'm afraid. If you do want to look at it, take a look at the class Javadoc within:

qtiworks-engine/src/main/java/uk/ac/ed/ph/qtiworks/web/controller/anonymous/SimpleRestRunner.java

NB: I've just tidied this up a bit, and put a reference to it in default.qtiworks-deployment.properties, so you'll want to pull yourself to the head of the master branch first.

The current 'REST' API is limited to anonymously uploading assessments into the system for launching - it's the kind of thing an authoring system might want to use. The API isn't particularly RESTful, though, so I regret calling it that now!

A more useful REST API would be one that lets you control the assessment delivery and rendering. I don't have resources to implement such a thing at present, I'm afraid.

By the way, can you let me know where you heard about the REST API? If it's in my documentation, I should probably play it down a bit so that people aren't too disappointed by the reality of the situation :-)

davemckain commented 7 years ago

Closing this one as it has been dormant for a while.