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
cancellationconditionAPI-Referenz
GET/v2/cancellationcondition/{id}

Stornierungsgruppen und Widerrufsregeln abrufen

Liest eine Gruppe per Pfad-ID bzw. id-Filter oder eine nach Gruppen-ID indizierte Map. Vor dem Lesen werden fehlende Standardgruppen angelegt und der Standardstatus sichergestellt.

Operation-ID get_v2_cancellationcondition_id

01

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

maintenance

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
cancellationcondition · caco
Levels
1, 3, 4
Dispatcher-Prüfung
Ja
03

Parameter

Pfadparameter

iderforderlich

Öffentliche cancellationconditiongroup-ID.

string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"cancellationconditiongroup_012345abcdef_123456"
Vollständiges Schema als JSON
{
  "type": "string",
  "pattern": "^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$",
  "examples": [
    "cancellationconditiongroup_012345abcdef_123456"
  ],
  "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
}

Query-Parameter

filteroptional

JSON-kodierte Filterliste. Diese Ressource wertet nur die genannten Eigenschaften aus.

application/json

array
Array-Elemente
object
property string erforderlich
Erlaubte Werte
"id"
expression string

Hier wird Gleichheit verwendet; expression wird ignoriert.

value Typ nicht eingeschränkt erforderlich

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

Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string",
        "enum": [
          "id"
        ]
      },
      "expression": {
        "type": "string",
        "description": "Hier wird Gleichheit verwendet; expression wird ignoriert."
      },
      "value": {}
    },
    "additionalProperties": true,
    "required": [
      "property",
      "value"
    ]
  }
}
Beispiel
[
  {
    "property": "id",
    "value": "cancellationconditiongroup_012345abcdef_123456"
  }
]

Header

languageoptional

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

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
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"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

11

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

200application/json

Gruppenobjekt beim gültigen id-Selektor, sonst ID-Map; leere PHP-Map wird als [] ausgegeben.

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
anyOf · Mindestens eine Variante muss passen
Variante 1 object
id string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"cancellationconditiongroup_012345abcdef_123456"
name string
name_translations object
Schema für zusätzliche Felder
string
slug string
active boolean
default boolean
auto_refund boolean
refund_method string
legaltext Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^legaltext_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"legaltext_012345abcdef_123456"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

vat Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^vat_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"vat_012345abcdef_123456"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

withdrawal object
enabled boolean
url string
checkbox_label string
checkbox_label_translations object
Schema für zusätzliche Felder
string

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

rules array
Array-Elemente
object
id string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^cancellationconditionrule_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"cancellationconditionrule_012345abcdef_123456"
days_before_start integer
action string
fee_percent number
active boolean
sort_order integer

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

compact_table_html string

HTML-Regelübersicht.

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

Variante 2 object
Schema für zusätzliche Felder
object
id string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"cancellationconditiongroup_012345abcdef_123456"
name string
name_translations object
Schema für zusätzliche Felder
string
slug string
active boolean
default boolean
auto_refund boolean
refund_method string
legaltext Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^legaltext_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"legaltext_012345abcdef_123456"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

vat Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^vat_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"vat_012345abcdef_123456"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

withdrawal object
enabled boolean
url string
checkbox_label string
checkbox_label_translations object
Schema für zusätzliche Felder
string

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

rules array
Array-Elemente
object
id string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^cancellationconditionrule_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"cancellationconditionrule_012345abcdef_123456"
days_before_start integer
action string
fee_percent number
active boolean
sort_order integer

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

compact_table_html string

HTML-Regelübersicht.

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

Variante 3 array
Array-Elemente
object
id string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"cancellationconditiongroup_012345abcdef_123456"
name string
name_translations object
Schema für zusätzliche Felder
string
slug string
active boolean
default boolean
auto_refund boolean
refund_method string
legaltext Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^legaltext_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"legaltext_012345abcdef_123456"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

vat Typ nicht eingeschränkt
anyOf · Mindestens eine Variante muss passen
Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^vat_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"vat_012345abcdef_123456"
Variante 2 Typ nicht eingeschränkt

Fester Wert: false

