...
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 through OpenMRS.
User Documentation
The module exposes the OpenMRS API through light-weight resource objects of the core OpenMRS objects.
See REST Web Services User Guide for more information.Enhanced Web Services (Design Page)
Downloads
View Source: http://source.openmrs.org/browse/Modules/webservices.rest/trunk/
Checkout Source: http://svn.openmrs.org/openmrs-modules/webservices.rest/trunk/
Download: http://modules.openmrs.org/modules/view.jsp?module= (To be updated once module is formally released)
Required OpenMRS Versions
For all features in the REST module to work you must use a nightly build of at least version 20404. This is due to Jira Legacy
Required OpenMRS Version
The REST Web Services module requires at least OpenMRS 1.9.0 , or 1.8.1, 1 .7.2, or 1.6.3 to run.
Development Plans
Development sprint: 2011-05-16 Development Sprint
Alpha release of module coming soon.
Release Notes
( To be filled in once a formal release is made to the Module Repository )
...
Configuration Options
webservices.rest.maxResultsDefault - This Global Property determines the maximum number of resources that can be accessed on any webservice call. The default is 50.
...
webservices.rest.allowedips - By default this is "", 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.
Technical Documentation
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.
See REST Web Services API for documentation, API, conventions, and descriptions.
Full example of adding new web services to the core/trunk openmrs.
Full example of adding new web service methods into your module.User Guide for more information.
Development History
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
Release Notes
( To be filled in once a formal release is made to the Module Repository )