GET/v2/membershipplan/{id}/publish-preflight

Veröffentlichungsreife eines Mitgliedschaftsplans prüfen

Prüft Konfiguration, Standardsprache/weitere Kontosprachen, Steuer, Geltungsbereiche, Checkout-Design, Formular, Rechtstexte und Teilnehmerkonto-Widget. ready=false mit issues ist ein erfolgreicher Prüflauf. Die Prüfung selbst ändert keine Pläne oder Designs und benötigt canConfigure.

Operation-ID get_v2_membershipplan_id_publish_preflight

Vertrag & Verhalten

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

GET-Verhalten laut Spezifikation

read

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: membershipplan · mepl
Levels: 1, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Query-Parameter

languageoptional

Gewünschte Textsprache; Fallback Kontosprache, danach vorhandene Sprache.

string

Vollständiges Schema als JSON

{
  "type": "string"
}

Pfadparameter

iderforderlich

Source-reviewed path context; normal dispatcher ownership and permission checks still apply.

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

"membershipplan_012345abcdef_123456"

Vollständiges Schema als JSON

{
  "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": [
    "membershipplan_012345abcdef_123456"
  ]
}

Request Body

Kein Request Body in der Spezifikation beschrieben.

Antworten

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

200application/json

data enthält bei Planauswahl das Preflight-Objekt (ready, issues, design, settings, languages). Auf /list ohne id-Auswahl stattdessen normale Planliste mit total. error=false und success=true.

`application/json`

object

success boolean

error boolean | string

error_code string

data object

id string erforderlich

Öffentliche v2-ID des aktuellen Kontos.

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

version integer erforderlich

ready boolean erforderlich

issues array erforderlich

Array-Elemente

object

key string erforderlich

code string erforderlich

severity string erforderlich

Erlaubte Werte

"error""warning"

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

design object erforderlich

id string | null

Öffentliche v2-ID des aktuellen Kontos.

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

resolved string | null

Öffentliche v2-ID des aktuellen Kontos.

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

customer string | null

Öffentliche v2-ID des aktuellen Kontos.

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

form_configured boolean

legal_texts_active boolean

customer_widget_present boolean

can_add_customer_widget boolean

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

settings Typ nicht eingeschränkt erforderlich

oneOf · Genau eine Variante muss passen

Variante 1 object

form object

design string

Öffentliche v2-ID des aktuellen Kontos.

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

template string

widget string

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

legal object

design string

Öffentliche v2-ID des aktuellen Kontos.

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

template string

widget string

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

customer_widget object | null

design string

Öffentliche v2-ID des aktuellen Kontos.

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

template string

widget string

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

Variante 2 array

maxItems: 0

languages object erforderlich

configured array

Array-Elemente

string

default string

missing array

Array-Elemente

string

required array

Array-Elemente

string

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": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID des aktuellen Kontos."
        },
        "version": {
          "type": "integer"
        },
        "ready": {
          "type": "boolean"
        },
        "issues": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "code": {
                "type": "string"
              },
              "severity": {
                "type": "string",
                "enum": [
                  "error",
                  "warning"
                ]
              }
            },
            "additionalProperties": true,
            "required": [
              "key",
              "code",
              "severity"
            ]
          }
        },
        "design": {
          "type": "object",
          "properties": {
            "id": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID des aktuellen Kontos."
            },
            "resolved": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID des aktuellen Kontos."
            },
            "customer": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID des aktuellen Kontos."
            },
            "form_configured": {
              "type": "boolean"
            },
            "legal_texts_active": {
              "type": "boolean"
            },
            "customer_widget_present": {
              "type": "boolean"
            },
            "can_add_customer_widget": {
              "type": "boolean"
            }
          },
          "additionalProperties": true
        },
        "settings": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "form": {
                  "type": "object",
                  "properties": {
                    "design": {
                      "type": "string",
                      "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID des aktuellen Kontos."
                    },
                    "template": {
                      "type": "string"
                    },
                    "widget": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true
                },
                "legal": {
                  "type": "object",
                  "properties": {
                    "design": {
                      "type": "string",
                      "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID des aktuellen Kontos."
                    },
                    "template": {
                      "type": "string"
                    },
                    "widget": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true
                },
                "customer_widget": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "design": {
                      "type": "string",
                      "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                      "description": "Öffentliche v2-ID des aktuellen Kontos."
                    },
                    "template": {
                      "type": "string"
                    },
                    "widget": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": true
                }
              },
              "additionalProperties": true
            },
            {
              "type": "array",
              "maxItems": 0
            }
          ]
        },
        "languages": {
          "type": "object",
          "properties": {
            "configured": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "default": {
              "type": "string"
            },
            "missing": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "required": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "version",
        "ready",
        "issues",
        "design",
        "settings",
        "languages"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "membershipplan_012345abcdef_123456",
    "version": 1,
    "ready": false,
    "issues": [
      {
        "key": "design",
        "code": "membership_design_not_found",
        "severity": "error"
      }
    ],
    "design": {
      "id": null,
      "resolved": null,
      "customer": null,
      "form_configured": false,
      "legal_texts_active": false,
      "customer_widget_present": false,
      "can_add_customer_widget": false
    },
    "settings": [],
    "languages": {
      "configured": [
        "de"
      ],
      "default": "de",
      "missing": [],
      "required": [
        "de"
      ]
    }
  }
}

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"
}

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Membershipplan.php:23getMembershipplan()

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-routeAliasEvidence

