Verlauf einer Mitgliedschaft lesen

{
  "operationId": "get_v2_usermembership_id_timeline",
  "summary": "Verlauf einer Mitgliedschaft lesen",
  "description": "Liest unveränderliche Audit- und Journalereignisse einer Mitgliedschaft einschließlich ihrer Perioden. Doppelte Vergabe-/Gutschriftanzeigen werden zusammengeführt; technische IDs aus Änderungen werden entfernt. Pagination per limit, Sortierung Zeit absteigend; total vor Pagination. Diese Detailaktion führt keinen Zahlungsabgleich aus.",
  "tags": [
    "usermembership"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "JSON-Objekt start/reply oder Zahl als reply. Standard 0/100, reply auf 1–500 begrenzt, start mindestens 0.",
      "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": "id",
      "in": "path",
      "required": true,
      "schema": {
        "type": "string",
        "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
        "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
        "examples": [
          "usermembership_012345abcdef_123456"
        ]
      },
      "description": "Source-reviewed path context; normal dispatcher ownership and permission checks still apply."
    }
  ],
  "responses": {
    "200": {
      "description": "data ist eine chronologisch absteigend sortierte Ereignisliste; total enthält die Gesamtzahl vor Pagination. error=false und success=true.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": [
              {
                "type": "redemption",
                "event_type": "membership.usage_consumed",
                "occurred_at": 1790000000,
                "reason": "Buchung",
                "actor": {
                  "type": "system"
                },
                "resource": {
                  "type": "membershipredemption",
                  "id": "membershipredemption_012345abcdef_123456"
                },
                "changes": {
                  "quantity_delta": -1
                }
              }
            ]
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "audit",
                        "redemption"
                      ]
                    },
                    "event_type": {
                      "type": "string"
                    },
                    "occurred_at": {
                      "type": "integer"
                    },
                    "reason": {
                      "type": "string"
                    },
                    "actor": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "type"
                      ]
                    },
                    "resource": {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string"
                        },
                        "id": {
                          "type": "string",
                          "description": "Öffentliche v2-ID des im type genannten Objekts."
                        }
                      },
                      "additionalProperties": true,
                      "required": [
                        "type",
                        "id"
                      ]
                    },
                    "changes": {
                      "type": "object",
                      "properties": {
                        "before": {
                          "type": [
                            "object",
                            "null"
                          ],
                          "additionalProperties": true,
                          "description": "Zugelassene Zustandsfelder und explizit in v2 umgewandelte Ressourcen; rohe technische IDs werden entfernt."
                        },
                        "after": {
                          "type": [
                            "object",
                            "null"
                          ],
                          "additionalProperties": true,
                          "description": "Zugelassene Zustandsfelder und explizit in v2 umgewandelte Ressourcen; rohe technische IDs werden entfernt."
                        },
                        "quantity_delta": {
                          "type": "integer"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "type",
                    "event_type",
                    "occurred_at",
                    "reason",
                    "actor",
                    "resource",
                    "changes"
                  ]
                }
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-routeAliasEvidence": {
    "file": "application/models/v2/Usermembership.php",
    "line": 34,
    "reason": "Reviewed dispatcher alias: the same literal action/constructor Structure is selected; the third segment supplies ID/filter context or an ignored collection spelling. Domain ownership, required data and model validation remain unchanged."
  },
  "x-edoobox-get-effect": "read",
  "x-edoobox-get-permission-review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/24",
    "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/Usermembership.php",
      "line": 34,
      "reason": "Timeline branch directly calls timeline.list before the other invoice/item/list branches."
    },
    "reason": "Read existing membership audit and redemption events as a timeline; do not refresh payment state.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-03.json",
      "pointer": "/operations/24",
      "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/Usermembership.php",
    "method": "getUsermembership",
    "line": 24,
    "branch": {
      "file": "application/models/v2/Usermembership.php",
      "line": 34
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "usermembership",
    "short": "usme",
    "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."
  }
}