Leistungen abrufen
Gibt eine paginierte Liste aller Leistungen zurück.
Request
GET /api/oauth/v2/resource/services
Header
| Header | Wert |
|---|---|
Authorization | Bearer {access_token} |
Query-Parameter
| Parameter | Typ | Pflicht | Beschreibung |
|---|---|---|---|
offset | integer | Nein | Startposition (Standard: 0) |
limit | integer | Nein | Anzahl Ergebnisse (Standard: 50, Max: 200) |
categoryId | string (UUID) | Nein | Nur Leistungen einer bestimmten Kategorie zurückgeben |
includeTypes | string | Nein | Kommaseparierte Liste von Typen, die zusätzlich zu regulären Leistungen zurückgegeben werden. Mögliche Werte: service_pause, service_pause_custom, official_holiday, vacation, illness, oder all für alle Typen. |
Erforderlicher Scope: services
Response
Erfolg (200 OK)
json
{
"data": [
{
"id": "c3d4e5f6-a7b8-9012-cdef-012345678901",
"name": "Erstordination",
"description": "Erstmaliger Besuch inklusive Anamnese",
"duration": 60,
"durationBefore": 5,
"durationAfter": 10,
"directBooking": false,
"isOnlineBookable": true,
"showDuration": true,
"price": 120.00,
"priceVisible": true,
"color": "#74AFAD",
"icon": "stethoscope",
"sort": 0,
"type": null,
"category": {
"id": "d4e5f6a7-b8c9-0123-defa-123456789012",
"name": "Allgemein",
"description": null,
"color": "#00adba",
"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"
}
]
}
],
"meta": {
"total": 25,
"offset": 0,
"limit": 50
}
}Response-Felder
| Feld | Typ | Beschreibung |
|---|---|---|
data | Array | Liste der Leistungen |
data[].id | string (UUID) | Eindeutige ID der Leistung |
data[].name | string | Name der Leistung |
data[].description | string | null | Beschreibungstext |
data[].duration | integer | Termindauer für den Kunden in Minuten |
data[].durationBefore | integer | Vorbereitungszeit in Minuten |
data[].durationAfter | integer | Nachbereitungszeit in Minuten |
data[].directBooking | boolean | Ob die Leistung direkt buchbar ist (ohne Bestätigung) |
data[].isOnlineBookable | boolean | Ob die Leistung online buchbar ist |
data[].showDuration | boolean | Ob die Dauer angezeigt wird |
data[].price | number | null | Preis (brutto) |
data[].priceVisible | boolean | Ob der Preis angezeigt wird |
data[].color | string | Farbe als Hex-Code (z.B. #74AFAD) |
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 |
meta.total | integer | Gesamtanzahl der Leistungen |
meta.offset | integer | Aktuelle Startposition |
meta.limit | integer | Anzahl der zurückgegebenen Ergebnisse |
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/services?offset=0&limit=50&categoryId=b2c3d4e5-f6a7-8901-bcde-f01234567890&includeTypes=beispiel" \
-H "Authorization: Bearer {access_token}"Parameter
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 |