OC Only: add ecid, PID, parentWindowOrigin parameter to all API calls

kobotoolbox / enketo-express

We've moved! Please use the new repository 🠊 https://github.com/enketo/enketo-express

Apache License 2.0

102 stars 90 forks source link

OC Only: add ecid, PID, parentWindowOrigin parameter to all API calls #1023

Closed MartijnR closed 6 years ago

MartijnR commented 6 years ago

Do all views (sometimes) use the ecid query parameter?

Should ecid be a required parameter in all API calls?

MartijnR commented 6 years ago

[x] ecid -> required
[x] parentWindowOrigin -> required
[x] PID -> required only for all views that load existing records, optional for all other views
[x] jini -> see settings (if set in config and for all views that it works, but optional for those views)
[ ] Not sure about auth token.

MartijnR commented 6 years ago

[x] let Yogi know when done

MartijnR commented 6 years ago

less than 12 hours

MartijnR commented 6 years ago

[x] Check which of these should be required. It will make manual testing more of a pain but add robustness to the API.
[x] why is PID added? Enketo doesn't pass this info back to OC, I think.
[x] add to documentation

MartijnR commented 6 years ago

[x] loadWarning (if not already done)
[x] goToErrorUrl (if not already done)

MartijnR commented 6 years ago

Hi @yogi-oc,

The latest Enketo Express master now has the updated API as discussed a few weeks ago. There should be no more need to manipulate webform URLs on the OC side. Yay. The only exception is the authentication token (let me know if I should add that to API and anything I may have forgotten).

See updated API Documentation: https://github.com/OpenClinica/enketo-express-oc/blob/master/doc/oc-api.md

Some of the new API parameters are required (ecid, pid), so this means OC integration is now broken until the API calls are changed on the OC side.

MartijnR commented 6 years ago

all is good

pbowen-oc commented 6 years ago

This is addressed further in #1085