Differences

This shows you the differences between two versions of the page.

--- web_interface:apis [2020/05/18 05:24] – Craig Drown
+++ web_interface:apis [2023/06/26 12:10] (current) – [Errors] Gary Willetts
@@ Line 1: / Line 1: @@
-{{indexmenu_n>90}}
+{{indexmenu_n>95}}
-====== 18.09. mSupply REST APIs ======
+====== 19.10. mSupply legacy REST APIs ======
 ===== What is it? =====
 This document describes an application programming interface for communicating with mSupply.
@@ Line 235: / Line 235: @@
 ^ Returned  | JSON containing the "Successfully sent" or any errors encounters  |
 ^Example | <code>http://example.com/mobile/report/type=currentstock</code> |
+=== Patients ===
+|<90% 35%>|
+^ Resource name  | patient |
+^ Query parameters | first_name: first name of patient \\ last_name: last name of patient \\ dob: patient date of birth (DD:MM:YY) \\ policy_number: patient insurance policy number |
+^ Returned  | JSON array of patient objects matching query parameters: \\ <code>
+[{
+  "ID":,
+  "name",
+  "phone",
+  "customer",
+  "bill_address1",
+  "supplier",
+  "email",
+  "code",
+  "last",
+  "first",
+  "date_of_birth",
+  "type",
+  "manufacturer",
+  "bill_address3",
+  "bill_address4",
+  "bill_postal_zip_code",
+  "supplying_store_id",
+  "nameNotes": ["note1","note2", ...],
+  "nameInsuranceJoin": [{
+    "ID",
+    "insuranceProviderID",
+    "nameID",
+    "isActive",
+    "policyNumberFamily",
+    "policyNumberPerson",
+    "type",
+    "discountRate",
+    "expiryDate",
+    "policyNumberFull",
+    "enteredByID" }, ... ],
+ }, ... ] </code> |
+^ Example | <code>http://example.com/api/v4/patient?first_name=j@&last_name=doe&dob=01/01/1960</code> |
+=== Prescribers ===
+|<90% 35%>|
+^ Resource name  | prescriber |
+^ Query parameters | first_name: first name of prescriber \\ last_name: last name of prescriber \\ code: prescriber code |
+^ Returned  | JSON array of prescriber objects matching query parameters: \\ <code>
+[{
+   "ID",
+   "code",
+   "first_name",
+   "last_name",
+   "initials",
+   "registration_code",
+   "category",
+   "address1",
+   "address2",
+   "phone",
+   "mobile",
+   "email",
+   "female",
+   "active",
+   "store_ID"
+}, ... ] </code> |
+^ Example | <code>http://example.com/api/v4/prescriber?first_name=j@&last_name=doe&code=foo@</code>
 ==== The Stock Endpoint ====
 This API is used by the mSupply stock web app.
@@ Line 345: / Line 407: @@
 \\
 \\
-|  //  Previous:  **[[web_interface:stock]]** | | Next: **[[web_interface:sync_api]]** //  |
+|  //  Previous:  **[[web_interface:rest_api]]** | | Next: **[[web_interface:sync_api]]** //  |
 ---- struct data ----
+pagestatus.status    :
 ----