taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-private-groups.rst (1225B)

      1 .. http:get:: [/instances/$INSTANCES]/private/groups
      2 
      3   This is used to return all the groups
      4   that are present in our backend.
      5 
      6   **Required permission:** ``groups-read``
      7 
      8   **Request:**
      9 
     10   :query limit: *Optional.*
     11     At most return the given number of results. Negative for descending by ``serial``, positive for ascending by ``serial``. Defaults to ``-20``.
     12   :query offset: *Optional.*
     13     Starting ``serial`` for :ref:`pagination <row-id-pagination>`.
     14 
     15   **Response:**
     16 
     17   :http:statuscode:`200 OK`:
     18     The backend has successfully returned all the groups.
     19     Returns a `GroupsSummaryResponse`.
     20 
     21   :http:statuscode:`404 Not found`:
     22     The backend has does not know about the instance.
     23 
     24   **Details:**
     25 
     26   .. ts:def:: GroupsSummaryResponse
     27 
     28     interface GroupsSummaryResponse {
     29 
     30       // Return groups that are present in our backend.
     31       groups: GroupEntry[];
     32 
     33     }
     34 
     35   The `GroupEntry` object describes a group.
     36   It has the following structure:
     37 
     38   .. ts:def:: GroupEntry
     39 
     40     interface GroupEntry {
     41 
     42       // Group identifier
     43       group_serial: Integer;
     44 
     45       // Unique name for the group (unique per instance).
     46       group_name: string;
     47 
     48       // Description for the group.
     49       description: string;
     50 
     51     }