Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
web_interface:apis [2020/04/24 13:36] – lou | web_interface:apis [2023/06/26 12:10] (current) – [Errors] Gary Willetts | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | {{indexmenu_n> | + | {{indexmenu_n> |
- | ====== | + | ====== |
===== 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 235: | Line 235: | ||
^ Returned | ^ Returned | ||
^Example | < | ^Example | < | ||
+ | |||
+ | === 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: | ||
+ | ^ Returned | ||
+ | [{ | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, ... ] </ | ||
+ | ^ Example | < | ||
+ | |||
+ | === Prescribers === | ||
+ | |<90% 35%>| | ||
+ | ^ Resource name | prescriber | | ||
+ | ^ Query parameters | first_name: first name of prescriber \\ last_name: last name of prescriber \\ code: prescriber code | | ||
+ | ^ Returned | ||
+ | [{ | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, ... ] </ | ||
+ | ^ Example | < | ||
==== The Stock Endpoint ==== | ==== The Stock Endpoint ==== | ||
This API is used by the mSupply stock web app. | This API is used by the mSupply stock web app. | ||
- | |||
Line 345: | Line 407: | ||
\\ | \\ | ||
\\ | \\ | ||
- | | // Previous: | + | | // Previous: |
---- struct data ---- | ---- struct data ---- | ||
+ | pagestatus.status | ||
---- | ---- | ||