withdrawal object
enabled boolean
url string
checkbox_label string
checkbox_label_translations object
Schema für zusätzliche Felder
string

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

rules array
Array-Elemente
object
id string

Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch.

pattern
"^cancellationconditionrule_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"cancellationconditionrule_012345abcdef_123456"
days_before_start integer
action string
fee_percent number
active boolean
sort_order integer

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

compact_table_html string

HTML-Regelübersicht.

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": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "pattern": "^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$",
              "examples": [
                "cancellationconditiongroup_012345abcdef_123456"
              ],
              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
            },
            "name": {
              "type": "string"
            },
            "name_translations": {
              "type": "object",
              "additionalProperties": {
                "type": "string"
              }
            },
            "slug": {
              "type": "string"
            },
            "active": {
              "type": "boolean"
            },
            "default": {
              "type": "boolean"
            },
            "auto_refund": {
              "type": "boolean"
            },
            "refund_method": {
              "type": "string"
            },
            "legaltext": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^legaltext_[a-f0-9]{12}_-?[0-9]+$",
                  "examples": [
                    "legaltext_012345abcdef_123456"
                  ],
                  "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                },
                {
                  "const": false
                }
              ]
            },
            "vat": {
              "anyOf": [
                {
                  "type": "string",
                  "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                  "examples": [
                    "vat_012345abcdef_123456"
                  ],
                  "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                },
                {
                  "const": false
                }
              ]
            },
            "withdrawal": {
              "type": "object",
              "properties": {
                "enabled": {
                  "type": "boolean"
                },
                "url": {
                  "type": "string"
                },
                "checkbox_label": {
                  "type": "string"
                },
                "checkbox_label_translations": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              },
              "additionalProperties": true
            },
            "rules": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^cancellationconditionrule_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "cancellationconditionrule_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                  },
                  "days_before_start": {
                    "type": "integer"
                  },
                  "action": {
                    "type": "string"
                  },
                  "fee_percent": {
                    "type": "number"
                  },
                  "active": {
                    "type": "boolean"
                  },
                  "sort_order": {
                    "type": "integer"
                  }
                },
                "additionalProperties": true
              }
            },
            "compact_table_html": {
              "type": "string",
              "description": "HTML-Regelübersicht."
            }
          },
          "additionalProperties": true
        },
        {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "cancellationconditiongroup_012345abcdef_123456"
                ],
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
              },
              "name": {
                "type": "string"
              },
              "name_translations": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                }
              },
              "slug": {
                "type": "string"
              },
              "active": {
                "type": "boolean"
              },
              "default": {
                "type": "boolean"
              },
              "auto_refund": {
                "type": "boolean"
              },
              "refund_method": {
                "type": "string"
              },
              "legaltext": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^legaltext_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "legaltext_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                  },
                  {
                    "const": false
                  }
                ]
              },
              "vat": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "vat_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                  },
                  {
                    "const": false
                  }
                ]
              },
              "withdrawal": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "url": {
                    "type": "string"
                  },
                  "checkbox_label": {
                    "type": "string"
                  },
                  "checkbox_label_translations": {
                    "type": "object",
                    "additionalProperties": {
                      "type": "string"
                    }
                  }
                },
                "additionalProperties": true
              },
              "rules": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^cancellationconditionrule_[a-f0-9]{12}_-?[0-9]+$",
                      "examples": [
                        "cancellationconditionrule_012345abcdef_123456"
                      ],
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                    },
                    "days_before_start": {
                      "type": "integer"
                    },
                    "action": {
                      "type": "string"
                    },
                    "fee_percent": {
                      "type": "number"
                    },
                    "active": {
                      "type": "boolean"
                    },
                    "sort_order": {
                      "type": "integer"
                    }
                  },
                  "additionalProperties": true
                }
              },
              "compact_table_html": {
                "type": "string",
                "description": "HTML-Regelübersicht."
              }
            },
            "additionalProperties": true
          }
        },
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "cancellationconditiongroup_012345abcdef_123456"
                ],
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
              },
              "name": {
                "type": "string"
              },
              "name_translations": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                }
              },
              "slug": {
                "type": "string"
              },
              "active": {
                "type": "boolean"
              },
              "default": {
                "type": "boolean"
              },
              "auto_refund": {
                "type": "boolean"
              },
              "refund_method": {
                "type": "string"
              },
              "legaltext": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^legaltext_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "legaltext_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                  },
                  {
                    "const": false
                  }
                ]
              },
              "vat": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "vat_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                  },
                  {
                    "const": false
                  }
                ]
              },
              "withdrawal": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "url": {
                    "type": "string"
                  },
                  "checkbox_label": {
                    "type": "string"
                  },
                  "checkbox_label_translations": {
                    "type": "object",
                    "additionalProperties": {
                      "type": "string"
                    }
                  }
                },
                "additionalProperties": true
              },
              "rules": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^cancellationconditionrule_[a-f0-9]{12}_-?[0-9]+$",
                      "examples": [
                        "cancellationconditionrule_012345abcdef_123456"
                      ],
                      "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                    },
                    "days_before_start": {
                      "type": "integer"
                    },
                    "action": {
                      "type": "string"
                    },
                    "fee_percent": {
                      "type": "number"
                    },
                    "active": {
                      "type": "boolean"
                    },
                    "sort_order": {
                      "type": "integer"
                    }
                  },
                  "additionalProperties": true
                }
              },
              "compact_table_html": {
                "type": "string",
                "description": "HTML-Regelübersicht."
              }
            },
            "additionalProperties": true
          }
        }
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "id": "cancellationconditiongroup_012345abcdef_123456",
    "name": "Flexible Stornierung",
    "name_translations": {
      "de": "Flexible Stornierung"
    },
    "slug": "flexible-stornierung",
    "active": true,
    "default": false,
    "auto_refund": true,
    "refund_method": "online",
    "legaltext": false,
    "vat": false,
    "withdrawal": {
      "enabled": true,
      "url": "https://app2.edoobox.com/EXAMPLE/?edwithdrawal=cancellationconditiongroup_012345abcdef_123456",
      "checkbox_label": "Beispiel einer Widerrufsbestätigung",
      "checkbox_label_translations": {
        "de": "Beispiel einer Widerrufsbestätigung"
      }
    },
    "rules": [
      {
        "id": "cancellationconditionrule_012345abcdef_123456",
        "days_before_start": 14,
        "action": "automatic",
        "fee_percent": 25,
        "active": true,
        "sort_order": 0
      }
    ],
    "compact_table_html": "<table><tr><td>14 Tage</td><td>25 %</td></tr></table>"
  }
}
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

