GET/v2/membershipplan/list

Mitgliedschaftspläne suchen

Liest Pläne mit Preisen, Rabatten, Geltungsbereich und aktiver Kundenzahl. JSON-Filter mit property/value; AND zwischen Eigenschaften, OR zwischen Enum-Werten. status (draft/internal/published/archived), validity_type, duration_unit, discount_type, scope_type akzeptieren String oder Stringliste. Weitere Felder: assignable, name, name_match (contains/starts_with/equals), search (Name/Beschreibung), sale_currency_iso, auto_renew_allowed (0/1/bool), valid_from/valid_until (Überlappung nur fixed_range). Grenzen *_min/*_max für sale_price, discount_value, included_uses, duration_value, active_customer_count. Numerische Grenzen akzeptieren Zahl oder numerischen String; ungültige Werte ergeben membership_invalid_filter. id wählt statt einer Liste ein Einzelobjekt. Pagination per limit, total vor Pagination. fields und response_type ändern die feste Ausgabe nicht.

Operation-ID get_v2_membershipplan_list

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

filteroptional

JSON-Filter mit property/value; AND zwischen Eigenschaften, OR zwischen Enum-Werten. status (draft/internal/published/archived), validity_type, duration_unit, discount_type, scope_type akzeptieren String oder Stringliste. Weitere Felder: assignable, name, name_match (contains/starts_with/equals), search (Name/Beschreibung), sale_currency_iso, auto_renew_allowed (0/1/bool), valid_from/valid_until (Überlappung nur fixed_range). Grenzen *_min/*_max für sale_price, discount_value, included_uses, duration_value, active_customer_count. Numerische Grenzen akzeptieren Zahl oder numerischen String; ungültige Werte ergeben membership_invalid_filter. id wählt statt einer Liste ein Einzelobjekt.

`application/json`

array

Array-Elemente

object

property string erforderlich

value Typ nicht eingeschränkt erforderlich

expression string

Bei diesen Ressourcen ignoriert; Auswahl erfolgt anhand von property/value.

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

Vollständiges Schema als JSON

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "value": {},
      "expression": {
        "type": "string",
        "description": "Bei diesen Ressourcen ignoriert; Auswahl erfolgt anhand von property/value."
      }
    },
    "additionalProperties": true,
    "required": [
      "property",
      "value"
    ]
  }
}

Beispiel

[
  {
    "property": "status",
    "value": [
      "published",
      "internal"
    ]
  }
]

limitoptional

JSON-Objekt mit start (Offset) und reply (Seitengröße, 1–500); alternativ eine Zahl. Standard reply=100. Größere Werte werden begrenzt; negative Offsets auf 0 gesetzt.

`application/json`

Typ nicht eingeschränkt

oneOf · Genau eine Variante muss passen

Variante 1 object

start integer

minimum: 0

Standardwert: 0

reply integer

minimum: 1
maximum: 500

Standardwert: 100

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

Variante 2 integer

minimum: 1
maximum: 500

Vollständiges Schema als JSON

{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "start": {
          "type": "integer",
          "minimum": 0,
          "default": 0
        },
        "reply": {
          "type": "integer",
          "minimum": 1,
          "maximum": 500,
          "default": 100
        }
      },
      "additionalProperties": true
    },
    {
      "type": "integer",
      "minimum": 1,
      "maximum": 500
    }
  ]
}

Beispiel

{
  "start": 0,
  "reply": 25
}

orderoptional

Sortierung nach updated_at, created_at, status, validity_type, sale_price, discount_value, sort_order, name oder active_customer_count; value/direction ASC/DESC. Ungültige Klauseln werden ignoriert. Standard sort_order ASC, danach stabile ID-Reihenfolge.

`application/json`

array

Array-Elemente

object

property string

field string

value string

direction string

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

Vollständiges Schema als JSON

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "field": {
        "type": "string"
      },
      "value": {
        "type": "string"
      },
      "direction": {
        "type": "string"
      }
    },
    "additionalProperties": true
  }
}

Beispiel

[
  {
    "property": "name",
    "value": "ASC"
  }
]

languageoptional

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

string

Vollständiges Schema als JSON

{
  "type": "string"
}

idoptional

Einzelobjekt über id auswählen; alternativ gleichnamiger Eintrag im JSON-filter.

string

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

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

Schema-Beispiel

"membershipplan_012345abcdef_123456"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.",
  "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 das dokumentierte Ergebnisobjekt; error=false und success=true.

`application/json`

object

success boolean

error boolean | string

error_code string

data Typ nicht eingeschränkt

oneOf · Genau eine Variante muss passen

Variante 1 array

Array-Elemente

object

id string erforderlich

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

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

version integer erforderlich

status string erforderlich

Erlaubte Werte

"draft""internal""published""archived"

name string erforderlich

description_html string erforderlich

language string erforderlich

validity object erforderlich

type string

Erlaubte Werte

"fixed_range""relative_duration""usage_count"

from integer | null

until integer | null

value integer | null

unit string | null

uses integer | null

promo_code_redemption boolean

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

discount object erforderlich

type string

Erlaubte Werte

"percent""fixed"

value string

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern: "^-?[0-9]+\\.[0-9]{2}$"

currency string | null

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

sale object erforderlich

amount string

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern: "^-?[0-9]+\\.[0-9]{2}$"

currency string

vat string | null

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

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

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

publication object erforderlich

design string | null

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

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

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

renewal object erforderlich

allowed boolean

default boolean

reminder_days integer

duration_value integer | null

duration_unit string | null

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

allow_parallel_instances boolean erforderlich

active_customer_count integer erforderlich

sort_order integer erforderlich

internal_reference string erforderlich

scopes array erforderlich

Array-Elemente

object

type string erforderlich

Erlaubte Werte

"root""category""offer"

resource string | null

v2 category-/offer-ID; bei root null.

id string

Eingabealias für resource.

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

published_at integer | null erforderlich

archived_at integer | null erforderlich

created_at integer erforderlich

updated_at integer erforderlich

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

Variante 2 object

id string erforderlich

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

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

version integer erforderlich

status string erforderlich

Erlaubte Werte

"draft""internal""published""archived"

name string erforderlich

description_html string erforderlich

language string erforderlich

validity object erforderlich

type string

Erlaubte Werte

"fixed_range""relative_duration""usage_count"

from integer | null

until integer | null

value integer | null

unit string | null

uses integer | null

promo_code_redemption boolean

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

discount object erforderlich

type string

Erlaubte Werte

"percent""fixed"

value string

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern: "^-?[0-9]+\\.[0-9]{2}$"

currency string | null

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

sale object erforderlich

amount string

Dezimalbetrag als String mit zwei Nachkommastellen.

pattern: "^-?[0-9]+\\.[0-9]{2}$"

currency string

vat string | null

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

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

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

publication object erforderlich

design string | null

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

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

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

renewal object erforderlich

allowed boolean

default boolean

reminder_days integer

duration_value integer | null

duration_unit string | null

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

allow_parallel_instances boolean erforderlich

active_customer_count integer erforderlich

sort_order integer erforderlich

internal_reference string erforderlich

scopes array erforderlich

Array-Elemente

object

type string erforderlich

Erlaubte Werte

"root""category""offer"

resource string | null

v2 category-/offer-ID; bei root null.

id string

Eingabealias für resource.

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

published_at integer | null erforderlich

archived_at integer | null erforderlich

created_at integer erforderlich

updated_at integer erforderlich

texts object | array erforderlich

Sprachcode → Textobjekt; ohne Übersetzungen kann PHP [] liefern.

Array-Elemente

Typ nicht eingeschränkt

Schema für zusätzliche Felder

object

name string

description_html string

content_hash 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": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "version": {
                "type": "integer"
              },
              "status": {
                "type": "string",
                "enum": [
                  "draft",
                  "internal",
                  "published",
                  "archived"
                ]
              },
              "name": {
                "type": "string"
              },
              "description_html": {
                "type": "string"
              },
              "language": {
                "type": "string"
              },
              "validity": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "fixed_range",
                      "relative_duration",
                      "usage_count"
                    ]
                  },
                  "from": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "until": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "value": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "unit": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "uses": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "promo_code_redemption": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": true
              },
              "discount": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "percent",
                      "fixed"
                    ]
                  },
                  "value": {
                    "type": "string",
                    "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                    "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                  },
                  "currency": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "additionalProperties": true
              },
              "sale": {
                "type": "object",
                "properties": {
                  "amount": {
                    "type": "string",
                    "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                    "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                  },
                  "currency": {
                    "type": "string"
                  },
                  "vat": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                  }
                },
                "additionalProperties": true
              },
              "publication": {
                "type": "object",
                "properties": {
                  "design": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                  }
                },
                "additionalProperties": true
              },
              "renewal": {
                "type": "object",
                "properties": {
                  "allowed": {
                    "type": "boolean"
                  },
                  "default": {
                    "type": "boolean"
                  },
                  "reminder_days": {
                    "type": "integer"
                  },
                  "duration_value": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "duration_unit": {
                    "type": [
                      "string",
                      "null"
                    ]
                  }
                },
                "additionalProperties": true
              },
              "allow_parallel_instances": {
                "type": "boolean"
              },
              "active_customer_count": {
                "type": "integer"
              },
              "sort_order": {
                "type": "integer"
              },
              "internal_reference": {
                "type": "string"
              },
              "scopes": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "root",
                        "category",
                        "offer"
                      ]
                    },
                    "resource": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "v2 category-/offer-ID; bei root null."
                    },
                    "id": {
                      "type": "string",
                      "description": "Eingabealias für resource."
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "type"
                  ]
                }
              },
              "published_at": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "archived_at": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "created_at": {
                "type": "integer"
              },
              "updated_at": {
                "type": "integer"
              }
            },
            "additionalProperties": true,
            "required": [
              "id",
              "version",
              "status",
              "name",
              "description_html",
              "language",
              "validity",
              "discount",
              "sale",
              "publication",
              "renewal",
              "allow_parallel_instances",
              "active_customer_count",
              "sort_order",
              "internal_reference",
              "scopes",
              "published_at",
              "archived_at",
              "created_at",
              "updated_at"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "version": {
              "type": "integer"
            },
            "status": {
              "type": "string",
              "enum": [
                "draft",
                "internal",
                "published",
                "archived"
              ]
            },
            "name": {
              "type": "string"
            },
            "description_html": {
              "type": "string"
            },
            "language": {
              "type": "string"
            },
            "validity": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "fixed_range",
                    "relative_duration",
                    "usage_count"
                  ]
                },
                "from": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "until": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "value": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "unit": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "uses": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "promo_code_redemption": {
                  "type": "boolean"
                }
              },
              "additionalProperties": true
            },
            "discount": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "enum": [
                    "percent",
                    "fixed"
                  ]
                },
                "value": {
                  "type": "string",
                  "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                  "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                },
                "currency": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "sale": {
              "type": "object",
              "properties": {
                "amount": {
                  "type": "string",
                  "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                  "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                },
                "currency": {
                  "type": "string"
                },
                "vat": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                }
              },
              "additionalProperties": true
            },
            "publication": {
              "type": "object",
              "properties": {
                "design": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                  "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                }
              },
              "additionalProperties": true
            },
            "renewal": {
              "type": "object",
              "properties": {
                "allowed": {
                  "type": "boolean"
                },
                "default": {
                  "type": "boolean"
                },
                "reminder_days": {
                  "type": "integer"
                },
                "duration_value": {
                  "type": [
                    "integer",
                    "null"
                  ]
                },
                "duration_unit": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "additionalProperties": true
            },
            "allow_parallel_instances": {
              "type": "boolean"
            },
            "active_customer_count": {
              "type": "integer"
            },
            "sort_order": {
              "type": "integer"
            },
            "internal_reference": {
              "type": "string"
            },
            "scopes": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "root",
                      "category",
                      "offer"
                    ]
                  },
                  "resource": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "description": "v2 category-/offer-ID; bei root null."
                  },
                  "id": {
                    "type": "string",
                    "description": "Eingabealias für resource."
                  }
                },
                "additionalProperties": true,
                "required": [
                  "type"
                ]
              }
            },
            "published_at": {
              "type": [
                "integer",
                "null"
              ]
            },
            "archived_at": {
              "type": [
                "integer",
                "null"
              ]
            },
            "created_at": {
              "type": "integer"
            },
            "updated_at": {
              "type": "integer"
            },
            "texts": {
              "type": [
                "object",
                "array"
              ],
              "additionalProperties": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "description_html": {
                    "type": "string"
                  },
                  "content_hash": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              },
              "items": {},
              "description": "Sprachcode → Textobjekt; ohne Übersetzungen kann PHP [] liefern."
            }
          },
          "additionalProperties": true,
          "required": [
            "id",
            "version",
            "status",
            "name",
            "description_html",
            "language",
            "validity",
            "discount",
            "sale",
            "publication",
            "renewal",
            "allow_parallel_instances",
            "active_customer_count",
            "sort_order",
            "internal_reference",
            "scopes",
            "published_at",
            "archived_at",
            "created_at",
            "updated_at",
            "texts"
          ]
        }
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": [
    {
      "id": "membershipplan_012345abcdef_123456",
      "version": 1,
      "status": "draft",
      "name": "Jahresmitgliedschaft",
      "description_html": "<p>Vorteile für ein Jahr</p>",
      "language": "de",
      "validity": {
        "type": "relative_duration",
        "from": null,
        "until": null,
        "value": 1,
        "unit": "year",
        "uses": null,
        "promo_code_redemption": false
      },
      "discount": {
        "type": "percent",
        "value": "10.00",
        "currency": null
      },
      "sale": {
        "amount": "120.00",
        "currency": "CHF",
        "vat": null
      },
      "publication": {
        "design": null
      },
      "renewal": {
        "allowed": false,
        "default": false,
        "reminder_days": 30,
        "duration_value": null,
        "duration_unit": null
      },
      "allow_parallel_instances": false,
      "active_customer_count": 0,
      "sort_order": 0,
      "internal_reference": "Mitgliedschaft 2027",
      "scopes": [
        {
          "type": "root",
          "resource": null
        }
      ],
      "published_at": null,
      "archived_at": null,
      "created_at": 1790000000,
      "updated_at": 1790000000
    }
  ]
}

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-get-effect

"read"

x-edoobox-get-permission-review

{
  "file": "docs/openapi/reviews/vue-get-permission-03.json",
  "pointer": "/operations/6",
  "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": 45,
    "reason": "GET collection delegates filters/order/pagination to service.list."
  },
  "reason": "List existing membership plans and computed current customer counts.",
  "review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/6",
    "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
}

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_list",
  "summary": "Mitgliedschaftspläne suchen",
  "description": "Liest Pläne mit Preisen, Rabatten, Geltungsbereich und aktiver Kundenzahl. JSON-Filter mit property/value; AND zwischen Eigenschaften, OR zwischen Enum-Werten. status (draft/internal/published/archived), validity_type, duration_unit, discount_type, scope_type akzeptieren String oder Stringliste. Weitere Felder: assignable, name, name_match (contains/starts_with/equals), search (Name/Beschreibung), sale_currency_iso, auto_renew_allowed (0/1/bool), valid_from/valid_until (Überlappung nur fixed_range). Grenzen *_min/*_max für sale_price, discount_value, included_uses, duration_value, active_customer_count. Numerische Grenzen akzeptieren Zahl oder numerischen String; ungültige Werte ergeben membership_invalid_filter. id wählt statt einer Liste ein Einzelobjekt. Pagination per limit, total vor Pagination. fields und response_type ändern die feste Ausgabe nicht.",
  "tags": [
    "membershipplan"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "JSON-Filter mit property/value; AND zwischen Eigenschaften, OR zwischen Enum-Werten. status (draft/internal/published/archived), validity_type, duration_unit, discount_type, scope_type akzeptieren String oder Stringliste. Weitere Felder: assignable, name, name_match (contains/starts_with/equals), search (Name/Beschreibung), sale_currency_iso, auto_renew_allowed (0/1/bool), valid_from/valid_until (Überlappung nur fixed_range). Grenzen *_min/*_max für sale_price, discount_value, included_uses, duration_value, active_customer_count. Numerische Grenzen akzeptieren Zahl oder numerischen String; ungültige Werte ergeben membership_invalid_filter. id wählt statt einer Liste ein Einzelobjekt.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "value": {},
                "expression": {
                  "type": "string",
                  "description": "Bei diesen Ressourcen ignoriert; Auswahl erfolgt anhand von property/value."
                }
              },
              "additionalProperties": true,
              "required": [
                "property",
                "value"
              ]
            }
          },
          "example": [
            {
              "property": "status",
              "value": [
                "published",
                "internal"
              ]
            }
          ]
        }
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "JSON-Objekt mit start (Offset) und reply (Seitengröße, 1–500); alternativ eine Zahl. Standard reply=100. Größere Werte werden begrenzt; negative Offsets auf 0 gesetzt.",
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "start": {
                    "type": "integer",
                    "minimum": 0,
                    "default": 0
                  },
                  "reply": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 500,
                    "default": 100
                  }
                },
                "additionalProperties": true
              },
              {
                "type": "integer",
                "minimum": 1,
                "maximum": 500
              }
            ]
          },
          "example": {
            "start": 0,
            "reply": 25
          }
        }
      }
    },
    {
      "name": "order",
      "in": "query",
      "required": false,
      "description": "Sortierung nach updated_at, created_at, status, validity_type, sale_price, discount_value, sort_order, name oder active_customer_count; value/direction ASC/DESC. Ungültige Klauseln werden ignoriert. Standard sort_order ASC, danach stabile ID-Reihenfolge.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "field": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                },
                "direction": {
                  "type": "string"
                }
              },
              "additionalProperties": true
            }
          },
          "example": [
            {
              "property": "name",
              "value": "ASC"
            }
          ]
        }
      }
    },
    {
      "name": "language",
      "in": "query",
      "required": false,
      "description": "Gewünschte Textsprache; Fallback Kontosprache, danach vorhandene Sprache.",
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.",
        "examples": [
          "membershipplan_012345abcdef_123456"
        ]
      },
      "description": "Einzelobjekt über id auswählen; alternativ gleichnamiger Eintrag im JSON-filter."
    }
  ],
  "responses": {
    "200": {
      "description": "data enthält das dokumentierte Ergebnisobjekt; error=false und success=true.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": [
              {
                "id": "membershipplan_012345abcdef_123456",
                "version": 1,
                "status": "draft",
                "name": "Jahresmitgliedschaft",
                "description_html": "<p>Vorteile für ein Jahr</p>",
                "language": "de",
                "validity": {
                  "type": "relative_duration",
                  "from": null,
                  "until": null,
                  "value": 1,
                  "unit": "year",
                  "uses": null,
                  "promo_code_redemption": false
                },
                "discount": {
                  "type": "percent",
                  "value": "10.00",
                  "currency": null
                },
                "sale": {
                  "amount": "120.00",
                  "currency": "CHF",
                  "vat": null
                },
                "publication": {
                  "design": null
                },
                "renewal": {
                  "allowed": false,
                  "default": false,
                  "reminder_days": 30,
                  "duration_value": null,
                  "duration_unit": null
                },
                "allow_parallel_instances": false,
                "active_customer_count": 0,
                "sort_order": 0,
                "internal_reference": "Mitgliedschaft 2027",
                "scopes": [
                  {
                    "type": "root",
                    "resource": null
                  }
                ],
                "published_at": null,
                "archived_at": null,
                "created_at": 1790000000,
                "updated_at": 1790000000
              }
            ]
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "oneOf": [
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "version": {
                          "type": "integer"
                        },
                        "status": {
                          "type": "string",
                          "enum": [
                            "draft",
                            "internal",
                            "published",
                            "archived"
                          ]
                        },
                        "name": {
                          "type": "string"
                        },
                        "description_html": {
                          "type": "string"
                        },
                        "language": {
                          "type": "string"
                        },
                        "validity": {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "enum": [
                                "fixed_range",
                                "relative_duration",
                                "usage_count"
                              ]
                            },
                            "from": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "until": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "value": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "unit": {
                              "type": [
                                "string",
                                "null"
                              ]
                            },
                            "uses": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "promo_code_redemption": {
                              "type": "boolean"
                            }
                          },
                          "additionalProperties": true
                        },
                        "discount": {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "enum": [
                                "percent",
                                "fixed"
                              ]
                            },
                            "value": {
                              "type": "string",
                              "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                              "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                            },
                            "currency": {
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "additionalProperties": true
                        },
                        "sale": {
                          "type": "object",
                          "properties": {
                            "amount": {
                              "type": "string",
                              "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                              "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                            },
                            "currency": {
                              "type": "string"
                            },
                            "vat": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                            }
                          },
                          "additionalProperties": true
                        },
                        "publication": {
                          "type": "object",
                          "properties": {
                            "design": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                            }
                          },
                          "additionalProperties": true
                        },
                        "renewal": {
                          "type": "object",
                          "properties": {
                            "allowed": {
                              "type": "boolean"
                            },
                            "default": {
                              "type": "boolean"
                            },
                            "reminder_days": {
                              "type": "integer"
                            },
                            "duration_value": {
                              "type": [
                                "integer",
                                "null"
                              ]
                            },
                            "duration_unit": {
                              "type": [
                                "string",
                                "null"
                              ]
                            }
                          },
                          "additionalProperties": true
                        },
                        "allow_parallel_instances": {
                          "type": "boolean"
                        },
                        "active_customer_count": {
                          "type": "integer"
                        },
                        "sort_order": {
                          "type": "integer"
                        },
                        "internal_reference": {
                          "type": "string"
                        },
                        "scopes": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string",
                                "enum": [
                                  "root",
                                  "category",
                                  "offer"
                                ]
                              },
                              "resource": {
                                "type": [
                                  "string",
                                  "null"
                                ],
                                "description": "v2 category-/offer-ID; bei root null."
                              },
                              "id": {
                                "type": "string",
                                "description": "Eingabealias für resource."
                              }
                            },
                            "additionalProperties": true,
                            "required": [
                              "type"
                            ]
                          }
                        },
                        "published_at": {
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "archived_at": {
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "created_at": {
                          "type": "integer"
                        },
                        "updated_at": {
                          "type": "integer"
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "id",
                        "version",
                        "status",
                        "name",
                        "description_html",
                        "language",
                        "validity",
                        "discount",
                        "sale",
                        "publication",
                        "renewal",
                        "allow_parallel_instances",
                        "active_customer_count",
                        "sort_order",
                        "internal_reference",
                        "scopes",
                        "published_at",
                        "archived_at",
                        "created_at",
                        "updated_at"
                      ]
                    }
                  },
                  {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^membershipplan_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "version": {
                        "type": "integer"
                      },
                      "status": {
                        "type": "string",
                        "enum": [
                          "draft",
                          "internal",
                          "published",
                          "archived"
                        ]
                      },
                      "name": {
                        "type": "string"
                      },
                      "description_html": {
                        "type": "string"
                      },
                      "language": {
                        "type": "string"
                      },
                      "validity": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "fixed_range",
                              "relative_duration",
                              "usage_count"
                            ]
                          },
                          "from": {
                            "type": [
                              "integer",
                              "null"
                            ]
                          },
                          "until": {
                            "type": [
                              "integer",
                              "null"
                            ]
                          },
                          "value": {
                            "type": [
                              "integer",
                              "null"
                            ]
                          },
                          "unit": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "uses": {
                            "type": [
                              "integer",
                              "null"
                            ]
                          },
                          "promo_code_redemption": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": true
                      },
                      "discount": {
                        "type": "object",
                        "properties": {
                          "type": {
                            "type": "string",
                            "enum": [
                              "percent",
                              "fixed"
                            ]
                          },
                          "value": {
                            "type": "string",
                            "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                            "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                          },
                          "currency": {
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "additionalProperties": true
                      },
                      "sale": {
                        "type": "object",
                        "properties": {
                          "amount": {
                            "type": "string",
                            "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                            "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                          },
                          "currency": {
                            "type": "string"
                          },
                          "vat": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                          }
                        },
                        "additionalProperties": true
                      },
                      "publication": {
                        "type": "object",
                        "properties": {
                          "design": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                          }
                        },
                        "additionalProperties": true
                      },
                      "renewal": {
                        "type": "object",
                        "properties": {
                          "allowed": {
                            "type": "boolean"
                          },
                          "default": {
                            "type": "boolean"
                          },
                          "reminder_days": {
                            "type": "integer"
                          },
                          "duration_value": {
                            "type": [
                              "integer",
                              "null"
                            ]
                          },
                          "duration_unit": {
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "additionalProperties": true
                      },
                      "allow_parallel_instances": {
                        "type": "boolean"
                      },
                      "active_customer_count": {
                        "type": "integer"
                      },
                      "sort_order": {
                        "type": "integer"
                      },
                      "internal_reference": {
                        "type": "string"
                      },
                      "scopes": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "enum": [
                                "root",
                                "category",
                                "offer"
                              ]
                            },
                            "resource": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "description": "v2 category-/offer-ID; bei root null."
                            },
                            "id": {
                              "type": "string",
                              "description": "Eingabealias für resource."
                            }
                          },
                          "additionalProperties": true,
                          "required": [
                            "type"
                          ]
                        }
                      },
                      "published_at": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "archived_at": {
                        "type": [
                          "integer",
                          "null"
                        ]
                      },
                      "created_at": {
                        "type": "integer"
                      },
                      "updated_at": {
                        "type": "integer"
                      },
                      "texts": {
                        "type": [
                          "object",
                          "array"
                        ],
                        "additionalProperties": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "description_html": {
                              "type": "string"
                            },
                            "content_hash": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true
                        },
                        "items": {},
                        "description": "Sprachcode → Textobjekt; ohne Übersetzungen kann PHP [] liefern."
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "id",
                      "version",
                      "status",
                      "name",
                      "description_html",
                      "language",
                      "validity",
                      "discount",
                      "sale",
                      "publication",
                      "renewal",
                      "allow_parallel_instances",
                      "active_customer_count",
                      "sort_order",
                      "internal_reference",
                      "scopes",
                      "published_at",
                      "archived_at",
                      "created_at",
                      "updated_at",
                      "texts"
                    ]
                  }
                ]
              },
              "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-get-effect": "read",
  "x-edoobox-get-permission-review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/6",
    "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": 45,
      "reason": "GET collection delegates filters/order/pagination to service.list."
    },
    "reason": "List existing membership plans and computed current customer counts.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-03.json",
      "pointer": "/operations/6",
      "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
  },
  "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.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/membershipplan/list' \
  --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/list";
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/list"
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/list";
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/list"
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.