{
  "file": "application/models/v2/Membershipplan.php",
  "line": 33,
  "reason": "Reviewed dispatcher alias: the same literal action/constructor Structure is selected; the third segment supplies ID/filter context or an ignored collection spelling. Domain ownership, required data and model validation remain unchanged."
}

x-edoobox-get-effect

"read"

x-edoobox-get-permission-review

{
  "file": "docs/openapi/reviews/vue-get-permission-03.json",
  "pointer": "/operations/9",
  "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
  "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
}

x-edoobox-mutationReview

{
  "source": {
    "file": "application/models/v2/Membershipplan.php",
    "line": 33,
    "reason": "Exact publish-preflight GET calls forPlan only, not publish/addCustomerWidget."
  },
  "reason": "Compute publication readiness from existing plan, design, translations, widget configuration and fixed legal texts.",
  "review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/9",
    "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  }
}

x-edoobox-runtimeMutationGuard

false

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/01-membership.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Membershipplan.php",
  "method": "getMembershipplan",
  "line": 23,
  "branch": {
    "file": "application/models/v2/Membershipplan.php",
    "line": 33
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

true

x-edoobox-safeForAutomation

true

x-edoobox-permission

{
  "resource": "membershipplan",
  "short": "mepl",
  "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_membershipplan_id_publish_preflight",
  "summary": "Veröffentlichungsreife eines Mitgliedschaftsplans prüfen",
  "description": "Prüft Konfiguration, Standardsprache/weitere Kontosprachen, Steuer, Geltungsbereiche, Checkout-Design, Formular, Rechtstexte und Teilnehmerkonto-Widget. ready=false mit issues ist ein erfolgreicher Prüflauf. Die Prüfung selbst ändert keine Pläne oder Designs und benötigt canConfigure.",
  "tags": [
    "membershipplan"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "query",
      "required": false,
      "description": "Gewünschte Textsprache; Fallback Kontosprache, danach vorhandene Sprache.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "id",
      "in": "path",
      "required": true,
      "schema": {
        "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": [
          "membershipplan_012345abcdef_123456"
        ]
      },
      "description": "Source-reviewed path context; normal dispatcher ownership and permission checks still apply."
    }
  ],
  "responses": {
    "200": {
      "description": "data enthält bei Planauswahl das Preflight-Objekt (ready, issues, design, settings, languages). Auf /list ohne id-Auswahl stattdessen normale Planliste mit total. error=false und success=true.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "membershipplan_012345abcdef_123456",
              "version": 1,
              "ready": false,
              "issues": [
                {
                  "key": "design",
                  "code": "membership_design_not_found",
                  "severity": "error"
                }
              ],
              "design": {
                "id": null,
                "resolved": null,
                "customer": null,
                "form_configured": false,
                "legal_texts_active": false,
                "customer_widget_present": false,
                "can_add_customer_widget": false
              },
              "settings": [],
              "languages": {
                "configured": [
                  "de"
                ],
                "default": "de",
                "missing": [],
                "required": [
                  "de"
                ]
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID des aktuellen Kontos."
                  },
                  "version": {
                    "type": "integer"
                  },
                  "ready": {
                    "type": "boolean"
                  },
                  "issues": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "key": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "severity": {
                          "type": "string",
                          "enum": [
                            "error",
                            "warning"
                          ]
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "key",
                        "code",
                        "severity"
                      ]
                    }
                  },
                  "design": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID des aktuellen Kontos."
                      },
                      "resolved": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID des aktuellen Kontos."
                      },
                      "customer": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID des aktuellen Kontos."
                      },
                      "form_configured": {
                        "type": "boolean"
                      },
                      "legal_texts_active": {
                        "type": "boolean"
                      },
                      "customer_widget_present": {
                        "type": "boolean"
                      },
                      "can_add_customer_widget": {
                        "type": "boolean"
                      }
                    },
                    "additionalProperties": true
                  },
                  "settings": {
                    "oneOf": [
                      {
                        "type": "object",
                        "properties": {
                          "form": {
                            "type": "object",
                            "properties": {
                              "design": {
                                "type": "string",
                                "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                                "description": "Öffentliche v2-ID des aktuellen Kontos."
                              },
                              "template": {
                                "type": "string"
                              },
                              "widget": {
                                "type": "string"
                              }
                            },
                            "additionalProperties": true
                          },
                          "legal": {
                            "type": "object",
                            "properties": {
                              "design": {
                                "type": "string",
                                "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                                "description": "Öffentliche v2-ID des aktuellen Kontos."
                              },
                              "template": {
                                "type": "string"
                              },
                              "widget": {
                                "type": "string"
                              }
                            },
                            "additionalProperties": true
                          },
                          "customer_widget": {
                            "type": [
                              "object",
                              "null"
                            ],
                            "properties": {
                              "design": {
                                "type": "string",
                                "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                                "description": "Öffentliche v2-ID des aktuellen Kontos."
                              },
                              "template": {
                                "type": "string"
                              },
                              "widget": {
                                "type": "string"
                              }
                            },
                            "additionalProperties": true
                          }
                        },
                        "additionalProperties": true
                      },
                      {
                        "type": "array",
                        "maxItems": 0
                      }
                    ]
                  },
                  "languages": {
                    "type": "object",
                    "properties": {
                      "configured": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "default": {
                        "type": "string"
                      },
                      "missing": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      },
                      "required": {
                        "type": "array",
                        "items": {
                          "type": "string"
                        }
                      }
                    },
                    "additionalProperties": true
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "version",
                  "ready",
                  "issues",
                  "design",
                  "settings",
                  "languages"
                ]
              },
              "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-routeAliasEvidence": {
    "file": "application/models/v2/Membershipplan.php",
    "line": 33,
    "reason": "Reviewed dispatcher alias: the same literal action/constructor Structure is selected; the third segment supplies ID/filter context or an ignored collection spelling. Domain ownership, required data and model validation remain unchanged."
  },
  "x-edoobox-get-effect": "read",
  "x-edoobox-get-permission-review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/9",
    "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  },
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Membershipplan.php",
      "line": 33,
      "reason": "Exact publish-preflight GET calls forPlan only, not publish/addCustomerWidget."
    },
    "reason": "Compute publication readiness from existing plan, design, translations, widget configuration and fixed legal texts.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-03.json",
      "pointer": "/operations/9",
      "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
      "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
    }
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/01-membership.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Membershipplan.php",
    "method": "getMembershipplan",
    "line": 23,
    "branch": {
      "file": "application/models/v2/Membershipplan.php",
      "line": 33
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "membershipplan",
    "short": "mepl",
    "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."
  }
}

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.
# cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${PATH_ID:?PATH_ID setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/membershipplan/'"${PATH_ID}"'/publish-preflight' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/membershipplan/{id}/publish-preflight";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
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");
const response = await fetch(url, { method: "GET", headers, 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.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/membershipplan/{id}/publish-preflight"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# 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="GET")
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.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/membershipplan/{id}/publish-preflight";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
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");
const response = await fetch(url, { method: "GET", headers, 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.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/membershipplan/{id}/publish-preflight"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# 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="GET")
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.