Zum Inhalt
edoobox Docs

Suchen Sie nach einer Aufgabe oder einem Thema, z. B. Rechnung oder Warteliste.
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
edsubscriptionAPI-Referenz
GET/v2/edsubscription/list/subscriptions_verification

Tatsächliche Abonnementnutzung prüfen

Liest aktuelle Nutzungszähler und aktivierte Funktionen zur Prüfung eines möglichen Planwechsels; ändert keinen Plan.

Operation-ID get_v2_edsubscription_list_subscriptions_verification

01

Vertrag & Verhalten

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

read

02

Authentifizierung

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

Alternative 1

bearerAuthhttp · bearer

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

Format: JWT

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

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

header: edid

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

Alternative 2

sessionCookieapiKey

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

cookie: _edlogin

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

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

header: edid

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

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

Ressource
edsubscription · edsu
Levels
1, 3, 4
Dispatcher-Prüfung
Ja
03

Parameter

Header

languageoptional

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

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

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

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

200application/json

Response; inspect error and success as legacy failures may also use HTTP 200.

application/json

object
success boolean
error boolean | string
error_code string
data object
offer_maximum integer
user_maximum integer
pricecategorie_maximum integer
oauth2_provider integer
datastructure_function integer
edoobox_connect integer
offerlist_maximum integer
lesson_booking boolean
certificate_validation boolean
offer_signup_start boolean
internal_function Typ nicht eingeschränkt

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": {
        "offer_maximum": {
          "type": "integer"
        },
        "user_maximum": {
          "type": "integer"
        },
        "pricecategorie_maximum": {
          "type": "integer"
        },
        "oauth2_provider": {
          "type": "integer"
        },
        "datastructure_function": {
          "type": "integer"
        },
        "edoobox_connect": {
          "type": "integer"
        },
        "offerlist_maximum": {
          "type": "integer"
        },
        "lesson_booking": {
          "type": "boolean"
        },
        "certificate_validation": {
          "type": "boolean"
        },
        "offer_signup_start": {
          "type": "boolean"
        },
        "internal_function": {}
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "offer_maximum": 3,
    "user_maximum": 20,
    "lesson_booking": false,
    "pricecategorie_maximum": 1,
    "internal_function": false,
    "oauth2_provider": 0,
    "datastructure_function": 2,
    "edoobox_connect": 0,
    "offerlist_maximum": 0,
    "certificate_validation": false,
    "offer_signup_start": false
  }
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

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

Beispiel
{
  "success": false,
  "error": "ED40006"
}
401application/json

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

application/json

Typ nicht eingeschränkt

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

Beispiel
{
  "success": false,
  "error": "ED40103"
}
402application/json

Missing/invalid action data or subscription/operation restriction.

application/json

Typ nicht eingeschränkt

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

Beispiel
{
  "success": false,
  "error": "ED80100"
}
403application/json

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

application/json

Typ nicht eingeschränkt

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

Beispiel
{
  "success": false,
  "error": "ED40340"
}
404application/json

Unknown resource/action or unsupported method.

application/json

Typ nicht eingeschränkt

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

Beispiel
{
  "success": false,
  "error": "ED80019"
}
422application/json

Validation failed.

application/json

Typ nicht eingeschränkt

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

Beispiel
{
  "success": false,
  "error": "ED80020"
}
429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

Retry-After

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

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

application/json

Typ nicht eingeschränkt

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

Beispiel
{
  "success": false,
  "error": "ED42902"
}
502application/json

Server-side operation failed.

application/json

Typ nicht eingeschränkt

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

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

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Edsubscription.php:326getEdsubscription()

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-02.json",
  "pointer": "/operations/3",
  "sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc",
  "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
}
x-edoobox-mutationReview
{
  "source": {
    "file": "application/config/config.php",
    "line": 370,
    "reason": "APIPermissions resource mapping to edsu.",
    "sha256": "8d7bcae1a154ab06f54007072f84af5fe87ae7349b1b06738e7adbd8ee084f82"
  },
  "reason": "Computes subscription feature/usage verification from existing account data; it neither switches plans nor bills the account.",
  "review": {
    "file": "docs/openapi/reviews/vue-get-permission-02.json",
    "pointer": "/operations/3",
    "sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc",
    "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/08-subscriptions.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Edsubscription.php",
  "method": "getEdsubscription",
  "line": 326,
  "branch": {
    "file": "application/models/v2/Edsubscription.php",
    "line": 365
  }
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
true
x-edoobox-permission
{
  "resource": "edsubscription",
  "short": "edsu",
  "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_edsubscription_list_subscriptions_verification",
  "summary": "Tatsächliche Abonnementnutzung prüfen",
  "description": "Liest aktuelle Nutzungszähler und aktivierte Funktionen zur Prüfung eines möglichen Planwechsels; ändert keinen Plan.",
  "tags": [
    "edsubscription"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Response; inspect error and success as legacy failures may also use HTTP 200.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "offer_maximum": 3,
              "user_maximum": 20,
              "lesson_booking": false,
              "pricecategorie_maximum": 1,
              "internal_function": false,
              "oauth2_provider": 0,
              "datastructure_function": 2,
              "edoobox_connect": 0,
              "offerlist_maximum": 0,
              "certificate_validation": false,
              "offer_signup_start": false
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "offer_maximum": {
                    "type": "integer"
                  },
                  "user_maximum": {
                    "type": "integer"
                  },
                  "pricecategorie_maximum": {
                    "type": "integer"
                  },
                  "oauth2_provider": {
                    "type": "integer"
                  },
                  "datastructure_function": {
                    "type": "integer"
                  },
                  "edoobox_connect": {
                    "type": "integer"
                  },
                  "offerlist_maximum": {
                    "type": "integer"
                  },
                  "lesson_booking": {
                    "type": "boolean"
                  },
                  "certificate_validation": {
                    "type": "boolean"
                  },
                  "offer_signup_start": {
                    "type": "boolean"
                  },
                  "internal_function": {}
                },
                "additionalProperties": true
              },
              "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-02.json",
    "pointer": "/operations/3",
    "sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  },
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/config/config.php",
      "line": 370,
      "reason": "APIPermissions resource mapping to edsu.",
      "sha256": "8d7bcae1a154ab06f54007072f84af5fe87ae7349b1b06738e7adbd8ee084f82"
    },
    "reason": "Computes subscription feature/usage verification from existing account data; it neither switches plans nor bills the account.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-02.json",
      "pointer": "/operations/3",
      "sha256": "25310a80e8f92a0486b6f7538bd2165e0bb66dd59c60a097ee53cf8d950337fc",
      "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/08-subscriptions.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Edsubscription.php",
    "method": "getEdsubscription",
    "line": 326,
    "branch": {
      "file": "application/models/v2/Edsubscription.php",
      "line": 365
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "edsubscription",
    "short": "edsu",
    "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."
  }
}
Cookies & Datenschutz
Notwendig

Für Sicherheit, Navigation, Formulare und den technischen Betrieb der Website.

Immer aktiv
Datenschutzerklärung