Kategorie aktualisieren

{
  "operationId": "put_v2_category",
  "summary": "Kategorie aktualisieren",
  "description": "Ändert die übergebenen schreibbaren Felder in data für Kategorie. Die Ziel-ID muss als id im JSON-Umschlag angegeben werden.",
  "tags": [
    "category"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "Ergebnis in data mit den beschriebenen Feldern; error und die Ergebniskennzeichen müssen ausgewertet werden.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "category_012345abcdef_123456",
              "update": true
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                    "examples": [
                      "category_012345abcdef_123456"
                    ]
                  },
                  "update": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "update"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "data": {
              "type": "object",
              "properties": {
                "id": false,
                "name": false,
                "row_lft": false,
                "row_rgt": false,
                "order": false,
                "image": false,
                "category": false,
                "type": false,
                "design": {
                  "anyOf": [
                    {
                      "type": "string",
                      "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
                      "examples": [
                        "design_012345abcdef_123456"
                      ]
                    },
                    {
                      "const": false
                    },
                    {
                      "type": "null"
                    }
                  ],
                  "x-edoobox-schemaStatus": "source-inferred",
                  "x-edoobox-sourceLine": 172
                },
                "internal_code": {
                  "x-edoobox-canonicalType": "string",
                  "description": "aP(...,true,40) trims, flattens line breaks, escapes and truncates strings; nonstrings become empty. Longer input is not rejected.\n\nString normalized to at most 40 characters after escaping. Category propagates to descendants; both disable firmaConnect.\n\nRuntime preconditions / rejection: Nonempty code requires subscription internal_function; absence emits ED40240. Missing/wrong-kind resource: category callback false -> ED90100; offer throws offer_not_found.",
                  "x-edoobox-schemaStatus": "source-reviewed",
                  "examples": [
                    "INTERNAL-SAMPLE",
                    ""
                  ],
                  "x-edoobox-contractSource": [
                    {
                      "file": "application/models/v2/Category.php",
                      "line": 188,
                      "lineStart": 188,
                      "lineEnd": 197,
                      "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45",
                      "spanSha256": "b9cc8df6ed7c8b88c9502b24e5a2d80c31b50d6c8c147413d3017e2fcce84c4d",
                      "reason": "Structure getter, output setter and field flags."
                    },
                    {
                      "file": "application/models/v2/Categoryfunc.php",
                      "line": 19,
                      "lineStart": 19,
                      "lineEnd": 77,
                      "sha256": "dd87dd957aef94579c4884c9fc846477cfb33cdac923a22a4885ad995871751c",
                      "spanSha256": "71831f2331b841d77fd50063ba1b55109814f8917f9b1fb9e39a81165b4d2c1c",
                      "reason": "func delegates to _internal_code"
                    },
                    {
                      "file": "application/helpers/edooboxhelp_helper.php",
                      "line": 11560,
                      "lineStart": 11560,
                      "lineEnd": 11577,
                      "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
                      "spanSha256": "47b45db25b5ed86673fe43c17c7d716427b0d86011b1ba918d19eebc39907fd1",
                      "reason": "Actual aP normalization; no rejecting maxLength. Reviewed aP update preserves legacy encoded storage and aQ read semantics. Truncation removes a dangling final escape backslash rather than creating a broken SQL literal; it remains normalization, not a rejecting raw input maxLength."
                    },
                    {
                      "file": "application/models/v2/Edsubscription/Edsubscriptionverification.php",
                      "line": 45,
                      "lineStart": 45,
                      "lineEnd": 71,
                      "sha256": "723114d7051c7917de61d4cc28f26acef144a985b6077ccaefb0052f4c4b78dd",
                      "spanSha256": "c9425ad19c85e68c6bc57eacc00cebd71d4e624b76013e116afd1cadcd87b7e8",
                      "reason": "Runtime subscription feature rejection."
                    },
                    {
                      "file": "application/models/v2/Category.php",
                      "line": 268,
                      "lineStart": 268,
                      "lineEnd": 303,
                      "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45",
                      "spanSha256": "3b64150dba0beb6abedf5061f2b9e11f36159e56028ca8e00171a15d93302784",
                      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                    },
                    {
                      "file": "application/models/v2/Category.php",
                      "line": 373,
                      "lineStart": 373,
                      "lineEnd": 394,
                      "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45",
                      "spanSha256": "6ed1a2030b3f277a83ece5878a285d06b4a16597da58e1ae03fb27fe5f35f27c",
                      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                    },
                    {
                      "file": "docs/openapi/reviews/domain-fields.json",
                      "line": 1,
                      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                      "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667"
                    }
                  ]
                },
                "prevent_multiple_bookings": {
                  "x-edoobox-recognizedValues": [
                    "status",
                    "gender",
                    "first_name",
                    "last_name",
                    "street",
                    "postcode",
                    "location",
                    "country",
                    "language",
                    "phone_number",
                    "email",
                    "company",
                    "data_1",
                    "data_2",
                    "data_3",
                    "data_4",
                    "data_5",
                    "data_6",
                    "data_7",
                    "data_8",
                    "data_9",
                    "data_10",
                    "data_11",
                    "data_12",
                    "data_13",
                    "data_14",
                    "data_15",
                    "data_16",
                    "data_17",
                    "data_18",
                    "data_19",
                    "data_20",
                    "data_21",
                    "data_22",
                    "data_23",
                    "data_24",
                    "data_25",
                    "data_26",
                    "data_27",
                    "data_28",
                    "data_29",
                    "data_30"
                  ],
                  "description": "false clears; recognized participant-data key maps to its DB column. Unknown string returns null rather than explicit rejection. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nFalsy input -> empty DB text. Known key -> Datastructure column. Unknown key falls through null. Empty output -> false; known column -> public key; unmapped nonempty -> null.",
                  "x-edoobox-canonicalType": "string or false",
                  "x-edoobox-schemaStatus": "source-reviewed",
                  "examples": [
                    "email",
                    false
                  ],
                  "x-edoobox-contractSource": [
                    {
                      "file": "application/models/v2/Category.php",
                      "line": 198,
                      "lineStart": 198,
                      "lineEnd": 220,
                      "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45",
                      "spanSha256": "101039fe8703832f5080f0af566ed7113ce1b2584974b72c122f070794ea90c6",
                      "reason": "Structure getter, output setter and field flags."
                    },
                    {
                      "file": "application/models/v2/Datastructure.php",
                      "line": 20,
                      "lineStart": 20,
                      "lineEnd": 126,
                      "sha256": "256cfd2c1002e4708b342b6649fa6bfda780273306c30ae2a43d424fd0e2e6a8",
                      "spanSha256": "e0b745f0330dae128c01bcc320aa6dc4429d391260fee2e2d6964a611041e2a9",
                      "reason": "Known participant keys plus data_1..data_30 generation and returnStructure."
                    },
                    {
                      "file": "application/models/v2/Category.php",
                      "line": 268,
                      "lineStart": 268,
                      "lineEnd": 303,
                      "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45",
                      "spanSha256": "3b64150dba0beb6abedf5061f2b9e11f36159e56028ca8e00171a15d93302784",
                      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                    },
                    {
                      "file": "application/models/v2/Category.php",
                      "line": 373,
                      "lineStart": 373,
                      "lineEnd": 394,
                      "sha256": "43e78dafbef58fdc0de2a46c4a9831d7615225c221164d9c5a0f6fabc7fc9e45",
                      "spanSha256": "6ed1a2030b3f277a83ece5878a285d06b4a16597da58e1ae03fb27fe5f35f27c",
                      "reason": "Actual resource dispatch and generic writer reachability; action branches are distinct."
                    },
                    {
                      "file": "docs/openapi/reviews/domain-fields.json",
                      "line": 1,
                      "reason": "Independent field-level source review, direction applicability, examples and explicit runtime limitations.",
                      "sha256": "0da1cbbf108a5871b54204c3c76aaf59dabf85a6886bfb38210136885cfc1667"
                    }
                  ]
                },
                "archive": false,
                "trash": false
              },
              "additionalProperties": true,
              "description": "Source-declared fields; action-specific and account validation still apply.",
              "minProperties": 1,
              "x-edoobox-readOnlyFields": [
                "name",
                "row_lft",
                "row_rgt",
                "order",
                "image",
                "category",
                "type",
                "archive",
                "trash"
              ],
              "x-edoobox-clientRestriction": "Read-only fields are forbidden by this client contract to prevent silently ignored writes; the legacy API itself skips them. Explicit source-marked update context fields remain accepted for hook validation without changing their immutable database columns."
            },
            "id": {
              "type": "string",
              "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
              "examples": [
                "category_012345abcdef_123456"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data",
            "id"
          ]
        },
        "examples": {
          "request": {
            "summary": "Kategorie aktualisieren",
            "value": {
              "data": {
                "design": "design_012345abcdef_123456"
              },
              "id": "category_012345abcdef_123456"
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/03-offers-places.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Category.php",
    "method": "updateCategory",
    "line": 373
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "category",
    "short": "ctgy",
    "checkedByDispatcher": true,
    "levels": [
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}