GET/v2/membershipredemption

Nutzungsbuchungen einer Mitgliedschaft lesen

Liest Nutzungsbuchungen genau einer Mitgliedschaft. Ohne id muss membership direkt als Query oder als filter-Eintrag vorhanden sein; fehlt beides, folgt membership_filter_required. Ein id-Selector liest stattdessen einen Einzelbeleg. Liest ausschließlich das unveränderliche Nutzungsjournal; keine Reservierung, Einlösung oder Zustandsänderung. Sortierung: created_at absteigend, danach Beleg-ID. Nur reply wird benutzt (1–500, Standard durch Dispatcher 100); start/Offset wird ignoriert und es gibt kein total.

Operation-ID get_v2_membershipredemption

Vertrag & Verhalten

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

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

Parameter

Query-Parameter

filteroptional

JSON-Filter: id wählt einen Einzelbeleg; membership wählt die zugehörige Mitgliedschaft. Mindestens eine dieser Auswahlen ist erforderlich. Andere Eigenschaften und expression werden ignoriert.

`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": "membership",
    "value": "usermembership_012345abcdef_123456"
  }
]

limitoptional

JSON-Objekt mit reply (Seitengröße, 1–500); alternativ eine Zahl. Standard reply=100. Größere Werte werden begrenzt; start wird ignoriert.

`application/json`

Typ nicht eingeschränkt

oneOf · Genau eine Variante muss passen

Variante 1 object

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": {
        "reply": {
          "type": "integer",
          "minimum": 1,
          "maximum": 500,
          "default": 100
        }
      },
      "additionalProperties": true
    },
    {
      "type": "integer",
      "minimum": 1,
      "maximum": 500
    }
  ]
}

Beispiel

{
  "reply": 25
}

idoptional

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

string

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

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

Schema-Beispiel

"membershipredemption_012345abcdef_123456"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.",
  "examples": [
    "membershipredemption_012345abcdef_123456"
  ]
}

membershipoptional

Pflichtauswahl für die Liste: Mitgliedschaft im aktuellen Konto; alternativ filter mit property=membership.

string

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

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

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
}

Header

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string

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

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

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

Request Body

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 ist bei membership-Auswahl eine JSON-Liste (auch leer), bei id-Auswahl ein einzelnes Objekt. error=false und success=true. Kein total und kein Offset.

Response Header

`X-Edoobox-Revision`

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

string

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

Vollständiges Schema als JSON

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

`application/json`

object

success boolean

error boolean | string

error_code string

data 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: "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$"

membership string erforderlich

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

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

user string erforderlich

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

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

event_type string erforderlich

quantity_delta integer erforderlich

offer string | null erforderlich

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

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

reverses string | null erforderlich

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

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

reason string erforderlich

actor_type string erforderlich

created_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: "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$"

membership string erforderlich

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

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

user string erforderlich

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

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

event_type string erforderlich

quantity_delta integer erforderlich

offer string | null erforderlich

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

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

reverses string | null erforderlich

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

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

reason string erforderlich

actor_type string erforderlich

created_at integer erforderlich

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

type string

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

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "membership": {
                "type": "string",
                "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "user": {
                "type": "string",
                "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "event_type": {
                "type": "string"
              },
              "quantity_delta": {
                "type": "integer"
              },
              "offer": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "reverses": {
                "type": [
                  "string",
                  "null"
                ],
                "pattern": "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
              },
              "reason": {
                "type": "string"
              },
              "actor_type": {
                "type": "string"
              },
              "created_at": {
                "type": "integer"
              }
            },
            "additionalProperties": true,
            "required": [
              "id",
              "membership",
              "user",
              "event_type",
              "quantity_delta",
              "offer",
              "reverses",
              "reason",
              "actor_type",
              "created_at"
            ]
          }
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "membership": {
              "type": "string",
              "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "user": {
              "type": "string",
              "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "event_type": {
              "type": "string"
            },
            "quantity_delta": {
              "type": "integer"
            },
            "offer": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "reverses": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "reason": {
              "type": "string"
            },
            "actor_type": {
              "type": "string"
            },
            "created_at": {
              "type": "integer"
            }
          },
          "additionalProperties": true,
          "required": [
            "id",
            "membership",
            "user",
            "event_type",
            "quantity_delta",
            "offer",
            "reverses",
            "reason",
            "actor_type",
            "created_at"
          ]
        }
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": [
    {
      "id": "membershipredemption_012345abcdef_123456",
      "membership": "usermembership_012345abcdef_123456",
      "user": "user_012345abcdef_123456",
      "event_type": "consume",
      "quantity_delta": -1,
      "offer": "offer_012345abcdef_123456",
      "reverses": null,
      "reason": "Buchung",
      "actor_type": "system",
      "created_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"
}

409application/json

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

`application/json`

object

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

Vollständiges Schema als JSON

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

Beispiel

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

422application/json

Validation failed.

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

429application/json

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

Response Header

`Retry-After`

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

string

Schema-Beispiel

"30"

Vollständiges Schema als JSON

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

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

502application/json

Server-side operation failed.

`application/json`

Typ nicht eingeschränkt

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

Beispiel

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

503application/json

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

Response Header

`application/json`

object

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

Vollständiges Schema als JSON

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

Beispiel

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

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Membershipredemption.php:17getMembershipredemption()

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

true

x-edoobox-get-effect

"read"

x-edoobox-documentationReview

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

x-edoobox-parameterAlternatives

[
  {
    "query": [
      "membership"
    ]
  },
  {
    "query": [
      "id"
    ]
  },
  {
    "query": [
      "filter"
    ],
    "containsProperty": [
      "membership",
      "id"
    ]
  }
]

x-edoobox-source

{
  "file": "application/models/v2/Membershipredemption.php",
  "method": "getMembershipredemption",
  "line": 17
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

true

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "membershipredemption",
  "short": "mere",
  "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_membershipredemption",
  "summary": "Nutzungsbuchungen einer Mitgliedschaft lesen",
  "description": "Liest Nutzungsbuchungen genau einer Mitgliedschaft. Ohne id muss membership direkt als Query oder als filter-Eintrag vorhanden sein; fehlt beides, folgt membership_filter_required. Ein id-Selector liest stattdessen einen Einzelbeleg.  Liest ausschließlich das unveränderliche Nutzungsjournal; keine Reservierung, Einlösung oder Zustandsänderung. Sortierung: created_at absteigend, danach Beleg-ID. Nur reply wird benutzt (1–500, Standard durch Dispatcher 100); start/Offset wird ignoriert und es gibt kein total.",
  "tags": [
    "membershipredemption"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "JSON-Filter: id wählt einen Einzelbeleg; membership wählt die zugehörige Mitgliedschaft. Mindestens eine dieser Auswahlen ist erforderlich. Andere Eigenschaften und expression werden ignoriert.",
      "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": "membership",
              "value": "usermembership_012345abcdef_123456"
            }
          ]
        }
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "JSON-Objekt mit reply (Seitengröße, 1–500); alternativ eine Zahl. Standard reply=100. Größere Werte werden begrenzt; start wird ignoriert.",
      "content": {
        "application/json": {
          "schema": {
            "oneOf": [
              {
                "type": "object",
                "properties": {
                  "reply": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 500,
                    "default": 100
                  }
                },
                "additionalProperties": true
              },
              {
                "type": "integer",
                "minimum": 1,
                "maximum": 500
              }
            ]
          },
          "example": {
            "reply": 25
          }
        }
      }
    },
    {
      "name": "id",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID.",
        "examples": [
          "membershipredemption_012345abcdef_123456"
        ]
      },
      "description": "Einzelobjekt über id auswählen; alternativ gleichnamiger Eintrag im JSON-filter."
    },
    {
      "name": "membership",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
      },
      "description": "Pflichtauswahl für die Liste: Mitgliedschaft im aktuellen Konto; alternativ filter mit property=membership."
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "responses": {
    "200": {
      "description": "data ist bei membership-Auswahl eine JSON-Liste (auch leer), bei id-Auswahl ein einzelnes Objekt. error=false und success=true. Kein total und kein Offset.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": [
              {
                "id": "membershipredemption_012345abcdef_123456",
                "membership": "usermembership_012345abcdef_123456",
                "user": "user_012345abcdef_123456",
                "event_type": "consume",
                "quantity_delta": -1,
                "offer": "offer_012345abcdef_123456",
                "reverses": null,
                "reason": "Buchung",
                "actor_type": "system",
                "created_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": "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "membership": {
                          "type": "string",
                          "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "user": {
                          "type": "string",
                          "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "event_type": {
                          "type": "string"
                        },
                        "quantity_delta": {
                          "type": "integer"
                        },
                        "offer": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "reverses": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "pattern": "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                        },
                        "reason": {
                          "type": "string"
                        },
                        "actor_type": {
                          "type": "string"
                        },
                        "created_at": {
                          "type": "integer"
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "id",
                        "membership",
                        "user",
                        "event_type",
                        "quantity_delta",
                        "offer",
                        "reverses",
                        "reason",
                        "actor_type",
                        "created_at"
                      ]
                    }
                  },
                  {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "membership": {
                        "type": "string",
                        "pattern": "^usermembership_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "user": {
                        "type": "string",
                        "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "event_type": {
                        "type": "string"
                      },
                      "quantity_delta": {
                        "type": "integer"
                      },
                      "offer": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "reverses": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^membershipredemption_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "reason": {
                        "type": "string"
                      },
                      "actor_type": {
                        "type": "string"
                      },
                      "created_at": {
                        "type": "integer"
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "id",
                      "membership",
                      "user",
                      "event_type",
                      "quantity_delta",
                      "offer",
                      "reverses",
                      "reason",
                      "actor_type",
                      "created_at"
                    ]
                  }
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/01-membership.json",
    "notes": []
  },
  "x-edoobox-parameterAlternatives": [
    {
      "query": [
        "membership"
      ]
    },
    {
      "query": [
        "id"
      ]
    },
    {
      "query": [
        "filter"
      ],
      "containsProperty": [
        "membership",
        "id"
      ]
    }
  ],
  "x-edoobox-source": {
    "file": "application/models/v2/Membershipredemption.php",
    "method": "getMembershipredemption",
    "line": 17
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "membershipredemption",
    "short": "mere",
    "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/membershipredemption' \
  --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/membershipredemption";
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/membershipredemption"
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/membershipredemption";
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/membershipredemption"
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.