Dauermedikationen abrufen

Gibt eine paginierte Liste aller Dauermedikationen des Unternehmens zurück.

Request

GET /api/oauth/v2/resource/long-term-medications

Header

Header	Wert
Authorization	Bearer {access_token}

Query-Parameter

Parameter	Typ	Pflicht	Beschreibung
offset	integer	Nein	Startposition (Standard: 0, Min: 0)
limit	integer	Nein	Anzahl Ergebnisse (Standard: 50, Min: 1, Max: 200)

Response

Erfolg (200 OK)

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "medicamentName": "Ramipril",
      "medicament": "Ramipril-ratiopharm 5 mg",
      "medicamentAmount": "1",
      "medicamentUnit": "Tablette",
      "op": 30,
      "dosage1": "1",
      "dosage2": "0",
      "dosage3": "0",
      "dosage4": "1",
      "dosage5": null,
      "dosageText": "Morgens und abends je 1 Tablette",
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      }
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "medicamentName": "Metformin",
      "medicament": null,
      "medicamentAmount": "500",
      "medicamentUnit": "mg",
      "op": null,
      "dosage1": "1",
      "dosage2": "0",
      "dosage3": "1",
      "dosage4": "0",
      "dosage5": null,
      "dosageText": null,
      "customer": {
        "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
        "firstName": "Anna",
        "lastName": "Muster"
      }
    }
  ],
  "meta": {
    "total": 18,
    "offset": 0,
    "limit": 50
  }
}

Response-Felder

Feld	Typ	Beschreibung
data	Array	Liste der Dauermedikationen
data[].id	string (UUID)	Eindeutige ID der Dauermedikation
data[].medicamentName	string	Name des Medikaments
data[].medicament	string | null	Handelsname / genaue Bezeichnung
data[].medicamentAmount	string | null	Menge (z.B. "1", "500")
data[].medicamentUnit	string | null	Einheit (z.B. "Tablette", "mg")
data[].op	integer | null	Originalpackungsanzahl
data[].dosage1	string | null	Dosierung morgens
data[].dosage2	string | null	Dosierung mittags
data[].dosage3	string | null	Dosierung abends
data[].dosage4	string | null	Dosierung nachts
data[].dosage5	string | null	Weitere Dosierungsangabe
data[].dosageText	string | null	Freitext zur Dosierung
data[].customer	object | null	Zugeordneter Kunde
data[].customer.id	string (UUID)	Kunden-ID
data[].customer.firstName	string	Vorname des Kunden
data[].customer.lastName	string	Nachname des Kunden
meta.total	integer	Gesamtanzahl der Dauermedikationen
meta.offset	integer	Aktuelle Startposition
meta.limit	integer	Anzahl der zurückgegebenen Einträge

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/long-term-medications?offset=0&limit=50" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

offset integer

limit integer

Zuerst Token anfordern

Mögliche Fehler

Status	Code	Beschreibung
401	invalid_client	Ungültiger oder fehlender Access Token
403	insufficient_scope	Scope medicals nicht vorhanden