designAPI-Referenz

PUT/v2/design

Buchungsdesign ändern

Ändert Name, Bootstrap-Zuordnung, Farbe oder Buchungswarenkorb-Einstellung eines bestehenden Buchungsdesigns. Ein nicht leeres data mit mindestens einem unterstützten Änderungsfeld ist erforderlich.

Operation-ID put_v2_design

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON

{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}

accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON

{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

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.

Ressource: design · desi
Levels: 3, 4
Dispatcher-Prüfung: Ja

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

X-Edoobox-If-Revisionoptional

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.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

erforderlich

`application/json`

object

data object erforderlich

Source-declared fields; action-specific and account validation still apply.

minProperties: 1

id kein Wert zulässig

bootstrap string

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.

pattern: "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"bootstrap_012345abcdef_123456"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 39
}

name Typ nicht eingeschränkt bei Anlage erforderlich

Kanonischer Typ nach Normalisierung: string. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

Maximal gespeicherte Länge: 200. Diese Speichergrenze ist keine maxLength-Validierung der Eingabe.

The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.

Schema-Beispiel

"Example"

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string",
  "x-edoobox-maxStoredLength": 200,
  "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
  "x-edoobox-requiredOnCreate": true,
  "x-edoobox-sourceLine": 52
}

color Typ nicht eingeschränkt

Canonical #RGB/#RRGGBB. Also accepts unprefixed 4/7 hex chars; strings of other lengths clear. Length 4/7 nonhex rejects. Not equivalent to strict CSS hex regex. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints. false or string length other than 4/7 -> empty aP string. At length4/7, hexadecimal after ltrim(all leading #) is required; nonhex returns false. Empty output -> false. Runtime preconditions / rejection: Length4/7 nonhex text returns strict false -> ED80100.

Kanonischer Typ nach Normalisierung: string or false. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

2 Schema-Beispiele

"#a1b"

false

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-canonicalType": "string or false",
  "x-edoobox-schemaStatus": "source-reviewed",
  "x-edoobox-contractSource": [
    {
      "file": "application/models/v2/Design.php",
      "line": 65,
      "lineStart": 65,
      "lineEnd": 84,
      "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8",
      "spanSha256": "771000c8566835f13d6d1779f5f4cc536ea201dea6a35b330d16edcbcf6550a5",
      "reason": "Structure getter, output setter and field flags."
    },
    {
      "file": "application/helpers/edooboxhelp_helper.php",
      "line": 11560,
      "lineStart": 11560,
      "lineEnd": 11606,
      "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
      "spanSha256": "2172cc49e4bcdb6840448b62929037cb9b90c299da3cb6fb0be6a8782881750f",
      "reason": "aP text normalization and aQ output. 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/Design.php",
      "line": 117,
      "lineStart": 117,
      "lineEnd": 139,
      "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8",
      "spanSha256": "e42660c8c4b9e9274c064605ffdad60d0943bf78a429ecde1334840e2696d01f",
      "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"
    }
  ]
}

booking_cart_enabled Typ nicht eingeschränkt

Kanonischer Typ nach Normalisierung: boolean. Dies ist keine zusätzliche Einschränkung des Eingabetyps.

PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.

Schema-Beispiel

false

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-schemaStatus": "source-inferred",
  "x-edoobox-sourceLine": 85,
  "x-edoobox-canonicalType": "boolean",
  "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction."
}

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Feld-Metadaten aus der Spezifikation

