This is an old and no longer supported version. Please see REST Module for the latest version.
What this module does
The module exposes the OpenMRS API as REST web services. If an OpenMRS instance is running the Webservices.REST module, other programs (and languages) can connect to retrieve and post certain information to an OpenMRS database.
Source at https://github.com/openmrs/openmrs-module-webservices.rest/tree/1.x
Download at https://modules.openmrs.org/modules/download/webservices.rest/webservices.rest-1.1.29293.omod
Download OpenMRS 1.9.x extension module at https://modules.openmrs.org/modules/view.jsp?module=webservices.rest19ext (It is needed, if you are running OpenMRS 1.9.1 and want to access some of the new API methods, tables, and objects.)
Required OpenMRS Version
The REST Web Services module requires at least OpenMRS 1.9.0 or 1.8.1 to run.
- This [Global Property|docs:Global Properties Descriptions] determines the maximum number of resources that can be accessed on any webservice call. The default is *50*.
- This [Global Property|docs:Global Properties Descriptions] determines the absolute maximum number of resources that can be accessed on any webservice call. If the client requests more than this limit, then receives an error. The default is *1000*.
- This should point at the root of your exposed web application. This is typically http://localhost:8080/openmrs during testing, but after being deployed will be something like http://192.168.1.100/openmrs or http://yourdomainname.org/openmrs. If this is empty or not filled in, the user will see NEEDSTOBECONFIGURED/ws/rest/ as the "self" urls on all objects.
- By default this is an empty string: "", which means anyone can access the rest URLs. If you put any IP addresses into this list, only calls from those are allowed. IPs should be separated by a whitespace or a comma. IPs can be declared with bit masks to denote whole subdomains e.g. 10.0.0.0/30 matches 10.0.0.0 - 10.0.0.3 and 10.0.0.0/24 matches 10.0.0.0 - 10.0.0.255. Non matching IP addresses will receive a 403 HTTP error. Both IPv4 and IPv6 addresses are supported.
The module exposes the OpenMRS API through light-weight resource objects off of the core OpenMRS objects. The structure is very similar, but not guaranteed to match up exactly.
This module uses Spring 3 annotations to expose URLs. Primary transport language is currently JSON with XML to be added at a later date.
For Creators of Web Service Core/Module Methods
Adding a Web Service Step by Step Guide for Core Developers
Adding a Web Service Step by Step Guide for Module Developers
For Web Service Client Developers
See REST Web Services API
For more information on individual objects within the API, see REST Web Service Resources in OpenMRS 1.8
Initial project page: Enhanced Web Services (Design Page)
Development sprint 1: 2011-05-16 Development Sprint
Followup sprint: 2011-05-30 Development Sprint
Development sprint 2: 2011-07-05 Development Sprint
Example Client code
- (23 bugs/features fixed/added)
- Fixed concept.answers
- Fixed patient.identifiers
- Made more resources editable
- Added ability to return retired resources generally
- Added Provider and Visit support to the 1.9ext module
- Main functionality realized with no new bugs
- 0.9 (Beta)
- 0.8 (Alpha)