Comments on FormListing

[Jørn Klungsøyr]

Hi,

 

I assume voting on FormListing is coming (even if mHealthSummit is over… J), so here are some comments:

 

1.       Some references to authentication, should be to the AuthenticationAPI, e.g. last line before Successful Response: “and must be able to authenticate with the server during this transaction, if required by the server.”

2.       Add an optional request parameter to list all versions of a form <listAllVersions>, which can be set to true or false (default is false if not set). In a response with ListAllVersions=true there could be an optional integer? <sequence> element. If present, that would be an indication of numeric sequence and can be used by the client to determine this.

3.       Would it be problematic  to allow the <xforms-group> to actually contain a full list of forms, and not requiring to go via a <listURL>? Could possibly support both modes.

4.        Background section should be removed as that is implementation/tool specific information (and the openmrs one is in addition not legal per the authenticationAPI….).

 

Have a great weekend!

Best regards,

Jørn

 

____________________________________________________________________________
Jorn Klungsoyr
openXdata - Centre for International Health, University of Bergen, Norway
www.openxdata.org / www.cih.uib.no / www.openrosa.org / www.open-mobile.org
Mobile: +4791365731, Skype/GoogleTalk: jornklung Alternative email: jorn.kl...@gmail.com
Post: Postboks 7800, 5020 Bergen, Visit: Årstadveien 21, 5th Floor, Bergen
                       ------¤¤¤¤------

 

[Anton de Winter]

Ok,  I did some work, see in-line responses:

1.       Some references to authentication, should be to the AuthenticationAPI, e.g. last line before Successful Response: “and must be able to authenticate with the server during this transaction, if required by the server.”

I think most of them are now gotten.  If you spot any feel free to edit and make the relevant link to the correct document though. 

2.       Add an optional request parameter to list all versions of a form <listAllVersions>, which can be set to true or false (default is false if not set). In a response with ListAllVersions=true there could be an optional integer? <sequence> element. If present, that would be an indication of numeric sequence and can be used by the client to determine this.

I added this parameter to the document  but left out the <sequence> part.  It was shot down in the chat.  This is hard since our version schema (from the MetaData API) is just a string, and how it's decided which form is newer (on the server side) is implementation specific.  On the plus side, the version is given for each form in the FormList response document, so the client can display that information and have the user decide which form to download/open.

 

3.       Would it be problematic  to allow the <xforms-group> to actually contain a full list of forms, and not requiring to go via a <listURL>? Could possibly support both modes.

I think the case that's being made here is the less information to download the better.  If there are tens/hundreds of forms available, the download could get large. 

 

4.        Background section should be removed as that is implementation/tool specific information (and the openmrs one is in addition not legal per the authenticationAPI….).

Good point.  I've created a new document on the wiki:  Historical FormList implementations (Pre OR 1.0 APIs) :D

 

Have a great weekend!

Best regards,

Jørn

 

____________________________________________________________________________
Jorn Klungsoyr
openXdata - Centre for International Health, University of Bergen, Norway
www.openxdata.org / www.cih.uib.no / www.openrosa.org / www.open-mobile.org
Mobile: +4791365731, Skype/GoogleTalk: jornklung Alternative email: jorn.kl...@gmail.com
Post: Postboks 7800, 5020 Bergen, Visit: Årstadveien 21, 5th Floor, Bergen
                       ------¤¤¤¤------

 

--
Anton de Winter

Dimagi Inc

(617) 692 0786

529 Main St

Charlestown, MA

02129