{
  "x-edoobox-readOnlyFields": [],
  "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 string erforderlich

Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.

pattern: "^design_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"design_012345abcdef_123456"

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": false,
        "bootstrap": {
          "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": [
            "bootstrap_012345abcdef_123456"
          ],
          "x-edoobox-schemaStatus": "source-inferred",
          "x-edoobox-sourceLine": 39
        },
        "name": {
          "x-edoobox-canonicalType": "string",
          "x-edoobox-maxStoredLength": 200,
          "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
          "examples": [
            "Example"
          ],
          "x-edoobox-requiredOnCreate": true,
          "x-edoobox-sourceLine": 52
        },
        "color": {
          "description": "Canonical #RGB/#RRGGBB. Also accepts unprefixed 4/7 hex chars; strings of other lengths clear. Length 4/7 nonhex rejects. Not equivalent to strict CSS hex regex. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nfalse or string length other than 4/7 -> empty aP string. At length4/7, hexadecimal after ltrim(all leading #) is required; nonhex returns false. Empty output -> false.\n\nRuntime preconditions / rejection: Length4/7 nonhex text returns strict false -> ED80100.",
          "x-edoobox-canonicalType": "string or false",
          "x-edoobox-schemaStatus": "source-reviewed",
          "examples": [
            "#a1b",
            false
          ],
          "x-edoobox-contractSource": [
            {
              "file": "application/models/v2/Design.php",
              "line": 65,
              "lineStart": 65,
              "lineEnd": 84,
              "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8",
              "spanSha256": "771000c8566835f13d6d1779f5f4cc536ea201dea6a35b330d16edcbcf6550a5",
              "reason": "Structure getter, output setter and field flags."
            },
            {
              "file": "application/helpers/edooboxhelp_helper.php",
              "line": 11560,
              "lineStart": 11560,
              "lineEnd": 11606,
              "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
              "spanSha256": "2172cc49e4bcdb6840448b62929037cb9b90c299da3cb6fb0be6a8782881750f",
              "reason": "aP text normalization and aQ output. 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/Design.php",
              "line": 117,
              "lineStart": 117,
              "lineEnd": 139,
              "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8",
              "spanSha256": "e42660c8c4b9e9274c064605ffdad60d0943bf78a429ecde1334840e2696d01f",
              "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"
            }
          ]
        },
        "booking_cart_enabled": {
          "x-edoobox-schemaStatus": "source-inferred",
          "x-edoobox-sourceLine": 85,
          "x-edoobox-canonicalType": "boolean",
          "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
          "examples": [
            false
          ]
        }
      },
      "additionalProperties": true,
      "description": "Source-declared fields; action-specific and account validation still apply.",
      "minProperties": 1,
      "x-edoobox-readOnlyFields": [],
      "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": "^design_[a-f0-9]{12}_-?[0-9]+$",
      "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
      "examples": [
        "design_012345abcdef_123456"
      ]
    }
  },
  "additionalProperties": true,
  "required": [
    "data",
    "id"
  ]
}

Buchungsdesign ändern

{
  "data": {
    "name": "Sommerdesign"
  },
  "id": "design_012345abcdef_123456"
}

Antworten

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

data.id bezeichnet das Objekt, data.update zeigt an, ob sich ein Feld geändert hat.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`application/json`

object

success boolean

error boolean | string

error_code string

data object

id string erforderlich

Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.

pattern: "^design_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"design_012345abcdef_123456"

update boolean erforderlich

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

type string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
          "examples": [
            "design_012345abcdef_123456"
          ]
        },
        "update": {
          "type": "boolean"
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "update"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "design_012345abcdef_123456",
    "update": true
  }
}

400application/json

Invalid request.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40006"
}

401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40103"
}

402application/json

Missing/invalid action data or subscription/operation restriction.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80100"
}

403application/json

Permission denied. Browser CORS rejection may have an empty body.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED40340"
}

404application/json

Unknown resource/action or unsupported method.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80019"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED80020"
}

429application/json

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.

Response Header

`Retry-After`

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "30"
  ]
}

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED42902"
}

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel

{
  "success": false,
  "error": "ED50201"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Design.php:134updateDesign()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state

true

x-edoobox-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/07-layout-files.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Design.php",
  "method": "updateDesign",
  "line": 134
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "design",
  "short": "desi",
  "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."
}

Vollständige Operation als JSON

