http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 --- Comment #1 from Robin Sheat <robin@catalyst.net.nz> --- Created attachment 35455 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=35455&action=edit Bug 13607: patron management API This provides a patron management API. It allows a remote service to: * add patrons * update patron details * delete patrons It presents a simple POST-based API and returns its results as XML. This API supports fields available in the borrower table, and extended attribute types also. Full documentation will be on a wiki page linked to from the bug. To test: * construct a sequence of API requests, make sure it works. * ensure that no side effects of these changes came about, particularly dealing with unrelated things (default_messageprefs.pl, sco-patron-image.pl, systempreferences.) -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 Robin Sheat <robin@catalyst.net.nz> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |Needs Signoff --- Comment #2 from Robin Sheat <robin@catalyst.net.nz> --- Documentation of the API is currently here: http://wiki.koha-community.org/wiki/Talk:Koha_/svc/_HTTP_API#Patron_Manageme... -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |martin.renvoize@ptfs-europe | |.com --- Comment #4 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Hi Robin, A much needed feature.. but I'm not 100% I agree with the implementation. I think we should really be attempting to follow restful best practice. Personally, I would: Use POST for the create operation only Use PUT for the update operation (possibly with your current implementation in here 'update or create' use DELETE for the delete operation only use GET for retrieving patron records use json (or xml) bodies to actually move the data around.. The above would bring us much more in line with the rest of the modern world. Parsing XML is hard in the browser, and such an API should be designed for maximum flexibility, i.e to be simply used in as many environments as possible.. including the browser. Anywho.. If I get the time, I might submit an alternative patch.. if not I'll go ahead and test this.. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 --- Comment #6 from Robin Sheat <robin@catalyst.net.nz> --- (In reply to Jonathan Druart from comment #3)

Hi Robin, Did you have a look at koha-restful? It seems it does the same job as this patch.

https://git.biblibre.com/biblibre/koha-restful

I didn't because I didn't see it in koha, so I didn't really know it existed or what it could do. (In reply to Martin Renvoize from comment #4)

Use POST for the create operation only Use PUT for the update operation (possibly with your current implementation in here 'update or create'

You don't always know if you're creating or updating from a membership management system thing. Hence upsert. Which is a word, look in wikipedia :)

use DELETE for the delete operation only use GET for retrieving patron records use json (or xml) bodies to actually move the data around..

Some of these verbs are (I think, though I haven't checked) harder to use from a browser.

The above would bring us much more in line with the rest of the modern world. Parsing XML is hard in the browser, and such an API should be designed for maximum flexibility, i.e to be simply used in as many environments as possible.. including the browser.

a) if you use things like DELETE and PUT, IIRC they're hard to use from a browser (I might be wrong, that used the be the case though), b) with the changes I added to C4::Service you can add switching to JSON easily ... but then you still need XML to authenticate. It's silly to mix technologies like that (even though they are already mixed, at least you can do user management using all one thing), c) the intention of this isn't really to work from a browser, but to add integration to things like salesforce that manage users. (In reply to Martin Renvoize from comment #5)

Also... have you seen Jesse's work on Koha::Service?

https://github.com/pianohacker/koha/commit/ 40908d6e58c40e6ffaa488266a70ef5233fe9642

