List long-term medications

Returns a paginated list of all long-term medications of the company.

Request

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

Header

Header	Value
Authorization	Bearer {access_token}

Query parameters

Parameter	Type	Required	Description
offset	integer	No	Start position (default: 0, min: 0)
limit	integer	No	Number of results (default: 50, min: 1, max: 200)

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"
      }
    },
    {
      "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 fields

Field	Type	Description
data	Array	List of long-term medications
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
meta.total	integer	Total number of long-term medications
meta.offset	integer	Current start position
meta.limit	integer	Number of returned entries

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

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope medicals not present