Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
pricecategoryAPI-Referenz
GET/v2/pricecategory/{id}/data

Belegung und freie Plätze einer Preiskategorie prüfen

Liefert zugeordnete Buchungen, noch gültige Reservierungstimer und verfügbare Plätze. Bei Standardkategorien gilt die Angebotskapazität, bei anderen Kategorien zusätzlich customer_limit. Bei freier Terminauswahl wird die Kapazität entsprechend den zukünftigen Terminen berechnet; available ist mindestens 0. Die Operation reserviert keine Plätze.

Operation-ID get_v2_pricecategory_id_data

01

Vertrag & Verhalten

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

read

02

Authentifizierung

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

Alternative 1

bearerAuthhttp · bearer

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

Format: JWT

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

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

header: edid

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

Alternative 2

sessionCookieapiKey

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

cookie: _edlogin

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

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

header: edid

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

Berechtigungen

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

03

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
"pricecategory_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": [
    "pricecategory_012345abcdef_123456"
  ]
}

Query-Parameter

filteroptional

JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.

application/json

array
Schema-Beispiel
[
  {
    "property": "id",
    "expression": "=",
    "value": "pricecategory_012345abcdef_123456"
  }
]
Array-Elemente
object
property string
expression string
value Typ nicht eingeschränkt

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

