Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
designAPI-Referenz
GET/v2/design/list/LUT

Öffentliches Vorlage-Design zum Kopieren lesen

Liefert das systemseitige Vorlage-Design mit öffentlicher design-ID, Bootstrap-Zuordnung, Name, Farbe und Buchungswarenkorb-Einstellung. Diese design-ID kann POST /design als data.design verwenden; diese Route listet keine frei wählbaren eigenen Designs.

Operation-ID get_v2_design_list_LUT

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Ja
GET-Verhalten laut Spezifikation

read

02

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.

03

Parameter

Header

languageoptional

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

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

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

200application/json

Nach öffentlicher design-ID indiziertes Objekt mit genau dem System-Vorlage-Design.

application/json

object
success boolean
error boolean | string
error_code string
data object
Schema für zusätzliche Felder
object
id string erforderlich

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

pattern
"^design_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"design_012345abcdef_123456"
bootstrap Typ nicht eingeschränkt erforderlich

Response field from the resource Structure; dynamic values remain unconstrained.

anyOf · Mindestens eine Variante muss passen
Variante 1 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"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

Variante 3 null
Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 39
}
name string erforderlich

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 52
}
color Typ nicht eingeschränkt erforderlich
anyOf · Mindestens eine Variante muss passen
Variante 1 string
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

Feld-Metadaten aus der Spezifikation
{
  "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 boolean erforderlich

Response field from the resource Structure; dynamic values remain unconstrained.

Feld-Metadaten aus der Spezifikation
{
  "x-edoobox-sourceLine": 85
}

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",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
            "examples": [
              "design_012345abcdef_123456"
            ],
            "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID."
          },
          "bootstrap": {
            "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
            "x-edoobox-sourceLine": 39,
            "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": [
                  "bootstrap_012345abcdef_123456"
                ]
              },
              {
                "const": false
              },
              {
                "type": "null"
              }
            ]
          },
          "name": {
            "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
            "x-edoobox-sourceLine": 52,
            "type": "string"
          },
          "color": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "const": 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": {
            "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
            "x-edoobox-sourceLine": 85,
            "type": "boolean"
          }
        },
        "additionalProperties": true,
        "required": [
          "id",
          "bootstrap",
          "name",
          "color",
          "booking_cart_enabled"
        ]
      }
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "design_012345abcdef_123456": {
      "id": "design_012345abcdef_123456",
      "bootstrap": "bootstrap_012345abcdef_123456",
      "name": "Standarddesign",
      "color": "#336699",
      "booking_cart_enabled": false
    }
  }
}
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"
}
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"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Design.php:212getDesign()

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
false
x-edoobox-mutationReview
{
  "source": {
    "file": "application/models/v2/Widgetfunc.php",
    "line": 50
  },
  "reason": "Lookup/configuration catalog reads; template construction uses existing rows only."
}
x-edoobox-runtimeMutationGuard
false
x-edoobox-get-effect
"read"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/07-layout-files.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Design.php",
  "method": "getDesign",
  "line": 212,
  "branch": {
    "file": "application/models/v2/Design.php",
    "line": 217
  }
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
true
x-edoobox-permission
{
  "resource": "design",
  "short": "desi",
  "checkedByDispatcher": true,
  "levels": [
    1,
    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": "get_v2_design_list_LUT",
  "summary": "Öffentliches Vorlage-Design zum Kopieren lesen",
  "description": "Liefert das systemseitige Vorlage-Design mit öffentlicher design-ID, Bootstrap-Zuordnung, Name, Farbe und Buchungswarenkorb-Einstellung. Diese design-ID kann POST /design als data.design verwenden; diese Route listet keine frei wählbaren eigenen Designs.",
  "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"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Nach öffentlicher design-ID indiziertes Objekt mit genau dem System-Vorlage-Design.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "design_012345abcdef_123456": {
                "id": "design_012345abcdef_123456",
                "bootstrap": "bootstrap_012345abcdef_123456",
                "name": "Standarddesign",
                "color": "#336699",
                "booking_cart_enabled": false
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "additionalProperties": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                      "examples": [
                        "design_012345abcdef_123456"
                      ],
                      "description": "Öffentliche v2-ID aus diesem Konto; keine Datenbank-ID."
                    },
                    "bootstrap": {
                      "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                      "x-edoobox-sourceLine": 39,
                      "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": [
                            "bootstrap_012345abcdef_123456"
                          ]
                        },
                        {
                          "const": false
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "name": {
                      "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                      "x-edoobox-sourceLine": 52,
                      "type": "string"
                    },
                    "color": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "const": 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": {
                      "description": "Response field from the resource Structure; dynamic values remain unconstrained.",
                      "x-edoobox-sourceLine": 85,
                      "type": "boolean"
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "id",
                    "bootstrap",
                    "name",
                    "color",
                    "booking_cart_enabled"
                  ]
                }
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "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"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Widgetfunc.php",
      "line": 50
    },
    "reason": "Lookup/configuration catalog reads; template construction uses existing rows only."
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/07-layout-files.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Design.php",
    "method": "getDesign",
    "line": 212,
    "branch": {
      "file": "application/models/v2/Design.php",
      "line": 217
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "design",
    "short": "desi",
    "checkedByDispatcher": true,
    "levels": [
      1,
      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."
  }
}