web_interface:apis

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
web_interface:apis [2021/03/16 22:57] – willweb_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? ===== ===== What is it? =====
 This document describes an application programming interface for communicating with mSupply. This document describes an application programming interface for communicating with mSupply.
Line 240: Line 240:
 ^ Resource name  | patient | ^ 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 | ^ 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. |+^ 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> | ^ Example | <code>http://example.com/api/v4/patient?first_name=j@&last_name=doe&dob=01/01/1960</code> |
  
Line 247: Line 279:
 ^ Resource name  | prescriber | ^ Resource name  | prescriber |
 ^ Query parameters | first_name: first name of prescriber \\ last_name: last name of prescriber \\ code: prescriber code | ^ 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. | +^ Returned  | JSON array of prescriber objects matching query parameters: \\ <code> 
-^ Example | <code>http://example.com/api/v4/prescriber?first_name=j@&last_name=doe&code=foo@</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 ==== ==== The Stock Endpoint ====
Line 358: Line 407:
 \\ \\
 \\ \\
-|  //  Previous:  **[[web_interface:stock]]** | | Next: **[[web_interface:sync_api]]** //  |+|  //  Previous:  **[[web_interface:rest_api]]** | | Next: **[[web_interface:sync_api]]** //  |
  
 ---- struct data ---- ---- struct data ----
  • Last modified: 2021/03/16 22:57
  • by will