taler-docs

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

post-private-groups.rst (779B)

      1 .. http:post:: [/instances/$INSTANCES]/private/groups
      2 
      3   This is used to create a group.
      4 
      5   **Required permission:** ``groups-write``
      6 
      7   **Request:**
      8 
      9   The request must be a `GroupAddRequest`.
     10 
     11   **Response:**
     12 
     13   :http:statuscode:`200 OK`:
     14     The backend has successfully added a new group. Returns a `GroupAddedResponse`.
     15 
     16   :http:statuscode:`404 Not found`:
     17     The merchant instance is unknown.
     18 
     19   **Details:**
     20 
     21   .. ts:def:: GroupAddRequest
     22 
     23     interface GroupAddRequest {
     24 
     25       // Unique name for the group (unique per instance).
     26       group_name: string;
     27 
     28       // Description of the group.
     29       description: string;
     30 
     31     }
     32 
     33   .. ts:def:: GroupAddedResponse
     34 
     35     interface GroupAddedResponse {
     36 
     37       // Unique ID for the group.
     38       group_serial_id: Integer;
     39 
     40     }