Vollständiges Schema als JSON
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "expression": {
        "type": "string"
      },
      "value": {}
    },
    "additionalProperties": true
  },
  "examples": [
    [
      {
        "property": "id",
        "expression": "=",
        "value": "pricecategory_012345abcdef_123456"
      }
    ]
  ]
}
Beispiel
[
  {
    "property": "id",
    "expression": "=",
    "value": "pricecategory_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"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

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

200application/json

Ergebnis in data mit den beschriebenen Feldern; error und die Ergebniskennzeichen müssen ausgewertet werden.

application/json

object
success boolean
error boolean | string
error_code string
data object
id string erforderlich

Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.

pattern
"^pricecategory_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"pricecategory_012345abcdef_123456"
offer string erforderlich

Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.

pattern
"^offer_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"offer_012345abcdef_123456"
statistics object erforderlich
assigned integer erforderlich
reserved integer erforderlich
available integer erforderlich

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

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": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
          "examples": [
            "pricecategory_012345abcdef_123456"
          ]
        },
        "offer": {
          "type": "string",
          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
          "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
          "examples": [
            "offer_012345abcdef_123456"
          ]
        },
        "statistics": {
          "type": "object",
          "properties": {
            "assigned": {
              "type": "integer"
            },
            "reserved": {
              "type": "integer"
            },
            "available": {
              "type": "integer"
            }
          },
          "additionalProperties": true,
          "required": [
            "assigned",
            "reserved",
            "available"
          ]
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "offer",
        "statistics"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}
Beispiel
{
  "success": true,
  "error": false,
  "data": {
    "id": "pricecategory_012345abcdef_123456",
    "offer": "offer_012345abcdef_123456",
    "statistics": {
      "assigned": 8,
      "reserved": 2,
      "available": 10
    }
  }
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

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

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

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

application/json

Typ nicht eingeschränkt

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

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

Missing/invalid action data or subscription/operation restriction.

application/json

Typ nicht eingeschränkt

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

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

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

application/json

Typ nicht eingeschränkt

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

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

Unknown resource/action or unsupported method.

application/json

Typ nicht eingeschränkt

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

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

Validation failed.

application/json

Typ nicht eingeschränkt

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

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

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

Response Header

Retry-After

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

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

application/json

Typ nicht eingeschränkt

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

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

Server-side operation failed.

application/json

Typ nicht eingeschränkt

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

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

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Pricecategory.php:267getPricecategory()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state
false
x-edoobox-mutationReview
{
  "source": {
    "file": "application/models/v2/Pricecategory.php",
    "line": 313
  },
  "reason": "Reviewed complete data branch: constructor only declares Structure/loads API_DATA; getPricecategory selects getPricecategoryData, which decodes the account pricecategory ID, performs SELECT/COUNT queries for active bookings and unexpired reservations, clamps computed availability, and serializes public IDs/statistics. ParticipantBooking::activeBookingSql validates an alias and returns an SQL predicate string. No INSERT/UPDATE/DELETE, mail, provider call, default creation or cleanup is reached.",
  "relatedSources": [
    {
      "file": "application/libraries/edoobox/helper/ParticipantBooking.php",
      "line": 13
    }
  ]
}
x-edoobox-runtimeMutationGuard
false
x-edoobox-get-effect
"read"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/03-offers-places.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Pricecategory.php",
  "method": "getPricecategory",
  "line": 267,
  "branch": {
    "file": "application/models/v2/Pricecategory.php",
    "line": 296
  }
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
true
x-edoobox-permission
{
  "resource": "pricecategory",
  "short": "prca",
  "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_pricecategory_id_data",
  "summary": "Belegung und freie Plätze einer Preiskategorie prüfen",
  "description": "Liefert zugeordnete Buchungen, noch gültige Reservierungstimer und verfügbare Plätze. Bei Standardkategorien gilt die Angebotskapazität, bei anderen Kategorien zusätzlich customer_limit. Bei freier Terminauswahl wird die Kapazität entsprechend den zukünftigen Terminen berechnet; available ist mindestens 0. Die Operation reserviert keine Plätze.",
  "tags": [
    "pricecategory"
  ],
  "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": [
          "pricecategory_012345abcdef_123456"
        ]
      }
    },
    {
      "name": "filter",
      "in": "query",
      "required": false,
      "description": "JSON-encoded filter value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "expression": {
                  "type": "string"
                },
                "value": {}
              },
              "additionalProperties": true
            },
            "examples": [
              [
                {
                  "property": "id",
                  "expression": "=",
                  "value": "pricecategory_012345abcdef_123456"
                }
              ]
            ]
          },
          "example": [
            {
              "property": "id",
              "expression": "=",
              "value": "pricecategory_012345abcdef_123456"
            }
          ]
        }
      }
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Ergebnis in data mit den beschriebenen Feldern; error und die Ergebniskennzeichen müssen ausgewertet werden.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "pricecategory_012345abcdef_123456",
              "offer": "offer_012345abcdef_123456",
              "statistics": {
                "assigned": 8,
                "reserved": 2,
                "available": 10
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "pattern": "^pricecategory_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                    "examples": [
                      "pricecategory_012345abcdef_123456"
                    ]
                  },
                  "offer": {
                    "type": "string",
                    "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                    "examples": [
                      "offer_012345abcdef_123456"
                    ]
                  },
                  "statistics": {
                    "type": "object",
                    "properties": {
                      "assigned": {
                        "type": "integer"
                      },
                      "reserved": {
                        "type": "integer"
                      },
                      "available": {
                        "type": "integer"
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "assigned",
                      "reserved",
                      "available"
                    ]
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "offer",
                  "statistics"
                ]
              },
              "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-mutationReview": {
    "source": {
      "file": "application/models/v2/Pricecategory.php",
      "line": 313
    },
    "reason": "Reviewed complete data branch: constructor only declares Structure/loads API_DATA; getPricecategory selects getPricecategoryData, which decodes the account pricecategory ID, performs SELECT/COUNT queries for active bookings and unexpired reservations, clamps computed availability, and serializes public IDs/statistics. ParticipantBooking::activeBookingSql validates an alias and returns an SQL predicate string. No INSERT/UPDATE/DELETE, mail, provider call, default creation or cleanup is reached.",
    "relatedSources": [
      {
        "file": "application/libraries/edoobox/helper/ParticipantBooking.php",
        "line": 13
      }
    ]
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/03-offers-places.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Pricecategory.php",
    "method": "getPricecategory",
    "line": 267,
    "branch": {
      "file": "application/models/v2/Pricecategory.php",
      "line": 296
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "pricecategory",
    "short": "prca",
    "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."
  }
}