API for requesting user info

kante / Tangra

Tangra: A web-based tool for administering research studies and tracking participant progress.

1 stars 0 forks source link

API for requesting user info #17

Closed kante closed 10 years ago

kante commented 10 years ago

Finalize and improve the API for requesting user info.

See the code in exe_interface/get_user_data for some example of how we might want to do this

Having a couple of views like /get_completed_stages/ and get_submitted_data/ would cover most cases I think

kante commented 10 years ago

After some thought and experimentation I think I will have the following functionality locked down in the public api:

login
logout

get_current_stage

save_data
save_data_with_key

get_data
get_data_for_key
get_data_for_stage_and_key

upload_file

finish_current_stage

I think this should be general enough to design a wide range of studies without locking down too much functionality

kante commented 10 years ago

Need to decide on a uniform format for returning success/failure and document this for issue #24