userAPI-Referenz

GET/v2/user/{id}/dashboard

Kundenübersicht mit Buchungen und Salden laden

Lädt Stammdaten, eigene und Sammelteilnehmer-Buchungen, Teilnahmen, Angebote, Rechnungen, Salden, vorhandenen Barcode, Dateien und gespeicherte Geokoordinaten. Die Pfad-ID muss eine user-ID sein. Barcode und Geocode werden hier nur gelesen; fehlende Einträge werden nicht erzeugt.

Operation-ID get_v2_user_id_dashboard

Vertrag & Verhalten

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

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

Parameter

Pfadparameter

iderforderlich

v2 object identifier in the selected account.

string

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

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

Schema-Beispiel

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

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

Erweiterte fachliche Rückgabe in data; die aufgeführten Sammlungen können leer sein und enthalten ausschliesslich öffentliche Referenzen.

`application/json`

object

success boolean

error boolean | string

error_code string

data object

balances array

Array-Elemente

object

total number

currency_iso string

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

barcode Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 object

code string

id string

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

Schema-Beispiel

"barcode_012345abcdef_123456"

type string

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

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

bookings array

Array-Elemente

object

id string

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

Schema-Beispiel

"booking_012345abcdef_123456"

time Typ nicht eingeschränkt

ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.

anyOf · Mindestens eine Variante muss passen

Variante 1 string

format: "date-time"

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

number number | string

amount number

currency string

mustpay boolean

canceled boolean

waiting_list boolean

offer string

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

Schema-Beispiel

"offer_012345abcdef_123456"

promotion_id string

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

Schema-Beispiel

"promotion_012345abcdef_123456"

promotion object

name string

code string

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

bookings_groupparticipant array

Array-Elemente

object

id string

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

Schema-Beispiel

"booking_012345abcdef_123456"

time Typ nicht eingeschränkt

ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.

anyOf · Mindestens eine Variante muss passen

Variante 1 string

format: "date-time"

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

number number | string

amount number

currency string

mustpay boolean

canceled boolean

waiting_list boolean

offer string

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

Schema-Beispiel

"offer_012345abcdef_123456"

promotion_id string

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

Schema-Beispiel

"promotion_012345abcdef_123456"

promotion object

name string

code string

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

invoices array

Array-Elemente

object

id string

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

Schema-Beispiel

"invoice_012345abcdef_123456"

amount number

amount_pay number

currency string

status integer

number string

date_create Typ nicht eingeschränkt

ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.

anyOf · Mindestens eine Variante muss passen

Variante 1 string

format: "date-time"

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

date_payuntil Typ nicht eingeschränkt

ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.

anyOf · Mindestens eine Variante muss passen

Variante 1 string

format: "date-time"

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

refresh_suggested boolean

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

participation array

Array-Elemente

object

id string

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

Schema-Beispiel

"booking_012345abcdef_123456"

waiting_list boolean

offer string

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

Schema-Beispiel

"offer_012345abcdef_123456"

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

user object

Kundenstammdaten aus dem User-Structure, einschliesslich kontoabhängiger Zusatzfelder.

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

files Typ nicht eingeschränkt

Ergebnis der internen File-Ressourcenabfrage; kann false oder eine Sammlung sein.

anyOf · Mindestens eine Variante muss passen

Variante 1 Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 array

Array-Elemente

object

Datensatz mit den jeweils konfigurierten Feldern des verbundenen Ressourcentyps.

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

Variante 2 object

Schema für zusätzliche Felder

object

Datensatz mit den jeweils konfigurierten Feldern des verbundenen Ressourcentyps.

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

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

geocode Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 object

lat number

lng number

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

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

offers array

Array-Elemente

object

id string

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

Schema-Beispiel

"offer_012345abcdef_123456"

category Typ nicht eingeschränkt

anyOf · Mindestens eine Variante muss passen

Variante 1 string

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

Schema-Beispiel

"category_012345abcdef_123456"

Variante 2 string

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

Schema-Beispiel

"offer_012345abcdef_123456"

name string

number string

status integer

date_start Typ nicht eingeschränkt

ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.

anyOf · Mindestens eine Variante muss passen

Variante 1 string

format: "date-time"

Variante 2 Typ nicht eingeschränkt

Fester Wert: false

archive boolean

trash boolean

type string

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

user_id string

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

Schema-Beispiel

