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 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)
Technical Documentation
This module uses Spring 3 annotations to expose URLs. Primary transport language is currently JSON.
See Webservices.rest Module 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.
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)
Development Plans / Timeline
Development sprint: 2011-05-16 Development Sprint
Release Notes
( To be filled in once a formal release is made to the Module Repository )
Module Configuration
webservices.rest.maxresults - This Global Property determines the maximum number of resources that can be accessed on any webservice call. The default is 50.
webservices.rest.uriPrefix - 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.
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. Non matching IP addresses will receive a 403 HTTP error. You can put wildcard * characters into the IP addresses to denote whole subdomains that can access the urls: 192.168.0., 192.168.1.* will allow most local IPs through.