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 23:15] – 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 241: Line 241:
 ^ 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: \\ <code> ^ Returned  | JSON array of patient objects matching query parameters: \\ <code>
-[ {+[{
   "ID":,   "ID":,
   "name",   "name",
Line 259: Line 259:
   "bill_postal_zip_code",   "bill_postal_zip_code",
   "supplying_store_id",   "supplying_store_id",
 +  "nameNotes": ["note1","note2", ...],
   "nameInsuranceJoin": [{    "nameInsuranceJoin": [{ 
     "ID",     "ID",
Line 279: Line 280:
 ^ 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: \\ <code> ^ Returned  | JSON array of prescriber objects matching query parameters: \\ <code>
-[ {+[{
    "ID",    "ID",
    "code",    "code",
Line 406: 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 23:15
  • by will