Get long-term medication

Returns the details of a single long-term medication.

Request

GET /api/oauth/v2/resource/long-term-medications/{uuid}

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string	Yes	Unique ID of the long-term medication

Response

Success (200 OK)

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "medicamentName": "Ramipril",
    "medicament": "Ramipril-ratiopharm 5 mg",
    "medicamentAmount": "1",
    "medicamentUnit": "Tablet",
    "op": 30,
    "dosage1": "1",
    "dosage2": "0",
    "dosage3": "0",
    "dosage4": "1",
    "dosage5": null,
    "dosageText": "1 tablet in the morning and evening",
    "customer": {
      "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
      "firstName": "Anna",
      "lastName": "Muster"
    }
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique ID of the long-term medication
data.medicamentName	string	Name of the medication
data.medicament	string | null	Trade name / exact designation
data.medicamentAmount	string | null	Amount (e.g. "1", "500")
data.medicamentUnit	string | null	Unit (e.g. "Tablet", "mg")
data.op	integer | null	Number of original packs
data.dosage1	string | null	Morning dosage
data.dosage2	string | null	Midday dosage
data.dosage3	string | null	Evening dosage
data.dosage4	string | null	Night dosage
data.dosage5	string | null	Additional dosage value
data.dosageText	string | null	Free-text dosage instructions
data.customer	object | null	Assigned customer
data.customer.id	string (UUID)	Customer ID
data.customer.firstName	string	Customer first name
data.customer.lastName	string	Customer last name

Beispiele

bash

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

Server

Client-ID

Client-Secret

Parameter

uuid *string

Zuerst Token anfordern

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope medicals not present
404	not_found	Long-term medication not found