Get resident devices with telemetry (compatibility)
- Sandbox: available
- Staging: available
- Production: unknown
Compatibility route for older resident vitals clients. Returns the devices assigned to one resident, each with its telemetry. For new integrations, use GET /v1/slim/patient/{id}/current-vitals.
Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs search and read on Patient, Device, Location, Observation and Organization.
Scope: the caller's project (from the token). The project parameter is ignored.
Behaviour
- Returns up to 100 device rows for the resident, with zone, device and telemetry.
- Results are cached for up to 60 seconds. Writes made through the Slim routes refresh the cache sooner.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/query/patient/c3499c27-2973-0a7f-807e-fb8676a92dcb' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'bearerAuthorizationBearer <JWT>id*stringuuidproject?stringproject is ignored for scoping; server uses auth token project only.
Project\/\S+Patient query results retrieved successfully.
application/json- response
total*numberresources*array<unknown>curl -X GET 'https://api.sandbox.ovok.com/v1/slim/query/patient/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "total": 0, "resources": [ null ]}List telemetry and alerts (compatibility) GET
Compatibility route for older live polling clients. Returns telemetry and alerts maps keyed by device identifier. For new integrations, use `GET /v1/slim/device/live/telemetry`. **Auth:** bearer token. The caller must be a practitioner, an admin or a System Owner, and needs `search` and `read` on `Patient`, `Device`, `Location`, `Observation` and `Organization`. **Scope:** the caller's project (from the token). The `project` parameter is ignored. ## Behaviour - Takes the same query parameters as `GET /v1/slim/query`, with the same validation rules. - Returns `total`, plus `telemetry` and `alerts` for the requested page only. - `alerts` has an entry for every device on the page. `telemetry` has an entry only for devices with telemetry. - The route returns 503 when the server is at capacity for live reads or the device list cannot be built. Retry shortly. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/query/telemetry?mustInclude=device,telemetry&shouldInclude=device,telemetry' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```
Count devices per zone (compatibility) GET
Compatibility route for older zone count clients. Returns device counts per zone. For new integrations, use `GET /v1/slim/zones/device-counts`. **Auth:** bearer token. The caller must be a practitioner, an admin or a System Owner, and needs `Organization:search` and `Device:search`. **Scope:** the caller's project (from the token). For admins, the counts also cover the project's sub-projects. ## Behaviour - Each entry has the zone (`organization`) and its `deviceCount`, `assignedResidentDeviceCount`, `activeDeviceCount` and `inactiveDeviceCount`. - Devices without a zone are counted in an entry without `organization`. - Only zones with at least one device are listed, sorted by `deviceCount`, highest first. - A device counts as active when its telemetry reports it active. - The top-level `total*` fields sum the counts over all entries. `total` is the number of entries. - Results are cached for up to 60 seconds. Writes made through the Slim routes refresh the cache sooner. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/query/organization/device/count' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```