"user_012345abcdef_123456"

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": {
        "balances": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "total": {
                "type": "number"
              },
              "currency_iso": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "barcode": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "code": {
                  "type": "string"
                },
                "id": {
                  "type": "string",
                  "pattern": "^barcode_[a-f0-9]{12}_-?[0-9]+$",
                  "examples": [
                    "barcode_012345abcdef_123456"
                  ]
                },
                "type": {
                  "type": "string"
                }
              },
              "additionalProperties": true
            },
            {
              "const": false
            }
          ]
        },
        "bookings": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "booking_012345abcdef_123456"
                ]
              },
              "time": {
                "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.",
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date-time"
                  },
                  {
                    "const": false
                  }
                ]
              },
              "number": {
                "type": [
                  "number",
                  "string"
                ]
              },
              "amount": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              },
              "mustpay": {
                "type": "boolean"
              },
              "canceled": {
                "type": "boolean"
              },
              "waiting_list": {
                "type": "boolean"
              },
              "offer": {
                "type": "string",
                "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "offer_012345abcdef_123456"
                ]
              },
              "promotion_id": {
                "type": "string",
                "pattern": "^promotion_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "promotion_012345abcdef_123456"
                ]
              },
              "promotion": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "code": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            },
            "additionalProperties": true
          }
        },
        "bookings_groupparticipant": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "booking_012345abcdef_123456"
                ]
              },
              "time": {
                "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.",
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date-time"
                  },
                  {
                    "const": false
                  }
                ]
              },
              "number": {
                "type": [
                  "number",
                  "string"
                ]
              },
              "amount": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              },
              "mustpay": {
                "type": "boolean"
              },
              "canceled": {
                "type": "boolean"
              },
              "waiting_list": {
                "type": "boolean"
              },
              "offer": {
                "type": "string",
                "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "offer_012345abcdef_123456"
                ]
              },
              "promotion_id": {
                "type": "string",
                "pattern": "^promotion_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "promotion_012345abcdef_123456"
                ]
              },
              "promotion": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string"
                  },
                  "code": {
                    "type": "string"
                  }
                },
                "additionalProperties": true
              }
            },
            "additionalProperties": true
          }
        },
        "invoices": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "invoice_012345abcdef_123456"
                ]
              },
              "amount": {
                "type": "number"
              },
              "amount_pay": {
                "type": "number"
              },
              "currency": {
                "type": "string"
              },
              "status": {
                "type": "integer"
              },
              "number": {
                "type": "string"
              },
              "date_create": {
                "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.",
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date-time"
                  },
                  {
                    "const": false
                  }
                ]
              },
              "date_payuntil": {
                "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.",
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date-time"
                  },
                  {
                    "const": false
                  }
                ]
              },
              "refresh_suggested": {
                "type": "boolean"
              }
            },
            "additionalProperties": true
          }
        },
        "participation": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "booking_012345abcdef_123456"
                ]
              },
              "waiting_list": {
                "type": "boolean"
              },
              "offer": {
                "type": "string",
                "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "offer_012345abcdef_123456"
                ]
              }
            },
            "additionalProperties": true
          }
        },
        "user": {
          "type": "object",
          "properties": {},
          "additionalProperties": true,
          "description": "Kundenstammdaten aus dem User-Structure, einschliesslich kontoabhängiger Zusatzfelder."
        },
        "files": {
          "description": "Ergebnis der internen File-Ressourcenabfrage; kann false oder eine Sammlung sein.",
          "anyOf": [
            {
              "anyOf": [
                {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "Datensatz mit den jeweils konfigurierten Feldern des verbundenen Ressourcentyps."
                  }
                },
                {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "Datensatz mit den jeweils konfigurierten Feldern des verbundenen Ressourcentyps."
                  }
                }
              ]
            },
            {
              "const": false
            }
          ]
        },
        "geocode": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number"
                },
                "lng": {
                  "type": "number"
                }
              },
              "additionalProperties": true
            },
            {
              "const": false
            }
          ]
        },
        "offers": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                "examples": [
                  "offer_012345abcdef_123456"
                ]
              },
              "category": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "category_012345abcdef_123456"
                    ]
                  },
                  {
                    "type": "string",
                    "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "offer_012345abcdef_123456"
                    ]
                  }
                ]
              },
              "name": {
                "type": "string"
              },
              "number": {
                "type": "string"
              },
              "status": {
                "type": "integer"
              },
              "date_start": {
                "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.",
                "anyOf": [
                  {
                    "type": "string",
                    "format": "date-time"
                  },
                  {
                    "const": false
                  }
                ]
              },
              "archive": {
                "type": "boolean"
              },
              "trash": {
                "type": "boolean"
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        },
        "user_id": {
          "type": "string",
          "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
          "examples": [
            "user_012345abcdef_123456"
          ]
        }
      },
      "additionalProperties": true
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "balances": [
      {
        "total": 0,
        "currency_iso": "CHF"
      }
    ],
    "barcode": false,
    "bookings": [],
    "bookings_groupparticipant": [],
    "invoices": [],
    "participation": [],
    "user": {
      "id": "user_012345abcdef_123456",
      "first_name": "Alex",
      "last_name": "Beispiel",
      "email": "alex@example.invalid"
    },
    "files": false,
    "geocode": false,
    "offers": [],
    "user_id": "user_012345abcdef_123456"
  }
}

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

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/User.php:486getUser()

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/dashboard/Userdashboard.php",
    "line": 9
  },
  "reason": "Reviewed complete reachable application callgraph: dashboard SELECTs/formatting, read-only geocode cache lookup, existing ticket path and normal User/File GET_data with action segments cleared. No geocode sync, file URL access logging or ticket generation is invoked.",
  "relatedSources": [
    {
      "file": "application/models/Usergeocode.php",
      "line": 53
    },
    {
      "file": "application/helpers/edooboxhelp_helper.php",
      "line": 9991
    },
    {
      "file": "application/models/v2/Eddata.php",
      "line": 18
    }
  ]
}

