List the controlled dispensing registry

Admin, auditor, or pharmacist. Returns a page of controlled dispensing rows, newest first. Medicine and patient filters are optional; each row carries medicine, invoice, and authoriser.

GET/api/v1/medicines/controlled/registry

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Query parameters

medicine_idstring

Restrict to one controlled medicine.

patient_idstring

Restrict to one patient national id.

pageinteger

One based page number. Defaults to 1.

page_sizeinteger

Rows per page, capped at 200. Defaults to 50.

Responses

200

A page of controlled dispensing records

totalintegerrequired

min -9007199254740991 · max 9007199254740991

pageintegerrequired

min -9007199254740991 · max 9007199254740991

page_sizeintegerrequired

min -9007199254740991 · max 9007199254740991

itemsobject[]required

Show properties

Array of object

idstringrequired

sale_idstringrequired

medicine_idstringrequired

batch_idstringrequired

quantityintegerrequired

min -9007199254740991 · max 9007199254740991

patient_national_idstringrequired

doctor_licensestringrequired

authorizing_user_idstringrequired

dispensed_atstringrequired

medicine_namestringrequired

authorizing_user_namestringrequired

invoice_numberstringrequired

401

Not authenticated

detailstringrequired

403

Caller is not an admin, auditor, branch manager, or pharmacist

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

medicine_idqueryRestrict to one controlled medicine.patient_idqueryRestrict to one patient national id.pagequeryOne based page number. Defaults to 1.page_sizequeryRows per page, capped at 200. Defaults to 50.

Request

curl -X GET 'http://localhost:8000/api/v1/medicines/controlled/registry' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/medicines/controlled/registry", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/medicines/controlled/registry",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "total": -9007199254740991,
  "page": -9007199254740991,
  "page_size": -9007199254740991,
  "items": [
    {
      "id": "string",
      "sale_id": "string",
      "medicine_id": "string",
      "batch_id": "string",
      "quantity": -9007199254740991,
      "patient_national_id": "string",
      "doctor_license": "string",
      "authorizing_user_id": "string",
      "dispensed_at": "string",
      "medicine_name": "string",
      "authorizing_user_name": "string",
      "invoice_number": "string"
    }
  ]
}

{
  "detail": "string"
}

{
  "detail": "string"
}