I hadn't, again, it's not in Koha so I didn't know it existed. At a (very quick) glance, it looks to be a definite improvement over the original C4::Service, but as it is, too much stuff is being crammed into C4::Service. My first impression of that is that it needs to be split up. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 --- Comment #7 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- I wasn't disputing upsert as a word.. more that in my experience it's the PUT method that used for it: http://stackoverflow.com/questions/7297578/correct-http-method-for-restful-c... gives a farily concise reasoning. As for the lack of browser support.. I can now having googled it see where your coming from on this.. It's not the browsers so much as the html versions. Pretty much all browser will support the requests via javascript, but it would seem the HTML 4.01 and XHTML 1.0 both only support GET and POST as Form submission methods. Hmm, this one does then need some thought applying. Your other points are all valid.. What I'm thinking here, as you've already put the work in, is to sign off on this as it stands and let it progress into koha. However, I hope to deprecate the /svc namespace at some point and push for a nice concise set of restful routes (including a patrons route). Some thoughts regarding this discussion can be found on the recently created wiki page: http://wiki.koha-community.org/wiki/New_REST_API_RFC and we hope to get a bit of a group together at the next hackfest. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |http://bugs.koha-community. | |org/bugzilla3/show_bug.cgi? | |id=12598 -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Failed QA --- Comment #10 from Magnus Enger <magnus@enger.priv.no> --- I did some basic exercising of the API calls with the attached script, and it seems to work as advertised. Yay! * Minor problem: - The POD (synopsis and description) in C4/Output/XMLStream.pm seems to mix up XML and JSON a bit. * Major problem: - EnhancedMessagingPreferences = allow - Create a new patron from scratch - Change the category from the default one - Firebug reports a 500 error for /cgi-bin/koha/members/default_messageprefs.pl The actual error reported: Software error: Can't use string ("C4::Service") as a HASH ref while "strict refs" in use at /home/vagrant/kohaclone/C4/Service.pm line 262. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 --- Comment #11 from Magnus Enger <magnus@enger.priv.no> --- If I try to include one of the B_* fields in my borrower data, I get this : <response> <status>failed</status> <type>data</type> <message>Invalid fieldname provided: B_address </message> </response> Probably because of this line: die "Invalid fieldname provided (update): $f\n" if $f =~ /[^A-Za-z0-9]/; Also, the "message" in the response would look better without the trailing newline, I think. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 --- Comment #12 from Robin Sheat <robin@catalyst.net.nz> --- Created attachment 35737 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=35737&action=edit Bug 13607: fix to account for _ in fieldnames -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 Magnus Enger <magnus@enger.priv.no> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Failed QA --- Comment #14 from Magnus Enger <magnus@enger.priv.no> --- This problem from comment 10 is still a problem: * Major problem: - EnhancedMessagingPreferences = allow - Create a new patron from scratch - Change the category from the default one - Firebug reports a 500 error for /cgi-bin/koha/members/default_messageprefs.pl The actual error reported: Software error: Can't use string ("C4::Service") as a HASH ref while "strict refs" in use at /home/vagrant/kohaclone/C4/Service.pm line 262. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 --- Comment #15 from Robin Sheat <robin@catalyst.net.nz> --- Created attachment 36148 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=36148&action=edit Bug 13607: fix to set default messaging preferences -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 Marc Véron <veron@veron.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |veron@veron.ch -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 --- Comment #17 from Robin Sheat <robin@catalyst.net.nz> --- Created attachment 36356 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=36356&action=edit Bug 13607: correct handling of dateexpiry and dateenrolled With this patch: * if a dateexpiry is not provided, it is generated based on the category. * if a dateenrolled is not provided, it is generated based on 'now'. This applies when a user is created only. -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 --- Comment #18 from Mirko Tietgen <mirko@abunchofthings.net> --- I have played with this a little and I like it. Works for me so far, will try to break it some more. I think userid (for account login) is automatically created from 'firstname'.'surname' if not explicitly given (in the staff client), I wonder if that should be the same here for consinstency (personally I don't mind). -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 --- Comment #20 from Robin Sheat <robin@catalyst.net.nz> --- Created attachment 37353 --> http://bugs.koha-community.org/bugzilla3/attachment.cgi?id=37353&action=edit Bug 13607: test cases fixes -- You are receiving this mail because: You are watching all bug changes.

http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=13607 jdemuth@roseville.ca.us <jdemuth@roseville.ca.us> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jdemuth@roseville.ca.us -- You are receiving this mail because: You are watching all bug changes.