Page History

...

Grouper Web Services

Introduction

Grouper web services (grouper-ws) is a J2EE web application which exposes common Grouper business logic REST.  See Web Services FAQ. and architectural diagram.

...

1. Understand the object model.  All grouper-ws services are operations based on simple data structures.  The structures support Strings, ints, arrays, and structure references.
   1. Core web service API
   2. Example structure (only "getters" and "setters" are applicable properties)
   3. Each operation has many samples (automated captures, versioned, and up to date).  Here is an example
   4. Most options has a sensible default (e.g. MemberFilter defaults to All members)
   5. Lookup objects in various (consistent) ways.  e.g. to delete a group, you can pass the name or uuid of the group.
2. You should use JSON/REST only even though other options are available.
3. Each operation has two levels of complexity, the normal one, and the Lite one.
   1. Normal operation: can usually be batched (support a list of inputs, e.g. add multiple groups at once), supports complex inputs (arrays or structures)
   2. Lite operation: supports only inputs of scalars (no structures, no arrays... only Strings, ints, etc).  In REST this also means that the request can be sent via query string only
4. Decide what format you want to send and receive data.  grouper-ws supports JSON, as well as query strings for input (in URL or message body)
   1. For example, in the URL you can set the content type you want back:

...

.NET client development guide

Operations

Guidelines For Working With Grouper Web Services

...