Kategorie anzeigen

Gibt die Details einer einzelnen Leistungs-Kategorie zurück.

Request

GET /api/oauth/v2/resource/service/categories/{uuid}

Header

Header	Wert
Authorization	Bearer {access_token}

URL-Parameter

Parameter	Typ	Pflicht	Beschreibung
uuid	string (UUID)	Ja	Eindeutige Kategorie-ID

Erforderlicher Scope: services

Response

Erfolg (200 OK)

{
  "data": {
    "id": "d4e5f6a7-b8c9-0123-defa-123456789012",
    "name": "Allgemein",
    "description": "Allgemeine Leistungen für Neupatienten",
    "color": "#74AFAD",
    "sort": 0,
    "tenancies": [
      {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "name": "Ordination Muster",
        "abbreviation": "OM",
        "color": "#00adba"
      }
    ]
  }
}

Response-Felder

Feld	Typ	Beschreibung
data.id	string (UUID)	Eindeutige Kategorie-ID
data.name	string	Name der Kategorie
data.description	string | null	Beschreibungstext
data.color	string	Farbe als Hex-Code (z.B. #74AFAD)
data.sort	integer	Sortierreihenfolge
data.tenancies	Array	Zugeordnete Mandanten
data.tenancies[].id	string (UUID)	Mandanten-ID
data.tenancies[].name	string	Name des Mandanten
data.tenancies[].abbreviation	string	Kürzel
data.tenancies[].color	string	Farbe als Hex-Code

Hinweis: Die API gibt weitere interne Felder zurück, die hier nicht dokumentiert sind. Verwende nur die hier beschriebenen Felder — alle anderen können sich ohne Vorankündigung ändern.

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/service/categories/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *integer

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope services nicht vorhanden
404	not_found	Kategorie nicht gefunden