GET/v2/admission/internal_documents

Interne Angebotsdokumente im Leiterkontext lesen

Prüft den Leiter-/Adminzugang auf filter.date und fragt danach nicht gelöschte Dateien des Kontos über den allgemeinen Dateihandler ab. Die Terminprüfung beschränkt die Dateiauswahl aktuell nicht automatisch auf das Angebot oder interne Dokumente. Für genau dessen interne Unterlagen zusätzlich explizite property/value-Filter auf resource_type=offer, resource_id mit der Angebots-ID und filetype=internalOfferFile senden. Custom-Exportdateien sind ausgeschlossen.

Operation-ID get_v2_admission_internal_documents

Vertrag & Verhalten

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

GET-Verhalten laut Spezifikation

read

Authentifizierung

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

Alternative 1

bearerAuthhttp · bearer

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

Format: JWT

Security-Schema als JSON

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

accountContextapiKey

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

header: edid

Security-Schema als JSON

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

Alternative 2

sessionCookieapiKey

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

cookie: _edlogin

Security-Schema als JSON

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

accountContextapiKey

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

header: edid

Security-Schema als JSON

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

Berechtigungen

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

Ressource: admission · adms
Levels: 1, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Query-Parameter

fieldsoptional

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

`application/json`

array

Schema-Beispiel

[
  "id"
]

Array-Elemente

string

Vollständiges Schema als JSON

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "examples": [
    [
      "id"
    ]
  ]
}

Beispiel

[
  "id"
]

filtererforderlich

date ist für die Terminprüfung erforderlich. Für die gewünschte Dateiauswahl zusätzliche explizite Ressourcen-/Dateitypfilter setzen.

`application/json`

array

Array-Elemente

object

property string erforderlich

expression string

value Typ nicht eingeschränkt erforderlich

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

allOf · Alle Teilschemas müssen gemeinsam passen

Variante 1 Typ nicht eingeschränkt

Schema-Regel contains

object

property Typ nicht eingeschränkt erforderlich

Fester Wert: "date"

value string erforderlich

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

Schema-Beispiel

"date_012345abcdef_123456"

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,
    "required": [
      "property",
      "value"
    ]
  },
  "allOf": [
    {
      "contains": {
        "type": "object",
        "properties": {
          "property": {
            "const": "date"
          },
          "value": {
            "type": "string",
            "pattern": "^date_[a-f0-9]{12}_-?[0-9]+$",
            "examples": [
              "date_012345abcdef_123456"
            ]
          }
        },
        "additionalProperties": true,
        "required": [
          "property",
          "value"
        ]
      }
    }
  ]
}

Beispiel

[
  {
    "property": "date",
    "value": "date_012345abcdef_123456"
  },
  {
    "property": "resource_type",
    "value": "offer"
  },
  {
    "property": "resource_id",
    "value": "offer_012345abcdef_123456"
  },
  {
    "property": "filetype",
    "value": "internalOfferFile"
  }
]

limitoptional

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

`application/json`

object

Schema-Beispiel

{
  "start": 0,
  "reply": 25
}

start integer

minimum: 0

Standardwert: 0

reply integer

maximum: 2000

Standardwert: 100

Vollständiges Schema als JSON

{
  "type": "object",
  "properties": {
    "start": {
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "reply": {
      "type": "integer",
      "maximum": 2000,
      "default": 100
    }
  },
  "examples": [
    {
      "start": 0,
      "reply": 25
    }
  ]
}

Beispiel

{
  "start": 0,
  "reply": 25
}

orderoptional

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

`application/json`

array

Schema-Beispiel

[
  {
    "property": "id",
    "value": "ASC"
  }
]

Array-Elemente

object

property string

value string

Erlaubte Werte

"ASC""DESC"

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

Vollständiges Schema als JSON

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "property": {
        "type": "string"
      },
      "value": {
        "type": "string",
        "enum": [
          "ASC",
          "DESC"
        ]
      }
    },
    "additionalProperties": true
  },
  "examples": [
    [
      {
        "property": "id",
        "value": "ASC"
      }
    ]
  ]
}

