GET/v2/membershipperiod/{id}

Periodenbeleg lesen

Liest einen Periodenbeleg anhand der öffentlichen Pfad-ID. Vor der Rückgabe werden verpasste Zahlungsrückmeldungen abgeglichen. Das kann Perioden/Zahlungsreferenzen, Mitgliedschaftsstatus, Gültigkeit, Nutzungsbestand, Audit und Outbox dauerhaft ändern.

Operation-ID get_v2_membershipperiod_id

Vertrag & Verhalten

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

Dieser GET-Aufruf kann Zustand verändern. Die HTTP-Methode allein kennzeichnet hier keinen reinen Lesezugriff.

GET-Verhalten laut Spezifikation

business-mutation

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

Parameter

Pfadparameter

iderforderlich

v2 object identifier in the selected account.

string

Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.

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

Schema-Beispiel

"membershipperiod_012345abcdef_123456"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-z0-9]+_[a-f0-9]{12}_-?[0-9]+$",
  "description": "Opaque edoobox v2 object ID returned by this account. Never send a raw database ID. The synthetic example is illustrative and is not a real record.",
  "examples": [
    "membershipperiod_012345abcdef_123456"
  ]
}

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 enthält das dokumentierte Ergebnisobjekt; error=false und success=true.

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 object

id string erforderlich

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

pattern: "^membershipperiod_[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]+$"

type string erforderlich

period_start integer | null erforderlich

period_end integer | null erforderlich

payment_status string erforderlich

amounts object erforderlich

gross string erforderlich

Dezimalbetrag als String mit zwei Nachkommastellen.

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

net string erforderlich

Dezimalbetrag als String mit zwei Nachkommastellen.

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

tax string erforderlich

Dezimalbetrag als String mit zwei Nachkommastellen.

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

currency string erforderlich

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

vat object erforderlich

id string | null erforderlich

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

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

rate string erforderlich

label string erforderlich

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

title string erforderlich

plan_version integer erforderlich

design string | null erforderlich

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

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

transaction string | null erforderlich

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

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

invoice string | null erforderlich

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

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

invoice_number string | null erforderlich

payment string | null erforderlich

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

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

reminder_due_at integer | null erforderlich

renewal_due_at integer | null erforderlich

created_at integer erforderlich

updated_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": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^membershipperiod_[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."
        },
        "type": {
          "type": "string"
        },
        "period_start": {
          "type": [
            "integer",
            "null"
          ]
        },
        "period_end": {
          "type": [
            "integer",
            "null"
          ]
        },
        "payment_status": {
          "type": "string"
        },
        "amounts": {
          "type": "object",
          "properties": {
            "gross": {
              "type": "string",
              "pattern": "^-?[0-9]+\\.[0-9]{2}$",
              "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
            },
            "net": {
              "type": "string",
              "pattern": "^-?[0-9]+\\.[0-9]{2}$",
              "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
            },
            "tax": {
              "type": "string",
              "pattern": "^-?[0-9]+\\.[0-9]{2}$",
              "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
            },
            "currency": {
              "type": "string"
            }
          },
          "additionalProperties": true,
          "required": [
            "gross",
            "net",
            "tax",
            "currency"
          ]
        },
        "vat": {
          "type": "object",
          "properties": {
            "id": {
              "type": [
                "string",
                "null"
              ],
              "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
            },
            "rate": {
              "type": "string"
            },
            "label": {
              "type": "string"
            }
          },
          "additionalProperties": true,
          "required": [
            "id",
            "rate",
            "label"
          ]
        },
        "title": {
          "type": "string"
        },
        "plan_version": {
          "type": "integer"
        },
        "design": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
        },
        "transaction": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^transaction_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
        },
        "invoice": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
        },
        "invoice_number": {
          "type": [
            "string",
            "null"
          ]
        },
        "payment": {
          "type": [
            "string",
            "null"
          ],
          "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
        },
        "reminder_due_at": {
          "type": [
            "integer",
            "null"
          ]
        },
        "renewal_due_at": {
          "type": [
            "integer",
            "null"
          ]
        },
        "created_at": {
          "type": "integer"
        },
        "updated_at": {
          "type": "integer"
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "membership",
        "type",
        "period_start",
        "period_end",
        "payment_status",
        "amounts",
        "vat",
        "title",
        "plan_version",
        "design",
        "transaction",
        "invoice",
        "invoice_number",
        "payment",
        "reminder_due_at",
        "renewal_due_at",
        "created_at",
        "updated_at"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "membershipperiod_012345abcdef_123456",
    "membership": "usermembership_012345abcdef_123456",
    "type": "initial",
    "period_start": 1790000000,
    "period_end": 1821536000,
    "payment_status": "free",
    "amounts": {
      "gross": "0.00",
      "net": "0.00",
      "tax": "0.00",
      "currency": "CHF"
    },
    "vat": {
      "id": null,
      "rate": "0.0000",
      "label": ""
    },
    "title": "Jahresmitgliedschaft",
    "plan_version": 1,
    "design": null,
    "transaction": null,
    "invoice": null,
    "invoice_number": null,
    "payment": null,
    "reminder_due_at": 1818944000,
    "renewal_due_at": 1821536000,
    "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"
}

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/Membershipperiod.php:17getMembershipperiod()

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

