API V3 Recommended
March 27, 2019 – Groups Service API v3 is recommended for production use. v3 includes JSON and has Swagger documentation.
Version 2 supports the authnfactor, classification, membership dependency (dependson), and optin and optout ACLS.
If you are making large membership changes, say more than a few hundred, your experience will be better if you split your activity into adds or deletes of fifty to a hundred members at a time. This tends to give you immediate feedback on successful changes and avoids possible session or connection timeouts.
Warning: This use of POST is deprecated and will not be supported in future API versions.
The Groups v2 API accepts the POST method for two purposes:
URI too long
If your uri would be too long for likely transport to the web service you may enclose it in a POST, with the elements:
<span class="_method"> GET | PUT | DELETE </span> <span class="_uri"> uri </span> |
included in the POST document. The path components of you actual URL must match those in the posted "_uri".
PUT content too big
If your PUT content would be too big for likely transport to the web service you may enclose it in a POST, with the element:
<span class="_method">PUT</span> |
included in the POST document.
Email help@uw.edu to contact the staff in UW-IT who oversee this wiki space and the groups service.
Announcements : Join groups-announce@uw.edu for service announcements.
Discussion : Discuss the service with other customers and users on groups-users@uw.edu.
3 Comments
Ryan H Becker
I don't see any mention of response format on this or the sub-pages - maybe I'm just missing it.
I do have an email exchange from August 2013 in which iam-support stated:
Currently the only response format is XHTML. We have cadrs in our backlog for XML and JSON, but that work hasn't been prioritized yet.
Is that still up-to-date information? Either way, it seems worth "publishing" that information in this wiki space.
Jim Fox
I have not had the opportunity do do much development with the groups
service. However, many of the responses will return plain xml. Try:
Accept: text/xml
Let me know if these would be helpful. I'll try to get them documented.
Until we go to 'v3' xhtml has to stay the default format.
Jim
Ryan H Becker
That works. I don't mind including headers in my request, so changing the default response format isn't particularly significant for my usage. Now, if you wanted to add JSON, that would be lovely, but I can live with xml.
I suppose these comments probably do the job, but
I think you guys should consider adding a brief paragraph describing the supported formats to the actual documentation(update: seeing that you already indicated you would add docs when you have time). I assume I won't be the last person to wonder.Thanks for the reply!