Beispiel

[
  {
    "property": "id",
    "value": "ASC"
  }
]

response_typeoptional

Controls generic collection representation; default is an ID-keyed object.

string

Erlaubte Werte

"array""object"

Schema-Beispiel

"array"

Vollständiges Schema als JSON

{
  "type": "string",
  "enum": [
    "array",
    "object"
  ],
  "examples": [
    "array"
  ]
}

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

Request Body

Kein Request Body in der Spezifikation beschrieben.

Antworten

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

200application/json

data ist standardmässig eine nach files-ID indizierte Sammlung; response_type=array liefert eine Liste. Eine leere Sammlung kann [] sein.

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 array

Array-Elemente

object

id string

Öffentliche v2-ID aus dem ausgewählten Konto.

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

Schema-Beispiel

"files_012345abcdef_123456"

filename string

description Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 object

Schema für zusätzliche Felder

string

Variante 2 array

Array-Elemente

Typ nicht eingeschränkt

filetype string

resource_type string

resource_id Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto.

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

Schema-Beispiel

"user_012345abcdef_123456"

Variante 2 string

Öffentliche v2-ID aus dem ausgewählten Konto.

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

Schema-Beispiel

"offer_012345abcdef_123456"

Variante 3 string

Öffentliche v2-ID aus dem ausgewählten Konto.

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

Schema-Beispiel

"admin_012345abcdef_123456"

Variante 4 Typ nicht eingeschränkt

Fester Wert: false

last_change string

format: "date-time"

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.

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

Schema-Beispiel

"files_012345abcdef_123456"

filename string

description Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 object

Schema für zusätzliche Felder

string

Variante 2 array

Array-Elemente

Typ nicht eingeschränkt

filetype string

resource_type string

resource_id Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Öffentliche v2-ID aus dem ausgewählten Konto.

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

Schema-Beispiel

"user_012345abcdef_123456"

Variante 2 string

Öffentliche v2-ID aus dem ausgewählten Konto.

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

Schema-Beispiel

"offer_012345abcdef_123456"

Variante 3 string

Öffentliche v2-ID aus dem ausgewählten Konto.

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

Schema-Beispiel

"admin_012345abcdef_123456"

Variante 4 Typ nicht eingeschränkt

Fester Wert: false

last_change string

format: "date-time"

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": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^files_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "files_012345abcdef_123456"
                ],
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
              },
              "filename": {
                "type": "string"
              },
              "description": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": {
                      "type": "string"
                    }
                  },
                  {
                    "type": "array",
                    "items": {}
                  }
                ]
              },
              "filetype": {
                "type": "string"
              },
              "resource_type": {
                "type": "string"
              },
              "resource_id": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "user_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                  },
                  {
                    "type": "string",
                    "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "offer_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                  },
                  {
                    "type": "string",
                    "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "admin_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                  },
                  {
                    "const": false
                  }
                ]
              },
              "last_change": {
                "type": "string",
                "format": "date-time"
              }
            },
            "additionalProperties": true
          }
        },
        {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^files_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "files_012345abcdef_123456"
                ],
                "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
              },
              "filename": {
                "type": "string"
              },
              "description": {
                "anyOf": [
                  {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": {
                      "type": "string"
                    }
                  },
                  {
                    "type": "array",
                    "items": {}
                  }
                ]
              },
              "filetype": {
                "type": "string"
              },
              "resource_type": {
                "type": "string"
              },
              "resource_id": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "user_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                  },
                  {
                    "type": "string",
                    "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "offer_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                  },
                  {
                    "type": "string",
                    "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "admin_012345abcdef_123456"
                    ],
                    "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                  },
                  {
                    "const": false
                  }
                ]
              },
              "last_change": {
                "type": "string",
                "format": "date-time"
              }
            },
            "additionalProperties": true
          }
        }
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "files_012345abcdef_123456": {
      "id": "files_012345abcdef_123456",
      "filename": "Unterlagen.pdf",
      "description": {
        "de": "Kursunterlagen"
      },
      "filetype": "internalOfferFile",
      "resource_type": "offer",
      "resource_id": "offer_012345abcdef_123456",
      "last_change": "2026-10-22T10:00:00+02:00"
    }
  }
}

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/Admission.php:136getAdmission()

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

