taler-docs

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

patch-private-groups-GROUP_ID.rst (1169B)

      1 .. http:patch:: [/instances/$INSTANCE]/private/groups/$GROUP_ID
      2 
      3   This is used to update a group.
      4 
      5   **Required permission:** ``groups-write``
      6 
      7   **Request:**
      8 
      9   The request body must be a `GroupPatchRequest`.
     10 
     11   **Response:**
     12 
     13   :http:statuscode:`204 No content`:
     14      The group has successfully modified.
     15   :http:statuscode:`400 Bad Request`:
     16      The group ID parameter is malformed.
     17      Returned with ``TALER_EC_GENERIC_PARAMETER_MALFORMED``.
     18   :http:statuscode:`404 Not found`:
     19      The group or instance is unknown to the backend.
     20      Returned with ``TALER_EC_MERCHANT_GENERIC_PRODUCT_GROUP_UNKNOWN``.
     21   :http:statuscode:`409 Conflict`:
     22      The specified group name is already in use.
     23      Returned with ``TALER_EC_MERCHANT_PRIVATE_PRODUCT_GROUP_CONFLICTING_NAME``.
     24   :http:statuscode:`500 Internal Server Error`:
     25      The server experienced an internal failure.
     26      Returned with ``TALER_EC_GENERIC_DB_STORE_FAILED``.
     27 
     28   **Details:**
     29 
     30   .. ts:def:: GroupPatchRequest
     31 
     32     interface GroupPatchRequest {
     33 
     34       // Unique name for the group (unique per instance).
     35       group_name: string;
     36 
     37       // Description of the group.
     38       description: string;
     39 
     40     }