Standorte abrufen
Gibt eine paginierte Liste aller Standorte zurück.
Request
GET /api/oauth/v2/resource/locations
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) |
Erforderlicher Scope: locations
Response
Erfolg (200 OK)
json
{
"data": [
{
"id": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
"name": "Hauptordination Wien",
"bookingName": "Wien – 1. Bezirk",
"abbreviation": "WI1",
"street": "Musterstraße 1",
"zip": "1010",
"city": "Wien",
"country": "AT",
"description": "Barrierefrei zugänglich",
"color": "#74AFAD",
"email": "wien@example.com",
"tel": "1234567",
"telCode": "+43",
"lat": 48.2082,
"lng": 16.3738,
"sort": 0,
"bookable": true,
"tenancies": [
{
"id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
"name": "Ordination Muster",
"abbreviation": "OM",
"color": "#00adba"
}
]
}
],
"meta": {
"total": 3,
"offset": 0,
"limit": 50
}
}Response-Felder
| Feld | Typ | Beschreibung |
|---|---|---|
data | Array | Liste der Standorte |
data[].id | string (UUID) | Eindeutige Standort-ID |
data[].name | string | Interner Name des Standorts |
data[].bookingName | string | null | Anzeigename für die Buchung |
data[].abbreviation | string | null | Kürzel |
data[].street | string | null | Straße und Hausnummer |
data[].zip | string | null | Postleitzahl |
data[].city | string | null | Stadt |
data[].country | string | null | Ländercode (ISO 3166-1 alpha-2) |
data[].description | string | null | Beschreibungstext |
data[].color | string | Farbe als Hex-Code (z.B. #74AFAD) |
data[].email | string | null | E-Mail-Adresse des Standorts |
data[].tel | string | null | Telefonnummer |
data[].telCode | string | null | Vorwahl |
data[].lat | number | null | Breitengrad |
data[].lng | number | null | Längengrad |
data[].sort | integer | Sortierreihenfolge |
data[].bookable | boolean | Ob der Standort buchbar ist |
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 Standorte |
meta.offset | integer | Aktuelle Startposition |
meta.limit | integer | Anzahl der zurückgegebenen Einträge |
Hinweis: Die
idwird als UUID zurückgegeben und wird für die Abfrage freier Slots und die Terminbuchung benötigt.
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/locations?offset=0&limit=50" \
-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 locations nicht vorhanden |