{
  "operationId": "put_v2_design",
  "summary": "Buchungsdesign ändern",
  "description": "Ändert Name, Bootstrap-Zuordnung, Farbe oder Buchungswarenkorb-Einstellung eines bestehenden Buchungsdesigns. Ein nicht leeres data mit mindestens einem unterstützten Änderungsfeld ist erforderlich.",
  "tags": [
    "design"
  ],
  "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": "data.id bezeichnet das Objekt, data.update zeigt an, ob sich ein Feld geändert hat.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "design_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": "^design_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
                    "examples": [
                      "design_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,
                "bootstrap": {
                  "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": [
                    "bootstrap_012345abcdef_123456"
                  ],
                  "x-edoobox-schemaStatus": "source-inferred",
                  "x-edoobox-sourceLine": 39
                },
                "name": {
                  "x-edoobox-canonicalType": "string",
                  "x-edoobox-maxStoredLength": 200,
                  "x-edoobox-normalization": "The aP getter trims text, replaces newlines and limits the legacy escaped storage representation to maxStoredLength UTF-8 characters without splitting escape pairs; aQ decodes the stored representation. Non-string input becomes empty text. This getter limit is normalization, not a rejecting input maxLength or proof of a custom action hook or database column capacity.",
                  "examples": [
                    "Example"
                  ],
                  "x-edoobox-requiredOnCreate": true,
                  "x-edoobox-sourceLine": 52
                },
                "color": {
                  "description": "Canonical #RGB/#RRGGBB. Also accepts unprefixed 4/7 hex chars; strings of other lengths clear. Length 4/7 nonhex rejects. Not equivalent to strict CSS hex regex. Canonical representations are shown; other PHP scalar coercions are not presented as rejection constraints.\n\nfalse or string length other than 4/7 -> empty aP string. At length4/7, hexadecimal after ltrim(all leading #) is required; nonhex returns false. Empty output -> false.\n\nRuntime preconditions / rejection: Length4/7 nonhex text returns strict false -> ED80100.",
                  "x-edoobox-canonicalType": "string or false",
                  "x-edoobox-schemaStatus": "source-reviewed",
                  "examples": [
                    "#a1b",
                    false
                  ],
                  "x-edoobox-contractSource": [
                    {
                      "file": "application/models/v2/Design.php",
                      "line": 65,
                      "lineStart": 65,
                      "lineEnd": 84,
                      "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8",
                      "spanSha256": "771000c8566835f13d6d1779f5f4cc536ea201dea6a35b330d16edcbcf6550a5",
                      "reason": "Structure getter, output setter and field flags."
                    },
                    {
                      "file": "application/helpers/edooboxhelp_helper.php",
                      "line": 11560,
                      "lineStart": 11560,
                      "lineEnd": 11606,
                      "sha256": "090d351b5bde81813c7a829bedf2f1f9f978fce5765f246989779f996198934e",
                      "spanSha256": "2172cc49e4bcdb6840448b62929037cb9b90c299da3cb6fb0be6a8782881750f",
                      "reason": "aP text normalization and aQ output. 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/Design.php",
                      "line": 117,
                      "lineStart": 117,
                      "lineEnd": 139,
                      "sha256": "30fc7f721958cb19e4ae31703698687fff67518d807af84f591f3526d2ef3fd8",
                      "spanSha256": "e42660c8c4b9e9274c064605ffdad60d0943bf78a429ecde1334840e2696d01f",
                      "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"
                    }
                  ]
                },
                "booking_cart_enabled": {
                  "x-edoobox-schemaStatus": "source-inferred",
                  "x-edoobox-sourceLine": 85,
                  "x-edoobox-canonicalType": "boolean",
                  "x-edoobox-normalization": "PHP coercion/normalization is applied by the Structure getter; its return type is not a rejecting wire-input type restriction.",
                  "examples": [
                    false
                  ]
                }
              },
              "additionalProperties": true,
              "description": "Source-declared fields; action-specific and account validation still apply.",
              "minProperties": 1,
              "x-edoobox-readOnlyFields": [],
              "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": "^design_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID. Beispiel ist synthetisch.",
              "examples": [
                "design_012345abcdef_123456"
              ]
            }
          },
          "additionalProperties": true,
          "required": [
            "data",
            "id"
          ]
        },
        "examples": {
          "request": {
            "summary": "Buchungsdesign ändern",
            "value": {
              "data": {
                "name": "Sommerdesign"
              },
              "id": "design_012345abcdef_123456"
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/07-layout-files.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Design.php",
    "method": "updateDesign",
    "line": 134
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "design",
    "short": "desi",
    "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."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
cat > payload.json <<'EDOOBOX_JSON_EXAMPLE'
{
  "data": {
    "name": "Sommerdesign"
  },
  "id": "design_012345abcdef_123456"
}
EDOOBOX_JSON_EXAMPLE
curl --request 'PUT' \
  --url "${API_ORIGIN%/}"'/v2/design' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: application/json' \
  --data-binary '@payload.json'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/design";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "name": "Sommerdesign"
  },
  "id": "design_012345abcdef_123456"
});
const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/design"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"name\":\"Sommerdesign\"},\"id\":\"design_012345abcdef_123456\"}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="PUT", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/design";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
headers['Content-Type'] = "application/json";
const body = JSON.stringify({
  "data": {
    "name": "Sommerdesign"
  },
  "id": "design_012345abcdef_123456"
});
const response = await fetch(url, { method: "PUT", headers, body, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# Request Body: synthetisches Beispiel aus der Spezifikation; Werte und Vollständigkeit vor Verwendung prüfen.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/design"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = "application/json"
body = "{\"data\":{\"name\":\"Sommerdesign\"},\"id\":\"design_012345abcdef_123456\"}".encode("utf-8")

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="PUT", data=body)
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.