x-edoobox-mutates-state

false

x-edoobox-runtimeMutationGuard

true

x-edoobox-get-effect

"read"

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/02-booking-users.json",
  "notes": [
    "Quellseitig werden resource_type/resource_id/filetype als assoziative filter-Schlüssel ergänzt. API_DATA verarbeitet nur property/value-Einträge; diese vorbereiteten Schlüssel begrenzen die Liste daher nicht. Die Dokumentation behauptet keine zusätzliche Angebotsberechtigung für gelistete Dateien."
  ]
}

x-edoobox-source

{
  "file": "application/models/v2/Admission.php",
  "method": "getAdmission",
  "line": 136,
  "branch": {
    "file": "application/models/v2/Admission.php",
    "line": 156
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

true

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "admission",
  "short": "adms",
  "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_admission_internal_documents",
  "summary": "Interne Angebotsdokumente im Leiterkontext lesen",
  "description": "Prüft den Leiter-/Adminzugang auf filter.date und fragt danach nicht gelöschte Dateien des Kontos über den allgemeinen Dateihandler ab. Die Terminprüfung beschränkt die Dateiauswahl aktuell nicht automatisch auf das Angebot oder interne Dokumente. Für genau dessen interne Unterlagen zusätzlich explizite property/value-Filter auf resource_type=offer, resource_id mit der Angebots-ID und filetype=internalOfferFile senden. Custom-Exportdateien sind ausgeschlossen.",
  "tags": [
    "admission"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "fields",
      "in": "query",
      "required": false,
      "description": "JSON-encoded fields value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "examples": [
              [
                "id"
              ]
            ]
          },
          "example": [
            "id"
          ]
        }
      }
    },
    {
      "name": "filter",
      "in": "query",
      "required": true,
      "description": "date ist für die Terminprüfung erforderlich. Für die gewünschte Dateiauswahl zusätzliche explizite Ressourcen-/Dateitypfilter setzen.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "expression": {
                  "type": "string"
                },
                "value": {}
              },
              "additionalProperties": true,
              "required": [
                "property",
                "value"
              ]
            },
            "allOf": [
              {
                "contains": {
                  "type": "object",
                  "properties": {
                    "property": {
                      "const": "date"
                    },
                    "value": {
                      "type": "string",
                      "pattern": "^date_[a-f0-9]{12}_-?[0-9]+$",
                      "examples": [
                        "date_012345abcdef_123456"
                      ]
                    }
                  },
                  "additionalProperties": true,
                  "required": [
                    "property",
                    "value"
                  ]
                }
              }
            ]
          },
          "example": [
            {
              "property": "date",
              "value": "date_012345abcdef_123456"
            },
            {
              "property": "resource_type",
              "value": "offer"
            },
            {
              "property": "resource_id",
              "value": "offer_012345abcdef_123456"
            },
            {
              "property": "filetype",
              "value": "internalOfferFile"
            }
          ]
        }
      }
    },
    {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "JSON-encoded limit value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "start": {
                "type": "integer",
                "minimum": 0,
                "default": 0
              },
              "reply": {
                "type": "integer",
                "maximum": 2000,
                "default": 100
              }
            },
            "examples": [
              {
                "start": 0,
                "reply": 25
              }
            ]
          },
          "example": {
            "start": 0,
            "reply": 25
          }
        }
      }
    },
    {
      "name": "order",
      "in": "query",
      "required": false,
      "description": "JSON-encoded order value consumed by RequestAPIData / API_DATA; specific actions may ignore it.",
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "property": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "enum": [
                    "ASC",
                    "DESC"
                  ]
                }
              },
              "additionalProperties": true
            },
            "examples": [
              [
                {
                  "property": "id",
                  "value": "ASC"
                }
              ]
            ]
          },
          "example": [
            {
              "property": "id",
              "value": "ASC"
            }
          ]
        }
      }
    },
    {
      "name": "response_type",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "array",
          "object"
        ],
        "examples": [
          "array"
        ]
      },
      "description": "Controls generic collection representation; default is an ID-keyed object."
    },
    {
      "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": "data ist standardmässig eine nach files-ID indizierte Sammlung; response_type=array liefert eine Liste. Eine leere Sammlung kann [] sein.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "files_012345abcdef_123456": {
                "id": "files_012345abcdef_123456",
                "filename": "Unterlagen.pdf",
                "description": {
                  "de": "Kursunterlagen"
                },
                "filetype": "internalOfferFile",
                "resource_type": "offer",
                "resource_id": "offer_012345abcdef_123456",
                "last_change": "2026-10-22T10:00:00+02:00"
              }
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "anyOf": [
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^files_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "files_012345abcdef_123456"
                          ],
                          "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                        },
                        "filename": {
                          "type": "string"
                        },
                        "description": {
                          "anyOf": [
                            {
                              "type": "object",
                              "properties": {},
                              "additionalProperties": {
                                "type": "string"
                              }
                            },
                            {
                              "type": "array",
                              "items": {}
                            }
                          ]
                        },
                        "filetype": {
                          "type": "string"
                        },
                        "resource_type": {
                          "type": "string"
                        },
                        "resource_id": {
                          "anyOf": [
                            {
                              "type": "string",
                              "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "user_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                            },
                            {
                              "type": "string",
                              "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "offer_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                            },
                            {
                              "type": "string",
                              "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "admin_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "last_change": {
                          "type": "string",
                          "format": "date-time"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  {
                    "type": "object",
                    "additionalProperties": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^files_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "files_012345abcdef_123456"
                          ],
                          "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                        },
                        "filename": {
                          "type": "string"
                        },
                        "description": {
                          "anyOf": [
                            {
                              "type": "object",
                              "properties": {},
                              "additionalProperties": {
                                "type": "string"
                              }
                            },
                            {
                              "type": "array",
                              "items": {}
                            }
                          ]
                        },
                        "filetype": {
                          "type": "string"
                        },
                        "resource_type": {
                          "type": "string"
                        },
                        "resource_id": {
                          "anyOf": [
                            {
                              "type": "string",
                              "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "user_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                            },
                            {
                              "type": "string",
                              "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "offer_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                            },
                            {
                              "type": "string",
                              "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "admin_012345abcdef_123456"
                              ],
                              "description": "Öffentliche v2-ID aus dem ausgewählten Konto."
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "last_change": {
                          "type": "string",
                          "format": "date-time"
                        }
                      },
                      "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": false,
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/02-booking-users.json",
    "notes": [
      "Quellseitig werden resource_type/resource_id/filetype als assoziative filter-Schlüssel ergänzt. API_DATA verarbeitet nur property/value-Einträge; diese vorbereiteten Schlüssel begrenzen die Liste daher nicht. Die Dokumentation behauptet keine zusätzliche Angebotsberechtigung für gelistete Dateien."
    ]
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Admission.php",
    "method": "getAdmission",
    "line": 136,
    "branch": {
      "file": "application/models/v2/Admission.php",
      "line": 156
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "admission",
    "short": "adms",
    "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.
# filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${QUERY_FILTER:?QUERY_FILTER setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/admission/internal_documents' \
  --url-query 'filter='"${QUERY_FILTER}" \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/admission/internal_documents";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("filter", required("QUERY_FILTER"));
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.
# filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/admission/internal_documents"
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("filter", os.environ["QUERY_FILTER"])])
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.
// filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/admission/internal_documents";
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
url.searchParams.append("filter", required("QUERY_FILTER"));
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.
# filter: komplexen Wert vorab gemäss content/style/explode serialisieren; das Beispiel verwendet einen vorbereiteten Wert.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/admission/internal_documents"
url = os.environ["API_ORIGIN"].rstrip("/") + path
url += "?" + urllib.parse.urlencode([("filter", os.environ["QUERY_FILTER"])])
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.