Leistung anzeigen

Gibt die Details einer einzelnen Leistung zurück.

Request

GET /api/oauth/v2/resource/services/{uuid}

Header

Header	Wert
Authorization	Bearer {access_token}

URL-Parameter

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

Erforderlicher Scope: services

Response

Erfolg (200 OK)

{
  "data": {
    "id": "c3d4e5f6-a7b8-9012-cdef-234567890123",
    "name": "Erstgespräch",
    "description": "Erstkonsultation für Neupatienten",
    "duration": 30,
    "durationBefore": 0,
    "durationAfter": 5,
    "directBooking": true,
    "isOnlineBookable": true,
    "showDuration": true,
    "price": 80.00,
    "priceVisible": true,
    "color": "#df3a7f",
    "icon": "stethoscope",
    "sort": 0,
    "type": null,
    "category": {
      "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"
        }
      ]
    },
    "tenancies": [
      {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "name": "Ordination Muster",
        "abbreviation": "OM",
        "color": "#00adba"
      }
    ]
  }
}

Response-Felder

Feld	Typ	Beschreibung
data.id	string (UUID)	Eindeutige Leistungs-ID
data.name	string	Name der Leistung
data.description	string | null	Beschreibungstext
data.duration	integer	Dauer der Leistung in Minuten
data.durationBefore	integer	Vorbereitungszeit in Minuten
data.durationAfter	integer	Nachbereitungszeit in Minuten
data.directBooking	boolean	Ob Direktbuchung möglich ist
data.isOnlineBookable	boolean	Ob die Leistung online buchbar ist
data.showDuration	boolean	Ob die Dauer im Buchungskalender angezeigt wird
data.price	number | null	Preis in Euro
data.priceVisible	boolean	Ob der Preis öffentlich sichtbar ist
data.color	string | null	Farbe als Hex-Code (z.B. #df3a7f)
data.icon	string | null	Icon-Name
data.sort	integer	Sortierreihenfolge
data.type	string | null	null = normale Leistung. Mögliche Werte: service_pause (Pause), service_pause_custom (Benutzerdefinierte Pause), official_holiday (Feiertag), vacation (Urlaub), illness (Krankenstand)
data.category	object | null	Zugeordnete Kategorie
data.category.id	string (UUID)	Eindeutige Kategorie-ID
data.category.name	string	Name der Kategorie
data.category.description	string | null	Beschreibungstext der Kategorie
data.category.color	string	Farbe der Kategorie als Hex-Code
data.category.sort	integer	Sortierreihenfolge der Kategorie
data.category.tenancies	Array	Zugeordnete Mandanten der Kategorie
data.category.tenancies[].id	string (UUID)	Mandanten-ID
data.category.tenancies[].name	string	Name des Mandanten
data.category.tenancies[].abbreviation	string	Kürzel
data.category.tenancies[].color	string	Farbe als Hex-Code
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/services/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	Leistung nicht gefunden