Retry-After

integer

Fester Wert: 1

Vollständiges Schema als JSON
{
  "type": "integer",
  "const": 1
}

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"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Cancellationcondition.php:17getCancellationcondition()

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-mutationReview
{
  "source": {
    "file": "application/models/v2/Cancellationcondition.php",
    "line": 190
  },
  "reason": "GET ensures default groups/configuration and can INSERT missing rows (Dunning.php206)."
}
x-edoobox-runtimeMutationGuard
true
x-edoobox-get-effect
"maintenance"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/08-subscriptions.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Cancellationcondition.php",
  "method": "getCancellationcondition",
  "line": 17
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
false
x-edoobox-safeForAutomation
false
x-edoobox-permission
{
  "resource": "cancellationcondition",
  "short": "caco",
  "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_cancellationcondition_id",
  "summary": "Stornierungsgruppen und Widerrufsregeln abrufen",
  "description": "Liest eine Gruppe per Pfad-ID bzw. id-Filter oder eine nach Gruppen-ID indizierte Map. Vor dem Lesen werden fehlende Standardgruppen angelegt und der Standardstatus sichergestellt.",
  "tags": [
    "cancellationcondition"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "Öffentliche cancellationconditiongroup-ID.",
      "schema": {
        "type": "string",
        "pattern": "^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$",
        "examples": [
          "cancellationconditiongroup_012345abcdef_123456"
        ],
        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
      }
    },
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "JSON-kodierte Filterliste. Diese Ressource wertet nur die genannten Eigenschaften aus.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string",
                  "enum": [
                    "id"
                  ]
                },
                "expression": {
                  "type": "string",
                  "description": "Hier wird Gleichheit verwendet; expression wird ignoriert."
                },
                "value": {}
              },
              "additionalProperties": true,
              "required": [
                "property",
                "value"
              ]
            }
          },
          "example": [
            {
              "property": "id",
              "value": "cancellationconditiongroup_012345abcdef_123456"
            }
          ]
        }
      }
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "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": "Gruppenobjekt beim gültigen id-Selektor, sonst ID-Map; leere PHP-Map wird als [] ausgegeben.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "cancellationconditiongroup_012345abcdef_123456",
              "name": "Flexible Stornierung",
              "name_translations": {
                "de": "Flexible Stornierung"
              },
              "slug": "flexible-stornierung",
              "active": true,
              "default": false,
              "auto_refund": true,
              "refund_method": "online",
              "legaltext": false,
              "vat": false,
              "withdrawal": {
                "enabled": true,
                "url": "https://app2.edoobox.com/EXAMPLE/?edwithdrawal=cancellationconditiongroup_012345abcdef_123456",
                "checkbox_label": "Beispiel einer Widerrufsbestätigung",
                "checkbox_label_translations": {
                  "de": "Beispiel einer Widerrufsbestätigung"
                }
              },
              "rules": [
                {
                  "id": "cancellationconditionrule_012345abcdef_123456",
                  "days_before_start": 14,
                  "action": "automatic",
                  "fee_percent": 25,
                  "active": true,
                  "sort_order": 0
                }
              ],
              "compact_table_html": "<table><tr><td>14 Tage</td><td>25 %</td></tr></table>"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "pattern": "^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$",
                        "examples": [
                          "cancellationconditiongroup_012345abcdef_123456"
                        ],
                        "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                      },
                      "name": {
                        "type": "string"
                      },
                      "name_translations": {
                        "type": "object",
                        "additionalProperties": {
                          "type": "string"
                        }
                      },
                      "slug": {
                        "type": "string"
                      },
                      "active": {
                        "type": "boolean"
                      },
                      "default": {
                        "type": "boolean"
                      },
                      "auto_refund": {
                        "type": "boolean"
                      },
                      "refund_method": {
                        "type": "string"
                      },
                      "legaltext": {
                        "anyOf": [
                          {
                            "type": "string",
                            "pattern": "^legaltext_[a-f0-9]{12}_-?[0-9]+$",
                            "examples": [
                              "legaltext_012345abcdef_123456"
                            ],
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                          },
                          {
                            "const": false
                          }
                        ]
                      },
                      "vat": {
                        "anyOf": [
                          {
                            "type": "string",
                            "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                            "examples": [
                              "vat_012345abcdef_123456"
                            ],
                            "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                          },
                          {
                            "const": false
                          }
                        ]
                      },
                      "withdrawal": {
                        "type": "object",
                        "properties": {
                          "enabled": {
                            "type": "boolean"
                          },
                          "url": {
                            "type": "string"
                          },
                          "checkbox_label": {
                            "type": "string"
                          },
                          "checkbox_label_translations": {
                            "type": "object",
                            "additionalProperties": {
                              "type": "string"
                            }
                          }
                        },
                        "additionalProperties": true
                      },
                      "rules": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "id": {
                              "type": "string",
                              "pattern": "^cancellationconditionrule_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "cancellationconditionrule_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                            },
                            "days_before_start": {
                              "type": "integer"
                            },
                            "action": {
                              "type": "string"
                            },
                            "fee_percent": {
                              "type": "number"
                            },
                            "active": {
                              "type": "boolean"
                            },
                            "sort_order": {
                              "type": "integer"
                            }
                          },
                          "additionalProperties": true
                        }
                      },
                      "compact_table_html": {
                        "type": "string",
                        "description": "HTML-Regelübersicht."
                      }
                    },
                    "additionalProperties": true
                  },
                  {
                    "type": "object",
                    "additionalProperties": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "cancellationconditiongroup_012345abcdef_123456"
                          ],
                          "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                        },
                        "name": {
                          "type": "string"
                        },
                        "name_translations": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "string"
                          }
                        },
                        "slug": {
                          "type": "string"
                        },
                        "active": {
                          "type": "boolean"
                        },
                        "default": {
                          "type": "boolean"
                        },
                        "auto_refund": {
                          "type": "boolean"
                        },
                        "refund_method": {
                          "type": "string"
                        },
                        "legaltext": {
                          "anyOf": [
                            {
                              "type": "string",
                              "pattern": "^legaltext_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "legaltext_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "vat": {
                          "anyOf": [
                            {
                              "type": "string",
                              "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "vat_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "withdrawal": {
                          "type": "object",
                          "properties": {
                            "enabled": {
                              "type": "boolean"
                            },
                            "url": {
                              "type": "string"
                            },
                            "checkbox_label": {
                              "type": "string"
                            },
                            "checkbox_label_translations": {
                              "type": "object",
                              "additionalProperties": {
                                "type": "string"
                              }
                            }
                          },
                          "additionalProperties": true
                        },
                        "rules": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "pattern": "^cancellationconditionrule_[a-f0-9]{12}_-?[0-9]+$",
                                "examples": [
                                  "cancellationconditionrule_012345abcdef_123456"
                                ],
                                "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                              },
                              "days_before_start": {
                                "type": "integer"
                              },
                              "action": {
                                "type": "string"
                              },
                              "fee_percent": {
                                "type": "number"
                              },
                              "active": {
                                "type": "boolean"
                              },
                              "sort_order": {
                                "type": "integer"
                              }
                            },
                            "additionalProperties": true
                          }
                        },
                        "compact_table_html": {
                          "type": "string",
                          "description": "HTML-Regelübersicht."
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^cancellationconditiongroup_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "cancellationconditiongroup_012345abcdef_123456"
                          ],
                          "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                        },
                        "name": {
                          "type": "string"
                        },
                        "name_translations": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "string"
                          }
                        },
                        "slug": {
                          "type": "string"
                        },
                        "active": {
                          "type": "boolean"
                        },
                        "default": {
                          "type": "boolean"
                        },
                        "auto_refund": {
                          "type": "boolean"
                        },
                        "refund_method": {
                          "type": "string"
                        },
                        "legaltext": {
                          "anyOf": [
                            {
                              "type": "string",
                              "pattern": "^legaltext_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "legaltext_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "vat": {
                          "anyOf": [
                            {
                              "type": "string",
                              "pattern": "^vat_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "vat_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "withdrawal": {
                          "type": "object",
                          "properties": {
                            "enabled": {
                              "type": "boolean"
                            },
                            "url": {
                              "type": "string"
                            },
                            "checkbox_label": {
                              "type": "string"
                            },
                            "checkbox_label_translations": {
                              "type": "object",
                              "additionalProperties": {
                                "type": "string"
                              }
                            }
                          },
                          "additionalProperties": true
                        },
                        "rules": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "pattern": "^cancellationconditionrule_[a-f0-9]{12}_-?[0-9]+$",
                                "examples": [
                                  "cancellationconditionrule_012345abcdef_123456"
                                ],
                                "description": "Öffentliche v2-ID aus dem ausgewählten Konto; Beispiel ist synthetisch."
                              },
                              "days_before_start": {
                                "type": "integer"
                              },
                              "action": {
                                "type": "string"
                              },
                              "fee_percent": {
                                "type": "number"
                              },
                              "active": {
                                "type": "boolean"
                              },
                              "sort_order": {
                                "type": "integer"
                              }
                            },
                            "additionalProperties": true
                          }
                        },
                        "compact_table_html": {
                          "type": "string",
                          "description": "HTML-Regelübersicht."
                        }
                      },
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "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-mutationReview": {
    "source": {
      "file": "application/models/v2/Cancellationcondition.php",
      "line": 190
    },
    "reason": "GET ensures default groups/configuration and can INSERT missing rows (Dunning.php206)."
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-get-effect": "maintenance",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/08-subscriptions.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Cancellationcondition.php",
    "method": "getCancellationcondition",
    "line": 17
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "cancellationcondition",
    "short": "caco",
    "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