x-edoobox-runtimeMutationGuard

false

x-edoobox-get-effect

"read"

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/02-booking-users.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/User.php",
  "method": "getUser",
  "line": 486,
  "branch": {
    "file": "application/models/v2/User.php",
    "line": 501
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

true

x-edoobox-safeForAutomation

true

x-edoobox-permission

{
  "resource": "user",
  "short": "user",
  "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_user_id_dashboard",
  "summary": "Kundenübersicht mit Buchungen und Salden laden",
  "description": "Lädt Stammdaten, eigene und Sammelteilnehmer-Buchungen, Teilnahmen, Angebote, Rechnungen, Salden, vorhandenen Barcode, Dateien und gespeicherte Geokoordinaten. Die Pfad-ID muss eine user-ID sein. Barcode und Geocode werden hier nur gelesen; fehlende Einträge werden nicht erzeugt.",
  "tags": [
    "user"
  ],
  "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": [
          "user_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": "Erweiterte fachliche Rückgabe in data; die aufgeführten Sammlungen können leer sein und enthalten ausschliesslich öffentliche Referenzen.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "balances": [
                {
                  "total": 0,
                  "currency_iso": "CHF"
                }
              ],
              "barcode": false,
              "bookings": [],
              "bookings_groupparticipant": [],
              "invoices": [],
              "participation": [],
              "user": {
                "id": "user_012345abcdef_123456",
                "first_name": "Alex",
                "last_name": "Beispiel",
                "email": "alex@example.invalid"
              },
              "files": false,
              "geocode": false,
              "offers": [],
              "user_id": "user_012345abcdef_123456"
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "balances": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "total": {
                          "type": "number"
                        },
                        "currency_iso": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "barcode": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "code": {
                            "type": "string"
                          },
                          "id": {
                            "type": "string",
                            "pattern": "^barcode_[a-f0-9]{12}_-?[0-9]+$",
                            "examples": [
                              "barcode_012345abcdef_123456"
                            ]
                          },
                          "type": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      },
                      {
                        "const": false
                      }
                    ]
                  },
                  "bookings": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "booking_012345abcdef_123456"
                          ]
                        },
                        "time": {
                          "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.",
                          "anyOf": [
                            {
                              "type": "string",
                              "format": "date-time"
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "number": {
                          "type": [
                            "number",
                            "string"
                          ]
                        },
                        "amount": {
                          "type": "number"
                        },
                        "currency": {
                          "type": "string"
                        },
                        "mustpay": {
                          "type": "boolean"
                        },
                        "canceled": {
                          "type": "boolean"
                        },
                        "waiting_list": {
                          "type": "boolean"
                        },
                        "offer": {
                          "type": "string",
                          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "offer_012345abcdef_123456"
                          ]
                        },
                        "promotion_id": {
                          "type": "string",
                          "pattern": "^promotion_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "promotion_012345abcdef_123456"
                          ]
                        },
                        "promotion": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "code": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "bookings_groupparticipant": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "booking_012345abcdef_123456"
                          ]
                        },
                        "time": {
                          "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.",
                          "anyOf": [
                            {
                              "type": "string",
                              "format": "date-time"
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "number": {
                          "type": [
                            "number",
                            "string"
                          ]
                        },
                        "amount": {
                          "type": "number"
                        },
                        "currency": {
                          "type": "string"
                        },
                        "mustpay": {
                          "type": "boolean"
                        },
                        "canceled": {
                          "type": "boolean"
                        },
                        "waiting_list": {
                          "type": "boolean"
                        },
                        "offer": {
                          "type": "string",
                          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "offer_012345abcdef_123456"
                          ]
                        },
                        "promotion_id": {
                          "type": "string",
                          "pattern": "^promotion_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "promotion_012345abcdef_123456"
                          ]
                        },
                        "promotion": {
                          "type": "object",
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "code": {
                              "type": "string"
                            }
                          },
                          "additionalProperties": true
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "invoices": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^invoice_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "invoice_012345abcdef_123456"
                          ]
                        },
                        "amount": {
                          "type": "number"
                        },
                        "amount_pay": {
                          "type": "number"
                        },
                        "currency": {
                          "type": "string"
                        },
                        "status": {
                          "type": "integer"
                        },
                        "number": {
                          "type": "string"
                        },
                        "date_create": {
                          "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.",
                          "anyOf": [
                            {
                              "type": "string",
                              "format": "date-time"
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "date_payuntil": {
                          "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.",
                          "anyOf": [
                            {
                              "type": "string",
                              "format": "date-time"
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "refresh_suggested": {
                          "type": "boolean"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "participation": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^booking_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "booking_012345abcdef_123456"
                          ]
                        },
                        "waiting_list": {
                          "type": "boolean"
                        },
                        "offer": {
                          "type": "string",
                          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "offer_012345abcdef_123456"
                          ]
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "user": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": true,
                    "description": "Kundenstammdaten aus dem User-Structure, einschliesslich kontoabhängiger Zusatzfelder."
                  },
                  "files": {
                    "description": "Ergebnis der internen File-Ressourcenabfrage; kann false oder eine Sammlung sein.",
                    "anyOf": [
                      {
                        "anyOf": [
                          {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {},
                              "additionalProperties": true,
                              "description": "Datensatz mit den jeweils konfigurierten Feldern des verbundenen Ressourcentyps."
                            }
                          },
                          {
                            "type": "object",
                            "additionalProperties": {
                              "type": "object",
                              "properties": {},
                              "additionalProperties": true,
                              "description": "Datensatz mit den jeweils konfigurierten Feldern des verbundenen Ressourcentyps."
                            }
                          }
                        ]
                      },
                      {
                        "const": false
                      }
                    ]
                  },
                  "geocode": {
                    "anyOf": [
                      {
                        "type": "object",
                        "properties": {
                          "lat": {
                            "type": "number"
                          },
                          "lng": {
                            "type": "number"
                          }
                        },
                        "additionalProperties": true
                      },
                      {
                        "const": false
                      }
                    ]
                  },
                  "offers": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                          "examples": [
                            "offer_012345abcdef_123456"
                          ]
                        },
                        "category": {
                          "anyOf": [
                            {
                              "type": "string",
                              "pattern": "^category_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "category_012345abcdef_123456"
                              ]
                            },
                            {
                              "type": "string",
                              "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                              "examples": [
                                "offer_012345abcdef_123456"
                              ]
                            }
                          ]
                        },
                        "name": {
                          "type": "string"
                        },
                        "number": {
                          "type": "string"
                        },
                        "status": {
                          "type": "integer"
                        },
                        "date_start": {
                          "description": "ISO-8601-Zeitwert von dQ; bei fehlendem/ungültigem gespeicherten Wert false.",
                          "anyOf": [
                            {
                              "type": "string",
                              "format": "date-time"
                            },
                            {
                              "const": false
                            }
                          ]
                        },
                        "archive": {
                          "type": "boolean"
                        },
                        "trash": {
                          "type": "boolean"
                        },
                        "type": {
                          "type": "string"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "user_id": {
                    "type": "string",
                    "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                    "examples": [
                      "user_012345abcdef_123456"
                    ]
                  }
                },
                "additionalProperties": true
              },
              "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/dashboard/Userdashboard.php",
      "line": 9
    },
    "reason": "Reviewed complete reachable application callgraph: dashboard SELECTs/formatting, read-only geocode cache lookup, existing ticket path and normal User/File GET_data with action segments cleared. No geocode sync, file URL access logging or ticket generation is invoked.",
    "relatedSources": [
      {
        "file": "application/models/Usergeocode.php",
        "line": 53
      },
      {
        "file": "application/helpers/edooboxhelp_helper.php",
        "line": 9991
      },
      {
        "file": "application/models/v2/Eddata.php",
        "line": 18
      }
    ]
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/02-booking-users.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/User.php",
    "method": "getUser",
    "line": 486,
    "branch": {
      "file": "application/models/v2/User.php",
      "line": 501
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "user",
    "short": "user",
    "checkedByDispatcher": true,
    "levels": [
      1,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}

Aufruf vorbereiten

Beispiel

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

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${PATH_ID:?PATH_ID setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/user/'"${PATH_ID}"'/dashboard' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"

JavaScript

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

Python

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

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

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

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

JavaScript

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

Python

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

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

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

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

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

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