إنتقل إلى المحتوى الرئيسي

API map

Source of truth for paths: afia-api health.afia.app.common.EndpointUri. Owner of this file: WP-00. Prefix owners: manifest/api-prefixes.tsv.

This file is an index. Implemented rows are marked live. Planned rows come from ADR 0012 and need a WP-00 constant before they land.

StatusMethodPathOwnerNotes
liveGET/api/v1/afia/healthWP-00Mobile liveness
liveGET/api/v1/afia/app-versionWP-00latestVersion, minSupportedVersion
reserved/api/v1/afia/auth/**WP-01identity
reserved/api/v1/afia/meWP-01current account and deletion
reserved/api/v1/afia/patient/profileWP-02patient profile
reserved/api/v1/afia/clinician/profileWP-03clinician profile
reserved/api/v1/afia/admin/**WP-04directory and clinic config
reserved/api/v1/afia/appointments/**WP-05patient booking
reserved/api/v1/afia/clinician/agendaWP-05clinician day view
reserved/api/v1/afia/clinician/patientsWP-05patients with an appointment
reserved/api/v1/afia/clinician/encounters/**WP-06encounter notes
reserved/api/v1/afia/orders/**WP-07diagnostics
reserved/api/v1/afia/worklistsWP-07diagnostics, kind query
reserved/api/v1/afia/resultsWP-08patient projection
plannedGET/api/v1/afia/clinician/agenda?from=&to=WP-12date range beside day
plannedPOST/api/v1/afia/appointments/{id}/ratingWP-121 to 5 stars, visit patient only
plannedGET/api/v1/afia/clinician/dashboardWP-12clinician home counts and next visits
plannedGET/api/v1/afia/patient/homeWP-12patient home projection
plannedGET/api/v1/afia/admin/dashboardWP-12admin counts, under the WP-04 prefix
plannedGET/api/v1/afia/worklists/summary?kind=WP-12worklist counts, under the WP-07 prefix
plannedGET/api/v1/afia/notificationsWP-12projection over visits, results, invoices, alerts
plannedPOST/api/v1/afia/notifications/seenWP-12sets lastSeenAt on the account
plannedPATCH/api/v1/afia/orders/{id}/scheduleWP-12sets scheduledAt
plannedPATCH/api/v1/afia/admin/users/{id}/statusWP-12ACTIVE or SUSPENDED

Ops: GET /actuator/health (Spring). Not the mobile contract.