true

x-edoobox-runtimeMutationGuard

true

x-edoobox-get-effect

"business-mutation"

x-edoobox-documentationReview

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

x-edoobox-source

{
  "file": "application/models/v2/Membershipperiod.php",
  "method": "getMembershipperiod",
  "line": 17
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "membershipperiod",
  "short": "mepe",
  "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_membershipperiod_id",
  "summary": "Periodenbeleg lesen",
  "description": "Liest einen Periodenbeleg anhand der öffentlichen Pfad-ID. Vor der Rückgabe werden verpasste Zahlungsrückmeldungen abgeglichen. Das kann Perioden/Zahlungsreferenzen, Mitgliedschaftsstatus, Gültigkeit, Nutzungsbestand, Audit und Outbox dauerhaft ändern.",
  "tags": [
    "membershipperiod"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "v2 object identifier in the selected account.",
      "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": [
          "membershipperiod_012345abcdef_123456"
        ]
      }
    },
    {
      "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 enthält das dokumentierte Ergebnisobjekt; error=false und success=true.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "membershipperiod_012345abcdef_123456",
              "membership": "usermembership_012345abcdef_123456",
              "type": "initial",
              "period_start": 1790000000,
              "period_end": 1821536000,
              "payment_status": "free",
              "amounts": {
                "gross": "0.00",
                "net": "0.00",
                "tax": "0.00",
                "currency": "CHF"
              },
              "vat": {
                "id": null,
                "rate": "0.0000",
                "label": ""
              },
              "title": "Jahresmitgliedschaft",
              "plan_version": 1,
              "design": null,
              "transaction": null,
              "invoice": null,
              "invoice_number": null,
              "payment": null,
              "reminder_due_at": 1818944000,
              "renewal_due_at": 1821536000,
              "created_at": 1790000000,
              "updated_at": 1790000000
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^membershipperiod_[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."
                  },
                  "type": {
                    "type": "string"
                  },
                  "period_start": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "period_end": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "payment_status": {
                    "type": "string"
                  },
                  "amounts": {
                    "type": "object",
                    "properties": {
                      "gross": {
                        "type": "string",
                        "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                        "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                      },
                      "net": {
                        "type": "string",
                        "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                        "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                      },
                      "tax": {
                        "type": "string",
                        "pattern": "^-?[0-9]+\\.[0-9]{2}$",
                        "description": "Dezimalbetrag als String mit zwei Nachkommastellen."
                      },
                      "currency": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "gross",
                      "net",
                      "tax",
                      "currency"
                    ]
                  },
                  "vat": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                      },
                      "rate": {
                        "type": "string"
                      },
                      "label": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "id",
                      "rate",
                      "label"
                    ]
                  },
                  "title": {
                    "type": "string"
                  },
                  "plan_version": {
                    "type": "integer"
                  },
                  "design": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "pattern": "^design_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                  },
                  "transaction": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "pattern": "^transaction_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                  },
                  "invoice": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                  },
                  "invoice_number": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "payment": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "pattern": "^pay_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID aus diesem Konto; keine rohe Datenbank-ID."
                  },
                  "reminder_due_at": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "renewal_due_at": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "created_at": {
                    "type": "integer"
                  },
                  "updated_at": {
                    "type": "integer"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "membership",
                  "type",
                  "period_start",
                  "period_end",
                  "payment_status",
                  "amounts",
                  "vat",
                  "title",
                  "plan_version",
                  "design",
                  "transaction",
                  "invoice",
                  "invoice_number",
                  "payment",
                  "reminder_due_at",
                  "renewal_due_at",
                  "created_at",
                  "updated_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": true,
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-get-effect": "business-mutation",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/01-membership.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Membershipperiod.php",
    "method": "getMembershipperiod",
    "line": 17
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "membershipperiod",
    "short": "mepe",
    "checkedByDispatcher": true,
    "levels": [
      1,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${PATH_ID:?PATH_ID setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/membershipperiod/'"${PATH_ID}"'' \
  --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/membershipperiod/{id}";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
import os
import urllib.parse
import urllib.request
import urllib.error

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

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="GET")
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/membershipperiod/{id}";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
import os
import urllib.parse
import urllib.request
import urllib.error

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

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="GET")
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.